simple_analytics 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+vendor/bundle
+bin
+pkg/*
+

data/Gemfile

@@ -0,0 +1,8 @@
+source 'http://rubygems.org'
+
+group :test do
+  gem "rake", "~> 0.9.2.2"
+end
+
+# Specify your gem's dependencies in simple_analytics.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    simple_analytics (0.0.1)
+      google_client_login (~> 0.3.1)
+      json
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.6)
+    crack (0.3.1)
+    diff-lcs (1.1.3)
+    fuubar (0.0.6)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.1.8)
+      ruby-progressbar (~> 0.0.10)
+    google_client_login (0.3.1)
+    json (1.6.5)
+    rake (0.9.2.2)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-instafail (0.1.9)
+    rspec-mocks (2.8.0)
+    ruby-progressbar (0.0.10)
+    webmock (1.7.10)
+      addressable (~> 2.2, > 2.2.5)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar (~> 0.0.6)
+  rake (~> 0.9.2.2)
+  rspec (~> 2.8)
+  simple_analytics!
+  webmock (~> 1.7.10)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Andrew Djoga
+
+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.rdoc

@@ -0,0 +1,75 @@
+= SimpleAnalytics
+
+SimpleAnalytics gem provides accessing Google Analytics Export Api. It uses Version 3.0 of the Google Core Reporting API with JSON. You can find the google documentation {here}[http://code.google.com/apis/analytics/docs/gdata/v3/gdataGettingStarted.html].
+
+== Installation
+
+Install as a gem from rubygems:
+
+  gem install simple_analytics
+
+== Getting Started
+
+Authentication:
+
+  analytics = SimpleAnalytics::Api.authenticate('user@gmail.com', 'password')
+
+The <tt>authenticate</tt> method sets an <tt>auth_token</tt> in the analytics service object. Then you can fetch data:
+
+  analytics.fetch('ids'        => 'ga:id',
+                  'metrics'    => 'ga:visitors',
+                  'dimensions' => 'ga:country',
+                  'start-date' => '2012-01-01',
+                  'end-date'   => '2012-01-10')
+  # => [["United States","24451"], ["Brazil","15616"], ["Spain","3966"]
+
+The <tt>fetch</tt> method sets and returns rows. Required query parameters are used to configure which data to return from Google Analytics:
+* ids — The profile IDs from which to access data.
+* start-date — The beginning of the date range.
+* end-date — The end of the date range.
+* metrics — The numeric values to return.
+
+For more detailed information about the parameters see {google REST docs}[http://code.google.com/apis/analytics/docs/gdata/v3/exportRest.html].
+
+== Authentication
+
+For the authentication it uses gem {google_client_login}[https://github.com/fortuity/google_client_login] based on the ClientLogin. You can also pass extra parameters which allows the gem (see the gem's {README}[https://github.com/fortuity/google_client_login]):
+
+  analytics = SimpleAnalytics::Api.authenticate('user@gmail.com', 'password', { :accountType => 'GOOGLE', 
+                                                                                :source => 'company-app-version' })
+
+==== Authentication Token
+
+You can set yourself the <tt>auth_token</tt> to use it in the fetching:
+
+  analytics.auth_token = 'your-token-from-oauth'
+
+== An example
+
+All parameters are escaped before a request. For date you can use the next tip: <tt>your_date.strftime("%Y-%m-%d")</tt>.
+
+  analytics = SimpleAnalytics::Api.authenticate('user@gmail.com', 'password')
+  
+  analytics.fetch('ids'        => 'ga:id',
+                  'metrics'    => 'ga:visitors',
+                  'dimensions' => 'ga:country',
+                  'start-date' => '2012-01-01',
+                  'end-date'   => '2012-01-10')
+  # => [["United States","24451"], ["Brazil","15616"], ["Spain","3966"]
+  
+  analytics.rows
+  # => [["United States","24451"], ["Brazil","15616"], ["Spain","3966"]
+  
+  analytics.body
+  # => returns the parsed response body (hash), where you can get other info, see google docs
+  
+  analytics.fetch('ids'        => 'ga:another-id',
+                  'metrics'    => 'ga:visitors,ga:newVisits',
+                  'dimensions' => 'ga:pagePath',
+                  'filters'    => 'ga:pagepath=~/articles/[\w-]+\z'
+                  'start-date' => '2012-01-01',
+                  'end-date'   => '2012-01-10')
+  # => [["/article/first-post","12", "2"], ["/article/second-post","2", "1"]]
+  
+  analytics.rows
+  # => [["/article/first-post","12", "2"], ["/article/second-post","2", "1"]]

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => [:spec]

data/lib/simple_analytics.rb

@@ -0,0 +1,77 @@
+require 'simple_analytics/version'
+require 'json'
+require 'google_client_login'
+
+module SimpleAnalytics
+  # Required query parameters are used to configure which data to return from Google Analytics.
+  REQUIRED_PROPERTIES = ['ids', 'start-date', 'end-date', 'metrics']
+
+  class NotSuccessfulResponseError < RuntimeError; end
+
+  class Api
+    # An authentication token for the Google Analytics Api.
+    attr_accessor :auth_token
+
+    # +rows+ is a 2-dimensional array of strings, each string represents a value in the table.
+    # +body+ is the data in response body.
+    attr_reader :rows, :body
+
+    # Authentication using ClientLogin, returns an analytics service object.
+    def self.authenticate(username, password, options = {})
+      new(username, password, options).tap do |analytics|
+        analytics.authenticate
+      end
+    end
+
+    def initialize(username, password, options = {})
+      @username = username
+      @password = password
+      @options = options
+    end
+
+    # Authenticates using ClientLogin.
+    def authenticate
+      login_service = ::GoogleClientLogin::GoogleAuth.new(client_options)
+      login_service.authenticate(@username, @password, @options[:captcha_response])
+      @auth_token = login_service.auth
+    end
+
+    # Fetches the report data, the following query parameters are required: 'ids', 'start-date', 'end-date', 'metrics'.
+    def fetch(properties)
+      check_properties(properties)
+
+      uri = URI.parse("https://www.googleapis.com/analytics/v3/data/ga")
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+
+      response = http.get("#{uri.path}?#{query_string(properties)}", { 'Authorization' => "GoogleLogin auth=#{@auth_token}", 'GData-Version' => '3' })
+      raise NotSuccessfulResponseError.new, response.body if response.code_type != Net::HTTPOK
+      @body = JSON.parse(response.body)
+      @rows = @body['rows']
+    end
+
+    private
+
+    def client_options
+      { :service     => 'analytics',
+        :accountType => (@options[:accountType] || 'GOOGLE'),
+        :source      => (@options[:source] || 'djo-simple_analytics-001') }
+    end
+
+    def check_properties(properties)
+      required = properties.keys.map(&:to_s) & REQUIRED_PROPERTIES
+      if required.size != REQUIRED_PROPERTIES.size
+        raise ArgumentError, "Properties: #{REQUIRED_PROPERTIES.join(', ')} are required."
+      end
+    end
+
+    def query_string(properties)
+      properties.map{ |k, v| "#{k}=#{escape v}" }.sort.join('&')
+    end
+
+    def escape(property)
+      URI.escape(property.to_s, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
+  end
+end

data/lib/simple_analytics/version.rb

@@ -0,0 +1,3 @@
+module SimpleAnalytics
+  VERSION = "0.0.1"
+end

data/simple_analytics.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simple_analytics/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Andrew Djoga"]
+  gem.email         = ["andrew.djoga@gmail.com"]
+  gem.description   = %q{The Simple Analytics allows to access Google Analytics report data}
+  gem.summary       = %q{Google Analytics Export API Ruby Wrapper}
+  gem.homepage      = "https://github.com/Djo/simple_analytics"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "simple_analytics"
+  gem.require_paths = ["lib"]
+  gem.version       = SimpleAnalytics::VERSION
+
+  gem.add_dependency "json"
+  gem.add_dependency "google_client_login", "~> 0.3.1"
+  gem.add_development_dependency "rspec", "~> 2.8"
+  gem.add_development_dependency "fuubar", "~> 0.0.6"
+  gem.add_development_dependency "webmock", "~> 1.7.10"
+end

data/spec/simple_analytics_spec.rb

@@ -0,0 +1,68 @@
+require 'spec_helper'
+
+describe SimpleAnalytics::Api do
+  before do
+    @auth_request = stub_request(:post, "https://www.google.com/accounts/ClientLogin").
+      with(:body => { "accountType" => "GOOGLE", "source" => "djo-simple_analytics-001", "service" => "analytics", "Email"=>"user@gmail.com", "Passwd" => "password" }).
+      to_return(:status => 200, :body => "AUTH=secret\n")
+  end
+
+  describe ".authenticate" do
+    it "requests authentication" do
+      SimpleAnalytics::Api.authenticate('user@gmail.com', 'password')
+      @auth_request.should have_been_requested
+    end
+
+    it "fetches an auth token" do
+      analytics = SimpleAnalytics::Api.authenticate('user@gmail.com', 'password')
+      analytics.auth_token.should eq('secret')
+    end
+  end
+
+  describe "#fetch" do
+    before { stub_analytics_request }
+
+    let(:analytics) { SimpleAnalytics::Api.authenticate('user@gmail.com', 'password') }
+    let(:properties) { { 'ids' => 'ga:id',
+                         'metrics' => 'ga:visitors',
+                         'dimensions' => 'ga:country',
+                         'start-date' => '2012-01-01',
+                         'end-date' => '2012-01-10' } }
+
+    it "raises an argument error without requried properties" do
+      expect {
+        analytics.fetch('ids' => 'ga:xxx')
+      }.to raise_error(ArgumentError)
+    end
+
+    it "fetches rows" do
+      rows = analytics.fetch(properties)
+      rows.should eq([[ "United States", "73834"], ["Ukraine", "15726"]])
+      analytics.rows.should eq([[ "United States", "73834"], ["Ukraine", "15726"]])
+    end
+
+    it "sets column headers" do
+      rows = analytics.fetch(properties)
+      rows.should eq([[ "United States", "73834"], ["Ukraine", "15726"]])
+      analytics.rows.should eq([[ "United States", "73834"], ["Ukraine", "15726"]])
+    end
+
+    it "raises not successful response error" do
+      stub_analytics_request(:status => 403, :code_type => Net::HTTPForbidden)
+
+      expect {
+        analytics.fetch(properties)
+      }.to raise_error(SimpleAnalytics::NotSuccessfulResponseError)
+    end
+
+    def stub_analytics_request(response = {})
+      data = { :body      => { :rows => [[ "United States", "73834"], ["Ukraine", "15726"]] }.to_json,
+               :status    => 200,
+               :code_type => Net::HTTPOK }.merge(response)
+
+      stub_request(:get, "https://www.googleapis.com/analytics/v3/data/ga?dimensions=ga:country&end-date=2012-01-10&ids=ga:id&metrics=ga:visitors&start-date=2012-01-01").
+        with(:headers => { 'Authorization'=>'GoogleLogin auth=secret', 'Gdata-Version'=>'3' }).
+        to_return(data)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'webmock/rspec'
+require 'simple_analytics'

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: simple_analytics
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Andrew Djoga
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70098909002660 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70098909002660
+- !ruby/object:Gem::Dependency
+  name: google_client_login
+  requirement: &70098908994280 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.3.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70098908994280
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70098908993300 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
+  type: :development
+  prerelease: false
+  version_requirements: *70098908993300
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: &70098908992220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.0.6
+  type: :development
+  prerelease: false
+  version_requirements: *70098908992220
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70098908990640 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.10
+  type: :development
+  prerelease: false
+  version_requirements: *70098908990640
+description: The Simple Analytics allows to access Google Analytics report data
+email:
+- andrew.djoga@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.rdoc
+- Rakefile
+- lib/simple_analytics.rb
+- lib/simple_analytics/version.rb
+- simple_analytics.gemspec
+- spec/simple_analytics_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Djo/simple_analytics
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2303643778759929262
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2303643778759929262
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Google Analytics Export API Ruby Wrapper
+test_files:
+- spec/simple_analytics_spec.rb
+- spec/spec_helper.rb