google-api-client 0.8.3 → 0.9

data/lib/google/apis/generator/templates/service.rb.tmpl

@@ -0,0 +1,60 @@
+# Copyright 2015 Google Inc.
+#
+# 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.
+
+require 'google/apis/core/base_service'
+require 'google/apis/core/json_representation'
+require 'google/apis/core/hashable'
+require 'google/apis/errors'
+
+module Google
+  module Apis
+    module <%= api.module_name  %>
+      # <%= api.title %>
+      #
+      # <%= block_comment(api.description, 6, 2) %>
+      #
+      # @example
+      #    require '<%= to_path(api.qualified_name) %>'
+      #
+      #    <%= api.name %> = <%= api.qualified_name %> # Alias the module
+      #    service = <%= api.name %>::<%= api.service_name %>.new
+      #
+<% if api.documentation_link -%>
+      # @see <%= api.documentation_link %>
+<% end -%>
+      class <%= api.service_name %> < Google::Apis::Core::BaseService
+<% for param in api.parameters.values.reject {|p| p.name == 'fields'} -%>
+        # @return [<%= param.generated_type %>]
+        #  <%= block_comment(param.description, 8, 2) %>
+        attr_accessor :<%= param.generated_name %>
+
+<% end -%>
+        def initialize
+          super('<%= api.root_url %>', '<%= api.service_path %>')
+        end
+<% for api_method in api.all_methods -%>
+<%= indent(include('method', :api_method => api_method, :api => api), 8) -%>
+<% end -%>
+
+        protected
+
+        def apply_command_defaults(command)
+<% for param in api.parameters.values.reject {|p| p.name == 'fields'} -%>
+          command.query['<%= param.name %>'] = <%= param.generated_name %> unless <%= param.generated_name %>.nil?
+<% end -%>
+        end
+      end
+    end
+  end
+end

data/lib/google/apis/generator.rb

@@ -0,0 +1,70 @@
+# Copyright 2015 Google Inc.
+#
+# 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.
+
+require 'google/apis/discovery_v1'
+require 'google/apis/generator/annotator'
+require 'google/apis/generator/model'
+require 'google/apis/generator/template'
+require 'active_support/inflector'
+require 'yaml'
+
+module Google
+  module Apis
+    # Generates ruby classes for APIs from discovery documents
+    # @private
+    class Generator
+      Discovery = Google::Apis::DiscoveryV1
+
+      # Load templates
+      def initialize(api_names: nil)
+        @names = Google::Apis::Generator::Names.new(api_names || File.join(Google::Apis::ROOT, 'api_names.yaml'))
+        @module_template = Template.load('module.rb')
+        @service_template = Template.load('service.rb')
+        @classes_template = Template.load('classes.rb')
+        @representations_template = Template.load('representations.rb')
+      end
+
+      # Generates ruby source for an API
+      #
+      # @param [String] json
+      #  API Description, as JSON text
+      # @return [Hash<String,String>]
+      #  Hash of generated files keyed by path
+      def render(json)
+        api = parse_description(json)
+        Annotator.process(api, @names)
+        base_path = ActiveSupport::Inflector.underscore(api.qualified_name)
+        context = {
+          'api' => api
+        }
+        files = {}
+        files[base_path + '.rb'] = @module_template.render(context)
+        files[File.join(base_path, 'service.rb')] = @service_template.render(context)
+        files[File.join(base_path, 'classes.rb')] = @classes_template.render(context)
+        files[File.join(base_path, 'representations.rb')] = @representations_template.render(context)
+        files
+      end
+
+      # Dump mapping of API names
+      # @return [String] Mapping of paths to ruby names in YAML format
+      def dump_api_names
+        @names.dump
+      end
+
+      def parse_description(json)
+        Discovery::RestDescription::Representation.new(Discovery::RestDescription.new).from_json(json)
+      end
+    end
+  end
+end

data/lib/google/apis/options.rb

@@ -0,0 +1,85 @@
+# Copyright 2015 Google Inc.
+#
+# 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.
+
+module Google
+  module Apis
+    # General options for API requests
+    ClientOptions =  Struct.new(
+      :application_name,
+      :application_version,
+      :proxy_url,
+      :use_net_http)
+
+    RequestOptions = Struct.new(
+      :authorization,
+      :retries,
+      :header,
+      :timeout_sec,
+      :open_timeout_sec)
+
+    # General client options
+    class ClientOptions
+      # @!attribute [rw] application_name
+      #   @return [String] Name of the application, for identification in the User-Agent header
+      # @!attribute [rw] application_version
+      #   @return [String] Version of the application, for identification in the User-Agent header
+      # @!attribute [rw] proxy_url
+      #   @return [String] URL of a proxy server
+
+      # Get the default options
+      # @return [Google::Apis::ClientOptions]
+      def self.default
+        @options ||= ClientOptions.new
+      end
+    end
+
+    # Request options
+    class RequestOptions
+      # @!attribute [rw] authorization
+      #   @return [Signet::OAuth2::Client, #apply(Hash)] OAuth2 credentials
+      # @!attribute [rw] retries
+      #   @return [Fixnum] Number of times to retry requests on server error
+      # @!attribute [rw] timeout_sec
+      #   @return [Fixnum] How long, in seconds, before requests time out
+      # @!attribute [rw] open_timeout_sec
+      #   @return [Fixnum] How long, in seconds, before failed connections time out
+      # @!attribute [rw] header
+      #   @return [Hash<String,String] Additional HTTP headers to include in requests
+
+      # Get the default options
+      # @return [Google::Apis::RequestOptions]
+      def self.default
+        @options ||= RequestOptions.new
+      end
+
+      def merge(options)
+        return self if options.nil?
+
+        new_options = dup
+        members.each do |opt|
+          opt = opt.to_sym
+          new_options[opt] = options[opt] unless options[opt].nil?
+        end
+        new_options
+      end
+    end
+    
+    ClientOptions.default.use_net_http = false
+    ClientOptions.default.application_name = 'unknown'
+    ClientOptions.default.application_version = '0.0.0'
+
+    RequestOptions.default.retries = 0
+    RequestOptions.default.open_timeout_sec = 20
+  end
+end

data/lib/google/apis/version.rb

@@ -0,0 +1,39 @@
+# Copyright 2015 Google Inc.
+#
+# 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.
+
+module Google
+  module Apis
+    # Client library version
+    VERSION = '0.9'
+
+    # Current operating system
+    # @private
+    OS_VERSION = begin
+      if RUBY_PLATFORM =~ /mswin|win32|mingw|bccwin|cygwin/
+        `ver`.sub(/\s*\[Version\s*/, '/').sub(']', '').strip
+      elsif RUBY_PLATFORM =~ /darwin/i
+        "Mac OS X/#{`sw_vers -productVersion`}"
+      elsif RUBY_PLATFORM == 'java'
+        require 'java'
+        name = java.lang.System.getProperty('os.name')
+        version = java.lang.System.getProperty('os.version')
+        "#{name}/#{version}"
+      else
+        `uname -sr`.sub(' ', '/')
+      end
+    rescue
+      RUBY_PLATFORM
+    end
+  end
+end

data/lib/google/apis.rb

@@ -0,0 +1,48 @@
+# Copyright 2015 Google Inc.
+#
+# 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.
+
+require 'google/apis/version'
+require 'logger'
+
+module Google
+  module Apis
+    ROOT = File.expand_path('..', File.dirname(__dir__))
+
+    # @!attribute [rw] logger
+    # @return [Logger] The logger.
+    def self.logger
+      @logger ||= rails_logger || default_logger
+    end
+
+    class << self
+      attr_writer :logger
+    end
+
+    private
+
+    # Create and configure a logger
+    # @return [Logger]
+    def self.default_logger
+      logger = Logger.new($stdout)
+      logger.level = Logger::WARN
+      logger
+    end
+
+    # Check to see if client is being used in a Rails environment and ge the logger if present
+    # @return [Logger]
+    def self.rails_logger
+      ::Rails.logger if defined?(::Rails) && ::Rails.respond_to?(:logger) && ::Rails.logger
+    end
+  end
+end

data/rakelib/metrics.rake

@@ -0,0 +1,22 @@
+namespace :metrics do
+  task :lines do
+    lines, codelines, total_lines, total_codelines = 0, 0, 0, 0
+    for file_name in FileList['lib/**/*.rb', 'bin/generate-api']
+      f = File.open(file_name)
+      while line = f.gets
+        lines += 1
+        next if line =~ /^\s*$/
+        next if line =~ /^\s*#/
+        codelines += 1
+      end
+      puts "L: #{sprintf('%4d', lines)}, " +
+               "LOC #{sprintf('%4d', codelines)} | #{file_name}"
+      total_lines     += lines
+      total_codelines += codelines
+
+      lines, codelines = 0, 0
+    end
+
+    puts "Total: Lines #{total_lines}, LOC #{total_codelines}"
+  end
+end

data/rakelib/rubocop.rake

@@ -0,0 +1,10 @@
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['progress']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end

data/rakelib/spec.rake

@@ -0,0 +1,11 @@
+require 'rake/clean'
+require 'rspec/core/rake_task'
+
+CLOBBER.include('coverage')
+
+namespace :spec do
+  RSpec::Core::RakeTask.new(:all)
+end
+
+desc 'Alias to spec:all'
+task 'spec' => 'spec:all'

data/rakelib/yard.rake

@@ -0,0 +1,11 @@
+begin
+	require 'yard'
+	require 'yard/rake/yardoc_task'
+
+	YARD::Rake::YardocTask.new do |t|
+  	t.files   = ['lib/**/*.rb', 'generated/**/*.rb']
+  	t.options = ['--verbose', '--markup', 'markdown']
+	end
+rescue LoadError
+  puts "YARD not available"
+end

data/samples/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'google-api-client', '~> 0.9.pre4'
+gem 'thor', '~> 0.19'
+gem 'os', '~> 0.9'
+gem 'rmail', '~> 1.1'
+gem 'dotenv'

data/samples/README.md

@@ -0,0 +1,51 @@
+# API Samples
+
+This directory contains a small but growing collection of samples for various
+APIs. Each sample can be run on the command line from the `google-api-samples`
+script.
+
+Contributions of new samples are welcome.
+
+# Setup
+
+Depending on which particular samples you want to run, different
+steps may be required. Some samples, like Pub/Sub, require a service account,
+others like Drive, Calendar, and YouTube require an OAuth Client ID. And in
+some cases like Translate, only an API key is needed.
+
+* Create a project at https://console.developers.google.com
+* Go to the `API Manager` and enable the APIs you'd like to try
+* Go to `Credentials` and create the appropriate type of credential for the sample
+    * For keys, use 'Server key' as the type
+    * For OAuth Client IDs, use 'Other' as the type
+    * For service accounts, use the 'JSON' key type
+
+Additional details on how to enable APIs and create credentials can be
+found in the help guide in the console.
+
+
+## Example Environment Settings
+
+For convenience, application credentials can be read from the shell environment
+or placed in a .env file.
+
+After setup, your .env file might look something like:
+
+```
+GOOGLE_API_KEY=AIzaSyC6GvjvPlEzJpTW2bW2t0MPHXXXXXXXXXX
+GOOGLE_CLIENT_ID=479164972499-i7j6av7bp2s4on5ltb7pjXXXXXXXXXX.apps.googleusercontent.com
+GOOGLE_CLIENT_SECRET=JBotCTG5biFWGzXXXXXXXXXX
+GOOGLE_APPLICATION_CREDENTIALS=~/ruby-samples-cred.json
+```
+
+# Running the samples
+
+To list the available sample modules, run the script:
+```
+google-api-samples
+```
+
+To get help on a specific set of samples, run:
+```
+google-api-samples help <module>
+```

data/samples/google-api-samples

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+
+$:.unshift(File.expand_path("../lib", __FILE__))
+
+require 'thor'
+require 'dotenv'
+
+
+# Small script to allow executing samples from the command line.
+# Each sample is loaded as a subcommand.
+#
+# Example usage:
+#
+#     google-api-samples drive upload myfile.txt
+#
+#
+class App < Thor
+
+  # Load all the samples and register them as subcommands
+  Dir.glob('./lib/samples/*.rb').each do |file|
+    require file
+  end
+
+  Samples.constants.each do |const|
+    desc const.downcase, "#{const} samples"
+    subcommand const.downcase, Samples.const_get(const)
+  end
+
+end
+
+Dotenv.load
+App.start(ARGV)

data/samples/lib/base_cli.rb

@@ -0,0 +1,94 @@
+# Copyright 2016 Google Inc.
+#
+# 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.
+
+require 'googleauth'
+require 'googleauth/stores/file_token_store'
+require 'fileutils'
+require 'thor'
+require 'os'
+
+# Base command line module for samples. Provides authorization support,
+# either using application default credentials or user authorization
+# depending on the use case.
+class BaseCli < Thor
+  include Thor::Actions
+
+  OOB_URI = 'urn:ietf:wg:oauth:2.0:oob'
+
+  class_option :user, :type => :string
+  class_option :api_key, :type => :string
+
+  no_commands do
+
+    # Returns the path to the client_secrets.json file.
+    def client_secrets_path
+      return ENV['GOOGLE_CLIENT_SECRETS'] if ENV.has_key?('GOOGLE_CLIENT_SECRETS')
+      return well_known_path_for('client_secrets.json')
+    end
+
+    # Returns the path to the token store.
+    def token_store_path
+      return ENV['GOOGLE_CREDENTIAL_STORE'] if ENV.has_key?('GOOGLE_CREDENTIAL_STORE')
+      return well_known_path_for('credentials.yaml')
+    end
+
+    # Builds a path to a file in $HOME/.config/google (or %APPDATA%/google,
+    # on Windows)
+    def well_known_path_for(file)
+      if OS.windows?
+        File.join(ENV['APPDATA'], 'google', file)
+      else
+        File.join(ENV['HOME'], '.config', 'google', file)
+      end
+    end
+
+    # Returns application credentials for the given scope.
+    def application_credentials_for(scope)
+      Google::Auth.get_application_default(scope)
+    end
+
+    # Returns user credentials for the given scope. Requests authorization
+    # if requrired.
+    def user_credentials_for(scope)
+      FileUtils.mkdir_p(File.dirname(token_store_path))
+
+      if ENV['GOOGLE_CLIENT_ID']
+        client_id = Google::Auth::ClientId.new(ENV['GOOGLE_CLIENT_ID'], ENV['GOOGLE_CLIENT_SECRET'])
+      else
+        client_id = Google::Auth::ClientId.from_file(client_secrets_path)
+      end
+      token_store = Google::Auth::Stores::FileTokenStore.new(:file => token_store_path)
+      authorizer = Google::Auth::UserAuthorizer.new(client_id, scope, token_store)
+
+      user_id = options[:user] || 'default'
+
+      credentials = authorizer.get_credentials(user_id)
+      if credentials.nil?
+        url = authorizer.get_authorization_url(base_url: OOB_URI)
+        say "Open the following URL in your browser and authorize the application."
+        say url
+        code = ask "Enter the authorization code:"
+        credentials = authorizer.get_and_store_credentials_from_code(
+          user_id: user_id, code: code, base_url: OOB_URI)
+      end
+      credentials
+    end
+
+    # Gets the API key of the client
+    def api_key
+      ENV['GOOGLE_API_KEY'] || options[:api_key]
+    end
+
+  end
+end

data/samples/lib/samples/analytics.rb

@@ -0,0 +1,62 @@
+# Copyright 2016 Google Inc.
+#
+# 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.
+
+require 'google/apis/analytics_v3'
+require 'base_cli'
+
+module Samples
+  # Examples for the Google Analytics APIs
+  #
+  # Sample usage session:
+  #
+  #     $ ./google-api-samples analytics show_visits 55622900 --start='2015-12-01' --end='2015-12-08'
+  #     ga:date   ga:sessions  ga:users  ga:newUsers  ga:percentNewSessions  ga:sessionDuration  ga:avgSessionDuration
+  #     20151201  0            0         0            0.0                    0.0                 0.0
+  #     20151202  0            0         0            0.0                    0.0                 0.0
+  #     20151203  1            1         1            100.0                  0.0                 0.0
+  #     20151204  2            2         1            50.0                   616.0               308.0
+  #     20151205  0            0         0            0.0                    0.0                 0.0
+  #     20151206  1            1         1            100.0                  0.0                 0.0
+  #     20151207  0            0         0            0.0                    0.0                 0.0
+  #     20151208  2            2         1            50.0                   0.0                 0.0
+  #
+  class Analytics < BaseCli
+    Analytics = Google::Apis::AnalyticsV3
+
+    desc 'show_visits PROFILE_ID', 'Show visists for the given analytics profile ID'
+    method_option :start, type: :string, required: true
+    method_option :end, type: :string, required: true
+    def show_visits(profile_id)
+      analytics = Analytics::AnalyticsService.new
+      analytics.authorization = user_credentials_for(Analytics::AUTH_ANALYTICS)
+
+      dimensions = %w(ga:date)
+      metrics = %w(ga:sessions ga:users ga:newUsers ga:percentNewSessions
+                   ga:sessionDuration ga:avgSessionDuration)
+      sort = %w(ga:date)
+      result = analytics.get_ga_data("ga:#{profile_id}",
+                                     options[:start],
+                                     options[:end],
+                                     metrics.join(','),
+                                     dimensions: dimensions.join(','),
+                                     sort: sort.join(','))
+
+      data = []
+      data.push(result.column_headers.map { |h| h.name })
+      data.push(*result.rows)
+      print_table(data)
+    end
+
+  end
+end