Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Initial check-in

git-svn-id: http://opensocial-ruby-client.googlecode.com/svn/trunk@6 f65e88d0-acf7-11dd-a0fe-71d3f493a0de
  • Loading branch information...
commit b620cdf8bf1fa5724a2fe47ccd93d95b437b2355 1 parent 6a2cd03
api.dwh@google.com authored
Showing with 9,365 additions and 0 deletions.
  1. +202 −0 LICENSE
  2. +60 −0 NOTICE
  3. +99 −0 README
  4. +101 −0 doc/classes/OAuth.html
  5. +152 −0 doc/classes/OpenSocial/Activity.html
  6. +26 −0 doc/classes/OpenSocial/Activity.src/M000030.html
  7. +166 −0 doc/classes/OpenSocial/AppData.html
  8. +27 −0 doc/classes/OpenSocial/AppData.src/M000002.html
  9. +151 −0 doc/classes/OpenSocial/Auth.html
  10. +27 −0 doc/classes/OpenSocial/Auth.src/M000001.html
  11. +117 −0 doc/classes/OpenSocial/AuthException.html
  12. +143 −0 doc/classes/OpenSocial/Base.html
  13. +18 −0 doc/classes/OpenSocial/Base.src/M000016.html
  14. +147 −0 doc/classes/OpenSocial/Collection.html
  15. +18 −0 doc/classes/OpenSocial/Collection.src/M000021.html
  16. +242 −0 doc/classes/OpenSocial/Connection.html
  17. +35 −0 doc/classes/OpenSocial/Connection.src/M000019.html
  18. +26 −0 doc/classes/OpenSocial/Connection.src/M000020.html
  19. +224 −0 doc/classes/OpenSocial/FetchActivitiesRequest.html
  20. +19 −0 doc/classes/OpenSocial/FetchActivitiesRequest.src/M000026.html
  21. +20 −0 doc/classes/OpenSocial/FetchActivitiesRequest.src/M000027.html
  22. +18 −0 doc/classes/OpenSocial/FetchActivitiesRequest.src/M000028.html
  23. +26 −0 doc/classes/OpenSocial/FetchActivitiesRequest.src/M000029.html
  24. +213 −0 doc/classes/OpenSocial/FetchAppDataRequest.html
  25. +19 −0 doc/classes/OpenSocial/FetchAppDataRequest.src/M000022.html
  26. +20 −0 doc/classes/OpenSocial/FetchAppDataRequest.src/M000023.html
  27. +18 −0 doc/classes/OpenSocial/FetchAppDataRequest.src/M000024.html
  28. +27 −0 doc/classes/OpenSocial/FetchAppDataRequest.src/M000025.html
  29. +182 −0 doc/classes/OpenSocial/FetchGroupsRequest.html
  30. +18 −0 doc/classes/OpenSocial/FetchGroupsRequest.src/M000003.html
  31. +26 −0 doc/classes/OpenSocial/FetchGroupsRequest.src/M000004.html
  32. +212 −0 doc/classes/OpenSocial/FetchPeopleRequest.html
  33. +18 −0 doc/classes/OpenSocial/FetchPeopleRequest.src/M000012.html
  34. +20 −0 doc/classes/OpenSocial/FetchPeopleRequest.src/M000013.html
  35. +18 −0 doc/classes/OpenSocial/FetchPeopleRequest.src/M000014.html
  36. +25 −0 doc/classes/OpenSocial/FetchPeopleRequest.src/M000015.html
  37. +213 −0 doc/classes/OpenSocial/FetchPersonRequest.html
  38. +18 −0 doc/classes/OpenSocial/FetchPersonRequest.src/M000008.html
  39. +20 −0 doc/classes/OpenSocial/FetchPersonRequest.src/M000009.html
  40. +18 −0 doc/classes/OpenSocial/FetchPersonRequest.src/M000010.html
  41. +25 −0 doc/classes/OpenSocial/FetchPersonRequest.src/M000011.html
  42. +152 −0 doc/classes/OpenSocial/Group.html
  43. +26 −0 doc/classes/OpenSocial/Group.src/M000005.html
  44. +169 −0 doc/classes/OpenSocial/Person.html
  45. +26 −0 doc/classes/OpenSocial/Person.src/M000006.html
  46. +22 −0 doc/classes/OpenSocial/Person.src/M000007.html
  47. +217 −0 doc/classes/OpenSocial/Request.html
  48. +21 −0 doc/classes/OpenSocial/Request.src/M000017.html
  49. +31 −0 doc/classes/OpenSocial/Request.src/M000018.html
  50. +117 −0 doc/classes/OpenSocial/RequestException.html
  51. +217 −0 doc/classes/OpenSocial/RpcRequest.html
  52. +20 −0 doc/classes/OpenSocial/RpcRequest.src/M000031.html
  53. +18 −0 doc/classes/OpenSocial/RpcRequest.src/M000032.html
  54. +23 −0 doc/classes/OpenSocial/RpcRequest.src/M000033.html
  55. +21 −0 doc/classes/OpenSocial/RpcRequest.src/M000034.html
  56. +1 −0  doc/created.rid
  57. +345 −0 doc/files/LICENSE.html
  58. +179 −0 doc/files/NOTICE.html
  59. +238 −0 doc/files/README.html
  60. +122 −0 doc/files/opensocial/activity_rb.html
  61. +122 −0 doc/files/opensocial/appdata_rb.html
  62. +144 −0 doc/files/opensocial/auth/action_controller_request_rb.html
  63. +131 −0 doc/files/opensocial/auth/validate_rb.html
  64. +132 −0 doc/files/opensocial/base_rb.html
  65. +129 −0 doc/files/opensocial/connection_rb.html
  66. +122 −0 doc/files/opensocial/group_rb.html
  67. +122 −0 doc/files/opensocial/person_rb.html
  68. +122 −0 doc/files/opensocial/request_rb.html
  69. +129 −0 doc/files/opensocial/string/merb_string_rb.html
  70. +122 −0 doc/files/opensocial/string/os_string_rb.html
  71. +139 −0 doc/files/opensocial_rb.html
  72. +130 −0 doc/files/rakefile_rb.html
  73. +122 −0 doc/files/tests/activity_test_rb.html
  74. +122 −0 doc/files/tests/appdata_test_rb.html
  75. +122 −0 doc/files/tests/group_test_rb.html
  76. +122 −0 doc/files/tests/person_test_rb.html
  77. +132 −0 doc/files/tests/test_helper_rb.html
  78. +129 −0 doc/files/tests/test_rb.html
  79. +44 −0 doc/fr_class_index.html
  80. +48 −0 doc/fr_file_index.html
  81. +60 −0 doc/fr_method_index.html
  82. +24 −0 doc/index.html
  83. +208 −0 doc/rdoc-style.css
  84. +29 −0 opensocial.rb
  85. +98 −0 opensocial/activity.rb
  86. +99 −0 opensocial/appdata.rb
  87. +88 −0 opensocial/auth/action_controller_request.rb
  88. +51 −0 opensocial/auth/validate.rb
  89. +49 −0 opensocial/base.rb
  90. +93 −0 opensocial/connection.rb
  91. +70 −0 opensocial/group.rb
  92. +153 −0 opensocial/person.rb
  93. +210 −0 opensocial/request.rb
  94. +32 −0 opensocial/string/merb_string.rb
  95. +22 −0 opensocial/string/os_string.rb
  96. +46 −0 rakefile.rb
  97. +107 −0 tests/activity_test.rb
  98. +59 −0 tests/appdata_test.rb
  99. +28 −0 tests/fixtures/activities.json
  100. +13 −0 tests/fixtures/activity.json
  101. +6 −0 tests/fixtures/appdata.json
  102. +5 −0 tests/fixtures/appdatum.json
  103. +7 −0 tests/fixtures/group.json
  104. +16 −0 tests/fixtures/groups.json
  105. +20 −0 tests/fixtures/people.json
  106. +9 −0 tests/fixtures/person.json
  107. +72 −0 tests/group_test.rb
  108. +109 −0 tests/person_test.rb
  109. +19 −0 tests/test.rb
  110. +39 −0 tests/test_helper.rb
View
202 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.
View
60 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.
View
99 README
@@ -0,0 +1,99 @@
+= 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
+
+* 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 * --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].
View
101 doc/classes/OAuth.html
@@ -0,0 +1,101 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Module: OAuth</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Module</strong></td>
+ <td class="class-name-in-header">OAuth</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ </td>
+ </tr>
+
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+
+
+ </div>
+
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
152 doc/classes/OpenSocial/Activity.html
@@ -0,0 +1,152 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: OpenSocial::Activity</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">OpenSocial::Activity</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/activity_rb.html">
+ opensocial/activity.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ <a href="Base.html">
+ Base
+ </a>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Acts as a wrapper for an OpenSocial activity.
+</p>
+<p>
+The <a href="Activity.html">Activity</a> 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.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000030">new</a>&nbsp;&nbsp;
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000030" class="method-detail">
+ <a name="M000030"></a>
+
+ <div class="method-heading">
+ <a href="Activity.src/M000030.html" target="Code" class="method-signature"
+ onclick="popupCode('Activity.src/M000030.html');return false;">
+ <span class="method-name">new</span><span class="method-args">(json)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
26 doc/classes/OpenSocial/Activity.src/M000030.html
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>new (OpenSocial::Activity)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/activity.rb, line 29</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">json</span>)
+ <span class="ruby-identifier">json</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+ <span class="ruby-identifier">proper_key</span> = <span class="ruby-identifier">key</span>.<span class="ruby-identifier">snake_case</span>
+ <span class="ruby-keyword kw">begin</span>
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{proper_key}=&quot;</span>, <span class="ruby-identifier">value</span>)
+ <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NoMethodError</span>
+ <span class="ruby-identifier">add_attr</span>(<span class="ruby-identifier">proper_key</span>)
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{proper_key}=&quot;</span>, <span class="ruby-identifier">value</span>)
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
View
166 doc/classes/OpenSocial/AppData.html
@@ -0,0 +1,166 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: OpenSocial::AppData</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">OpenSocial::AppData</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/appdata_rb.html">
+ opensocial/appdata.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ <a href="Base.html">
+ Base
+ </a>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Acts as a wrapper for an OpenSocial appdata entry.
+</p>
+<p>
+The <a href="AppData.html">AppData</a> class takes a person&#8216;s ID and
+input JSON as initialization parameters, and iterates through each of the
+key/value pairs of that JSON. For each key that is found, an attr_accessor
+is constructed (except for :id which is preconstructed, and required),
+allowing direct access to the value. Each value is stored in the
+attr_accessor, either as a String, Fixnum, Hash, or Array.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000002">new</a>&nbsp;&nbsp;
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+ <div id="attribute-list">
+ <h3 class="section-bar">Attributes</h3>
+
+ <div class="name-list">
+ <table>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">id</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000002" class="method-detail">
+ <a name="M000002"></a>
+
+ <div class="method-heading">
+ <a href="AppData.src/M000002.html" target="Code" class="method-signature"
+ onclick="popupCode('AppData.src/M000002.html');return false;">
+ <span class="method-name">new</span><span class="method-args">(id, json)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
27 doc/classes/OpenSocial/AppData.src/M000002.html
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>new (OpenSocial::AppData)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/appdata.rb, line 32</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">json</span>)
+ <span class="ruby-ivar">@id</span> = <span class="ruby-identifier">id</span>
+
+ <span class="ruby-identifier">json</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+ <span class="ruby-keyword kw">begin</span>
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{key}=&quot;</span>, <span class="ruby-identifier">value</span>)
+ <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">NoMethodError</span>
+ <span class="ruby-identifier">add_attr</span>(<span class="ruby-identifier">key</span>)
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{key}=&quot;</span>, <span class="ruby-identifier">value</span>)
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
View
151 doc/classes/OpenSocial/Auth.html
@@ -0,0 +1,151 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Module: OpenSocial::Auth</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Module</strong></td>
+ <td class="class-name-in-header">OpenSocial::Auth</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/auth/validate_rb.html">
+ opensocial/auth/validate.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Provides verification of signed makeRequest using <a
+href="../OAuth.html">OAuth</a> with HMAC-SHA1.
+</p>
+<pre>
+ class ExampleController &lt; ApplicationController
+ CONSUMER_KEY = '623061448914'
+ CONSUMER_SECRET = 'uynAeXiWTisflWX99KU1D2q5'
+
+ include OpenSocial::Auth
+
+ before_filter :validate
+
+ def return_private_data
+ end
+ end
+</pre>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000001">validate</a>&nbsp;&nbsp;
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000001" class="method-detail">
+ <a name="M000001"></a>
+
+ <div class="method-heading">
+ <a href="Auth.src/M000001.html" target="Code" class="method-signature"
+ onclick="popupCode('Auth.src/M000001.html');return false;">
+ <span class="method-name">validate</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
27 doc/classes/OpenSocial/Auth.src/M000001.html
@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>validate (OpenSocial::Auth)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/auth/validate.rb, line 38</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">validate</span>
+ <span class="ruby-identifier">consumer</span> = <span class="ruby-constant">OAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">Consumer</span>.<span class="ruby-identifier">new</span>(<span class="ruby-constant">CONSUMER_KEY</span>, <span class="ruby-constant">CONSUMER_SECRET</span>)
+ <span class="ruby-keyword kw">begin</span>
+ <span class="ruby-identifier">signature</span> = <span class="ruby-constant">OAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">Signature</span>.<span class="ruby-identifier">build</span>(<span class="ruby-identifier">request</span>) <span class="ruby-keyword kw">do</span>
+ [<span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">consumer</span>.<span class="ruby-identifier">secret</span>]
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-identifier">pass</span> = <span class="ruby-identifier">signature</span>.<span class="ruby-identifier">verify</span>
+ <span class="ruby-keyword kw">rescue</span> <span class="ruby-constant">OAuth</span><span class="ruby-operator">::</span><span class="ruby-constant">Signature</span><span class="ruby-operator">::</span><span class="ruby-constant">UnknownSignatureMethod</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">e</span>
+ <span class="ruby-identifier">logger</span>.<span class="ruby-identifier">error</span> <span class="ruby-value str">'An unknown signature method was supplied: '</span> <span class="ruby-operator">+</span> <span class="ruby-identifier">e</span>.<span class="ruby-identifier">to_s</span>
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-keyword kw">return</span> <span class="ruby-identifier">pass</span>
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
View
117 doc/classes/OpenSocial/AuthException.html
@@ -0,0 +1,117 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: OpenSocial::AuthException</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">OpenSocial::AuthException</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/request_rb.html">
+ opensocial/request.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ RuntimeError
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+An exception thrown when a request returns a 401 unauthorized status.
+</p>
+
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
143 doc/classes/OpenSocial/Base.html
@@ -0,0 +1,143 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: OpenSocial::Base</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">OpenSocial::Base</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/base_rb.html">
+ opensocial/base.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ Object
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Provides base functionality for the OpenSocial child classes.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000016">add_attr</a>&nbsp;&nbsp;
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000016" class="method-detail">
+ <a name="M000016"></a>
+
+ <div class="method-heading">
+ <a href="Base.src/M000016.html" target="Code" class="method-signature"
+ onclick="popupCode('Base.src/M000016.html');return false;">
+ <span class="method-name">add_attr</span><span class="method-args">(name)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
18 doc/classes/OpenSocial/Base.src/M000016.html
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>add_attr (OpenSocial::Base)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/base.rb, line 32</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">add_attr</span>(<span class="ruby-identifier">name</span>)
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">class</span>.<span class="ruby-identifier">class_eval</span> <span class="ruby-node">&quot;attr_accessor :#{name}&quot;</span>
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
View
147 doc/classes/OpenSocial/Collection.html
@@ -0,0 +1,147 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: OpenSocial::Collection</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">OpenSocial::Collection</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/base_rb.html">
+ opensocial/base.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ Hash
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Wraps the functionality of an OpenSocial collection as defined by the
+specification. In practical uses, a <a
+href="Collection.html">Collection</a> serves as a Hash (usually index by
+ID) with the added benefit of being convertable to an Array, when
+it&#8216;s necessary to iterate over all of the values.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000021">to_array</a>&nbsp;&nbsp;
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000021" class="method-detail">
+ <a name="M000021"></a>
+
+ <div class="method-heading">
+ <a href="Collection.src/M000021.html" target="Code" class="method-signature"
+ onclick="popupCode('Collection.src/M000021.html');return false;">
+ <span class="method-name">to_array</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
18 doc/classes/OpenSocial/Collection.src/M000021.html
@@ -0,0 +1,18 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>to_array (OpenSocial::Collection)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/base.rb, line 45</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">to_array</span>
+ <span class="ruby-identifier">values</span>
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
View
242 doc/classes/OpenSocial/Connection.html
@@ -0,0 +1,242 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: OpenSocial::Connection</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">OpenSocial::Connection</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/connection_rb.html">
+ opensocial/connection.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ Object
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Describes a connection to an OpenSocial container, including the ability to
+declare an authorization mechanism and appropriate credentials.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000019">new</a>&nbsp;&nbsp;
+ <a href="#M000020">service_uri</a>&nbsp;&nbsp;
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+ <div id="constants-list">
+ <h3 class="section-bar">Constants</h3>
+
+ <div class="name-list">
+ <table summary="Constants">
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">ORKUT</td>
+ <td>=</td>
+ <td class="context-item-value">{ :endpoint =&gt; 'http://sandbox.orkut.com/social', :rest =&gt; 'rest/', :rpc =&gt; 'rpc/' }</td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">IGOOGLE</td>
+ <td>=</td>
+ <td class="context-item-value">{ :endpoint =&gt; 'http://gmodules.com/api', :rest =&gt; '', :rpc =&gt; 'rpc' }</td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">MYSPACE</td>
+ <td>=</td>
+ <td class="context-item-value">{ :endpoint =&gt; 'http://api.myspace.com/v2', :rest =&gt; '', :rpc =&gt; '' }</td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">AUTH_HMAC</td>
+ <td>=</td>
+ <td class="context-item-value">0</td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">AUTH_ST</td>
+ <td>=</td>
+ <td class="context-item-value">1</td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">DEFAULT_OPTIONS</td>
+ <td>=</td>
+ <td class="context-item-value">{ :container =&gt; ORKUT, :st =&gt; '', :consumer_key =&gt; '', :consumer_secret =&gt; '', :consumer_token =&gt; OAuth::Token.new('', ''), :xoauth_requestor_id =&gt; '', :auth =&gt; AUTH_HMAC }</td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+ <div id="attribute-list">
+ <h3 class="section-bar">Attributes</h3>
+
+ <div class="name-list">
+ <table>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">auth</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">consumer_key</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">consumer_secret</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">consumer_token</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">container</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">st</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">xoauth_requestor_id</td>
+ <td class="context-item-value">&nbsp;[RW]&nbsp;</td>
+ <td class="context-item-desc"></td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000019" class="method-detail">
+ <a name="M000019"></a>
+
+ <div class="method-heading">
+ <a href="Connection.src/M000019.html" target="Code" class="method-signature"
+ onclick="popupCode('Connection.src/M000019.html');return false;">
+ <span class="method-name">new</span><span class="method-args">(options = {})</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000020" class="method-detail">
+ <a name="M000020"></a>
+
+ <div class="method-heading">
+ <a href="Connection.src/M000020.html" target="Code" class="method-signature"
+ onclick="popupCode('Connection.src/M000020.html');return false;">
+ <span class="method-name">service_uri</span><span class="method-args">(service, guid, selector, pid)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
35 doc/classes/OpenSocial/Connection.src/M000019.html
@@ -0,0 +1,35 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>new (OpenSocial::Connection)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/connection.rb, line 53</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">options</span> = {})
+ <span class="ruby-identifier">options</span> = <span class="ruby-constant">DEFAULT_OPTIONS</span>.<span class="ruby-identifier">merge</span>(<span class="ruby-identifier">options</span>)
+ <span class="ruby-identifier">options</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword kw">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">key</span>, <span class="ruby-identifier">value</span><span class="ruby-operator">|</span>
+ <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">send</span>(<span class="ruby-node">&quot;#{key}=&quot;</span>, <span class="ruby-identifier">value</span>)
+ <span class="ruby-keyword kw">end</span>
+
+ <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@auth</span> <span class="ruby-operator">==</span> <span class="ruby-constant">AUTH_HMAC</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">has_valid_hmac_triple?</span>
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Connection authentication is set to '</span> <span class="ruby-operator">+</span>
+ <span class="ruby-value str">'HMAC-SHA1, but a valid consumer_key/'</span> <span class="ruby-operator">+</span>
+ <span class="ruby-value str">'secret and xoauth_requestor_id triple '</span> <span class="ruby-operator">+</span>
+ <span class="ruby-value str">'was not supplied.'</span>)
+ <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@auth</span> <span class="ruby-operator">==</span> <span class="ruby-constant">AUTH_ST</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-ivar">@st</span>.<span class="ruby-identifier">empty?</span>
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Connection authentication is set to '</span> <span class="ruby-operator">+</span>
+ <span class="ruby-value str">'security token, but a security token was '</span> <span class="ruby-operator">+</span>
+ <span class="ruby-value str">'not supplied.'</span>)
+ <span class="ruby-keyword kw">elsif</span> <span class="ruby-operator">!</span>[<span class="ruby-constant">AUTH_HMAC</span>, <span class="ruby-constant">AUTH_ST</span>].<span class="ruby-identifier">include?</span>(<span class="ruby-ivar">@auth</span>)
+ <span class="ruby-identifier">raise</span> <span class="ruby-constant">ArgumentError</span>.<span class="ruby-identifier">new</span>(<span class="ruby-value str">'Connection authentication is set to an '</span> <span class="ruby-operator">+</span>
+ <span class="ruby-value str">'unknown value.'</span>)
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
View
26 doc/classes/OpenSocial/Connection.src/M000020.html
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>service_uri (OpenSocial::Connection)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/connection.rb, line 74</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">service_uri</span>(<span class="ruby-identifier">service</span>, <span class="ruby-identifier">guid</span>, <span class="ruby-identifier">selector</span>, <span class="ruby-identifier">pid</span>)
+ <span class="ruby-identifier">uri</span> = [<span class="ruby-ivar">@container</span>[<span class="ruby-identifier">:endpoint</span>], <span class="ruby-identifier">service</span>, <span class="ruby-identifier">guid</span>, <span class="ruby-identifier">selector</span>, <span class="ruby-identifier">pid</span>].<span class="ruby-identifier">compact</span>.
+ <span class="ruby-identifier">join</span>(<span class="ruby-value str">'/'</span>)
+
+ <span class="ruby-keyword kw">if</span> <span class="ruby-ivar">@auth</span> <span class="ruby-operator">==</span> <span class="ruby-constant">AUTH_HMAC</span>
+ <span class="ruby-identifier">uri</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'?xoauth_requestor_id='</span> <span class="ruby-operator">+</span> <span class="ruby-ivar">@xoauth_requestor_id</span>
+ <span class="ruby-keyword kw">elsif</span> <span class="ruby-ivar">@auth</span> <span class="ruby-operator">==</span> <span class="ruby-constant">AUTH_ST</span>
+ <span class="ruby-identifier">uri</span> <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-value str">'?st='</span> <span class="ruby-operator">+</span> <span class="ruby-keyword kw">self</span>.<span class="ruby-identifier">st</span>
+ <span class="ruby-keyword kw">end</span>
+ <span class="ruby-constant">URI</span>.<span class="ruby-identifier">parse</span>(<span class="ruby-identifier">uri</span>)
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>
View
224 doc/classes/OpenSocial/FetchActivitiesRequest.html
@@ -0,0 +1,224 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+ <title>Class: OpenSocial::FetchActivitiesRequest</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <meta http-equiv="Content-Script-Type" content="text/javascript" />
+ <link rel="stylesheet" href="../.././rdoc-style.css" type="text/css" media="screen" />
+ <script type="text/javascript">
+ // <![CDATA[
+
+ function popupCode( url ) {
+ window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+ }
+
+ function toggleCode( id ) {
+ if ( document.getElementById )
+ elem = document.getElementById( id );
+ else if ( document.all )
+ elem = eval( "document.all." + id );
+ else
+ return false;
+
+ elemStyle = elem.style;
+
+ if ( elemStyle.display != "block" ) {
+ elemStyle.display = "block"
+ } else {
+ elemStyle.display = "none"
+ }
+
+ return true;
+ }
+
+ // Make codeblocks hidden by default
+ document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+
+ // ]]>
+ </script>
+
+</head>
+<body>
+
+
+
+ <div id="classHeader">
+ <table class="header-table">
+ <tr class="top-aligned-row">
+ <td><strong>Class</strong></td>
+ <td class="class-name-in-header">OpenSocial::FetchActivitiesRequest</td>
+ </tr>
+ <tr class="top-aligned-row">
+ <td><strong>In:</strong></td>
+ <td>
+ <a href="../../files/opensocial/activity_rb.html">
+ opensocial/activity.rb
+ </a>
+ <br />
+ </td>
+ </tr>
+
+ <tr class="top-aligned-row">
+ <td><strong>Parent:</strong></td>
+ <td>
+ <a href="Request.html">
+ Request
+ </a>
+ </td>
+ </tr>
+ </table>
+ </div>
+ <!-- banner header -->
+
+ <div id="bodyContent">
+
+
+
+ <div id="contextContent">
+
+ <div id="description">
+ <p>
+Provides the ability to request a collection of activities for a given user
+or set of users.
+</p>
+<p>
+The <a href="FetchActivitiesRequest.html">FetchActivitiesRequest</a> 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 <a
+href="FetchActivitiesRequest.html#M000027">send</a>, or bundled into an RPC
+request.
+</p>
+
+ </div>
+
+
+ </div>
+
+ <div id="method-list">
+ <h3 class="section-bar">Methods</h3>
+
+ <div class="name-list">
+ <a href="#M000026">new</a>&nbsp;&nbsp;
+ <a href="#M000028">parse_rpc_response</a>&nbsp;&nbsp;
+ <a href="#M000027">send</a>&nbsp;&nbsp;
+ <a href="#M000029">to_json</a>&nbsp;&nbsp;
+ </div>
+ </div>
+
+ </div>
+
+
+ <!-- if includes -->
+
+ <div id="section">
+
+
+ <div id="constants-list">
+ <h3 class="section-bar">Constants</h3>
+
+ <div class="name-list">
+ <table summary="Constants">
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">SERVICE</td>
+ <td>=</td>
+ <td class="context-item-value">'activities'</td>
+ </tr>
+ <tr class="top-aligned-row context-row">
+ <td class="context-item-name">RPC_SERVICE</td>
+ <td>=</td>
+ <td class="context-item-value">'activity'</td>
+ <td width="3em">&nbsp;</td>
+ <td class="context-item-desc">
+This is only necessary because of a spec inconsistency
+
+</td>
+ </tr>
+ </table>
+ </div>
+ </div>
+
+
+
+
+
+
+ <!-- if method_list -->
+ <div id="methods">
+ <h3 class="section-bar">Public Class methods</h3>
+
+ <div id="method-M000026" class="method-detail">
+ <a name="M000026"></a>
+
+ <div class="method-heading">
+ <a href="FetchActivitiesRequest.src/M000026.html" target="Code" class="method-signature"
+ onclick="popupCode('FetchActivitiesRequest.src/M000026.html');return false;">
+ <span class="method-name">new</span><span class="method-args">(connection = nil, guid = '@me', selector = '@self', pid = nil)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <h3 class="section-bar">Public Instance methods</h3>
+
+ <div id="method-M000028" class="method-detail">
+ <a name="M000028"></a>
+
+ <div class="method-heading">
+ <a href="FetchActivitiesRequest.src/M000028.html" target="Code" class="method-signature"
+ onclick="popupCode('FetchActivitiesRequest.src/M000028.html');return false;">
+ <span class="method-name">parse_rpc_response</span><span class="method-args">(response)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000027" class="method-detail">
+ <a name="M000027"></a>
+
+ <div class="method-heading">
+ <a href="FetchActivitiesRequest.src/M000027.html" target="Code" class="method-signature"
+ onclick="popupCode('FetchActivitiesRequest.src/M000027.html');return false;">
+ <span class="method-name">send</span><span class="method-args">()</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+ <div id="method-M000029" class="method-detail">
+ <a name="M000029"></a>
+
+ <div class="method-heading">
+ <a href="FetchActivitiesRequest.src/M000029.html" target="Code" class="method-signature"
+ onclick="popupCode('FetchActivitiesRequest.src/M000029.html');return false;">
+ <span class="method-name">to_json</span><span class="method-args">(*a)</span>
+ </a>
+ </div>
+
+ <div class="method-description">
+ </div>
+ </div>
+
+
+ </div>
+
+
+ </div>
+
+
+<div id="validator-badges">
+ <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+
+</body>
+</html>
View
19 doc/classes/OpenSocial/FetchActivitiesRequest.src/M000026.html
@@ -0,0 +1,19 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+ PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+<html>
+<head>
+ <title>new (OpenSocial::FetchActivitiesRequest)</title>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+ <link rel="stylesheet" href="../../.././rdoc-style.css" type="text/css" media="screen" />
+</head>
+<body class="standalone-code">
+ <pre><span class="ruby-comment cmt"># File opensocial/activity.rb, line 59</span>
+ <span class="ruby-keyword kw">def</span> <span class="ruby-identifier">initialize</span>(<span class="ruby-identifier">connection</span> = <span class="ruby-keyword kw">nil</span>, <span class="ruby-identifier">guid</span> = <span class="ruby-value str">'@me'</span>, <span class="ruby-identifier">selector</span> = <span class="ruby-value str">'@self'</span>,
+ <span class="ruby-identifier">pid</span> = <span class="ruby-keyword kw">nil</span>)
+ <span class="ruby-keyword kw">super</span>
+ <span class="ruby-keyword kw">end</span></pre>
+</body>
+</html>