macros-garb 0.2.6

data/lib/garb/data_request.rb

@@ -0,0 +1,38 @@
+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_retries = 5
+      begin 
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.use_ssl = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        http.read_timeout = 60
+        response = http.get("#{uri.path}#{query_string}", 'Authorization' => "GoogleLogin auth=#{Session.auth_token}")
+        raise response.body.inspect unless response.is_a?(Net::HTTPOK)
+        response
+      rescue Timeout::Error
+        sleep(2)
+        retry if (http_retries -= 1 > 0)
+        raise Timeout::Error, "Timeout connecting to google analytics, giving up"
+      end
+    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,50 @@
+module Garb
+  class Profile
+    
+    attr_reader :table_id, :title, :account_name, :account_id
+    
+    class Property
+      include HappyMapper
+      
+      tag 'property'
+      namespace 'dxp'
+      
+      attribute :name, String
+      attribute :value, String
+
+      def instance_name
+        name.from_ga.underscored
+      end
+    end
+
+    class Entry
+      include HappyMapper
+      
+      tag 'entry'
+
+      element :title, String
+      element :tableId, String, :namespace => 'dxp'
+
+      has_many :properties, Property
+    end
+
+    def initialize(entry)
+      @title = entry.title
+      @table_id = entry.tableId
+
+      entry.properties.each do |p|
+        instance_variable_set :"@#{p.instance_name}", p.value
+      end
+    end
+
+    def id
+      @table_id.from_ga
+    end
+
+    def self.all
+      url = "https://www.google.com/analytics/feeds/accounts/default"
+      response = DataRequest.new(url).send_request      
+      Entry.parse(response.body).map {|entry| new(entry)}
+    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, opts={})
+      @email = email
+      auth_request = AuthenticationRequest.new(email, password)
+      @auth_token = auth_request.auth_token(opts)
+    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  = 6
+
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+
+  end
+end

data/test/fixtures/cacert.pem

@@ -0,0 +1,67 @@
+##
+## cacert.pem-foo -- Bundle of CA Root Certificates
+##
+## Converted at: Thu Mar 26 21:23:06 2009 UTC
+##
+## This is a bundle of X.509 certificates of public Certificate Authorities
+## (CA). These were automatically extracted from Mozilla's root certificates
+## file (certdata.txt).  This file can be found in the mozilla source tree:
+## '/mozilla/security/nss/lib/ckfw/builtins/certdata.txt'
+##
+## It contains the certificates in PEM format and therefore
+## can be directly used with curl / libcurl / php_curl, or with
+## an Apache+mod_ssl webserver for SSL client authentication.
+## Just configure this file as the SSLCACertificateFile.
+##
+
+# ***** BEGIN LICENSE BLOCK *****
+# Version: MPL 1.1/GPL 2.0/LGPL 2.1
+#
+# The contents of this file are subject to the Mozilla Public License Version
+# 1.1 (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+# http://www.mozilla.org/MPL/
+#
+# Software distributed under the License is distributed on an "AS IS" basis,
+# WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
+# for the specific language governing rights and limitations under the
+# License.
+#
+# The Original Code is the Netscape security libraries.
+#
+# The Initial Developer of the Original Code is
+# Netscape Communications Corporation.
+# Portions created by the Initial Developer are Copyright (C) 1994-2000
+# the Initial Developer. All Rights Reserved.
+#
+# Contributor(s):
+#
+# Alternatively, the contents of this file may be used under the terms of
+# either the GNU General Public License Version 2 or later (the "GPL"), or
+# the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
+# in which case the provisions of the GPL or the LGPL are applicable instead
+# of those above. If you wish to allow use of your version of this file only
+# under the terms of either the GPL or the LGPL, and not to allow others to
+# use your version of this file under the terms of the MPL, indicate your
+# decision by deleting the provisions above and replace them with the notice
+# and other provisions required by the GPL or the LGPL. If you do not delete
+# the provisions above, a recipient may use your version of this file under
+# the terms of any one of the MPL, the GPL or the LGPL.
+#
+# ***** END LICENSE BLOCK *****
+# @(#) $RCSfile: certdata.txt,v $ $Revision: 1.51 $ $Date: 2009/01/15 22:35:15 $
+
+Verisign/RSA Secure Server CA
+=============================
+-----BEGIN CERTIFICATE-----
+MIICNDCCAaECEAKtZn5ORf5eV288mBle3cAwDQYJKoZIhvcNAQECBQAwXzELMAkGA1UEBhMCVVMx
+IDAeBgNVBAoTF1JTQSBEYXRhIFNlY3VyaXR5LCBJbmMuMS4wLAYDVQQLEyVTZWN1cmUgU2VydmVy
+IENlcnRpZmljYXRpb24gQXV0aG9yaXR5MB4XDTk0MTEwOTAwMDAwMFoXDTEwMDEwNzIzNTk1OVow
+XzELMAkGA1UEBhMCVVMxIDAeBgNVBAoTF1JTQSBEYXRhIFNlY3VyaXR5LCBJbmMuMS4wLAYDVQQL
+EyVTZWN1cmUgU2VydmVyIENlcnRpZmljYXRpb24gQXV0aG9yaXR5MIGbMA0GCSqGSIb3DQEBAQUA
+A4GJADCBhQJ+AJLOesGugz5aqomDV6wlAXYMra6OLDfO6zV4ZFQD5YRAUcm/jwjiioII0haGN1Xp
+sSECrXZogZoFokvJSyVmIlZsiAeP94FZbYQHZXATcXY+m3dM41CJVphIuR2nKRoTLkoRWZweFdVJ
+VCxzOmmCsZc5nG1wZ0jl3S3WyB57AgMBAAEwDQYJKoZIhvcNAQECBQADfgBl3X7hsuyw4jrg7HFG
+mhkRuNPHoLQDQCYCPgmc4RKz0Vr2N6W3YQO2WxZpO8ZECAyIUwxrl0nHPjXcbLm7qt9cuzovk2C2
+qUtN8iD3zV9/ZHuO3ABc1/p3yjkWWW8O6tO1g39NTUJWdrTJXwT4OPjr0l91X817/OWOgHz8UA==
+-----END CERTIFICATE-----

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>
+