garb 0.2.1

data/lib/garb/data_request.rb

@@ -0,0 +1,28 @@
+module Garb
+  class DataRequest
+
+    def initialize(base_url, parameters={})
+      @base_url = base_url
+      @parameters = parameters
+    end
+
+    def query_string
+      parameter_list = @parameters.map {|k,v| "#{k}=#{v}" }
+      parameter_list.empty? ? '' : "?#{parameter_list.join('&')}"
+    end
+
+    def uri
+      URI.parse(@base_url)
+    end
+
+    def send_request
+      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}", 'Authorization' => "GoogleLogin auth=#{Session.auth_token}")
+      raise response.body.inspect unless response.is_a?(Net::HTTPOK)
+      response
+    end
+
+  end
+end

data/lib/garb/oauth_session.rb

@@ -0,0 +1,21 @@
+module Garb
+  class OAuthSession
+    attr_accessor :access_token
+    
+    OAuthGetRequestToken = "https://www.google.com/accounts/OAuthGetRequestToken"
+    OAuthAuthorizeToken = "https://www.google.com/accounts/OAuthAuthorizeToken"
+    OAuthGetAccessToken = "https://www.google.com/accounts/OAuthGetAccessToken"
+    
+    def get_request_token
+      
+    end
+    
+    def authorization_request
+      
+    end
+    
+    def get_access_token
+      
+    end
+  end
+end

data/lib/garb/profile.rb

@@ -0,0 +1,45 @@
+module Garb
+  class Profile
+    
+    attr_reader :table_id, :title, :account_name
+    
+    class Property
+      include HappyMapper
+      
+      tag 'property'
+      namespace 'dxp'
+      
+      attribute :name, String
+      attribute :value, String
+    end
+
+    class Entry
+      include HappyMapper
+      
+      tag 'entry'
+      
+      element :id, Integer
+      element :title, String
+      element :tableId, String, :namespace => 'dxp'
+      
+      # has_one :table_id, TableId
+      has_many :properties, Property
+    end
+
+    def initialize(entry)
+      @title = entry.title
+      @table_id = entry.tableId
+      @account_name = entry.properties.detect{|p| p.name == 'ga:accountName'}.value
+    end
+    
+    def id
+      @table_id.sub(/^ga:/, '')
+    end
+    
+    def self.all
+      url = "https://www.google.com/analytics/feeds/accounts/#{Session.email}"
+      response = DataRequest.new(url).send_request      
+      Entry.parse(response.body).map {|e| Garb::Profile.new(e)}
+    end
+  end
+end

data/lib/garb/report.rb

@@ -0,0 +1,31 @@
+module Garb
+  class Report
+    include Resource::ResourceMethods
+
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    def initialize(profile, opts={})
+      @profile = profile
+
+      @start_date = opts.fetch(:start_date, Time.now - MONTH)
+      @end_date = opts.fetch(:end_date, Time.now)
+      @limit = opts.fetch(:limit, nil)
+      @offset = opts.fetch(:offset, nil)
+
+      # clear filters and sort
+      @filters = ReportParameter.new(:filters)
+      @sorts = ReportParameter.new(:sort)
+
+      metrics opts.fetch(:metrics, [])
+      dimensions opts.fetch(:dimensions, [])
+      filter opts.fetch(:filter, [])
+      sort opts.fetch(:sort, [])
+    end
+
+    def results
+      ReportResponse.new(send_request_for_body).results
+    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).compact!
+      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}#{URI.encode(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,62 @@
+module Garb  
+  class ReportResponse
+    # include Enumerable
+
+    def initialize(response_body)
+      @xml = response_body
+    end
+    
+    def parse      
+      entries = Entry.parse(@xml)
+      
+      @results = 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
+
+    def results
+      @results || parse
+    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/resource.rb

@@ -0,0 +1,89 @@
+module Garb
+  module Resource
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    def self.included(report)
+      report.extend(ResourceMethods)
+    end
+
+    module ResourceMethods
+
+      def metrics(*fields)
+        @metrics ||= ReportParameter.new(:metrics)
+        @metrics << fields
+      end
+
+      def dimensions(*fields)
+        @dimensions ||= ReportParameter.new(:dimensions)
+        @dimensions << fields
+      end
+
+      def filter(*hash)
+        @filters << hash
+      end
+
+      def filters
+        @filters ||= ReportParameter.new(:filters)
+      end
+
+      def sort(*fields)
+        @sorts << fields
+      end
+
+      def sorts
+        @sorts ||= ReportParameter.new(:sort)
+      end
+
+      def results(profile, opts = {}, &block)
+        @profile = profile
+
+        # clear filters and sort
+        @filters = ReportParameter.new(:filters)
+        @sorts = ReportParameter.new(:sort)
+
+        @start_date = opts.fetch(:start_date, Time.now - MONTH)
+        @end_date = opts.fetch(:end_date, Time.now)
+        @limit = opts.fetch(:limit, nil)
+        @offset = opts.fetch(:offset, nil)
+
+        instance_eval(&block) if block_given?
+
+        ReportResponse.new(send_request_for_body).results
+      end
+
+      def page_params
+        {'max-results' => @limit, 'start-index' => @offset}.reject{|k,v| v.nil?}
+      end
+
+      def default_params
+        {'ids' => @profile.table_id,
+          'start-date' => format_time(@start_date),
+          'end-date' => format_time(@end_date)}
+      end
+
+      def params
+        [
+          metrics.to_params,
+          dimensions.to_params,
+          sorts.to_params,
+          filters.to_params,
+          page_params
+        ].inject(default_params) do |p, i|
+          p.merge(i)
+        end
+      end
+
+      def format_time(t)
+        t.strftime('%Y-%m-%d')
+      end
+
+      def send_request_for_body
+        request = DataRequest.new(URL, params)
+        response = request.send_request
+        response.body
+      end
+
+    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/version.rb

@@ -0,0 +1,13 @@
+module Garb
+  module Version
+
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 1
+
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    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/test_helper.rb

@@ -0,0 +1,16 @@
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/garb'
+
+class Test::Unit::TestCase
+  
+  def read_fixture(filename)
+    File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
+  end
+  
+end