opensocial 0.0.4

Sign up to get free protection for your applications and to get access to all the features.
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/NOTICE ADDED
@@ -0,0 +1,60 @@
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
+ /opensocial/auth/action_controller_request.rb is covered under the following
16
+ license:
17
+
18
+ Copyright (c) 2007 Blaine Cook, Larry Halff, Pelle Braendgaard
19
+
20
+ Permission is hereby granted, free of charge, to any person obtaining
21
+ a copy of this software and associated documentation files (the
22
+ "Software"), to deal in the Software without restriction, including
23
+ without limitation the rights to use, copy, modify, merge, publish,
24
+ distribute, sublicense, and/or sell copies of the Software, and to
25
+ permit persons to whom the Software is furnished to do so, subject to
26
+ the following conditions:
27
+
28
+ The above copyright notice and this permission notice shall be
29
+ included in all copies or substantial portions of the Software.
30
+
31
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
32
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
33
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
34
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
35
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
36
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
37
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
38
+
39
+ /opensocial/string/merb_string.rb is covered under the following license:
40
+
41
+ Copyright (c) 2008 Engine Yard
42
+
43
+ Permission is hereby granted, free of charge, to any person obtaining
44
+ a copy of this software and associated documentation files (the
45
+ "Software"), to deal in the Software without restriction, including
46
+ without limitation the rights to use, copy, modify, merge, publish,
47
+ distribute, sublicense, and/or sell copies of the Software, and to
48
+ permit persons to whom the Software is furnished to do so, subject to
49
+ the following conditions:
50
+
51
+ The above copyright notice and this permission notice shall be
52
+ included in all copies or substantial portions of the Software.
53
+
54
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
55
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
56
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
57
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
58
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
59
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
60
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
data/README ADDED
@@ -0,0 +1,108 @@
1
+ = OpenSocial -- REST/RPC and authentication wrappers
2
+
3
+ The OpenSocial modules provides wrapper functionality for REST and RPC HTTP
4
+ requests to OpenSocial-compliant endpoints. The results of these calls are
5
+ translated into helper objects, each representing a specific type of data
6
+ that the calls are expected to return. Finally, the module provides helper
7
+ functionality for verification of signed makeRequest calls.
8
+
9
+ == Features
10
+
11
+ This library operates using a set of wrappers around basic HTTP requests
12
+ and authentication, including the following features:
13
+
14
+ * Read-only REST support:
15
+
16
+ r = OpenSocial::FetchPersonRequest.new(connection)
17
+ person = r.send
18
+ puts person.display_name
19
+
20
+ # person is a Person object.
21
+
22
+ * Read-only RPC support (with batch processing):
23
+
24
+ r = OpenSocial::RpcRequest.new(connection)
25
+ r.add(:me => OpenSocial::FetchPersonRequest.new)
26
+ r.add(:friends => OpenSocial::FetchPeopleRequest.new)
27
+ data = r.send
28
+
29
+ # data contains two entries.
30
+ # data[:me] is a Person object.
31
+ # data[:friends] is a Collection of Person objects, indexed by ID.
32
+
33
+ * Automatic OAuth HMAC-SHA1 signing on outgoing requests:
34
+
35
+ consumer_key = 'orkut.com:623061448914'
36
+ consumer_secret = 'uynAeXiWTisflWX99KU1D2q5'
37
+ requestor = '03067092798963641994'
38
+
39
+ c = OpenSocial::Connection.new(:container => OpenSocial::Connection::ORKUT,
40
+ :consumer_key => consumer_key,
41
+ :consumer_secret => consumer_secret,
42
+ :xoauth_requestor_id => requestor)
43
+ r = OpenSocial::FetchPersonRequest.new(c)
44
+ person = r.send
45
+
46
+ * Support for body signing via the {request body hash}[http://oauth.googlecode.com/svn-history/r823/spec/ext/body_hash/1.0/drafts/1/spec.html]:
47
+
48
+ ORKUT = { :endpoint => 'http://sandbox.orkut.com/social',
49
+ :rest => 'rest/',
50
+ :rpc => 'rpc/',
51
+ :content_type => 'application/json',
52
+ :post_body_signing => false,
53
+ :use_request_body_hash => true }
54
+
55
+ * Incoming signed makeRequest verification helper:
56
+
57
+ class ExampleController < ApplicationController
58
+ CONSUMER_KEY = '623061448914'
59
+ CONSUMER_SECRET = 'uynAeXiWTisflWX99KU1D2q5'
60
+
61
+ include OpenSocial::Auth
62
+
63
+ before_filter :validate
64
+
65
+ def return_private_data
66
+ end
67
+ end
68
+
69
+ == Installation
70
+
71
+ The following gems and their dependencies are required by this client library:
72
+
73
+ * oauth
74
+ * json
75
+ * rails (optional, for incoming signed makeRequest validation)
76
+ * mocha (optional, for running tests)
77
+
78
+ Once you have the required gems installed, check out the project code from SVN,
79
+ and copy opensocial.rb and opensocial/ into your application's path. Then add:
80
+
81
+ require 'opensocial'
82
+
83
+ in your code.
84
+
85
+ To generate docs:
86
+
87
+ rdoc * --force --main README
88
+
89
+ from the (tag/branch/trunk) root of the project directory.
90
+
91
+ To run tests:
92
+
93
+ rake test
94
+
95
+ from the (tag/branch/trunk) root of the project directory.
96
+
97
+ == Learning More
98
+
99
+ Examples, current issues and feature requests, and the most up-to-date code
100
+ are available on the {project page}[http://code.google.com/p/opensocial-ruby-client/].
101
+
102
+ Discussion of this client library and others takes place
103
+ {here}[http://groups.google.com/group/opensocial-client-libraries].
104
+
105
+ == Contributing
106
+
107
+ If you'd like to contribute code to the project, check out this
108
+ {wiki page}[http://code.google.com/p/opensocial-ruby-client/wiki/BecomingAContributor].
@@ -0,0 +1,29 @@
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.expand_path(File.dirname(__FILE__))) unless
16
+ $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
17
+
18
+
19
+ require 'opensocial/auth/action_controller_request'
20
+ require 'opensocial/auth/base'
21
+ require 'opensocial/string/merb_string'
22
+ require 'opensocial/string/os_string'
23
+ require 'opensocial/base'
24
+ require 'opensocial/connection'
25
+ require 'opensocial/request'
26
+ require 'opensocial/person'
27
+ require 'opensocial/appdata'
28
+ require 'opensocial/activity'
29
+ require 'opensocial/group'
@@ -0,0 +1,116 @@
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
+
16
+ module OpenSocial #:nodoc:
17
+
18
+ # Acts as a wrapper for an OpenSocial activity.
19
+ #
20
+ # The Activity class takes input JSON as an initialization parameter, and
21
+ # iterates through each of the key/value pairs of that JSON. For each key
22
+ # that is found, an attr_accessor is constructed, allowing direct access
23
+ # to the value. Each value is stored in the attr_accessor, either as a
24
+ # String, Fixnum, Hash, or Array.
25
+ #
26
+
27
+
28
+ class Activity < Base
29
+
30
+ # Initializes the Activity based on the provided json fragment. If no JSON
31
+ # is provided, an empty object (with no attributes) is created.
32
+ def initialize(json)
33
+ if json
34
+ json.each do |key, value|
35
+ proper_key = key.snake_case
36
+ begin
37
+ self.send("#{proper_key}=", value)
38
+ rescue NoMethodError
39
+ add_attr(proper_key)
40
+ self.send("#{proper_key}=", value)
41
+ end
42
+ end
43
+ end
44
+ end
45
+ end
46
+
47
+ # Provides the ability to request a Collection of activities for a given
48
+ # user or set of users.
49
+ #
50
+ # The FetchActivitiesRequest wraps a simple request to an OpenSocial
51
+ # endpoint for a Collection of activities. As parameters, it accepts
52
+ # a user ID and selector (and optionally an ID of a particular activity).
53
+ # This request may be used, standalone, by calling send, or bundled into
54
+ # an RpcRequest.
55
+ #
56
+
57
+
58
+ class FetchActivitiesRequest < Request
59
+ # Defines the service fragment for use in constructing the request URL or
60
+ # JSON
61
+ SERVICE = 'activities'
62
+
63
+ # This is only necessary because of a spec inconsistency
64
+ RPC_SERVICE = 'activity'
65
+
66
+ # Initializes a request to fetch activities for the specified user and
67
+ # group, or the default (@me, @self). A valid Connection is not necessary
68
+ # if the request is to be used as part of an RpcRequest.
69
+ def initialize(connection = nil, guid = '@me', selector = '@self',
70
+ pid = nil)
71
+ super
72
+ end
73
+
74
+ # Sends the request, passing in the appropriate SERVICE and specified
75
+ # instance variables.
76
+ def send
77
+ json = send_request(SERVICE, @guid, @selector, @pid)
78
+
79
+ return parse_response(json['entry'])
80
+ end
81
+
82
+ # Selects the appropriate fragment from the JSON response in order to
83
+ # create a native object.
84
+ def parse_rpc_response(response)
85
+ return parse_response(response['data']['list'])
86
+ end
87
+
88
+ # Converts the request into a JSON fragment that can be used as part of a
89
+ # larger RpcRequest.
90
+ def to_json(*a)
91
+ value = {
92
+ 'method' => RPC_SERVICE + GET,
93
+ 'params' => {
94
+ 'userId' => ["#{@guid}"],
95
+ 'groupId' => "#{@selector}",
96
+ 'appId' => "#{@pid}"
97
+ },
98
+ 'id' => @key
99
+ }.to_json(*a)
100
+ end
101
+
102
+ private
103
+
104
+ # Converts the JSON response into a Collection of activities, indexed by
105
+ # id.
106
+ def parse_response(response)
107
+ activities = Collection.new
108
+ for entry in response
109
+ activity = Activity.new(entry)
110
+ activities[activity.id] = activity
111
+ end
112
+
113
+ return activities
114
+ end
115
+ end
116
+ end