ga_collect 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bf5907829af46de04e773e9c922dbea14155f52e
+  data.tar.gz: 5db8c408e45bb6fca4d5b3e3242c7fa8528db786
+SHA512:
+  metadata.gz: 423f342bceb51c14402012ce4f847108a16e6d773a687c0edcf32de646799a4d96ed22bf2eed297628fececcb0c1770aff8e95e4c8fe3d814f85aafe96b9eb84
+  data.tar.gz: 8de3155cb3e886f674e1af77b7dd5f4109745709f9171506114a082d4fa1416476c73866ad5beaac8f935dbe0bb312145a5e35b0db8a62bf1b15bad512197b36

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.0.0

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ga_collect.gemspec
+gemspec

data/README.md

@@ -0,0 +1,63 @@
+# GaCollect
+
+GaCollect is a simple Ruby library which collects metrics on the server side and sends them to google analytics using its measurement protocol https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#usertiming
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ga_collect'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ga_collect
+
+## Usage
+All parameters are the same than the official measurement protocol https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide
+
+First get the tracker
+```ruby
+    @tracker  = GaCollect.tracker('test_tracker_id')
+```
+And then use the measurements available
+```ruby
+    # Pageview
+    @tracker.pageview(dh: 'jsanroman.net', dp: '/', dt: 'Javi Sanromán')
+
+    # Event
+    @tracker.event(ec: 'ga_collect', ea: 'test2', ev: 1)
+
+    # Exception
+    @tracker.exception(exd: 'IOException', exf: '1')
+
+    # Item
+    @tracker.item(ti: 123, in: 'test', ip: '10', iq: 2, ic: '12345', iv: 'ga_collect')
+
+    # Screenview
+    @tracker.screenview(an: 'funTimes', av: '4.2.0', aid: 'com.foo.App', aiid: 'com.android.vending', cd: 'Home')
+
+    # Social
+    @tracker.social(sa: 'like', sn: 'facebook', st: '/home')
+
+    # Timing
+    @tracker.timing(utc: 'jsonLoader', utv: 'load', utt: 5000, utl: 'jQuery', dns: 100, pdt: 20, rrt: 32, tcp: 56, srt: 12)
+
+    # Transaction
+    @tracker.transaction(ti: 123, ta: '', tr: 10, ts: 0, tt: 0c)
+```
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ga_collect"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/ga_collect.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ga_collect/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'ga_collect'
+  spec.version       = GaCollect::VERSION
+  spec.licenses      = ["MIT"]
+  spec.authors       = ["Javi Sanromán"]
+  spec.email         = ["javisanroman@gmail.com"]
+
+  spec.summary       = %q{GaCollect is a simple Ruby library which collects metrics on the server side and sends them to google analytics using its measurement protocol}
+  spec.description   = %q{GaCollect is a simple Ruby library which collects metrics on the server side and sends them to google analytics using its measurement protocol https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#usertiming}
+  spec.homepage      = "https://github.com/jsanroman/ga_collect"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/lib/ga_collect/http.rb

@@ -0,0 +1,14 @@
+require 'net/http'
+
+module GaCollect
+  module HTTP
+
+    def self.get(params)
+      uri = URI('http://www.google-analytics.com/collect')
+      uri.query = URI.encode_www_form(params)
+
+      Net::HTTP.get_response(uri)
+    end
+
+  end
+end

data/lib/ga_collect/measure/event.rb

@@ -0,0 +1,15 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#event
+    def self.event(options={})
+      raise ArgumentError, 'category is required'  if options[:ec].nil? || options[:ec].empty?
+      raise ArgumentError, 'action is required'    if options[:ea].nil? || options[:ea].empty?
+
+      params = {ec: '', ea: '', el: '', ev: ''}.merge(options)
+      params.merge!({t: :event})
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/measure/exception.rb

@@ -0,0 +1,11 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#exception
+    def self.exception(options={})
+      params = {exd: '', exf: ''}.merge(options)
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/measure/item.rb

@@ -0,0 +1,13 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#ecom
+    def self.item(options={})
+      raise ArgumentError, 'transaction_id is required'  if options[:ti].nil? || options[:ti].to_s.empty?
+
+      params = {ti: '', in: '', ip: 0, iq: 1, ic: '', iv: '', cu: 'EUR'}.merge(options)
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/measure/pageview.rb

@@ -0,0 +1,11 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#page
+    def self.pageview(options={})
+      params = {dh: '', dp: '', dt: ''}.merge(options)
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/measure/screenview.rb

@@ -0,0 +1,11 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#screenView
+    def self.screenview(options={})
+      params = {an: '', av: '', aid: '', aiid: '', cd: ''}.merge(options)
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/measure/social.rb

@@ -0,0 +1,15 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#social
+    def self.social(options={})
+      raise ArgumentError, 'social_action is required'  if options[:sa].nil? || options[:sa].empty?
+      raise ArgumentError, 'social_network is required' if options[:sn].nil? || options[:sn].empty?
+      raise ArgumentError, 'social_target is required'  if options[:st].nil? || options[:st].empty?
+
+      params = {sa: '', sn: '', st: ''}.merge(options)
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/measure/timing.rb

@@ -0,0 +1,11 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#usertiming
+    def self.timing(options={})
+      params = {utc: '', utv: '', utt: 0, utl: '', dns: 0, pdt: 0, rrt: 0, tcp: 0, srt: 0}.merge(options)
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/measure/transaction.rb

@@ -0,0 +1,13 @@
+module GaCollect
+  module Measure
+
+    # https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#ecom
+    def self.transaction(options={})
+      raise ArgumentError, 'transaction_id is required'  if options[:ti].nil? || options[:ti].to_s.empty?
+
+      params = {ti: '', ta: '', tr: 0, ts: 0, tt: 0, cu: 'EUR'}.merge(options)
+
+      GaCollect::HTTP.get(params)
+    end
+  end
+end

data/lib/ga_collect/version.rb

@@ -0,0 +1,3 @@
+module GaCollect
+  VERSION = "0.1.0"
+end

data/lib/ga_collect.rb

@@ -0,0 +1,33 @@
+require "ga_collect/version"
+
+module GaCollect
+  MEASURES = [:pageview, :event, :transaction, :item, :social, :exception, :timing, :screenview]
+
+  def self.tracker(tracking_id = nil)
+    raise ArgumentError, 'tracking_id is required' if tracking_id.empty?
+    GaCollect::Tracker.new(tracking_id)
+  end
+
+  class Tracker
+    def initialize(tracking_id, client_id=555, version=1)
+      @tracking_id = tracking_id
+      @client_id   = client_id
+      @version     = version
+    end
+
+
+    GaCollect::MEASURES.each do |method|
+      define_method(method) do |argument|
+        options = argument.merge({v: @version, tid: @tracking_id, cid: @client_id, t: method})
+
+        GaCollect::Measure.send(method, options)
+      end
+    end
+  end
+end
+
+
+require 'ga_collect/http'
+GaCollect::MEASURES.each do |measure|
+  require "ga_collect/measure/#{measure}"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: ga_collect
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Javi Sanromán
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-11-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: GaCollect is a simple Ruby library which collects metrics on the server
+  side and sends them to google analytics using its measurement protocol https://developers.google.com/analytics/devguides/collection/protocol/v1/devguide#usertiming
+email:
+- javisanroman@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ga_collect.gemspec
+- lib/ga_collect.rb
+- lib/ga_collect/http.rb
+- lib/ga_collect/measure/event.rb
+- lib/ga_collect/measure/exception.rb
+- lib/ga_collect/measure/item.rb
+- lib/ga_collect/measure/pageview.rb
+- lib/ga_collect/measure/screenview.rb
+- lib/ga_collect/measure/social.rb
+- lib/ga_collect/measure/timing.rb
+- lib/ga_collect/measure/transaction.rb
+- lib/ga_collect/version.rb
+homepage: https://github.com/jsanroman/ga_collect
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: GaCollect is a simple Ruby library which collects metrics on the server side
+  and sends them to google analytics using its measurement protocol
+test_files: []