gaevents 0.1.1 → 1.04

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: e523230f45496a7bd32a3c62c07462367e12233f
-  data.tar.gz: e3df85876a2a176efeccd1786a664b9f917a7dd9
+SHA256:
+  metadata.gz: 31e17368516bd792f7be1a798d4b467705b64f7414bcaf424714f7b406f66ef5
+  data.tar.gz: 061faad9641e410ec34a94ecbf8c2fdb25c34959f9dcd206d0e43a4f5ae1181e
 SHA512:
-  metadata.gz: 9f42e64a7acf73c89c3e7cbbdd5cc338b0144a3607956a47052e0a69e481dafe6dac7a0f84e1ed99977c35bb8d9fa576fa9f5c6a08de542a89538109cf153527
-  data.tar.gz: 7e0b058368e5dd442726f3cd94ac6deefc7bef8a8d7ea76603c3e0b38b736fb936a290a5f16d02c9e0c63fe657ef364f8683ae72ffdb1f2d2f375bc7ca96edef
+  metadata.gz: 29516d500929862fcb097832654f679441c37e4a15b05ab8d727d229657ecd44188952e065e94dbd32ab8b3886ced7c96d9c99cb5a8019bbfe3dd0ae627eaf9a
+  data.tar.gz: 07d1c6503ee27ed09e229edcb01fef99ab94b04445e0a7395cc05f423952ff4ce85cc8c40b4caa136ab4a1c1da5385307f23b152bf0259a5585b530b75853c57

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Style/Tab:
+  Enabled: false
+Metrics/LineLength:
+  Max: 100

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile

@@ -2,3 +2,7 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in gaevents.gemspec
 gemspec
+
+group :development, :test do
+	 gem 'rubocop', '~> 0.59.2', require: false
+end

data/README.md

@@ -1,6 +1,9 @@
+[![Gem Version](https://badge.fury.io/rb/gaevents.svg)](https://badge.fury.io/rb/gaevents)
+[![Build Status](https://travis-ci.com/singhshivam/gaevents.svg?branch=master)](https://travis-ci.com/singhshivam/gaevents)
+
 # Gaevents
 
-This gem provides an integration for sending multiple events to Google Analytics. Events are sent in batches leveraging Measurement Protocol.
+This gem allows you to update multiple background events in one go (via batches). Unlike other gems you do not need to load a js file to send events. Gaevents leverage GA's Measurement Protocol to send the events.
 
 ## Installation
 
@@ -20,16 +23,30 @@ Or install it yourself as:
 
 ## Usage
 
-```
-# configure your application's API key
-GAEvents.api_key = "UA-XXXXX-Y"
+Please refer [Measurement Protocol Parameter Reference](https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters) for the list of all parameters accepted by the Protocol.
+
+The following parameters are required in each event:
+`v`, `tid`, `cid` and `t`. This gem automatically injects `v`, make sure all events have `tid`, `cid` and `t` as parameters.
 
+```
 events = []
 10.times { |n|
-	events << GAEvents::Event.new(GOOGLE_API_CLIENT_ID, "testcategory", "gaaction#{n}")
+	events << GAEvents::Event.new({tid: GATRACKINGID, cid: "ci#{n}", t: 'event', ec: "video#{n}", ea: "abc#{n}", uid: "user#{n}"})
 }
 GAEvents.track(events)
 ```
+
+## Migrating from 0.x to 1.x
+
+In 0.x versions events were restricted to accepting only 5 parameters: `cid`, `ec`, `ea`, `el` and `ev` in the same order. Example:
+```
+GAEvents::Event.new(GOOGLE_API_CLIENT_ID, "testcategory", "gaaction")
+```
+1.x now accepts a hash that can have any number of acceptable parameters. The above line of code then becomes:
+```
+GAEvents::Event.new({tid: GATRACKINGID, cid: GOOGLE_API_CLIENT_ID, ec: "testcategory", ea: "gaaction"})
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/Rakefile

@@ -1,2 +1,2 @@
-require "bundler/gem_tasks"
-task :default => :spec
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "gaevents"
+require 'bundler/setup'
+require 'gaevents'
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
@@ -10,5 +10,5 @@ require "gaevents"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/gaevents.gemspec

@@ -1,27 +1,32 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'gaevents/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "gaevents"
+  spec.name          = 'gaevents'
   spec.version       = Gaevents::VERSION
-  spec.authors       = ["singhshivam"]
-  spec.email         = ["shivam@blogvault.net"]
+  spec.authors       = ['singhshivam']
+  spec.email         = ['shivam@blogvault.net']
 
-  spec.summary       = %q{Sends events to google analytics in batches leveraging Measurement Protocol}
-  spec.description   = %q{Provides an integration for sending multiple events to Google Analytics}
-  spec.homepage      = "https://github.com/singhshivam/gaevents"
-  spec.license       = "MIT"
+  spec.description   = 'Provides an integration for sending multiple events to Google Analytics'
+ 	spec.summary       = 'This gem allows you to update multiple background events ' \
+										 'in one go (via batches). Unlike other gems ' \
+										 'you dont need to load a js file to send events. ' \
+										 'Gaevents leverage GA\'s Measurement Protocol.'
+
+  spec.homepage      = 'https://github.com/singhshivam/gaevents'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "rake", ">= 12.3.3"
+	spec.add_development_dependency 'rspec'
 	spec.add_runtime_dependency 'rest-client', '~> 2.0', '>= 2.0.2'
 end

data/lib/gaevents.rb

@@ -1,32 +1,34 @@
-require "gaevents/version"
-require "rest-client"
-require_relative "gaevents/event"
+require 'gaevents/version'
+require 'rest-client'
+require_relative 'gaevents/event'
 
+# collection of events
 class GAEvents
-	BULK_URI = 'https://www.google-analytics.com/batch'.freeze
-	COLLECT_URI = 'https://www.google-analytics.com/batch'.freeze
+	 BULK_URI = 'https://www.google-analytics.com/batch'.freeze
+	 COLLECT_URI = 'https://www.google-analytics.com/collect'.freeze
 
-	class << self
-		attr_accessor :api_key
+	 class << self
+ 		attr_accessor :api_key
 
-		def send_event(event)
-			resource = RestClient::Resource.new COLLECT_URI
-			resource.post(track_body([event]), {:content_type => 'text/plain'})
-		end
+ 		def send_event(event)
+ 			 resource = RestClient::Resource.new COLLECT_URI
+ 			 resource.post(track_body([event]), content_type: 'text/plain')
+ 		end
 
-		def track(*events)
-			# as per GA: A maximum of 20 hits can be specified per request
-			# https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#batch
-			res = []
-			events.each_slice(20) { |_events|
-				resource = RestClient::Resource.new BULK_URI
-				res << resource.post(track_body(_events.compact), {:content_type => 'text/plain'})
-			}
-			res
-		end
+ 		# takes Array of Event as parameter
+ 		def track(events)
+ 			 # as per GA: A maximum of 20 hits can be specified per request
+ 			 # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#batch
+ 			 res = []
+ 			 events.each_slice(20) do |events_slice|
+  				 resource = RestClient::Resource.new BULK_URI
+  				 res << resource.post(track_body(events_slice.compact), content_type: 'text/plain')
+  			end
+ 			 res
+ 		end
 
-		def track_body(*events)
-			events.flatten.map { |_event| _event.payload(api_key) }.join("\n")
-		end
-	end
+ 		def track_body(*events)
+ 			 events.flatten.map(&:payload).join("\n")
+ 		end
+ 	end
 end

data/lib/gaevents/event.rb

@@ -1,31 +1,26 @@
+# frozen_string_literal: true
+
 class GAEvents
-	class Event
-		attr_accessor :client, :category, :action, :label, :value
+	 # Class to define analytical events
+	 # expected attributes: tid, cid and t
+	 class Event
+ 		 attr_accessor :params
 
-		def initialize(client, category, action, label = nil, value = nil)
-			@client = client
-			@category = category
-			@action = action
-			@label = label
-			@value = value
-		end
+ 		 # Initialize Events by passing a hash.
+ 		 # Keys could be any GA allowed parameter.
+ 		 # Please refer Measurement Protocol Parameter Reference for available options:
+ 		 # https://developers.google.com/analytics/devguides/collection/protocol/v1/parameters
 
-		def params(tid)
-			params = {
-			"v" => 1,
-			"tid" => tid,
-			"cid" => @client,
-			"t" => "event",
-			"ec" => @category,
-			"ea" => @action,
-			"el" => @label,
-			"ev" => @value
-			}
-			params.reject! { |k,v| !v }
-		end
+ 		 # As per Measurement Protocol, parameters: v, tid, cid and t should always be present.
+ 		 # This gem automatically injects v. Ensure you always pass tid, cid and t while
+ 		 # initializing events.
+ 		 def initialize(hash = {})
+  			 @params = hash.select { |_k, v| v }
+  			 @params['v'] = 1
+  		end
 
-		def payload(tid)
-			URI.encode_www_form params(tid)
-		end
-	end
+ 		 def payload
+  			 URI.encode_www_form(@params)
+  		end
+ 	end
 end

data/lib/gaevents/version.rb

@@ -1,3 +1,3 @@
 module Gaevents
-  VERSION = "0.1.1"
+  VERSION = '1.04'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gaevents
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '1.04'
 platform: ruby
 authors:
 - singhshivam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-12-13 00:00:00.000000000 Z
+date: 2020-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,20 +24,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,9 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - LICENSE.txt
@@ -96,9 +127,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Sends events to google analytics in batches leveraging Measurement Protocol
+summary: This gem allows you to update multiple background events in one go (via batches).
+  Unlike other gems you dont need to load a js file to send events. Gaevents leverage
+  GA's Measurement Protocol.
 test_files: []