qoobaa-opensocial 0.1.0

data/lib/opensocial/request.rb

@@ -0,0 +1,263 @@
+# 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:
+
+  # Provides a wrapper for a single request to an OpenSocial endpoint, either
+  # as a standalone request, or as a fragment of an RPC request.
+  #
+  # The Request class wraps an HTTP request to an OpenSocial endpoint for
+  # social data. A Request may be used, directly, to access social resources
+  # that may not be currently wrapped by Request's child classes. Used in this
+  # was it gives near-raw access to social data. The Request class supplies
+  # OAuth signing when the supplied connection contains appropriate
+  # credentials.
+  #
+
+
+  class Request
+    GET = ".get"
+
+    # Defines the connection that will be used in the request.
+    attr_accessor :connection
+
+    # Defines the guid for the request.
+    attr_accessor :guid
+
+    # Defines the selector for the request.
+    attr_accessor :selector
+
+    # Defines the pid for the request.
+    attr_accessor :pid
+
+    # Defines the key used to lookup the request result in an RPC request.
+    attr_accessor :key
+
+    # Initializes a request using the optionally supplied connection, guid,
+    # selector, and pid.
+    def initialize(connection = nil, guid = nil, selector = nil, pid = nil)
+      @connection = connection
+      @guid = guid
+      @selector = selector
+      @pid = pid
+    end
+
+    # Generates a request given the service, guid, selector, and pid, to the
+    # OpenSocial endpoint by constructing the service URI and dispatching the
+    # request. When data is returned, it is parsed as JSON after being
+    # optionally unescaped.
+    def send_request(service, guid, selector = nil, pid = nil,
+                     unescape = false, extra_fields = {})
+      if !@connection
+        raise RequestException.new("Request requires a valid connection.")
+      end
+
+      uri = @connection.service_uri(@connection.container[:rest] + service,
+                                    guid, selector, pid, extra_fields)
+      data = dispatch(uri)
+
+      if unescape
+        JSON.parse(data.os_unescape)
+      else
+        JSON.parse(data)
+      end
+    end
+
+    private
+
+    # Dispatches a request to a given URI with optional POST data. If a
+    # request's connection has specified HMAC-SHA1 authentication, OAuth
+    # parameters and signature are appended to the request.
+    def dispatch(uri, post_data = nil)
+      http = Net::HTTP.new(uri.host, uri.port)
+
+      if post_data
+        req = Net::HTTP::Post.new(uri.request_uri)
+
+        # FIXME: post_data is a serialized JSON string - set_form_data
+        # requires a hash, using body= method instead (doesn't work as
+        # well)
+
+        # req.set_form_data(post_data)
+        req.body = post_data
+      else
+        req = Net::HTTP::Get.new(uri.request_uri)
+      end
+
+      @connection.sign!(http, req)
+
+      if post_data
+        resp = http.post(req.path, post_data)
+        check_for_json_error!(resp)
+      else
+        resp = http.get(req.path)
+        check_for_http_error!(resp, uri) # TODO uri for debugging only
+      end
+
+      return resp.body
+    end
+
+    # Checks the response object's status code. If the response is is
+    # unauthorized, an exception is raised.
+    def check_for_http_error!(resp, req_uri=nil) # TODO uri for debugging only
+      if !resp.kind_of?(Net::HTTPSuccess)
+        if resp.is_a?(Net::HTTPUnauthorized)
+          if Object.const_defined?(:HoptoadNotifier)
+            HoptoadNotifier.notify(:error_class => "Myspace API Auth error",
+                                   :error_message => "Myspace API Auth error",
+                                   :request => {:params => {"body" => resp.body,
+                                       "uri" => req_uri.to_s}})
+          end
+          raise AuthException.new("The request lacked proper authentication " +
+                                  "credentials to retrieve data.")
+        else
+          resp.value
+        end
+      end
+    end
+
+    # Checks the JSON response for a status code. If a code is present an
+    # exception is raised.
+    def check_for_json_error!(resp)
+      json = JSON.parse(resp.body)
+      if json.is_a?(Hash) && json.has_key?("code") && json.has_key?("message")
+        rc = json["code"]
+        message = json["message"]
+        case rc
+        when 401
+          raise AuthException.new("The request lacked proper authentication " +
+                                  "credentials to retrieve data.")
+        else
+          raise RequestException.new("The request returned an unsupported " +
+                                     "status code: #{rc} #{message}.")
+        end
+      end
+    end
+  end
+
+  # Provides a wrapper for a single RPC request to an OpenSocial endpoint,
+  # composed of one or more individual requests.
+  #
+  # The RpcRequest class wraps an HTTP request to an OpenSocial endpoint for
+  # social data. An RpcRequest is intended to be used as a container for one
+  # or more Requests (or Fetch*Requests), but may also be used with a manually
+  # constructed post body. The RpcRequest class uses OAuth signing inherited
+  # from the Request class, when appropriate OAuth credentials are supplied.
+  #
+
+
+  class RpcRequest < Request
+
+    # Defines the requests sent in the single RpcRequest. The requests are
+    # stored a key/value pairs.
+    attr_accessor :requests
+
+    # Initializes an RpcRequest with the supplied connection and an optional
+    # hash of requests.
+    def initialize(connection, requests = {})
+      @connection = connection
+
+      @requests = requests
+    end
+
+    # Adds one or more requests to the RpcRequest. Expects a hash of key/value
+    # pairs (key used to refernece the data when it returns => the Request).
+    def add(requests = {})
+      @requests.merge!(requests)
+    end
+
+    # Sends an RpcRequest to the OpenSocial endpoint by constructing JSON for
+    # the POST body and delegating the request to send_request. If an
+    # RpcRequest is sent with an empty list of requests, an exception is
+    # thrown. The response JSON is optionally unescaped (defaulting to true).
+    def send(unescape = true)
+      if @requests.length == 0
+        raise RequestException.new("RPC request requires a non-empty hash " +
+                                   "of requests in order to be sent.")
+      end
+
+      json = send_request(request_json, unescape)
+    end
+
+    # Sends an RpcRequest to the OpenSocial endpoint by constructing the
+    # service URI and dispatching the request. This method is public so that
+    # an arbitrary POST body can be constructed and sent. The response JSON is
+    # optionally unescaped.
+    def send_request(post_data, unescape)
+      uri = @connection.service_uri(@connection.container[:rpc], nil, nil, nil)
+      data = dispatch(uri, post_data)
+
+      parse_response(data, unescape)
+    end
+
+    private
+
+    # Parses the response JSON. First, the JSON is unescaped, when specified,
+    # then for each element specified in @requests, the appropriate response
+    # is selected from the larger JSON response. This element is then delegated
+    # to the appropriate class to be turned into a native object (Person,
+    # Activity, etc.)
+    def parse_response(response, unescape)
+      if unescape
+        parsed = JSON.parse(response.os_unescape)
+      else
+        parsed = JSON.parse(response)
+      end
+      keyed_by_id = key_by_id(parsed)
+
+      native_objects = {}
+      @requests.each_pair do |key, request|
+        native_object = request.parse_rpc_response(keyed_by_id[key.to_s])
+        native_objects.merge!({key => native_object})
+      end
+
+      return native_objects
+    end
+
+    # Constructs a hash of the elements in data referencing each element
+    # by its 'id' attribute.
+    def key_by_id(data)
+      keyed_by_id = {}
+      for entry in data
+        keyed_by_id.merge!({entry["id"] => entry})
+      end
+
+      return keyed_by_id
+    end
+
+    # Modifies each request in an outgoing RpcRequest so that its key is set
+    # to the value specified when added to the RpcRequest.
+    def request_json
+      keyed_requests = []
+      @requests.each_pair do |key, request|
+        request.key = key
+        keyed_requests << request
+      end
+
+      return keyed_requests.to_json
+    end
+  end
+
+  # An exception thrown when a request cannot return data.
+  #
+
+
+  class RequestException < RuntimeError; end
+
+  # An exception thrown when a request returns a 401 unauthorized status.
+  #
+
+
+  class AuthException < RuntimeError; end
+end

data/lib/opensocial/string/merb_string.rb

@@ -0,0 +1,32 @@
+# 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.
+
+class String #:nodoc:
+  def snake_case
+    gsub(/\B[A-Z]/, '_\&').downcase
+  end
+
+  def camel_case
+    words = split('_')
+    camel = words[1..-1].map { |e| e.capitalize }.join
+    words[0] + camel
+  end
+end

data/lib/opensocial/string/os_string.rb

@@ -0,0 +1,23 @@
+# 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.
+
+class String #:nodoc:
+  # Removes backslash escaping.
+  def os_unescape
+    unescaped = self.gsub(/\\\"/, '"')
+    unescaped = unescaped.gsub('"{', "{")
+    unescaped = unescaped.gsub('}"', "}")
+    unescaped = unescaped.gsub(/\"\"/, "\"")
+  end
+end

data/qoobaa-opensocial.gemspec

@@ -0,0 +1,99 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{qoobaa-opensocial}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jakub Ku\305\272ma", "Piotr Sarnacki"]
+  s.date = %q{2010-03-24}
+  s.description = %q{OpenSocial Google Gem}
+  s.email = %q{qoobaa@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "NOTICE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/opensocial.rb",
+     "lib/opensocial/activity.rb",
+     "lib/opensocial/appdata.rb",
+     "lib/opensocial/auth/action_controller_request.rb",
+     "lib/opensocial/auth/base.rb",
+     "lib/opensocial/base.rb",
+     "lib/opensocial/connection.rb",
+     "lib/opensocial/group.rb",
+     "lib/opensocial/person.rb",
+     "lib/opensocial/request.rb",
+     "lib/opensocial/string/merb_string.rb",
+     "lib/opensocial/string/os_string.rb",
+     "qoobaa-opensocial.gemspec",
+     "test/fixtures/activities.json",
+     "test/fixtures/activity.json",
+     "test/fixtures/appdata.json",
+     "test/fixtures/appdatum.json",
+     "test/fixtures/group.json",
+     "test/fixtures/groups.json",
+     "test/fixtures/people.json",
+     "test/fixtures/person.json",
+     "test/fixtures/person_appdata_rpc.json",
+     "test/fixtures/person_rpc.json",
+     "test/helper.rb",
+     "test/test_activity.rb",
+     "test/test_appdata.rb",
+     "test/test_connection.rb",
+     "test/test_group.rb",
+     "test/test_online.rb",
+     "test/test_person.rb",
+     "test/test_request.rb",
+     "test/test_rpcrequest.rb"
+  ]
+  s.homepage = %q{http://github.com/qoobaa/opensocial}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{OpenSocial Google Gem}
+  s.test_files = [
+    "test/test_request.rb",
+     "test/test_rpcrequest.rb",
+     "test/test_connection.rb",
+     "test/test_appdata.rb",
+     "test/test_person.rb",
+     "test/test_activity.rb",
+     "test/helper.rb",
+     "test/test_group.rb",
+     "test/test_online.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<oauth>, [">= 0"])
+      s.add_development_dependency(%q<test-unit>, [">= 2"])
+      s.add_development_dependency(%q<json_pure>, [">= 0"])
+      s.add_development_dependency(%q<mocha>, [">= 0"])
+    else
+      s.add_dependency(%q<oauth>, [">= 0"])
+      s.add_dependency(%q<test-unit>, [">= 2"])
+      s.add_dependency(%q<json_pure>, [">= 0"])
+      s.add_dependency(%q<mocha>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<oauth>, [">= 0"])
+    s.add_dependency(%q<test-unit>, [">= 2"])
+    s.add_dependency(%q<json_pure>, [">= 0"])
+    s.add_dependency(%q<mocha>, [">= 0"])
+  end
+end
+

data/test/fixtures/activities.json

@@ -0,0 +1,28 @@
+{
+  "totalResults" : 2,
+  "startIndex" : 0,
+  "entry" : [
+    {
+      "id" : "http://example.org/activities/example.org:87ead8dead6beef/self/af3778",
+      "title" : { "type" : "html",
+                  "value" : "<a href=\"foo\">some activity</a>"
+                },
+      "updated" : "2008-02-20T23:35:37.266Z",
+      "body" : "Some details for some activity",
+      "bodyId" : "383777272",
+      "url" : "http://api.example.org/activity/feeds/.../af3778",
+      "userId" : "example.org:34KJDCSKJN2HHF0DW20394"
+    },
+    {
+      "id" : "http://example.org/activities/example.org:87ead8dead6beef/self/af3779",
+      "title" : { "type" : "html",
+                  "value" : "<a href=\"foo\">some activity</a>"
+                },
+      "updated" : "2008-02-20T23:35:38.266Z",
+      "body" : "Some details for some second activity",
+      "bodyId" : "383777273",
+      "url" : "http://api.example.org/activity/feeds/.../af3779",
+      "userId" : "example.org:34KJDCSKJN2HHF0DW20394"
+    }
+  ]
+}