vigetlabs-garb 0.1.2

data/lib/garb/report.rb

@@ -0,0 +1,211 @@
+require 'ostruct'
+
+module Garb
+  class Report
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    METRICS = {
+      :visitor => [
+        :avgPageviews,
+        :avgSessionTime,
+        :bounces,
+        :bounceRate,
+        :entrances,
+        :exits,
+        :exitRate,
+        :newVisitors,
+        :pageDuration,
+        :pageviews,
+        :visitDuration,
+        :visitors,
+        :visits
+      ],
+      :campaign => [
+        :cost,
+        :clicks,
+        :clickThroughRate,
+        :costPerConversion,
+        :costPerGoalConversion,
+        :costPerMilleImpressions,
+        :costPerTransaction,
+        :impressions
+      ],
+      :content => [
+        :uniquePageviews
+      ],
+      :ecommerce => [
+        :productPurchases,
+        :productRevenue,
+        :products,
+        :revenue,
+        :revenuePerClick,
+        :revenuePerTransaction,
+        :revenuePerVisit,
+        :shipping,
+        :tax,
+        :transactions
+      ],
+      :internal_search => [
+        :searchDepth,
+        :searchDuration,
+        :searchExits,
+        :searchTransitions,
+        :uniqueInternalSearches,
+        :visitsWithSearches
+      ],
+      :goals => [
+        :goalCompletions1,
+        :goalCompletions2,
+        :goalCompletions3,
+        :goalCompletions4,
+        :goalCompletionsAll,
+        :goalConversionRate,
+        :goalStarts1,
+        :goalStarts2,
+        :goalStarts3,
+        :goalStarts4,
+        :goalStartsAll,
+        :goalValue1,
+        :goalValue2,
+        :goalValue3,
+        :goalValue4,
+        :goalValueAll,
+        :goalValuePerVisit
+      ]
+    }
+    
+    DIMENSIONS = {
+      :visitor => [
+        :browser,
+        :browserVersion,
+        :city,
+        :connectionSpeed,
+        :continent,
+        :country,
+        :daysSinceLastVisit,
+        :domain,
+        :flashVersion,
+        :hostname,
+        :hour,
+        :javaEnabled,
+        :languqage,
+        :medium,
+        :organization,
+        :pageDepth,
+        :platform,
+        :platformVersion,
+        :referralPath,
+        :region,
+        :screenColors,
+        :screenResolution,
+        :subContinentRegion,
+        :userDefinedValue,
+        :visitNumber,
+        :visitorType
+      ],
+      :campaign => [
+        :adGroup,
+        :adSlot,
+        :adSlotPosition,
+        :campaign,
+        :content,
+        :keyword,
+        :source,
+        :sourceMedium
+      ],
+      :content => [
+        :pageTitle,
+        :requestUri,
+        :requestUri1,
+        :requestUriLast
+      ],
+      :ecommerce => [
+        :affiliation,
+        :daysToTransaction,
+        :productCode,
+        :productName,
+        :productVariation,
+        :transactionId,
+        :visitsToTransaction
+      ],
+      :internal_search => [
+        :hasInternalSearch,
+        :internalSearchKeyword,
+        :internalSearchNext,
+        :internalSearchType
+      ]
+    }
+    
+    attr_accessor :metrics, :dimensions, :sort, :filters,
+      :start_date, :max_results, :end_date
+    
+    attr_reader :profile
+
+    # def self.element_id(property_name)
+    #   property_name.is_a?(Operator) ? property_name.to_s : property_name.to_ga.lower_camelized
+    # end
+    # 
+    # def self.property_value(entry, property_name)
+    #   (entry/property_name).first.inner_text
+    # end
+    # 
+    # def self.property_values(entry, property_names)
+    #   hash = property_names.inject({}) do |hash, property_name|
+    #     hash.merge({property_name => property_value(entry, property_name.to_s.lower_camelized)})
+    #   end
+    #   OpenStruct.new hash
+    # end
+    # 
+    def self.format_time(t)
+      t.strftime('%Y-%m-%d')
+    end
+    
+    def initialize(profile, opts={})
+      @profile = profile
+
+      @sort = ReportParameter.new(:sort) << opts.fetch(:sort, [])
+      @filters = ReportParameter.new(:filters) << opts.fetch(:filters, [])      
+      @metrics = ReportParameter.new(:metrics) << opts.fetch(:metrics, [])
+      @dimensions = ReportParameter.new(:dimensions) << opts.fetch(:dimensions, [])
+    
+      @start_date = opts.fetch(:start_date, Time.now - MONTH)
+      @end_date = opts.fetch(:end_date, Time.now)
+      
+      yield self if block_given?
+    end
+
+    def page_params
+      max_results.nil? ? {} : {'max-results' => max_results}
+    end
+    
+    def default_params
+      {'ids' => profile.table_id,
+        'start-date' => self.class.format_time(start_date),
+        'end-date' => self.class.format_time(end_date)}
+    end
+    
+    def params
+      [
+        metrics.to_params,
+        dimensions.to_params,
+        sort.to_params,
+        filters.to_params,
+        page_params
+      ].inject(default_params) do |p, i|
+        p.merge(i)
+      end
+    end
+    
+    def send_request_for_body
+      request = DataRequest.new(URL, params)
+      response = request.send_request
+      response.body
+    end
+    
+    def all
+      @entries = ReportResponse.new(send_request_for_body).parse
+    end
+    
+  end
+end

data/lib/garb/report_parameter.rb

@@ -0,0 +1,36 @@
+module Garb
+  class ReportParameter
+
+    attr_reader :elements
+    
+    def initialize(name)
+      @name = name
+      @elements = []
+    end
+    
+    def name
+      @name.to_s
+    end
+    
+    def <<(element)
+      @elements += [element].flatten
+      self
+    end
+    
+    def to_params
+      params = self.elements.map do |elem|
+        case elem
+        when Hash
+          elem.collect do |k,v|
+            next unless k.is_a?(Operator)
+            "#{k.target}#{CGI::escape(k.operator.to_s)}#{CGI::escape(v.to_s)}"
+          end.join(';')
+        else
+          elem.to_ga
+        end
+      end.join(',')
+      
+      params.empty? ? {} : {self.name => params}
+    end    
+  end
+end

data/lib/garb/report_response.rb

@@ -0,0 +1,56 @@
+module Garb  
+  class ReportResponse
+    def initialize(response_body)
+      @xml = response_body
+    end
+    
+    def parse      
+      entries = Entry.parse(@xml)
+      
+      entries.collect do |entry|
+        hash = {}
+        
+        entry.metrics.each do |m|
+          name = m.name.sub(/^ga\:/,'').underscored
+          hash.merge!({name => m.value})
+        end
+        
+        entry.dimensions.each do |d|
+          name = d.name.sub(/^ga\:/,'').underscored
+          hash.merge!({name => d.value})
+        end
+        
+        OpenStruct.new(hash)
+      end
+    end
+    
+    class Metric
+      include HappyMapper
+
+      tag 'metric'
+      namespace 'dxp'
+
+      attribute :name, String
+      attribute :value, String
+    end
+  
+    class Dimension
+      include HappyMapper
+
+      tag 'dimension'
+      namespace 'dxp'
+
+      attribute :name, String
+      attribute :value, String
+    end
+  
+    class Entry
+      include HappyMapper
+    
+      tag 'entry'
+
+      has_many :metrics, Metric
+      has_many :dimensions, Dimension
+    end
+  end
+end

data/lib/garb/session.rb

@@ -0,0 +1,19 @@
+module Garb
+  class Session
+    
+    def self.login(email, password)
+      @email = email
+      auth_request = AuthenticationRequest.new(email, password)
+      @auth_token = auth_request.auth_token
+    end
+    
+    def self.auth_token
+      @auth_token
+    end
+    
+    def self.email
+      @email
+    end
+
+  end
+end

data/lib/garb.rb

@@ -0,0 +1,67 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'net/http'
+require 'net/https'
+require 'rubygems'
+require 'cgi'
+require 'happymapper'
+
+require 'garb/authentication_request'
+require 'garb/data_request'
+require 'garb/session'
+require 'garb/profile'
+require 'garb/report'
+require 'garb/report_parameter'
+require 'garb/report_response'
+
+require 'extensions/string'
+require 'extensions/operator'
+require 'extensions/symbol'
+require 'extensions/happymapper'
+
+module Garb
+  # :stopdoc:
+  GA = "http://schemas.google.com/analytics/2008"
+
+  VERSION = '0.1.2'
+  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
+  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
+  # :startdoc:
+
+  # Returns the version string for the library.
+  #
+  def self.version
+    VERSION
+  end
+
+  # Returns the library path for the module. If any arguments are given,
+  # they will be joined to the end of the libray path using
+  # <tt>File.join</tt>.
+  #
+  def self.libpath( *args )
+    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
+  end
+
+  # Returns the lpath for the module. If any arguments are given,
+  # they will be joined to the end of the path using
+  # <tt>File.join</tt>.
+  #
+  def self.path( *args )
+    args.empty? ? PATH : ::File.join(PATH, args.flatten)
+  end
+
+  # Utility method used to rquire all files ending in .rb that lie in the
+  # directory below this file that has the same name as the filename passed
+  # in. Optionally, a specific _directory_ name can be passed in such that
+  # the _filename_ does not have to be equivalent to the directory.
+  #
+  def self.require_all_libs_relative_to( fname, dir = nil )
+    dir ||= ::File.basename(fname, '.*')
+    search_me = ::File.expand_path(
+        ::File.join(::File.dirname(fname), dir, '*', '*.rb'))
+
+    Dir.glob(search_me).sort.each {|rb| require rb}
+  end
+end  # module Garb
+
+# EOF

data/test/authentication_request_test.rb

@@ -0,0 +1,91 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+module Garb
+  class AuthenticationRequestTest < Test::Unit::TestCase
+    
+    context "An instance of the AuthenticationRequest class" do
+      
+      setup { @request = AuthenticationRequest.new('email', 'password') }
+      
+      should "have a collection of parameters that include the email and password" do
+        expected = 
+          {
+            'Email'       => 'user@example.com',
+            'Passwd'      => 'fuzzybunnies',
+            'accountType' => 'HOSTED_OR_GOOGLE',
+            'service'     => 'analytics',
+            'source'      => 'vigetLabs-garb-001'
+          }
+        
+        request = AuthenticationRequest.new('user@example.com', 'fuzzybunnies')
+        assert_equal expected, request.parameters
+      end
+      
+      should "have a URI" do
+        assert_equal URI.parse('https://www.google.com/accounts/ClientLogin'), @request.uri
+      end
+      
+      
+      should "be able to send a request to the GAAPI service" do        
+        @request.expects(:build_request).returns('post')
+        response = mock {|m| m.expects(:is_a?).with(Net::HTTPOK).returns(true) }
+        
+        http = mock do |m|
+          m.expects(:use_ssl=).with(true)
+          m.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+          m.expects(:request).with('post').yields(response)
+        end
+        
+        Net::HTTP.expects(:new).with('www.google.com', 443).returns(http)
+        
+        @request.send_request
+      end
+      
+      should "be able to build a request for the GAAPI service" do
+        params = "param"
+        @request.expects(:parameters).with().returns(params)
+        
+        post = mock
+        post.expects(:set_form_data).with(params)
+        
+        Net::HTTP::Post.expects(:new).with('/accounts/ClientLogin').returns(post)
+        
+        @request.build_request
+      end
+      
+      should "be able to retrieve an auth_token from the body" do
+        response_data =
+          "SID=mysid\n" +
+          "LSID=mylsid\n" +
+          "Auth=auth_token\n"
+          
+        @request.expects(:send_request).with().returns(stub(:body => response_data))
+        
+        assert_equal 'auth_token', @request.auth_token
+      end
+      
+      should "raise an exception when requesting an auth_token when the authorization fails" do
+        @request.stubs(:build_request)
+        response = mock do |m|
+          m.expects(:is_a?).with(Net::HTTPOK).returns(false)
+        end
+        
+        http = stub do |s|
+          s.stubs(:use_ssl=)
+          s.stubs(:verify_mode=)
+          s.stubs(:request).yields(response)
+        end
+        
+        Net::HTTP.stubs(:new).with('www.google.com', 443).returns(http)
+        
+        assert_raise(Garb::AuthenticationRequest::AuthError) do
+          @request.send_request
+        end
+      end
+      
+    end
+    
+    
+    
+  end
+end

data/test/data_request_test.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+module Garb
+  class DataRequestTest < Test::Unit::TestCase
+    
+    context "An instance of the DataRequest class" do
+
+      should "be able to build the query string from parameters" do
+        parameters = {'ids' => '12345', 'metrics' => 'country'}
+        data_request = DataRequest.new("", parameters)
+        
+        query_string = data_request.query_string
+        
+        assert_match(/^\?/, query_string)
+        
+        query_string.sub!(/^\?/, '')
+        
+        assert_equal ["ids=12345", "metrics=country"], query_string.split('&').sort
+      end
+      
+      should "return an empty query string if parameters are empty" do
+        data_request = DataRequest.new("")
+        assert_equal "", data_request.query_string
+      end
+      
+      should "be able to build a uri" do
+        url        = 'http://example.com'
+        expected = URI.parse('http://example.com')
+        
+        assert_equal expected, DataRequest.new(url).uri
+      end
+      
+      should "be able to make a request to the GAAPI" do
+        Session.expects(:auth_token).with().returns('toke')
+        response = mock
+        response.expects(:is_a?).with(Net::HTTPOK).returns(true)
+        
+        http = mock do |m|
+          m.expects(:use_ssl=).with(true)
+          m.expects(:verify_mode=).with(OpenSSL::SSL::VERIFY_NONE)
+          m.expects(:get).with('/data?key=value', 'Authorization' => 'GoogleLogin auth=toke').returns(response)
+        end
+        
+        Net::HTTP.expects(:new).with('example.com', 443).returns(http)
+        
+        data_request = DataRequest.new('https://example.com/data', 'key' => 'value')
+        assert_equal response, data_request.send_request
+      end
+    end
+
+  end
+end

data/test/fixtures/profile_feed.xml

@@ -0,0 +1,33 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/' xmlns:dxp='http://schemas.google.com/analytics/2009'>
+  <id>http://www.google.com/analytics/feeds/accounts/email@example.com</id>
+  <updated>2009-03-27T08:14:28.000-07:00</updated>
+  <title type='text'>Profile list for email@example.com</title>
+  <link rel='self' type='application/atom+xml' href='http://www.google.com/analytics/feeds/accounts/email@example.com'/>
+  <author><name>Google Analytics</name></author>
+  <generator version='1.0'>Google Analytics</generator>
+  <openSearch:totalResults>2</openSearch:totalResults>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <openSearch:itemsPerPage>2</openSearch:itemsPerPage>
+  <entry>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:12345</id>
+    <updated>2008-07-21T14:05:57.000-07:00</updated>
+    <title type='text'>Historical</title>
+    <dxp:tableId>ga:12345</dxp:tableId>
+    <dxp:property name='ga:accountId' value='1111'/>
+    <dxp:property name='ga:accountName' value='Blog Beta'/>
+    <dxp:property name='ga:profileId' value='1212'/>
+    <dxp:property name='ga:webPropertyId' value='UA-1111-1'/>
+  </entry>
+  <entry>
+    <id>http://www.google.com/analytics/feeds/accounts/ga:12346</id>
+    <updated>2008-11-24T11:51:07.000-08:00</updated>
+    <title type='text'>Presently</title>
+    <dxp:tableId>ga:12346</dxp:tableId>
+    <dxp:property name='ga:accountId' value='1111'/>
+    <dxp:property name='ga:accountName' value='Blog Beta'/>
+    <dxp:property name='ga:profileId' value='1213'/>
+    <dxp:property name='ga:webPropertyId' value='UA-1111-2'/>
+  </entry>
+</feed>
+  

data/test/fixtures/report_feed.xml

@@ -0,0 +1,46 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<feed xmlns='http://www.w3.org/2005/Atom'
+  xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/'
+  xmlns:dxp='http://schemas.google.com/dataexport/2009'
+  xmlns:ga='http://schemas.google.com/analytics/2008'>
+    <id>http://www.google.com/analytics/feeds/data?ids=ga:983247&amp;dimensions=ga:country,ga:city&amp;metrics=ga:pageViews&amp;start-date=2008-01-01&amp;end-date=2008-01-02</id>
+    <updated>2008-01-02T15:59:59.999-08:00 </updated>
+    <title type="text">Google Analytics Data for Profile 983247</title>
+    <link href="http://www.google.com/analytics/feeds/data" rel="http://schemas.google.com/g/2005#feed" type="application/atom+xml"/>
+    <link href="http://www.google.com/analytics/feeds/data?end-date=2008-01-02&amp;start-date=2008-01-01&amp;metrics=ga%3ApageViews&amp;ids=ga%3A983247&amp;dimensions=ga%3Acountry%2Cga%3Acity" rel="self" type="application/atom+xml"/>
+    <link href="http://www.google.com/analytics/feeds/data?start-index=1001&amp;max-results=1000&amp;end-date=2008-01-02&amp;start-date=2008-01-01&amp;metrics=ga%3ApageViews&amp;ids=ga%3A983247&amp;dimensions=ga%3Acountry%2Cga%3Acity" rel="next" type="application/atom+xml"/>
+    <author>
+      <name>Google Analytics</name>
+    </author>    
+  <openSearch:startIndex>3</openSearch:startIndex>
+  <openSearch:itemsPerPage>4</openSearch:itemsPerPage>
+  <ga:webPropertyID>UA-983247-67</ga:webPropertyID>
+  <ga:start-date>2008-01-01</ga:start-date>
+  <ga:end-date>2008-01-02</ga:end-date>
+
+  <entry>
+    <id> http://www.google.com/analytics/feeds/data?ids=ga:1174&amp;ga:country=%28not%20set%29&amp;ga:city=%28not%20set%29&amp;start-date=2008-01-01&amp;end-date=2008-01-02 </id>
+    <updated> 2008-01-01T16:00:00.001-08:00 </updated>
+    <title type="text"> ga:country=(not set) | ga:city=(not set) </title>
+    <link href="http://www.google.com/analytics/feeds/data" rel="self" type="application/atom+xml"/>
+    <dxp:dimension name="ga:country" value="(not set)" />
+    <dxp:dimension name="ga:city" value="(not set)" />
+    <dxp:metric name="ga:pageviews" value="33" />
+  </entry>
+  <entry>
+    <id> http://www.google.com/analytics/feeds/data?ids=ga:1174&amp;ga:country=Afghanistan&amp;ga:city=Kabul&amp;start-date=2008-01-01&amp;end-date=2008-01-02 </id>
+    <updated> 2008-01-01T16:00:00.001-08:00 </updated>
+    <title type="text"> ga:country=Afghanistan | ga:city=Kabul </title>
+    <dxp:dimension name="ga:country" value="Afghanistan" />
+    <dxp:dimension name="ga:city" value="Kabul" />
+    <dxp:metric name="ga:pageviews" value="2" />
+  </entry>
+  <entry>
+    <id> http://www.google.com/analytics/feeds/data?ids=ga:1174&amp;ga:country=Albania&amp;ga:city=Tirana&amp;start-date=2008-01-01&amp;end-date=2008-01-02 </id>
+    <updated> 2008-01-01T16:00:00.001-08:00 </updated>
+    <title type="text"> ga:country=Albania | ga:city=Tirana </title>
+    <dxp:dimension name="ga:country" value="Albania" />
+    <dxp:dimension name="ga:city" value="Tirana" />
+    <dxp:metric name="ga:pageviews" value="1" />
+  </entry>
+</feed>

data/test/garb_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class GarbTest < Test::Unit::TestCase
+  context "A green egg" do
+    should "be served with ham" do
+      assert true
+    end
+  end  
+end

data/test/operator_test.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class OperatorTest < Test::Unit::TestCase
+  context "An instance of an Operator" do
+    should "lower camelize the target" do
+      assert_equal "ga:uniqueVisits=", Operator.new(:unique_visits, "=").to_ga
+    end
+    
+    should "return target and operator together" do
+      assert_equal "ga:metric=", Operator.new(:metric, "=").to_ga
+    end
+    
+    should "prefix the operator to the target" do
+      assert_equal "-ga:metric", Operator.new(:metric, "-", true).to_ga
+    end
+    
+    should "know if it is equal to another operator" do
+      op1 = Operator.new(:hello, "==")
+      op2 = Operator.new(:hello, "==")
+      assert_equal op1, op2
+    end
+    
+    should "not be equal to another operator if target, operator, or prefix is different" do
+      op1 = Operator.new(:hello, "==")
+      op2 = Operator.new(:hello, "==", true)
+      assert_not_equal op1, op2
+      
+      op1 = Operator.new(:hello1, "==")
+      op2 = Operator.new(:hello2, "==")
+      assert_not_equal op1, op2
+      
+      op1 = Operator.new(:hello, "!=")
+      op2 = Operator.new(:hello, "==")
+      assert_not_equal op1, op2
+    end
+  end
+end