gosquared 1.0.3 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2cb0d96bd28e30dea4b869f9f94afe24b697f59d
-  data.tar.gz: 6a9b3f21a35ca37f09a0aa6a3f260664913e675f
+  metadata.gz: 2c9fe8b01e1133ea8e5a1d3a9b58dac91633cb15
+  data.tar.gz: 05501768ac59a9f9117e94ea6b0eff4c3af1a4a6
 SHA512:
-  metadata.gz: 067cae35ed70d8f8bd9197c978eda94f8b07af7df6d7558a589084aa697c99ffb269e55b45956c858f8eb573f77d00bec6b26feeab7f4e8a887cde4b71b458bf
-  data.tar.gz: 9181f9ccc43a923e14c69a1d7a5440741d8fc35f8a0a60247f3297f81243ebeedf9901c05a9979764640cb38e04e900ac15615192a7e7dd8d600a02940ac93e4
+  metadata.gz: 5a174baff33c17ef135723f2d80f04fa0c53b15f73ac4dffb835f7f9f6ff3846cb71a8a2e90252e3648add9d43b16ca8acc3a50df0c02ee4a39821bd0e04e6ff
+  data.tar.gz: f4c11daa660cca3cad03022a5db5d646dfb166a8177adf8b60f39d05e717faa7422000e4ebd5c1328490ac05b01bc56c2f3cfd7e7c73884d3ecc2c98485b4010

data/README.md

@@ -1,19 +1,34 @@
 ## GoSquared Ruby Gem
 
-[![Build Status](https://travis-ci.org/gosquared/ruby-gem.svg?branch=master)](https://travis-ci.org/gosquared/ruby-gem)
+[![Build Status](https://travis-ci.org/gosquared/ruby-client.svg?branch=master)](https://travis-ci.org/gosquared/ruby-gem)
 
 **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**
 
-This gems works with the [GoSquared API](https://www.gosquared.com/docs/api/), making it simple to integrate GoSquared with your Rails app. You can use it for both fetching metrics from your GoSquared account and also posting new events and contacts. 
+This gems works with the [GoSquared API](https://www.gosquared.com/docs/api/), making it simple to integrate GoSquared with your Rails app. You can use it for both fetching metrics from your GoSquared account and also posting new events and contacts.
 
 All functions listed in the API documentation are methods you can call on the GoSquared class.
 
 #Installation
 
 ```ruby
-gem install gosquared 
+gem install gosquared
 ```
 
+Then require GoSquared in your application
+
+```ruby
+require 'gosquared'
+```
+
+If you’d like to quickly install your GoSquared javascript tracking code on all of your Rails’ views, you can easily run:
+
+```ruby
+rails generate go_squared:config ‘your_site_token'
+```
+
+This will insert a ```<script>``` tag automatically before the closing ```</body>``` tag on each view rendered.
+
+
 #Tracking API
 This is for sending data to GoSquared. It allows you to track:
 * Events
@@ -23,9 +38,9 @@ This is for sending data to GoSquared. It allows you to track:
 ##Track Events
 ```ruby
 
-gs = GoSquared.new("your_API_key","your_project_token")
+gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
 
-gs.tracking.event({event: {name: 'event'}})
+gs.tracking.event({ event: { name: 'event' } })
 
 #builds the url to the 'GoSquared Tracking' endpoint with the "events" dimension and an event to add to the events list
 
@@ -41,9 +56,12 @@ Reponse Message: OK
 ##Track Transactions
 
 ```ruby
-gs = GoSquared.new("your_API_key","your_project_token")
+gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
 
-gs.tracking.transaction({ transaction: {id: "1", revenue: 50, quantity: 1, previous_transaction_timestamp: Time.new } })
+gs.tracking.transaction({
+  transaction: { id: "1", revenue: 50, quantity: 1,
+  previous_transaction_timestamp: Time.new }
+  })
 
 gs.tracking.post
 
@@ -53,9 +71,27 @@ Reponse Message: OK
 
 ##Track People
 ```ruby
-gs = GoSquared.new("your_API_key","your_project_token")
-
-gs.tracking.identify({person_id:"email:example_email@example.com", properties: {first_name: 'Example', last_name: "User", created_at: Time.new, custom: {any: "properties", you: "would_like" } })
+gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
+
+gs.tracking.identify({
+  person_id: "email:user@test.com", # Required
+
+  # Reserved property names
+  properties: {
+    name: "Test User",
+    username: "testuser",
+    phone: "+44123456789",
+    created_at:"2016-06-07T15:44:20Z", # ISO 8601 formatted String
+    company_name:"GoSquared",
+    company_industry:"Customer Analytics",
+    company_size: 15000,
+
+    # Custom properties
+    custom: {
+      # custom_property_name: "custom property value"
+    }
+  }
+})
 
 gs.tracking.post
 
@@ -77,7 +113,7 @@ The Now API provides real-time concurrent information about your sites and apps,
 _Now Example:_
 
 ```ruby
-gs = GoSquared.new("your_API_key","your_project_token")
+gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
 
 #instantiates new GoSquared object
 
@@ -98,7 +134,7 @@ The Trends API provides historical analytics information for any given period in
 _Trends Example:_
 
 ```ruby
-gs = GoSquared.new("your_API_key","your_project_token")
+gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
 
 gs.trends.browser.from('2016-06-30').to('2016-07-07')
 
@@ -117,7 +153,7 @@ gs.trends.fetch
 
 ```ruby
 
-gs = GoSquared.new("your_API_key","your_project_token")
+gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
 
 gs.people.smartgroups
 
@@ -136,7 +172,7 @@ _Account Example:_
 
 ```ruby
 
-gs = GoSquared.new("your_API_key","your_project_token")
+gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
 
 gs.account.blocked.ips.ip('5.10.148.50')
 
@@ -149,7 +185,7 @@ gs.account.post
 Reponse Message: OK
 => #<Net::HTTPOK 200 OK readbody=true>
 
-gs.account.sites.token("you_site_token")
+gs.account.sites.token("your_site_token")
 
 #builds the url to the 'GoSquared Account' endpoint with the "Sites" dimension and token you want to retrieve the site by.
 

data/lib/config.rb

@@ -0,0 +1,16 @@
+module GoSquared
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    block_given? ? yield(configuration) : configuration
+  end
+
+  class Configuration
+    attr_accessor :site_token
+  end
+
+end

data/lib/gosquared.rb

@@ -1,34 +1,40 @@
-require_relative './gosquared/trends'
-require_relative './gosquared/tracking'
-require_relative './gosquared/people'
-require_relative './gosquared/now'
-require_relative './gosquared/account'
+require 'tracker_inject/railtie' if defined? (Rails)
+require_relative "gosquared/trends"
+require_relative "gosquared/tracking"
+require_relative "gosquared/people"
+require_relative "gosquared/now"
+require_relative "gosquared/account"
+require_relative "config"
 
-class GoSquared 
+module GoSquared
 
-	def initialize api_key, site_id
-		@api_key = api_key
-		@site_id = site_id
-	end
+	class RubyLibrary
 
-	def trends
-		@trends ||= Trends.new(@api_key, @site_id)
-	end
+		def initialize api_key, site_id
+			@api_key = api_key
+			@site_id = site_id
+		end
 
-	def tracking 
-		@tracking ||= Tracking.new(@api_key, @site_id)
-	end
+		def trends
+			@trends ||= Trends.new(@api_key, @site_id)
+		end
 
-	def people 
-		@people ||=  People.new(@api_key, @site_id)
-	end
+		def tracking
+			@tracking ||= Tracking.new(@api_key, @site_id)
+		end
 
-	def now 
-		@now ||= Now.new(@api_key, @site_id)
-	end
+		def people
+			@people ||=  People.new(@api_key, @site_id)
+		end
+
+		def now
+			@now ||= Now.new(@api_key, @site_id)
+		end
+
+		def account
+			@account ||= Account.new(@api_key, @site_id)
+		end
 
-	def account 
-		@account ||= Account.new(@api_key, @site_id)
 	end
 
-end
+end

data/lib/gosquared/account.rb

@@ -1,7 +1,7 @@
-require_relative 'client'
+require_relative "client"
 
 class Account
-	
+
 	BASEURL = "https://api.gosquared.com/account/v1/"
 	DIMENSIONS = %w(blocked feeds reportPreferences sharedUsers sites taggedVisitors triggerTypes webhooks)
 	DIMENSION_FILTER = %w(token webhookID visitorID triggerType)
@@ -70,7 +70,7 @@ class Account
 		@visitor = "/visitors/#{id}"
 		self
 	end
-	
+
 	def build_url(ips = @ips)
 		array = [""]
 		@url = BASEURL + @dimension + @dimension_filter + @visitor + @bots + ips +
@@ -80,4 +80,4 @@ class Account
 		@url = @url.concat(parameters)
 	end
 
-end
+end

data/lib/gosquared/now.rb

@@ -1,12 +1,12 @@
-require_relative 'client'
+require_relative "client"
 class Now
 
 	BASEURL = "https://api.gosquared.com/now/v3/"
-	DIMENSIONS = %w(browsers campaigns concurrents engagement geo languages notifications 
+	DIMENSIONS = %w(browsers campaigns concurrents engagement geo languages notifications
 		organisations overview pages platforms sources time timeSeries visitors)
-@@filters = {dateFormat: @date_format, from: @from, to: @to, 
-	format: @format, limit: @limit, sort: @sort, 
-	presenter: @presenter, visitors_mode: @string, href: @href, 
+@@filters = {dateFormat: @date_format, from: @from, to: @to,
+	format: @format, limit: @limit, sort: @sort,
+	presenter: @presenter, visitors_mode: @string, href: @href,
 	drill_limit: @drill_limit, sections: @sections,
 	minimal: @minimal, interval: @interval}
 
@@ -19,10 +19,10 @@ class Now
 
 	DIMENSIONS.each do |dimension|
 		define_method dimension do
-			@dimension = dimension 
+			@dimension = dimension
 			self
 		end
-	end	
+	end
 
 	@@filters.each do |key, value|
 		define_method key do |argument|
@@ -36,7 +36,7 @@ class Now
 		@@filters.each{|key, value| @@filters[key]=nil} if data
 		data
 	end
-	
+
 	private
 
 	def url
@@ -47,4 +47,4 @@ class Now
 		@url = @url.concat(parameters)
 	end
 
-end
+end

data/lib/gosquared/people.rb

@@ -1,10 +1,10 @@
-require_relative 'client'
+require_relative "client"
 class People
 
 	BASEURL = "https://api.gosquared.com/people/v1/"
 	VERSION = %w(v1 v2 v3)
 	DIMENSIONS = %w(devices eventTypes people propertyTypes feed smartgroups)
-	@@filters = {query: @query, filters: @filters, sort: @sort, 
+	@@filters = {query: @query, filters: @filters, sort: @sort,
 		format: @presenter, limit: @limit, type: @type, from: @from, to: @to}
 
 		def initialize(api_key, site_token, client =Client.new)
@@ -17,7 +17,7 @@ class People
 
 		DIMENSIONS.each do |dimension|
 			define_method dimension do |options = ""|
-				@dimension = dimension 
+				@dimension = dimension
 				@data = options
 				self
 			end
@@ -34,7 +34,7 @@ class People
 			@person_id = "/" + object
 			@person_filter = "/" + filter
 			self
-		end 
+		end
 
 		def fetch
 			data = @client.get(url)
@@ -44,11 +44,11 @@ class People
 
 		def url
 			array = [""]
-			url = BASEURL + @dimension + @person_id + @person_filter + 
+			url = BASEURL + @dimension + @person_id + @person_filter +
 			"?api_key=#{@api_key}" + "&site_token=#{@site_token}"
 			@@filters.each { |key, value| array << "#{key}=#{value}" if value }
 			parameters=array.join('&')
 			url.concat(parameters)
 		end
 
-	end
+	end

data/lib/gosquared/tracking.rb

@@ -1,8 +1,8 @@
-require_relative 'client'
+require_relative "client"
 	class Tracking
 
 		BASEURL = "https://api.gosquared.com/tracking/v1/"
-		DIMENSIONS = %w(event identify pageview ping properties timeout transaction)	
+		DIMENSIONS = %w(event identify pageview ping properties timeout transaction)
 
 		def initialize(api_key, site_token, client=Client.new)
 			@site_token = site_token
@@ -12,7 +12,7 @@ require_relative 'client'
 
 		DIMENSIONS.each do |dimension|
 			define_method dimension do |options|
-				@dimension = dimension 
+				@dimension = dimension
 				@data = options
 				self
 			end
@@ -25,7 +25,7 @@ require_relative 'client'
 		end
 
 		def url
-			url = BASEURL + @dimension + "?api_key=#{@api_key}" + "&site_token=#{@site_token}" 
+			url = BASEURL + @dimension + "?api_key=#{@api_key}" + "&site_token=#{@site_token}"
 		end
 
-	end
+	end

data/lib/gosquared/trends.rb

@@ -1,9 +1,9 @@
-require_relative 'client'
+require_relative "client"
 	class Trends
 
 		BASEURL = "https://api.gosquared.com/trends/v2/"
 		DIMENSIONS = %w(aggregate browser category country event language organisation os page path1 product screenDimensions sources transactions)
-		@@filters = {date_format: @date_format, from: @from, to: @to, 
+		@@filters = {date_format: @date_format, from: @from, to: @to,
 			format: @format, limit: @limit, sort: @sort, group: @group}
 
 			def initialize(api_key, site_token, client=Client.new)
@@ -14,10 +14,10 @@ require_relative 'client'
 
 			DIMENSIONS.each do |dimension|
 				define_method dimension do
-					@dimension = dimension 
+					@dimension = dimension
 					self
 				end
-			end	
+			end
 
 			@@filters.each do |key, value|
 				define_method key do |argument|
@@ -41,4 +41,4 @@ require_relative 'client'
 				parameters=array.join('&')
 				url.concat(parameters)
 			end
-		end
+		end

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

@@ -0,0 +1,16 @@
+require 'rails/generators/base'
+
+module GoSquared
+  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("go_squared.rb.erb", File.join("config/initializers/go_squared.rb"))
+      end
+    end
+  end
+end

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

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

data/lib/tracker_inject/injector.rb

@@ -0,0 +1,39 @@
+  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) {
+              trackingCode();
+              } else {
+                delete _gs;
+                trackingCode();
+              }
+              };
+              $(document).on('page:load', loadTracker)
+              $(document).on('turbolinks:load', loadTracker);
+              </script>" + "\n </body>")
+
+        end
+
+      end
+    end
+
+  end

data/lib/tracker_inject/railtie.rb

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

data/spec/people_spec.rb

@@ -1,24 +1,24 @@
 describe People do
 	subject(:gs) { described_class.new("demo", "GSN-106863-S") }
-	
-	People::DIMENSIONS.each do |dimension|	
-		before do 
+
+	People::DIMENSIONS.each do |dimension|
+		before do
 			data = '{"a": [{"test": "response"}]}'
-			stub_request(:get, "https://api.gosquared.com/people/v1/#{dimension}?api_key=demo&site_token=GSN-106863-S" 
+			stub_request(:get, "https://api.gosquared.com/people/v1/#{dimension}?api_key=demo&site_token=GSN-106863-S"
 				).
 			with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
 			to_return(status: 200, body: data, headers: {})
 		end
 	end
 
-	People::DIMENSIONS.each do |dimension|	
+	People::DIMENSIONS.each do |dimension|
 		it "fetches a request from the GoSquared People API with #{dimension} dimension" do
 			gs.send "#{dimension}"
 			expect(gs.fetch).to eq("a" => [{"test"=>"response"}])
 		end
 	end
 
-	before do 
+	before do
 		data = '{"a": [{"test": "response"}, {"with": "params"}]}'
 		stub_request(:get, "https://api.gosquared.com/people/v1/people/example.email@example.com/devices?api_key=demo&site_token=GSN-106863-S").
 		with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Host'=>'api.gosquared.com', 'User-Agent'=>'Ruby'}).
@@ -31,8 +31,8 @@ describe People do
 	end
 
 
-	People::DIMENSIONS.each do |dimension|	
-		before do 
+	People::DIMENSIONS.each do |dimension|
+		before do
 			data = '{"a": [{"test": "response"}, {"with": "params"}]}'
 			stub_request(:get, "https://api.gosquared.com/people/v1/#{dimension}?api_key=demo&site_token=GSN-106863-S&limit=5").
 			with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Host'=>'api.gosquared.com', 'User-Agent'=>'Ruby'}).
@@ -40,7 +40,7 @@ describe People do
 		end
 	end
 
-	GoSquared::People::DIMENSIONS.each do |dimension|
+	People::DIMENSIONS.each do |dimension|
 		it "fetches a request from the GoSquared People API with dimension and paramaters" do
 			gs.send("#{dimension}").limit(5)
 			expect(gs.fetch).to eq("a" => [{"test"=>"response"}, {"with"=>"params"}])
@@ -48,4 +48,4 @@ describe People do
 	end
 
 
-end
+end

data/spec/trends_spec.rb

@@ -1,8 +1,8 @@
-describe Trends do 
+describe Trends do
 	subject(:gs) { described_class.new("demo","GSN-106863-S") }
 
-GoSquared::Trends::DIMENSIONS.each do |dimension|	
-	before do 
+	Trends::DIMENSIONS.each do |dimension|
+		before do
 			data = '{"a": [{"test": "response"}]}'
 			stub_request(:get, "https://api.gosquared.com/trends/v2/#{dimension}?api_key=demo&site_token=GSN-106863-S").
 			with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
@@ -10,15 +10,15 @@ GoSquared::Trends::DIMENSIONS.each do |dimension|
 		end
 	end
 
-	GoSquared::Trends::DIMENSIONS.each do |dimension|	
+	Trends::DIMENSIONS.each do |dimension|
 		it "fetches a request from the GoSquared Trends API with #{dimension} dimension" do
 			gs.send "#{dimension}"
 			expect(gs.fetch).to eq("a" => [{"test"=>"response"}])
 		end
 	end
 
-GoSquared::Trends::DIMENSIONS.each do |dimension|	
-	before do 
+	Trends::DIMENSIONS.each do |dimension|
+		before do
 			data = '{"a": [{"test": "response"}, {"with": "params"}]}'
 			stub_request(:get, "https://api.gosquared.com/trends/v2/#{dimension}?api_key=demo&site_token=GSN-106863-S&date_format=yyyy-mm-dd&format=json&from=2016-06-20&group=true&limit=5&site_token=GSN-106863-S&sort=visits&to=2016-06-30").
 			with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Host'=>'api.gosquared.com', 'User-Agent'=>'Ruby'}).
@@ -26,12 +26,12 @@ GoSquared::Trends::DIMENSIONS.each do |dimension|
 		end
 	end
 
-GoSquared::Trends::DIMENSIONS.each do |dimension|	
-	it "fetches a request from the GoSquared Trends API with #{dimension} dimension and paramaters" do
-	gs.send("#{dimension}").from('2016-06-20').to('2016-06-30')
-	.date_format('yyyy-mm-dd').sort('visits').group(true).format('json').limit(5)
-	expect(gs.fetch).to eq("a" => [{"test"=>"response"}, {"with"=>"params"}])
-end
-end
+	Trends::DIMENSIONS.each do |dimension|
+		it "fetches a request from the GoSquared Trends API with #{dimension} dimension and paramaters" do
+			gs.send("#{dimension}").from('2016-06-20').to('2016-06-30')
+			.date_format('yyyy-mm-dd').sort('visits').group(true).format('json').limit(5)
+			expect(gs.fetch).to eq("a" => [{"test"=>"response"}, {"with"=>"params"}])
+		end
+	end
 
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gosquared
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 2.0.0
 platform: ruby
 authors:
 - Russell Vaughan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-12 00:00:00.000000000 Z
+date: 2016-09-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -50,6 +50,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- lib/config.rb
 - lib/gosquared.rb
 - lib/gosquared/account.rb
 - lib/gosquared/client.rb
@@ -57,6 +58,10 @@ files:
 - lib/gosquared/people.rb
 - lib/gosquared/tracking.rb
 - lib/gosquared/trends.rb
+- lib/rails/generators/go_squared/config/config_generator.rb
+- lib/rails/generators/go_squared/config/templates/go_squared.rb.erb
+- lib/tracker_inject/injector.rb
+- lib/tracker_inject/railtie.rb
 - spec/account_spec.rb
 - spec/client_spec.rb
 - spec/now_spec.rb