gosquared 3.0.4 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 190af14d102193d71cd19ee272100216f2192fae
-  data.tar.gz: d736e2f7d7fc41c69e98628fe6886144f00e2744
+  metadata.gz: 4b08adf61eaf083d34f944c45d22f919be153296
+  data.tar.gz: c80660918a18f39b0b0d39ca683e9c7724a0c3c7
 SHA512:
-  metadata.gz: 6f050ba2156fb41fe186a622b04162446b0eb80de08b47617a89ed7babfad4b16ebf4d7e5572f4670dc7712387fad73c9bb04d526f3a0c7ea9c7d25bdf15fc87
-  data.tar.gz: a8393ddb2aa97c3a116a6270423f6fba3c880f3646927ce545e9faf60c73b7f120fedc4e725fefa82f20b875798152b14ada071571740d2207d8f71aa5fccaf7
+  metadata.gz: f94fd4812bcc3261561e7156732e5cefb686e74c8ea116dd78e2097821cb03d4b41baa55aa4892556626009b6e18e95c0f8f79c00b05df61dc624bd96158e16a
+  data.tar.gz: e7da126fc50218f2d2ea58e876eccf7707c065ceae7cd103ea6853bd67bb5bd0227521a71ac43a402eda915478554105e68241ff2fbd2bdad35512ff0e944389

data/Gemfile

@@ -1,8 +1,8 @@
 source 'https://rubygems.org'
 
-ruby '2.2.2'
+ruby '2.7.2'
 
 group :development, :test do
   gem 'rspec'
-	gem 'webmock'
+  gem 'webmock', ">= 2.3"
 end

data/lib/gosquared.rb

@@ -1,43 +1,42 @@
-require_relative "gosquared/trends"
-require_relative "gosquared/tracking"
-require_relative "gosquared/people"
-require_relative "gosquared/now"
-require_relative "gosquared/account"
+require_relative 'gosquared/trends'
+require_relative 'gosquared/tracking'
+require_relative 'gosquared/people'
+require_relative 'gosquared/now'
+require_relative 'gosquared/account'
 
 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
-			@trends ||= Gosquared::Trends.new(@api_key, @site_id)
-		end
-
-		def tracking
-			@tracking ||= Gosquared::Tracking.new(@api_key, @site_id)
-		end
-
-		def people
-			@people ||= Gosquared::People.new(@api_key, @site_id)
-		end
-
-		def now
-			@now ||= Gosquared::Now.new(@api_key, @site_id)
-		end
-
-		def account
-			@account ||= Gosquared::Account.new(@api_key, @site_id)
-		end
-
-	end
+  VERSION = '3.1.0'.freeze
+
+  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
+      @trends ||= Gosquared::Trends.new(@api_key, @site_id)
+    end
+
+    def tracking
+      @tracking ||= Gosquared::Tracking.new(@api_key, @site_id)
+    end
+
+    def people
+      @people ||= Gosquared::People.new(@api_key, @site_id)
+    end
+
+    def now
+      @now ||= Gosquared::Now.new(@api_key, @site_id)
+    end
+
+    def account
+      @account ||= Gosquared::Account.new(@api_key, @site_id)
+    end
+  end
 end
 
 module GoSquared
-	include Gosquared
+  include Gosquared
 end

data/lib/gosquared/account.rb

@@ -3,8 +3,8 @@ require_relative 'client'
 module Gosquared
   class Account
     BASEURL = 'https://api.gosquared.com/account/v1/'.freeze
-    DIMENSIONS = %w(blocked feeds reportPreferences sharedUsers sites taggedVisitors triggerTypes webhooks).freeze
-    DIMENSION_FILTER = %w(token webhookID visitorID triggerType).freeze
+    DIMENSIONS = %w[blocked feeds reportPreferences sharedUsers sites taggedVisitors triggerTypes webhooks].freeze
+    DIMENSION_FILTER = %w[token webhookID visitorID triggerType].freeze
     @@filters = { presenter: @presenter, ip: @ip, url: @url, email: @email }
 
     def initialize(api_key, site_token, client = Gosquared::Client.new)

data/lib/gosquared/client.rb

@@ -4,67 +4,64 @@ require 'json'
 
 module Gosquared
   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 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', 'User-Agent' => 'ruby-client/' + VERSION })
+        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
 
-  	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 "Response 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 "Response Message: #{response.message}" if response
-  	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
+      response
+    end
   end
 end

data/lib/gosquared/now.rb

@@ -1,53 +1,50 @@
-require_relative "client"
+require_relative 'client'
 
 module Gosquared
   class Now
-
-  	BASEURL = "https://api.gosquared.com/now/v3/".freeze
-  	DIMENSIONS = %w(browsers campaigns concurrents engagement geo languages notifications
-  		organisations overview pages platforms sources time timeSeries visitors).freeze
-  @@filters = {date_format: @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 = Gosquared::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
-
+    BASEURL = 'https://api.gosquared.com/now/v3/'.freeze
+    DIMENSIONS = %w[browsers campaigns concurrents engagement geo languages notifications
+                    organisations overview pages platforms sources time timeSeries visitors].freeze
+    @@filters = { date_format: @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 = Gosquared::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
 end

data/lib/gosquared/people.rb

@@ -1,68 +1,78 @@
-require_relative "client"
+require_relative 'client'
 
 module Gosquared
   class People
+    BASEURL = 'https://api.gosquared.com/people/v1/'.freeze
+    VERSION = %w[v1 v2 v3].freeze
+    DIMENSIONS = %w[devices eventTypes people propertyTypes feed].freeze
+    @@filters = { query: @query, filters: @filters, sort: @sort,
+                  format: @presenter, limit: @limit, type: @type, from: @from, to: @to }
 
-  	BASEURL = "https://api.gosquared.com/people/v1/".freeze
-  	VERSION = %w(v1 v2 v3).freeze
-  	DIMENSIONS = %w(devices eventTypes people propertyTypes feed smartgroups).freeze
-  	@@filters = {query: @query, filters: @filters, sort: @sort,
-  		format: @presenter, limit: @limit, type: @type, from: @from, to: @to}
+    def initialize(api_key, site_token)
+      @site_token = site_token
+      @api_key = api_key
+      @person_id = ''
+      @person_filter = ''
+   end
 
-  		def initialize(api_key, site_token)
-  			@site_token = site_token
-  			@api_key = api_key
-  			@person_id = ""
-  			@person_filter = ""
-  		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
 
-  		DIMENSIONS.each do |dimension|
-  			define_method dimension do |options = ""|
-  				@dimension = dimension
-  				@data = options
-  				self
-  			end
-  		end
+    def person_id(object, filter=nil)
+      @person_id = '/' + object
+      @person_filter = '/' + filter if filter
+      self
+   end
 
-  		@@filters.each do |key, value|
-  			define_method key do |argument|
-  				@@filters[key] = argument
-          puts @@filters[key]
-          self
-        end
+    def smartgroups(group_id = nil, filter = nil)
+      if group_id
+        @dimension = "smartgroups/#{group_id}/people" if filter == 'people'
+        @dimension = "smartgroups/#{group_id}/count/latest" if filter == 'count'
+      else @dimension = 'smartgroups'
       end
+      self
+    end
 
-      def person_id(object, filter)
-       @person_id = "/" + object
-       @person_filter = "/" + filter
-       self
-     end
+    def fetch
+      data = Client.new.get(url)
+      @@filters.each { |key, _value| @@filters[key] = nil } if data
+      data
+    end
 
-     def fetch
-       data = Client.new.get(url)
-       @@filters.each{|key, value| @@filters[key]=nil} if data
-       data
-     end
+    def delete
+      response = Client.new.delete(url)
+    end
 
-     def url
-       array = [""]
-       url = BASEURL + @dimension + @person_id + @person_filter +
-       "?api_key=#{@api_key}" + "&site_token=#{@site_token}"
-       @@filters.each do |key, value|
-        if @dimension=="people" && key == :filters && value.is_a?(Array)
-          json_object=JSON.generate(value)
-          filter_request=URI.escape(json_object, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    def url
+      array = ['']
+      url = BASEURL + @dimension + @person_id + @person_filter +
+            "?api_key=#{@api_key}" + "&site_token=#{@site_token}"
+      @@filters.each do |key, value|
+        if @dimension == 'people' && key == :filters && value.is_a?(Array)
+          json_object = JSON.generate(value)
+          filter_request = URI.escape(json_object, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
           array << "#{key}=#{filter_request}"
         else
           array << "#{key}=#{value}" if value
         end
       end
-      parameters=array.join('&')
+      parameters = array.join('&')
       url.concat(parameters)
-    end
+   end
 
     def post
-      puts @data
       check_for_nil_user
       response = Client.new.post(url, @data)
       @data = nil if response.code === '200'
@@ -70,11 +80,10 @@ module Gosquared
     end
 
     def check_for_nil_user
-      if @data.key?(:person_id) && @data[:person_id] == nil
-        @data.tap { |data| @data.delete(:person_id) }
+      if @data.key?(:person_id) && @data[:person_id].nil?
+        @data.tap { |_data| @data.delete(:person_id) }
         warn 'person_id is nil, event will not be track against a user'
       end
     end
-
   end
 end