wrest 0.0.5 → 0.0.6

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/exceptions/method_not_overridden_exception.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 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

@@ -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.
+
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+module Wrest::Components
+  describe Mutators::Base do
+    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

@@ -0,0 +1,47 @@
+# 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::XmlSimpleTypeCaster do
+    before(:each) do
+      @mutator = Mutators::XmlSimpleTypeCaster.new
+    end
+
+    # {"lead-bottle"=>[{"name"=>["Wooz"], "universe-id"=>[{"type"=>"integer", "nil"=>"true"}], "id"=>[{"type"=>"integer", "content"=>"1"}]}]}
+
+    it "should typecast a nil value in a tuple" do
+      @mutator.mutate(
+      ["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"]]
+      ).should == ["name", "Wooz"]
+    end
+
+    it "should cast an integer value in a tuple" do
+      @mutator.mutate(
+      ["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

data/spec/wrest/{translators → components/translators}/xml_spec.rb

@@ -1,12 +1,12 @@
-require File.dirname(__FILE__) + '/../../spec_helper'
+require File.dirname(__FILE__) + '/../../../spec_helper'
 
-module Wrest::Translators
+module Wrest::Components::Translators
   describe Xml do  
     it "should know how to convert xml to a hashmap" do
       http_response = mock('Http Reponse')
       http_response.should_receive(:body).and_return("<ooga><age>12</age></ooga>")
 
-      Xml.call(http_response).should == {"ooga"=>[{"age"=>["12"]}]}
+      Xml.deserialise(http_response).should == {"ooga"=>[{"age"=>["12"]}]}
     end
   end
 end

data/spec/wrest/components/translators_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module Wrest::Components
+  describe Translators do
+    it "should know how to raise an exception if the mime type doesn't exist" do
+      lambda{ Translators.lookup('weird/unknown')}.should raise_error(Wrest::Exceptions::UnsupportedContentTypeException)
+    end
+  end
+end

data/spec/wrest/core_ext/hash/conversions_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'
+
+describe Hash, 'conversions' do
+  it "should know how to build a mutated hash given a hash mutator" do
+    class StringToSymbolMutator < Wrest::Components::Mutators::Base
+      def mutate(pair)
+        [pair.first.to_sym, pair.last]
+      end
+    end
+    
+    {'ooga' => 'booga'}.mutate_using(StringToSymbolMutator.new).should == {:ooga => 'booga'}
+  end
+end

data/{lib/wrest/translators/json.rb → spec/wrest/core_ext/string/conversions_spec.rb}

@@ -7,15 +7,10 @@
 # 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'
+require File.dirname(__FILE__) + '/../../../spec_helper'
 
-module Wrest
-  module Translators
-    # Knows how to deserialise json. 
-    # Depends on the json gem.
-    Json = lambda{|response| 
-        JSON.parse(response.body)
-    }
+describe String, 'conversions' do
+  it "should know how to convert a string to a Wrest::Uri" do
+    'http://localhost:3000'.to_uri.should == Wrest::Uri.new('http://localhost:3000')
   end
 end
-    

data/spec/wrest/resource/base_spec.rb

@@ -38,7 +38,7 @@ module Wrest
       it "should know how to create an instance using deserialised attributes" do
         # Json => {"lead_bottle"=>{"name"=>"Wooz", "id"=>1, "universe_id"=>nil}}
         # Xml =>  {"lead-bottle"=>[{"name"=>["Wooz"], "universe-id"=>[{"type"=>"integer", "nil"=>"true"}], "id"=>[{"type"=>"integer", "content"=>"1"}]}]}
-        universe = @BottledUniverse.new "name"=>"Wooz", "id"=>1, "universe_id"=>nil, 'owner_id'=>nil
+        universe = @BottledUniverse.new "name"=>"Wooz", "id"=>'1', "universe_id"=>nil, 'owner_id'=>nil
         universe.name.should == "Wooz"
         universe.owner_id.should be_nil
         universe.id.should == 1

data/spec/wrest/response_spec.rb

@@ -4,8 +4,8 @@ module Wrest
   describe Response do
     it "should know how to delegate to a translator" do
       http_response = mock('response')
-      Translators::Xml.should_receive(:call).with(http_response)
-      Response.new(http_response).deserialise_using(Translators::Xml)
+      Components::Translators::Xml.should_receive(:deserialise).with(http_response)
+      Response.new(http_response).deserialise_using(Components::Translators::Xml)
     end
 
     it "should know how to load a translator based on content type" do
@@ -13,7 +13,7 @@ module Wrest
       http_response.should_receive(:content_type).and_return('application/xml')
 
       response = Response.new(http_response)
-      response.should_receive(:deserialise_using).with(Translators::Xml)
+      response.should_receive(:deserialise_using).with(Components::Translators::Xml)
 
       response.deserialise
     end