gosquared 0.1.5 → 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 51c2a6717a8db7d61b602c4f51dda78e7328ce59
+  data.tar.gz: c723eb2426af2869ee78dfb14d680cba1210bb8e
+SHA512:
+  metadata.gz: 704d1fac4d900e0c188fb816cbdeb34bce2075864fcf3c52deaedf103dd9b0d248ba90eac2cff5ca131bae7cb424dc0de9577a37f0627d1d49d68cde8e3f14c0
+  data.tar.gz: f380d51a645dc84095895e9594fdd58e9fcd116faa60e12c904867524590c94f786d7da6f5a9eea2965fe965319f3224b8183bcd0a69234ae44a074685178fd4

data/.rspec

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

data/Gemfile

@@ -1,14 +1,8 @@
-ruby '1.9.3'
 source 'https://rubygems.org'
 
-gem 'faraday', '~> 0.8'
-gem 'json', '~> 1.7'
+ruby '2.2.2'
 
-group :development do
-  gem 'rake', '~> 0.9'
+group :development, :test do
+  gem 'rspec'
+	gem 'webmock'
 end
-
-group :test do
-  gem 'guard-minitest', '~> 0.5'
-  gem 'minitest', '~> 3.4'
-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

@@ -1,75 +1,165 @@
-## GoSquared Ruby API client
+## GoSquared Ruby Gem
 
-This module works with the [GoSquared API][api-docs], making it really easy to integrate GoSquared with your node app. You can also use it to track metrics and events in your application using GoSquared
+[![Build Status](https://travis-ci.org/gosquared/ruby-gem.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. 
+
+All functions listed in the API documentation are methods you can call on the GoSquared class.
+
+#Installation
+
+```ruby
+gem install gosquared 
+```
+
+#Tracking API
+This is for sending data to GoSquared. It allows you to track:
+* Events
+* Transactions
+* People profiles
+
+##Track Events
+```ruby
+
+gs = GoSquared.new("your_API_key","your_project_token")
+
+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
+
+gs.tracking.post
+
+#posts the data to the 'GoSquared Tracking' endpoint
+
+Reponse Message: OK
+=> #<Net::HTTPOK 200 OK readbody=true>
 
-## Installation
-```bash
-gem install gosquared
 ```
 
-## Usage
+##Track Transactions
+
+```ruby
+gs = GoSquared.new("your_API_key","your_project_token")
+
+gs.tracking.transaction({ transaction: {id: "1", revenue: 50, quantity: 1, previous_transaction_timestamp: Time.new } })
 
+gs.tracking.post
+
+Reponse Message: OK
+=> #<Net::HTTPOK 200 OK readbody=true>
+```
+
+##Track People
 ```ruby
-# Create an API client
-gosquared_api = GoSquared::API.new(opts)
+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" } })
 
-# Create Event client
-gosquared_event = GoSquared::Event.new(opts)
+gs.tracking.post
 
+Reponse Message: OK
+=> #<Net::HTTPOK 200 OK readbody=true>
 ```
 
-##### Options
 
-* api_key: API key from your [account][casa]. Required for API client, not required for event client.
-* site_token: Token for the registered site you're working with. Required.
-* debugLevel: One of:
-	* GoSquared::DEBUG_LEVELS[:ALL]
-	* GoSquared::DEBUG_LEVELS[:TRACE]
-	* GoSquared::DEBUG_LEVELS[:NOTICE]
-	* GoSquared::DEBUG_LEVELS[:WARNING]
-	* GoSquared::DEBUG_LEVELS[:FATAL]
+#Reporting API
+This is for pulling data from your GoSquared account. It is split into 3 sections;
+* Now - realtime data
+* Trends – historical data (includes ecommerce)
+* People - user data
+* Account - administration
+
+##Now
+The Now API provides real-time concurrent information about your sites and apps, such as the number of concurrent visitors online, the most popular pages right now, the most influential traffic sources, and much more.
+
+_Now Example:_
 
-### API
 ```ruby
-require 'gosquared'
+gs = GoSquared.new("your_API_key","your_project_token")
+
+#instantiates new GoSquared object
+
+gs.now.concurrents
 
-gosquared_api = GoSquared::API.new({
-  :api_key    => 'demo',
-  :site_token => 'GSN-181546-E'
-})
+#builds the url to the 'GoSquared Now' endpoint with the "Concurrents dimension"
 
-response = gosquared_api.concurrents(params)
+gs.now.fetch
+
+#fetches the data from the 'GoSquared Now' endpoint
+
+=> {"visitors"=>3, "returning"=>1, "pages"=>0, "active"=>0, "tagged"=>0}
 ```
 
-All functions listed in the [API documentation][api-docs] are methods you can call on the ```GoSquared::API``` class.
+##Trends
+The Trends API provides historical analytics information for any given period in a project's history. The data for the current period updates in real-time, so the figures are always fresh and up-to-date.
+
+_Trends Example:_
 
+```ruby
+gs = GoSquared.new("your_API_key","your_project_token")
+
+gs.trends.browser.from('2016-06-30').to('2016-07-07')
+
+#builds the url to the 'GoSquared Trends' endpoint with the "Trends dimension" and date filters
+
+gs.trends.fetch
+
+#fetches the filtered data from the 'GoSquared Trends' endpoint
+
+=> {"list"=>[{"id"=>"chrome", "browser"=>"chrome", "name"=>"Chrome", "metrics"=>{"visits"=>3}}], "cardinality"=>1, "dimension"=>"browser", "range"=>{"from"=>"2016-06-30T00:00:00+01:00", "to"=>"2016-07-07T23:59:59+01:00"}, "interval"=>"day"}
+
+```
 
-### Tracking
+##People
 
-##### Events
-Send events to GoSquared:
 
 ```ruby
-require 'gosquared'
-
-gosquared_event = GoSquared::Event.new({
-  :site_token => 'GSN-181546-E'
-})
-
-response = gosquared_event.store_event('Test Event', {
-	:its => true,
-	:'you can' => 'store',
-	:any => 'event',
-	:properties => 'You Like'
-})
+
+gs = GoSquared.new("your_API_key","your_project_token")
+
+gs.people.smartgroups
+
+#builds the url to the 'GoSquared People' endpoint with the "people" dimension.
+
+gs.people.fetch
+
+#fetches all smartgroups associated with the account.
+
 ```
 
-## Run tests
-Install all dependencies using ```bundle``` then:
+##Account
+The Account API allows you to perform administrative actions against GoSquared accounts. This includes actions like changing settings, configuration, and listing resources under the account.
+
+_Account Example:_
+
+```ruby
+
+gs = GoSquared.new("your_API_key","your_project_token")
+
+gs.account.blocked.ips.ip('5.10.148.50')
+
+#builds the url to the 'GoSquared Account' endpoint with the "Blocked dimension" and ip address to add to the blocked list
+
+gs.account.post
+
+#posts the data to the 'GoSquared Account' endpoint
+
+Reponse Message: OK
+=> #<Net::HTTPOK 200 OK readbody=true>
+
+gs.sites.token("you_site_token")
+
+#builds the url to the 'GoSquared Account' endpoint with the "Sites" dimension and token you want to retrieve the site by.
+
+gs.sites.fetch
 
-```bash
-rake
 ```
 
-[api-docs]: https://www.gosquared.com/developer/latest/
-[casa]: https://www.gosquared.com/home/developer
+
+#Tests
+
+```ruby
+rspec
+```

data/lib/gosquared.rb

@@ -1,47 +1,34 @@
-require_relative './client'
-module GoSquared
-  class API < Client
-    API_VERSION = ENV.fetch('GOSQUARED_API_VERSION') { "latest" }
-
-    def initialize(opts={})
-      super
-      debug 2, GoSquared::DEBUG_LEVELS[:WARNING] if @opts[:api_key].nil?
-      debug 3, GoSquared::DEBUG_LEVELS[:NOTICE], {:api_version => API_VERSION} if @opts[:api_version].nil?
-
-      @req_opts[:api_key] = @opts[:api_key]
-      @opts[:api_version] ||= API_VERSION
-    end
-
-    def url
-      @url ||= GoSquared::API_ENDPOINT + '/' + @opts[:api_version]
-    end
-
-    GoSquared::API_FUNCTIONS.each do | func_name |
-      define_method(func_name) { | func_params={} |
-        get("/#{func_name}", func_params)
-      }
-    end
-  end
-
-  class Event < Client
-
-    def initialize(opts={})
-      super
-    end
-
-    def url
-      @url ||= GoSquared::EVENT_ENDPOINT
-    end
-
-    def store_event(name, params={})
-      debug 4, GoSquared::DEBUG_LEVELS[:WARNING] if name.nil?
-
-      params = JSON.generate(params)
-      query_params = {
-        :_name => name
-      }
-      post('/event', query_params, params)
-    end
-  end
-
-end
+require './lib/gosquared/trends'
+require './lib/gosquared/tracking'
+require './lib/gosquared/people'
+require './lib/gosquared/now'
+require './lib/gosquared/account'
+
+class GoSquared 
+
+	def initialize api_key, site_id
+		@api_key = api_key
+		@site_id = site_id
+	end
+
+	def trends
+		@trends ||= Trends.new(@api_key, @site_id)
+	end
+
+	def tracking 
+		@tracking ||= Tracking.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
+
+end

data/lib/gosquared/account.rb

@@ -0,0 +1,79 @@
+require './lib/gosquared/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)
+	@@filters = {presenter: @presenter, ip: @ip, url: @url, email: @email}
+
+	def initialize(api_key, site_token, client = Client.new)
+		@site_token = site_token
+		@api_key = api_key
+		@client = client
+		@bots= ""
+		@ips = ""
+		@visitor = ""
+		@dimension_filter = ""
+	end
+
+	DIMENSION_FILTER.each do |filter|
+		define_method filter do |parameter = ""|
+			@dimension_filter = "/" + parameter
+			self
+		end
+	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 fetch
+		data = @client.get(url)
+		@@filters.each{|key, value| @@filters[key]=nil} if data
+		data
+	end
+
+	def post
+		@client.post(url, @data)
+	end
+
+	def delete
+		@client.delete(url, @data)
+	end
+
+	def bots
+		@bots = "/bots"
+	end
+
+	def ips
+		@ips = "/ips"
+		self
+	end
+
+	def visitors(id="")
+		@visitor = "/visitors/#{id}"
+		self
+	end
+	
+	def url(ips = @ips)
+		array = [""]
+		@url = BASEURL + @dimension + @dimension_filter + @visitor + @bots + ips +
+		"?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/client.rb

@@ -0,0 +1,68 @@
+require 'net/https'
+require 'uri'
+require 'json'
+
+class Client
+
+	def get(url)
+		uri = URI(url)
+		begin
+			response = Net::HTTP.get(uri)
+		rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+			Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+			puts "[error] HTTP error: #{e}"
+			begin 
+				JSON.parse(response)
+			rescue StandardError => e 
+				puts "[error] StandardError: Could not parse JSON"
+				response = false
+			end
+		end
+	@data = JSON.parse(response) if response
+	end
+
+	def post(url,data)
+	uri = URI.parse(url)
+	begin
+		https = Net::HTTP.new(uri.host, uri.port)
+		https.use_ssl = true
+		request = Net::HTTP::Post.new(uri.request_uri, initheader = {'Content-Type' =>'application/json'})
+		request.body = "[ #{data.to_json} ]"
+		response = https.request(request)
+	rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+		Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+		puts "[error] HTTP error: #{e}"
+		begin 
+				response.message
+			rescue StandardError => e 
+				puts "[error] StandardError: Could not print response message"
+				response = false
+			end
+	end
+	puts "Reponse Message: #{response.message}" if response
+	response
+end
+
+def delete(url,data)
+	uri = URI.parse(url)
+	begin
+		https = Net::HTTP.new(uri.host, uri.port)
+		https.use_ssl = true
+		request = Net::HTTP::Delete.new(uri.request_uri, initheader = {'Content-Type' =>'application/json'})
+		request.body = "[ #{data.to_json} ]"
+		response = https.request(request)
+	rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError,
+		Net::HTTPBadResponse, Net::HTTPHeaderSyntaxError, Net::ProtocolError => e
+		puts "[error] HTTP error: #{e}"
+		begin 
+				response.message
+			rescue StandardError => e 
+				puts "[error] StandardError: Could not print response message"
+				response = false
+			end
+	end
+	puts "Reponse Message: #{response.message}" if response
+	response
+end
+
+end