jonuts-garb 0.2.3

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

data/test/unit/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 < Test::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_raise(Garb::AuthenticationRequest::AuthError) do
+          @request.send_request(OpenSSL::SSL::VERIFY_NONE)
+        end
+      end
+      
+    end
+    
+    
+    
+  end
+end

data/test/unit/data_request_test.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+module Garb
+  class DataRequestTest < Test::Unit::TestCase
+    
+    context "An instance of the DataRequest class" do
+
+      should "be able to build the query string from parameters" do
+        parameters = {'ids' => '12345', 'metrics' => 'country'}
+        data_request = DataRequest.new("", parameters)
+        
+        query_string = data_request.query_string
+        
+        assert_match(/^\?/, query_string)
+        
+        query_string.sub!(/^\?/, '')
+        
+        assert_equal ["ids=12345", "metrics=country"], query_string.split('&').sort
+      end
+      
+      should "return an empty query string if parameters are empty" do
+        data_request = DataRequest.new("")
+        assert_equal "", data_request.query_string
+      end
+      
+      should "be able to build a uri" do
+        url        = 'http://example.com'
+        expected = URI.parse('http://example.com')
+        
+        assert_equal expected, DataRequest.new(url).uri
+      end
+      
+      should "be able to make a request to the GAAPI" do
+        Session.expects(:auth_token).with(nil).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
+      end
+    end
+
+  end
+end

data/test/unit/garb_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+class GarbTest < Test::Unit::TestCase
+  context "A green egg" do
+    should "be served with ham" do
+      assert true
+    end
+  end  
+end

data/test/unit/oauth_session_test.rb

@@ -0,0 +1,11 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+module Garb
+  class OAuthSessionTest < Test::Unit::TestCase
+    context "An instance of OAuthSession" do
+      should "have tests" do
+        assert true
+      end
+    end
+  end
+end

data/test/unit/operator_test.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+class OperatorTest < Test::Unit::TestCase
+  context "An instance of an Operator" do
+    should "lower camelize the target" do
+      assert_equal "ga:uniqueVisits=", Operator.new(:unique_visits, "=").to_ga
+    end
+    
+    should "return target and operator together" do
+      assert_equal "ga:metric=", Operator.new(:metric, "=").to_ga
+    end
+    
+    should "prefix the operator to the target" do
+      assert_equal "-ga:metric", Operator.new(:metric, "-", true).to_ga
+    end
+    
+    should "know if it is equal to another operator" do
+      op1 = Operator.new(:hello, "==")
+      op2 = Operator.new(:hello, "==")
+      assert_equal op1, op2
+    end
+    
+    should "not be equal to another operator if target, operator, or prefix is different" do
+      op1 = Operator.new(:hello, "==")
+      op2 = Operator.new(:hello, "==", true)
+      assert_not_equal op1, op2
+      
+      op1 = Operator.new(:hello1, "==")
+      op2 = Operator.new(:hello2, "==")
+      assert_not_equal op1, op2
+      
+      op1 = Operator.new(:hello, "!=")
+      op2 = Operator.new(:hello, "==")
+      assert_not_equal op1, op2
+    end
+  end
+end

data/test/unit/profile_test.rb

@@ -0,0 +1,59 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+module Garb
+  class ProfileTest < Test::Unit::TestCase
+    
+    context "The Profile class" do
+      
+      should "be able to return a list of all profiles" do
+        Session.stubs(:email).with(nil).returns('user@host.com')
+        
+        url = 'https://www.google.com/analytics/feeds/accounts/user@host.com'
+        
+        xml = read_fixture('profile_feed.xml')
+        
+        data_request = mock
+        data_request.expects(:send_request).with('user@host.com').returns(stub(:body => xml))
+        
+        DataRequest.expects(:new).with(url).returns(data_request)
+        
+        entries = [stub]
+        
+        Profile::Entry.expects(:parse).with(xml).returns(entries)
+                
+        profiles = []
+        entries.each do |entry|
+          profile = stub
+          profiles << profile
+          Garb::Profile.expects(:new).with(entry,'user@host.com').returns(profile)
+        end
+        
+        assert_equal profiles, Profile.all
+      end
+      
+    end
+    
+    context "An instance of the Profile class" do
+      
+      setup do
+        Session.stubs(:email).with(nil).returns('user@host.com')
+        @entry = (Profile::Entry.parse(read_fixture('profile_feed.xml'))).first
+        @profile = Profile.new(@entry)
+      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
+      
+    end
+
+  end
+end

data/test/unit/report_parameter_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+module Garb
+  class ReportParameterTest < Test::Unit::TestCase
+    
+    context "An instance of the ReportParameter class" do
+      setup do
+        @metrics = ReportParameter.new(:metrics)
+      end
+      
+      should "have a name" do
+        assert_equal "metrics", @metrics.name
+      end
+      
+      should "have a list of elements" do
+        assert_equal [], @metrics.elements
+      end
+      
+      should "be able to add new elements" do
+        assert_equal(@metrics, @metrics << :request_uri)
+        assert_equal [:request_uri], @metrics.elements
+      end
+      
+      should "merge an array of elements" do
+        assert_equal(@metrics, @metrics << [:request_uri])
+        assert_equal [:request_uri], @metrics.elements
+      end
+
+      context "converting to params" do
+        should "be able to format the parameters into strings" do
+          @metrics << :request_uri
+          assert_equal({'metrics' => 'ga:requestUri'}, @metrics.to_params)
+        end
+
+        should "join multiple symbol elements" do
+          @metrics << :request_uri << :city
+          assert_equal({'metrics' => 'ga:requestUri,ga:city'}, @metrics.to_params)
+        end
+        
+        should "join operator elements" do
+          @metrics << :city.desc
+          assert_equal({'metrics' => '-ga:city'}, @metrics.to_params)
+        end
+        
+        should "parameterize hash operators and join elements" do
+          @metrics << {:city.eql => 'New York'}
+          params = {'metrics' => 'ga:city%3D%3DNew+York'}
+
+          assert_equal params, @metrics.to_params
+        end
+
+        should "properly encode operators" do
+          @metrics << {:request_uri.contains => 'New York'}
+          params = {'metrics' => 'ga:requestUri%3D~New+York'}
+
+          assert_equal params, @metrics.to_params
+        end
+      end
+    end
+    
+  end
+end