opensocial 0.0.4

data/LICENSE

@@ -0,0 +1,202 @@
+
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/NOTICE

@@ -0,0 +1,60 @@
+Copyright (c) 2008 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.
+
+/opensocial/auth/action_controller_request.rb is covered under the following
+license:
+
+Copyright (c) 2007 Blaine Cook, Larry Halff, Pelle Braendgaard
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+/opensocial/string/merb_string.rb is covered under the following license:
+
+Copyright (c) 2008 Engine Yard
+ 
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+ 
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+ 
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README

@@ -0,0 +1,108 @@
+= OpenSocial -- REST/RPC and authentication wrappers
+
+The OpenSocial modules provides wrapper functionality for REST and RPC HTTP
+requests to OpenSocial-compliant endpoints. The results of these calls are
+translated into helper objects, each representing a specific type of data
+that the calls are expected to return. Finally, the module provides helper
+functionality for verification of signed makeRequest calls.
+
+== Features
+
+This library operates using a set of wrappers around basic HTTP requests
+and authentication, including the following features:
+
+* Read-only REST support:
+
+   r = OpenSocial::FetchPersonRequest.new(connection)
+   person = r.send
+   puts person.display_name
+   
+   # person is a Person object.
+  
+* Read-only RPC support (with batch processing):
+
+   r = OpenSocial::RpcRequest.new(connection)
+   r.add(:me => OpenSocial::FetchPersonRequest.new)
+   r.add(:friends => OpenSocial::FetchPeopleRequest.new)
+   data = r.send
+   
+   # data contains two entries.
+   # data[:me] is a Person object. 
+   # data[:friends] is a Collection of Person objects, indexed by ID.
+  
+* Automatic OAuth HMAC-SHA1 signing on outgoing requests:
+
+   consumer_key = 'orkut.com:623061448914'
+   consumer_secret = 'uynAeXiWTisflWX99KU1D2q5'
+   requestor = '03067092798963641994'
+   
+   c = OpenSocial::Connection.new(:container => OpenSocial::Connection::ORKUT,
+                                  :consumer_key => consumer_key,
+                                  :consumer_secret => consumer_secret,
+                                  :xoauth_requestor_id => requestor)
+   r = OpenSocial::FetchPersonRequest.new(c)
+   person = r.send
+   
+* 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]:
+
+   ORKUT = { :endpoint => 'http://sandbox.orkut.com/social',
+             :rest => 'rest/',
+             :rpc => 'rpc/',
+             :content_type => 'application/json',
+             :post_body_signing => false,
+             :use_request_body_hash => true }
+   
+* Incoming signed makeRequest verification helper:
+
+   class ExampleController < ApplicationController
+     CONSUMER_KEY = '623061448914'
+     CONSUMER_SECRET = 'uynAeXiWTisflWX99KU1D2q5'
+     
+     include OpenSocial::Auth
+     
+     before_filter :validate
+     
+     def return_private_data
+     end
+   end
+
+== Installation
+
+The following gems and their dependencies are required by this client library:
+
+* oauth
+* json
+* rails (optional, for incoming signed makeRequest validation)
+* mocha (optional, for running tests)
+
+Once you have the required gems installed, check out the project code from SVN,
+and copy opensocial.rb and opensocial/ into your application's path. Then add:
+
+  require 'opensocial'
+  
+in your code.
+
+To generate docs:
+
+  rdoc * --force --main README
+  
+from the (tag/branch/trunk) root of the project directory.
+
+To run tests:
+
+  rake test
+  
+from the (tag/branch/trunk) root of the project directory.
+
+== Learning More
+
+Examples, current issues and feature requests, and the most up-to-date code
+are available on the {project page}[http://code.google.com/p/opensocial-ruby-client/].
+
+Discussion of this client library and others takes place
+{here}[http://groups.google.com/group/opensocial-client-libraries].
+
+== Contributing
+
+If you'd like to contribute code to the project, check out this
+{wiki page}[http://code.google.com/p/opensocial-ruby-client/wiki/BecomingAContributor].

data/lib/opensocial.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2008 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.
+
+$:.unshift(File.expand_path(File.dirname(__FILE__))) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+require 'opensocial/auth/action_controller_request'
+require 'opensocial/auth/base'
+require 'opensocial/string/merb_string'
+require 'opensocial/string/os_string'
+require 'opensocial/base'
+require 'opensocial/connection'
+require 'opensocial/request'
+require 'opensocial/person'
+require 'opensocial/appdata'
+require 'opensocial/activity'
+require 'opensocial/group'

data/lib/opensocial/activity.rb

@@ -0,0 +1,116 @@
+# Copyright (c) 2008 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.
+
+
+module OpenSocial #:nodoc:
+  
+  # Acts as a wrapper for an OpenSocial activity.
+  #
+  # The Activity class takes input JSON as an initialization parameter, and
+  # iterates through each of the key/value pairs of that JSON. For each key
+  # that is found, an attr_accessor is constructed, allowing direct access
+  # to the value. Each value is stored in the attr_accessor, either as a
+  # String, Fixnum, Hash, or Array.
+  #
+  
+  
+  class Activity < Base
+    
+    # Initializes the Activity based on the provided json fragment. If no JSON
+    # is provided, an empty object (with no attributes) is created.
+    def initialize(json)
+      if json
+        json.each do |key, value|
+          proper_key = key.snake_case
+          begin
+            self.send("#{proper_key}=", value)
+          rescue NoMethodError
+            add_attr(proper_key)
+            self.send("#{proper_key}=", value)
+          end
+        end
+      end
+    end
+  end
+  
+  # Provides the ability to request a Collection of activities for a given
+  # user or set of users.
+  #
+  # The FetchActivitiesRequest wraps a simple request to an OpenSocial
+  # endpoint for a Collection of activities. As parameters, it accepts
+  # a user ID and selector (and optionally an ID of a particular activity).
+  # This request may be used, standalone, by calling send, or bundled into
+  # an RpcRequest.
+  #
+  
+  
+  class FetchActivitiesRequest < Request
+    # Defines the service fragment for use in constructing the request URL or
+    # JSON
+    SERVICE = 'activities'
+    
+    # This is only necessary because of a spec inconsistency
+    RPC_SERVICE = 'activity'
+    
+    # Initializes a request to fetch activities for the specified user and
+    # group, or the default (@me, @self). A valid Connection is not necessary
+    # if the request is to be used as part of an RpcRequest.
+    def initialize(connection = nil, guid = '@me', selector = '@self',
+                   pid = nil)
+      super
+    end
+    
+    # Sends the request, passing in the appropriate SERVICE and specified
+    # instance variables.
+    def send
+      json = send_request(SERVICE, @guid, @selector, @pid)
+
+      return parse_response(json['entry'])
+    end
+    
+    # Selects the appropriate fragment from the JSON response in order to
+    # create a native object.
+    def parse_rpc_response(response)
+      return parse_response(response['data']['list'])
+    end
+    
+    # Converts the request into a JSON fragment that can be used as part of a
+    # larger RpcRequest.
+    def to_json(*a)
+      value = {
+        'method' => RPC_SERVICE + GET,
+        'params' => {
+          'userId' => ["#{@guid}"],
+          'groupId' => "#{@selector}",
+          'appId' => "#{@pid}"
+        },
+        'id' => @key
+      }.to_json(*a)
+    end
+    
+    private
+    
+    # Converts the JSON response into a Collection of activities, indexed by
+    # id.
+    def parse_response(response)
+      activities = Collection.new
+      for entry in response
+        activity = Activity.new(entry)
+        activities[activity.id] = activity
+      end
+      
+      return activities
+    end
+  end
+end