gosquared-rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 29ecc8597ac248b671b4b05b4fb9c22d834c991a
+  data.tar.gz: d1265f50e4ac015bd70a0a822b00bfb596ddb433
+SHA512:
+  metadata.gz: 0a29e5ad98dca630c1ea21b0d66312b35e573c74b2b89706242d5c089873326674a9d01beaf79c34002586e2480a1470aeb06f5cc42bb2d990c55df4bce3e7aa
+  data.tar.gz: 2b3e393ef71184910d13b6ccf9e22ac1e0c5e3937421c7eb77e3f5b1da039d3e3d3914c901cf15a2868560c733a2e792091878e67bab962256624bfe0628e8cb

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+ruby '2.2.2'
+
+group :development, :test do
+gem 'combustion', '~> 0.5.5', :group => :test
+gem 'rspec-rails'
+gem 'generator_spec'
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015-2016 Go Squared Ltd.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+## GoSquared Rails Gem
+
+[![Build Status](https://travis-ci.org/gosquared/gosquared-rails.svg?branch=master)](https://travis-ci.org/gosquared/gosquared-rails)
+
+The GoSquared Rails Gem will allow you to quickly and easily install GoSquared Chat, Anayltics and People in your Rails app.
+
+If you are looking to interact with our Tracking or Reporting API's, you can do so by using our [Ruby Client]
+(https://github.com/gosquared/ruby-client)
+
+Note, this gem will inject the GoSquared JavaScript snippet as well as GoSquared Identify method in your front end. If you currently have GoSquared JavaScript snippets in place, this can create a conflict.
+
+**This is an early beta, please open an issue if you find anything not working, or to leave feedback for improvement. You can also get in touch directly: russell@gosquared.com**
+
+### Install of Analytics and Chat
+
+With the GoSquared Rails gem you can 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 have a GoSquared account and you can sign up for one [here](https://www.gosquared.com/join/) and get your project token. Then you can quickly add the code to all of your Rails’ views by running this:
+
+```ruby
+rails generate gosquared_rails:config 'your_project_token'
+```
+
+This will insert a `<script>` tag automatically before the closing `</head>` 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
+```
+
+### Configuration
+
+To configure GoSquared Analytics tracking, you can do so in ```conifg/initializers/gosquared_rails.rb```
+
+```ruby
+config.track_local = true
+```
+Whether to track data and load Live Chat on local pages/sites (using the file:// protocol, or on localhost). This helps prevent local development from polluting your stats.
+
+```ruby
+config.anonymize_ip = true
+```
+Setting this value to true will prevent the visitors' IP address from being tracked.
+
+```ruby
+config.cookie_domain = '.your-domain.com'
+```
+By default, cookie_domain will be the current domain (including subdomain). This means that IDs will not be shared across subdomains. Set this to .your-domain.com to enable accurate cross-subdomain tracking.
+
+```ruby
+config.use_cookies = false
+```
+Set to false to disable usage of cookies in the tracker (for example, if your site is subject to strict cookie legislation). This will mean that certain parts of GoSquared will be inaccurate.
+
+```ruby
+config.referrer = 'some_other_domain'
+```
+Use this option to override the value of the page's referring URL. This is useful if you know the source of the pageview via another tracking system.
+
+```ruby
+config.track_hash = true
+```
+Whether to track hashes in the page URL, for example /home#my-hash will, by default, be tracked as /home.
+
+```ruby
+config.track_params = false
+```
+Whether to track URL querystring parameters, for example /home?my=query&string=true will be tracked as /home if this is set to false.
+
+For more details on configuration, you can view the docs here https://www.gosquared.com/docs/api/javascript-tracking-code/configuration#
+
+### Installation of People
+
+If you have a user system and would like to track down to an individual user level, you can do so by including the GoSquared Identify Method in your ApplicationController (or any indvidual controller you would like to track.)
+
+```ruby
+append_after_filter  {|controller| controller.add_gosquared_identify_method your_current_user_object }
+```
+
+Then just define the following method in the respective controller and pass in a hash of any properties you'd like to track
+
+```ruby
+def gosquared_user_properties
+GosquaredRails.configure.custom_properties = {id: current_user_object.id, email: current_user_object.email,
+                                               phone: current_user_object.phone_number,
+                                               monthly_mrr: current_user_object.mrr,
+                                               role_of_user: current_user_object.role
+                                               any_other_property: 'you'd like to track'}
+end
+```
+
+This will insert a `<script>` tag automatically before the closing `</body>` tag on each view rendered.
+
+
+#Tests
+
+```ruby
+rspec
+```

data/lib/configuration.rb

@@ -0,0 +1,60 @@
+module GosquaredRails
+  class Configuration
+    attr_accessor :site_token, :track_local, :anonymize_ip, :cookie_domain,
+    :use_cookies, :referrer, :track_hash, :track_params, :identified_user, :custom_properties
+
+    def initialize
+      @site_token = nil
+      @track_local = nil
+      @anonymize_ip = nil
+      @cookie_domain = nil
+      @use_cookies = nil
+      @referrer = nil
+      @track_hash = nil
+      @track_params = nil
+      @identified_user = nil
+      @custom_properties = nil
+    end
+
+    def config_options
+      @configurations = [set_track_local, set_anonymize_ip,
+        set_cookie_domain, set_use_cookies, set_referrer, set_track_hash, set_track_params]
+        @display_config = []
+        @configurations.each do |config|
+          @display_config << config if config
+        end
+        @display_config.join(" ")
+      end
+
+      def set_track_local
+       "_gs('set', 'trackLocal', true);" if track_local == true
+     end
+
+     def set_anonymize_ip
+       "_gs('set', 'anonymizeIP', true);" if @anonymize_ip == true
+     end
+
+     def set_cookie_domain
+       "_gs('set', 'cookieDomain', '#{@cookie_domain}');" if @cookie_domain
+     end
+
+     def set_use_cookies
+       "_gs('set', 'useCookies', false);" if @use_cookies == false
+     end
+
+     def set_referrer
+       "_gs('set', 'referrer', '#{@referrer}');" if @referrer
+     end
+
+     def set_track_hash
+      "_gs('set', 'trackHash', true);" if @track_hash == true
+    end
+
+    def set_track_params
+      "_gs('set', 'trackParams', false);" if @track_params == false
+    end
+
+   end
+ end
+
+

data/lib/gosquared-rails.rb

@@ -0,0 +1,17 @@
+require 'tracker_inject/railtie' if defined? (Rails)
+require_relative "configuration"
+
+module GosquaredRails
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def self.configure
+   block_given? ? yield(configuration) : configuration
+  end
+
+end

data/lib/rails/generators/gosquared_rails/config/config_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators/base'
+
+module GosquaredRails
+  module Generators
+    class ConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      argument :site_token
+
+      def copy_initializer_file
+        @site_token = site_token
+        template("gosquared_rails.rb.erb", File.join("config/initializers/gosquared_rails.rb"))
+      end
+    end
+  end
+end

data/lib/rails/generators/gosquared_rails/config/templates/gosquared_rails.rb.erb

@@ -0,0 +1,3 @@
+GosquaredRails.configure do |config|
+  config.site_token = ENV["GOSQUARED_SITE_TOKEN"] || "<%= @site_token %>"
+end

data/lib/tracker_inject/injector.rb

@@ -0,0 +1,85 @@
+require_relative "property_config.rb"
+
+class Injector
+  module Filter
+    extend ActiveSupport::Concern
+    included do
+      append_after_filter :add_gosquared_script, :if => :html_response?
+
+      CLOSING_HEAD_TAG = %r{</head>}
+      CLOSING_BODY_TAG = %r{</body>}
+
+      def add_gosquared_script
+        response.body = response.body.gsub(CLOSING_HEAD_TAG, "<script>
+
+          (function() {
+            if (window._gs) return;
+              !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('#{GosquaredRails.configure.site_token}', false);
+        #{GosquaredRails.configure.config_options}
+
+
+        function track() {
+          _gs('track');
+        }
+        $(document).on('page:load', track);
+        $(document).on('turbolinks:load', track);
+
+        $(document)
+        .on('turbolinks:before-render', function(event){
+          var chat = $('[id^=\"gs_\"]');
+          if (chat.length) {
+            chat
+            .detach()
+            .appendTo(event.originalEvent.data.newBody);
+          }
+          })
+        .on('turbolinks:render', function() {
+          try {
+            window.dispatchEvent(new Event('resize'));
+            } catch (e) {}
+            })
+})();
+
+</script>" + "\n </head>"
+)
+end
+
+def add_gosquared_identify_method(current_user)
+  if current_user
+    begin
+      gosquared_user_properties
+    rescue NameError
+      STDERR.puts "ERROR: The #gosquared_user_properties method must be added to the respective controller, please see docs"
+    end
+    populate_script
+  end
+end
+
+private
+
+def populate_script(property_config=PropertyConfig.new)
+ unless GosquaredRails.configure.custom_properties.nil?
+  property_config.sort_property_fields(GosquaredRails.configure.custom_properties)
+  response.body = response.body.gsub(CLOSING_BODY_TAG, "<script>
+    _gs('identify',
+      #{property_config.gosquared_standard_properties}
+      #{property_config.gosquared_custom_properties}
+      });
+  </script>" + "\n </body>"
+  )
+end
+end
+
+def html_response?
+  response.content_type == "text/html"
+end
+
+end
+
+end
+
+end

data/lib/tracker_inject/property_config.rb

@@ -0,0 +1,47 @@
+
+class PropertyConfig
+
+def sort_property_fields(hash)
+  validate_properties(hash)
+  property_fields = ['id', 'email', 'name', 'first_name', 'last_name',
+    'username', 'phone', 'created_at']
+
+    @standard_properties_hash = {}
+    @custom_properties_hash = {}
+    hash.each do | key, value |
+      property_fields.each do | property |
+       if key.to_s === property
+        @standard_properties_hash[key] = value
+        hash.except!(key)
+      end
+      @custom_properties_hash = hash
+    end
+  end
+end
+
+def gosquared_custom_properties
+  @custom_properties = "custom: { \n "
+  @custom_properties_hash.each do |key, value|
+   @custom_properties  << "#{key}: '#{value}',\n "
+ end
+ @custom_properties << '}'
+end
+
+def gosquared_standard_properties
+  @standard_properties =  " { \n "
+  @standard_properties_hash.each do |key, value|
+   @standard_properties  << "#{key}: '#{value}',\n "
+ end
+ @standard_properties << '}' if @custom_properties == "custom: { \n }"
+ @standard_properties
+end
+
+private
+
+def validate_properties(property_hash)
+  unless property_hash.key?(:id) || property_hash.key(:email)
+  STDERR.puts "ERROR: GoSquared User properties must include id or email address"
+end
+end
+
+end

data/lib/tracker_inject/railtie.rb

@@ -0,0 +1,8 @@
+require_relative 'injector'
+module GosquaredRails
+  class GoSquaredRailtie < Rails::Railtie
+    initializer "my_initialization" do |app|
+      ActionController::Base.send(:include, Injector::Filter)
+    end
+  end
+end

data/spec/configuration_spec.rb

@@ -0,0 +1,104 @@
+require 'spec_helper'
+
+describe GosquaredRails::Configuration do
+
+  subject(:gs) { described_class.new() }
+
+  describe '#site_token' do
+    it 'responds to #site_token' do
+      expect(gs).to respond_to(:site_token)
+    end
+  end
+
+  describe '#set_local_configuration' do
+    it 'returns _gs track local when track_local is true' do
+      gs.track_local = true
+      expect(gs.set_track_local).to eq("_gs('set', 'trackLocal', true);")
+    end
+
+    it 'returns nil when not  true' do
+      expect(gs.set_track_local).to eq nil
+    end
+
+  end
+
+  describe '#set_anonymize_ip' do
+    it 'returns _gs anonymize_ip true' do
+      gs.anonymize_ip = true
+      expect(gs.set_anonymize_ip).to eq("_gs('set', 'anonymizeIP', true);")
+    end
+
+    it 'returns nil when anonymize_ip is not true' do
+      expect(gs.set_anonymize_ip).to eq nil
+    end
+  end
+
+  describe '#set_use_cookies' do
+    it 'returns _gs useCookies true when use_cookies is true' do
+      gs.use_cookies = false
+      expect(gs.set_use_cookies).to eq("_gs('set', 'useCookies', false);")
+    end
+    it 'returns nil when use_cookies is not true' do
+      expect(gs.set_use_cookies).to eq nil
+    end
+  end
+
+  describe '#set_cookie_domain' do
+    it 'returns _gs cookieDomain undefined when cookie_domain is true' do
+      gs.cookie_domain = '.your_domain.com'
+      expect(gs.set_cookie_domain).to eq("_gs('set', 'cookieDomain', '.your_domain.com');")
+    end
+    it 'returns nil when cookie_domain is not true' do
+      expect(gs.set_cookie_domain).to eq nil
+    end
+  end
+
+
+  describe '#set_referrer' do
+    it 'returns _gs referrer document.referrer when referrer is true' do
+      gs.referrer = 'some other url'
+      expect(gs.set_referrer).to eq("_gs('set', 'referrer', 'some other url');")
+    end
+    it 'returns nil when set_referrer is not true' do
+      expect(gs.set_referrer).to eq nil
+    end
+  end
+
+  describe '#set_track_hash' do
+    it 'returns _gs trackHash false when track_hash is true' do
+      gs.track_hash = true
+      expect(gs.set_track_hash).to eq("_gs('set', 'trackHash', true);")
+    end
+    it 'returns nil when track_hash is not true' do
+      expect(gs.set_track_hash).to eq nil
+    end
+  end
+
+  describe '#set_track_params' do
+    it 'returns _gs trackParams true when track_params is true' do
+      gs.track_params = false
+      expect(gs.set_track_params).to eq("_gs('set', 'trackParams', false);")
+    end
+  end
+
+  describe '#config_options' do
+    it 'responds to #config_options' do
+      expect(gs).to respond_to(:config_options)
+    end
+
+    it 'returns config option if value associated' do
+      expect(gs.config_options).to eq ""
+    end
+
+    it 'returns multiple config options if value associated' do
+     gs.track_hash = true
+     gs.track_params = false
+     expect(gs.config_options).to eq "_gs('set', 'trackHash', true); _gs('set', 'trackParams', false);"
+   end
+ end
+
+
+
+
+end
+