garb 0.5.1 → 0.6.0

data/README.md

@@ -1,37 +1,12 @@
-garb
+Garb
 ====
 
-  by Tony Pitale with much help from Justin Marney, Patrick Reagan and others at Viget Labs
-
   http://github.com/vigetlabs/garb
 
 Important Changes
 =================
 
-Version 0.5.0
-
-  * Filters now have a new DSL so that I could toss Symbol operators (which conflict with DataMapper and MongoMapper)
-  * The method of passing a hash to filters no longer works, at all
-
-Version 0.4.0
-  
-  * Changes the api for filters and sort making it consistent with metrics/dimensions
-  * If you wish to clear the defaults defined on a class, you may use clear_(filters/sort/metrics/dimensions)
-  * To make a custom class using Garb::Resource, you must now extend instead of include the module
-
-Version 0.3.2
-
-  * adds Profile.first which can be used to get the first profile with a table id, or web property id (UA number)
-
-Version 0.2.4
-
-  * requires happymapper from rubygems, version 0.2.5. Be sure to update.
-
-Version 0.2.0
-
-  * makes major changes (compared to 0.1.0) to the way garb is used to build reports.
-  * There is now both a module that gets included for generating defined classes,
-  * slight changes to the way that the Report class can be used.
+ Please read CHANGELOG
 
 Description
 -----------
@@ -43,13 +18,19 @@ Description
 Basic Usage
 ===========
 
-Login
------
+Single User Login
+-----------------
   
     > Garb::Session.login(username, password)
+    
+OAuth Access Token
+------------------
+
+    > Garb::Session.access_token = access_token # assign from oauth gem
 
 Accounts
 --------
+
     > Garb::Account.all
 
 Profiles
@@ -62,8 +43,8 @@ Profiles
     > Garb::Profile.all
     > profile = Garb::Profile.all.first
 
-Define a Report Class and Get Results
--------------------------------------
+Define a Report Class
+---------------------
 
     class Exits
       extend Garb::Resource
@@ -75,8 +56,20 @@ Define a Report Class and Get Results
       filters do
         eql(:page_path, 'season')
       end
+
+      # alternative:
+      # filters :page_path.eql => 10
     end
 
+Get the Results
+---------------
+
+    > Exits.results(profile)
+
+  OR shorthand
+
+    > profile.exits
+
 Other Parameters
 ----------------
 
@@ -118,6 +111,9 @@ Building a Report
         contains(:page_path, 'season')
         gt(:exits, 100)
       end
+
+      # or with a hash
+      # filters :page_path.contains => 'season', :exits.gt => 100
     end
 
   reports will be an array of OpenStructs with methods for the metrics and dimensions returned.
@@ -135,6 +131,9 @@ Build a One-Off Report
       gte(:exits, 10)
     and
 
+    # or with a hash
+    # report.filters :page_path.contains => 'season', :exits.gt => 100
+
     report.results
 
 Filtering
@@ -152,21 +151,21 @@ Filtering
 
   Operators on metrics:
 
-    :eql => '==',
-    :not_eql => '!=',
-    :gt => '>',
-    :gte => '>=',
-    :lt => '<',
-    :lte => '<='
+    eql => '==',
+    not_eql => '!=',
+    gt => '>',
+    gte => '>=',
+    lt => '<',
+    lte => '<='
 
   Operators on dimensions:
 
-    :matches => '==',
-    :does_not_match => '!=',
-    :contains => '=~',
-    :does_not_contain => '!~',
-    :substring => '=@',
-    :not_substring => '!@'
+    matches => '==',
+    does_not_match => '!=',
+    contains => '=~',
+    does_not_contain => '!~',
+    substring => '=@',
+    not_substring => '!@'
     
   Given the previous example one-off report, we can add a line for filter:
   
@@ -174,10 +173,14 @@ Filtering
       eql(:page_path, '/extend/effectively-using-git-with-subversion/')
     end
 
+  Or, if you're comfortable using symbol operators:
+
+    report.filters :page_path.eql => '/extend/effectively-using-git-with-subversion/'
+
 SSL
 ---
 
-  Version 0.2.3 includes support for real ssl encryption for authentication. First do:
+  Version 0.2.3 includes support for real ssl encryption for SINGLE USER authentication. First do:
 
     Garb::Session.login(username, password, :secure => true)
 
@@ -191,27 +194,40 @@ TODOS
 -----
 
   * Sessions are currently global, which isn't awesome
-  * Single user login is the only supported method currently.
-    Intend to add hooks for using OAuth
   * Read opensearch header in results
 
 Requirements
 ------------
 
-  happymapper >= 0.3.0 (should also install libxml)
-  active_support >= 2.3.0
+  * happymapper >= 0.3.0 (should also install libxml)
+  * active_support >= 2.3.0
+
+Requirements for Testing
+------------------------
+
+  * jferris-mocha
+  * tpitale-shoulda (works with minitest)
 
 Install
 -------
 
     sudo gem install garb
 
+Contributors
+------------
+
+  Many Thanks, for all their help, goes to:
+
+  * Patrick Reagan
+  * Justin Marney
+  * Nick Plante
+
 License
 -------
 
   (The MIT License)
 
-  Copyright (c) 2008 Viget Labs
+  Copyright (c) 2010 Viget Labs
 
   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the

data/Rakefile

@@ -12,7 +12,7 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc          = false
   s.rubyforge_project = 'viget'
   s.summary           = "Google Analytics API Ruby Wrapper"
-  s.authors           = ['Tony Pitale', 'Patrick Reagan']
+  s.authors           = ['Tony Pitale']
   s.email             = 'tony.pitale@viget.com'
   s.homepage          = 'http://github.com/vigetlabs/garb'
   s.files             = %w(README.md Rakefile) + Dir.glob("lib/**/*")

data/lib/garb.rb

@@ -9,10 +9,10 @@ require 'happymapper'
 require 'active_support'
 
 require 'garb/version'
-require 'garb/profile_array'
 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'

data/lib/garb/account.rb

@@ -9,7 +9,21 @@ module Garb
     end
 
     def self.all
-      Profile.all.group_to_array{|p| p.account_id}.map{|profiles| new(profiles)}
+      # Profile.all.group_to_array{|p| p.account_id}.map{|profiles| new(profiles)}
+
+      profile_groups = Profile.all.inject({}) do |hash, profile|
+        key = profile.account_id
+        
+        if hash.has_key?(key)
+          hash[key] << profile
+        else
+          hash[key] = [profile]
+        end
+
+        hash
+      end
+
+      profile_groups.map {|k,v| v}.map {|profiles| new(profiles)}
     end
   end
 end

data/lib/garb/data_request.rb

@@ -1,5 +1,6 @@
 module Garb
   class DataRequest
+    class ClientError < StandardError; end
 
     def initialize(base_url, parameters={})
       @base_url = base_url
@@ -16,13 +17,25 @@ module Garb
     end
 
     def send_request
+      response = if Session.single_user?
+        single_user_request
+      elsif Session.oauth_user?
+        oauth_user_request
+      end
+
+      raise ClientError, response.body.inspect unless response.kind_of?(Net::HTTPSuccess)
+      response
+    end
+
+    def single_user_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
+      http.get("#{uri.path}#{query_string}", 'Authorization' => "GoogleLogin auth=#{Session.auth_token}")
     end
 
+    def oauth_user_request
+      Session.access_token.get("#{uri}#{query_string}")
+    end
   end
-end
+end

data/lib/garb/profile.rb

@@ -1,6 +1,8 @@
 module Garb
   class Profile
-    
+
+    include ProfileReports
+
     attr_reader :table_id, :title, :account_name, :account_id, :web_property_id
     
     class Property
@@ -44,8 +46,7 @@ module Garb
     def self.all
       url = "https://www.google.com/analytics/feeds/accounts/default"
       response = DataRequest.new(url).send_request      
-      profiles = Entry.parse(response.body).map {|entry| new(entry)}
-      ProfileArray.new(profiles)
+      Entry.parse(response.body).map {|entry| new(entry)}
     end
 
     def self.first(id)

data/lib/garb/profile_reports.rb

@@ -0,0 +1,15 @@
+module Garb
+  module ProfileReports
+    def self.add_report_method(klass)
+      # demodulize leaves potential to redefine
+      # these methods given different namespaces
+      method_name = klass.to_s.demodulize.underscore
+
+      class_eval <<-CODE
+        def #{method_name}(opts = {}, &block)
+          #{klass}.results(self, opts, &block)
+        end
+      CODE
+    end
+  end
+end

data/lib/garb/reports.rb

@@ -0,0 +1,5 @@
+require 'reports/exits'
+require 'reports/visits'
+require 'reports/bounces'
+require 'reports/pageviews'
+require 'reports/unique_pageviews'

data/lib/garb/reports/bounces.rb

@@ -0,0 +1,5 @@
+class Bounces
+  extend Garb::Resource
+
+  metric :bounces
+end

data/lib/garb/reports/exits.rb

@@ -0,0 +1,5 @@
+class Exits
+  extend Garb::Resource
+
+  metric :exits
+end

data/lib/garb/reports/pageviews.rb

@@ -0,0 +1,5 @@
+class Pageviews
+  extend Garb::Resource
+
+  metric :pageviews
+end

data/lib/garb/reports/unique_pageviews.rb

@@ -0,0 +1,5 @@
+class UniquePageviews
+  extend Garb::Resource
+
+  metric :unique_pageviews
+end

data/lib/garb/reports/visits.rb

@@ -0,0 +1,5 @@
+class Visits
+  extend Garb::Resource
+
+  metric :visits
+end

data/lib/garb/resource.rb

@@ -3,6 +3,15 @@ module Garb
     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)

data/lib/garb/session.rb

@@ -2,12 +2,21 @@ module Garb
   module Session
     extend self
 
-    attr_accessor :auth_token, :email
-    
+    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
 end

data/lib/garb/version.rb

@@ -2,8 +2,8 @@ module Garb
   module Version
 
     MAJOR = 0
-    MINOR = 5
-    TINY  = 1
+    MINOR = 6
+    TINY  = 0
 
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/test/unit/garb/account_test.rb

@@ -6,10 +6,14 @@ module Garb
       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(ProfileArray.new([p1,p2,p1,p2]))
-        Account.expects(:new).with([p1,p1]).returns('account1')
-        Account.expects(:new).with([p2,p2]).returns('account2')
+
+        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
 

data/test/unit/garb/data_request_test.rb

@@ -30,23 +30,73 @@ module Garb
         assert_equal expected, DataRequest.new(url).uri
       end
       
-      should "be able to make a request to the GAAPI" do
+      should "be able to send a request for a single user" do
+        Session.stubs(:single_user?).returns(true)
+        response = mock('Net::HTTPOK') do |m|
+          m.expects(:kind_of?).with(Net::HTTPSuccess).returns(true)
+        end
+
+        data_request = DataRequest.new('https://example.com/data', 'key' => 'value')
+        data_request.stubs(:single_user_request).returns(response)
+        data_request.send_request
+
+        assert_received(data_request, :single_user_request)
+      end
+
+      should "be able to send a request for an oauth user" do
+        Session.stubs(:single_user?).returns(false)
+        Session.stubs(:oauth_user?).returns(true)
+        response = mock('Net::HTTPOK') do |m|
+          m.expects(:kind_of?).with(Net::HTTPSuccess).returns(true)
+        end
+
+        data_request = DataRequest.new('https://example.com/data', 'key' => 'value')
+        data_request.stubs(:oauth_user_request).returns(response)
+        data_request.send_request
+
+        assert_received(data_request, :oauth_user_request)
+      end
+
+      should "raise if the request is unauthorized" do
+        Session.stubs(:single_user?).returns(false)
+        Session.stubs(:oauth_user?).returns(true)
+        response = mock('Net::HTTPUnauthorized', :body => 'Error')
+
+        data_request = DataRequest.new('https://example.com/data', 'key' => 'value')
+        data_request.stubs(:oauth_user_request).returns(response)
+
+        assert_raises(Garb::DataRequest::ClientError) do
+          data_request.send_request
+        end
+      end
+
+      should "be able to request via the ouath access token" do
+        access_token = stub(:get => "responseobject")
+        Session.stubs(:access_token).returns(access_token)
+
+        data_request = DataRequest.new('https://example.com/data', 'key' => 'value')
+        assert_equal 'responseobject', data_request.oauth_user_request
+
+        assert_received(Session, :access_token)
+        assert_received(access_token, :get) {|e| e.with('https://example.com/data?key=value')}
+      end
+
+      should "be able to request via http with an auth token" 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
+        assert_equal response, data_request.single_user_request
       end
     end
 
   end
-end
+end

data/test/unit/garb/profile_reports_test.rb

@@ -0,0 +1,29 @@
+require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
+
+module Garb
+
+  Exits = Class.new
+
+  class FakeProfile
+    include ProfileReports
+  end
+
+  class ProfileReportsTest < MiniTest::Unit::TestCase
+    context "The ProfileReports module" do
+      should "define a new method when given a class" do
+        ProfileReports.add_report_method(Exits)
+        assert_equal true, FakeProfile.new.respond_to?(:exits)
+      end
+
+      should "return results from the given class with options" do
+        results = [1,2,3]
+        Exits.stubs(:results).returns(results)
+        ProfileReports.add_report_method(Exits)
+
+        profile = FakeProfile.new
+        assert_equal results, profile.exits(:start => "now")
+        assert_received(Exits, :results) {|e| e.with(profile, :start => "now")}
+      end
+    end
+  end
+end

data/test/unit/garb/session_test.rb

@@ -28,7 +28,16 @@ module Garb
         Session.login('email', 'password')
         assert_equal 'email', Session.email
       end
-      
+
+      should "know if the Session is for a single user" do
+        Session.auth_token = "abcdefg1234567"
+        assert_equal true, Session.single_user?
+      end
+
+      should "know if the Session is for oauth" do
+        Session.access_token = 'some_oauth_access_token'
+        assert_equal true, Session.oauth_user?
+      end
     end
 
   end

metadata

@@ -1,16 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: garb
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors: 
 - Tony Pitale
-- Patrick Reagan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-01-14 00:00:00 -05:00
+date: 2010-02-10 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,12 +47,17 @@ files:
 - lib/garb/authentication_request.rb
 - lib/garb/data_request.rb
 - lib/garb/filter_parameters.rb
-- lib/garb/oauth_session.rb
 - lib/garb/profile.rb
-- lib/garb/profile_array.rb
+- lib/garb/profile_reports.rb
 - lib/garb/report.rb
 - lib/garb/report_parameter.rb
 - lib/garb/report_response.rb
+- lib/garb/reports/bounces.rb
+- lib/garb/reports/exits.rb
+- lib/garb/reports/pageviews.rb
+- lib/garb/reports/unique_pageviews.rb
+- lib/garb/reports/visits.rb
+- lib/garb/reports.rb
 - lib/garb/resource.rb
 - lib/garb/session.rb
 - lib/garb/version.rb
@@ -68,6 +72,7 @@ files:
 - test/unit/garb/data_request_test.rb
 - test/unit/garb/filter_parameters_test.rb
 - test/unit/garb/oauth_session_test.rb
+- test/unit/garb/profile_reports_test.rb
 - test/unit/garb/profile_test.rb
 - test/unit/garb/report_parameter_test.rb
 - test/unit/garb/report_response_test.rb
@@ -114,6 +119,7 @@ test_files:
 - test/unit/garb/data_request_test.rb
 - test/unit/garb/filter_parameters_test.rb
 - test/unit/garb/oauth_session_test.rb
+- test/unit/garb/profile_reports_test.rb
 - test/unit/garb/profile_test.rb
 - test/unit/garb/report_parameter_test.rb
 - test/unit/garb/report_response_test.rb

data/lib/garb/oauth_session.rb

@@ -1,21 +0,0 @@
-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_array.rb

@@ -1,18 +0,0 @@
-module Garb
-  class ProfileArray < Array
-    def group_to_array
-      h = Hash.new
-
-      each do |element|
-        key = yield(element)
-        if h.has_key?(key)
-          h[key] << element
-        else
-          h[key] = [element]
-        end
-      end
-
-      h.map{|k,v| v}
-    end
-  end
-end