garb 0.3.2 → 0.4.0

data/README.md

@@ -8,11 +8,25 @@ garb
 Important Changes
 =================
 
-  Version 0.2.4 requires happymapper from rubygems, version 0.2.5. Be sure to update.
+Version 0.4.0
+  
+  * Changes the api for filters and sort making it consistent with metrics/dimensions
+  * If you wish to clear the defaults defined on a class, you may use clear_(filters/sort/metrics/dimensions)
+  * To make a custom class using Garb::Resource, you must now extend instead of include the module
+
+Version 0.3.2
+
+  * adds Profile.first which can be used to get the first profile with a table id, or web property id (UA number)
+
+Version 0.2.4
+
+  * requires happymapper from rubygems, version 0.2.5. Be sure to update.
 
-  Version 0.2.0 makes major changes (compared to 0.1.0) to the way garb is used to build reports.
-  There is now both a module that gets included for generating defined classes,
-  as well as, slight changes to the way that the Report class can be used.
+Version 0.2.0
+
+  * makes major changes (compared to 0.1.0) to the way garb is used to build reports.
+  * There is now both a module that gets included for generating defined classes,
+  * slight changes to the way that the Report class can be used.
 
 Description
 -----------
@@ -38,6 +52,8 @@ Profiles
 
     > Garb::Account.first.profiles
     
+    > Garb::Profile.first('UA-XXXX-XX')
+    
     > Garb::Profile.all
     > profile = Garb::Profile.all.first
 
@@ -45,14 +61,16 @@ Define a Report Class and Get Results
 -------------------------------------
 
     class Exits
-      include Garb::Resource
+      extend Garb::Resource
 
       metrics :exits, :pageviews, :exit_rate
-      dimensions :request_uri
+      dimensions :page_path
+      filters :page_path => 'season'
+      sort :exits
     end
 
-Parameters
-----------
+Other Parameters
+----------------
 
   * start_date: The date of the period you would like this report to start
   * end_date: The date to end, inclusive
@@ -86,7 +104,7 @@ Building a Report
   Or, with sorting and filters:
 
     Exits.results(profile, :limit => 10, :offset => 19) do
-      filter :request_uri.contains => 'season', :exits.gt => 100
+      filters :request_uri.contains => 'season', :exits.gt => 100
       sort :exits
     end
 
@@ -96,10 +114,11 @@ Build a One-Off Report
 ----------------------
 
     report = Garb::Report.new(profile)
-    report.metrics :pageviews
-    report.dimensions :request_uri
+    report.metrics :pageviews, :exits
+    report.dimensions :page_path
 
-    report.filter :request_uri.contains => 'season', :exits.gte => 10
+    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.results
@@ -159,22 +178,17 @@ TODOS
   * Single user login is the only supported method currently.
     Intend to add hooks for using OAuth
   * Read opensearch header in results
-  * OR joining filter parameters
 
 Requirements
 ------------
 
-  happymapper >= 0.2.5 (should also install libxml)
+  happymapper >= 0.3.0 (should also install libxml)
 
 Install
 -------
 
     sudo gem install garb
 
-    OR
-
-    sudo gem install vigetlabs-garb -s http://gems.github.com
-
 License
 -------
 

data/lib/garb.rb

@@ -24,48 +24,5 @@ require 'extensions/symbol'
 require 'extensions/array'
 
 module Garb
-  # :stopdoc:
   GA = "http://schemas.google.com/analytics/2008"
-
-  VERSION = '0.1.2'
-  LIBPATH = ::File.expand_path(::File.dirname(__FILE__)) + ::File::SEPARATOR
-  PATH = ::File.dirname(LIBPATH) + ::File::SEPARATOR
-  # :startdoc:
-
-  # Returns the version string for the library.
-  #
-  def self.version
-    VERSION
-  end
-
-  # Returns the library path for the module. If any arguments are given,
-  # they will be joined to the end of the libray path using
-  # <tt>File.join</tt>.
-  #
-  def self.libpath( *args )
-    args.empty? ? LIBPATH : ::File.join(LIBPATH, args.flatten)
-  end
-
-  # Returns the lpath for the module. If any arguments are given,
-  # they will be joined to the end of the path using
-  # <tt>File.join</tt>.
-  #
-  def self.path( *args )
-    args.empty? ? PATH : ::File.join(PATH, args.flatten)
-  end
-
-  # Utility method used to rquire all files ending in .rb that lie in the
-  # directory below this file that has the same name as the filename passed
-  # in. Optionally, a specific _directory_ name can be passed in such that
-  # the _filename_ does not have to be equivalent to the directory.
-  #
-  def self.require_all_libs_relative_to( fname, dir = nil )
-    dir ||= ::File.basename(fname, '.*')
-    search_me = ::File.expand_path(
-        ::File.join(::File.dirname(fname), dir, '*', '*.rb'))
-
-    Dir.glob(search_me).sort.each {|rb| require rb}
-  end
-end  # module Garb
-
-# EOF
+end

data/lib/garb/profile.rb

@@ -1,7 +1,7 @@
 module Garb
   class Profile
     
-    attr_reader :table_id, :title, :account_name, :account_id
+    attr_reader :table_id, :title, :account_name, :account_id, :web_property_id
     
     class Property
       include HappyMapper

data/lib/garb/report.rb

@@ -1,6 +1,6 @@
 module Garb
   class Report
-    include Resource::ResourceMethods
+    include Resource
 
     MONTH = 2592000
     URL = "https://www.google.com/analytics/feeds/data"
@@ -13,13 +13,9 @@ module Garb
       @limit = opts.fetch(:limit, nil)
       @offset = opts.fetch(:offset, nil)
 
-      # clear filters and sort
-      @filters = ReportParameter.new(:filters)
-      @sorts = ReportParameter.new(:sort)
-
       metrics opts.fetch(:metrics, [])
       dimensions opts.fetch(:dimensions, [])
-      filter opts.fetch(:filter, [])
+      filters opts.fetch(:filters, [])
       sort opts.fetch(:sort, [])
     end
 

data/lib/garb/resource.rb

@@ -3,87 +3,90 @@ module Garb
     MONTH = 2592000
     URL = "https://www.google.com/analytics/feeds/data"
 
-    def self.included(report)
-      report.extend(ResourceMethods)
-    end
-
-    module ResourceMethods
-
-      def metrics(*fields)
-        @metrics ||= ReportParameter.new(:metrics)
-        @metrics << fields
-      end
-
-      def dimensions(*fields)
-        @dimensions ||= ReportParameter.new(:dimensions)
-        @dimensions << fields
-      end
-
-      def filter(*hash)
-        @filters << hash
-      end
-
-      def filters
-        @filters ||= ReportParameter.new(:filters)
-      end
-
-      def sort(*fields)
-        @sorts << fields
-      end
-
-      def sorts
-        @sorts ||= ReportParameter.new(:sort)
-      end
-
-      def results(profile, opts = {}, &block)
-        @profile = profile
-
-        # clear filters and sort
-        @filters = ReportParameter.new(:filters)
-        @sorts = ReportParameter.new(:sort)
-
-        @start_date = opts.fetch(:start_date, Time.now - MONTH)
-        @end_date = opts.fetch(:end_date, Time.now)
-        @limit = opts.fetch(:limit, nil)
-        @offset = opts.fetch(:offset, nil)
-
-        instance_eval(&block) if block_given?
+    %w(metrics dimensions filters sort).each do |parameter|
+      class_eval <<-CODE
+        def #{parameter}(*fields)
+          @#{parameter} ||= ReportParameter.new(:#{parameter})
+          @#{parameter} << fields
+        end
 
-        ReportResponse.new(send_request_for_body).results
-      end
+        def clear_#{parameter}
+          @#{parameter} = ReportParameter.new(:#{parameter})
+        end
+      CODE
+    end
 
-      def page_params
-        {'max-results' => @limit, 'start-index' => @offset}.reject{|k,v| v.nil?}
-      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 results(profile, opts = {}, &block)
+      @profile = profile.is_a?(Profile) ? profile : Profile.first(profile)
+
+      @start_date = opts.fetch(:start_date, Time.now - MONTH)
+      @end_date = opts.fetch(:end_date, Time.now)
+      @limit = opts.fetch(:limit, nil)
+      @offset = opts.fetch(:offset, nil)
+
+      instance_eval(&block) if block_given?
+
+      ReportResponse.new(send_request_for_body).results
+    end
 
-      def default_params
-        {'ids' => @profile.table_id,
-          'start-date' => format_time(@start_date),
-          'end-date' => format_time(@end_date)}
-      end
+    def page_params
+      {'max-results' => @limit, 'start-index' => @offset}.reject{|k,v| v.nil?}
+    end
 
-      def params
-        [
-          metrics.to_params,
-          dimensions.to_params,
-          sorts.to_params,
-          filters.to_params,
-          page_params
-        ].inject(default_params) do |p, i|
-          p.merge(i)
-        end
-      end
+    def default_params
+      {'ids' => @profile.table_id,
+        'start-date' => format_time(@start_date),
+        'end-date' => format_time(@end_date)}
+    end
 
-      def format_time(t)
-        t.strftime('%Y-%m-%d')
+    def params
+      [
+        metrics.to_params,
+        dimensions.to_params,
+        sort.to_params,
+        filters.to_params,
+        page_params
+      ].inject(default_params) do |p, i|
+        p.merge(i)
       end
+    end
 
-      def send_request_for_body
-        request = DataRequest.new(URL, params)
-        response = request.send_request
-        response.body
-      end
+    def format_time(t)
+      t.strftime('%Y-%m-%d')
+    end
 
+    def send_request_for_body
+      request = DataRequest.new(URL, params)
+      response = request.send_request
+      response.body
     end
   end
 end

data/lib/garb/session.rb

@@ -1,19 +1,13 @@
 module Garb
-  class Session
+  module Session
+    extend self
+
+    attr_accessor :auth_token, :email
     
-    def self.login(email, password, opts={})
-      @email = email
+    def login(email, password, opts={})
+      self.email = email
       auth_request = AuthenticationRequest.new(email, password, opts)
-      @auth_token = auth_request.auth_token(opts)
-    end
-
-    def self.auth_token
-      @auth_token
+      self.auth_token = auth_request.auth_token(opts)
     end
-
-    def self.email
-      @email
-    end
-
   end
 end

data/lib/garb/version.rb

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

data/test/unit/report_test.rb

@@ -11,10 +11,14 @@ module Garb
         @report = Report.new(@profile)
       end
 
-      %w(metrics dimensions filters sorts).each do |param|
+      %w(metrics dimensions filters sort).each do |param|
         should "have parameters for #{param}" do
           assert @report.send(:"#{param}").is_a?(ReportParameter)
         end
+
+        should "clear parameters for #{param}" do
+          assert_equal({}, @report.send(:"clear_#{param}").to_params)
+        end
       end
 
       should "have default parameters" do
@@ -27,7 +31,7 @@ module Garb
         @report.stubs(:metrics).returns(stub(:to_params => {'metrics' => 6}))
         @report.stubs(:dimensions).returns(stub(:to_params => {'dimensions' => 5}))
         @report.stubs(:filters).returns(stub(:to_params => {'filters' => 4}))
-        @report.stubs(:sorts).returns(stub(:to_params => {'sort' => 3}))
+        @report.stubs(:sort).returns(stub(:to_params => {'sort' => 3}))
         @report.stubs(:page_params).returns({'page_params' => 2})
         @report.stubs(:default_params).returns({'default_params' => 1})
         

data/test/unit/resource_test.rb

@@ -1,7 +1,7 @@
 require File.join(File.dirname(__FILE__), '..', '/test_helper')
 
 class TestReport
-  include Garb::Resource
+  extend Garb::Resource
 end
 
 # Most of the resource testing is done as a part of ReportTest
@@ -9,11 +9,11 @@ class ResourceTest < MiniTest::Unit::TestCase
 
   context "A class with Garb::Resource mixed in" do
     should "get results from GA" do
-      profile = stub
+      profile = stub(:is_a? => true)
       TestReport.expects(:send_request_for_body).returns('xml')
       Garb::ReportResponse.expects(:new).with('xml').returns(mock(:results => 'analytics'))
 
       assert_equal 'analytics', TestReport.results(profile)
     end
   end
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: garb
 version: !ruby/object:Gem::Version 
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors: 
 - Tony Pitale