garb 0.6.0 → 0.7.0

data/README.md

@@ -193,8 +193,9 @@ SSL
 TODOS
 -----
 
-  * Sessions are currently global, which isn't awesome
   * Read opensearch header in results
+  * Investigate new features from GA to see if they're in the API, implement if so
+  * clarify AND/OR filtering behavior in code and documentation
 
 Requirements
 ------------

data/lib/garb/account.rb

@@ -8,10 +8,10 @@ module Garb
       @profiles = profiles
     end
 
-    def self.all
+    def self.all(session = Session)
       # Profile.all.group_to_array{|p| p.account_id}.map{|profiles| new(profiles)}
 
-      profile_groups = Profile.all.inject({}) do |hash, profile|
+      profile_groups = Profile.all(session).inject({}) do |hash, profile|
         key = profile.account_id
         
         if hash.has_key?(key)

data/lib/garb/data_request.rb

@@ -2,7 +2,8 @@ module Garb
   class DataRequest
     class ClientError < StandardError; end
 
-    def initialize(base_url, parameters={})
+    def initialize(session, base_url, parameters={})
+      @session = session
       @base_url = base_url
       @parameters = parameters
     end
@@ -17,9 +18,9 @@ module Garb
     end
 
     def send_request
-      response = if Session.single_user?
+      response = if @session.single_user?
         single_user_request
-      elsif Session.oauth_user?
+      elsif @session.oauth_user?
         oauth_user_request
       end
 
@@ -31,11 +32,11 @@ module Garb
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
       http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-      http.get("#{uri.path}#{query_string}", 'Authorization' => "GoogleLogin auth=#{Session.auth_token}")
+      http.get("#{uri.path}#{query_string}", 'Authorization' => "GoogleLogin auth=#{@session.auth_token}")
     end
 
     def oauth_user_request
-      Session.access_token.get("#{uri}#{query_string}")
+      @session.access_token.get("#{uri}#{query_string}")
     end
   end
 end

data/lib/garb/profile.rb

@@ -3,7 +3,7 @@ module Garb
 
     include ProfileReports
 
-    attr_reader :table_id, :title, :account_name, :account_id, :web_property_id
+    attr_reader :session, :table_id, :title, :account_name, :account_id, :web_property_id
     
     class Property
       include HappyMapper
@@ -30,7 +30,8 @@ module Garb
       has_many :properties, Property
     end
 
-    def initialize(entry)
+    def initialize(entry, session)
+      @session = session
       @title = entry.title
       @table_id = entry.tableId
 
@@ -43,14 +44,14 @@ module Garb
       Garb.from_google_analytics(@table_id)
     end
 
-    def self.all
+    def self.all(session = Session)
       url = "https://www.google.com/analytics/feeds/accounts/default"
-      response = DataRequest.new(url).send_request      
-      Entry.parse(response.body).map {|entry| new(entry)}
+      response = DataRequest.new(session, url).send_request      
+      Entry.parse(response.body).map {|entry| new(entry, session)}
     end
 
-    def self.first(id)
-      all.detect {|profile| profile.id == id || profile.web_property_id == id }
+    def self.first(id, session = Session)
+      all(session).detect {|profile| profile.id == id || profile.web_property_id == id }
     end
   end
 end

data/lib/garb/resource.rb

@@ -41,16 +41,20 @@ module Garb
     end
 
     def results(profile, opts = {}, &block)
-      @profile = profile.is_a?(Profile) ? profile : Profile.first(profile)
+      @profile = profile.is_a?(Profile) ? profile : Profile.first(profile, opts.fetch(:session, Session))
 
-      @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)
+      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?
+        instance_eval(&block) if block_given?
 
-      ReportResponse.new(send_request_for_body).results
+        ReportResponse.new(send_request_for_body).results
+      else
+        []
+      end
     end
 
     def page_params
@@ -80,7 +84,7 @@ module Garb
     end
 
     def send_request_for_body
-      request = DataRequest.new(URL, params)
+      request = DataRequest.new(@profile.session, URL, params)
       response = request.send_request
       response.body
     end

data/lib/garb/session.rb

@@ -1,22 +1,25 @@
 module Garb
-  module Session
-    extend self
+  class Session
+    module Methods
+      attr_accessor :auth_token, :access_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
 
-    # 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 single_user?
-      auth_token && auth_token.is_a?(String)
+      def oauth_user?
+        !access_token.nil?
+      end
     end
 
-    def oauth_user?
-      !access_token.nil?
-    end
+    include Methods
+    extend Methods
   end
 end

data/lib/garb/version.rb

@@ -2,7 +2,7 @@ module Garb
   module Version
 
     MAJOR = 0
-    MINOR = 6
+    MINOR = 7
     TINY  = 0
 
     def self.to_s # :nodoc:

data/test/unit/garb/account_test.rb

@@ -18,13 +18,24 @@ module Garb
     end
 
     context "An instance of the Account class" do
-      context "when creating a new account from an array of profiles" do
-        setup do
-          profile = stub(:account_id => '1111', :account_name => 'Blog 1')
-          @profiles = [profile,profile]
-          @account = Account.new(@profiles)
+      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

data/test/unit/garb/data_request_test.rb

@@ -4,10 +4,14 @@ module Garb
   class DataRequestTest < MiniTest::Unit::TestCase
     
     context "An instance of the DataRequest class" do
+      setup do
+        @session = Session.new
+        @session.auth_token = 'abcdefg123456'
+      end
 
       should "be able to build the query string from parameters" do
         parameters = {'ids' => '12345', 'metrics' => 'country'}
-        data_request = DataRequest.new("", parameters)
+        data_request = DataRequest.new(@session, "", parameters)
         
         query_string = data_request.query_string
         
@@ -19,7 +23,7 @@ module Garb
       end
       
       should "return an empty query string if parameters are empty" do
-        data_request = DataRequest.new("")
+        data_request = DataRequest.new(@session, "")
         assert_equal "", data_request.query_string
       end
       
@@ -27,16 +31,16 @@ module Garb
         url        = 'http://example.com'
         expected = URI.parse('http://example.com')
         
-        assert_equal expected, DataRequest.new(url).uri
+        assert_equal expected, DataRequest.new(@session, url).uri
       end
       
       should "be able to send a request for a single user" do
-        Session.stubs(:single_user?).returns(true)
+        @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 = DataRequest.new(@session, 'https://example.com/data', 'key' => 'value')
         data_request.stubs(:single_user_request).returns(response)
         data_request.send_request
 
@@ -44,13 +48,13 @@ module Garb
       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)
+        @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 = DataRequest.new(@session, 'https://example.com/data', 'key' => 'value')
         data_request.stubs(:oauth_user_request).returns(response)
         data_request.send_request
 
@@ -58,11 +62,11 @@ module Garb
       end
 
       should "raise if the request is unauthorized" do
-        Session.stubs(:single_user?).returns(false)
-        Session.stubs(:oauth_user?).returns(true)
+        @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 = DataRequest.new(@session, 'https://example.com/data', 'key' => 'value')
         data_request.stubs(:oauth_user_request).returns(response)
 
         assert_raises(Garb::DataRequest::ClientError) do
@@ -72,17 +76,17 @@ module Garb
 
       should "be able to request via the ouath access token" do
         access_token = stub(:get => "responseobject")
-        Session.stubs(:access_token).returns(access_token)
+        @session.stubs(:access_token).returns(access_token)
 
-        data_request = DataRequest.new('https://example.com/data', 'key' => 'value')
+        data_request = DataRequest.new(@session, 'https://example.com/data', 'key' => 'value')
         assert_equal 'responseobject', data_request.oauth_user_request
 
-        assert_received(Session, :access_token)
+        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')
+        @session.expects(:auth_token).with().returns('toke')
         response = mock
 
         http = mock do |m|
@@ -93,7 +97,7 @@ module Garb
 
         Net::HTTP.expects(:new).with('example.com', 443).returns(http)
 
-        data_request = DataRequest.new('https://example.com/data', 'key' => 'value')
+        data_request = DataRequest.new(@session, 'https://example.com/data', 'key' => 'value')
         assert_equal response, data_request.single_user_request
       end
     end

data/test/unit/garb/profile_test.rb

@@ -4,6 +4,7 @@ module Garb
   class ProfileTest < MiniTest::Unit::TestCase
     
     context "The Profile class" do
+      setup {@session = Session.new}
       
       should "be able to return a list of all profiles" do
         url = 'https://www.google.com/analytics/feeds/accounts/default'
@@ -13,7 +14,7 @@ module Garb
         data_request = mock
         data_request.expects(:send_request).with().returns(stub(:body => xml))
         
-        DataRequest.expects(:new).with(url).returns(data_request)
+        DataRequest.expects(:new).with(@session, url).returns(data_request)
         
         entries = [stub]
         
@@ -23,10 +24,10 @@ module Garb
         entries.each do |entry|
           profile = stub
           profiles << profile
-          Garb::Profile.expects(:new).with(entry).returns(profile)
+          Garb::Profile.expects(:new).with(entry, @session).returns(profile)
         end
         
-        assert_equal profiles, Profile.all
+        assert_equal profiles, Profile.all(@session)
       end
 
       should "return the first profile for a given web property id" do
@@ -36,7 +37,9 @@ module Garb
 
         Garb::Profile.stubs(:all).returns(entries)
 
-        assert_equal profile1, Garb::Profile.first('12345')
+        assert_equal profile1, Garb::Profile.first('12345', @session)
+
+        assert_received(Garb::Profile, :all) {|e| e.with(@session)}
       end
 
       should "return the first profile for a given table id" do
@@ -46,25 +49,27 @@ module Garb
 
         Garb::Profile.stubs(:all).returns(entries)
 
-        assert_equal profile2, Garb::Profile.first('67890')
+        assert_equal profile2, Garb::Profile.first('67890', @session)
+
+        assert_received(Garb::Profile, :all) {|e| e.with(@session)}
       end
     end
-    
+
     context "An instance of the Profile class" do
-      
+
       setup do
         @entry = (Profile::Entry.parse(read_fixture('profile_feed.xml'))).first
-        @profile = Profile.new(@entry)
+        @profile = Profile.new(@entry, Session)
       end
-      
+
       should "have a value for :title" do
         assert_equal "Historical", @profile.title
       end
-      
+
       should "have a value for :table_id" do
         assert_equal 'ga:12345', @profile.table_id
       end
-      
+
       should "have a value for :id" do
         assert_equal '12345', @profile.id
       end
@@ -76,7 +81,6 @@ module Garb
       should "have a value for :account_name" do
         assert_equal 'Blog Beta', @profile.account_name
       end
-      
     end
 
   end

data/test/unit/garb/report_test.rb

@@ -7,7 +7,7 @@ module Garb
       setup do
         @now = Time.now
         Time.stubs(:now).returns(@now)
-        @profile = stub(:table_id => 'ga:1234')
+        @profile = stub(:table_id => 'ga:1234', :session => Session)
         @report = Report.new(@profile)
       end
 
@@ -64,7 +64,7 @@ module Garb
         request = mock {|m| m.expects(:send_request).returns(response) }
         @report.expects(:params).returns('params')
 
-        DataRequest.expects(:new).with(Garb::Report::URL, 'params').returns(request)
+        DataRequest.expects(:new).with(Session, Garb::Report::URL, 'params').returns(request)
         assert_equal 'response body', @report.send_request_for_body
       end
 

data/test/unit/garb/resource_test.rb

@@ -15,5 +15,24 @@ class ResourceTest < MiniTest::Unit::TestCase
 
       assert_equal 'analytics', TestReport.results(profile)
     end
+
+    should "get results from GA using a specific user session" do
+      profile = '123'
+      session = Garb::Session.new
+      TestReport.expects(:send_request_for_body).returns('xml')
+      Garb::ReportResponse.expects(:new).with('xml').returns(mock(:results => 'analytics'))
+      Garb::Profile.expects(:first).with(profile, session).returns(mock('Garb::Profile'))
+
+      assert_equal 'analytics', TestReport.results(profile, :session => session)
+    end
+
+    should "return an empty result set if profile is invalid" do
+      profile = '123'
+      TestReport.expects(:send_request_for_body).never
+      Garb::ReportResponse.expects(:new).never
+
+      Garb::Profile.expects(:first).returns(nil)
+      assert_equal [], TestReport.results(profile)
+    end
   end
 end

data/test/unit/garb/session_test.rb

@@ -40,5 +40,45 @@ module Garb
       end
     end
 
+    context "A Session" do
+      setup do
+        @session = Session.new
+      end
+      
+      should "be able retrieve an auth_token for a user" do
+        auth_request = mock {|m| m.expects(:auth_token).with({}).returns('toke') }
+        AuthenticationRequest.expects(:new).with('email', 'password', {}).returns(auth_request)
+
+        @session.login('email', 'password')
+        assert_equal 'toke', @session.auth_token
+      end
+
+      should "be able retrieve an auth_token for a user with secure ssl" do
+        opts = {:secure => true, :account_type => 'GOOGLE'}
+        auth_request = mock {|m| m.expects(:auth_token).with(opts).returns('toke') }
+        AuthenticationRequest.expects(:new).with('email', 'password', opts).returns(auth_request)
+
+        @session.login('email', 'password', opts)
+        assert_equal 'toke', @session.auth_token
+      end
+      
+      should "retain the email address for this session" do
+        AuthenticationRequest.stubs(:new).returns(stub(:auth_token => 'toke'))
+        
+        @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
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: garb
 version: !ruby/object:Gem::Version 
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Tony Pitale
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-10 00:00:00 -05:00
+date: 2010-02-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency