kaiwren-wrest 0.0.4

data/lib/wrest/mappers/attributes_container.rb

@@ -0,0 +1,123 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest::Mappers #:nodoc:
+
+  # Adds behaviour allowing a class to
+  # contain attributes and providing support
+  # for dynamic getters, setters and query methods.
+  # These methods are added at runtime, on the first
+  # invocation and on a per instance basis.   
+  # <tt>respond_to?</tt> however will respond as though 
+  # they are all already present.
+  # This means that two different instances of the same 
+  # <tt>AttributesContainer</tt> could well have
+  # different attribute getters/setters/query methods.
+  # 
+  # Note that this means the first call to a particular
+  # method will be slower because the method is defined
+  # at that point; subsequent calls will be much faster.
+  #
+  # If you're implementing your own initialize method
+  # remember to delegate to the default initialize 
+  # of AttributesContainer by invoking <tt>super(attributes)</tt>
+  # Also keep in mind that attribute getter/setter/query methods
+  # will _not_ override any existing methods on the class.
+  #
+  # In situations where this is a problem, such as a client consuming Rails
+  # REST services where <tt>id</tt> is a common attribute and clashes with
+  # Object#id it is recommended to create getter/setter/query methods
+  # on the class (which affects all instances) using the <tt>has_attributes</tt> macro.
+  module AttributesContainer
+    def self.included(klass) #:nodoc:
+      klass.extend AttributesContainer::ClassMethods
+      klass.class_eval{ include AttributesContainer::InstanceMethods }
+    end
+    
+    def self.build_attribute_getter(attribute_name) #:nodoc:
+      "def #{attribute_name};@attributes[:#{attribute_name}];end;"
+    end
+    
+    def self.build_attribute_setter(attribute_name) #:nodoc:
+      "def #{attribute_name}=(value);@attributes[:#{attribute_name}] = value;end;"
+    end
+    
+    def self.build_attribute_queryer(attribute_name) #:nodoc:
+      "def #{attribute_name}?;not @attributes[:#{attribute_name}].nil?;end;"
+    end
+    
+    module ClassMethods
+      # This macro explicitly creates getter, setter and query methods on
+      # a class, overriding any exisiting methods with the same names. 
+      # This can be used when attribute names clash with method names;
+      # an example would be Rails REST services which frequently make use
+      # an attribute named <tt>id</tt> which clashes with Object#id. Also,
+      # this can be used as a performance optimisation if the incoming
+      # attributes are known beforehand, as defining methods on the first 
+      # invocation is no longer necessary.      
+      def has_attributes(*attribute_names)
+        attribute_names.each do |attribute_name|
+          self.class_eval(
+            AttributesContainer.build_attribute_getter(attribute_name) +
+            AttributesContainer.build_attribute_setter(attribute_name) +
+            AttributesContainer.build_attribute_queryer(attribute_name)
+          ) 
+        end
+      end
+    end
+       
+    module InstanceMethods
+      # Sets up any class to act like
+      # an attributes container by creating
+      # two variables, @attributes and @interface.
+      # Remember not to use these two variable names
+      # when using AttributesContainer in your
+      # own class.
+      def initialize(attributes = {})
+        @attributes = attributes.symbolize_keys
+        @interface = Module.new
+        self.extend @interface
+      end
+      
+      def [](key)
+        @attributes[key.to_sym]
+      end
+      
+      def []=(key, value)
+        @attributes[key.to_sym] = value
+      end
+      
+      def respond_to?(method_name, include_private = false)
+        super(method_name, include_private) ? true : @attributes.include?(method_name.to_s.gsub(/(\?$)|(=$)/, '').to_sym)
+      end
+
+      # Creates getter, setter and query methods for
+      # attributes on the first call.
+      def method_missing(method_sym, *arguments)
+        method_name = method_sym.to_s
+        attribute_name = method_name.gsub(/(\?$)|(=$)/, '')
+
+        if @attributes.include?(attribute_name.to_sym) || method_name.last == '='
+          case method_name.last
+          when '='
+            @interface.module_eval AttributesContainer.build_attribute_setter(attribute_name)
+          when '?'
+            @interface.module_eval AttributesContainer.build_attribute_queryer(attribute_name)
+          else
+            @interface.module_eval AttributesContainer.build_attribute_getter(attribute_name)
+          end
+          send(method_sym, *arguments)
+        else
+          super(method_sym, *arguments)
+        end
+      end
+      
+    end
+  end
+end

data/lib/wrest/mappers/resource.rb

@@ -0,0 +1,17 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest
+  module Mappers
+    module Resource
+    end
+  end
+end
+
+require "#{WREST_ROOT}/wrest/mappers/resource/base"

data/lib/wrest/mappers/resource/base.rb

@@ -0,0 +1,69 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest::Mappers::Resource #:nodoc:
+  # Resource::Base is the equivalent of ActiveResource::Base.
+  # It is a REST client targetted at Rails REST apps.
+  class Base
+    include Wrest::Mappers::AttributesContainer
+
+    has_attributes  :id
+    attr_reader     :attributes
+    
+    class << self
+      def inherited(klass)
+        klass.set_resource_name klass.name
+      end
+      
+      # Allows the resource name to be configured and creates
+      # a getter method for it. 
+      # This is a useful feature when using anonymous classes like
+      # we often do while writing tests.
+      # By default, the resource name is set to the name of the class.
+      def set_resource_name(resource_name)
+        self.class_eval "def self.resource_name; '#{resource_name}';end"
+      end
+      
+      # Allows the host url at which the resource is found to be configured
+      # and creates a getter method for it. 
+      # For example in the url
+      #  http://localhost:3000/users/1/settings
+      # you would set 
+      #  http://localhost:3000
+      # as the host url.
+      def set_host(host)
+        self.class_eval "def self.host; '#{host}';end"
+      end
+
+      def resource_path
+        @resource_path ||= "/#{resource_name.underscore.pluralize}"
+      end
+
+      def resource_url
+        "#{host}#{resource_path}"
+      end
+      
+      def find_all
+      end
+
+      def find(id)
+        response_hash = "#{resource_url}/#{id}".to_uri.get.deserialise
+        resource_type = response_hash.keys.first
+        if(resource_type.underscore.camelize == self.name)
+          self.new(response_hash[resource_type].first)
+        else
+          response_hash
+        end
+      end
+
+      def objectify(hash)
+      end
+    end
+  end
+end

data/lib/wrest/mappers/resource/collection.rb

@@ -0,0 +1,12 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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. 
+
+# Understands how to contain a collection of Wrest::Resources
+class Wrest::Mappers::Resource::Collection
+end

data/lib/wrest/mappers/simple_resource.rb

@@ -0,0 +1,17 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest
+  module Mappers
+    class SimpleResource
+      include Wrest::Mappers::AttributesContainer
+      attr_reader :attributes
+    end
+  end
+end

data/lib/wrest/response.rb

@@ -0,0 +1,38 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest #:nodoc:
+  # Decorates a response providing support for deserialisation. 
+  #
+  # The following methods are also available (unlisted by rdoc because they're forwarded):
+  #
+  # <tt>:@http_response,  :code, :message, :body, :http_version, 
+  # :[], :content_length, :content_type, :each_header, :each_name, :each_value, :fetch,
+  # :get_fields, :key?, :type_params</tt>
+  #
+  # They behave exactly like their Net::HTTPResponse equivalents.
+  class Response
+    extend Forwardable
+    def_delegators  :@http_response,  :code, :message, :body, :http_version, 
+                    :[], :content_length, :content_type, :each_header, :each_name, :each_value, :fetch,
+                    :get_fields, :key?, :type_params
+    
+    def initialize(http_response)
+      @http_response = http_response
+    end
+    
+    def deserialise
+      deserialise_using(Wrest::Translators.load(@http_response.content_type))
+    end
+    
+    def deserialise_using(translator)
+      translator.call(@http_response)
+    end
+  end
+end

data/lib/wrest/translators.rb

@@ -0,0 +1,26 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest
+  # Contains strategies/lambdas which know how to deserialise
+  # different content types.
+  module Translators
+    # Loads the appropriate desirialisation strategy based on
+    # the content type
+    def self.load(content_type)
+      translator = CONTENT_TYPES[content_type]
+      translator || (raise UnsupportedContentTypeException.new("Unsupported content type #{content_type}"))
+    end
+  end
+end
+
+require "#{WREST_ROOT}/wrest/translators/xml"
+require "#{WREST_ROOT}/wrest/translators/json"
+require "#{WREST_ROOT}/wrest/translators/content_types"
+require "#{WREST_ROOT}/wrest/translators/typed_hash"

data/lib/wrest/translators/content_types.rb

@@ -0,0 +1,20 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest 
+  module Translators
+    # Maps content types to deserialisers
+    CONTENT_TYPES = {
+      'application/xml' => Wrest::Translators::Xml,
+      'text/xml' => Wrest::Translators::Xml,
+      'application/json' => Wrest::Translators::Json,
+      'text/javascript' => Wrest::Translators::Json
+    }
+  end
+end

data/lib/wrest/translators/json.rb

@@ -0,0 +1,21 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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. 
+
+require 'json'
+
+module Wrest
+  module Translators
+    # Knows how to deserialise json. 
+    # Depends on the json gem.
+    Json = lambda{|response| 
+        JSON.parse(response.body)
+    }
+  end
+end
+    

data/lib/wrest/translators/typed_hash.rb

@@ -0,0 +1,4 @@
+module Wrest::Translators
+  class TypedHash
+  end
+end

data/lib/wrest/translators/xml.rb

@@ -0,0 +1,24 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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. 
+
+require 'xmlsimple'
+
+module Wrest 
+  module Translators
+    # Knows how to deserialise xml.
+    # Depends on the xmlsimple gem.
+    Xml = lambda{|response|
+        XmlSimple.xml_in(
+          response.body,
+          'keeproot'  => true
+        )
+    }
+  end
+end
+    

data/lib/wrest/uri.rb

@@ -0,0 +1,74 @@
+# Copyright 2009 Sidu Ponnappa
+
+# 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 Wrest #:nodoc:
+  # Wrest::Uri provides a simple api for
+  # REST calls. String#to_uri is a convenience
+  # method to build a Wrest::Uri from a string url.
+  class Uri
+    attr_reader :uri
+    def initialize(uri_string)
+      @uri = URI.parse(uri_string)
+    end
+    
+    def eql?(other)
+      self == other
+    end
+    
+    def ==(other)
+      return false if other.class != self.class
+      return other.uri == self.uri
+    end
+    
+    def hash
+      self.uri.hash + self.class.object_id
+    end
+    
+    # Make a HTTP get request to this URI.
+    # Remember to escape the parameter strings using URI.escape 
+    def get(parameters = {}, headers = {})
+      do_request 'get', parameters.empty? ? @uri.request_uri : "#{@uri.request_uri}?#{parameters.to_query}", headers.stringify_keys
+    end
+
+    def put(body = '', headers = {})
+      do_request 'put', @uri.request_uri, body.to_s, headers.stringify_keys
+    end
+
+    def post(body = '', headers = {})
+      do_request 'post', @uri.request_uri, body.to_s, headers.stringify_keys
+    end
+
+    def delete(headers = {})
+      do_request 'delete', @uri.request_uri, headers.stringify_keys
+    end
+    
+    def do_request(method, url, *args)
+      response = nil
+
+      Wrest.logger.info  "#{method} -> #{url}"
+      time = Benchmark.realtime { response = Wrest::Response.new(http.send(method, url, *args)) }
+      Wrest.logger.info "--> %d %s (%d %.2fs)" % [response.code, response.message, response.body ? response.body.length : 0, time]
+
+      response
+    end
+    
+    def https?
+      @uri.is_a?(URI::HTTPS)
+    end
+
+    def http
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      if https?
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http
+    end
+  end
+end