Merge pull request #126 from wrocla/master

Add sampled flag for response data of google analytics api

lib/legato/query.rb

@@ -3,7 +3,7 @@ class Query
     include Enumerable
 
     MONTH = 2592000
-    REQUEST_FIELDS = 'columnHeaders/name,rows,totalResults,totalsForAllResults'
+    REQUEST_FIELDS = 'columnHeaders/name,rows,totalResults,totalsForAllResults,containsSampledData'
 
     BASIC_OPTION_KEYS = [
       :sort, :limit, :offset, :start_date, :end_date, :quota_user,
@@ -160,6 +160,7 @@ def load
       @collection = response.collection
       @total_results = response.total_results
       @totals_for_all_results = response.totals_for_all_results
+      @sampled = response.sampled
       @loaded = true
     end
 
@@ -179,6 +180,11 @@ def totals_for_all_results
       @totals_for_all_results
     end
 
+    def sampled
+      load unless loaded?
+      @sampled
+    end
+
     def each(&block)
       collection.each(&block)
     end

lib/legato/response.rb

@@ -21,6 +21,10 @@ def totals_for_all_results
       Hash[data["totalsForAllResults"].map{|k,v| [Legato.from_ga_string(k), number_for(v)]}]
     end
 
+    def sampled
+      data["containsSampledData"]
+    end
+
     def rows
       Array.wrap(data['rows']).compact
     end

spec/lib/legato/query_spec.rb

@@ -60,7 +60,7 @@ def self.it_defines_operators(*operators)
     end
 
     it "loads a collection of results" do
-      response = stub(:collection => [], :total_results => 0, :totals_for_all_results => {})
+      response = stub(:collection => [], :total_results => 0, :totals_for_all_results => {}, :sampled => false)
       user = stub(:request => response)
       query.stubs(:profile => stub(:user => user))
 
@@ -71,23 +71,24 @@ def self.it_defines_operators(*operators)
       response.should have_received(:collection)
       response.should have_received(:total_results)
       response.should have_received(:totals_for_all_results)
+      response.should have_received(:sampled)
     end
 
     it "returns the collection" do
-      query.stubs(:request_for_query).returns(stub(:collection => [1,2,3], :total_results => 3, :totals_for_all_results => {'foo' => 34.2}))
+      query.stubs(:request_for_query).returns(stub(:collection => [1,2,3], :total_results => 3, :totals_for_all_results => {'foo' => 34.2}, :sampled => false))
       query.load
       query.collection.should == [1,2,3]
       query.to_a.should == [1,2,3]
     end
 
     it "returns the total number of results" do
-      query.stubs(:request_for_query).returns(stub(:collection => [1,2,3], :total_results => 3, :totals_for_all_results => {'foo' => 34.2}))
+      query.stubs(:request_for_query).returns(stub(:collection => [1,2,3], :total_results => 3, :totals_for_all_results => {'foo' => 34.2}, :sampled => false))
       query.load
       query.total_results.should == 3
     end
 
     it "returns the totals for all results" do
-      query.stubs(:request_for_query).returns(stub(:collection => [1,2,3], :total_results => 3, :totals_for_all_results => {'foo' => 34.2}))
+      query.stubs(:request_for_query).returns(stub(:collection => [1,2,3], :total_results => 3, :totals_for_all_results => {'foo' => 34.2}, :sampled => false))
       query.load
       query.totals_for_all_results.should == {'foo' => 34.2}
     end