google-api-client 0.8.6 → 0.9.3

data/samples/cli/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/cli/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/cli/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

data/samples/cli/lib/samples/pubsub.rb

@@ -0,0 +1,114 @@
+# 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/pubsub_v1'
+require 'base_cli'
+
+
+module Samples
+  # Examples for the Google Cloud Pub/Sub API.
+  #
+  # Sample usage session:
+  #
+  #     $ ./google-api-samples pubsub create_topic mytopic --project=623040240964
+  #     # ./google-api-samples pubsub subscribe mysub --topic=mytopic --project=623040240964
+  #     $ ./google-api-samples pubsub publish 'Hello!' --topic=mytopic --project=623040240964
+  #     $ ./google-api-samples pubsub pull mysub --project=623040240964
+  #     Received: Hello!
+  #     $ ./google-api-samples pubsub unsubscribe mysub --project=623040240964
+  #     $ ./google-api-samples pubsub delete_topic mytopic --project=623040240964
+  #
+  class PubSub < BaseCli
+    Pubsub = Google::Apis::PubsubV1
+
+    desc 'create_topic TOPIC_NAME', 'Create a topic'
+    method_option :project, type: :string, required: true
+    def create_topic(name)
+      pubsub = Pubsub::PubsubService.new
+      pubsub.authorization = Google::Auth.get_application_default([Pubsub::AUTH_PUBSUB])
+      topic = "projects/#{options[:project]}/topics/#{name}"
+
+      pubsub.create_topic(topic)
+    end
+
+    desc 'delete_topic TOPIC_NAME', 'Delete a topic'
+    method_option :project, type: :string, required: true
+    def delete_topic(name)
+      pubsub = Pubsub::PubsubService.new
+      pubsub.authorization = Google::Auth.get_application_default([Pubsub::AUTH_PUBSUB])
+
+      topic = "projects/#{options[:project]}/topics/#{name}"
+
+      pubsub.delete_topic(topic)
+    end
+
+    desc 'subscribe SUBSCRIPTION_NAME', 'Subscribe to a topic'
+    method_option :project, type: :string, required: true
+    method_option :topic, type: :string, required: true
+    def subscribe(name)
+      pubsub = Pubsub::PubsubService.new
+      pubsub.authorization = Google::Auth.get_application_default([Pubsub::AUTH_PUBSUB])
+
+      topic = "projects/#{options[:project]}/topics/#{options[:topic]}"
+      subscription = "projects/#{options[:project]}/subscriptions/#{name}"
+      pubsub.create_subscription(subscription, Pubsub::Subscription.new(topic: topic))
+    end
+
+    desc 'unsubscribe subscription_name', 'Ububscribe from a topic'
+    method_option :project, type: :string, required: true
+    def unsubscribe(name)
+      pubsub = Pubsub::PubsubService.new
+      pubsub.authorization = Google::Auth.get_application_default([Pubsub::AUTH_PUBSUB])
+
+      subscription = "projects/#{options[:project]}/subscriptions/#{name}"
+      pubsub.delete_subscription(subscription)
+    end
+
+
+    desc 'publish MESSAGE', 'Publish a message to a topic'
+    method_option :project, type: :string, required: true
+    method_option :topic, type: :string, required: true
+    def publish(message)
+      pubsub = Pubsub::PubsubService.new
+      pubsub.authorization = Google::Auth.get_application_default([Pubsub::AUTH_PUBSUB])
+      topic = "projects/#{options[:project]}/topics/#{options[:topic]}"
+
+      request = Pubsub::PublishRequest.new(messages: [])
+      request.messages << Pubsub::Message.new(data: message)
+
+      pubsub.publish_topic(topic, request)
+    end
+
+    desc 'pull SUBSCRIPTION_NAME', 'Pull message(s) from the topic'
+    method_option :project, type: :string, required: true
+    method_option :max, type: :numeric, default: 5
+    def pull(name)
+      pubsub = Pubsub::PubsubService.new
+      pubsub.authorization = Google::Auth.get_application_default([Pubsub::AUTH_PUBSUB])
+
+      subscription = "projects/#{options[:project]}/subscriptions/#{name}"
+
+      # Pull messages
+      response = pubsub.pull_subscription(subscription, Pubsub::PullRequest.new(max_messages: options[:max]))
+      response.received_messages.each do |received_message|
+        data = received_message.message.data
+        puts "Received: #{data}"
+      end
+
+      # Acknowledge receipt
+      ack_ids = response.received_messages.map{ |msg| msg.ack_id }
+      pubsub.acknowledge_subscription(subscription, Pubsub::AcknowledgeRequest.new(ack_ids: ack_ids))
+    end
+  end
+end

data/samples/cli/lib/samples/translate.rb

@@ -0,0 +1,44 @@
+# 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/translate_v2'
+require 'base_cli'
+
+
+module Samples
+  # Examples for the Google Translate API
+  #
+  # Sample usage:
+  #
+  #      $ ./google-api-samples translate 'Hola!' --target='en'
+  #      Hello
+  #
+  class Translate < BaseCli
+    Translate = Google::Apis::TranslateV2
+
+    desc 'translate PHRASE', 'Translate a phrase'
+    method_option :source, type: :string
+    method_option :target, type: :string, required: true
+    def translate(phrase)
+      translate = Translate::TranslateService.new
+      translate.key = api_key
+
+      result = translate.list_translations(phrase, options[:target], source: options[:source])
+      puts result.translations.first.translated_text
+    end
+
+    default_task :translate
+
+  end
+end

data/samples/cli/lib/samples/you_tube.rb

@@ -0,0 +1,44 @@
+# 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/youtube_v3'
+require 'base_cli'
+
+
+module Samples
+  # Examples for the YouTube APIs
+  #
+  # Sample usage:
+  #
+  #     $ ./google-api-samples youtube upload ~/myvideo.mov --title="So funny!"
+  #
+  class YouTube < BaseCli
+    YT = Google::Apis::YoutubeV3
+
+    desc 'upload FILE', 'Upload a video to YouTube'
+    method_option :title, type: :string
+    def upload(file)
+      youtube = YT::YouTubeService.new
+      youtube.authorization = user_credentials_for(YT::AUTH_YOUTUBE)
+
+      metadata  = {
+        snippet: {
+          title: options[:title] || file
+        }
+      }
+      result = youtube.insert_video('snippet', metadata, upload_source: file)
+      say "Upload complete"
+    end
+  end
+end

data/samples/web/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gem 'google-api-client', '~> 0.9'
+gem 'google-id-token', '~> 1.3'
+gem 'sinatra', '~> 1.4'
+gem 'redis', '~> 3.2'
+gem 'dotenv'

data/samples/web/README.md

@@ -0,0 +1,44 @@
+# API Samples
+
+This directory contains a simple Sinatra web app illustrating how to use the client
+in a server-side web environment.
+
+It illustrates a few key concepts:
+
+* Using [Google Sign-in](https://developers.google.com/identity) for authentication.
+* Using the [googleauth gem](https://github.com/google/google-auth-library-ruby) to
+  request incremental authorization as more permissions are needed.
+
+# Setup
+
+* Create a project at https://console.developers.google.com
+* Go to the `API Manager` and enable the `Drive` and `Calendar` APIs
+* Go to `Credentials` and create a new OAuth Client ID of type 'Web application'
+    * Use `http://localhost:4567/oauth2callback` as the redirect URL
+    * Use `http://localhost:4567` as the JavaScript origin
+
+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_CLIENT_ID=479164972499-i7j6av7bp2s4on5ltb7pjXXXXXXXXXX.apps.googleusercontent.com
+GOOGLE_CLIENT_SECRET=JBotCTG5biFWGzXXXXXXXXXX
+```
+
+# Running the samples
+
+To start the server, run
+
+```
+ruby app.rb
+```
+
+Open `http://localhost:4567/` in your browser to explore the sample.
+

data/samples/web/app.rb

@@ -0,0 +1,120 @@
+# 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 'sinatra'
+require 'googleauth'
+require 'googleauth/stores/redis_token_store'
+require 'google/apis/drive_v3'
+require 'google/apis/calendar_v3'
+require 'google-id-token'
+require 'dotenv'
+
+LOGIN_URL = '/'
+
+configure do
+  Dotenv.load
+
+  Google::Apis::ClientOptions.default.application_name = 'Ruby client samples'
+  Google::Apis::ClientOptions.default.application_version = '0.9'
+  Google::Apis::RequestOptions.default.retries = 3
+
+  enable :sessions
+  set :show_exceptions, false
+  set :client_id, Google::Auth::ClientId.new(ENV['GOOGLE_CLIENT_ID'],
+                                             ENV['GOOGLE_CLIENT_SECRET'])
+  set :token_store, Google::Auth::Stores::RedisTokenStore.new(redis: Redis.new)
+end
+
+helpers do
+  # Returns credentials authorized for the requested scopes. If no credentials are available,
+  # redirects the user to authorize access.
+  def credentials_for(scope)
+    authorizer = Google::Auth::WebUserAuthorizer.new(settings.client_id, scope, settings.token_store)
+    user_id = session[:user_id]
+    redirect LOGIN_URL if user_id.nil?
+    credentials = authorizer.get_credentials(user_id, request)
+    if credentials.nil?
+      redirect authorizer.get_authorization_url(login_hint: user_id, request: request)
+    end
+    credentials
+  end
+
+  def resize(url, width)
+    url.sub(/s220/, sprintf('s%d', width))
+  end
+end
+
+# Home page
+get('/') do
+  @client_id = settings.client_id.id
+  erb :home
+end
+
+# Log in the user by validating the identity token generated by the Google Sign-In button.
+# This checks that the token is signed by Google, current, and is intended for this application.
+#
+post('/signin') do
+  audience = settings.client_id.id
+  # Important: The google-id-token gem is not production ready. If using, consider fetching and
+  # supplying the valid keys separately rather than using the built-in certificate fetcher.
+  validator = GoogleIDToken::Validator.new
+  claim = validator.check(params['id_token'], audience, audience)
+  if claim
+    session[:user_id] = claim['sub']
+    session[:user_email] = claim['email']
+    200
+  else
+    logger.info('No valid identity token present')
+    401
+  end
+end
+
+# Retrieve the 10 most recently modified files in Google Drive
+get('/drive') do
+  drive = Google::Apis::DriveV3::DriveService.new
+  drive.authorization = credentials_for(Google::Apis::DriveV3::AUTH_DRIVE)
+  @result = drive.list_files(page_size: 10,
+                             fields: 'files(name,modified_time,web_view_link),next_page_token')
+  erb :drive
+end
+
+# Retrieve the next 10 upcoming events from Google Calendar
+get('/calendar') do
+  calendar = Google::Apis::CalendarV3::CalendarService.new
+  calendar.authorization = credentials_for(Google::Apis::CalendarV3::AUTH_CALENDAR)
+  calendar_id = 'primary'
+  @result = calendar.list_events(calendar_id,
+                                 max_results: 10,
+                                 single_events: true,
+                                 order_by: 'startTime',
+                                 time_min: Time.now.iso8601)
+  erb :calendar
+end
+
+
+# Callback for authorization requests. This saves the autorization code and
+# redirects back to the URL that originally requested authorization. The code is
+# redeemed on the next request.
+#
+# Important: While the deferred approach is generally easier, it doesn't play well
+# with developer mode and sinatra's default cookie-based session implementation. Changes to the
+# session state are lost if the page doesn't render due to error, which can lead to further
+# errors indicating the code has already been redeemed.
+#
+# Disabling show_exceptions or using a different session provider (E.g. Rack::Session::Memcache)
+# avoids the issue.
+get('/oauth2callback') do
+  target_url = Google::Auth::WebUserAuthorizer.handle_auth_callback_deferred(request)
+  redirect target_url
+end

data/samples/web/views/calendar.erb

@@ -0,0 +1,34 @@
+<%#
+# 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.
+%>
+<section>
+  <h5>Next 10 events</h5>
+  <table class="">
+    <thead>
+    <tr>
+      <th class="">Time</th>
+      <th class="">Summary</th>
+    </tr>
+    </thead>
+    <tbody>
+    <% @result.items.each do |event| %>
+        <tr>
+          <td class=""><%= event.start.date_time || event.start.date %></td>
+          <td class=""><%= event.summary %></td>
+        </tr>
+    <% end %>
+    </tbody>
+  </table>
+</section>

data/{lib/google/api_client/service_account.rb → samples/web/views/drive.erb}

@@ -1,4 +1,5 @@
-# Copyright 2010 Google Inc.
+<%#
+# 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.
@@ -11,11 +12,22 @@
 # 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/api_client/auth/pkcs12'
-require 'google/api_client/auth/jwt_asserter'
-require 'google/api_client/auth/key_utils'
-require 'google/api_client/auth/compute_service_account'
-require 'google/api_client/auth/storage'
-require 'google/api_client/auth/storages/redis_store'
-require 'google/api_client/auth/storages/file_store'
+<h5>10 most recently modified files</h5>
+<table class="">
+  <thead>
+    <tr>
+      <th class="">Name</th>
+      <th class="">Last Modified</th>
+    </tr>
+  </thead>
+  <tbody>
+  <% @result.files.each do |file| %>
+      <tr>
+        <td class=""><a href="<%= file.web_view_link %>"><%= file.name %></a></td>
+        <td class=""><%= file.modified_time %></td>
+      </tr>
+  <% end %>
+  </tbody>
+</table>