legato 0.0.7 → 0.0.8

data/.ruby-version

@@ -0,0 +1 @@
+1.9.3-p362

data/README.md

@@ -144,6 +144,7 @@ Operators on dimensions:
   * :limit - The maximum number of results to be returned
   * :offset - The starting index
   * :sort - metric/dimension to sort by
+  * :quota_user - any arbitrary string that uniquely identifies a user (40 characters max)
 
 ## License ##
 
@@ -168,4 +169,4 @@ Operators on dimensions:
   IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
   CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
   TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+  SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,73 +1,100 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
 
 require 'oauth'
 require 'oauth2'
 
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
 # get oauth2 via device code, unimplemented as of now
 # curl -d "client_id={{client_id}}&scope=https://www.googleapis.com/auth/analytics.readonly" https://accounts.google.com/o/oauth2/device/code
 # { "device_code" : "4/8O1xUKWzOdJESG7ednnulZPsbyNt", "user_code" : "3tywhirg", "verification_url" : "http://www.google.com/device", "expires_in" : 1800, "interval" : 5 }
 # curl -d "client_id={{client_id}}&client_secret={{client_secret}}&code=4/8O1xUKWzOdJESG7ednnulZPsbyNt&grant_type=http://oauth.net/grant_type/device/1.0" https://accounts.google.com/o/oauth2/token
 # { "access_token" : "ERspXATXoblahblahblah", "token_type" : "Bearer", "expires_in" : 3600, "refresh_token" : "1/balhaajsdfklasfdjs;df" }
 
-namespace :oauth2 do
-  def client
+module OAuth2Helpers
+  def build_client(id, secret)
     # This is my test client account for Legato.
-    OAuth2::Client.new('779170787975.apps.googleusercontent.com', 'mbCISoZiSwyVQIDEbLj4EeEc', {
+    opts = {
       :authorize_url => 'https://accounts.google.com/o/oauth2/auth',
       :token_url => 'https://accounts.google.com/o/oauth2/token'
-    })
+    }
+
+    OAuth2::Client.new(id, secret, opts)
   end
 
-  def auth_url
+  def auth_url(client)
     client.auth_code.authorize_url({
       :scope => 'https://www.googleapis.com/auth/analytics.readonly',
       :redirect_uri => 'http://localhost'
     })
   end
 
+  extend self
+end
+
+namespace :oauth2 do
   desc "Get a new OAuth2 Token"
   task :token do
-    `open "#{auth_url}"`
+    puts 'Get your OAuth2 id and secret from the API Console: https://code.google.com/apis/console#access'
+
+    puts
+    print 'Your OAuth2 id: '
+    oauth_id = $stdin.gets.strip
+    print 'Your OAuth2 secret: '
+    oauth_secret = $stdin.gets.strip
+
+    client = OAuth2Helpers.build_client(oauth_id, oauth_secret)
 
-    print 'OAuth2 Code: '
-    code = $stdin.gets
+    puts
+    puts "Opening the OAuth2 auth url: #{OAuth2Helpers.auth_url(client)} ..."
+    `open "#{OAuth2Helpers.auth_url(client)}"`
 
-    access_token = client.auth_code.get_token(code.strip, :redirect_uri => 'http://localhost')
+    puts
+    print 'OAuth2 Code (in the url): '
+    code = $stdin.gets.strip
+
+    access_token = client.auth_code.get_token(code, :redirect_uri => 'http://localhost')
+
+    puts
+    puts "Here's your access token: "
     puts access_token.token
   end
 end
 
-namespace :oauth do
-  def consumer
-    OAuth::Consumer.new('779170787975.apps.googleusercontent.com', 'mbCISoZiSwyVQIDEbLj4EeEc', {
-      :site => "https://www.google.com",
-      :request_token_path => "/accounts/OAuthGetRequestToken",
-      :access_token_path => "/accounts/OAuthGetAccessToken",
-      :authorize_path => "/accounts/OAuthAuthorizeToken"
-    })
-  end
+# namespace :oauth do
+#   def consumer(id, secret)
+#     OAuth::Consumer.new('779170787975.apps.googleusercontent.com', 'mbCISoZiSwyVQIDEbLj4EeEc', {
+#       :site => "https://www.google.com",
+#       :request_token_path => "/accounts/OAuthGetRequestToken",
+#       :access_token_path => "/accounts/OAuthGetAccessToken",
+#       :authorize_path => "/accounts/OAuthAuthorizeToken"
+#     })
+#   end
 
-  def request_token
-    @request_token ||= consumer.get_request_token({}, {:scope => "https://www.googleapis.com/auth/analytics.readonly"})
-  end
+#   def request_token
+#     @request_token ||= consumer.get_request_token({}, {:scope => "https://www.googleapis.com/auth/analytics.readonly"})
+#   end
 
-  def auth_url
-    request_token.authorize_url
-  end
+#   def auth_url
+#     request_token.authorize_url
+#   end
 
-  def access_token
-    @access_token ||= begin
-      print 'OAuth Code: '
-      code = $stdin.gets.strip
-      request_token.get_access_token(:oauth_verifier => code)
-    end
-  end
+#   def access_token
+#     @access_token ||= begin
+#       print 'OAuth Code: '
+#       code = $stdin.gets.strip
+#       request_token.get_access_token(:oauth_verifier => code)
+#     end
+#   end
 
-  desc "Get a new OAuth Token"
-  task :token do
-    `open "#{auth_url}"`
+#   desc "Get a new OAuth Token"
+#   task :token do
+#     `open "#{auth_url}"`
 
-    puts "Token: #{access_token.token}"
-    puts "Secret: #{access_token.secret}"
-  end
-end
+#     puts "Token: #{access_token.token}"
+#     puts "Secret: #{access_token.secret}"
+#   end
+# end

data/lib/legato.rb

@@ -4,7 +4,10 @@ require 'multi_json'
 require 'cgi'
 require 'ostruct'
 
-unless Object.const_defined?("ActiveSupport")
+if Object.const_defined?("ActiveSupport")
+  require "active_support/core_ext/string"
+  require "active_support/core_ext/array"
+else
   require "legato/core_ext/string"
   require "legato/core_ext/array"
 end

data/lib/legato/query.rb

@@ -23,7 +23,7 @@ module Legato
 
     attr_reader :parent_klass
     attr_accessor :profile, :start_date, :end_date
-    attr_accessor :sort, :limit, :offset#, :segment # individual, overwritten
+    attr_accessor :sort, :limit, :offset, :quota_user #, :segment # individual, overwritten
     attr_accessor :filters # appended to, may add :segments later for dynamic segments
 
     def initialize(klass)
@@ -75,14 +75,14 @@ module Legato
     end
 
     def apply_basic_options(options)
-      [:sort, :limit, :offset, :start_date, :end_date].each do |key| #:segment
+      [:sort, :limit, :offset, :start_date, :end_date, :quota_user].each do |key| #:segment
         self.send("#{key}=".to_sym, options[key]) if options.has_key?(key)
       end
     end
 
     # def apply_filter_options(filter_options)
     #   join_character = Legato.and_join_character
-    # 
+    #
     #   Array.wrap(filter_options).compact.each do |filter|
     #     filter.each do |key, value|
     #       self.filters << hash_to_filter(key, value, join_character)
@@ -186,7 +186,8 @@ module Legato
         'start-index' => offset,
         # 'segment' => segment_id,
         'filters' => filters.to_params, # defaults to AND filtering
-        'fields' => REQUEST_FIELDS
+        'fields' => REQUEST_FIELDS,
+        'quotaUser' => quota_user
       }
 
       [metrics, dimensions, sort].each do |list|

data/lib/legato/version.rb

@@ -1,3 +1,3 @@
 module Legato
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/spec/lib/legato/query_spec.rb

@@ -248,6 +248,23 @@ describe Legato::Query do
         @query.offset.should == 200
       end
 
+      it "sets the quota_user" do
+        @query.apply_options({:quota_user => 'an id'})
+        @query.quota_user.should == 'an id'
+      end
+
+      it "replaces the quota_user" do
+        @query.quota_user = 'an id'
+        @query.apply_options({:quota_user => 'a different id'})
+        @query.quota_user.should == 'a different id'
+      end
+
+      it "does not replace quota_user if option is omitted" do
+        @query.quota_user = 'an id'
+        @query.apply_options({})
+        @query.quota_user.should == 'an id'
+      end
+
       context "with Time" do
         before :each do
           @now = Time.now
@@ -321,6 +338,15 @@ describe Legato::Query do
         @query.to_params['start-index'].should == 50
       end
 
+      it 'includes the quotaUser if quota_user is set' do
+        @query.quota_user = 'an id'
+        @query.to_params['quotaUser'].should == 'an id'
+      end
+
+      it 'excludes the quotaUser if quota_user is not set' do
+        @query.to_params.keys.should_not include('quotaUser')
+      end
+
       it 'includes filters' do
         filters = stub(:to_params => 'filter set parameters')
         @query.stubs(:filters).returns(filters)

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
-require 'bundler'
-Bundler.setup(:test)
+require 'bundler/setup'
 
 require 'rspec'
 require 'mocha'

metadata

@@ -1,151 +1,156 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: legato
-version: !ruby/object:Gem::Version 
-  hash: 17
+version: !ruby/object:Gem::Version
+  version: 0.0.8
   prerelease: 
-  segments: 
-  - 0
-  - 0
-  - 7
-  version: 0.0.7
 platform: ruby
-authors: 
+authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-05-17 00:00:00 -04:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
-  type: :development
-  requirement: *id001
+date: 2013-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rake
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  prerelease: false
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id002
-  name: rspec
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id003
-  name: mocha
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id004
-  name: bourne
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - "="
-      - !ruby/object:Gem::Version 
-        hash: -2540839718
-        segments: 
-        - 2
-        - 0
-        - 0
-        - beta
-        - 2
-        version: 2.0.0.beta2
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bourne
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id005
-  name: vcr
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
   type: :development
-  requirement: *id006
-  name: fakeweb
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id007 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
   prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  requirement: *id007
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: oauth2
-- !ruby/object:Gem::Dependency 
-  version_requirements: &id008 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
   prerelease: false
-  type: :runtime
-  requirement: *id008
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
   name: multi_json
-description: Access the Google Analytics Core Reporting and Management APIs with Ruby. Create models for metrics and dimensions. Filter your data to tell you what you need.
-email: 
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Access the Google Analytics Core Reporting and Management APIs with Ruby.
+  Create models for metrics and dimensions. Filter your data to tell you what you
+  need.
+email:
 - tpitale@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - .rspec
+- .ruby-version
 - .travis.yml
 - CHANGELOG.md
 - Gemfile
@@ -191,43 +196,31 @@ files:
 - spec/spec_helper.rb
 - spec/support/examples/management_finder.rb
 - spec/support/macros/oauth.rb
-has_rdoc: true
 homepage: http://github.com/tpitale/legato
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 57
-      segments: 
-      - 1
-      - 8
-      - 7
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
       version: 1.8.7
-required_rubygems_version: !ruby/object:Gem::Requirement 
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: legato
-rubygems_version: 1.4.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Access the Google Analytics API with Ruby
-test_files: 
+test_files:
 - spec/cassettes/management/accounts.json
 - spec/cassettes/management/profiles.json
 - spec/cassettes/management/web_properties.json