gosquared 0.1.5 → 1.0.1

data/lib/gosquared/now.rb

@@ -0,0 +1,50 @@
+require './lib/gosquared/client'
+class Now
+
+	BASEURL = "https://api.gosquared.com/now/v3/"
+	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, 
+	drill_limit: @drill_limit, sections: @sections,
+	minimal: @minimal, interval: @interval}
+
+	def initialize(api_key, site_token, client=Client.new)
+		@site_token = site_token
+		@api_key = api_key
+		@client = client
+	end
+
+
+	DIMENSIONS.each do |dimension|
+		define_method dimension do
+			@dimension = dimension 
+			self
+		end
+	end	
+
+	@@filters.each do |key, value|
+		define_method key do |argument|
+			@@filters[key] = argument
+			self
+		end
+	end
+
+	def fetch
+		data = @client.get(url)
+		@@filters.each{|key, value| @@filters[key]=nil} if data
+		data
+	end
+	
+	private
+
+	def url
+		array = [""]
+		@url = BASEURL + @dimension + "?api_key=#{@api_key}" + "&site_token=#{@site_token}"
+		@@filters.each {|key, value| array << "#{key}=#{value}" if value }
+		parameters=array.join('&')
+		@url = @url.concat(parameters)
+	end
+
+end

data/lib/gosquared/people.rb

@@ -0,0 +1,54 @@
+require './lib/gosquared/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, 
+		format: @presenter, limit: @limit, type: @type, from: @from, to: @to}
+
+		def initialize(api_key, site_token, client =Client.new)
+			@site_token = site_token
+			@api_key = api_key
+			@person_id = ""
+			@person_filter = ""
+			@client = client
+		end
+
+		DIMENSIONS.each do |dimension|
+			define_method dimension do |options = ""|
+				@dimension = dimension 
+				@data = options
+				self
+			end
+		end
+
+		@@filters.each do |key, value|
+			define_method key do |argument|
+				@@filters[key] = argument
+				self
+			end
+		end
+
+		def person_id(object, filter)
+			@person_id = "/" + object
+			@person_filter = "/" + filter
+			self
+		end 
+
+		def fetch
+			data = @client.get(url)
+			@@filters.each{|key, value| @@filters[key]=nil} if data
+			data
+		end
+
+		def url
+			array = [""]
+			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

data/lib/gosquared/tracking.rb

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

data/lib/gosquared/trends.rb

@@ -0,0 +1,44 @@
+require './lib/gosquared/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, 
+			format: @format, limit: @limit, sort: @sort, group: @group}
+
+			def initialize(api_key, site_token, client=Client.new)
+				@site_token = site_token
+				@api_key = api_key
+				@client = client
+			end
+
+			DIMENSIONS.each do |dimension|
+				define_method dimension do
+					@dimension = dimension 
+					self
+				end
+			end	
+
+			@@filters.each do |key, value|
+				define_method key do |argument|
+					@@filters[key] = argument
+					self
+				end
+			end
+
+			def fetch
+				data = @client.get(url)
+				@@filters.each{|key, value| @@filters[key]=nil} if data
+				data
+			end
+
+			private
+
+			def url
+				array = [""]
+				url = BASEURL + @dimension + "?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

data/spec/account_spec.rb

@@ -0,0 +1,67 @@
+describe Account do
+	subject(:gs) { described_class.new("demo", "GSN-2194840-F") }
+
+	Account::DIMENSIONS.each do |dimension|	
+		before do 
+			data = '{"a": [{"test": "response"}]}'
+			stub_request(:get, "https://api.gosquared.com/account/v1/#{dimension}?api_key=demo&site_token=GSN-2194840-F" ).
+			with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+			to_return(status: 200, body: data, headers: {})
+		end
+	end
+
+	Account::DIMENSIONS.each do |dimension|	
+		it "fetches a request from the GoSquared Account API with #{dimension} dimension"  do 
+			gs.send("#{dimension}")
+			expect(gs.fetch).to eq("a" => [{"test"=>"response"}])
+		end
+	end
+
+	before do 
+		data = '{"a": [{"test": "response"}]}'
+		stub_request(:get, "https://api.gosquared.com/account/v1/sites/GSN-086224-W?api_key=demo&site_token=GSN-2194840-F").
+		with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Host'=>'api.gosquared.com', 'User-Agent'=>'Ruby'}).
+		to_return(:status => 200, :body => data, :headers => {})
+	end
+
+	it "retrieves a site by its site token"  do 
+		gs.sites.token("GSN-086224-W")
+		expect(gs.fetch).to eq("a" => [{"test"=>"response"}])
+	end
+
+	before do 
+		stub_request(:post, "https://api.gosquared.com/account/v1/blocked/ips?api_key=demo&ip=20.15.33.99&site_token=GSN-2194840-F").
+		with(:body => "[ \"\" ]",
+			:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+		to_return(:status => 200, :body => "", :headers => {})
+		stub_request(:delete, "https://api.gosquared.com/account/v1/blocked/ips?api_key=demo&ip=20.15.33.99&site_token=GSN-2194840-F").
+		with(:body => "[ \"\" ]",
+			:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Content-Type'=>'application/json', 'User-Agent'=>'Ruby'}).
+		to_return(:status => 200, :body => "", :headers => {})
+	end
+
+	it "posts a request to the GoSquared Account API with an IP address to block bots"  do 
+		gs.blocked.ips.ip('20.15.33.99')
+		expect(gs.post.code).to eq('200')
+	end
+
+	it "sends a delete request to the GoSquared Account API with an IP address to block bots"  do 
+		gs.blocked.ips.ip('20.15.33.99')
+		expect(gs.delete.code).to eq('200')
+	end
+
+	before do 
+		data = '{"a": [{"test": "response"}]}'
+		stub_request(:get, "https://api.gosquared.com/account/v1/blocked/visitors/test.email@gmail.com?api_key=demo&ip=20.15.33.99&site_token=GSN-2194840-F").
+		with(:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Host'=>'api.gosquared.com', 'User-Agent'=>'Ruby'}).
+		to_return(:status => 200, :body => data, :headers => {})
+	end
+
+	it "retrieves a list of blocked visitors"  do 
+		gs.blocked.visitors("test.email@gmail.com")
+		expect(gs.fetch).to eq("a" => [{"test"=>"response"}])
+	end
+
+	
+
+end

data/spec/client_spec.rb

@@ -0,0 +1,71 @@
+require 'net/https'
+require 'uri'
+require 'json'
+
+describe Client do
+	subject(:client) { described_class.new }
+
+	EXCEPTIONS = [Timeout::Error, EOFError,
+			Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError]
+
+EXCEPTIONS.each do |exception|	
+	it "raises a #{exception} error on a get request" do
+		uri = URI('www.example.com')
+		allow(Net::HTTP).to receive(:get).with(uri).and_raise(exception)
+		expect{client.get('www.example.com')}.to output("[error] HTTP error: #{exception}\n[error] StandardError: Could not parse JSON\n").to_stdout
+	end 
+end
+
+it "raises a Errno::EINVAL error on a get request" do
+		uri = URI('www.example.com')
+		allow(Net::HTTP).to receive(:get).with(uri).and_raise(Errno::EINVAL)
+		expect{client.get('www.example.com')}.to output("[error] HTTP error: Invalid argument\n[error] StandardError: Could not parse JSON\n").to_stdout
+	end 
+
+it "raises a Errno::ECONNRESET error on a get request" do
+		uri = URI('www.example.com')
+		allow(Net::HTTP).to receive(:get).with(uri).and_raise(Errno::ECONNRESET)
+		expect{client.get('www.example.com')}.to output("[error] HTTP error: Connection reset by peer\n[error] StandardError: Could not parse JSON\n").to_stdout
+	end 
+
+EXCEPTIONS.each do |exception|	
+	it "raises a #{exception} error on a post request" do
+		uri = URI.parse("www.example.com")
+		allow(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_raise(exception)
+		expect{client.post("www.example.com", "body")}.to output("[error] HTTP error: #{exception}\n[error] StandardError: Could not print response message\n").to_stdout
+	end 
+end
+
+it "raises a Errno::EINVAL error on a post request" do
+		uri = URI.parse("www.example.com")
+		allow(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_raise(Errno::EINVAL)
+		expect{client.post("www.example.com", "body")}.to output("[error] HTTP error: Invalid argument\n[error] StandardError: Could not print response message\n").to_stdout
+	end
+
+it "raises a Errno::ECONNRESET error on a post request" do
+		uri = URI.parse("www.example.com")
+		allow(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_raise(Errno::ECONNRESET)
+		expect{client.post("www.example.com", "body")}.to output("[error] HTTP error: Connection reset by peer\n[error] StandardError: Could not print response message\n").to_stdout
+	end  
+
+EXCEPTIONS.each do |exception|	
+	it "raises a #{exception} error on a delete request" do
+		uri = URI.parse("www.example.com")
+		allow(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_raise(exception)
+		expect{client.delete("www.example.com", "body")}.to output("[error] HTTP error: #{exception}\n[error] StandardError: Could not print response message\n").to_stdout
+	end 
+end
+
+it "raises a Errno::EINVAL error on a delete request" do
+		uri = URI.parse("www.example.com")
+		allow(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_raise(Errno::EINVAL)
+		expect{client.delete("www.example.com", "body")}.to output("[error] HTTP error: Invalid argument\n[error] StandardError: Could not print response message\n").to_stdout
+	end
+
+it "raises a Errno::ECONNRESET error on a delete request" do
+		uri = URI.parse("www.example.com")
+		allow(Net::HTTP).to receive(:new).with(uri.host, uri.port).and_raise(Errno::ECONNRESET)
+		expect{client.delete("www.example.com", "body")}.to output("[error] HTTP error: Connection reset by peer\n[error] StandardError: Could not print response message\n").to_stdout
+	end  
+
+end

data/spec/now_spec.rb

@@ -0,0 +1,32 @@
+describe Now do
+	subject(:gs) { described_class.new("demo", "GSN-2194840-F") }
+
+	Now::DIMENSIONS.each do |dimension|	
+	before do 
+			data = '{"a": [{"test": "response"}]}'
+			stub_request(:get, "https://api.gosquared.com/now/v3/#{dimension}?api_key=demo&site_token=GSN-2194840-F" ).
+			with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+			to_return(status: 200, body: data, headers: {})
+		end
+	end
+
+		Now::DIMENSIONS.each do |dimension|	
+		it "fetches a request from the GoSquared Now API with #{dimension} dimension" do 
+			gs.send "#{dimension}"
+			expect(gs.fetch).to eq("a" => [{"test"=>"response"}])
+		end
+	end
+
+	before do 
+		data = '{"a": [{"test": "response"}, {"with": "params"}]}'
+		stub_request(:get, "https://api.gosquared.com/now/v3/browsers?api_key=demo&site_token=GSN-2194840-F&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'}).
+		to_return(:status => 200, :body => data, :headers => {})
+	end
+
+	it "fetches a request from the GoSquared Now API with paramaters" do
+		gs.browsers.limit('5')
+		expect(gs.fetch).to eq("a" => [{"test"=>"response"}, {"with"=>"params"}])
+	end
+
+end

data/spec/people_spec.rb

@@ -0,0 +1,51 @@
+describe People do
+	subject(:gs) { described_class.new("demo", "GSN-106863-S") }
+	
+	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" 
+				).
+			with(headers: {'Accept'=>'*/*', 'User-Agent'=>'Ruby'}).
+			to_return(status: 200, body: data, headers: {})
+		end
+	end
+
+	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 
+		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'}).
+		to_return(:status => 200, :body => data, :headers => {})
+	end
+
+	it "fetches a request from the GoSquared People API with a person_id and paramaters" do
+		gs.people.person_id('example.email@example.com','devices')
+		expect(gs.fetch).to eq("a" => [{"test"=>"response"}, {"with"=>"params"}])
+	end
+
+
+	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'}).
+			to_return(:status => 200, :body => data, :headers => {})
+		end
+	end
+
+	GoSquared::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"}])
+		end
+	end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,105 @@
+require 'gosquared.rb'
+require 'gosquared/account.rb'
+require 'gosquared/now.rb'
+require 'gosquared/trends.rb'
+require 'gosquared/tracking.rb'
+require 'gosquared/people.rb'
+require 'gosquared/client.rb'
+require 'webmock/rspec'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    #     be_bigger_than(2).and_smaller_than(4).description
+    #     # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #     # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Allows RSpec to persist some state between runs in order to support
+  # the `--only-failures` and `--next-failure` CLI options. We recommend
+  # you configure your source control system to ignore this file.
+  config.example_status_persistence_file_path = "spec/examples.txt"
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end