vigetlabs-garb 0.1.2

data/test/profile_test.rb

@@ -0,0 +1,58 @@
+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().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().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).returns(profile)
+        end
+        
+        assert_equal profiles, Profile.all
+      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)
+      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/report_parameter_test.rb

@@ -0,0 +1,55 @@
+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
+      end
+    end
+    
+  end
+end

data/test/report_response_test.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+module Garb
+  class ReportResponseTest < Test::Unit::TestCase
+    context "An instance of the ReportResponse class" do
+      setup do
+        @xml = File.read(File.dirname(__FILE__) + "/fixtures/report_feed.xml")
+        @response = ReportResponse.new(@xml)
+      end
+      
+      should "parse xml response with happymapper" do
+        h1 = {"city"=>"(not set)", "pageviews"=>"33", "country"=>"(not set)"}
+        h2 = {"city"=>"Kabul", "pageviews"=>"2", "country"=>"Afghanistan"}
+        h3 = {"city"=>"Tirana", "pageviews"=>"1", "country"=>"Albania"}
+        
+        OpenStruct.expects(:new).with(h1).returns('entry1')
+        OpenStruct.expects(:new).with(h2).returns('entry2')
+        OpenStruct.expects(:new).with(h3).returns('entry3')
+        
+        assert_equal(['entry1', 'entry2', 'entry3'], @response.parse)
+      end
+    end
+  end
+end

data/test/report_test.rb

@@ -0,0 +1,124 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+module Garb
+  class ReportTest < Test::Unit::TestCase
+    
+    context "An instance of the Report class" do
+      setup do
+        @now = Time.now
+        Time.stubs(:now).returns(@now)
+        @profile = stub(:table_id => 'ga:1234')
+        @report = Report.new(@profile)
+      end
+      
+      %w(metrics dimensions sort filters).each do |param|
+        should "have parameters for #{param}" do
+          assert @report.send(:"#{param}").is_a?(ReportParameter)
+        end
+      end
+
+      should "have a start_date" do
+        report = Report.new(@profile, :start_date => @now)
+        assert_equal @now, report.start_date
+      end
+    
+      should "have a default start_date of one month ago" do
+        month_ago = @now - Report::MONTH
+        assert_equal month_ago, @report.start_date
+      end
+    
+      should "have an end_date" do
+        report = Report.new(@profile, :end_date => @now)
+        assert_equal @now, report.end_date
+      end
+    
+      should "have a default end_date of now" do
+        assert_equal @now, @report.end_date
+      end
+      
+      should "have max results if set" do
+        @report.max_results = 5
+        assert_equal({'max-results' => 5}, @report.page_params)
+      end
+      
+      should "have an empty hash if max results not set" do
+        assert_equal({}, @report.page_params)
+      end
+      
+      should "have a profile" do
+        assert_equal @profile, @report.profile
+      end
+            
+      should "return default params with no options" do
+        Report.expects(:format_time).with(@report.start_date).returns('start')
+        Report.expects(:format_time).with(@report.end_date).returns('end')
+        
+        params = {'ids' => 'ga:1234', 'start-date' => 'start', 'end-date' => 'end'}
+        assert_equal params, @report.default_params
+      end
+      
+      should "combine parameters for request" do
+        @report.sort.expects(:to_params).returns({'sort' => 'value'})
+        @report.filters.expects(:to_params).returns({'filters' => 'value'})
+        @report.metrics.expects(:to_params).returns({'metrics' => 'value'})
+        @report.dimensions.expects(:to_params).returns({'dimensions' => 'value'})
+        
+        @report.expects(:page_params).returns({})
+        @report.expects(:default_params).returns({'ids' => 'ga:1234'})
+        
+        params = {'ids' => 'ga:1234', 'metrics' => 'value', 'dimensions' => 'value', 'sort' => 'value', 'filters' => 'value'}
+        
+        assert_equal params, @report.params
+      end
+
+      should "send a request and get the response body" do
+        response = stub(:body => 'feed')
+        data_request = mock
+        data_request.expects(:send_request).with().returns(response)
+        
+        @report.stubs(:params).returns({'key' => 'value'})
+        DataRequest.expects(:new).with(Report::URL, {'key' => 'value'}).returns(data_request)
+        
+        assert_equal 'feed', @report.send_request_for_body
+      end
+      
+      should "fetch and parse all entries" do
+        @report.expects(:send_request_for_body).with().returns('xml')
+        ReportResponse.expects(:new).with('xml').returns(mock(:parse => ['entry']))
+        assert_equal ['entry'], @report.all
+      end
+    end
+    
+    context "The Report class" do
+
+    #   should "get the value for a given entry and property" do
+    #     # entry = mock do |m|
+    #     #   m.expects(:/).with().returns(['balding'])
+    #     # end
+    #     # assert_equal 'balding', Report.property_value(entry, Report.element_id(:balding))
+    #   end
+    # 
+    #   should "get the values for a given entry and array of properties" do
+    #     entry = stub
+    #     Report.stubs(:property_value).with(entry, "balding").returns('balding')
+    #     Report.stubs(:property_value).with(entry, "spaulding").returns('spaulding')
+    #     
+    #     data = Report.property_values(entry, [:balding, :spaulding])
+    #     assert_equal 'balding', data.balding
+    #     assert_equal 'spaulding', data.spaulding
+    #   end
+    #   
+    #   should "return an ostruct for an entry" do
+    #     entry = stub
+    #     Report.stubs(:property_value).with(entry, "balding").returns('balding')
+    #     assert_equal true, Report.property_values(entry, [:balding]).is_a?(OpenStruct)
+    #   end
+
+      should "format time" do
+        t = Time.now
+        assert_equal t.strftime('%Y-%m-%d'), Report.format_time(t)
+      end
+    end
+
+  end
+end

data/test/session_test.rb

@@ -0,0 +1,26 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+module Garb
+  class SessionTest < Test::Unit::TestCase
+    
+    context "The Session class" do
+      
+      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 "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
+      
+    end
+
+  end
+end

data/test/symbol_test.rb

@@ -0,0 +1,44 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class SymbolTest < Test::Unit::TestCase
+  
+  context "An instance of the Symbol class" do
+    
+    should "properly format itself for ga" do
+      assert_equal "ga:requestUri", :request_uri.to_ga
+    end
+    
+    should "define a :desc operator" do
+      operator = stub()
+      symbol = :foo
+      
+      Operator.expects(:new).with(:foo, '-', true).returns(operator)
+      assert_equal operator, :foo.desc
+    end
+
+    def self.should_define_operator(operators)
+      operators.each do |method, operator|
+        should "define an :#{method} operator" do
+          new_operator = stub()
+          symbol = :foo
+
+          Operator.expects(:new).with(:foo, operator).returns(new_operator)
+          assert_equal new_operator, :foo.send(method)
+        end
+      end
+    end
+
+    should_define_operator  :eql => '==',
+                            :not_eql => '!=',
+                            :gt => '>',
+                            :gte => '>=',
+                            :lt => '<',
+                            :lte => '<=',
+                            :matches => '==',
+                            :does_not_match => '!=',
+                            :contains => '=~',
+                            :does_not_contain => '!~',
+                            :substring => '=@',
+                            :not_substring => '!@'
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,13 @@
+require 'test/unit'
+require 'rubygems'
+require 'mocha'
+require 'shoulda'
+require 'garb'
+
+class Test::Unit::TestCase
+  
+  def read_fixture(filename)
+    File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
+  end
+  
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification 
+name: vigetlabs-garb
+version: !ruby/object:Gem::Version 
+  version: 0.1.2
+platform: ruby
+authors: 
+- Tony Pitale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-22 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jnunemaker-happymapper
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: libxml-ruby
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.8
+    version: 
+description: A ruby gem to aid in the use of the Google Analytics API
+email: tony.pitale@viget.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- History.txt
+- README.md
+- Rakefile
+- garb.gemspec
+- lib/garb.rb
+- lib/garb/authentication_request.rb
+- lib/garb/data_request.rb
+- lib/garb/profile.rb
+- lib/garb/report.rb
+- lib/garb/report_parameter.rb
+- lib/garb/report_response.rb
+- lib/garb/session.rb
+- lib/extensions/symbol.rb
+- lib/extensions/string.rb
+- lib/extensions/operator.rb
+- lib/extensions/happymapper.rb
+has_rdoc: false
+homepage: http://github.com/vigetlabs/garb
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Google Analytics API Ruby Wrapper
+test_files: 
+- test/authentication_request_test.rb
+- test/data_request_test.rb
+- test/garb_test.rb
+- test/operator_test.rb
+- test/profile_test.rb
+- test/report_parameter_test.rb
+- test/report_response_test.rb
+- test/report_test.rb
+- test/session_test.rb
+- test/symbol_test.rb
+- test/test_helper.rb
+- test/fixtures/profile_feed.xml
+- test/fixtures/report_feed.xml