garb 0.5.0 → 0.5.1

data/README.md

@@ -8,6 +8,11 @@ garb
 Important Changes
 =================
 
+Version 0.5.0
+
+  * Filters now have a new DSL so that I could toss Symbol operators (which conflict with DataMapper and MongoMapper)
+  * The method of passing a hash to filters no longer works, at all
+
 Version 0.4.0
   
   * Changes the api for filters and sort making it consistent with metrics/dimensions
@@ -65,8 +70,11 @@ Define a Report Class and Get Results
 
       metrics :exits, :pageviews, :exit_rate
       dimensions :page_path
-      filters :page_path => 'season'
       sort :exits
+
+      filters do
+        eql(:page_path, 'season')
+      end
     end
 
 Other Parameters
@@ -104,8 +112,12 @@ Building a Report
   Or, with sorting and filters:
 
     Exits.results(profile, :limit => 10, :offset => 19) do
-      filters :request_uri.contains => 'season', :exits.gt => 100
       sort :exits
+
+      filters do
+        contains(:page_path, 'season')
+        gt(:exits, 100)
+      end
     end
 
   reports will be an array of OpenStructs with methods for the metrics and dimensions returned.
@@ -116,11 +128,13 @@ Build a One-Off Report
     report = Garb::Report.new(profile)
     report.metrics :pageviews, :exits
     report.dimensions :page_path
-
-    report.filters :page_path.contains => 'season', :exits.gte => 10 # AND'd together
-    report.filters :page_path.contains => 'greeting' # OR'd with previous filters
     report.sort :exits
 
+    report.filters do
+      contains(:page_path, 'season')
+      gte(:exits, 10)
+    and
+
     report.results
 
 Filtering
@@ -156,7 +170,9 @@ Filtering
     
   Given the previous example one-off report, we can add a line for filter:
   
-    report.filters << {:request_uri.eql => '/extend/effectively-using-git-with-subversion/'}
+    report.filters do
+      eql(:page_path, '/extend/effectively-using-git-with-subversion/')
+    end
 
 SSL
 ---
@@ -183,6 +199,7 @@ Requirements
 ------------
 
   happymapper >= 0.3.0 (should also install libxml)
+  active_support >= 2.3.0
 
 Install
 -------

data/lib/garb.rb

@@ -20,12 +20,15 @@ require 'garb/report_parameter'
 require 'garb/report_response'
 require 'garb/resource'
 require 'garb/report'
-require 'garb/operator'
+
+require 'support'
 
 module Garb
   GA = "http://schemas.google.com/analytics/2008"
   
   def self.to_google_analytics(thing)
+    return thing.to_google_analytics if thing.respond_to?(:to_google_analytics)
+
     "ga:#{thing.to_s.camelize(:lower)}"
   end
 

data/lib/garb/authentication_request.rb

@@ -1,15 +1,15 @@
 module Garb
   class AuthenticationRequest
     class AuthError < StandardError;end
-    
+
     URL = 'https://www.google.com/accounts/ClientLogin'
-    
+
     def initialize(email, password, opts={})
       @email = email
       @password = password
       @account_type = opts.fetch(:account_type, 'HOSTED_OR_GOOGLE')
     end
-    
+
     def parameters
       {
         'Email'       => @email,
@@ -23,7 +23,7 @@ module Garb
     def uri
       URI.parse(URL)
     end
-    
+
     def send_request(ssl_mode)
       http = Net::HTTP.new(uri.host, uri.port)
       http.use_ssl = true

data/lib/garb/filter_parameters.rb

@@ -1,25 +1,17 @@
 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
+    def self.define_operators(*methods)
+      methods.each do |method|
+        class_eval <<-CODE
+          def #{method}(field, value)
+            self.parameters << {SymbolOperator.new(field, :#{method}) => value}
+          end
+        CODE
+      end
     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, '!@')
+    define_operators :eql, :not_eql, :gt, :gte, :lt, :lte, :matches,
+      :does_not_match, :contains, :does_not_contain, :substring, :not_substring
 
     attr_accessor :parameters
 
@@ -34,8 +26,8 @@ module Garb
     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)}"
+          next unless k.is_a?(SymbolOperator)
+          "#{URI.encode(k.to_google_analytics, /[=<>]/)}#{CGI::escape(v.to_s)}"
         end.join(',') # Hash AND
       end.join(';') # Array OR
 

data/lib/garb/report_parameter.rb

@@ -22,4 +22,4 @@ module Garb
       value.empty? ? {} : {self.name => value}
     end
   end
-end
+end

data/lib/garb/resource.rb

@@ -16,8 +16,13 @@ module Garb
       CODE
     end
 
-    def filters(&block)
+    def filters(*hashes, &block)
       @filter_parameters ||= FilterParameters.new
+
+      hashes.each do |hash|
+        @filter_parameters.parameters << hash
+      end
+
       @filter_parameters.filters(&block) if block_given?
       @filter_parameters
     end

data/lib/garb/version.rb

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

data/lib/support.rb

@@ -0,0 +1,39 @@
+class SymbolOperator
+  def initialize(field, operator)
+    @field, @operator = field, operator
+  end unless method_defined?(:initialize)
+
+  def to_google_analytics
+    operators = {
+      :eql => '==',
+      :not_eql => '!=',
+      :gt => '>',
+      :gte => '>=',
+      :lt => '<',
+      :lte => '<=',
+      :matches => '==',
+      :does_not_match => '!=',
+      :contains => '=~',
+      :does_not_contain => '!~',
+      :substring => '=@',
+      :not_substring => '!@',
+      :desc => '-'
+    }
+
+    target = Garb.to_google_analytics(@field)
+    operator = operators[@operator]
+
+    @operator == :desc ? "#{operator}#{target}" : "#{target}#{operator}"
+  end
+end
+
+class Symbol
+  [:eql, :not_eql, :gt, :gte, :lt, :lte, :desc,
+    :matches, :does_not_match, :contains, :does_not_contain,
+    :substring, :not_substring].each do |operator|
+
+    define_method(operator) do
+      SymbolOperator.new(self, operator)
+    end unless method_defined?(operator)
+  end
+end

data/test/test_helper.rb

@@ -8,7 +8,7 @@ require 'mocha'
 require File.dirname(__FILE__) + '/../lib/garb'
 
 class MiniTest::Unit::TestCase
-  
+
   def read_fixture(filename)
     File.read(File.dirname(__FILE__) + "/fixtures/#{filename}")
   end

data/test/unit/garb/filter_parameters_test.rb

@@ -2,16 +2,18 @@ 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
+    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
 
-        Garb::Operator.expects(:new).with(:foo, param).returns(new_operator)
-        @filter_parameters.send(operator.to_sym, :foo, 100)
+          SymbolOperator.expects(:new).with(:bar, operator).returns(new_operator)
+          @filter_parameters.send(operator.to_sym, :bar, 100)
 
-        parameter = {new_operator => 100}
-        assert_equal parameter, @filter_parameters.parameters.last
+          parameter = {new_operator => 100}
+          assert_equal parameter, @filter_parameters.parameters.last
+        end
       end
     end
 
@@ -20,18 +22,8 @@ module Garb
         @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_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"}
@@ -53,10 +45,10 @@ module Garb
 
         should "properly encode operators" do
           @filter_parameters.filters do
-            contains(:request_uri, 'New York')
+            contains(:page_path, 'New York')
           end
 
-          params = {'filters' => 'ga:requestUri%3D~New+York'}
+          params = {'filters' => 'ga:pagePath%3D~New+York'}
           assert_equal params, @filter_parameters.to_params
         end
       end

data/test/unit/garb/report_parameter_test.rb

@@ -17,24 +17,24 @@ module Garb
       end
       
       should "be able to add new elements" do
-        assert_equal(@metrics, @metrics << :request_uri)
-        assert_equal [:request_uri], @metrics.elements
+        assert_equal(@metrics, @metrics << :page_path)
+        assert_equal [:page_path], @metrics.elements
       end
       
       should "merge an array of elements" do
-        assert_equal(@metrics, @metrics << [:request_uri])
-        assert_equal [:request_uri], @metrics.elements
+        assert_equal(@metrics, @metrics << [:page_path])
+        assert_equal [:page_path], @metrics.elements
       end
 
       context "converting to params" do
         should "be able to format the parameters into strings" do
-          @metrics << :request_uri
-          assert_equal({'metrics' => 'ga:requestUri'}, @metrics.to_params)
+          @metrics << :page_path
+          assert_equal({'metrics' => 'ga:pagePath'}, @metrics.to_params)
         end
 
         should "join multiple symbol elements" do
-          @metrics << :request_uri << :city
-          assert_equal({'metrics' => 'ga:requestUri,ga:city'}, @metrics.to_params)
+          @metrics << :page_path << :city
+          assert_equal({'metrics' => 'ga:pagePath,ga:city'}, @metrics.to_params)
         end
       end
     end

data/test/unit/garb/report_test.rb

@@ -25,8 +25,16 @@ module Garb
         assert @report.filters.is_a?(FilterParameters)
       end
 
+      should "add new filters to filter parameters" do
+        @report.clear_filters
+        hash = {:thing.gt => 'val'}
+        @report.filters hash
+
+        assert_equal hash, @report.filters.parameters.first
+      end
+
       should "clear filter parameters for filters" do
-        assert_equal({}, @report.filters.to_params)
+        assert_equal({}, @report.clear_filters.to_params)
       end
 
       should "have default parameters" do

data/test/unit/garb_test.rb

@@ -3,6 +3,7 @@ require File.join(File.dirname(__FILE__), '..', '/test_helper')
 class GarbTest < MiniTest::Unit::TestCase
   context "The Garb module" do
     should 'prefix a string with ga: for GA' do
+      assert_equal '-ga:bob', Garb.to_google_analytics(stub(:to_google_analytics => '-ga:bob'))
       assert_equal 'ga:bob', Garb.to_google_analytics('bob')
     end
 

data/test/unit/symbol_operator_test.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), '..', '/test_helper')
+
+class SymbolOperatorTest < MiniTest::Unit::TestCase
+  context "An instance of a SymbolOperator" do
+    should "lower camelize the target" do
+      assert_equal "ga:uniqueVisits==", SymbolOperator.new(:unique_visits, :eql).to_google_analytics
+    end
+
+    should "return target and operator together" do
+      assert_equal "ga:metric==", SymbolOperator.new(:metric, :eql).to_google_analytics
+    end
+
+    should "prefix the operator to the target" do
+      assert_equal "-ga:metric", SymbolOperator.new(:metric, :desc).to_google_analytics
+    end
+
+    # should "know if it is equal to another operator" do
+    #   op1 = SymbolOperator.new(:hello, "==")
+    #   op2 = SymbolOperator.new(:hello, "==")
+    #   assert_equal op1, op2
+    # end
+    # 
+    # should "not be equal to another operator if target, operator, or prefix is different" do
+    #   op1 = SymbolOperator.new(:hello, "==")
+    #   op2 = SymbolOperator.new(:hello, "==", true)
+    #   refute_equal op1, op2
+    # 
+    #   op1 = SymbolOperator.new(:hello1, "==")
+    #   op2 = SymbolOperator.new(:hello2, "==")
+    #   refute_equal op1, op2
+    # 
+    #   op1 = SymbolOperator.new(:hello, "!=")
+    #   op2 = SymbolOperator.new(:hello, "==")
+    #   refute_equal op1, op2
+    # end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: garb
 version: !ruby/object:Gem::Version 
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors: 
 - Tony Pitale
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-22 00:00:00 -05:00
+date: 2010-01-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,7 +49,6 @@ files:
 - lib/garb/data_request.rb
 - lib/garb/filter_parameters.rb
 - lib/garb/oauth_session.rb
-- lib/garb/operator.rb
 - lib/garb/profile.rb
 - lib/garb/profile_array.rb
 - lib/garb/report.rb
@@ -59,6 +58,7 @@ files:
 - lib/garb/session.rb
 - lib/garb/version.rb
 - lib/garb.rb
+- lib/support.rb
 - test/fixtures/cacert.pem
 - test/fixtures/profile_feed.xml
 - test/fixtures/report_feed.xml
@@ -68,7 +68,6 @@ files:
 - 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
@@ -76,7 +75,8 @@ files:
 - test/unit/garb/resource_test.rb
 - test/unit/garb/session_test.rb
 - test/unit/garb_test.rb
-has_rdoc: true
+- test/unit/symbol_operator_test.rb
+has_rdoc: false
 homepage: http://github.com/vigetlabs/garb
 licenses: []
 
@@ -114,7 +114,6 @@ test_files:
 - 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
@@ -122,3 +121,4 @@ test_files:
 - test/unit/garb/resource_test.rb
 - test/unit/garb/session_test.rb
 - test/unit/garb_test.rb
+- test/unit/symbol_operator_test.rb

data/lib/garb/operator.rb

@@ -1,22 +0,0 @@
-# Concept from dm-core
-module Garb
-  class Operator
-    attr_reader :target, :operator, :prefix
-  
-    def initialize(target, operator, prefix=false)
-      @target   = Garb.to_google_analytics(target)
-      @operator = operator
-      @prefix = prefix
-    end
-
-    def to_google_analytics
-      @prefix ? "#{operator}#{target}" : "#{target}#{operator}"
-    end
-  
-    def ==(rhs)
-      target == rhs.target &&
-      operator == rhs.operator &&
-      prefix == rhs.prefix
-    end
-  end
-end

data/test/unit/garb/operator_test.rb

@@ -1,39 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', '..', '/test_helper')
-
-module Garb
-  class OperatorTest < MiniTest::Unit::TestCase
-    context "An instance of an Operator" do
-      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)
-        refute_equal op1, op2
-      
-        op1 = Operator.new(:hello1, "==")
-        op2 = Operator.new(:hello2, "==")
-        refute_equal op1, op2
-      
-        op1 = Operator.new(:hello, "!=")
-        op2 = Operator.new(:hello, "==")
-        refute_equal op1, op2
-      end
-    end
-  end
-end