garb 0.9.1 → 0.9.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f5abc6c78a276a4e48842d665234cf8d16ab5bc
+  data.tar.gz: 1e2bc9ad76235027b818e4d16f53cf28a8b19ef7
+SHA512:
+  metadata.gz: d02e72f9733c7b1d36c69020b3b4e7294290719eb3fccc38297303a4a7fa51343592df163075434d2844ed60a21d45d777e3c307e358c417ece0f61bad49640e
+  data.tar.gz: 855bcfeaa85559b085deb284a18f6acddf5f79c7c7edf71394bfdde3ed6bb8b4d7c906395040cb7941e5a7ee71ee6c0aeb6f48707bef82af3306bca5a8cacc80

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+coverage
+pkg

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode
+

data/CHANGELOG.md

@@ -0,0 +1,95 @@
+Version 0.9.7
+
+  * Fixed bug causing Garb::Model#all_results to return nil if no limit provided
+  * Don't error out if goal Destination is missing steps
+  * Fixed "undefined method `map' for nil:NilClass" [#7]
+  * Single user requests supports fibers with `Garb.use_fibers = true` [#6]
+  * Made Garb::ResultSet comparable
+
+Version 0.9.6
+
+  * Swapped Yajl/JSON for MultiJson
+  * Fixed "NameError: uninitialized constant Forwardable"
+  * Updated README
+
+Version 0.9.5
+
+  * Moved all Garb::*Error classes to separate file
+  * Made all Garb::*Error classes inherit from Garb::Error
+  * Fixed couple of outstanding failing tests
+  * CA_CERT_FILE -> Garb.ca_cert_file
+  * API key as an element of the session
+  * Added `Garb.logger` module attribute
+  * Logs responses coming from GAPI (if logger set)
+  * Adds open_timeout support for Net::HTTP requests
+  * Added Travis CI configuration file
+
+Version 0.9.4
+
+  * Fixed fetching all records
+  * Adds custom error classes inheriting from ClientError
+  * Made error messages a bit more descriptive
+  * Adds WebsiteProperty#name and #website_url properties
+  * Made Garb report its version with each request
+  * Made FilterParameter#hash_to_params do not escape backslash. Fixes #74
+  * Code cleanup
+
+Version 0.9.3
+
+  * Adds support for fetching all results to Garb::Model
+  * ClientError handles properly error code and message from returned JSON
+  * Switches to GAPI v3
+
+Version 0.9.2
+
+  * Removed all deprecated features: Garb::Report, Garb::Resource, Garb::Profile, and Garb::Account
+  * Moved the differing types of requests into a module, will refactor to share more code
+  * Fixed OR'ing in :filters option for results
+
+Version 0.9.0
+
+  * New Garb::Model is solid. Garb::Resource and Garb::Report are deprecated.
+  * New GA Management API is functional and should be used in place of Garb::Profile and Garb::Account
+
+Version 0.7.4
+
+  * Removes HappyMapper dependency in favor of Crack so we can drop libxml dependency
+
+Version 0.7.0
+
+  * Adds multi-session support
+
+Version 0.6.0
+
+  * Adds OAuth access token support
+  * Simplifies Garb report access through a profile
+  * Includes the start of a basic library of pre-built reports (require 'garb/reports')
+
+Version 0.5.1
+  
+  * Brings back hash filters and symbol operators after agreed upon SymbolOperator
+
+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
+  * 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
+  * Slight changes to the way that the Report class can be used

data/Gemfile

@@ -0,0 +1,15 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in garb.gemspec
+gemspec
+
+gem 'rake'
+
+group :test do
+  gem 'shoulda'
+  gem 'shoulda-context'
+  gem 'simplecov',            :require => false
+  gem 'minitest',      '4.2', :require => false
+  gem 'jferris-mocha',        :require => false
+  gem 'json'
+end

data/README.md

@@ -1,28 +1,28 @@
-Garb
+Garb [![Build Status](https://secure.travis-ci.org/Sija/garb.png)](http://travis-ci.org/Sija/garb)
 ====
 
-  http://github.com/vigetlabs/garb
+  http://github.com/Sija/garb
 
-Important Changes
-=================
+Legato
+------
 
-  With The release of version 0.9.0 I have officially deprecated Garb::Report, Garb::Resource,
-  Garb::Profile, and Garb::Account. Garb::Report and Garb::Resource should be replaced by Garb::Model.
-  Garb::Profile and Garb::Account are supplanted by their Garb::Management::* counterparts.
-  
-  I'll be working hard to update the documentation over the next day or so to highlight all of the
-  old features in the new classes, as well as any new features brought by the new classes. If you
-  are looking for something in particular, please open an issue and I will try to prioritize these
-  requests.
+  There's rewritten and (moar) actively maintained version of the library in the form of [Legato](https://github.com/tpitale/legato).  
+  You might want to check it out as it's mostly compatible with `Garb`.
+
+Important Changes
+-----------------
 
-  Please read CHANGELOG
+  This fork contains heavily modified version of vigetlab's `Garb` library.  
+  It works only with version 3 of Google API.
 
+  Please read CHANGELOG.
+  
 Description
 -----------
 
   Provides a Ruby API to the Google Analytics API.
 
-  http://code.google.com/apis/analytics/docs/gdata/gdataDeveloperGuide.html
+  https://developers.google.com/analytics/devguides/reporting/core/v3/coreDevguide
 
 Basic Usage
 ===========
@@ -30,15 +30,16 @@ Basic Usage
 Single User Login
 -----------------
   
+    > Garb::Session.api_key = api_key # required for 2-step authentication
     > Garb::Session.login(username, password)
     
 OAuth Access Token
 ------------------
 
-    > Garb::Session.access_token = access_token # assign from oauth gem
+    > Garb::Session.access_token = access_token # an instance of OAuth2::Client
 
 Accounts, WebProperties, Profiles, and Goals
---------
+--------------------------------------------
 
     > Garb::Management::Account.all
     > Garb::Management::WebProperty.all
@@ -46,7 +47,7 @@ Accounts, WebProperties, Profiles, and Goals
     > Garb::Management::Goal.all
 
 Profiles for a UA- Number (a WebProperty)
---------
+-----------------------------------------
 
     > profile = Garb::Management::Profile.all.detect {|p| p.web_property_id == 'UA-XXXXXXX-X'}
 
@@ -78,6 +79,7 @@ Other Parameters
   * end_date: The date to end, inclusive
   * limit: The maximum number of results to be returned
   * offset: The starting index
+  * all: Return all results if true (which might result in several requests to GAPI)
 
 Metrics & Dimensions
 --------------------
@@ -86,7 +88,7 @@ Metrics & Dimensions
 
   I suggest reading the google documentation to familiarize yourself with this.
 
-  http://code.google.com/apis/analytics/docs/gdata/gdataReferenceDimensionsMetrics.html#bounceRate
+  https://developers.google.com/analytics/devguides/reporting/core/dimsmets#q=bouncerate
 
   When you've returned, you can pass the appropriate combinations to Garb, as symbols.
 
@@ -95,7 +97,7 @@ Filtering
 
   Google Analytics supports a significant number of filtering options.
 
-  http://code.google.com/apis/analytics/docs/gdata/gdataReference.html#filtering
+  https://developers.google.com/analytics/devguides/reporting/core/v3/reference#filters
 
   Here is what we can do currently:
   (the operator is a method on a symbol for the appropriate metric or dimension)
@@ -130,11 +132,20 @@ SSL
     Garb::Session.login(username, password, :secure => true)
 
   Next, be sure to download http://curl.haxx.se/ca/cacert.pem into your application somewhere.
-  Then, define a constant CA_CERT_FILE and point to that file.
+  Then, point `Garb.ca_cert_file` property to that file.
 
   For whatever reason, simply creating a new certificate store and setting the defaults would
   not validate the google ssl certificate as authentic.
 
+OPEN / READ TIMEOUT
+-------------------
+
+  The open and read timeout values used with the network client (Net::HTTP) are configurable.
+  Both values default to 60 seconds.  
+
+    Garb.open_timeout = 3
+    Garb.read_timeout = 3
+    
 TODOS
 -----
 
@@ -143,19 +154,28 @@ TODOS
 Requirements
 ------------
 
-  * crack >= 0.1.6
-  * active_support >= 2.2.0
+  * active_support >= 2.2
+  * multi_json >= 1.3
 
 Requirements for Testing
 ------------------------
 
   * shoulda
-  * jferris-mocha
+  * mocha
+  * bourne
 
 Install
 -------
 
-    gem install garb
+    From git:
+    
+    `git clone git://github.com/Sija/garb.git`
+    `cd garb && rake install`
+    
+    OR with bundler:
+    
+    gem 'garb', :git => 'git://github.com/Sija/garb.git'
+    `bundle install`
 
 Contributors
 ------------
@@ -165,13 +185,15 @@ Contributors
   * Patrick Reagan
   * Justin Marney
   * Nick Plante
+  * James Cook
+  * Chris Gunther
 
 License
 -------
 
   (The MIT License)
 
-  Copyright (c) 2010 Viget Labs
+  Copyright (c) 2011 Tony Pitale, Viget Labs
 
   Permission is hereby granted, free of charge, to any person obtaining
   a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,4 +1,7 @@
-require 'rake/gempackagetask'
+#!/usr/bin/env rake
+
+require 'rubygems/package_task' 
+require 'bundler/gem_tasks'
 require 'rake/testtask'
 
 $:.unshift File.expand_path('../lib', __FILE__)
@@ -6,52 +9,23 @@ require 'garb'
 
 task :default => :test
 
-spec = Gem::Specification.new do |s|
-  s.name              = 'garb'
-  s.version           = Garb::Version.to_s
-  s.has_rdoc          = false
-  s.rubyforge_project = 'viget'
-  s.summary           = "Google Analytics API Ruby Wrapper"
-  s.authors           = ['Tony Pitale']
-  s.email             = 'tony.pitale@viget.com'
-  s.homepage          = 'http://github.com/vigetlabs/garb'
-  s.files             = %w(README.md Rakefile) + Dir.glob("lib/**/*")
-  s.test_files        = Dir.glob("test/**/*")
-
-  s.add_dependency("crack", [">= 0.1.6"])
-  s.add_dependency("activesupport", [">= 2.2.0"])
-end
-
-Rake::GemPackageTask.new(spec) do |pkg|
-  pkg.gem_spec = spec
-end
-
 Rake::TestTask.new do |t|
   t.libs << 'test'
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.test_files = FileList['test/**/*_test.rb']
   t.verbose = true
 end
 
-desc 'Generate the gemspec to serve this Gem from Github'
-task :github do
-  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
-  File.open(file, 'w') {|f| f << spec.to_ruby }
-  puts "Created gemspec: #{file}"
-end
-
 begin
   require 'rcov/rcovtask'
 
-  desc "Generate RCov coverage report"
+  desc 'Generate RCov coverage report'
   Rcov::RcovTask.new(:rcov) do |t|
-    t.libs << "test"
+    t.libs << 'test'
     t.test_files = FileList['test/**/*_test.rb']
-    t.rcov_opts << "-x \"test/*,gems/*,/Library/Ruby/*,config/*\" -x lib/garb.rb -x lib/garb/version.rb --rails" 
+    t.rcov_opts << '-x "test/*,gems/*,/Library/Ruby/*,config/*" -x lib/garb.rb -x lib/garb/version.rb --rails'
   end
 rescue LoadError
   nil
 end
 
-task :default => 'test'
-
 # EOF

data/garb.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/garb/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ['Tony Pitale', 'Sijawusz Pur Rahnama']
+  gem.email         = ['tony.pitale@viget.com', 'sija@sija.pl']
+  gem.homepage      = 'http://github.com/Sija/garb'
+  gem.license       = 'MIT'
+  
+  gem.summary       = 'Google Analytics API Ruby Wrapper'
+  gem.description   = ''
+
+  gem.files         = `git ls-files`.split $\
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'garb'
+  gem.require_paths = ['lib']
+  gem.version       = Garb::VERSION
+  
+  gem.add_dependency 'activesupport', '>= 2.2'
+  gem.add_dependency 'multi_json', '>= 1.3'
+end

data/lib/garb.rb

@@ -1,56 +1,84 @@
+$:.unshift File.dirname(__FILE__)
+
 require 'net/http'
 require 'net/https'
 
 require 'cgi'
 require 'ostruct'
-require 'crack'
-
-begin
-  require 'active_support/inflector'
-  require 'active_support/deprecation'
-rescue LoadError
-  require 'active_support'
-end
 
-require 'garb/version'
-require 'garb/authentication_request'
-require 'garb/data_request'
-require 'garb/account_feed_request'
-require 'garb/session'
-require 'garb/profile_reports'
-require 'garb/step'
-require 'garb/destination'
-require 'garb/goal'
-require 'garb/profile'
-require 'garb/account'
-require 'garb/filter_parameters'
-require 'garb/report_parameter'
-require 'garb/result_set'
-require 'garb/report_response'
-require 'garb/resource'
-require 'garb/report'
-
-require 'garb/model'
-
-# management
-require 'garb/management/feed'
-require 'garb/management/segment'
-require 'garb/management/account'
-require 'garb/management/web_property'
-require 'garb/management/profile'
-require 'garb/management/goal'
-
-require 'support'
+require 'multi_json'
 
 module Garb
-  GA = "http://schemas.google.com/analytics/2008"
+  autoload :VERSION,          'garb/version'
+  
+  autoload :Attributes,       'garb/attributes'
+  autoload :PathAttribute,    'garb/path_attribute'
+  autoload :Destination,      'garb/destination'
+  autoload :FilterParameters, 'garb/filter_parameters'
+  autoload :Model,            'garb/model'
+  autoload :ProfileReports,   'garb/profile_reports'
+  autoload :ReportParameter,  'garb/report_parameter'
+  autoload :ReportResponse,   'garb/report_response'
+  autoload :ResultSet,        'garb/result_set'
+  autoload :Session,          'garb/session'
+  autoload :Step,             'garb/step'
+
+  module Management
+    autoload :Account,     'garb/management/account'
+    autoload :Feed,        'garb/management/feed'
+    autoload :Goal,        'garb/management/goal'
+    autoload :Profile,     'garb/management/profile'
+    autoload :Segment,     'garb/management/segment'
+    autoload :WebProperty, 'garb/management/web_property'
+  end
+
+  module Request
+    autoload :Authentication, 'garb/request/authentication'
+    autoload :Data,           'garb/request/data'
+  end
+ end
 
+module Garb
   extend self
 
+  class << self
+    attr_accessor :proxy_address, :proxy_port, :proxy_user, :proxy_password, :logger
+    attr_writer   :open_timeout, :read_timeout, :ca_cert_file
+  end
+
+  def use_fibers=(val)
+    if val and (!defined?(EM) || !defined?(Fiber))
+      raise ArgumentError, 'Eventmachine and Fibers required (Ruby 1.9+ only)'
+    end
+    require 'em-net-http' if val
+    @use_fibers = val
+  end
+
+  def use_fibers
+    @use_fibers || false
+  end
+
+  def open_timeout
+    @open_timeout || 60
+  end
+
+  def read_timeout
+    @read_timeout || 60
+  end
+
+  def ca_cert_file
+    @ca_cert_file || raise(MissingCertFileError)
+  end
+
+  def log(str, level = :debug)
+    level, str = str, level if str.is_a? Symbol
+    logger.send level, str unless logger.nil?
+  end
+
   def to_google_analytics(thing)
-    return thing.to_google_analytics if thing.respond_to?(:to_google_analytics)
+    return thing.to_google_analytics if thing.respond_to? :to_google_analytics
 
-    "ga:#{thing.to_s.camelize(:lower)}"
+    "#{$1}ga:#{$2}" if "#{thing.to_s.camelize(:lower)}" =~ /^(-)?(.*)$/
   end
   alias :to_ga :to_google_analytics
 
@@ -58,12 +86,7 @@ module Garb
     thing.to_s.gsub(/^ga\:/, '').underscore
   end
   alias :from_ga :from_google_analytics
-
-  def parse_properties(entry)
-    Hash[entry['dxp:property'].map {|p| [Garb.from_ga(p['name']),p['value']]}]
-  end
-
-  def parse_link(entry, rel)
-    entry['link'].detect {|link| link["rel"] == rel}['href']
-  end
 end
+
+require 'garb/support'
+require 'garb/errors'