Skip to content

Commit 8ce4d05

Browse files
sqrrrlsqrrrl
committed
Add oauth helper for installed apps, update CLI
1 parent 1d7315e commit 8ce4d05

File tree

2 files changed

+139
-172
lines changed

2 files changed

+139
-172
lines changed

‎bin/google-api

+24-172
Original file line numberDiff line numberDiff line change
@@ -15,45 +15,13 @@ require 'faraday/utils'
1515
require 'webrick'
1616
require 'google/api_client/version'
1717
require 'google/api_client'
18+
require 'google/api_client/auth/installed_app'
1819

1920
ARGV.unshift('--help') if ARGV.empty?
2021

2122
module Google
2223
class APIClient
2324
class CLI
24-
# Used for oauth login
25-
class OAuthVerifierServlet < WEBrick::HTTPServlet::AbstractServlet
26-
attr_reader :verifier
27-
28-
def do_GET(request, response)
29-
$verifier ||= Addressable::URI.unencode_component(
30-
request.request_uri.to_s[/\?.*oauth_verifier=([^&$]+)(&|$)/, 1] ||
31-
request.request_uri.to_s[/\?.*code=([^&$]+)(&|$)/, 1]
32-
)
33-
response.status = WEBrick::HTTPStatus::RC_ACCEPTED
34-
# This javascript will auto-close the tab after the
35-
# verifier is obtained.
36-
response.body = <<-HTML
37-
<html>
38-
<head>
39-
<script>
40-
function closeWindow() {
41-
window.open('', '_self', '');
42-
window.close();
43-
}
44-
setTimeout(closeWindow, 10);
45-
</script>
46-
</head>
47-
<body>
48-
You may close this window.
49-
</body>
50-
</html>
51-
HTML
52-
# Eww, hack!
53-
server = self.instance_variable_get('@server')
54-
server.stop if server
55-
end
56-
end
5725

5826
# Initialize with default parameter values
5927
def initialize(argv)
@@ -164,8 +132,7 @@ HTML
164132

165133
opts.separator(
166134
"\nAvailable commands:\n" +
167-
" oauth-1-login Log a user into an API with OAuth 1.0a\n" +
168-
" oauth-2-login Log a user into an API with OAuth 2.0 d10\n" +
135+
" oauth-2-login Log a user into an API with OAuth 2.0\n" +
169136
" list List the methods available for an API\n" +
170137
" execute Execute a method on the API\n" +
171138
" irb Start an interactive client session"
@@ -184,9 +151,7 @@ HTML
184151
end
185152

186153
def client
187-
require 'signet/oauth_1/client'
188154
require 'yaml'
189-
require 'irb'
190155
config_file = File.expand_path('~/.google-api.yaml')
191156
authorization = nil
192157
if File.exist?(config_file)
@@ -198,19 +163,14 @@ HTML
198163
authorization = config["mechanism"].to_sym
199164
end
200165

201-
client = Google::APIClient.new(:authorization => authorization)
166+
client = Google::APIClient.new(
167+
:application_name => 'Ruby CLI',
168+
:application_version => Google::APIClient::VERSION::STRING,
169+
:authorization => authorization)
202170

203171
case authorization
204172
when :oauth_1
205-
if client.authorization &&
206-
!client.authorization.kind_of?(Signet::OAuth1::Client)
207-
STDERR.puts(
208-
"Unexpected authorization mechanism: " +
209-
"#{client.authorization.class}"
210-
)
211-
exit(1)
212-
end
213-
config = open(config_file, 'r') { |file| YAML.load(file.read) }
173+
STDERR.puts('OAuth 1 is deprecated. Please reauthorize with OAuth 2.')
214174
client.authorization.client_credential_key =
215175
config["client_credential_key"]
216176
client.authorization.client_credential_secret =
@@ -220,15 +180,6 @@ HTML
220180
client.authorization.token_credential_secret =
221181
config["token_credential_secret"]
222182
when :oauth_2
223-
if client.authorization &&
224-
!client.authorization.kind_of?(Signet::OAuth2::Client)
225-
STDERR.puts(
226-
"Unexpected authorization mechanism: " +
227-
"#{client.authorization.class}"
228-
)
229-
exit(1)
230-
end
231-
config = open(config_file, 'r') { |file| YAML.load(file.read) }
232183
client.authorization.scope = options[:scope]
233184
client.authorization.client_id = config["client_id"]
234185
client.authorization.client_secret = config["client_secret"]
@@ -268,84 +219,14 @@ HTML
268219
end
269220

270221
COMMANDS = [
271-
:oauth_1_login,
272222
:oauth_2_login,
273223
:list,
274224
:execute,
275225
:irb,
276-
:fuzz
277226
]
278227

279-
def oauth_1_login
280-
require 'signet/oauth_1/client'
281-
require 'launchy'
282-
require 'yaml'
283-
if options[:client_credential_key] &&
284-
options[:client_credential_secret]
285-
config = {
286-
"mechanism" => "oauth_1",
287-
"scope" => options[:scope],
288-
"client_credential_key" => options[:client_credential_key],
289-
"client_credential_secret" => options[:client_credential_secret],
290-
"token_credential_key" => nil,
291-
"token_credential_secret" => nil
292-
}
293-
config_file = File.expand_path('~/.google-api.yaml')
294-
open(config_file, 'w') { |file| file.write(YAML.dump(config)) }
295-
exit(0)
296-
else
297-
$verifier = nil
298-
server = WEBrick::HTTPServer.new(
299-
:Port => OAUTH_SERVER_PORT,
300-
:Logger => WEBrick::Log.new,
301-
:AccessLog => WEBrick::Log.new
302-
)
303-
server.logger.level = 0
304-
trap("INT") { server.shutdown }
305-
306-
server.mount("/", OAuthVerifierServlet)
307-
308-
oauth_client = Signet::OAuth1::Client.new(
309-
:temporary_credential_uri =>
310-
'https://www.google.com/accounts/OAuthGetRequestToken',
311-
:authorization_uri =>
312-
'https://www.google.com/accounts/OAuthAuthorizeToken',
313-
:token_credential_uri =>
314-
'https://www.google.com/accounts/OAuthGetAccessToken',
315-
:client_credential_key => 'anonymous',
316-
:client_credential_secret => 'anonymous',
317-
:callback => "http://localhost:#{OAUTH_SERVER_PORT}/"
318-
)
319-
oauth_client.fetch_temporary_credential!(:additional_parameters => {
320-
:scope => options[:scope],
321-
:xoauth_displayname => 'Google API Client'
322-
})
323-
324-
# Launch browser
325-
Launchy::Browser.run(oauth_client.authorization_uri.to_s)
326-
327-
server.start
328-
oauth_client.fetch_token_credential!(:verifier => $verifier)
329-
config = {
330-
"scope" => options[:scope],
331-
"client_credential_key" =>
332-
oauth_client.client_credential_key,
333-
"client_credential_secret" =>
334-
oauth_client.client_credential_secret,
335-
"token_credential_key" =>
336-
oauth_client.token_credential_key,
337-
"token_credential_secret" =>
338-
oauth_client.token_credential_secret
339-
}
340-
config_file = File.expand_path('~/.google-api.yaml')
341-
open(config_file, 'w') { |file| file.write(YAML.dump(config)) }
342-
exit(0)
343-
end
344-
end
345-
346228
def oauth_2_login
347229
require 'signet/oauth_2/client'
348-
require 'launchy'
349230
require 'yaml'
350231
if !options[:client_credential_key] ||
351232
!options[:client_credential_secret]
@@ -365,45 +246,26 @@ HTML
365246
open(config_file, 'w') { |file| file.write(YAML.dump(config)) }
366247
exit(0)
367248
else
368-
$verifier = nil
369-
logger = WEBrick::Log.new
370-
logger.level = 0
371-
server = WEBrick::HTTPServer.new(
372-
:Port => OAUTH_SERVER_PORT,
373-
:Logger => logger,
374-
:AccessLog => logger
375-
)
376-
trap("INT") { server.shutdown }
377-
378-
server.mount("/", OAuthVerifierServlet)
379-
380-
oauth_client = Signet::OAuth2::Client.new(
381-
:authorization_uri =>
382-
'https://www.google.com/accounts/o8/oauth2/authorization',
383-
:token_credential_uri =>
384-
'https://www.google.com/accounts/o8/oauth2/token',
249+
flow = Google::APIClient::InstalledAppFlow.new(
250+
:port => OAUTH_SERVER_PORT,
385251
:client_id => options[:client_credential_key],
386252
:client_secret => options[:client_credential_secret],
387-
:redirect_uri => "http://localhost:#{OAUTH_SERVER_PORT}/",
388253
:scope => options[:scope]
389254
)
390-
391-
# Launch browser
392-
Launchy.open(oauth_client.authorization_uri.to_s)
393-
394-
server.start
395-
oauth_client.code = $verifier
396-
oauth_client.fetch_access_token!
397-
config = {
398-
"mechanism" => "oauth_2",
399-
"scope" => options[:scope],
400-
"client_id" => oauth_client.client_id,
401-
"client_secret" => oauth_client.client_secret,
402-
"access_token" => oauth_client.access_token,
403-
"refresh_token" => oauth_client.refresh_token
404-
}
405-
config_file = File.expand_path('~/.google-api.yaml')
406-
open(config_file, 'w') { |file| file.write(YAML.dump(config)) }
255+
256+
oauth_client = flow.authorize
257+
if oauth_client
258+
config = {
259+
"mechanism" => "oauth_2",
260+
"scope" => options[:scope],
261+
"client_id" => oauth_client.client_id,
262+
"client_secret" => oauth_client.client_secret,
263+
"access_token" => oauth_client.access_token,
264+
"refresh_token" => oauth_client.refresh_token
265+
}
266+
config_file = File.expand_path('~/.google-api.yaml')
267+
open(config_file, 'w') { |file| file.write(YAML.dump(config)) }
268+
end
407269
exit(0)
408270
end
409271
end
@@ -414,7 +276,7 @@ HTML
414276
STDERR.puts('No API name supplied.')
415277
exit(1)
416278
end
417-
client = Google::APIClient.new(:authorization => nil)
279+
#client = Google::APIClient.new(:authorization => nil)
418280
if options[:discovery_uri]
419281
if options[:api] && options[:version]
420282
client.register_discovery_uri(
@@ -517,16 +379,6 @@ HTML
517379
IRB.start(__FILE__)
518380
end
519381

520-
def fuzz
521-
STDERR.puts('API fuzzing not yet supported.')
522-
if self.rpcname
523-
# Fuzz just one method
524-
else
525-
# Fuzz the entire API
526-
end
527-
exit(1)
528-
end
529-
530382
def help
531383
puts self.parser
532384
exit(0)

‎lib/google/api_client/auth/installed_app.rb

+115
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,115 @@
1+
# Copyright 2010 Google Inc.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
require 'webrick'
16+
require 'launchy'
17+
18+
module Google
19+
class APIClient
20+
21+
# Small helper for the sample apps for performing OAuth 2.0 flows from the command
22+
# line or in any other installed app environment.
23+
#
24+
# @example
25+
#
26+
# client = Google::APIClient.new
27+
# flow = Google::APIClient::InstalledAppFlow.new(
28+
# :client_id => '691380668085.apps.googleusercontent.com',
29+
# :client_secret => '...,
30+
# :scope => 'https://www.googleapis.com/auth/drive'
31+
# )
32+
# client.authorization = flow.authorize
33+
#
34+
class InstalledAppFlow
35+
36+
RESPONSE_BODY = <<-HTML
37+
<html>
38+
<head>
39+
<script>
40+
function closeWindow() {
41+
window.open('', '_self', '');
42+
window.close();
43+
}
44+
setTimeout(closeWindow, 10);
45+
</script>
46+
</head>
47+
<body>You may close this window.</body>
48+
</html>
49+
HTML
50+
51+
##
52+
# Configure the flow
53+
#
54+
# @param [Hash] options The configuration parameters for the client.
55+
# @option options [Fixnum] :port
56+
# Port to run the embedded server on. Defaults to 9292
57+
# @option options [String] :client_id
58+
# A unique identifier issued to the client to identify itself to the
59+
# authorization server.
60+
# @option options [String] :client_secret
61+
# A shared symmetric secret issued by the authorization server,
62+
# which is used to authenticate the client.
63+
# @option options [String] :scope
64+
# The scope of the access request, expressed either as an Array
65+
# or as a space-delimited String.
66+
#
67+
# @see Signet::OAuth2::Client
68+
def initialize(options)
69+
@port = options[:port] || 9292
70+
@authorization = Signet::OAuth2::Client.new({
71+
:authorization_uri => 'https://accounts.google.com/o/oauth2/auth',
72+
:token_credential_uri => 'https://accounts.google.com/o/oauth2/token',
73+
:redirect_uri => "http://localhost:#{@port}/"}.update(options)
74+
)
75+
end
76+
77+
##
78+
# Request authorization. Opens a browser and waits for response.
79+
#
80+
# @return [Signet::OAuth2::Client]
81+
# Authorization instance, nil if user cancelled.
82+
def authorize
83+
auth = @authorization
84+
85+
server = WEBrick::HTTPServer.new(
86+
:Port => @port,
87+
:BindAddress =>"localhost",
88+
:Logger => WEBrick::Log.new(STDOUT, 0),
89+
:AccessLog => []
90+
)
91+
trap("INT") { server.shutdown }
92+
93+
server.mount_proc '/' do |req, res|
94+
auth.code = req.query['code']
95+
if auth.code
96+
auth.fetch_access_token!
97+
end
98+
res.status = WEBrick::HTTPStatus::RC_ACCEPTED
99+
res.body = RESPONSE_BODY
100+
server.stop
101+
end
102+
103+
Launchy.open(auth.authorization_uri.to_s)
104+
server.start
105+
if @authorization.access_token
106+
return @authorization
107+
else
108+
return nil
109+
end
110+
end
111+
end
112+
113+
end
114+
end
115+

0 commit comments

Comments
 (0)