gosquared 2.0.0 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c9fe8b01e1133ea8e5a1d3a9b58dac91633cb15
-  data.tar.gz: 05501768ac59a9f9117e94ea6b0eff4c3af1a4a6
+  metadata.gz: 7d967932ba27cf17815ddf7836dbbd969f5134e1
+  data.tar.gz: 7d6d2759059c45e3c5c90fe7eb0829e76bb30dd4
 SHA512:
-  metadata.gz: 5a174baff33c17ef135723f2d80f04fa0c53b15f73ac4dffb835f7f9f6ff3846cb71a8a2e90252e3648add9d43b16ca8acc3a50df0c02ee4a39821bd0e04e6ff
-  data.tar.gz: f4c11daa660cca3cad03022a5db5d646dfb166a8177adf8b60f39d05e717faa7422000e4ebd5c1328490ac05b01bc56c2f3cfd7e7c73884d3ecc2c98485b4010
+  metadata.gz: eaa7ddda82cf174d6b294b5604306deea789443eafaa33eb2dfc528a2a82791885a4b2ab8d13fafc370b12e6b98eadc14cfde2ca7f64a231b5dc6061ad13fec0
+  data.tar.gz: a0daf661154404ce33a3babc590f3ce9c03a14434c36e70ff16a9bac262909edb4b361559d9f8b6665b599c5a4fbddf68c16b604462732f1f6d1a2728f182f42

data/README.md

@@ -8,6 +8,9 @@ This gems works with the [GoSquared API](https://www.gosquared.com/docs/api/), m
 
 All functions listed in the API documentation are methods you can call on the GoSquared class.
 
+You can generate an API key from your [GoSquared Account Settings](https://www.gosquared.com/settings/api).
+
+
 #Installation
 
 ```ruby
@@ -20,14 +23,22 @@ Then require GoSquared in your application
 require 'gosquared'
 ```
 
-If you’d like to quickly install your GoSquared javascript tracking code on all of your Rails’ views, you can easily run:
+### 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 go_squared:config ‘your_site_token'
+rails generate gosquared:config 'your_project_token'
 ```
 
-This will insert a ```<script>``` tag automatically before the closing ```</body>``` tag on each view rendered.
+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:
@@ -38,7 +49,7 @@ This is for sending data to GoSquared. It allows you to track:
 ##Track Events
 ```ruby
 
-gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
+gs = Gosquared::RubyLibrary.new("your_API_key","your_project_token")
 
 gs.tracking.event({ event: { name: 'event' } })
 
@@ -48,7 +59,7 @@ gs.tracking.post
 
 #posts the data to the 'GoSquared Tracking' endpoint
 
-Reponse Message: OK
+Response Message: OK
 => #<Net::HTTPOK 200 OK readbody=true>
 
 ```
@@ -56,7 +67,7 @@ Reponse Message: OK
 ##Track Transactions
 
 ```ruby
-gs = GoSquared::RubyLibrary.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,
@@ -65,13 +76,20 @@ gs.tracking.transaction({
 
 gs.tracking.post
 
-Reponse Message: OK
+Response Message: OK
 => #<Net::HTTPOK 200 OK readbody=true>
 ```
 
-##Track People
+##Create or Update People profiles
+
+This method is useful for importing existing user profiles into GoSquared people and updating profiles you have already added.
+
+It's highly recommended that you also implement the front end [javascript 'identify' method](https://www.gosquared.com/docs/api/javascript-tracking-code/identify-users) on your site. This enables us to track a the user's session activity and browser information against their People profile.
+
+We also recommend using an email address for the `person_id`. To do this, the email address needs to be prefixed with `email:` like in the example below. 
+
 ```ruby
-gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
+gs = Gosquared::RubyLibrary.new("your_API_key","your_project_token")
 
 gs.tracking.identify({
   person_id: "email:user@test.com", # Required
@@ -88,14 +106,14 @@ gs.tracking.identify({
 
     # Custom properties
     custom: {
-      # custom_property_name: "custom property value"
+      # custom_property_name: "custom property value"  # You can track as many custom properties as you like
     }
   }
 })
 
 gs.tracking.post
 
-Reponse Message: OK
+Response Message: OK
 => #<Net::HTTPOK 200 OK readbody=true>
 ```
 
@@ -113,7 +131,7 @@ The Now API provides real-time concurrent information about your sites and apps,
 _Now Example:_
 
 ```ruby
-gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
+gs = Gosquared::RubyLibrary.new("your_API_key","your_project_token")
 
 #instantiates new GoSquared object
 
@@ -134,7 +152,7 @@ The Trends API provides historical analytics information for any given period in
 _Trends Example:_
 
 ```ruby
-gs = GoSquared::RubyLibrary.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')
 
@@ -153,7 +171,7 @@ gs.trends.fetch
 
 ```ruby
 
-gs = GoSquared::RubyLibrary.new("your_API_key","your_project_token")
+gs = Gosquared::RubyLibrary.new("your_API_key","your_project_token")
 
 gs.people.smartgroups
 
@@ -172,7 +190,7 @@ _Account Example:_
 
 ```ruby
 
-gs = GoSquared::RubyLibrary.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')
 
@@ -182,7 +200,7 @@ gs.account.post
 
 #posts the data to the 'GoSquared Account' endpoint
 
-Reponse Message: OK
+Response Message: OK
 => #<Net::HTTPOK 200 OK readbody=true>
 
 gs.account.sites.token("your_site_token")

data/lib/compatibility.rb

@@ -0,0 +1,3 @@
+module GoSquared
+ include Gosquared
+end

data/lib/config.rb

@@ -1,4 +1,4 @@
-module GoSquared
+module Gosquared
 
   class << self
     attr_accessor :configuration

data/lib/gosquared.rb

@@ -5,14 +5,17 @@ require_relative "gosquared/people"
 require_relative "gosquared/now"
 require_relative "gosquared/account"
 require_relative "config"
+require_relative "compatibility"
 
-module GoSquared
+module Gosquared
 
 	class RubyLibrary
 
 		def initialize api_key, site_id
 			@api_key = api_key
 			@site_id = site_id
+		raise 'api key cannot be empty/nil' if api_key.nil? || api_key.empty?
+    	raise 'site_token cannot be empty/nil' if site_id.nil? || site_id.empty?
 		end
 
 		def trends

data/lib/gosquared/client.rb

@@ -39,7 +39,7 @@ class Client
 				response = false
 			end
 	end
-	puts "Reponse Message: #{response.message}" if response
+	puts "Response Message: #{response.message}" if response
 	response
 end
 
@@ -61,7 +61,7 @@ def delete(url,data)
 				response = false
 			end
 	end
-	puts "Reponse Message: #{response.message}" if response
+	puts "Response Message: #{response.message}" if response
 	response
 end
 

data/lib/rails/generators/{go_squared → gosquared}/config/config_generator.rb

@@ -1,6 +1,6 @@
 require 'rails/generators/base'
 
-module GoSquared
+module Gosquared
   module Generators
     class ConfigGenerator < Rails::Generators::Base
       source_root File.expand_path("../templates", __FILE__)
@@ -9,7 +9,7 @@ module GoSquared
 
       def copy_initializer_file
         @site_token = site_token
-        template("go_squared.rb.erb", File.join("config/initializers/go_squared.rb"))
+        template("gosquared.rb.erb", File.join("config/initializers/gosquared.rb"))
       end
     end
   end

data/lib/rails/generators/{go_squared/config/templates/go_squared.rb.erb → gosquared/config/templates/gosquared.rb.erb}

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

data/lib/tracker_inject/injector.rb

@@ -15,7 +15,7 @@
                 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);
+          _gs('#{Gosquared.configure.site_token}'); _gs('set', 'trackLocal', true);
           };
 
           var loadTracker;

data/lib/tracker_inject/railtie.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gosquared
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.2
 platform: ruby
 authors:
 - Russell Vaughan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-06 00:00:00.000000000 Z
+date: 2016-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -50,6 +50,7 @@ files:
 - Gemfile
 - LICENSE
 - README.md
+- lib/compatibility.rb
 - lib/config.rb
 - lib/gosquared.rb
 - lib/gosquared/account.rb
@@ -58,8 +59,8 @@ 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/rails/generators/gosquared/config/config_generator.rb
+- lib/rails/generators/gosquared/config/templates/gosquared.rb.erb
 - lib/tracker_inject/injector.rb
 - lib/tracker_inject/railtie.rb
 - spec/account_spec.rb
@@ -89,7 +90,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: GoSquared Ruby Library