google-api-client 0.1.0

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.1.0
+
+* initial release

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README

@@ -0,0 +1,68 @@
+== APIClient
+
+Homepage::  google-api-ruby-client[http://code.google.com/p/google-api-ruby-client/]
+Authors::   Bob Aman (mailto:bobaman@google.com), Matt Pokrzywa (mailto:mattpok@google.com)
+Copyright:: Copyright 2010 Google Inc.
+License::   Apache 2.0
+
+== Description
+
+The Google API Ruby Client makes it trivial to discover and access supported
+APIs.
+
+== Example Usage
+
+  # Initialize the client
+  require 'google/api_client'
+  require 'signet/oauth_1/client'
+  client = Google::APIClient.new(
+    :service => 'buzz',
+    # Buzz has API-specific endpoints
+    :authorization => Signet::OAuth1::Client.new(
+      :temporary_credential_uri =>
+        'https://www.google.com/accounts/OAuthGetRequestToken',
+      :authorization_uri =>
+        'https://www.google.com/buzz/api/auth/OAuthAuthorizeToken',
+      :token_credential_uri =>
+        'https://www.google.com/accounts/OAuthGetAccessToken',
+      :client_credential_key => 'anonymous',
+      :client_credential_secret => 'anonymous'
+    )
+  )
+  client.authorization.fetch_temporary_credential!(
+    :additional_parameters => {
+      'scope' => 'https://www.googleapis.com/auth/buzz'
+    }
+  )
+  redirect_uri = client.authorization.authorization_uri(
+    :additional_parameters => {
+      'domain' => client.authorization.client_credential_key,
+      'scope' => 'https://www.googleapis.com/auth/buzz'
+    }
+  )
+  # Redirect user here
+  client.authorization.fetch_token_credential!(:verifier => '12345')
+
+  # Discover available methods
+  method_names = client.discovered_service('buzz').to_h.keys
+
+  # Make an API call
+  response = client.execute(
+    'chili.activities.list',
+    {'scope' => '@self', 'userId' => '@me', 'alt' => 'json'}
+  )
+  status, headers, body = response
+
+== Install
+
+Be sure both http://gems.github.com/ and http://rubygems.org/ are in your gem
+sources.
+
+For normal client usage, this is sufficient:
+
+sudo gem install google-api-client
+
+The command line interface, the example applications, and the test suite
+require additional dependencies. These may be obtained with:
+
+sudo gem install google-api-client --development --force --no-rdoc --no-ri

data/Rakefile

@@ -0,0 +1,52 @@
+lib_dir = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.uniq!
+
+require 'rubygems'
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'rake/packagetask'
+require 'rake/gempackagetask'
+
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  STDERR.puts "Please install rspec:"
+  STDERR.puts "sudo gem install rspec"
+  exit(1)
+end
+
+require File.join(File.dirname(__FILE__), 'lib/google/api_client', 'version')
+
+PKG_DISPLAY_NAME   = 'Google API Client'
+PKG_NAME           = PKG_DISPLAY_NAME.downcase.gsub(/\s/, '-')
+PKG_VERSION        = Google::APIClient::VERSION::STRING
+PKG_FILE_NAME      = "#{PKG_NAME}-#{PKG_VERSION}"
+PKG_HOMEPAGE       = 'http://code.google.com/p/google-api-ruby-client/'
+
+RELEASE_NAME       = "REL #{PKG_VERSION}"
+
+PKG_SUMMARY        = 'Package Summary'
+PKG_DESCRIPTION    = <<-TEXT
+The Google API Ruby Client makes it trivial to discover and access supported
+APIs.
+TEXT
+
+PKG_FILES = FileList[
+    'lib/**/*', 'spec/**/*', 'vendor/**/*',
+    'tasks/**/*', 'website/**/*',
+    '[A-Z]*', 'Rakefile'
+].exclude(/database\.yml/).exclude(/[_\.]git$/)
+
+RCOV_ENABLED = (RUBY_PLATFORM != 'java' && RUBY_VERSION =~ /^1\.8/)
+if RCOV_ENABLED
+  task :default => 'spec:verify'
+else
+  task :default => 'spec'
+end
+
+WINDOWS = (RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/) rescue false
+SUDO = WINDOWS ? '' : ('sudo' unless ENV['SUDOLESS'])
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/google-api

@@ -0,0 +1,295 @@
+#!/usr/bin/env ruby
+
+bin_dir = File.expand_path("..", __FILE__)
+lib_dir = File.expand_path("../lib", bin_dir)
+
+$LOAD_PATH.unshift(lib_dir)
+$LOAD_PATH.uniq!
+
+OAUTH_SERVER_PORT = 12736
+
+require 'rubygems'
+require 'optparse'
+require 'google/api_client/version'
+require 'google/api_client'
+
+ARGV.unshift('--help') if ARGV.empty?
+
+command = 'execute'
+options = {}
+OptionParser.new do |opts|
+  opts.banner =
+    "Usage: google-api <rpcname> [options] -- <parameters>\n" +
+    "   or: google-api --oauth-login=<scope> [options]\n" +
+    "   or: google-api --interactive=<service> [options]\n" +
+    "   or: google-api --fuzz [options]"
+
+  opts.separator ""
+
+  opts.on(
+      "--oauth-login <scope>", String, "Authorize for the scope") do |s|
+    if command != 'execute'
+      STDERR.puts("Ambiguous command: #{command}")
+      exit(1)
+    end
+    command = 'oauth-login'
+    options[:scope] = s
+  end
+  opts.on(
+      "-s", "--service <name>", String, "Perform discovery on service") do |s|
+    options[:service_name] = s
+  end
+  opts.on(
+      "-i", "--interactive <name>", String, "Start interactive session") do |s|
+    if command != 'execute'
+      STDERR.puts("Ambiguous command: #{command}")
+      exit(1)
+    end
+    command = 'interactive'
+    options[:service_name] = s
+  end
+  opts.on(
+      "--service-version <id>", String, "Select service version") do |id|
+    options[:service_version] = id
+  end
+  opts.on(
+      "--content-type <format>", String, "Content-Type for request") do |f|
+    # Resolve content type shortcuts
+    case f
+    when 'json'
+      f = 'application/json'
+    when 'xml'
+      f = 'application/xml'
+    when 'atom'
+      f = 'application/atom+xml'
+    when 'rss'
+      f = 'application/rss+xml'
+    end
+    options[:content_type] = f
+  end
+  opts.on("--fuzz [rpcname]", String, "Fuzz an API or endpoint") do |rpcname|
+    if command != 'execute'
+      STDERR.puts("Ambiguous command: #{command}")
+      exit(1)
+    end
+    command = 'fuzz'
+    options[:fuzz] = rpcname
+  end
+
+  opts.on_tail("-v", "--verbose", "Run verbosely") do |v|
+    options[:verbose] = v
+  end
+  opts.on_tail("-h", "--help", "Show this message") do
+    puts opts
+    exit
+  end
+  opts.on_tail("--version", "Show version") do
+    puts "google-api-client (#{Google::APIClient::VERSION::STRING})"
+    exit
+  end
+end.parse!
+
+if command == 'oauth-login' # Guard to keep start-up time short
+  require 'webrick'
+  # Used for oauth login
+  class OAuthVerifierServlet < WEBrick::HTTPServlet::AbstractServlet
+    def do_GET(request, response)
+      $verifier ||= Addressable::URI.unencode_component(
+        request.request_uri.to_s[/\?.*oauth_verifier=([^&$]+)(&|$)/, 1]
+      )
+      response.status = WEBrick::HTTPStatus::RC_ACCEPTED
+      # This javascript will auto-close the tab after the verifier is obtained.
+      response.body = <<-HTML
+<html>
+  <head>
+    <script>
+      function closeWindow() { 
+        window.open('', '_self', '');
+        window.close();
+      }
+      setTimeout(closeWindow, 10);
+    </script>
+  </head>
+  <body>
+    You may close this window.
+  </body>
+</html>
+HTML
+      self.instance_variable_get('@server').stop
+    end
+  end
+end
+
+def oauth_login(options={})
+  require 'signet/oauth_1/client'
+  require 'launchy'
+  require 'yaml'
+  $verifier = nil
+  logger = WEBrick::Log.new('/dev/null') # TODO(bobaman): Cross-platform?
+  server = WEBrick::HTTPServer.new(
+    :Port => OAUTH_SERVER_PORT,
+    :Logger => logger,
+    :AccessLog => logger
+  )
+  trap("INT") { server.shutdown }
+
+  server.mount("/", OAuthVerifierServlet)
+
+  oauth_client = Signet::OAuth1::Client.new(
+    :temporary_credential_uri =>
+      'https://www.google.com/accounts/OAuthGetRequestToken',
+    :authorization_uri =>
+      'https://www.google.com/accounts/OAuthAuthorizeToken',
+    :token_credential_uri =>
+      'https://www.google.com/accounts/OAuthGetAccessToken',
+    :client_credential_key => 'anonymous',
+    :client_credential_secret => 'anonymous',
+    :callback => "http://localhost:#{OAUTH_SERVER_PORT}/"
+  )
+  scope = options[:scope]
+  # Special cases
+  case scope
+  when "https://www.googleapis.com/auth/buzz",
+      "https://www.googleapis.com/auth/buzz.readonly"
+    oauth_client.authorization_uri =
+      'https://www.google.com/buzz/api/auth/OAuthAuthorizeToken?' +
+      "domain=#{oauth_client.client_credential_key}&" +
+      "scope=#{scope}&" +
+      "xoauth_displayname=Google%20API%20Client"
+  end
+  oauth_client.fetch_temporary_credential!(:additional_parameters => {
+    :scope => scope,
+    :xoauth_displayname => 'Google API Client'
+  })
+
+  # Launch browser
+  Launchy::Browser.run(oauth_client.authorization_uri.to_s)
+
+  server.start
+  oauth_client.fetch_token_credential!(:verifier => $verifier)
+  config = {
+    "scope" => scope,
+    "client_credential_key" => oauth_client.client_credential_key,
+    "client_credential_secret" => oauth_client.client_credential_secret,
+    "token_credential_key" => oauth_client.token_credential_key,
+    "token_credential_secret" => oauth_client.token_credential_secret
+  }
+  config_file = File.expand_path('~/.google-api.yaml')
+  open(config_file, 'w') { |file| file.write(YAML.dump(config)) }
+  exit(0)
+end
+
+def execute(options={})
+  require 'signet/oauth_1/client'
+  require 'yaml'
+  config_file = File.expand_path('~/.google-api.yaml')
+  signed = File.exist?(config_file)
+  rpcname = ARGV.detect { |p| p =~ /^[a-z0-9_-]+\.[a-z0-9_\.-]+$/i }
+  if rpcname
+    ARGV.delete(rpcname)
+  else
+    STDERR.puts('Could not find rpcname.')
+    exit(1)
+  end
+  service_name = options[:service_name] || rpcname[/^([^\.]+)\./, 1]
+  client = Google::APIClient.new(
+    :service => service_name,
+    :authorization => :oauth_1
+  )
+  if signed
+    if !client.authorization.kind_of?(Signet::OAuth1::Client)
+      STDERR.puts(
+        "Unexpected authorization mechanism: #{client.authorization.class}"
+      )
+      exit(1)
+    end
+    config = open(config_file, 'r') { |file| YAML.load(file.read) }
+    client.authorization.client_credential_key =
+      config["client_credential_key"]
+    client.authorization.client_credential_secret =
+      config["client_credential_secret"]
+    client.authorization.token_credential_key =
+      config["token_credential_key"]
+    client.authorization.token_credential_secret =
+      config["token_credential_secret"]
+  end
+  service_version =
+    options[:service_version] ||
+    client.latest_service_version(service_name).version
+  service = client.discovered_service(service_name, service_version)
+  method = service.to_h[rpcname]
+  if !method
+    STDERR.puts(
+      "Method #{rpcname} does not exist for " +
+      "#{service_name}-#{service_version}."
+    )
+    exit(1)
+  end
+  parameters = ARGV.inject({}) do |accu, pair|
+    name, value = pair.split('=', 2)
+    accu[name] = value
+    accu
+  end
+  request_body = ''
+  input_streams, _, _ = IO.select([STDIN], [], [], 0)
+  request_body = STDIN.read || '' if input_streams
+  headers = []
+  if options[:content_type]
+    headers << ['Content-Type', options[:content_type]]
+  elsif request_body
+    # Default to JSON
+    headers << ['Content-Type', 'application/json']
+  end
+  response = client.execute(
+    method, parameters, request_body, headers, {:signed => signed}
+  )
+  status, headers, body = response
+  puts body
+  exit(0)
+end
+
+def interactive(options={})
+  require 'signet/oauth_1/client'
+  require 'yaml'
+  config_file = File.expand_path('~/.google-api.yaml')
+  signed = File.exist?(config_file)
+
+  $client = Google::APIClient.new(
+    :service => options[:service_name],
+    :authorization => (signed ? :oauth_1 : nil)
+  )
+
+  if signed
+    if $client.authorization &&
+        !$client.authorization.kind_of?(Signet::OAuth1::Client)
+      STDERR.puts(
+        "Unexpected authorization mechanism: #{$client.authorization.class}"
+      )
+      exit(1)
+    end
+    config = open(config_file, 'r') { |file| YAML.load(file.read) }
+    $client.authorization.client_credential_key =
+      config["client_credential_key"]
+    $client.authorization.client_credential_secret =
+      config["client_credential_secret"]
+    $client.authorization.token_credential_key =
+      config["token_credential_key"]
+    $client.authorization.token_credential_secret =
+      config["token_credential_secret"]
+  end
+
+  require 'irb'
+  IRB.start(__FILE__)
+end
+
+def fuzz(options={})
+  STDERR.puts('API fuzzing not yet supported.')
+  if rpcname
+    # Fuzz just one method
+  else
+    # Fuzz the entire API
+  end
+  exit(1)
+end
+
+self.send(command.gsub(/-/, "_").to_sym, options)