google-api-client 0.8.6 → 0.9

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

data/samples/lib/samples/calendar.rb

@@ -0,0 +1,83 @@
+# 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/calendar_v3'
+require 'base_cli'
+
+
+module Samples
+  # Examples for the Google Calendar API
+  #
+  # Sample usage:
+  #
+  #     $ ./google-api-samples calendar list --limit 10
+  class Calendar < BaseCli
+    Calendar = Google::Apis::CalendarV3
+
+    desc 'schedule', 'Create an event'
+    method_option :summary, type: :string, required: true
+    method_option :start, type: :string, required: true
+    method_option :end , type: :string, required: true
+    method_option :attendees, type: :array
+    def schedule
+      calendar = Calendar::CalendarService.new
+      calendar.authorization = user_credentials_for(Calendar::AUTH_CALENDAR)
+
+      event = {
+        summary: options[:summary],
+        attendees: Array(options[:attenddes]).map { |email| { email: email } },
+        start: {
+          date_time: DateTime.parse(options[:start])
+        },
+        end: {
+          date_time: DateTime.parse(options[:end])
+        }
+      }
+
+      event = calendar.insert_event('primary', event, send_notifications: true)
+      say "Created event '#{event.summary}' (#{event.id})"
+    end
+
+    desc 'list', 'List upcoming events'
+    method_option :limit, type: :numeric
+    def list()
+      calendar = Calendar::CalendarService.new
+      calendar.authorization = user_credentials_for(Calendar::AUTH_CALENDAR)
+
+      page_token = nil
+      limit = options[:limit] || 1000
+      now = Time.now.iso8601
+      begin
+        result = calendar.list_events('primary',
+                                      max_results: [limit, 100].min,
+                                      single_events: true,
+                                      order_by: 'startTime',
+                                      time_min: now,
+                                      page_token: page_token,
+                                      fields: 'items(id,summary,start),next_page_token')
+
+        result.items.each do |event|
+          time = event.start.date_time || event.start.date
+          say "#{time}, #{event.summary}"
+        end
+        limit -= result.items.length
+        if result.next_page_token
+          page_token = result.next_page_token
+        else
+          page_token = nil
+        end
+      end while !page_token.nil? && limit > 0
+    end
+  end
+end

data/samples/lib/samples/drive.rb

@@ -0,0 +1,82 @@
+# 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/drive_v3'
+require 'base_cli'
+
+
+module Samples
+  # Examples for the Google Drive API
+  #
+  # Sample usage:
+  #
+  #     $ ./google-api-samples drive upload ~/myvideo.mov
+  class Drive < BaseCli
+    Drive = Google::Apis::DriveV3
+
+    desc 'upload FILE', 'Upload a file to Google Drive'
+    method_option :name, type: :string
+    def upload(file)
+      drive = Drive::DriveService.new
+      drive.authorization = user_credentials_for(Drive::AUTH_DRIVE)
+
+      metadata  = {
+        name: options[:name] || file
+      }
+      result = drive.create_file(metadata, upload_source: file)
+      say "Upload complete"
+    end
+
+    desc 'download FILE_ID', 'Download a file from Google Drive'
+    method_option :out, type: :string
+    def download(file_id)
+      drive = Drive::DriveService.new
+      drive.authorization = user_credentials_for(Drive::AUTH_DRIVE)
+
+      dest = options[:out] || StringIO.new
+      drive.get_file(file_id, download_dest: dest)
+
+      if dest.is_a?(StringIO)
+        dest.rewind
+        STDOUT.write(dest.read)
+      else
+        say "File downloaded to #{options[:out]}"
+      end
+    end
+
+    desc 'list QUERY', 'Search for files'
+    method_option :limit, type: :numeric
+    def list(query)
+      drive = Drive::DriveService.new
+      drive.authorization = user_credentials_for(Drive::AUTH_DRIVE)
+
+      page_token = nil
+      limit = options[:limit] || 1000
+      begin
+        result = drive.list_files(q: query,
+                                  page_size: [limit, 100].min,
+                                  page_token: page_token,
+                                  fields: 'files(id,name),next_page_token')
+
+        result.files.each { |file| puts "#{file.id}, #{file.name}" }
+        limit -= result.files.length
+        if result.next_page_token
+          page_token = result.next_page_token
+        else
+          page_token = nil
+        end
+      end while !page_token.nil? && limit > 0
+    end
+  end
+end

data/samples/lib/samples/gmail.rb

@@ -0,0 +1,50 @@
+# 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/gmail_v1'
+require 'base_cli'
+require 'rmail'
+
+module Samples
+  # Examples for the Gmail API
+  #
+  # Sample usage:
+  #
+  #     $ ./google-api-samples gmail send 'Hello there!' \
+  #       --to='recipient@example.com' --from='user@example.com' \
+  #       --subject='Hello'
+  #
+  class Gmail < BaseCli
+    Gmail = Google::Apis::GmailV1
+
+    desc 'send TEXT', 'Send a message with the gmail API'
+    method_option :to, type: :string, required: true
+    method_option :from, type: :string, required: true
+    method_option :subject, type: :string, required: true
+    def send(body)
+      gmail = Gmail::GmailService.new
+      gmail.authorization = user_credentials_for(Gmail::AUTH_SCOPE)
+
+      message = RMail::Message.new
+      message.header['To'] = options[:to]
+      message.header['From'] = options[:from]
+      message.header['Subject'] = options[:subject]
+      message.body = body
+
+      gmail.send_user_message('me',
+                              upload_source: StringIO.new(message.to_s),
+                              content_type: 'message/rfc822')
+    end
+  end
+end