garb 0.9.0 → 0.9.1

data/README.md

@@ -48,7 +48,7 @@ Accounts, WebProperties, Profiles, and Goals
 Profiles for a UA- Number (a WebProperty)
 --------
 
-    > profile = profile = Garb::Management::Profile.all.detect {|p| p.web_property_id == 'UA-XXXXXXX-X'}
+    > profile = Garb::Management::Profile.all.detect {|p| p.web_property_id == 'UA-XXXXXXX-X'}
 
 Define a Report Class
 ---------------------
@@ -82,14 +82,13 @@ Other Parameters
 Metrics & Dimensions
 --------------------
 
-  **Metrics and Dimensions are very complex because of the ways in which the can and cannot be combined.**
+  **Metrics and Dimensions are very complex because of the ways in which they can and cannot be combined.**
 
   I suggest reading the google documentation to familiarize yourself with this.
 
   http://code.google.com/apis/analytics/docs/gdata/gdataReferenceDimensionsMetrics.html#bounceRate
 
-  When you've returned, you can pass the appropriate combinations (up to 50 metrics and 2 dimenstions)
-  to garb, as an array, of symbols. Or you can simply push a symbol into the array.
+  When you've returned, you can pass the appropriate combinations to Garb, as symbols.
 
 Filtering
 ---------
@@ -98,11 +97,8 @@ Filtering
 
   http://code.google.com/apis/analytics/docs/gdata/gdataReference.html#filtering
 
-  We handle filtering as an array of hashes that you can push into, 
-  which will be joined together (AND'd)
-
   Here is what we can do currently:
-  (the operator is a method on a symbol metric or dimension)
+  (the operator is a method on a symbol for the appropriate metric or dimension)
 
   Operators on metrics:
 
@@ -122,7 +118,7 @@ Filtering
     substring => '=@',
     not_substring => '!@'
     
-  Given the previous Exits example report, we can add an options for filter:
+  Given the previous Exits example report in shorthand, we can add an option for filter:
 
     profile.exits(:filters => {:page_path.eql => '/extend/effectively-using-git-with-subversion/')
 

data/lib/garb.rb

@@ -25,6 +25,7 @@ require 'garb/profile'
 require 'garb/account'
 require 'garb/filter_parameters'
 require 'garb/report_parameter'
+require 'garb/result_set'
 require 'garb/report_response'
 require 'garb/resource'
 require 'garb/report'

data/lib/garb/filter_parameters.rb

@@ -31,7 +31,8 @@ module Garb
       value = self.parameters.map do |param|
         param.map do |k,v|
           next unless k.is_a?(SymbolOperator)
-          "#{URI.encode(k.to_google_analytics, /[=<>]/)}#{CGI::escape(v.to_s)}"
+          escaped_v = v.to_s.gsub(/([,;\\])/) {|c| '\\'+c}
+          "#{URI.encode(k.to_google_analytics, /[=<>]/)}#{CGI::escape(escaped_v)}"
         end.join('%3B') # Hash AND (no duplicate keys), escape char for ';' fixes oauth
       end.join(',') # Array OR
 

data/lib/garb/management/feed.rb

@@ -15,7 +15,7 @@ module Garb
 
       def entries
         # possible to have nil entries, yuck
-        parsed_response ? Array(parsed_response['feed']['entry']).flatten.compact : []
+        parsed_response ? [parsed_response['feed']['entry']].flatten.compact : []
       end
 
       def response

data/lib/garb/model.rb

@@ -26,7 +26,9 @@ module Garb
     end
 
     def results(profile, options = {})
-      default_params = build_default_params(profile)
+      start_date = options.fetch(:start_date, Time.now - MONTH)
+      end_date = options.fetch(:end_date, Time.now)
+      default_params = build_default_params(profile, start_date, end_date)
 
       param_set = [
         default_params,
@@ -70,11 +72,11 @@ module Garb
       sort
     end
 
-    def build_default_params(profile)
+    def build_default_params(profile, start_date, end_date)
       {
         'ids' => Garb.to_ga(profile.id),
-        'start-date' => format_time(Time.now - Model::MONTH),
-        'end-date' => format_time(Time.now)
+        'start-date' => format_time(start_date),
+        'end-date' => format_time(end_date)
       }
     end
 

data/lib/garb/report_response.rb

@@ -8,7 +8,16 @@ module Garb
     end
 
     def results
-      @results ||= parse
+      if @results.nil?
+        @results = ResultSet.new(parse)
+        @results.total_results = parse_total_results
+        @results.sampled = parse_sampled_flag
+      end
+
+      @results
+    end
+
+    def sampled?
     end
 
     private
@@ -21,8 +30,23 @@ module Garb
     end
 
     def entries
-      entry_hash = Crack::XML.parse(@xml)
-      entry_hash ? [entry_hash['feed']['entry']].flatten.compact : []
+      feed? ? [parsed_xml['feed']['entry']].flatten.compact : []
+    end
+
+    def parse_total_results
+      feed? ? parsed_xml['feed']['openSearch:totalResults'].to_i : 0
+    end
+
+    def parse_sampled_flag
+      feed? ? (parsed_xml['feed']['dxp:containsSampledData'] == 'true') : false
+    end
+
+    def parsed_xml
+      @parsed_xml ||= Crack::XML.parse(@xml)
+    end
+
+    def feed?
+      !parsed_xml['feed'].nil?
     end
 
     def values_for(entry)

data/lib/garb/result_set.rb

@@ -0,0 +1,21 @@
+module Garb
+  class ResultSet
+    include Enumerable
+
+    attr_accessor :total_results, :sampled
+
+    alias :sampled? :sampled
+
+    def initialize(results)
+      @results = results
+    end
+
+    def each(&block)
+      @results.each(&block)
+    end
+
+    def to_a
+      @results
+    end
+  end
+end

data/lib/garb/version.rb

@@ -3,7 +3,7 @@ module Garb
 
     MAJOR = 0
     MINOR = 9
-    TINY  = 0
+    TINY  = 1
 
     def self.to_s # :nodoc:
       [MAJOR, MINOR, TINY].join('.')

data/test/fixtures/report_feed.xml

@@ -14,6 +14,8 @@
     </author>    
   <openSearch:startIndex>3</openSearch:startIndex>
   <openSearch:itemsPerPage>4</openSearch:itemsPerPage>
+  <openSearch:totalResults>18</openSearch:totalResults>
+  <dxp:containsSampledData>true</dxp:containsSampledData>
   <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>

data/test/unit/garb/coverage/index.html

@@ -21,7 +21,7 @@
       <img src="./assets/0.3.9/loading.gif" alt="loading"/>
     </div>
     <div id="wrapper" style="display:none;">
-      <div class="timestamp">Generated <abbr class="timeago" title="2010-12-09T15:19:41-05:00">2010-12-09T15:19:41-05:00</abbr></div>
+      <div class="timestamp">Generated <abbr class="timeago" title="2011-01-08T20:21:01-05:00">2011-01-08T20:21:01-05:00</abbr></div>
       <ul class="group_tabs"></ul>
 
       <div id="content">

data/test/unit/garb/coverage/resultset.yml

@@ -2,4 +2,4 @@
 Unit Tests: 
   :original_result: {}
 
-  :created_at: 2010-12-09 15:19:41.584017 -05:00
+  :created_at: 2011-01-08 20:21:01.493065 -05:00

data/test/unit/garb/filter_parameters_test.rb

@@ -53,6 +53,15 @@ module Garb
           params = {'filters' => 'ga:pagePath%3D~New+York'}
           assert_equal params, @filter_parameters.to_params
         end
+
+        should "escape comma, semicolon, and backslash in values" do
+          @filter_parameters.filters do
+            eql(:url, 'this;that,thing\other')
+          end
+
+          params = {'filters' => 'ga:url%3D%3Dthis%5C%3Bthat%5C%2Cthing%5C%5Cother'}
+          assert_equal params, @filter_parameters.to_params
+        end
       end
     end
   end

data/test/unit/garb/management/coverage/index.html

@@ -21,7 +21,7 @@
       <img src="./assets/0.3.9/loading.gif" alt="loading"/>
     </div>
     <div id="wrapper" style="display:none;">
-      <div class="timestamp">Generated <abbr class="timeago" title="2010-12-09T17:47:44-05:00">2010-12-09T17:47:44-05:00</abbr></div>
+      <div class="timestamp">Generated <abbr class="timeago" title="2011-01-08T19:38:09-05:00">2011-01-08T19:38:09-05:00</abbr></div>
       <ul class="group_tabs"></ul>
 
       <div id="content">

data/test/unit/garb/management/coverage/resultset.yml

@@ -2,4 +2,4 @@
 Unit Tests: 
   :original_result: {}
 
-  :created_at: 2010-12-09 17:47:44.425037 -05:00
+  :created_at: 2011-01-08 19:38:09.152093 -05:00

data/test/unit/garb/management/feed_test.rb

@@ -23,6 +23,11 @@ module Garb
           assert_equal ['entry1', 'entry2'], @feed.entries
         end
 
+        should "handle case of a single entry" do
+          @feed.stubs(:parsed_response).returns({'feed' => {'entry' => {'profile_id' => '12345'}}})
+          assert_equal [{'profile_id' => '12345'}], @feed.entries
+        end
+
         should "have an empty array for entries without a response" do
           @feed.stubs(:parsed_response).returns(nil)
           assert_equal [], @feed.entries

data/test/unit/garb/model_test.rb

@@ -64,7 +64,7 @@ module Garb
             @test_model.stubs(:dimensions).returns(stub(:to_params => {'dimensions' => 'ga:pagePath'}))
 
             now = Time.now
-            Time.stubs(:new).returns(now)
+            Time.stubs(:now).returns(now)
 
             # p @profile.id
 
@@ -115,7 +115,13 @@ module Garb
             assert_data_params(@params.merge({'start-index' => 10}))
           end
 
-          # should "be able to shift the date range"
+          should "be able to shift the date range" do
+            start_date = (Time.now - 1296000)
+            end_date = Time.now
+
+            assert_equal ['result'], @test_model.results(@profile, :start_date => start_date, :end_date => end_date)
+            assert_data_params(@params.merge({'start-date' => start_date.strftime('%Y-%m-%d'), 'end-date' => end_date.strftime('%Y-%m-%d')}))
+          end
 
           should "return a set of results in the defined class" do
             @test_model.stubs(:instance_klass).returns(ResultKlass)
@@ -125,7 +131,6 @@ module Garb
           end
         end
 
-        # should "have a block syntax for filtering results"
         # should "return results as an array of the class it belongs to, if that class is an ActiveRecord descendant"
         # should "return results as an array of the class it belongs to, if that class is a DataMapper descendant"
         # should "return results as an array of the class it belongs to, if that class is a MongoMapper descendant"

data/test/unit/garb/report_response_test.rb

@@ -7,30 +7,40 @@ module Garb
     context "A ReportResponse" do
       context "with a report feed" do
         setup do
-          @file = File.read(File.join(File.dirname(__FILE__), '..', '..', "/fixtures/report_feed.xml"))
+          @xml = File.read(File.join(File.dirname(__FILE__), '..', '..', "/fixtures/report_feed.xml"))
         end
 
         should "parse results from atom xml" do
-          response = ReportResponse.new(@file)
+          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(@file)
+          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(@file, SpecialKlass)
+          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
+        assert_equal [], response.results.to_a
       end
     end
   end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 9
-  - 0
-  version: 0.9.0
+  - 1
+  version: 0.9.1
 platform: ruby
 authors: 
 - Tony Pitale
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-10 00:00:00 -05:00
+date: 2011-01-08 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -84,6 +84,7 @@ files:
 - lib/garb/reports/visits.rb
 - lib/garb/reports.rb
 - lib/garb/resource.rb
+- lib/garb/result_set.rb
 - lib/garb/session.rb
 - lib/garb/step.rb
 - lib/garb/version.rb