garb-no-activesupport 0.7.3

data/lib/garb/resource.rb

@@ -0,0 +1,92 @@
+module Garb
+  module Resource
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    def self.extended(base)
+      # define a method on a module that gets included into profile
+      # Exits would make:
+      # to enable profile.exits(options_hash, &block)
+      # returns Exits.results(self, options_hash, &block)
+      # every class defined which extends Resource will add to the module
+      ProfileReports.add_report_method(base)
+    end
+
+    %w(metrics dimensions sort).each do |parameter|
+      class_eval <<-CODE
+        def #{parameter}(*fields)
+          @#{parameter} ||= ReportParameter.new(:#{parameter})
+          @#{parameter} << fields
+        end
+
+        def clear_#{parameter}
+          @#{parameter} = ReportParameter.new(:#{parameter})
+        end
+      CODE
+    end
+
+    def filters(*hashes, &block)
+      @filter_parameters ||= FilterParameters.new
+
+      hashes.each do |hash|
+        @filter_parameters.parameters << hash
+      end
+
+      @filter_parameters.filters(&block) if block_given?
+      @filter_parameters
+    end
+
+    def clear_filters
+      @filter_parameters = FilterParameters.new
+    end
+
+    def results(profile, opts = {}, &block)
+      @profile = profile.is_a?(Profile) ? profile : Profile.first(profile, opts.fetch(:session, Session))
+
+      if @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)
+
+        instance_eval(&block) if block_given?
+
+        ReportResponse.new(send_request_for_body).results
+      else
+        []
+      end
+    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,
+        sort.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(@profile.session, URL, params)
+      response = request.send_request
+      response.body
+    end
+  end
+end

data/lib/garb/session.rb

@@ -0,0 +1,25 @@
+module Garb
+  class Session
+    module Methods
+      attr_accessor :auth_token, :access_token, :email
+
+      # use only for single user authentication
+      def login(email, password, opts={})
+        self.email = email
+        auth_request = AuthenticationRequest.new(email, password, opts)
+        self.auth_token = auth_request.auth_token(opts)
+      end
+
+      def single_user?
+        auth_token && auth_token.is_a?(String)
+      end
+
+      def oauth_user?
+        !access_token.nil?
+      end
+    end
+
+    include Methods
+    extend Methods
+  end
+end

data/lib/garb/version.rb

@@ -0,0 +1,13 @@
+module Garb
+  module Version
+
+    MAJOR = 0
+    MINOR = 7
+    TINY  = 3
+
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+
+  end
+end

data/lib/garb.rb

@@ -0,0 +1,38 @@
+$:.unshift File.expand_path(File.dirname(__FILE__))
+
+require 'net/http'
+require 'net/https'
+
+require 'cgi'
+require 'ostruct'
+require 'happymapper'
+
+require 'string_ext'
+require 'garb/version'
+require 'garb/authentication_request'
+require 'garb/data_request'
+require 'garb/session'
+require 'garb/profile_reports'
+require 'garb/profile'
+require 'garb/account'
+require 'garb/filter_parameters'
+require 'garb/report_parameter'
+require 'garb/report_response'
+require 'garb/resource'
+require 'garb/report'
+
+require 'support'
+
+module Garb
+  GA = "http://schemas.google.com/analytics/2008"
+  
+  def self.to_google_analytics(thing)
+    return thing.to_google_analytics if thing.respond_to?(:to_google_analytics)
+
+    "ga:#{thing.to_s.camelize(:lower)}"
+  end
+
+  def self.from_google_analytics(thing)
+    thing.to_s.gsub(/^ga\:/, '').underscore
+  end
+end

data/lib/string_ext.rb

@@ -0,0 +1,20 @@
+# These are pulled out of ActiveSupport
+
+class String
+  def camelize(first_letter_in_uppercase = :upper)
+    if first_letter_in_uppercase == :upper
+      gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+    else
+      self[0..0].downcase + camelize[1..-1]
+    end
+  end
+
+  def underscore
+    gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+  end
+end
+

data/lib/support.rb

@@ -0,0 +1,39 @@
+class SymbolOperator
+  def initialize(field, operator)
+    @field, @operator = field, operator
+  end unless method_defined?(:initialize)
+
+  def to_google_analytics
+    operators = {
+      :eql => '==',
+      :not_eql => '!=',
+      :gt => '>',
+      :gte => '>=',
+      :lt => '<',
+      :lte => '<=',
+      :matches => '==',
+      :does_not_match => '!=',
+      :contains => '=~',
+      :does_not_contain => '!~',
+      :substring => '=@',
+      :not_substring => '!@',
+      :desc => '-'
+    }
+
+    target = Garb.to_google_analytics(@field)
+    operator = operators[@operator]
+
+    @operator == :desc ? "#{operator}#{target}" : "#{target}#{operator}"
+  end
+end
+
+class Symbol
+  [:eql, :not_eql, :gt, :gte, :lt, :lte, :desc,
+    :matches, :does_not_match, :contains, :does_not_contain,
+    :substring, :not_substring].each do |operator|
+
+    define_method(operator) do
+      SymbolOperator.new(self, operator)
+    end unless method_defined?(operator)
+  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,40 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<feed xmlns='http://www.w3.org/2005/Atom' xmlns:dxp='http://schemas.google.com/analytics/2009' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/'>
+	<id>http://www.google.com/analytics/feeds/accounts/tpitale@gmail.com</id>
+	<updated>2009-10-02T07:47:35.000-07:00</updated>
+	<title type='text'>Profile list for tpitale@gmail.com</title><link rel='self' type='application/atom+xml' href='http://www.google.com/analytics/feeds/accounts/default'/>
+	<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>
+		<link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+    <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'/>
+		<dxp:property name='ga:currency' value='USD'/>
+		<dxp:property name='ga:timezone' value='America/New_York'/>
+		<dxp:tableId>ga:12345</dxp:tableId>
+  </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>
+		<link rel='alternate' type='text/html' href='http://www.google.com/analytics'/>
+    <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'/>
+		<dxp:property name='ga:currency' value='USD'/>
+		<dxp:property name='ga:timezone' value='America/New_York'/>
+		<dxp:tableId>ga:12346</dxp:tableId>
+  </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/analytics/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,18 @@
+$:.reject! { |e| e.include? 'TextMate' }
+
+require 'rubygems'
+require 'minitest/unit'
+require 'shoulda'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/garb'
+
+class MiniTest::Unit::TestCase
+
+  def read_fixture(filename)
+    File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
+  end
+  
+end
+
+MiniTest::Unit.autorun

data/test/unit/garb/account_test.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
+
+module Garb
+  class AccountTest < MiniTest::Unit::TestCase
+    context "The Account class" do
+      should "have an array of accounts with all profiles" do
+        p1 = stub(:account_id => '1111', :account_name => 'Blog 1')
+        p2 = stub(:account_id => '1112', :account_name => 'Blog 2')
+
+        Profile.stubs(:all).returns([p1,p2,p1,p2])
+        Account.stubs(:new).returns('account1', 'account2')
+
+        assert_equal ['account1','account2'], Account.all
+        assert_received(Profile, :all)
+        assert_received(Account, :new) {|e| e.with([p1,p1])}
+        assert_received(Account, :new) {|e| e.with([p2,p2])}
+      end
+    end
+
+    context "An instance of the Account class" do
+      setup do
+        profile = stub(:account_id => '1111', :account_name => 'Blog 1')
+        @profiles = [profile,profile]
+        @account = Account.new(@profiles)
+      end
+
+      context "all" do
+        should "use an optional user session" do
+          session = Session.new
+          Garb::Profile.expects(:all).with(session).returns(@profiles)
+
+          accounts = Account.all(session)
+          assert_equal 1, accounts.size
+          assert_equal @profiles, accounts.first.profiles
+        end
+      end
+
+      context "when creating a new account from an array of profiles" do
+        should "take the account id from the first profile" do
+          assert_equal @profiles.first.account_id, @account.id
+        end
+
+        should "take the account name from the first profile" do
+          assert_equal @profiles.first.account_name, @account.name
+        end
+
+        should "store the array of profiles" do
+          assert_equal @profiles, @account.profiles
+        end
+      end
+    end
+  end
+end

data/test/unit/garb/authentication_request_test.rb

@@ -0,0 +1,121 @@
+require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
+
+CA_CERT_FILE = File.join(File.dirname(__FILE__), '..', '/cacert.pem')
+
+module Garb
+  class AuthenticationRequestTest < MiniTest::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 with proper ssl" 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_PEER)
+          m.expects(:ca_file=).with(CA_CERT_FILE)
+          m.expects(:request).with('post').yields(response)
+        end
+        
+        Net::HTTP.expects(:new).with('www.google.com', 443).returns(http)
+
+        @request.send_request(OpenSSL::SSL::VERIFY_PEER)
+      end
+
+      should "be able to send a request to the GAAPI service with ignoring ssl" 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(OpenSSL::SSL::VERIFY_NONE)
+      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(OpenSSL::SSL::VERIFY_NONE).returns(stub(:body => response_data))
+
+        assert_equal 'auth_token', @request.auth_token
+      end
+
+      should "use VERIFY_PEER if auth_token needs to be secure" do
+        response_data =
+          "SID=mysid\n" +
+          "LSID=mylsid\n" +
+          "Auth=auth_token\n"
+
+        @request.expects(:send_request).with(OpenSSL::SSL::VERIFY_PEER).returns(stub(:body => response_data))
+
+        assert_equal 'auth_token', @request.auth_token(:secure => true)
+      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_raises(Garb::AuthenticationRequest::AuthError) do
+          @request.send_request(OpenSSL::SSL::VERIFY_NONE)
+        end
+      end
+      
+    end
+    
+    
+    
+  end
+end