garb 0.9.1 → 0.9.7

data/lib/garb/result_set.rb

@@ -1,21 +1,35 @@
+require 'forwardable'
+
 module Garb
   class ResultSet
     include Enumerable
+    include Comparable
+    extend Forwardable
 
-    attr_accessor :total_results, :sampled
-
-    alias :sampled? :sampled
+    attr_accessor :results, :total_results, :sampled
+    alias_method :sampled?, :sampled
+    
+    def_delegators :results, :each, :to_a, :count, :size, :empty?
 
     def initialize(results)
       @results = results
     end
-
-    def each(&block)
-      @results.each(&block)
+    
+    def <=>(other)
+      results <=> other.results
     end
-
-    def to_a
-      @results
+    
+    def +(other)
+      copy = self.dup
+      copy.results = @results + other.to_a
+      copy
+    end
+    
+    def [](*args)
+      return @results[*args] if args.size == 1 && args.first.is_a?(Integer)
+      copy = self.dup
+      copy.results = @results[*args]
+      copy
     end
   end
 end

data/lib/garb/session.rb

@@ -1,12 +1,12 @@
 module Garb
   class Session
     module Methods
-      attr_accessor :auth_token, :access_token, :email
+      attr_accessor :auth_token, :access_token, :email, :api_key
 
       # use only for single user authentication
-      def login(email, password, opts={})
+      def login(email, password, opts = {})
         self.email = email
-        auth_request = AuthenticationRequest.new(email, password, opts)
+        auth_request = Request::Authentication.new(email, password, opts)
         self.auth_token = auth_request.auth_token(opts)
       end
 

data/lib/garb/step.rb

@@ -1,13 +1,13 @@
 module Garb
   class Step
-    attr_reader :name, :number, :path
+    attr_reader :name, :number, :url
 
     def initialize(attributes)
-      return unless attributes.is_a?(Hash)
+      return unless attributes.is_a? Hash
 
       @name = attributes['name']
-      @number = attributes['number'].to_i
-      @path = attributes['path']
+      @number = attributes['number']
+      @url = attributes['url']
     end
   end
 end

data/lib/garb/support.rb

@@ -0,0 +1,6 @@
+unless Object.const_defined? 'ActiveSupport'
+  require 'garb/core_ext/string'
+  require 'garb/core_ext/array'
+end
+
+require 'garb/core_ext/symbol'

data/lib/garb/version.rb

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

data/test/fixtures/account_management.json

@@ -0,0 +1 @@
+{"kind":"analytics#accounts","username":"someone@somewhere.com","totalResults":1,"startIndex":1,"itemsPerPage":1000,"items":[{"id":"1234","kind":"analytics#account","selfLink":"https://www.googleapis.com/analytics/v3/management/accounts/1234","name":"www.google.com","created":"2012-1-01T17:52:03.000Z","updated":"2012-01-01T18:52:11.747Z","childLink":{"type":"analytics#webproperties","href":"https://www.googleapis.com/analytics/v3/management/accounts/1234/webproperties"}}]}

data/test/fixtures/ga_profile_management.json

@@ -0,0 +1 @@
+{"kind":"analytics#profiles","username":"someone@somewhere.com","totalResults":1,"startIndex":1,"itemsPerPage":1000,"nextLink":"https://www.googleapis.com/analytics/v3/management/accounts/~all/webproperties/~all/profiles?start-index=1001&max-results=1000","items":[{"id":"2","kind":"analytics#profile","selfLink":"https://www.googleapis.com/analytics/v3/management/accounts/1234/webproperties/UA-5555-1/profiles/2","accountId":"1234","webPropertyId":"UA-5555-1","internalWebPropertyId":"7777","name":"the profile name","currency":"USD","timezone":"America/Los_Angeles","defaultPage":"index.html","siteSearchQueryParameters":"q,term","created":"2012-01-01T18:04:04.000Z","updated":"2012-01-01T18:55:51.046Z","parentLink":{"type":"analytics#webproperty","href":"https://www.googleapis.com/analytics/v3/management/accounts/1234/webproperties/UA-5555-1"},"childLink":{"type":"analytics#goals","href":"https://www.googleapis.com/analytics/v3/management/accounts/1234/webproperties/UA-5555-1/profiles/2/goals"}}]}

data/test/fixtures/ga_segment_management.json

@@ -0,0 +1 @@
+{"kind":"analytics#segments","username":"someone@somewhere.com","totalResults":1,"startIndex":1,"itemsPerPage":1000,"items":[{"id":"1","kind":"analytics#segment","selfLink":"https://www.googleapis.com/analytics/v3/management/segments/gaid::1","segmentId":"gaid::1","name":"derpy","definition":"ga:pagePath=@derpy","created":"2012-01-01T15:07:11.815Z","updated":"2012-01-01T15:07:11.815Z"}]}

data/test/fixtures/ga_webproperty_management.json

@@ -0,0 +1 @@
+{"kind":"analytics#webproperties","username":"someone@somewhere.com","totalResults":1,"startIndex":1,"itemsPerPage":1000,"items":[{"id":"UA-7777-1","kind":"analytics#webproperty","selfLink":"https://www.googleapis.com/analytics/v3/management/accounts/1/webproperties/UA-7777-1","accountId":"1","internalWebPropertyId":"7777","name":"google","websiteUrl":"http://www.google.com","created":"2012-01-01T17:52:03.000Z","updated":"2012-01-01T16:05:57.532Z","parentLink":{"type":"analytics#account","href":"https://www.googleapis.com/analytics/v3/management/accounts/1"},"childLink":{"type":"analytics#profiles","href":"https://www.googleapis.com/analytics/v3/management/accounts/1/webproperties/UA-7777-1/profiles"}}]}

data/test/fixtures/goal_management.json

@@ -0,0 +1 @@
+{"kind":"analytics#goals","username":"someone@somewhere.com","totalResults":1,"startIndex":1,"itemsPerPage":1000,"nextLink":"https://www.googleapis.com/analytics/v3/management/accounts/~all/webproperties/~all/profiles/~all/goals?start-index=1001&max-results=1000","items":[{"id":"1","kind":"analytics#goal","selfLink":"https://www.googleapis.com/analytics/v3/management/accounts/1234/webproperties/UA-55555-1/profiles/1234/goals/1","accountId":"1234","webPropertyId":"UA-5555-1","internalWebPropertyId":"7777","profileId":"1234","name":"the goal","value":1.0,"active":true,"type":"URL_DESTINATION","created":"2012-01-01T17:32:10.000Z","updated":"2012-01-01T15:54:41.781Z","parentLink":{"type":"analytics#profile","href":"https://www.googleapis.com/analytics/v3/management/accounts/1234/webproperties/UA-5555-1/profiles/1234"},"urlDestinationDetails":{"url":"^/somewhere/results","caseSensitive":false,"matchType":"REGEX","firstStepRequired":false,"steps":[{"number":1,"name":"Intro Page","url":"^/somewhere/index"},{"number":2,"name":"Select A Thing","url":"^/somewhere/select_a_thing"},{"number":3,"name":"Results","url":"^/somewhere/results"}]}}]}

data/test/fixtures/profile_feed.json

@@ -0,0 +1 @@
+{"feed":{"id":"http://www.google.com/analytics/feeds/accounts/blah@gmail.com","updated":"2010-05-06T19:27:28.028-07:00","title":"Profile list for blah@gmail.com","link":{"rel":"self","type":"application/atom+xml","href":"https://www.google.com/analytics/feeds/accounts/default"},"author":{"name":"Google Analytics"},"generator":"Google Analytics","openSearch:totalResults":"2","openSearch:startIndex":"1","openSearch:itemsPerPage":"2","dxp$segment":[{"dxp$definition":null,"id":"gaid::-1","name":"All Visits"},{"dxp$definition":"ga:visitorType==New Visitor","id":"gaid::-2","name":"New Visitors"},{"dxp$definition":"ga:medium==cpa,ga:medium==cpc,ga:medium==cpm,ga:medium==cpp,ga:medium==cpv,ga:medium==ppc","id":"gaid::-3","name":"Paid Search Traffic"},{"dxp$definition":"ga:city!=New York","id":"gaid::0","name":"Not New York"}],"entry":[{"id":"http://www.google.com/analytics/feeds/accounts/ga:12345","updated":"2008-07-21T14:05:57.000-07:00","title":"Historical","link":{"rel":"alternate","type":"text/html","href":"http://www.google.com/analytics"},"ga:goal":[{"ga:destination":{"caseSensitive":"false","expression":"/blog.html","matchType":"head","step1Required":"false"},"active":"true","name":"Read Blog","number":"1","value":"10.0"},{"ga:destination":{"caseSensitive":"false","expression":"/support.html","matchType":"head","step1Required":"false"},"active":"true","name":"Go for Support","number":"2","value":"5.0"},{"ga:destination":{"ga:step":{"name":"Contact Form Page","number":"1","path":"/contact.html"},"caseSensitive":"false","expression":"/contact-submit","matchType":"exact","step1Required":"true"},"active":"true","name":"Contact Form Submission","number":"3","value":"100.0"},{"ga:destination":{"caseSensitive":"false","expression":"/newsletter-submit","matchType":"exact","step1Required":"false"},"active":"true","name":"Newsletter Form Submission","number":"4","value":"25.0"}],"dxp$property":[{"name":"ga:accountId","value":"1111"},{"name":"ga:accountName","value":"Blog Beta"},{"name":"ga:profileId","value":"1212"},{"name":"ga:webPropertyId","value":"UA-1111-1"},{"name":"ga:currency","value":"USD"},{"name":"ga:timezone","value":"America/New_York"}],"dxp:tableId":"ga:12345","gd:etag":"W/\"CUcHSXs8fip7I2A9WxBUFUg.\"","gd:kind":"analytics#account"},{"id":"http://www.google.com/analytics/feeds/accounts/ga:12346","updated":"2008-11-24T11:51:07.000-08:00","title":"Presently","link":{"rel":"alternate","type":"text/html","href":"http://www.google.com/analytics"},"ga:goal":[{"ga:destination":{"ga:step":{"name":"Contact Form Page","number":"1","path":"/contact.html"},"caseSensitive":"false","expression":"/contact-submit","matchType":"exact","step1Required":"true"},"active":"true","name":"Contact Form Submission","number":"1","value":"100.0"},{"ga:destination":{"caseSensitive":"false","expression":"/newsletter-submit","matchType":"exact","step1Required":"false"},"active":"true","name":"Newsletter Form Submission","number":"2","value":"25.0"}],"dxp$property":[{"name":"ga:accountId","value":"1111"},{"name":"ga:accountName","value":"Blog Beta"},{"name":"ga:profileId","value":"1213"},{"name":"ga:webPropertyId","value":"UA-1111-2"},{"name":"ga:currency","value":"USD"},{"name":"ga:timezone","value":"America/New_York"}],"dxp:tableId":"ga:12346","gd:etag":"W/\"A0UASX45cCp7I2A9WxFQEUQ.\"","gd:kind":"analytics#account"}],"xmlns":"http://www.w3.org/2005/Atom","xmlns:dxp":"http://schemas.google.com/analytics/2009","xmlns:ga":"http://schemas.google.com/ga/2009","xmlns:openSearch":"http://a9.com/-/spec/opensearch/1.1/","xmlns:gd":"http://schemas.google.com/g/2005","gd:etag":"W/\"A0UASX45cCp7I2A9WxFQEUQ.\"","gd:kind":"analytics#accounts"}}

data/test/fixtures/report_feed.json

@@ -0,0 +1,75 @@
+{
+  "kind":"analytics#gaData",
+  "id":"https://www.googleapis.com/analytics/v3/data/ga?ids=ga:123456&dimensions=ga:country,ga:city&metrics=ga:pageViews&start-date=2011-12-01&end-date=2011-12-31&start-index=1&max-results=5",
+  "query":{
+    "start-date":"2011-12-01",
+    "end-date":"2011-12-31",
+    "ids":"ga:123456",
+    "dimensions":"ga:country,ga:city",
+    "metrics":[
+      "ga:pageViews"
+    ],
+    "start-index":1,
+    "max-results":5
+  },
+  "itemsPerPage":5,
+  "totalResults":1261,
+  "selfLink":"https://www.googleapis.com/analytics/v3/data/ga?ids=ga:123456&dimensions=ga:country,ga:city&metrics=ga:pageViews&start-date=2011-12-01&end-date=2011-12-31&start-index=1&max-results=5",
+  "nextLink":"https://www.googleapis.com/analytics/v3/data/ga?ids=ga:123456&dimensions=ga:country,ga:city&metrics=ga:pageViews&start-date=2011-12-01&end-date=2011-12-31&start-index=6&max-results=5",
+  "profileInfo":{
+    "profileId":"123456",
+    "accountId":"123456",
+    "webPropertyId":"UA-123456-1",
+    "internalWebPropertyId":"123456",
+    "profileName":"example.com",
+    "tableId":"ga:123456"
+  },
+  "containsSampledData":true,
+  "columnHeaders":[
+    {
+      "name":"ga:country",
+      "columnType":"DIMENSION",
+      "dataType":"STRING"
+    },
+    {
+      "name":"ga:city",
+      "columnType":"DIMENSION",
+      "dataType":"STRING"
+    },
+    {
+      "name":"ga:pageviews",
+      "columnType":"METRIC",
+      "dataType":"INTEGER"
+    }
+  ],
+  "totalsForAllResults":{
+    "ga:pageviews":"38817"
+  },
+  "rows":[
+    [
+      "(not set)",
+      "(not set)",
+      "4"
+    ],
+    [
+      "Australia",
+      "Adelaide",
+      "4"
+    ],
+    [
+      "Australia",
+      "Brisbane",
+      "17"
+    ],
+    [
+      "Australia",
+      "Geelong",
+      "1"
+    ],
+    [
+      "Australia",
+      "Melbourne",
+      "5"
+    ]
+  ]
+}

data/test/test_helper.rb

@@ -10,35 +10,31 @@ begin
 
   SimpleCov.start 'garb'
 rescue LoadError
-  puts "Install simplecov if you use 1.9 and want coverage metrics"
+  puts 'Install simplecov if you use 1.9 and want coverage metrics'
 end
 
-$:.reject! { |e| e.include? 'TextMate' }
-
-require 'rubygems'
 require 'bundler'
 Bundler.setup(:default, :test)
 
 require 'shoulda'
 require 'minitest/unit'
+require 'minitest/autorun'
 require 'mocha'
 
 $:.unshift File.expand_path('../../lib', __FILE__)
 require 'garb'
 
 class MiniTest::Unit::TestCase
-  include Shoulda::InstanceMethods
-  extend Shoulda::ClassMethods
-  include Shoulda::Assertions
-  extend Shoulda::Macros
-  include Shoulda::Helpers
+  include Shoulda::Context::Assertions
+  include Shoulda::Context::InstanceMethods
+  extend Shoulda::Context::ClassMethods
 
   def read_fixture(filename)
     File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
   end
 
   def assert_data_params(expected)
-    assert_received(Garb::DataRequest, :new) {|e| e.with(Garb::Session, Garb::Model::URL, expected)}
+    assert_received(Garb::Request::Data, :new) {|e| e.with(Garb::Session, Garb::Model::URL, expected)}
   end
 end
 

data/test/unit/garb/filter_parameters_test.rb

@@ -2,65 +2,34 @@ require 'test_helper'
 
 module Garb
   class FilterParametersTest < MiniTest::Unit::TestCase
-    def self.should_define_operators(*operators)
-      operators.each do |operator|
-        should "create an operator and add to parameters for the #{operator} method" do
-          new_operator = stub
-          symbol = :foo
-
-          SymbolOperator.expects(:new).with(:bar, operator).returns(new_operator)
-          @filter_parameters.filters do
-            send(operator.to_sym, :bar, 100)
-          end
-
-          parameter = {new_operator => 100}
-          assert_equal parameter, @filter_parameters.parameters.last
-        end
-      end
-    end
-
     context "A FilterParameters" do
-      setup do
-        @filter_parameters = FilterParameters.new
-      end
-
-      should_define_operators :eql, :not_eql, :gt, :gte, :lt, :lte,
-        :matches, :does_not_match, :contains, :does_not_contain, :substring, :not_substring
-
-      should "instance eval for filters" do
-        blk = lambda {"in a block"}
-
-        @filter_parameters.expects(:instance_eval)
-        @filter_parameters.filters(&blk)
-      end
-
       context "when converting parameters hash into query string parameters" do
         should "parameterize hash operators and join elements with AND" do
-          @filter_parameters.filters do
-            eql(:city, 'New York City')
-            eql(:state, 'New York')
-          end
+          filters = FilterParameters.new({:city.eql => 'New York City', :state.eql => 'New York'})
 
           params = ['ga:city%3D%3DNew+York+City', 'ga:state%3D%3DNew+York']
-          assert_equal params, @filter_parameters.to_params['filters'].split('%3B').sort
+          assert_equal params, filters.to_params['filters'].split('%3B').sort
         end
 
         should "properly encode operators" do
-          @filter_parameters.filters do
-            contains(:page_path, 'New York')
-          end
+          filters = FilterParameters.new({:page_path.contains => 'New York'})
 
           params = {'filters' => 'ga:pagePath%3D~New+York'}
-          assert_equal params, @filter_parameters.to_params
+          assert_equal params, filters.to_params
+        end
+
+        should "escape comma, semicolon in values" do
+          filters = FilterParameters.new({:url.eql => 'this;that,thing\other'})
+
+          params = {'filters' => 'ga:url%3D%3Dthis%5C%3Bthat%5C%2Cthing%5Cother'}
+          assert_equal params, filters.to_params
         end
 
-        should "escape comma, semicolon, and backslash in values" do
-          @filter_parameters.filters do
-            eql(:url, 'this;that,thing\other')
-          end
+        should "handle nested arrays mixed with hashes" do
+          filters = FilterParameters.new([{:page_path.contains => 'NYC'}, [{:city.eql => 'New York City'}, {:state.eql => 'New York'}]])
 
-          params = {'filters' => 'ga:url%3D%3Dthis%5C%3Bthat%5C%2Cthing%5C%5Cother'}
-          assert_equal params, @filter_parameters.to_params
+          params = ['ga:pagePath%3D~NYC,ga:city%3D%3DNew+York+City,ga:state%3D%3DNew+York']
+          assert_equal params, filters.to_params['filters'].split('%3B').sort
         end
       end
     end

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

@@ -8,39 +8,31 @@ module Garb
           feed = stub(:entries => ["entry1"])
           Feed.stubs(:new).returns(feed)
 
-          Account.stubs(:new_from_entry)
+          Account.stubs(:new)
           Account.all
 
           assert_received(Feed, :new) {|e| e.with(Session, '/accounts')}
           assert_received(feed, :entries)
-          assert_received(Account, :new_from_entry) {|e| e.with("entry1", Session)}
+          assert_received(Account, :new) {|e| e.with("entry1", Session)}
         end
       end
 
       context "an Account" do
         setup do
-          entry = {
-            "title" => "Google Analytics Account Garb",
-            "link" => [{"rel" => "self", "href" => Feed::BASE_URL+"/accounts/123456"}],
-            "dxp:property" => [
-              {"name" => "ga:accountId", "value" => "123456"},
-              {"name" => "ga:accountName", "value" => "Garb"}
-            ]
-          }
-          @account = Account.new_from_entry(entry, Session)
+          entry = MultiJson.load(read_fixture("account_management.json"))['items'].first
+          @account = Account.new(entry, Session)
         end
 
-        should "extract id and title from GA entry" do
-          assert_equal "Garb", @account.title
-          assert_equal "123456", @account.id
+        should "extract id from GA entry" do
+          assert_equal "1234", @account.id
         end
 
         should "extract a name from GA entry properties" do
-          assert_equal "Garb", @account.name
+          assert_equal "www.google.com", @account.name
         end
 
         should "combine the Account.path and the id into an new path" do
-          assert_equal "/accounts/123456", @account.path
+          assert_equal "/accounts/1234", @account.path
         end
 
         should "have a reference to the session it was created with" do

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

@@ -6,28 +6,23 @@ module Garb
       context "a Feed" do
         setup do
           @request = stub
-          DataRequest.stubs(:new).returns(@request)
+          Request::Data.stubs(:new).returns(@request)
           @feed = Feed.new(Garb::Session.new, '/accounts')
         end
 
         should "have a parsed response" do
-          Crack::XML.stubs(:parse)
+          MultiJson.stubs(:load)
           @feed.stubs(:response).returns(stub(:body => 'response body'))
           @feed.parsed_response
 
-          assert_received(Crack::XML, :parse) {|e| e.with('response body')}
+          assert_received(MultiJson, :load) {|e| e.with('response body')}
         end
 
         should "have entries from the parsed response" do
-          @feed.stubs(:parsed_response).returns({'feed' => {'entry' => ['entry1', 'entry2']}})
+          @feed.stubs(:parsed_response).returns({'items' => ['entry1', 'entry2']})
           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
@@ -41,4 +36,4 @@ module Garb
       end
     end
   end
-end
+end

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

@@ -8,12 +8,12 @@ module Garb
           feed = stub(:entries => ["entry1"])
           Feed.stubs(:new).returns(feed)
 
-          Goal.stubs(:new_from_entry)
+          Goal.stubs(:new)
           Goal.all
 
           assert_received(Feed, :new) {|e| e.with(Session, '/accounts/~all/webproperties/~all/profiles/~all/goals')}
           assert_received(feed, :entries)
-          assert_received(Goal, :new_from_entry) {|e| e.with("entry1", Session)}
+          assert_received(Goal, :new) {|e| e.with("entry1", Session)}
         end
 
         should "find all goals for a given account" do
@@ -37,30 +37,16 @@ module Garb
 
       context "a Goal" do
         setup do
-          entry = {
-            "link" => [{"rel" => "self", "href" => Feed::BASE_URL+"/accounts/1189765/webproperties/UA-1189765-1/profiles/98765"}],
-            "ga:goal" => {
-              "ga:destination"=>{"caseSensitive"=>"false","expression"=>"/blog.html","matchType"=>"head"},
-              "active"=>"true",
-              "name"=>"Read Blog",
-              "number"=>"1",
-              "value"=>"10.0"
-            }
-          }
-
-          @goal = Goal.new_from_entry(entry, Session)
+          entry = MultiJson.load(read_fixture("goal_management.json"))["items"].first
+          @goal = Goal.new(entry, Session)
         end
 
         should "have a name" do
-          assert_equal "Read Blog", @goal.name
-        end
-
-        should "have a number" do
-          assert_equal 1, @goal.number
+          assert_equal "the goal", @goal.name
         end
 
         should "have a value" do
-          assert_equal 10.0, @goal.value
+          assert_equal 1.0, @goal.value
         end
 
         should "know if it is active" do
@@ -68,7 +54,7 @@ module Garb
         end
 
         should "know if it is not active" do
-          @goal.active = false
+          @goal.instance_variable_set("@active", false)
           assert_equal false, @goal.active?
         end