vigetlabs-garb 0.1.2 → 0.2.0

data/README.md

@@ -1,7 +1,7 @@
 garb
 ====
 
-  by Tony Pitale and Justin Marney
+  by Tony Pitale with much help from Justin Marney, Patrick Reagan and others at Viget Labs
 
   http://github.com/vigetlabs/garb
 
@@ -26,20 +26,14 @@ Profiles
     > Garb::Profile.all
     > profile = Garb::Profile.all.first
 
-Define a Report Class
----------------------
-
-    class ExitsReport < Garb::Report
-      def initialize(profile)
-        super(profile) do |config|
-          config.start_date = Time.now.at_beginning_of_month
-          config.end_date = Time.now.at_end_of_month
-          config.metrics << [:exits, :pageviews, :exit_rate]
-          config.dimensions << :request_uri
-          config.sort << :exits.desc
-          config.max_results = 10
-        end
-      end
+Define a Report Class and Get Results
+-------------------------------------
+
+    class Exits
+      include Garb::Resource
+
+      metrics :exits, :pageviews, :exit_rate
+      dimensions :request_uri
     end
 
 Parameters
@@ -47,7 +41,8 @@ Parameters
 
   * start_date: The date of the period you would like this report to start
   * end_date: The date to end, inclusive
-  * max_results: The maximum number of results to be returned
+  * limit: The maximum number of results to be returned
+  * offset: The starting index
 
 Metrics & Dimensions
 --------------------
@@ -65,13 +60,20 @@ Sorting
 -------
 
   Sorting can be done on any metric or dimension defined in the request, with .desc reversing the sort.
-  
+
 Building a Report
 -----------------
 
-  Given the class, session, and profile from above:
+  Given the class, session, and profile from above we can do:
 
-    reports = ExitsReport.new(profile).all
+    Exits.results(profile, :limit => 10, :offset => 19)
+
+  Or, with sorting and filters:
+
+    Exits.results(profile, :limit => 10, :offset => 19) do
+      filter :request_uri.contains => 'season', :exits.gt => 100
+      sort :exits
+    end
 
   reports will be an array of OpenStructs with methods for the metrics and dimensions returned.
 
@@ -79,10 +81,13 @@ Build a One-Off Report
 ----------------------
 
     report = Garb::Report.new(profile)
-    report.metrics << :pageviews
-    report.dimensions << :request_uri
+    report.metrics :pageviews
+    report.dimensions :request_uri
+
+    report.filter :request_uri.contains => 'season', :exits.gte => 10
+    report.sort :exits
 
-    report.all
+    report.results
 
 Filtering
 ---------
@@ -125,8 +130,6 @@ 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
-  * Intend to make defined report classes before more like AR
-  * Support start-index
   * Read opensearch header in results
   * OR joining filter parameters
 

data/Rakefile

@@ -1,26 +1,50 @@
-# Look in the tasks/setup.rb file for the various options that can be
-# configured in this Rakefile. The .rake files in the tasks directory
-# are where the options are used.
-
-begin
-  require 'bones'
-  Bones.setup
-rescue LoadError
-  load 'tasks/setup.rb'
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rcov/rcovtask'
+
+require 'lib/garb'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name              = 'garb'
+  s.version           = Garb::Version.to_s
+  s.has_rdoc          = false
+  s.summary           = "Google Analytics API Ruby Wrapper"
+  s.authors           = ['Tony Pitale','Justin Marney', 'Patrick Reagan']
+  s.email             = 'tony.pitale@viget.com'
+  s.homepage          = 'http://github.com/vigetlabs/garb'
+  s.files             = %w(README.md Rakefile) + Dir.glob("lib/**/*")
+  s.test_files        = Dir.glob("test/**/*")
+
+  s.add_dependency("jnunemaker-happymapper", [">= 0.2.2"])
+  s.add_dependency("libxml-ruby", [">= 0.9.8"])
 end
 
-ensure_in_path 'lib'
-require 'garb'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
 
-task :default => 'test'
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
 
-PROJ.name = 'garb'
-PROJ.authors = ['Tony Pitale','Justin Marney']
-PROJ.email = 'tony.pitale@viget.com'
-PROJ.url = 'http://github.com/vigetlabs/garb'
-PROJ.version = Garb::VERSION
-PROJ.rubyforge.name = 'garb'
-PROJ.test.files = FileList['test/**/*_test.rb']
-PROJ.spec.opts << '--color'
+desc "Generate RCov coverage report"
+Rcov::RcovTask.new(:rcov) do |t|
+  t.test_files = FileList['test/**/*_test.rb']
+  t.rcov_opts << "-x lib/garb.rb -x lib/garb/version.rb"
+end
+
+task :default => 'test'
 
 # EOF

data/lib/garb/data_request.rb

@@ -1,20 +1,20 @@
 module Garb
   class DataRequest
-    
+
     def initialize(base_url, parameters={})
       @base_url = base_url
       @parameters = parameters
     end
-    
+
     def query_string
       parameter_list = @parameters.map {|k,v| "#{k}=#{v}" }
       parameter_list.empty? ? '' : "?#{parameter_list.join('&')}"
     end
-    
+
     def uri
       URI.parse(@base_url)
     end
-    
+
     def send_request
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true
@@ -23,6 +23,6 @@ module Garb
       raise response.body.inspect unless response.is_a?(Net::HTTPOK)
       response
     end
-    
+
   end
 end

data/lib/garb/oauth_session.rb

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

@@ -1,211 +1,31 @@
-require 'ostruct'
-
 module Garb
   class Report
+    include Resource::ResourceMethods
+
     MONTH = 2592000
     URL = "https://www.google.com/analytics/feeds/data"
 
-    METRICS = {
-      :visitor => [
-        :avgPageviews,
-        :avgSessionTime,
-        :bounces,
-        :bounceRate,
-        :entrances,
-        :exits,
-        :exitRate,
-        :newVisitors,
-        :pageDuration,
-        :pageviews,
-        :visitDuration,
-        :visitors,
-        :visits
-      ],
-      :campaign => [
-        :cost,
-        :clicks,
-        :clickThroughRate,
-        :costPerConversion,
-        :costPerGoalConversion,
-        :costPerMilleImpressions,
-        :costPerTransaction,
-        :impressions
-      ],
-      :content => [
-        :uniquePageviews
-      ],
-      :ecommerce => [
-        :productPurchases,
-        :productRevenue,
-        :products,
-        :revenue,
-        :revenuePerClick,
-        :revenuePerTransaction,
-        :revenuePerVisit,
-        :shipping,
-        :tax,
-        :transactions
-      ],
-      :internal_search => [
-        :searchDepth,
-        :searchDuration,
-        :searchExits,
-        :searchTransitions,
-        :uniqueInternalSearches,
-        :visitsWithSearches
-      ],
-      :goals => [
-        :goalCompletions1,
-        :goalCompletions2,
-        :goalCompletions3,
-        :goalCompletions4,
-        :goalCompletionsAll,
-        :goalConversionRate,
-        :goalStarts1,
-        :goalStarts2,
-        :goalStarts3,
-        :goalStarts4,
-        :goalStartsAll,
-        :goalValue1,
-        :goalValue2,
-        :goalValue3,
-        :goalValue4,
-        :goalValueAll,
-        :goalValuePerVisit
-      ]
-    }
-    
-    DIMENSIONS = {
-      :visitor => [
-        :browser,
-        :browserVersion,
-        :city,
-        :connectionSpeed,
-        :continent,
-        :country,
-        :daysSinceLastVisit,
-        :domain,
-        :flashVersion,
-        :hostname,
-        :hour,
-        :javaEnabled,
-        :languqage,
-        :medium,
-        :organization,
-        :pageDepth,
-        :platform,
-        :platformVersion,
-        :referralPath,
-        :region,
-        :screenColors,
-        :screenResolution,
-        :subContinentRegion,
-        :userDefinedValue,
-        :visitNumber,
-        :visitorType
-      ],
-      :campaign => [
-        :adGroup,
-        :adSlot,
-        :adSlotPosition,
-        :campaign,
-        :content,
-        :keyword,
-        :source,
-        :sourceMedium
-      ],
-      :content => [
-        :pageTitle,
-        :requestUri,
-        :requestUri1,
-        :requestUriLast
-      ],
-      :ecommerce => [
-        :affiliation,
-        :daysToTransaction,
-        :productCode,
-        :productName,
-        :productVariation,
-        :transactionId,
-        :visitsToTransaction
-      ],
-      :internal_search => [
-        :hasInternalSearch,
-        :internalSearchKeyword,
-        :internalSearchNext,
-        :internalSearchType
-      ]
-    }
-    
-    attr_accessor :metrics, :dimensions, :sort, :filters,
-      :start_date, :max_results, :end_date
-    
-    attr_reader :profile
-
-    # def self.element_id(property_name)
-    #   property_name.is_a?(Operator) ? property_name.to_s : property_name.to_ga.lower_camelized
-    # end
-    # 
-    # def self.property_value(entry, property_name)
-    #   (entry/property_name).first.inner_text
-    # end
-    # 
-    # def self.property_values(entry, property_names)
-    #   hash = property_names.inject({}) do |hash, property_name|
-    #     hash.merge({property_name => property_value(entry, property_name.to_s.lower_camelized)})
-    #   end
-    #   OpenStruct.new hash
-    # end
-    # 
-    def self.format_time(t)
-      t.strftime('%Y-%m-%d')
-    end
-    
     def initialize(profile, opts={})
       @profile = profile
 
-      @sort = ReportParameter.new(:sort) << opts.fetch(:sort, [])
-      @filters = ReportParameter.new(:filters) << opts.fetch(:filters, [])      
-      @metrics = ReportParameter.new(:metrics) << opts.fetch(:metrics, [])
-      @dimensions = ReportParameter.new(:dimensions) << opts.fetch(:dimensions, [])
-    
       @start_date = opts.fetch(:start_date, Time.now - MONTH)
       @end_date = opts.fetch(:end_date, Time.now)
-      
-      yield self if block_given?
-    end
+      @limit = opts.fetch(:limit, nil)
+      @offset = opts.fetch(:offset, nil)
 
-    def page_params
-      max_results.nil? ? {} : {'max-results' => max_results}
-    end
-    
-    def default_params
-      {'ids' => profile.table_id,
-        'start-date' => self.class.format_time(start_date),
-        'end-date' => self.class.format_time(end_date)}
-    end
-    
-    def params
-      [
-        metrics.to_params,
-        dimensions.to_params,
-        sort.to_params,
-        filters.to_params,
-        page_params
-      ].inject(default_params) do |p, i|
-        p.merge(i)
-      end
-    end
-    
-    def send_request_for_body
-      request = DataRequest.new(URL, params)
-      response = request.send_request
-      response.body
+      # clear filters and sort
+      @filters = ReportParameter.new(:filters)
+      @sorts = ReportParameter.new(:sort)
+
+      metrics opts.fetch(:metrics, [])
+      dimensions opts.fetch(:dimensions, [])
+      filter opts.fetch(:filter, [])
+      sort opts.fetch(:sort, [])
     end
-    
-    def all
-      @entries = ReportResponse.new(send_request_for_body).parse
+
+    def results
+      ReportResponse.new(send_request_for_body).results
     end
-    
+
   end
-end
+end

data/lib/garb/report_parameter.rb

@@ -13,7 +13,7 @@ module Garb
     end
     
     def <<(element)
-      @elements += [element].flatten
+      (@elements += [element].flatten).compact!
       self
     end
     
@@ -23,7 +23,7 @@ module Garb
         when Hash
           elem.collect do |k,v|
             next unless k.is_a?(Operator)
-            "#{k.target}#{CGI::escape(k.operator.to_s)}#{CGI::escape(v.to_s)}"
+            "#{k.target}#{URI.encode(k.operator.to_s, /[=<>]/)}#{CGI::escape(v.to_s)}"
           end.join(';')
         else
           elem.to_ga
@@ -31,6 +31,6 @@ module Garb
       end.join(',')
       
       params.empty? ? {} : {self.name => params}
-    end    
+    end
   end
 end

data/lib/garb/report_response.rb

@@ -1,5 +1,7 @@
 module Garb  
   class ReportResponse
+    # include Enumerable
+
     def initialize(response_body)
       @xml = response_body
     end
@@ -7,7 +9,7 @@ module Garb
     def parse      
       entries = Entry.parse(@xml)
       
-      entries.collect do |entry|
+      @results = entries.collect do |entry|
         hash = {}
         
         entry.metrics.each do |m|
@@ -23,6 +25,10 @@ module Garb
         OpenStruct.new(hash)
       end
     end
+
+    def results
+      @results || parse
+    end
     
     class Metric
       include HappyMapper

data/lib/garb/resource.rb

@@ -0,0 +1,89 @@
+module Garb
+  module Resource
+    MONTH = 2592000
+    URL = "https://www.google.com/analytics/feeds/data"
+
+    def self.included(report)
+      report.extend(ResourceMethods)
+    end
+
+    module ResourceMethods
+
+      def metrics(*fields)
+        @metrics ||= ReportParameter.new(:metrics)
+        @metrics << fields
+      end
+
+      def dimensions(*fields)
+        @dimensions ||= ReportParameter.new(:dimensions)
+        @dimensions << fields
+      end
+
+      def filter(*hash)
+        @filters << hash
+      end
+
+      def filters
+        @filters ||= ReportParameter.new(:filters)
+      end
+
+      def sort(*fields)
+        @sorts << fields
+      end
+
+      def sorts
+        @sorts ||= ReportParameter.new(:sort)
+      end
+
+      def results(profile, opts = {}, &block)
+        @profile = profile
+
+        # clear filters and sort
+        @filters = ReportParameter.new(:filters)
+        @sorts = ReportParameter.new(:sort)
+
+        @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?
+
+        ReportResponse.new(send_request_for_body).results
+      end
+
+      def page_params
+        {'max-results' => @limit, 'start-index' => @offset}.reject{|k,v| v.nil?}
+      end
+
+      def default_params
+        {'ids' => @profile.table_id,
+          'start-date' => format_time(@start_date),
+          'end-date' => format_time(@end_date)}
+      end
+
+      def params
+        [
+          metrics.to_params,
+          dimensions.to_params,
+          sorts.to_params,
+          filters.to_params,
+          page_params
+        ].inject(default_params) do |p, i|
+          p.merge(i)
+        end
+      end
+
+      def format_time(t)
+        t.strftime('%Y-%m-%d')
+      end
+
+      def send_request_for_body
+        request = DataRequest.new(URL, params)
+        response = request.send_request
+        response.body
+      end
+
+    end
+  end
+end

data/lib/garb/version.rb

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

data/lib/garb.rb

@@ -4,15 +4,18 @@ require 'net/http'
 require 'net/https'
 require 'rubygems'
 require 'cgi'
+require 'ostruct'
 require 'happymapper'
 
+require 'garb/version'
 require 'garb/authentication_request'
 require 'garb/data_request'
 require 'garb/session'
 require 'garb/profile'
-require 'garb/report'
 require 'garb/report_parameter'
 require 'garb/report_response'
+require 'garb/resource'
+require 'garb/report'
 
 require 'extensions/string'
 require 'extensions/operator'

data/test/test_helper.rb

@@ -1,8 +1,11 @@
-require 'test/unit'
+$:.reject! { |e| e.include? 'TextMate' }
+
 require 'rubygems'
-require 'mocha'
+require 'test/unit'
 require 'shoulda'
-require 'garb'
+require 'mocha'
+
+require File.dirname(__FILE__) + '/../lib/garb'
 
 class Test::Unit::TestCase
   

data/test/{authentication_request_test.rb → unit/authentication_request_test.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 module Garb
   class AuthenticationRequestTest < Test::Unit::TestCase

data/test/{data_request_test.rb → unit/data_request_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 module Garb
   class DataRequestTest < Test::Unit::TestCase

data/test/{garb_test.rb → unit/garb_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 class GarbTest < Test::Unit::TestCase
   context "A green egg" do

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/{operator_test.rb → unit/operator_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 class OperatorTest < Test::Unit::TestCase
   context "An instance of an Operator" do

data/test/{profile_test.rb → unit/profile_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 module Garb
   class ProfileTest < Test::Unit::TestCase

data/test/{report_parameter_test.rb → unit/report_parameter_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 module Garb
   class ReportParameterTest < Test::Unit::TestCase
@@ -45,7 +45,14 @@ module Garb
         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

data/test/{report_response_test.rb → unit/report_response_test.rb}

@@ -1,10 +1,10 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+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")
+        @xml = File.read(File.join(File.dirname(__FILE__), '..', "/fixtures/report_feed.xml"))
         @response = ReportResponse.new(@xml)
       end
       
@@ -19,6 +19,11 @@ module Garb
         
         assert_equal(['entry1', 'entry2', 'entry3'], @response.parse)
       end
+
+      should "have results or parse them" do
+        @response.expects(:parse)
+        @response.results
+      end
     end
   end
 end

data/test/unit/report_test.rb

@@ -0,0 +1,71 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+module Garb
+  # Also tests Garb::Resource, which is the basis for Garb::Report
+  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 filters sorts).each do |param|
+        should "have parameters for #{param}" do
+          assert @report.send(:"#{param}").is_a?(ReportParameter)
+        end
+      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 "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(:sorts).returns(stub(:to_params => {'sort' => 3}))
+        @report.stubs(:page_params).returns({'page_params' => 2})
+        @report.stubs(:default_params).returns({'default_params' => 1})
+        
+        params = {'metrics' => 6, 'dimensions' => 5, 'filters' => 4, 'sort' => 3, 'page_params' => 2, 'default_params' => 1}
+        assert_equal 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(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/resource_test.rb

@@ -0,0 +1,19 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+class TestReport
+  include Garb::Resource
+end
+
+# Most of the resource testing is done as a part of ReportTest
+class ResourceTest < Test::Unit::TestCase
+
+  context "A class with Garb::Resource mixed in" do
+    should "get results from GA" do
+      profile = stub
+      TestReport.expects(:send_request_for_body).returns('xml')
+      Garb::ReportResponse.expects(:new).with('xml').returns(mock(:results => 'analytics'))
+
+      assert_equal 'analytics', TestReport.results(profile)
+    end
+  end
+end

data/test/{session_test.rb → unit/session_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 module Garb
   class SessionTest < Test::Unit::TestCase

data/test/unit/string_test.rb

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+class StringTest < Test::Unit::TestCase
+  context "An instance of a String" do
+    should 'prefix a string with ga: for GA' do
+      assert_equal 'ga:bob', 'bob'.to_ga
+    end
+  end
+end

data/test/{symbol_test.rb → unit/symbol_test.rb}

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + '/test_helper'
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 class SymbolTest < Test::Unit::TestCase
   

metadata

@@ -1,15 +1,17 @@
 --- !ruby/object:Gem::Specification 
 name: vigetlabs-garb
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors: 
 - Tony Pitale
+- Justin Marney
+- Patrick Reagan
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-04-22 00:00:00 -07:00
+date: 2009-04-29 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,7 +34,7 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.9.8
     version: 
-description: A ruby gem to aid in the use of the Google Analytics API
+description: 
 email: tony.pitale@viget.com
 executables: []
 
@@ -41,22 +43,43 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
-- History.txt
 - README.md
 - Rakefile
-- garb.gemspec
-- lib/garb.rb
+- lib/extensions
+- lib/extensions/happymapper.rb
+- lib/extensions/operator.rb
+- lib/extensions/string.rb
+- lib/extensions/symbol.rb
+- lib/garb
 - lib/garb/authentication_request.rb
 - lib/garb/data_request.rb
+- lib/garb/oauth_session.rb
 - lib/garb/profile.rb
 - lib/garb/report.rb
 - lib/garb/report_parameter.rb
 - lib/garb/report_response.rb
+- lib/garb/resource.rb
 - lib/garb/session.rb
-- lib/extensions/symbol.rb
-- lib/extensions/string.rb
-- lib/extensions/operator.rb
-- lib/extensions/happymapper.rb
+- lib/garb/version.rb
+- lib/garb.rb
+- test/fixtures
+- test/fixtures/profile_feed.xml
+- test/fixtures/report_feed.xml
+- test/test_helper.rb
+- test/unit
+- test/unit/authentication_request_test.rb
+- test/unit/data_request_test.rb
+- test/unit/garb_test.rb
+- test/unit/oauth_session_test.rb
+- test/unit/operator_test.rb
+- test/unit/profile_test.rb
+- test/unit/report_parameter_test.rb
+- test/unit/report_response_test.rb
+- test/unit/report_test.rb
+- test/unit/resource_test.rb
+- test/unit/session_test.rb
+- test/unit/string_test.rb
+- test/unit/symbol_test.rb
 has_rdoc: false
 homepage: http://github.com/vigetlabs/garb
 post_install_message: 
@@ -84,16 +107,21 @@ 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
 - test/fixtures/profile_feed.xml
 - test/fixtures/report_feed.xml
+- test/test_helper.rb
+- test/unit
+- test/unit/authentication_request_test.rb
+- test/unit/data_request_test.rb
+- test/unit/garb_test.rb
+- test/unit/oauth_session_test.rb
+- test/unit/operator_test.rb
+- test/unit/profile_test.rb
+- test/unit/report_parameter_test.rb
+- test/unit/report_response_test.rb
+- test/unit/report_test.rb
+- test/unit/resource_test.rb
+- test/unit/session_test.rb
+- test/unit/string_test.rb
+- test/unit/symbol_test.rb

data/garb.gemspec

@@ -1,42 +0,0 @@
-Gem::Specification.new do |s|
-  s.name     = "garb"
-  s.version  = "0.1.2"
-  s.date     = "2009-04-22"
-  s.summary  = "Google Analytics API Ruby Wrapper"
-  s.email    = "tony.pitale@viget.com"
-  s.homepage = "http://github.com/vigetlabs/garb"
-  s.description = "A ruby gem to aid in the use of the Google Analytics API"
-  s.has_rdoc = false
-  s.authors  = ["Tony Pitale"]
-  s.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"]
-  s.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']
-  s.add_dependency("jnunemaker-happymapper", [">= 0.2.2"])
-  s.add_dependency("libxml-ruby", [">= 0.9.8"])
-end

data/test/report_test.rb

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