From a11696b85ea5dfdb682b893118a6c1fe0f66e610 Mon Sep 17 00:00:00 2001
From: Rohan Mitchell <rohan@rohanmitchell.com>
Date: Wed, 4 May 2016 12:13:03 +1000
Subject: [PATCH] Include BugHerd script only if configured, and with
 configured API key

---
 app/views/layouts/_bugherd_script.html.haml   | 14 +----
 .../consumer/external_services_spec.rb        | 57 +++++++++++++++++++
 spec/support/request/web_helper.rb            | 18 ++++++
 3 files changed, 77 insertions(+), 12 deletions(-)
 create mode 100644 spec/features/consumer/external_services_spec.rb

diff --git a/app/views/layouts/_bugherd_script.html.haml b/app/views/layouts/_bugherd_script.html.haml
index ad6fe585f5..8a04160cfd 100644
--- a/app/views/layouts/_bugherd_script.html.haml
+++ b/app/views/layouts/_bugherd_script.html.haml
@@ -1,18 +1,8 @@
-- if Rails.env.staging? or Rails.env.production?
+- if (Rails.env.staging? || Rails.env.production?) && Spree::Config.bugherd_api_key.present?
   :javascript
     (function (d, t) {
       var bh = d.createElement(t), s = d.getElementsByTagName(t)[0];
       bh.type = 'text/javascript';
-      bh.src = '//www.bugherd.com/sidebarv2.js?apikey=4ftxjbgwx7y6ssykayr04w';
+      bh.src = '//www.bugherd.com/sidebarv2.js?apikey=#{Spree::Config.bugherd_api_key}';
       s.parentNode.insertBefore(bh, s);
     })(document, 'script');
-
-
--#- elsif Rails.env.production?
-  -#:javascript
-    -#(function (d, t) {
-      -#var bh = d.createElement(t), s = d.getElementsByTagName(t)[0];
-      -#bh.type = 'text/javascript';
-      -#bh.src = '//www.bugherd.com/sidebarv2.js?apikey=xro3uv55objies58o2wrua';
-      -#s.parentNode.insertBefore(bh, s);
-      -#})(document, 'script');
diff --git a/spec/features/consumer/external_services_spec.rb b/spec/features/consumer/external_services_spec.rb
new file mode 100644
index 0000000000..28be1f8cb6
--- /dev/null
+++ b/spec/features/consumer/external_services_spec.rb
@@ -0,0 +1,57 @@
+require 'spec_helper'
+
+feature 'External services' do
+  include AuthenticationWorkflow
+  include WebHelper
+
+  describe "bugherd" do
+    describe "limiting inclusion by environment" do
+      before { Spree::Config.bugherd_api_key = 'abc123' }
+
+      it "is not included in test" do
+        visit root_path
+        expect(script_content(with: 'bugherd')).to be_nil
+      end
+
+      it "is not included in dev" do
+        Rails.env.stub(:development?) { true }
+        visit root_path
+        expect(script_content(with: 'bugherd')).to be_nil
+      end
+
+      it "is included in staging" do
+        Rails.env.stub(:staging?) { true }
+        visit root_path
+        expect(script_content(with: 'bugherd')).not_to be_nil
+      end
+
+      it "is included in production" do
+        Rails.env.stub(:production?) { true }
+        visit root_path
+        expect(script_content(with: 'bugherd')).not_to be_nil
+      end
+    end
+
+    context "in an environment where BugHerd is displayed" do
+      before { Rails.env.stub(:staging?) { true } }
+
+      context "when there is no API key set" do
+        before { Spree::Config.bugherd_api_key = nil }
+
+        it "does not include the BugHerd script" do
+          visit root_path
+          expect(script_content(with: 'bugherd')).to be_nil
+        end
+      end
+
+      context "when an API key is set" do
+        before { Spree::Config.bugherd_api_key = 'abc123' }
+
+        it "includes the BugHerd script, with the correct API key" do
+          visit root_path
+          expect(script_content(with: 'bugherd')).to include 'abc123'
+        end
+      end
+    end
+  end
+end
diff --git a/spec/support/request/web_helper.rb b/spec/support/request/web_helper.rb
index 30ce677c6c..70c803709e 100644
--- a/spec/support/request/web_helper.rb
+++ b/spec/support/request/web_helper.rb
@@ -115,6 +115,24 @@ module WebHelper
     DirtyFormDialog.new(page)
   end
 
+  # Fetch the content of a script block
+  # eg. script_content with: 'my-script.com'
+  # Returns nil if not found
+  # Raises an exception if multiple matching blocks are found
+  def script_content(opts={})
+    elems = page.all('script', visible: false)
+
+    elems = elems.to_a.select { |e| e.text(:all).include? opts[:with] }  if opts[:with]
+
+    if elems.none?
+      nil
+    elsif elems.many?
+      raise "Multiple results returned for script_content"
+    else
+      elems.first.text(:all)
+    end
+  end
+
   # http://www.elabs.se/blog/53-why-wait_until-was-removed-from-capybara
   # Do not use this without good reason. Capybara's built-in waiting is very effective.
   def wait_until(secs=nil)