wrest 0.0.5-java → 0.0.6-java

data/lib/wrest/{translators → components/translators}/xml.rb

@@ -1,24 +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. 
+# 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
-        )
-    }
+module Wrest::Components::Translators
+  module Xml
+    extend self
+
+    def deserialise(response)
+      XmlSimple.xml_in(
+      response.body,
+      'keeproot'  => true
+      )
+    end
+
+    def serialise(hash)
+    end
   end
 end
-    

data/lib/wrest/components/typecast_helpers.rb

@@ -0,0 +1,41 @@
+module Wrest::Components #:nodoc:
+  # Provides helper methods which build lambdas
+  # to cast strings to specific types.
+  module TypecastHelpers
+    def as_base64Binary
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['base64Binary']
+    end
+
+    def as_boolean
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['boolean']
+    end
+
+    def as_decimal
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['decimal']
+    end
+
+    def as_date
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['date']
+    end
+
+    def as_datetime
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['datetime']
+    end
+
+    def as_float
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['float']
+    end
+
+    def as_integer
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['integer']
+    end
+
+    def as_symbol
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['symbol']
+    end
+
+    def as_yaml
+      ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['yaml']
+    end
+  end
+end

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

@@ -10,11 +10,30 @@
 module Wrest
   module CoreExt #:nodoc:
     module Hash #:nodoc:
-      # Makes it easier to build other objects from a String
+      # Makes it easier to build other objects from a Hash
       module Conversions
 
-        # A convenience method equivalent to Wrest::Uri.new(string)
-        def to_mutated_hash(mutator)
+        # This method accepts a hash mutator (found in Wrest::Compononents)
+        # to build a new hash map by making changes to an existing one.
+        #
+        # No, this method does not mutate the state of the hash it is invoked on, 
+        # but rather builds a new one.
+        #
+        # Yes, the name is misleading in that respect. However, one 
+        # hopes the absence of an exclamation mark will increase clarity.
+        #
+        # Uses include mutating the hash produced by xml-simple
+        # by using the meta data in the hash to type cast values.
+        # 
+        # Example:
+        # "http://search.yahooapis.com/NewsSearchService/V1/newsSearch".to_uri.get(
+        #                           :appid  => 'YahooDemo', 
+        #                           :output => 'xml',
+        #                           :query  => 'India',
+        #                           :results=> '3',
+        #                           :start  => '1'
+        #                         ).deserialise.mutate_using(XmlSimpleTypeCaster.new)
+        def mutate_using(mutator)
           returning({})do |mutated_hash|
             self.each{|tuple| mutated_hash.store(*mutator.mutate(tuple))}
           end

data/lib/wrest/exceptions.rb

@@ -1 +1,6 @@
-require "#{WREST_ROOT}/wrest/exceptions/unsupported_content_type_exception"
+module Wrest
+  module Exceptions #:nodoc:
+  end
+end
+require "#{WREST_ROOT}/wrest/exceptions/unsupported_content_type_exception"
+require "#{WREST_ROOT}/wrest/exceptions/method_not_overridden_exception"

data/lib/wrest/{translators/json.rb → exceptions/method_not_overridden_exception.rb}

@@ -1,21 +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. 
-
-require 'json'
+# 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
-    # Knows how to deserialise json. 
-    # Depends on the json gem.
-    Json = lambda{|response| 
-        JSON.parse(response.body)
-    }
+  module Exceptions
+    # Raised when a base method that should be overriden
+    # is invoked on a subclass that has not implemented it.
+    class MethodNotOverriddenException < StandardError
+    end
   end
 end
-    

data/lib/wrest/exceptions/unsupported_content_type_exception.rb

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

data/lib/wrest/resource/base.rb

@@ -14,6 +14,7 @@ module Wrest::Resource #:nodoc:
     include Wrest::Components::AttributesContainer
 
     has_attributes  :id
+    typecast        :id => as_integer
     attr_reader     :attributes
     
     class << self
@@ -40,7 +41,10 @@ module Wrest::Resource #:nodoc:
       def set_host(host)
         self.class_eval "def self.host; '#{host}';end"
       end
-
+      
+      def set_redirect_handler(method_object)
+      end
+      
       def resource_path
         @resource_path ||= "/#{resource_name.underscore.pluralize}"
       end

data/lib/wrest/response.rb

@@ -28,11 +28,11 @@ module Wrest #:nodoc:
     end
     
     def deserialise
-      deserialise_using(Wrest::Translators.load(@http_response.content_type))
+      deserialise_using(Wrest::Components::Translators.lookup(@http_response.content_type))
     end
     
     def deserialise_using(translator)
-      translator.call(@http_response)
+      translator.deserialise(@http_response)
     end
   end
 end

data/lib/wrest/uri.rb

@@ -27,7 +27,7 @@ module Wrest #:nodoc:
     end
     
     def hash
-      self.uri.hash + self.class.object_id
+      self.uri.hash + 20090423
     end
     
     # Make a HTTP get request to this URI.
@@ -44,8 +44,8 @@ module Wrest #:nodoc:
       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
+    def delete(parameters = {}, headers = {})
+      do_request 'delete', parameters.empty? ? @uri.request_uri : "#{@uri.request_uri}?#{parameters.to_query}", headers.stringify_keys
     end
     
     def do_request(method, url, *args)

data/lib/wrest/version.rb

@@ -12,7 +12,7 @@ module Wrest
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 0
-      TINY   = 5
+      TINY   = 6
 
       STRING = [MAJOR, MINOR, TINY].join('.')
 

data/spec/spec_helper.rb

@@ -10,7 +10,8 @@ require 'spec'
 Wrest.logger = Logger.new(File.open("#{WREST_ROOT}/../log/test.log", 'a'))
 
 def p(*args)
- super *(args << caller[0])
+ # super *(args << caller[0])
+ super *(args << '<br>')
 end
 
 Spec::Runner.configure do |config|

data/spec/wrest/components/attributes_container_spec.rb

@@ -20,6 +20,61 @@ module Wrest::Components
       lambda{ HumanBeing.new }.should_not raise_error
     end
 
+    describe 'typecast' do
+      before :each do
+        @Demon = Class.new
+        @Demon.class_eval{include AttributesContainer}
+      end
+
+      it "should know how to apply a lambda to the string value of a given key casting it to a new type" do
+        @Demon.class_eval{ typecast :age => lambda{|id_string| id_string.to_i} }
+        kai_wren = @Demon.new('age' => '1')
+        kai_wren.age.should == 1
+      end
+
+      it "should not apply a lambda to the value of a given key if it is not a string" do
+        @Demon.class_eval{ typecast :age => lambda{|id_string| id_string.to_i} }
+        kai_wren = @Demon.new('age' => :ooga)
+        kai_wren.age.should == :ooga
+      end
+
+      it "should leave nils unchanged" do
+        @Demon.class_eval{ typecast :age => lambda{|id_string| id_string.to_i} }
+        kai_wren = @Demon.new('age' => nil)
+        kai_wren.age.should be_nil
+      end
+
+      it "should provide helpers for typcasting common types" do
+        @Demon.class_eval{ typecast :age => as_integer }
+        kai_wren = @Demon.new('age' => '1500')
+        kai_wren.age.should == 1500
+      end
+
+      describe 'in subclasses' do
+        before :each do
+          @Sidhe = Class.new
+          @Sidhe.class_eval{
+            include AttributesContainer
+            typecast :age => as_integer
+          }
+        end
+
+        it "should inherit all defined typecasts" do
+          @ChineseSidhe = Class.new(@Sidhe)
+          kai_wren = @ChineseSidhe.new('age' => '1500')
+          kai_wren.age.should == 1500
+        end
+        
+        it "should discard all typecasts from parent if defined in child" do
+          @ChineseSidhe = Class.new(@Sidhe)
+          @ChineseSidhe.class_eval{ typecast :born_in => as_integer }
+          kai_wren = @ChineseSidhe.new('age' => '1500', 'born_in' => '509')
+          kai_wren.age.should == '1500'
+          kai_wren.born_in.should == 509
+        end
+      end
+    end
+
     describe 'has_attributes' do
       describe 'method creation' do
         before :each do
@@ -68,7 +123,7 @@ module Wrest::Components
           @Demon.class_eval{
             include AttributesContainer
             has_attributes :trainer
-            
+
             def method_missing(method_name, *args)
               # Ensuring that the instance level
               # attribute methods don't kick in
@@ -107,16 +162,6 @@ module Wrest::Components
         @li_piao['profession'].should == "Natural Magician"
       end
 
-      it "should provide a generic key based getter that understands symbols" do
-        @li_piao[:enhanced_by] = "Viss"
-        @li_piao.instance_variable_get('@attributes')[:enhanced_by].should == "Viss"
-      end
-
-      it "should provide a generic key based getter that translates strings to symbols" do
-        @li_piao['enhanced_by'] = "Viss"
-        @li_piao.instance_variable_get('@attributes')[:enhanced_by].should == "Viss"
-      end
-
       it "should fail when getter methods for attributes that don't exist are invoked" do
         lambda{ @li_piao.ooga }.should raise_error(NoMethodError)
       end
@@ -135,6 +180,16 @@ module Wrest::Components
         @li_piao.should_not respond_to(:gods)
       end
 
+      it "should provide a generic key based setter that understands symbols" do
+        @li_piao[:enhanced_by] = "Viss"
+        @li_piao.instance_variable_get('@attributes')[:enhanced_by].should == "Viss"
+      end
+
+      it "should provide a generic key based setter that translates strings to symbols" do
+        @li_piao['enhanced_by'] = "Viss"
+        @li_piao.instance_variable_get('@attributes')[:enhanced_by].should == "Viss"
+      end
+
       it "should create a setter method when one is invoked for attributes that don't exist" do
         @li_piao.niece = 'Li Plum'
         @li_piao.instance_variable_get('@attributes')[:niece].should == 'Li Plum'

data/spec/wrest/components/mutators/base_spec.rb

@@ -1,18 +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. 
+# 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 File.dirname(__FILE__) + '/../../../spec_helper'
 
 module Wrest::Components
   describe Mutators::Base do
-    it "should return a tuple unchanged" do
-      Mutators::Base.new.mutate([:ooga, :booga]).should == [:ooga, :booga]
+    it "should raise an exception if mutate is invoked without do_mutate being implemented in a subclass" do
+      lambda{ Class.new(Mutators::Base).new.mutate([]) }.should raise_error(Wrest::Exceptions::MethodNotOverriddenException)
     end
+
+    it "should ensure that the next mutator is invoked for a subclass" do
+      next_mutator = mock('Mutator')
+      mutator = Mutators::CamelToSnakeCase.new(next_mutator)
+
+      next_mutator.should_receive(:mutate).with(['a', 1]).and_return([:a, '1'])
+
+      mutator.mutate(['a', 1]).should == [:a, '1']
+    end
+
+    it "should know how to chain mutators recursively" do
+      mutator = Mutators::XmlSimpleTypeCaster.new(Mutators::CamelToSnakeCase.new)
+      mutator.mutate(
+      ["Result", [{
+        "Publish-Date"=>["1240326000"],
+        "News-Source"=>[{"Online" => ["PC via News"], "Unique-Id" => [{"type"=>"integer", "content"=>"1"}]}]
+      }]]
+      ).should == ["result", {"publish_date" => "1240326000", "news_source" => {"online"=>"PC via News", "unique_id"=>1}}]
+    end
+
   end
 end

data/spec/wrest/components/mutators/camel_to_snake_spec.rb

@@ -0,0 +1,22 @@
+# 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 File.dirname(__FILE__) + '/../../../spec_helper'
+
+module Wrest::Components
+  describe Mutators::CamelToSnakeCase do
+    before(:each) do
+      @mutator = Mutators::CamelToSnakeCase.new
+    end
+
+    it "should underscore the key in a tuple" do
+      @mutator.mutate(["universe-id", "1"]).should == ["universe_id", "1"]
+    end
+  end
+end

data/spec/wrest/components/mutators/xml_simple_type_caster_spec.rb

@@ -16,26 +16,32 @@ module Wrest::Components
     end
 
     # {"lead-bottle"=>[{"name"=>["Wooz"], "universe-id"=>[{"type"=>"integer", "nil"=>"true"}], "id"=>[{"type"=>"integer", "content"=>"1"}]}]}
-    it "should underscore the key in a tuple" do
-      @mutator.mutate(["universe-id", ["1"]]).should == ["universe_id", "1"]
-    end
 
     it "should typecast a nil value in a tuple" do
       @mutator.mutate(
-        ["universe-id", [{"type"=>"integer", "nil"=>"true"}]]
-      ).should == ["universe_id", nil]
+      ["universe-id", [{"type"=>"integer", "nil"=>"true"}]]
+      ).should == ["universe-id", nil]
     end
 
     it "should leave a string value in a tuple unchanged" do
       @mutator.mutate(
-        ["name", ["Wooz"]]
+      ["name", ["Wooz"]]
       ).should == ["name", "Wooz"]
     end
-    
+
     it "should cast an integer value in a tuple" do
       @mutator.mutate(
-        ["id", [{"type"=>"integer", "content"=>"1"}]]
+      ["id", [{"type"=>"integer", "content"=>"1"}]]
       ).should == ["id", 1]
     end
+    
+    it "should step into a value if it is a hash" do
+      @mutator.mutate(
+        ["Result", [{
+                      "PublishDate"=>["1240326000"], 
+                      "NewsSource"=>[{"Online" => ["PC via News"], "UniqueId" => [{"type"=>"integer", "content"=>"1"}]}]
+                    }]]
+      ).should == ["Result", {"PublishDate" => "1240326000", "NewsSource" => {"Online"=>"PC via News", "UniqueId"=>1}}]
+    end
   end
 end