readmedia-garb 0.9.1.1

data/test/unit/garb/report_parameter_test.rb

@@ -0,0 +1,43 @@
+require 'test_helper'
+
+module Garb
+  class ReportParameterTest < MiniTest::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 << :page_path)
+        assert_equal [:page_path], @metrics.elements
+      end
+      
+      should "merge an array of elements" do
+        assert_equal(@metrics, @metrics << [:page_path])
+        assert_equal [:page_path], @metrics.elements
+      end
+
+      context "converting to params" do
+        should "be able to format the parameters into strings" do
+          @metrics << :page_path
+          assert_equal({'metrics' => 'ga:pagePath'}, @metrics.to_params)
+        end
+
+        should "join multiple symbol elements" do
+          @metrics << :page_path << :city
+          assert_equal({'metrics' => 'ga:pagePath,ga:city'}, @metrics.to_params)
+        end
+      end
+    end
+    
+  end
+end

data/test/unit/garb/report_response_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+module Garb
+  SpecialKlass = Class.new(OpenStruct)
+
+  class ReportResponseTest < MiniTest::Unit::TestCase
+    context "A ReportResponse" do
+      context "with a report feed" do
+        setup do
+          @xml = File.read(File.join(File.dirname(__FILE__), '..', '..', "/fixtures/report_feed.xml"))
+        end
+
+        should "parse results from atom xml" do
+          response = ReportResponse.new(@xml)
+          assert_equal ['33', '2', '1'], response.results.map(&:pageviews)
+        end
+
+        should "default to returning an array of OpenStruct objects" do
+          response = ReportResponse.new(@xml)
+          assert_equal [OpenStruct, OpenStruct, OpenStruct], response.results.map(&:class)
+        end
+
+        should "return an array of instances of a specified class" do
+          response = ReportResponse.new(@xml, SpecialKlass)
+          assert_equal [SpecialKlass, SpecialKlass, SpecialKlass], response.results.map(&:class)
+        end
+
+        should "know the total number of results" do
+          response = ReportResponse.new(@xml)
+          assert_equal 18, response.results.total_results
+        end
+
+        should "know if the data has been sampled" do
+          response = ReportResponse.new(@xml)
+          assert_equal true, response.results.sampled?
+        end
+      end
+
+      should "return an empty array if there are no results" do
+        response = ReportResponse.new("result xml")
+        Crack::XML.stubs(:parse).with("result xml").returns({'feed' => {'entry' => nil}})
+
+        assert_equal [], response.results.to_a
+      end
+    end
+  end
+end

data/test/unit/garb/report_test.rb

@@ -0,0 +1,99 @@
+require 'test_helper'
+
+module Garb
+  # Also tests Garb::Resource, which is the basis for Garb::Report
+  class ReportTest < MiniTest::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', :session => Session)
+        @report = Report.new(@profile)
+      end
+
+      %w(metrics dimensions sort).each do |param|
+        should "have parameters for #{param}" do
+          assert @report.send(:"#{param}").is_a?(ReportParameter)
+        end
+
+        should "clear parameters for #{param}" do
+          assert_equal({}, @report.send(:"clear_#{param}").to_params)
+        end
+      end
+
+      should "have filter parameters for filters" do
+        assert @report.filters.is_a?(FilterParameters)
+      end
+
+      should "add new filters to filter parameters" do
+        @report.clear_filters
+        hash = {:thing.gt => 'val'}
+        @report.filters hash
+
+        assert_equal hash, @report.filters.parameters.first
+      end
+
+      should "clear filter parameters for filters" do
+        assert_equal({}, @report.clear_filters.to_params)
+      end
+
+      should "have default parameters" do
+        @report.stubs(:format_time).returns('2009-08-01')
+        params = {'ids' => 'ga:1234', 'start-date' => '2009-08-01', 'end-date' => '2009-08-01'}
+        assert_equal params, @report.default_params
+      end
+
+      should "allow setting a segment id to the segment params" do
+        @report.set_segment_id 121
+        assert_equal({'segment' => 'gaid::121'}, @report.segment_params)
+      end
+
+      should "collect params from metrics, dimensions, filters, sort, and defaults" do
+        @report.stubs(:metrics).returns(stub(:to_params => {'metrics' => 6}))
+        @report.stubs(:dimensions).returns(stub(:to_params => {'dimensions' => 5}))
+        @report.stubs(:filters).returns(stub(:to_params => {'filters' => 4}))
+        @report.stubs(:sort).returns(stub(:to_params => {'sort' => 3}))
+        @report.stubs(:page_params).returns({'page_params' => 2})
+        @report.stubs(:default_params).returns({'default_params' => 1})
+        @report.stubs(:segment_params).returns({'segment' => 'gaid::10'})
+        
+        expected_params = {'metrics' => 6,'dimensions' => 5, 'filters' => 4, 'sort' => 3,
+                            'page_params' => 2, 'default_params' => 1, 'segment' => 'gaid::10'}
+
+        assert_equal expected_params, @report.params
+      end
+
+      should "format time" do
+        assert_equal @now.strftime('%Y-%m-%d'), @report.format_time(@now)
+      end
+
+      should "send a data request to GA" do
+        response = mock {|m| m.expects(:body).returns('response body') }
+        request = mock {|m| m.expects(:send_request).returns(response) }
+        @report.expects(:params).returns('params')
+
+        DataRequest.expects(:new).with(Session, Garb::Report::URL, 'params').returns(request)
+        assert_equal 'response body', @report.send_request_for_body
+      end
+
+      should "fetch and parse results from GA" do
+        @report.expects(:send_request_for_body).with().returns('xml')
+        ReportResponse.expects(:new).with('xml').returns(mock(:results => ['entry']))
+        assert_equal ['entry'], @report.results
+      end
+    end
+    
+    context "An instance of the Report class with initial options" do
+      setup do
+        @profile = stub(:table_id => 'ga:1234')
+        @report = Report.new(@profile, :limit => 10, :offset => 20)
+      end
+
+      should "have page paramaters" do
+        params = {'max-results' => 10, 'start-index' => 20}
+        assert_equal params, @report.page_params
+      end
+    end
+
+  end
+end

data/test/unit/garb/resource_test.rb

@@ -0,0 +1,50 @@
+require 'test_helper'
+
+# Most of the resource testing is done as a part of ReportTest
+class ResourceTest < MiniTest::Unit::TestCase
+
+  context "A class with Garb::Resource mixed in" do
+    setup do
+      @test_report = Class.new
+      @test_report.extend(Garb::Resource)
+    end
+
+    should "get results from GA" do
+      profile = stub(:is_a? => true)
+      @test_report.expects(:send_request_for_body).returns('xml')
+      Garb::ReportResponse.expects(:new).with('xml', OpenStruct).returns(mock(:results => 'analytics'))
+
+      assert_equal 'analytics', @test_report.results(profile)
+    end
+
+    should "get results from GA using a specific user session" do
+      profile = '123'
+      session = Garb::Session.new
+      @test_report.expects(:send_request_for_body).returns('xml')
+      Garb::ReportResponse.expects(:new).with('xml', OpenStruct).returns(mock(:results => 'analytics'))
+      Garb::Profile.expects(:first).with(profile, session).returns(mock('Garb::Profile'))
+
+      assert_equal 'analytics', @test_report.results(profile, :session => session)
+    end
+
+    should "permit setting a segment id" do
+      @test_report.set_segment_id 1
+      assert_equal "gaid::1", @test_report.segment
+    end
+
+    should "permit setting a klass used for instantiation of results" do
+      TestKlass = Class.new(OpenStruct)
+      @test_report.set_instance_klass TestKlass
+      assert_equal TestKlass, @test_report.instance_klass
+    end
+
+    should "return an empty result set if profile is invalid" do
+      profile = '123'
+      @test_report.expects(:send_request_for_body).never
+      Garb::ReportResponse.expects(:new).never
+
+      Garb::Profile.expects(:first).returns(nil)
+      assert_equal [], @test_report.results(profile)
+    end
+  end
+end

data/test/unit/garb/session_test.rb

@@ -0,0 +1,84 @@
+require 'test_helper'
+
+module Garb
+  class SessionTest < MiniTest::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 "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
+
+    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

data/test/unit/garb/step_test.rb

@@ -0,0 +1,15 @@
+require 'test_helper'
+
+module Garb
+  class StepTest < MiniTest::Unit::TestCase
+    context "A Step" do
+      should "have a name, number, and path" do
+        step = Step.new({'name' => 'Contact Form Page', 'number' => '1', 'path' => '/contact.html'})
+
+        assert_equal 'Contact Form Page', step.name
+        assert_equal 1, step.number
+        assert_equal '/contact.html', step.path
+      end
+    end
+  end
+end

data/test/unit/garb_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+class GarbTest < MiniTest::Unit::TestCase
+  context "The Garb module" do
+    should 'prefix a string with ga: for GA' do
+      assert_equal '-ga:bob', Garb.to_google_analytics(stub(:to_google_analytics => '-ga:bob'))
+      assert_equal 'ga:bob', Garb.to_google_analytics('bob')
+    end
+
+    should 'remove ga: prefix' do
+      assert_equal 'bob', Garb.from_google_analytics('ga:bob')
+    end
+
+    should "have a helper to parse properties out of entries" do
+      entry = {"dxp:property"=>[{"name"=>"ga:accountId", "value"=>"1189765"}, {"name"=>"ga:webPropertyId", "value"=>"UA-1189765-1"}]}
+
+      assert_equal({"account_id" => '1189765', "web_property_id" => "UA-1189765-1"}, Garb.parse_properties(entry))
+    end
+
+    should "parse out the self link" do
+      entry = {"link" => [{"rel" => "self", "href" => "http://google.com/accounts/12345"}]}
+
+      assert_equal "http://google.com/accounts/12345", Garb.parse_link(entry, "self")
+    end
+  end
+end

data/test/unit/symbol_operator_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+class SymbolOperatorTest < MiniTest::Unit::TestCase
+  context "An instance of a SymbolOperator" do
+    should "lower camelize the target" do
+      assert_equal "ga:uniqueVisits==", SymbolOperator.new(:unique_visits, :eql).to_google_analytics
+    end
+
+    should "return target and operator together" do
+      assert_equal "ga:metric==", SymbolOperator.new(:metric, :eql).to_google_analytics
+    end
+
+    should "prefix the operator to the target" do
+      assert_equal "-ga:metric", SymbolOperator.new(:metric, :desc).to_google_analytics
+    end
+
+    # should "know if it is equal to another operator" do
+    #   op1 = SymbolOperator.new(:hello, "==")
+    #   op2 = SymbolOperator.new(:hello, "==")
+    #   assert_equal op1, op2
+    # end
+    # 
+    # should "not be equal to another operator if target, operator, or prefix is different" do
+    #   op1 = SymbolOperator.new(:hello, "==")
+    #   op2 = SymbolOperator.new(:hello, "==", true)
+    #   refute_equal op1, op2
+    # 
+    #   op1 = SymbolOperator.new(:hello1, "==")
+    #   op2 = SymbolOperator.new(:hello2, "==")
+    #   refute_equal op1, op2
+    # 
+    #   op1 = SymbolOperator.new(:hello, "!=")
+    #   op2 = SymbolOperator.new(:hello, "==")
+    #   refute_equal op1, op2
+    # end
+  end
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification 
+name: readmedia-garb
+version: !ruby/object:Gem::Version 
+  hash: 1
+  prerelease: 
+  segments: 
+  - 0
+  - 9
+  - 1
+  - 1
+  version: 0.9.1.1
+platform: ruby
+authors: 
+- Tony Pitale, Philip Brocoum (readMedia)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-08-28 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 0
+        - 1
+        - 6
+        version: 0.1.6
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
+        - 2
+        - 0
+        version: 2.2.0
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: Developer@readMedia.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- lib/garb.rb
+- lib/garb/report_response.rb
+- lib/garb/data_request.rb
+- lib/garb/report_parameter.rb
+- lib/garb/management/feed.rb
+- lib/garb/management/segment.rb
+- lib/garb/management/web_property.rb
+- lib/garb/management/goal.rb
+- lib/garb/management/account.rb
+- lib/garb/management/profile.rb
+- lib/garb/goal.rb
+- lib/garb/authentication_request.rb
+- lib/garb/session.rb
+- lib/garb/report.rb
+- lib/garb/profile_reports.rb
+- lib/garb/version.rb
+- lib/garb/result_set.rb
+- lib/garb/account.rb
+- lib/garb/resource.rb
+- lib/garb/reports.rb
+- lib/garb/account_feed_request.rb
+- lib/garb/destination.rb
+- lib/garb/model.rb
+- lib/garb/reports/bounces.rb
+- lib/garb/reports/visits.rb
+- lib/garb/reports/pageviews.rb
+- lib/garb/reports/exits.rb
+- lib/garb/reports/unique_pageviews.rb
+- lib/garb/step.rb
+- lib/garb/filter_parameters.rb
+- lib/garb/profile.rb
+- lib/support.rb
+- test/fixtures/cacert.pem
+- test/fixtures/report_feed.xml
+- test/fixtures/profile_feed.xml
+- test/test_helper.rb
+- test/unit/symbol_operator_test.rb
+- test/unit/garb/oauth_session_test.rb
+- test/unit/garb/session_test.rb
+- test/unit/garb/resource_test.rb
+- test/unit/garb/report_parameter_test.rb
+- test/unit/garb/model_test.rb
+- test/unit/garb/management/feed_test.rb
+- test/unit/garb/management/account_test.rb
+- test/unit/garb/management/web_property_test.rb
+- test/unit/garb/management/profile_test.rb
+- test/unit/garb/management/goal_test.rb
+- test/unit/garb/management/segment_test.rb
+- test/unit/garb/report_response_test.rb
+- test/unit/garb/destination_test.rb
+- test/unit/garb/profile_reports_test.rb
+- test/unit/garb/step_test.rb
+- test/unit/garb/account_test.rb
+- test/unit/garb/profile_test.rb
+- test/unit/garb/report_test.rb
+- test/unit/garb/account_feed_request_test.rb
+- test/unit/garb/goal_test.rb
+- test/unit/garb/filter_parameters_test.rb
+- test/unit/garb/data_request_test.rb
+- test/unit/garb/authentication_request_test.rb
+- test/unit/garb_test.rb
+has_rdoc: false
+homepage: http://github.com/readmedia/garb
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: readmedia
+rubygems_version: 1.3.9.4
+signing_key: 
+specification_version: 3
+summary: Google Analytics API (v2.4) Ruby Wrapper
+test_files: 
+- test/fixtures/cacert.pem
+- test/fixtures/report_feed.xml
+- test/fixtures/profile_feed.xml
+- test/test_helper.rb
+- test/unit/symbol_operator_test.rb
+- test/unit/garb/oauth_session_test.rb
+- test/unit/garb/session_test.rb
+- test/unit/garb/resource_test.rb
+- test/unit/garb/report_parameter_test.rb
+- test/unit/garb/model_test.rb
+- test/unit/garb/management/feed_test.rb
+- test/unit/garb/management/account_test.rb
+- test/unit/garb/management/web_property_test.rb
+- test/unit/garb/management/profile_test.rb
+- test/unit/garb/management/goal_test.rb
+- test/unit/garb/management/segment_test.rb
+- test/unit/garb/report_response_test.rb
+- test/unit/garb/destination_test.rb
+- test/unit/garb/profile_reports_test.rb
+- test/unit/garb/step_test.rb
+- test/unit/garb/account_test.rb
+- test/unit/garb/profile_test.rb
+- test/unit/garb/report_test.rb
+- test/unit/garb/account_feed_request_test.rb
+- test/unit/garb/goal_test.rb
+- test/unit/garb/filter_parameters_test.rb
+- test/unit/garb/data_request_test.rb
+- test/unit/garb/authentication_request_test.rb
+- test/unit/garb_test.rb