gosquared 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d967932ba27cf17815ddf7836dbbd969f5134e1
-  data.tar.gz: 7d6d2759059c45e3c5c90fe7eb0829e76bb30dd4
+  metadata.gz: 53c41a7e343c373266553d6661997c9717ee2d9f
+  data.tar.gz: d071c532ded3028809e16bdc80ee4b4a475c746e
 SHA512:
-  metadata.gz: eaa7ddda82cf174d6b294b5604306deea789443eafaa33eb2dfc528a2a82791885a4b2ab8d13fafc370b12e6b98eadc14cfde2ca7f64a231b5dc6061ad13fec0
-  data.tar.gz: a0daf661154404ce33a3babc590f3ce9c03a14434c36e70ff16a9bac262909edb4b361559d9f8b6665b599c5a4fbddf68c16b604462732f1f6d1a2728f182f42
+  metadata.gz: bbf374a4591cc1180fe06ef14a7e68ecc47190affb728e69f6d59d8f73a904baefeb8c1c2cee57213fbbc1b329e82ab73920167fd3f2cedaad4d6088477ef800
+  data.tar.gz: c933d841cf339acb7ea5b19401956ada2fd993a3e18e1e2aae638d7061c25155460a92bcac9c2e4d6d92324b55157b2d4961e8738435e988bda3fc9981e7a6b5

data/README.md

@@ -23,23 +23,6 @@ Then require GoSquared in your application
 require 'gosquared'
 ```
 
-### Quickly install Analytics and Chat 
-
-GoSquared uses a javascript code snippet to track pageviews and optionally load the GoSquared Live Chat widget.
-If you want to, you can quickly add the the code to all of your Rails’ views by running this:
-
-```ruby
-rails generate gosquared:config 'your_project_token'
-```
-
-This will insert a `<script>` tag automatically before the closing `</body>` tag on each view rendered.
-
-After generating your config file, if there are any controllers you would prefer not to have the tracking code automatically inserted in, you'll just need to add the following to that specific controller:
-
-```ruby
-skip_after_action :add_script
-```
-
 #Tracking API
 This is for sending data to GoSquared. It allows you to track:
 * Events
@@ -212,6 +195,24 @@ gs.account.sites.fetch
 ```
 
 
+### Optional install of Analytics and Chat 
+
+While it is not required to make use of our library to interact with our Tracking and Reporting API's, you can also quickly install GoSquared's tracking code on your app. GoSquared uses a javascript code snippet to track pageviews and optionally load the GoSquared Live Chat widget.
+
+If you don't currently have a GoSquared tracking code on your site, you can quickly add the the code to all of your Rails’ views by running this:
+
+```ruby
+rails generate gosquared:config 'your_project_token'
+```
+
+This will insert a `<script>` tag automatically before the closing `</body>` tag on each view rendered.
+
+After generating your config file, if there are any controllers you would prefer not to have the tracking code automatically inserted in, you'll just need to add the following to that specific controller:
+
+```ruby
+skip_after_action :add_gosquared_script
+```
+
 #Tests
 
 ```ruby

data/lib/tracker_inject/injector.rb

@@ -1,39 +1,45 @@
-  class Injector
-
-    module Filter
-      extend ActiveSupport::Concern
-      included do
-        append_after_filter :add_script
-
-        CLOSING_BODY_TAG = %r{</body>}
-
-        def add_script
-          response.body = response.body.gsub(CLOSING_BODY_TAG, "<script>
-            var trackingCode = function() {
-
-              !function(g,s,q,r,d){r=g[r]=g[r]||function(){(r.q=r.q||[]).push(
-                arguments)};d=s.createElement(q);q=s.getElementsByTagName(q)[0];
-          d.src='//d1l6p2sc9645hc.cloudfront.net/tracker.js';q.parentNode.
-          insertBefore(d,q)}(window,document,'script','_gs');
-          _gs('#{Gosquared.configure.site_token}'); _gs('set', 'trackLocal', true);
-          };
-
-          var loadTracker;
-          loadTracker=function(){
-            if(!window._gs) {
+class Injector
+  module Filter
+    extend ActiveSupport::Concern
+    included do
+      append_after_filter :add_gosquared_script, :if => :html_response?
+
+      CLOSING_HEAD_TAG = %r{</body>}
+
+      def add_gosquared_script
+        response.body = response.body.gsub(CLOSING_HEAD_TAG, "<script type='text/javascript' async='true'>
+          var trackingCode = function(){
+            !function(g,s,q,r,d){r=g[r]=g[r]||function(){(r.q=r.q||[]).push(
+              arguments)};d=s.createElement(q);q=s.getElementsByTagName(q)[0];
+        d.src='//d1l6p2sc9645hc.cloudfront.net/tracker.js';q.parentNode.
+        insertBefore(d,q)}(window,document,'script','_gs');
+        _gs('GSN-589158-M'); _gs('set', 'trackLocal', true);
+        _gs('event', '#{request.headers["PATH_INFO"]}', {
+          extra: 'event',
+          details: true
+          });
+        };
+
+        var loadTracker;
+        loadTracker=function(){
+          if(!window._gs) {
+            trackingCode();
+            } else {
+              delete _gs;
               trackingCode();
-              } else {
-                delete _gs;
-                trackingCode();
-              }
-              };
-              $(document).on('page:load', loadTracker)
-              $(document).on('turbolinks:load', loadTracker);
-              </script>" + "\n </body>")
-
-        end
+            }
+            };
+            $(document).on('page:load', loadTracker)
+            $(document).on('turbolinks:load', loadTracker);
+            </script>" + "\n </body>"
+            )
+      end
 
+      def html_response?
+        response.content_type == "text/html"
       end
-    end
 
+    end
   end
+
+end

data/spec/tracker_inject_spec.rb

@@ -0,0 +1,65 @@
+require "spec_helper"
+
+if defined?(Rails)
+
+  class ApplicationController < ActionController::Base
+
+    after_filter :add_gosquared_script, :if => :html_response?
+
+    def add_gosquared_script
+      response.body = response.body.gsub(CLOSING_HEAD_TAG, "<script type='text/javascript' async='true'>
+        var trackingCode = function(){
+          !function(g,s,q,r,d){r=g[r]=g[r]||function(){(r.q=r.q||[]).push(
+            arguments)};d=s.createElement(q);q=s.getElementsByTagName(q)[0];
+      d.src='//d1l6p2sc9645hc.cloudfront.net/tracker.js';q.parentNode.
+      insertBefore(d,q)}(window,document,'script','_gs');
+      _gs('GSN-589158-M'); _gs('set', 'trackLocal', true);
+      _gs('event', '#{request.headers["PATH_INFO"]}', {
+        extra: 'event',
+        details: true
+        });
+      };
+
+      var loadTracker;
+      loadTracker=function(){
+        if(!window._gs) {
+          trackingCode();
+          } else {
+            delete _gs;
+            trackingCode();
+          }
+          };
+          $(document).on('page:load', loadTracker)
+          $(document).on('turbolinks:load', loadTracker);
+          </script>" + "\n </body>"
+          )
+    end
+
+    def html_response?
+      response.content_type == "text/html"
+    end
+  end
+
+  describe ApplicationController, :type => :controller do
+    controller do
+      def index
+        render :html => true
+      end
+
+      def new
+        render :json => true
+      end
+    end
+
+    it "adds the GoSquared tracking code if response HTML" do
+     expect(controller).to receive(:add_gosquared_script)
+     get :index
+   end
+
+   it "does not add the GoSquared tracking code if response not HTML" do
+     expect(controller).not_to receive(:add_gosquared_script)
+     get :new
+   end
+
+ end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gosquared
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3
 platform: ruby
 authors:
 - Russell Vaughan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-14 00:00:00.000000000 Z
+date: 2016-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -68,6 +68,7 @@ files:
 - spec/now_spec.rb
 - spec/people_spec.rb
 - spec/spec_helper.rb
+- spec/tracker_inject_spec.rb
 - spec/tracking_spec.rb
 - spec/trends_spec.rb
 homepage: https://github.com/gosquared/ruby-client
@@ -90,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: GoSquared Ruby Library
@@ -100,5 +101,6 @@ test_files:
 - spec/now_spec.rb
 - spec/people_spec.rb
 - spec/spec_helper.rb
+- spec/tracker_inject_spec.rb
 - spec/tracking_spec.rb
 - spec/trends_spec.rb