wrest 0.0.5-java

data/lib/wrest/components/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::Components #: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/components/mutators.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. 
+
+module Wrest #:nodoc:
+  module Components
+    # A mutator understands how to transform
+    # one tuple(key/value pair) from a hash
+    # into another
+    module Mutators
+    end
+  end
+end
+
+require "#{WREST_ROOT}/wrest/components/mutators/base"
+require "#{WREST_ROOT}/wrest/components/mutators/xml_simple_type_caster"

data/lib/wrest/components/mutators/base.rb

@@ -0,0 +1,27 @@
+# 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. 
+
+# This is a Null Object implementation of a
+# hash mutator that will leave the contents
+# of any hash it is applied to unchanged.
+class Wrest::Components::Mutators::Base
+  # This method operates on a tuple (well, pair)
+  # from a hash map.
+  # Iterating over any hash using each injects
+  # each key/value pair from the hash in the
+  # form of an array.
+  # Thus the tuple this method expects 
+  # is simply [:key, :value]
+  #
+  # Since this is a Null Object, this method
+  # simply returns the tuple unchanged
+  def mutate(tuple)
+    tuple
+  end
+end

data/lib/wrest/components/mutators/xml_simple_type_caster.rb

@@ -0,0 +1,31 @@
+# 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. 
+
+# This mutator undertands how do type casting
+# using the type data embedded in a hash
+# created by deserialising an xml using
+# xml-simple
+class Wrest::Components::Mutators::XmlSimpleTypeCaster
+  def mutate(tuple)
+    out_key = tuple.first.underscore
+    in_value = tuple.last[0]
+    out_value = in_value
+    
+    case in_value
+    when Hash
+      if in_value["nil"] == "true"
+        out_value = nil
+      elsif in_value["type"] == "integer"
+        out_value = in_value["content"].to_i
+      end
+    end
+      
+    [out_key, out_value]
+  end
+end

data/lib/wrest/core_ext/hash.rb

@@ -0,0 +1,5 @@
+require "#{WREST_ROOT}/wrest/core_ext/hash/conversions"
+
+class Hash #:nodoc:
+  include Wrest::CoreExt::Hash::Conversions
+end

data/lib/wrest/core_ext/hash/conversions.rb

@@ -0,0 +1,25 @@
+# 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 CoreExt #:nodoc:
+    module Hash #:nodoc:
+      # Makes it easier to build other objects from a String
+      module Conversions
+
+        # A convenience method equivalent to Wrest::Uri.new(string)
+        def to_mutated_hash(mutator)
+          returning({})do |mutated_hash|
+            self.each{|tuple| mutated_hash.store(*mutator.mutate(tuple))}
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wrest/core_ext/string.rb

@@ -0,0 +1,5 @@
+require "#{WREST_ROOT}/wrest/core_ext/string/conversions"
+
+class String #:nodoc:
+  include Wrest::CoreExt::String::Conversions
+end

data/lib/wrest/core_ext/string/conversions.rb

@@ -0,0 +1,23 @@
+# 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 CoreExt #:nodoc:
+    module String #:nodoc:
+      # Makes it easier to build other objects from a String
+      module Conversions
+
+        # A convenience method equivalent to Wrest::Uri.new(string)
+        def to_uri
+          Wrest::Uri.new(self)
+        end
+      end
+    end
+  end
+end

data/lib/wrest/exceptions.rb

@@ -0,0 +1 @@
+require "#{WREST_ROOT}/wrest/exceptions/unsupported_content_type_exception"

data/lib/wrest/exceptions/unsupported_content_type_exception.rb

@@ -0,0 +1,15 @@
+# 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
+  # Raised when a translator for an unregisterd response content type
+  # is requested. See Translators.
+  class UnsupportedContentTypeException < StandardError
+  end
+end

data/lib/wrest/resource.rb

@@ -0,0 +1,18 @@
+# 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
+  # Wrest::Resource is a re-implementation
+  # of ActiveResource using Wrest::Components
+  # and with some of the rough edges removed
+  module Resource
+  end
+end
+
+require "#{WREST_ROOT}/wrest/resource/base"

data/lib/wrest/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::Resource #:nodoc:
+  # Resource::Base is the equivalent of ActiveResource::Base.
+  # It is a REST client targetted at Rails REST apps.
+  class Base
+    include Wrest::Components::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/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::Resource::Collection
+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,25 @@
+# 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"