kaiwren-wrest 0.0.6 → 0.0.8

data/lib/wrest/uri_template.rb

@@ -19,9 +19,26 @@ module Wrest
     # the corressponding values.
     #
     # Example:
-    # template = UriTemplate.new("http://localhost:3000/:resource/:id.:format")
+    # template = UriTemplate.new("http://coathangers.com/:resource/:id.:format")
     # template.to_uri(:resource => 'shen_coins', :id => 5, :format => :json)
     # => #<Wrest::Uri:0x1225514 @uri=#<URI::HTTP:0x9127d8 URL:http://localhost:3000/shen_coins/5.json>>
+    #
+    # This feature can also be used to handle HTTP authentication where the username
+    # and password needs changing at runtime. However, this approach _will_ fail if
+    # the password contains characters like ^ and @.
+    #
+    # Note that beacuse because both HTTP Auth and UriTemplate
+    # use ':' as a delimiter, the pattern does look slightly weird, but it still works.
+    #
+    # Example:
+    # template = UriTemplate.new("http://:username::password@coathangers.com/:resource/:id.:format")
+    # template.to_uri(
+    #  :user => 'kaiwren',
+    #  :password => 'fupuppies',
+    #  :resource => 'portal',
+    #  :id => '1'
+    # )
+    #  => #<Wrest::Uri:0x18e0bec @uri=#<URI::HTTP:0x18e09a8 URL:http://kaiwren:fupuppies@coathangers.com/portal/1>>
     def to_uri(options = {})
       options.inject(uri_pattern.clone) do |uri_string, tuple| 
         key, value = tuple

data/lib/wrest/version.rb

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

data/spec/spec.opts

@@ -1,6 +1,6 @@
 --colour
 --format
-progress
+specdoc
 --loadby
 mtime
 --reverse

data/spec/spec_helper.rb

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

data/spec/wrest/components/attributes_container/typecaster_spec.rb

@@ -0,0 +1,63 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+module Wrest::Components
+  describe AttributesContainer::Typecaster do
+    before :each do
+      @Demon = Class.new
+      @Demon.class_eval do
+        include AttributesContainer
+        include AttributesContainer::Typecaster
+      end
+    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 do
+          include AttributesContainer
+          include AttributesContainer::Typecaster
+
+          typecast :age => as_integer
+        end
+      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
+end

data/spec/wrest/components/attributes_container_spec.rb

@@ -13,69 +13,14 @@ module Wrest::Components
   describe AttributesContainer do
     class HumanBeing
       include AttributesContainer
-      has_attributes :id
+      always_has :id
     end
 
     it "should allow instantiation with no attributes" do
       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 'always_has' do
       describe 'method creation' do
         before :each do
           @Demon = Class.new
@@ -87,7 +32,7 @@ module Wrest::Components
 
           @Demon.class_eval{
             include AttributesContainer
-            has_attributes :trainer
+            always_has :trainer
           }
 
           kai_wren.methods.should include('trainer')
@@ -99,7 +44,7 @@ module Wrest::Components
 
           @Demon.class_eval{
             include AttributesContainer
-            has_attributes :trainer
+            always_has :trainer
           }
 
           kai_wren.methods.should include('trainer=')
@@ -111,7 +56,7 @@ module Wrest::Components
 
           @Demon.class_eval{
             include AttributesContainer
-            has_attributes :trainer
+            always_has :trainer
           }
           kai_wren.methods.should include('trainer?')
         end
@@ -122,7 +67,7 @@ module Wrest::Components
           @Demon = Class.new
           @Demon.class_eval{
             include AttributesContainer
-            has_attributes :trainer
+            always_has :trainer
 
             def method_missing(method_name, *args)
               # Ensuring that the instance level
@@ -234,6 +179,17 @@ module Wrest::Components
         @li_piao.id = 6
         @li_piao.id.should == 6
       end
+      
+      it "should provide getter and query methods to instance which has corresponding attribute" do
+        zotoh_zhaan = HumanBeing.new(:species => "Delvian")
+        zotoh_zhaan.species.should == "Delvian"
+        zotoh_zhaan.species?.should be_true
+        zotoh_zhaan.species = "Human"
+        lambda{@li_piao.species}.should raise_error(NoMethodError)
+        lambda{@li_piao.species?}.should raise_error(NoMethodError)
+        @li_piao.should_not respond_to(:species=)
+        @li_piao.methods.grep(/:species=/).should be_empty
+      end
     end
   end
 end

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

@@ -33,6 +33,10 @@ module Wrest::Components
       }]]
       ).should == ["result", {"publish_date" => "1240326000", "news_source" => {"online"=>"PC via News", "unique_id"=>1}}]
     end
-
+    
+    it "should register all subclasses in the registry" do
+      class SomeMutator < Mutators::Base; end
+      Mutators::REGISTRY[:some_mutator].should == SomeMutator
+    end
   end
 end

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

@@ -0,0 +1,75 @@
+# 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::XmlMiniTypeCaster do
+    before(:each) do
+      @mutator = Mutators::XmlMiniTypeCaster.new
+    end
+
+    # {"lead-bottle"=>{"name"=>{"__content__"=>"Wooz"}, "universe-id"=>{"type"=>"integer", "nil"=>"true"}, "id"=>{"__content__"=>"1", "type"=>"integer"}}}
+
+    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", {"__content__" => "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(
+        ["ResultSet", {
+                        "firstResultPosition"=>"1", "totalResultsReturned"=>"1", 
+                        "xsi:schemaLocation"=>"urn:ooga:on http://api.search.ooga.com/NewsSearchService/V1/NewsSearchResponse.xsd", 
+                        "totalResultsAvailable"=>"23287", 
+                        "Result"=>{
+                          "UniqueId"=>{"__content__"=>"1", "type" => "integer"},
+                          "PublishDate"=>{"__content__"=>"20090424", "type" => "date"}, 
+                          "Language"=>{"__content__"=>"en"}, 
+                          "Title"=>{"__content__"=>"Wootler: Wook focus should be Klingon, not India"}, 
+                          "ClickUrls"=>[
+                                      {"One" => {"__content__"=>"http://news.ooga.com/s/ap/20090424/ap_on_go_ca_st_pe/us_us_wookieland_5"}},
+                                      {"Two" => {"__content__"=>"http://news.ooga.com/s/ap/20090424/ap_on_go_ca_st_pe/us_us_wookieland_6"}},
+                                    ]
+                                       
+                        }
+                      }
+        ]
+      ).should == ["ResultSet", {
+                        "firstResultPosition"=>"1", "totalResultsReturned"=>"1", 
+                        "xsi:schemaLocation"=>"urn:ooga:on http://api.search.ooga.com/NewsSearchService/V1/NewsSearchResponse.xsd", 
+                        "totalResultsAvailable"=>"23287", 
+                        "Result"=>{
+                          "UniqueId"=> 1,
+                          "PublishDate"=>Date.parse("20090424"),
+                          "Language"=>"en", 
+                          "Title"=>"Wootler: Wook focus should be Klingon, not India", 
+                          "ClickUrls"=>[
+                                      {"One" => "http://news.ooga.com/s/ap/20090424/ap_on_go_ca_st_pe/us_us_wookieland_5"},
+                                      {"Two" => "http://news.ooga.com/s/ap/20090424/ap_on_go_ca_st_pe/us_us_wookieland_6"},
+                                    ]
+                        }
+                      }
+        ]
+    end
+  end
+end

data/spec/wrest/components/mutators_spec.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 File.dirname(__FILE__) + '/../../spec_helper'
+
+module Wrest::Components
+  describe Mutators do
+    it "should know how to chain mutators without having to namespace them all" do
+      mutator = Mutators.chain(:xml_mini_type_caster, :xml_simple_type_caster, :camel_to_snake_case)
+      mutator.class.should == Mutators::XmlMiniTypeCaster
+      mutator.next_mutator.class.should == Mutators::XmlSimpleTypeCaster
+      mutator.next_mutator.next_mutator.class.should == Mutators::CamelToSnakeCase
+    end
+  end
+end

data/spec/wrest/components/translators/xml_spec.rb

@@ -6,7 +6,7 @@ module Wrest::Components::Translators
       http_response = mock('Http Reponse')
       http_response.should_receive(:body).and_return("<ooga><age>12</age></ooga>")
 
-      Xml.deserialise(http_response).should == {"ooga"=>[{"age"=>["12"]}]}
+      Xml.deserialise(http_response).should == {"ooga"=>{"age"=>{"__content__" => "12"}}}
     end
   end
 end

data/spec/wrest/components/translators_spec.rb

@@ -1,3 +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. 
+
 require File.dirname(__FILE__) + '/../../spec_helper'
 
 module Wrest::Components

data/spec/wrest/core_ext/string/conversions_spec.rb

@@ -13,4 +13,13 @@ 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
+  
+  it "should accept username and password as options" do
+    uri = 'http://localhost:3000'.to_uri(
+      :username => 'ooga',
+      :password => 'booga'
+    )
+    uri.username.should == 'ooga'
+    uri.password.should == 'booga'
+  end
 end

data/spec/wrest/http/request_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 Wrest::Http::Request do
+  it "should convert all symbols in header keys to strings" do
+    Wrest::Http::Request.new(
+                'http://localhost/foo'.to_uri, Net::HTTP::Get, {}, 
+                nil, 'Content-Type' => 'application/xml', :per_page => '10'
+                ).headers.should == {
+                  'Content-Type' => 'application/xml',
+                  'per_page' => '10'
+                }
+  end
+end

data/spec/wrest/{response_spec.rb → http/response_spec.rb}

@@ -1,18 +1,18 @@
-require File.dirname(__FILE__) + '/../spec_helper'
+require File.dirname(__FILE__) + '/../../spec_helper'
 
 module Wrest
-  describe Response do
+  describe Http::Response do
     it "should know how to delegate to a translator" do
       http_response = mock('response')
       Components::Translators::Xml.should_receive(:deserialise).with(http_response)
-      Response.new(http_response).deserialise_using(Components::Translators::Xml)
+      Http::Response.new(http_response).deserialise_using(Components::Translators::Xml)
     end
 
     it "should know how to load a translator based on content type" do
       http_response = mock('response')
       http_response.should_receive(:content_type).and_return('application/xml')
 
-      response = Response.new(http_response)
+      response = Http::Response.new(http_response)
       response.should_receive(:deserialise_using).with(Components::Translators::Xml)
 
       response.deserialise