gdata-19 1.1.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +8 -0
- data/Gemfile +4 -0
- data/LICENSE +202 -0
- data/README +97 -0
- data/Rakefile +2 -0
- data/gdata.gemspec +44 -0
- data/lib/gdata.rb +24 -0
- data/lib/gdata/auth.rb +22 -0
- data/lib/gdata/auth/authsub.rb +161 -0
- data/lib/gdata/auth/clientlogin.rb +102 -0
- data/lib/gdata/client.rb +84 -0
- data/lib/gdata/client/apps.rb +27 -0
- data/lib/gdata/client/base.rb +182 -0
- data/lib/gdata/client/blogger.rb +28 -0
- data/lib/gdata/client/booksearch.rb +28 -0
- data/lib/gdata/client/calendar.rb +58 -0
- data/lib/gdata/client/contacts.rb +28 -0
- data/lib/gdata/client/doclist.rb +28 -0
- data/lib/gdata/client/finance.rb +28 -0
- data/lib/gdata/client/gbase.rb +28 -0
- data/lib/gdata/client/gmail.rb +28 -0
- data/lib/gdata/client/health.rb +28 -0
- data/lib/gdata/client/notebook.rb +28 -0
- data/lib/gdata/client/photos.rb +29 -0
- data/lib/gdata/client/spreadsheets.rb +28 -0
- data/lib/gdata/client/webmaster_tools.rb +28 -0
- data/lib/gdata/client/youtube.rb +47 -0
- data/lib/gdata/http.rb +18 -0
- data/lib/gdata/http/default_service.rb +82 -0
- data/lib/gdata/http/mime_body.rb +95 -0
- data/lib/gdata/http/request.rb +74 -0
- data/lib/gdata/http/response.rb +44 -0
- data/lib/gdata/version.rb +3 -0
- data/test/tc_gdata_auth_authsub.rb +54 -0
- data/test/tc_gdata_auth_clientlogin.rb +60 -0
- data/test/tc_gdata_client_base.rb +38 -0
- data/test/tc_gdata_client_calendar.rb +41 -0
- data/test/tc_gdata_client_photos.rb +66 -0
- data/test/tc_gdata_client_youtube.rb +78 -0
- data/test/tc_gdata_http_mime_body.rb +47 -0
- data/test/tc_gdata_http_request.rb +37 -0
- data/test/test_config.yml.example +7 -0
- data/test/test_helper.rb +47 -0
- data/test/testimage.jpg +0 -0
- data/test/ts_gdata.rb +44 -0
- data/test/ts_gdata_auth.rb +26 -0
- data/test/ts_gdata_client.rb +30 -0
- data/test/ts_gdata_http.rb +25 -0
- metadata +129 -0
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE
ADDED
@@ -0,0 +1,202 @@
|
|
1
|
+
|
2
|
+
Apache License
|
3
|
+
Version 2.0, January 2004
|
4
|
+
http://www.apache.org/licenses/
|
5
|
+
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
7
|
+
|
8
|
+
1. Definitions.
|
9
|
+
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
12
|
+
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
14
|
+
the copyright owner that is granting the License.
|
15
|
+
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
17
|
+
other entities that control, are controlled by, or are under common
|
18
|
+
control with that entity. For the purposes of this definition,
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
20
|
+
direction or management of such entity, whether by contract or
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
23
|
+
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
25
|
+
exercising permissions granted by this License.
|
26
|
+
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
28
|
+
including but not limited to software source code, documentation
|
29
|
+
source, and configuration files.
|
30
|
+
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
32
|
+
transformation or translation of a Source form, including but
|
33
|
+
not limited to compiled object code, generated documentation,
|
34
|
+
and conversions to other media types.
|
35
|
+
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
37
|
+
Object form, made available under the License, as indicated by a
|
38
|
+
copyright notice that is included in or attached to the work
|
39
|
+
(an example is provided in the Appendix below).
|
40
|
+
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
47
|
+
the Work and Derivative Works thereof.
|
48
|
+
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
50
|
+
the original version of the Work and any modifications or additions
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
62
|
+
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
65
|
+
subsequently incorporated within the Work.
|
66
|
+
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
73
|
+
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
79
|
+
where such license applies only to those patent claims licensable
|
80
|
+
by such Contributor that are necessarily infringed by their
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
83
|
+
institute patent litigation against any entity (including a
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
86
|
+
or contributory patent infringement, then any patent licenses
|
87
|
+
granted to You under this License for that Work shall terminate
|
88
|
+
as of the date such litigation is filed.
|
89
|
+
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
92
|
+
modifications, and in Source or Object form, provided that You
|
93
|
+
meet the following conditions:
|
94
|
+
|
95
|
+
(a) You must give any other recipients of the Work or
|
96
|
+
Derivative Works a copy of this License; and
|
97
|
+
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
99
|
+
stating that You changed the files; and
|
100
|
+
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
103
|
+
attribution notices from the Source form of the Work,
|
104
|
+
excluding those notices that do not pertain to any part of
|
105
|
+
the Derivative Works; and
|
106
|
+
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
109
|
+
include a readable copy of the attribution notices contained
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
112
|
+
of the following places: within a NOTICE text file distributed
|
113
|
+
as part of the Derivative Works; within the Source form or
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
115
|
+
within a display generated by the Derivative Works, if and
|
116
|
+
wherever such third-party notices normally appear. The contents
|
117
|
+
of the NOTICE file are for informational purposes only and
|
118
|
+
do not modify the License. You may add Your own attribution
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
121
|
+
that such additional attribution notices cannot be construed
|
122
|
+
as modifying the License.
|
123
|
+
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
125
|
+
may provide additional or different license terms and conditions
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
129
|
+
the conditions stated in this License.
|
130
|
+
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
134
|
+
this License, without any additional terms or conditions.
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
136
|
+
the terms of any separate license agreement you may have executed
|
137
|
+
with Licensor regarding such Contributions.
|
138
|
+
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
141
|
+
except as required for reasonable and customary use in describing the
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
143
|
+
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
153
|
+
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
159
|
+
incidental, or consequential damages of any character arising as a
|
160
|
+
result of this License or out of the use or inability to use the
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
163
|
+
other commercial damages or losses), even if such Contributor
|
164
|
+
has been advised of the possibility of such damages.
|
165
|
+
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
169
|
+
or other liability obligations and/or rights consistent with this
|
170
|
+
License. However, in accepting such obligations, You may act only
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
175
|
+
of your accepting any such warranty or additional liability.
|
176
|
+
|
177
|
+
END OF TERMS AND CONDITIONS
|
178
|
+
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
180
|
+
|
181
|
+
To apply the Apache License to your work, attach the following
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
183
|
+
replaced with your own identifying information. (Don't include
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
185
|
+
comment syntax for the file format. We also recommend that a
|
186
|
+
file or class name and description of purpose be included on the
|
187
|
+
same "printed page" as the copyright notice for easier
|
188
|
+
identification within third-party archives.
|
189
|
+
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
191
|
+
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
193
|
+
you may not use this file except in compliance with the License.
|
194
|
+
You may obtain a copy of the License at
|
195
|
+
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
197
|
+
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
201
|
+
See the License for the specific language governing permissions and
|
202
|
+
limitations under the License.
|
data/README
ADDED
@@ -0,0 +1,97 @@
|
|
1
|
+
= GData
|
2
|
+
|
3
|
+
* http://code.google.com/p/gdata
|
4
|
+
|
5
|
+
== DESCRIPTION:
|
6
|
+
|
7
|
+
Ruby wrapper for working with Google Data APIs
|
8
|
+
|
9
|
+
== SYNOPSIS:
|
10
|
+
|
11
|
+
yt = GData::Client::YouTube.new
|
12
|
+
yt.source = 'my_cool_application'
|
13
|
+
yt.clientlogin('username', 'password')
|
14
|
+
yt.client_id = 'CLIENT_ID'
|
15
|
+
yt.developer_key = 'DEVELOPER_KEY'
|
16
|
+
feed = yt.get('http://gdata.youtube.com/feeds/api/users/default/uploads').to_xml
|
17
|
+
|
18
|
+
# creating, updating, and deleting a playlist
|
19
|
+
|
20
|
+
entry = <<-EOF
|
21
|
+
<entry xmlns="http://www.w3.org/2005/Atom"
|
22
|
+
xmlns:yt="http://gdata.youtube.com/schemas/2007">
|
23
|
+
<title type="text">Ruby Utility Unit Test</title>
|
24
|
+
<summary>This is a test playlist.</summary>
|
25
|
+
</entry>
|
26
|
+
EOF
|
27
|
+
|
28
|
+
response = yt.post('http://gdata.youtube.com/feeds/api/users/default/playlists', entry).to_xml
|
29
|
+
|
30
|
+
edit_uri = response.elements["link[@rel='edit']"].attributes['href']
|
31
|
+
|
32
|
+
response.elements["summary"].text = "Updated description"
|
33
|
+
|
34
|
+
response = yt.put(edit_uri, response.to_s).to_xml
|
35
|
+
|
36
|
+
yt.delete(edit_uri).to_xml
|
37
|
+
|
38
|
+
# uploading a video
|
39
|
+
|
40
|
+
test_movie = '/path/to/a/movie.mov'
|
41
|
+
mime_type = 'video/quicktime'
|
42
|
+
feed = 'http://uploads.gdata.youtube.com/feeds/api/users/default/uploads'
|
43
|
+
|
44
|
+
entry = <<EOF
|
45
|
+
<entry xmlns="http://www.w3.org/2005/Atom"
|
46
|
+
xmlns:media="http://search.yahoo.com/mrss/"
|
47
|
+
xmlns:yt="http://gdata.youtube.com/schemas/2007">
|
48
|
+
<media:group>
|
49
|
+
<media:title type="plain">Test Movie</media:title>
|
50
|
+
<media:description type="plain">
|
51
|
+
This is a test with the Ruby library
|
52
|
+
</media:description>
|
53
|
+
<media:category
|
54
|
+
scheme="http://gdata.youtube.com/schemas/2007/categories.cat">People
|
55
|
+
</media:category>
|
56
|
+
<media:keywords>test,lame</media:keywords>
|
57
|
+
</media:group>
|
58
|
+
</entry>
|
59
|
+
EOF
|
60
|
+
|
61
|
+
response = @yt.post_file(feed, test_movie, mime_type, entry).to_xml
|
62
|
+
|
63
|
+
== REQUIREMENTS:
|
64
|
+
|
65
|
+
* A sunny disposition
|
66
|
+
|
67
|
+
Tested against Ruby 1.8.6 patch level 114
|
68
|
+
|
69
|
+
== INSTALL:
|
70
|
+
|
71
|
+
sudo gem install gdata
|
72
|
+
|
73
|
+
To generate documentation:
|
74
|
+
|
75
|
+
rake doc
|
76
|
+
|
77
|
+
To run unit tests:
|
78
|
+
|
79
|
+
cp test/test_config.yml.example test/test_config.yml
|
80
|
+
# edit test/test_config.yml
|
81
|
+
rake test
|
82
|
+
|
83
|
+
== LICENSE:
|
84
|
+
|
85
|
+
Copyright (C) 2008 Google Inc.
|
86
|
+
|
87
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
88
|
+
you may not use this file except in compliance with the License.
|
89
|
+
You may obtain a copy of the License at
|
90
|
+
|
91
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
92
|
+
|
93
|
+
Unless required by applicable law or agreed to in writing, software
|
94
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
95
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
96
|
+
See the License for the specific language governing permissions and
|
97
|
+
limitations under the License.
|
data/Rakefile
ADDED
data/gdata.gemspec
ADDED
@@ -0,0 +1,44 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
$:.push File.expand_path("../lib", __FILE__)
|
3
|
+
require 'rubygems'
|
4
|
+
require "gdata/version"
|
5
|
+
require 'rake/rdoctask'
|
6
|
+
require 'rake/testtask'
|
7
|
+
require 'rake/gempackagetask'
|
8
|
+
|
9
|
+
task :default => [:test]
|
10
|
+
|
11
|
+
task :test do
|
12
|
+
ruby "test/ts_gdata.rb"
|
13
|
+
end
|
14
|
+
|
15
|
+
task :prepdoc do
|
16
|
+
all_doc_files = FileList.new('doc/**/*')
|
17
|
+
all_doc_files.each do |file|
|
18
|
+
system "hg add #{file}"
|
19
|
+
end
|
20
|
+
end
|
21
|
+
|
22
|
+
task :doc do
|
23
|
+
system "rdoc -U --title 'gdata module documentation' -m README README lib/"
|
24
|
+
end
|
25
|
+
|
26
|
+
|
27
|
+
|
28
|
+
Gem::Specification.new do |s|
|
29
|
+
s.name = "gdata-19"
|
30
|
+
s.version = Gdata::VERSION
|
31
|
+
s.platform = Gem::Platform::RUBY
|
32
|
+
s.authors = ["This is the gdata ruby gem. Minor updates for Ruby 1.9."]
|
33
|
+
s.email = ["bridgeutopia@gmail.com"]
|
34
|
+
s.homepage = ""
|
35
|
+
s.summary = %q{A Ruby gem designed to assist Ruby developers in working with Google Data APIs}
|
36
|
+
s.description = %q{A Ruby gem designed to assist Ruby developers in working with Google Data APIs}
|
37
|
+
s.add_development_dependency "test-unit"
|
38
|
+
s.rubyforge_project = "gdata"
|
39
|
+
|
40
|
+
s.files = `git ls-files`.split("\n")
|
41
|
+
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
42
|
+
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
43
|
+
s.require_paths = ["lib"]
|
44
|
+
end
|
data/lib/gdata.rb
ADDED
@@ -0,0 +1,24 @@
|
|
1
|
+
# Copyright (C) 2008 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
|
+
$:.unshift(File.dirname(__FILE__))
|
16
|
+
|
17
|
+
require 'gdata/http'
|
18
|
+
require 'gdata/client'
|
19
|
+
require 'gdata/auth'
|
20
|
+
# This is for Unicode "support"
|
21
|
+
if RUBY_VERSION < '1.9'
|
22
|
+
require 'jcode'
|
23
|
+
$KCODE = 'UTF8'
|
24
|
+
end
|
data/lib/gdata/auth.rb
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
# Copyright (C) 2008 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 'gdata/auth/clientlogin'
|
16
|
+
require 'gdata/auth/authsub'
|
17
|
+
|
18
|
+
module GData
|
19
|
+
module Auth
|
20
|
+
SOURCE_LIB_STRING = 'GoogleDataRubyUtil-'
|
21
|
+
end
|
22
|
+
end
|
@@ -0,0 +1,161 @@
|
|
1
|
+
# Copyright (C) 2008 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 'cgi'
|
16
|
+
require 'openssl'
|
17
|
+
require 'base64'
|
18
|
+
|
19
|
+
module GData
|
20
|
+
module Auth
|
21
|
+
|
22
|
+
# This class implements AuthSub signatures for Data API requests.
|
23
|
+
# It can be used with a GData::Client::GData object.
|
24
|
+
class AuthSub
|
25
|
+
|
26
|
+
# The URL of AuthSubRequest.
|
27
|
+
REQUEST_HANDLER = 'https://www.google.com/accounts/AuthSubRequest'
|
28
|
+
# The URL of AuthSubSessionToken.
|
29
|
+
SESSION_HANDLER = 'https://www.google.com/accounts/AuthSubSessionToken'
|
30
|
+
# The URL of AuthSubRevokeToken.
|
31
|
+
REVOKE_HANDLER = 'https://www.google.com/accounts/AuthSubRevokeToken'
|
32
|
+
# The URL of AuthSubInfo.
|
33
|
+
INFO_HANDLER = 'https://www.google.com/accounts/AuthSubTokenInfo'
|
34
|
+
# 2 ** 64, the largest 64 bit unsigned integer
|
35
|
+
BIG_INT_MAX = 18446744073709551616
|
36
|
+
|
37
|
+
# AuthSub access token.
|
38
|
+
attr_accessor :token
|
39
|
+
# Private RSA key used to sign secure requests.
|
40
|
+
attr_reader :private_key
|
41
|
+
|
42
|
+
# Initialize the class with a new token. Optionally pass a private
|
43
|
+
# key or custom URLs.
|
44
|
+
def initialize(token, options = {})
|
45
|
+
if token.nil?
|
46
|
+
raise ArgumentError, "Token cannot be nil."
|
47
|
+
elsif token.class != String
|
48
|
+
raise ArgumentError, "Token must be a String."
|
49
|
+
end
|
50
|
+
|
51
|
+
@token = token
|
52
|
+
|
53
|
+
options.each do |key, value|
|
54
|
+
self.send("#{key}=", value)
|
55
|
+
end
|
56
|
+
end
|
57
|
+
|
58
|
+
# Set the private key to use with this AuthSub token.
|
59
|
+
# The key can be an OpenSSL::PKey::RSA object, a string containing a
|
60
|
+
# private key in PEM format, or a string specifying a path to a PEM
|
61
|
+
# file that contains the private key.
|
62
|
+
def private_key=(key)
|
63
|
+
begin
|
64
|
+
if key.nil? or key.class == OpenSSL::PKey::RSA
|
65
|
+
@private_key = key
|
66
|
+
elsif File.exists?(key)
|
67
|
+
key_from_file = File.read(key)
|
68
|
+
@private_key = OpenSSL::PKey::RSA.new(key_from_file)
|
69
|
+
else
|
70
|
+
@private_key = OpenSSL::PKey::RSA.new(key)
|
71
|
+
end
|
72
|
+
rescue
|
73
|
+
raise ArgumentError, "Not a valid private key."
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
# Sign a GData::Http::Request object with a valid AuthSub Authorization
|
78
|
+
# header.
|
79
|
+
def sign_request!(request)
|
80
|
+
header = "AuthSub token=\"#{@token}\""
|
81
|
+
|
82
|
+
if @private_key
|
83
|
+
time = Time.now.to_i
|
84
|
+
nonce = OpenSSL::BN.rand_range(BIG_INT_MAX)
|
85
|
+
method = request.method.to_s.upcase
|
86
|
+
data = "#{method} #{request.url} #{time} #{nonce}"
|
87
|
+
sig = @private_key.sign(OpenSSL::Digest::SHA1.new, data)
|
88
|
+
sig = Base64.encode64(sig).gsub(/\n/, '')
|
89
|
+
header = "#{header} sigalg=\"rsa-sha1\" data=\"#{data}\""
|
90
|
+
header = "#{header} sig=\"#{sig}\""
|
91
|
+
end
|
92
|
+
|
93
|
+
request.headers['Authorization'] = header
|
94
|
+
end
|
95
|
+
|
96
|
+
# Upgrade the current token into a session token.
|
97
|
+
def upgrade
|
98
|
+
request = GData::HTTP::Request.new(SESSION_HANDLER)
|
99
|
+
sign_request!(request)
|
100
|
+
service = GData::HTTP::DefaultService.new
|
101
|
+
response = service.make_request(request)
|
102
|
+
if response.status_code != 200
|
103
|
+
raise GData::Client::AuthorizationError.new(response)
|
104
|
+
end
|
105
|
+
|
106
|
+
@token = response.body[/Token=(.*)/,1]
|
107
|
+
return @token
|
108
|
+
|
109
|
+
end
|
110
|
+
|
111
|
+
# Return some information about the current token. If the current token
|
112
|
+
# is a one-time use token, this operation will use it up!
|
113
|
+
def info
|
114
|
+
request = GData::HTTP::Request.new(INFO_HANDLER)
|
115
|
+
sign_request!(request)
|
116
|
+
service = GData::HTTP::DefaultService.new
|
117
|
+
response = service.make_request(request)
|
118
|
+
if response.status_code != 200
|
119
|
+
raise GData::Client::AuthorizationError.new(response)
|
120
|
+
end
|
121
|
+
|
122
|
+
result = {}
|
123
|
+
result[:target] = response.body[/Target=(.*)/,1]
|
124
|
+
result[:scope] = response.body[/Scope=(.*)/,1]
|
125
|
+
result[:secure] = response.body[/Secure=(.*)/,1]
|
126
|
+
return result
|
127
|
+
|
128
|
+
end
|
129
|
+
|
130
|
+
# Revoke the token.
|
131
|
+
def revoke
|
132
|
+
request = GData::HTTP::Request.new(REVOKE_HANDLER)
|
133
|
+
sign_request!(request)
|
134
|
+
service = GData::HTTP::DefaultService.new
|
135
|
+
response = service.make_request(request)
|
136
|
+
if response.status_code != 200
|
137
|
+
raise GData::Client::AuthorizationError.new(response)
|
138
|
+
end
|
139
|
+
|
140
|
+
end
|
141
|
+
|
142
|
+
# Return the proper URL for an AuthSub approval page with the requested
|
143
|
+
# scope. next_url should be a URL that points back to your code that
|
144
|
+
# will receive the token. domain is optionally a Google Apps domain.
|
145
|
+
def self.get_url(next_url, scope, secure = false, session = true,
|
146
|
+
domain = nil)
|
147
|
+
next_url = CGI.escape(next_url)
|
148
|
+
scope = CGI.escape(scope)
|
149
|
+
secure = secure ? 1 : 0
|
150
|
+
session = session ? 1 : 0
|
151
|
+
body = "next=#{next_url}&scope=#{scope}&session=#{session}" +
|
152
|
+
"&secure=#{secure}"
|
153
|
+
if domain
|
154
|
+
domain = CGI.escape(domain)
|
155
|
+
body = "#{body}&hd=#{domain}"
|
156
|
+
end
|
157
|
+
return "#{REQUEST_HANDLER}?#{body}"
|
158
|
+
end
|
159
|
+
end
|
160
|
+
end
|
161
|
+
end
|