2013-01-05 00:14:59 +00:00
|
|
|
# Copyright 2010 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 'webrick'
|
2018-12-05 18:51:45 +00:00
|
|
|
|
|
|
|
|
launchy_available =
|
|
|
|
|
begin
|
|
|
|
|
require 'launchy'
|
|
|
|
|
true
|
|
|
|
|
rescue LoadError
|
|
|
|
|
warn "Attempted to require google/api_client/auth/installed_app.rb when" \
|
|
|
|
|
" launchy is not available. The InstalledAppFlow class is disabled."
|
|
|
|
|
false
|
|
|
|
|
end
|
2013-01-05 00:14:59 +00:00
|
|
|
|
|
|
|
|
module Google
|
|
|
|
|
class APIClient
|
|
|
|
|
|
|
|
|
|
# Small helper for the sample apps for performing OAuth 2.0 flows from the command
|
|
|
|
|
# line or in any other installed app environment.
|
|
|
|
|
#
|
2018-12-05 18:51:45 +00:00
|
|
|
# This class is used in some sample apps and tests but is not really part
|
|
|
|
|
# of the client libraries, and probably does not belong here. As such, it
|
|
|
|
|
# is deprecated. If you do choose to use it, note that you must include the
|
|
|
|
|
# `launchy` gem in your bundle, as it is required by this class but not
|
|
|
|
|
# listed in the google-api-client gem's requirements.
|
|
|
|
|
#
|
2013-01-05 00:14:59 +00:00
|
|
|
# @example
|
|
|
|
|
#
|
|
|
|
|
# flow = Google::APIClient::InstalledAppFlow.new(
|
|
|
|
|
# :client_id => '691380668085.apps.googleusercontent.com',
|
2014-12-15 21:02:51 +00:00
|
|
|
# :client_secret => '...',
|
2013-01-05 00:14:59 +00:00
|
|
|
# :scope => 'https://www.googleapis.com/auth/drive'
|
|
|
|
|
# )
|
2015-07-20 23:53:06 +00:00
|
|
|
# authorization = flow.authorize
|
|
|
|
|
# Drive = Google::Apis::DriveV2
|
|
|
|
|
# drive = Drive::DriveService.new
|
|
|
|
|
# drive.authorization = authorization
|
2013-01-05 00:14:59 +00:00
|
|
|
#
|
2015-12-15 01:42:17 +00:00
|
|
|
# @deprecated Use google-auth-library-ruby instead
|
2013-01-05 00:14:59 +00:00
|
|
|
class InstalledAppFlow
|
2015-01-10 00:02:40 +00:00
|
|
|
|
2013-01-05 00:14:59 +00:00
|
|
|
RESPONSE_BODY = <<-HTML
|
|
|
|
|
<html>
|
|
|
|
|
<head>
|
|
|
|
|
<script>
|
2015-01-10 00:02:40 +00:00
|
|
|
function closeWindow() {
|
2013-01-05 00:14:59 +00:00
|
|
|
window.open('', '_self', '');
|
|
|
|
|
window.close();
|
|
|
|
|
}
|
|
|
|
|
setTimeout(closeWindow, 10);
|
|
|
|
|
</script>
|
|
|
|
|
</head>
|
|
|
|
|
<body>You may close this window.</body>
|
|
|
|
|
</html>
|
|
|
|
|
HTML
|
2015-01-10 00:02:40 +00:00
|
|
|
|
2013-01-05 00:14:59 +00:00
|
|
|
##
|
|
|
|
|
# Configure the flow
|
|
|
|
|
#
|
|
|
|
|
# @param [Hash] options The configuration parameters for the client.
|
|
|
|
|
# @option options [Fixnum] :port
|
|
|
|
|
# Port to run the embedded server on. Defaults to 9292
|
2015-01-10 00:02:40 +00:00
|
|
|
# @option options [String] :client_id
|
2013-01-05 00:14:59 +00:00
|
|
|
# A unique identifier issued to the client to identify itself to the
|
|
|
|
|
# authorization server.
|
|
|
|
|
# @option options [String] :client_secret
|
|
|
|
|
# A shared symmetric secret issued by the authorization server,
|
|
|
|
|
# which is used to authenticate the client.
|
|
|
|
|
# @option options [String] :scope
|
|
|
|
|
# The scope of the access request, expressed either as an Array
|
|
|
|
|
# or as a space-delimited String.
|
|
|
|
|
#
|
|
|
|
|
# @see Signet::OAuth2::Client
|
|
|
|
|
def initialize(options)
|
|
|
|
|
@port = options[:port] || 9292
|
|
|
|
|
@authorization = Signet::OAuth2::Client.new({
|
|
|
|
|
:authorization_uri => 'https://accounts.google.com/o/oauth2/auth',
|
|
|
|
|
:token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
|
|
|
|
|
:redirect_uri => "http://localhost:#{@port}/"}.update(options)
|
|
|
|
|
)
|
|
|
|
|
end
|
2015-01-10 00:02:40 +00:00
|
|
|
|
2013-01-05 00:14:59 +00:00
|
|
|
##
|
|
|
|
|
# Request authorization. Opens a browser and waits for response.
|
|
|
|
|
#
|
2015-01-10 00:02:40 +00:00
|
|
|
# @param [Google::APIClient::Storage] storage
|
2013-05-29 19:31:44 +00:00
|
|
|
# Optional object that responds to :write_credentials, used to serialize
|
|
|
|
|
# the OAuth 2 credentials after completing the flow.
|
|
|
|
|
#
|
2013-01-05 00:14:59 +00:00
|
|
|
# @return [Signet::OAuth2::Client]
|
|
|
|
|
# Authorization instance, nil if user cancelled.
|
2015-10-02 20:41:59 +00:00
|
|
|
def authorize(storage=nil, options={})
|
2013-01-05 00:14:59 +00:00
|
|
|
auth = @authorization
|
2015-01-10 00:02:40 +00:00
|
|
|
|
2013-01-05 00:14:59 +00:00
|
|
|
server = WEBrick::HTTPServer.new(
|
|
|
|
|
:Port => @port,
|
|
|
|
|
:BindAddress =>"localhost",
|
|
|
|
|
:Logger => WEBrick::Log.new(STDOUT, 0),
|
|
|
|
|
:AccessLog => []
|
|
|
|
|
)
|
2013-11-19 23:22:28 +00:00
|
|
|
begin
|
|
|
|
|
trap("INT") { server.shutdown }
|
|
|
|
|
|
|
|
|
|
server.mount_proc '/' do |req, res|
|
2013-01-05 00:14:59 +00:00
|
|
|
auth.code = req.query['code']
|
|
|
|
|
if auth.code
|
|
|
|
|
auth.fetch_access_token!
|
|
|
|
|
end
|
|
|
|
|
res.status = WEBrick::HTTPStatus::RC_ACCEPTED
|
|
|
|
|
res.body = RESPONSE_BODY
|
|
|
|
|
server.stop
|
2013-11-19 23:22:28 +00:00
|
|
|
end
|
2013-01-05 00:14:59 +00:00
|
|
|
|
2015-07-20 19:37:03 +00:00
|
|
|
Launchy.open(auth.authorization_uri(options).to_s)
|
2013-11-19 23:22:28 +00:00
|
|
|
server.start
|
|
|
|
|
ensure
|
|
|
|
|
server.shutdown
|
|
|
|
|
end
|
2013-01-05 00:14:59 +00:00
|
|
|
if @authorization.access_token
|
2013-05-29 19:31:44 +00:00
|
|
|
if storage.respond_to?(:write_credentials)
|
|
|
|
|
storage.write_credentials(@authorization)
|
|
|
|
|
end
|
2013-01-05 00:14:59 +00:00
|
|
|
return @authorization
|
|
|
|
|
else
|
|
|
|
|
return nil
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
end
|
2018-12-05 18:51:45 +00:00
|
|
|
end if launchy_available
|
