garb 0.4.2 → 0.5.0

data/lib/garb/filter_parameters.rb

@@ -0,0 +1,45 @@
+module Garb
+  class FilterParameters
+    def self.define_operator(key, operation)
+      class_eval <<-CODE
+        def #{key}(target, value)
+          self.parameters << {Operator.new(target, '#{operation}') => value}
+        end
+      CODE
+    end
+
+    define_operator(:eql, '==')
+    define_operator(:not_eql, '!=')
+    define_operator(:gt, '>')
+    define_operator(:gte, '>=')
+    define_operator(:lt, '<')
+    define_operator(:lte, '<=')
+    define_operator(:matches, '==')
+    define_operator(:does_not_match, '!=')
+    define_operator(:contains, '=~')
+    define_operator(:does_not_contain, '!~')
+    define_operator(:substring, '=@')
+    define_operator(:not_substring, '!@')
+
+    attr_accessor :parameters
+
+    def initialize
+      self.parameters = []
+    end
+
+    def filters(&block)
+      instance_eval &block
+    end
+
+    def to_params
+      value = self.parameters.map do |param|
+        param.map do |k,v|
+          next unless k.is_a?(Garb::Operator)
+          "#{k.target}#{URI.encode(k.operator.to_s, /[=<>]/)}#{CGI::escape(v.to_s)}"
+        end.join(',') # Hash AND
+      end.join(';') # Array OR
+
+      value.empty? ? {} : {'filters' => value}
+    end
+  end
+end

data/lib/garb/operator.rb

@@ -4,11 +4,11 @@ module Garb
     attr_reader :target, :operator, :prefix
   
     def initialize(target, operator, prefix=false)
-      @target   = target.to_google_analytics
+      @target   = Garb.to_google_analytics(target)
       @operator = operator
       @prefix = prefix
     end
-  
+
     def to_google_analytics
       @prefix ? "#{operator}#{target}" : "#{target}#{operator}"
     end

data/lib/garb/profile.rb

@@ -13,7 +13,7 @@ module Garb
       attribute :value, String
 
       def instance_name
-        name.from_google_analytics.underscore
+        Garb.from_google_analytics(name)
       end
     end
 
@@ -38,7 +38,7 @@ module Garb
     end
 
     def id
-      @table_id.from_google_analytics
+      Garb.from_google_analytics(@table_id)
     end
 
     def self.all

data/lib/garb/report.rb

@@ -15,7 +15,6 @@ module Garb
 
       metrics opts.fetch(:metrics, [])
       dimensions opts.fetch(:dimensions, [])
-      filters opts.fetch(:filters, [])
       sort opts.fetch(:sort, [])
     end
 

data/lib/garb/report_parameter.rb

@@ -18,19 +18,8 @@ module Garb
     end
     
     def to_params
-      params = self.elements.map do |elem|
-        case elem
-        when Hash
-          elem.collect do |k,v|
-            next unless k.is_a?(Operator)
-            "#{k.target}#{URI.encode(k.operator.to_s, /[=<>]/)}#{CGI::escape(v.to_s)}"
-          end.join(';')
-        else
-          elem.to_google_analytics
-        end
-      end.join(',')
-      
-      params.empty? ? {} : {self.name => params}
+      value = self.elements.map{|param| Garb.to_google_analytics(param)}.join(',')
+      value.empty? ? {} : {self.name => value}
     end
   end
 end

data/lib/garb/resource.rb

@@ -3,7 +3,7 @@ module Garb
     MONTH = 2592000
     URL = "https://www.google.com/analytics/feeds/data"
 
-    %w(metrics dimensions filters sort).each do |parameter|
+    %w(metrics dimensions sort).each do |parameter|
       class_eval <<-CODE
         def #{parameter}(*fields)
           @#{parameter} ||= ReportParameter.new(:#{parameter})
@@ -16,33 +16,15 @@ module Garb
       CODE
     end
 
-    # def metrics(*fields)
-    #   @metrics ||= ReportParameter.new(:metrics)
-    #   @metrics << fields
-    # end
-    # 
-    # def dimensions(*fields)
-    #   @dimensions ||= ReportParameter.new(:dimensions)
-    #   @dimensions << fields
-    # end
-    # 
-    # def filters(*hashes)
-    #   @filters ||= ReportParameter.new(:filters)
-    #   @filters << hashes
-    # end
-    # 
-    # def sort(*fields)
-    #   @sort ||= ReportParameter.new(:sort)
-    #   @sort << fields
-    # end
-    # 
-    # def clear_filters
-    #   @filters = ReportParameter.new(:filters)
-    # end
-    # 
-    # def clear_sort
-    #   @sort = ReportParameter.new(:sort)
-    # end
+    def filters(&block)
+      @filter_parameters ||= FilterParameters.new
+      @filter_parameters.filters(&block) if block_given?
+      @filter_parameters
+    end
+
+    def clear_filters
+      @filter_parameters = FilterParameters.new
+    end
 
     def results(profile, opts = {}, &block)
       @profile = profile.is_a?(Profile) ? profile : Profile.first(profile)

data/lib/garb/version.rb

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

data/lib/garb.rb

@@ -15,15 +15,21 @@ require 'garb/data_request'
 require 'garb/session'
 require 'garb/profile'
 require 'garb/account'
+require 'garb/filter_parameters'
 require 'garb/report_parameter'
 require 'garb/report_response'
 require 'garb/resource'
 require 'garb/report'
 require 'garb/operator'
 
-require 'extensions/string'
-require 'extensions/symbol'
-
 module Garb
   GA = "http://schemas.google.com/analytics/2008"
+  
+  def self.to_google_analytics(thing)
+    "ga:#{thing.to_s.camelize(:lower)}"
+  end
+
+  def self.from_google_analytics(thing)
+    thing.to_s.gsub(/^ga\:/, '').underscore
+  end
 end

data/test/unit/{account_test.rb → garb/account_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 AccountTest < MiniTest::Unit::TestCase

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

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '/test_helper')
+require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
 
 CA_CERT_FILE = File.join(File.dirname(__FILE__), '..', '/cacert.pem')
 

data/test/unit/{data_request_test.rb → garb/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 < MiniTest::Unit::TestCase

data/test/unit/garb/filter_parameters_test.rb

@@ -0,0 +1,65 @@
+require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
+
+module Garb
+  class FilterParametersTest < MiniTest::Unit::TestCase
+    def self.should_define_operator(operator, param)
+      should "create an operator and add to parameters for the #{operator} method" do
+        new_operator = stub
+        symbol = :foo
+
+        Garb::Operator.expects(:new).with(:foo, param).returns(new_operator)
+        @filter_parameters.send(operator.to_sym, :foo, 100)
+
+        parameter = {new_operator => 100}
+        assert_equal parameter, @filter_parameters.parameters.last
+      end
+    end
+
+    context "A FilterParameters" do
+      setup do
+        @filter_parameters = FilterParameters.new
+      end
+
+      should_define_operator(:eql, '==')
+      should_define_operator(:not_eql, '!=')
+      should_define_operator(:gt, '>')
+      should_define_operator(:gte, '>=')
+      should_define_operator(:lt, '<')
+      should_define_operator(:lte, '<=')
+      should_define_operator(:matches, '==')
+      should_define_operator(:does_not_match, '!=')
+      should_define_operator(:contains, '=~')
+      should_define_operator(:does_not_contain, '!~')
+      should_define_operator(:substring, '=@')
+      should_define_operator(: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" do
+          @filter_parameters.filters do
+            eql(:city, 'New York')
+            eql(:state, 'New York')
+          end
+
+          params = {'filters' => 'ga:city%3D%3DNew+York;ga:state%3D%3DNew+York'}
+          assert_equal params, @filter_parameters.to_params
+        end
+
+        should "properly encode operators" do
+          @filter_parameters.filters do
+            contains(:request_uri, 'New York')
+          end
+
+          params = {'filters' => 'ga:requestUri%3D~New+York'}
+          assert_equal params, @filter_parameters.to_params
+        end
+      end
+    end
+  end
+end

data/test/unit/{oauth_session_test.rb → garb/oauth_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 OAuthSessionTest < MiniTest::Unit::TestCase

data/test/unit/{operator_test.rb → garb/operator_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 OperatorTest < MiniTest::Unit::TestCase
@@ -6,21 +6,21 @@ module Garb
       should "lower camelize the target" do
         assert_equal "ga:uniqueVisits=", Operator.new(:unique_visits, "=").to_google_analytics
       end
-    
+
       should "return target and operator together" do
         assert_equal "ga:metric=", Operator.new(:metric, "=").to_google_analytics
       end
-    
+
       should "prefix the operator to the target" do
         assert_equal "-ga:metric", Operator.new(:metric, "-", true).to_google_analytics
       end
-    
+
       should "know if it is equal to another operator" do
         op1 = Operator.new(:hello, "==")
         op2 = Operator.new(:hello, "==")
         assert_equal op1, op2
       end
-    
+
       should "not be equal to another operator if target, operator, or prefix is different" do
         op1 = Operator.new(:hello, "==")
         op2 = Operator.new(:hello, "==", true)
@@ -36,4 +36,4 @@ module Garb
       end
     end
   end
-end
+end

data/test/unit/{profile_test.rb → garb/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 < MiniTest::Unit::TestCase

data/test/unit/{report_parameter_test.rb → garb/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 < MiniTest::Unit::TestCase
@@ -36,25 +36,6 @@ module Garb
           @metrics << :request_uri << :city
           assert_equal({'metrics' => 'ga:requestUri,ga:city'}, @metrics.to_params)
         end
-        
-        should "join operator elements" do
-          @metrics << :city.desc
-          assert_equal({'metrics' => '-ga:city'}, @metrics.to_params)
-        end
-        
-        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
     end
     

data/test/unit/{report_response_test.rb → garb/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 < MiniTest::Unit::TestCase
     context "An instance of the ReportResponse class" do
       setup do
-        @xml = File.read(File.join(File.dirname(__FILE__), '..', "/fixtures/report_feed.xml"))
+        @xml = File.read(File.join(File.dirname(__FILE__), '..', '..', "/fixtures/report_feed.xml"))
         @response = ReportResponse.new(@xml)
       end
       

data/test/unit/{report_test.rb → garb/report_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '/test_helper')
+require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
 
 module Garb
   # Also tests Garb::Resource, which is the basis for Garb::Report
@@ -11,7 +11,7 @@ module Garb
         @report = Report.new(@profile)
       end
 
-      %w(metrics dimensions filters sort).each do |param|
+      %w(metrics dimensions sort).each do |param|
         should "have parameters for #{param}" do
           assert @report.send(:"#{param}").is_a?(ReportParameter)
         end
@@ -21,6 +21,14 @@ module Garb
         end
       end
 
+      should "have filter parameters for filters" do
+        assert @report.filters.is_a?(FilterParameters)
+      end
+
+      should "clear filter parameters for filters" do
+        assert_equal({}, @report.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'}

data/test/unit/{resource_test.rb → garb/resource_test.rb}

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), '..', '/test_helper')
+require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
 
 class TestReport
   extend Garb::Resource

data/test/unit/{session_test.rb → garb/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 < MiniTest::Unit::TestCase

data/test/unit/garb_test.rb

@@ -1,9 +1,13 @@
 require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 class GarbTest < MiniTest::Unit::TestCase
-  context "A green egg" do
-    should "be served with ham" do
-      assert true
+  context "The Garb module" do
+    should 'prefix a string with ga: for GA' do
+      assert_equal 'ga:bob', Garb.to_google_analytics('bob')
     end
-  end  
-end
+
+    should 'remove ga: prefix' do
+      assert_equal 'bob', Garb.from_google_analytics('ga:bob')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: garb
 version: !ruby/object:Gem::Version 
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors: 
 - Tony Pitale
@@ -44,11 +44,10 @@ extra_rdoc_files: []
 files: 
 - README.md
 - Rakefile
-- lib/extensions/string.rb
-- lib/extensions/symbol.rb
 - lib/garb/account.rb
 - lib/garb/authentication_request.rb
 - lib/garb/data_request.rb
+- lib/garb/filter_parameters.rb
 - lib/garb/oauth_session.rb
 - lib/garb/operator.rb
 - lib/garb/profile.rb
@@ -64,20 +63,19 @@ files:
 - test/fixtures/profile_feed.xml
 - test/fixtures/report_feed.xml
 - test/test_helper.rb
-- test/unit/account_test.rb
-- test/unit/authentication_request_test.rb
-- test/unit/data_request_test.rb
+- test/unit/garb/account_test.rb
+- test/unit/garb/authentication_request_test.rb
+- test/unit/garb/data_request_test.rb
+- test/unit/garb/filter_parameters_test.rb
+- test/unit/garb/oauth_session_test.rb
+- test/unit/garb/operator_test.rb
+- test/unit/garb/profile_test.rb
+- test/unit/garb/report_parameter_test.rb
+- test/unit/garb/report_response_test.rb
+- test/unit/garb/report_test.rb
+- test/unit/garb/resource_test.rb
+- test/unit/garb/session_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: true
 homepage: http://github.com/vigetlabs/garb
 licenses: []
@@ -111,17 +109,16 @@ test_files:
 - test/fixtures/profile_feed.xml
 - test/fixtures/report_feed.xml
 - test/test_helper.rb
-- test/unit/account_test.rb
-- test/unit/authentication_request_test.rb
-- test/unit/data_request_test.rb
+- test/unit/garb/account_test.rb
+- test/unit/garb/authentication_request_test.rb
+- test/unit/garb/data_request_test.rb
+- test/unit/garb/filter_parameters_test.rb
+- test/unit/garb/oauth_session_test.rb
+- test/unit/garb/operator_test.rb
+- test/unit/garb/profile_test.rb
+- test/unit/garb/report_parameter_test.rb
+- test/unit/garb/report_response_test.rb
+- test/unit/garb/report_test.rb
+- test/unit/garb/resource_test.rb
+- test/unit/garb/session_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/lib/extensions/string.rb

@@ -1,9 +0,0 @@
-class String
-  def to_google_analytics
-    "ga:#{self}"
-  end
-
-  def from_google_analytics
-    self.gsub(/^ga\:/, '')
-  end
-end

data/lib/extensions/symbol.rb

@@ -1,36 +0,0 @@
-class Symbol
-  # OPERATORS
-
-  def self.operator(operators)
-    operators.each do |method, operator|
-      class_eval <<-CODE
-        def #{method}
-          Garb::Operator.new(self, '#{operator}')
-        end
-      CODE
-    end
-  end
-
-  # Sorting
-  def desc
-    Garb::Operator.new(self, '-', true)
-  end
-
-  operator  :eql => '==',
-            :not_eql => '!=',
-            :gt => '>',
-            :gte => '>=',
-            :lt => '<',
-            :lte => '<=',
-            :matches => '==',
-            :does_not_match => '!=',
-            :contains => '=~',
-            :does_not_contain => '!~',
-            :substring => '=@',
-            :not_substring => '!@'
-
-  # Metric filters  
-  def to_google_analytics
-    self.to_s.camelize(:lower).to_google_analytics
-  end
-end

data/test/unit/string_test.rb

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

data/test/unit/symbol_test.rb

@@ -1,44 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', '/test_helper')
-
-class SymbolTest < MiniTest::Unit::TestCase
-  
-  context "An instance of the Symbol class" do
-    
-    should "properly format itself for ga" do
-      assert_equal "ga:requestUri", :request_uri.to_google_analytics
-    end
-    
-    should "define a :desc operator" do
-      operator = stub()
-      symbol = :foo
-      
-      Garb::Operator.expects(:new).with(:foo, '-', true).returns(operator)
-      assert_equal operator, :foo.desc
-    end
-
-    def self.should_define_operator(operators)
-      operators.each do |method, operator|
-        should "define an :#{method} operator" do
-          new_operator = stub()
-          symbol = :foo
-
-          Garb::Operator.expects(:new).with(:foo, operator).returns(new_operator)
-          assert_equal new_operator, :foo.send(method)
-        end
-      end
-    end
-
-    should_define_operator  :eql => '==',
-                            :not_eql => '!=',
-                            :gt => '>',
-                            :gte => '>=',
-                            :lt => '<',
-                            :lte => '<=',
-                            :matches => '==',
-                            :does_not_match => '!=',
-                            :contains => '=~',
-                            :does_not_contain => '!~',
-                            :substring => '=@',
-                            :not_substring => '!@'
-  end
-end