kaiwren-wrest 0.0.4

data/lib/wrest/uri_template.rb

@@ -0,0 +1,32 @@
+# 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
+  class UriTemplate
+    attr_reader :uri_pattern
+    def initialize(uri_pattern)
+      @uri_pattern = uri_pattern.clone
+    end
+    
+    # Builds a new Wrest::Uri from this uri template 
+    # by replacing the keys in the options that match with
+    # the corressponding values.
+    #
+    # Example:
+    # template = UriTemplate.new("http://localhost:3000/: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>>
+    def to_uri(options = {})
+      options.inject(uri_pattern.clone) do |uri_string, tuple| 
+        key, value = tuple
+        uri_string.gsub(":#{key.to_s}", value.to_s)
+      end.to_uri
+    end
+  end
+end

data/lib/wrest/version.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. 
+
+module Wrest
+  module VERSION
+    unless defined? MAJOR
+      MAJOR  = 0
+      MINOR  = 0
+      TINY   = 4
+
+      STRING = [MAJOR, MINOR, TINY].join('.')
+
+      SUMMARY = "wrest version #{STRING}"
+    end
+  end
+end

data/spec/custom_matchers/custom_matchers.rb

@@ -0,0 +1,2 @@
+module CustomMatchers
+end

data/spec/rcov.opts

@@ -0,0 +1,4 @@
+--text-report
+--html
+--exclude-only  ^\/usr,^\/Library,^\/System,spec\/
+--output coverage

data/spec/spec.opts

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

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + "/../lib/wrest")
+require 'spec'
+
+["/custom_matchers/**/*.rb"].each{|directory|
+  Dir["#{File.expand_path(File.dirname(__FILE__) + directory)}"].each { |file|
+    require file
+  }
+}
+
+Wrest.logger = Logger.new(File.open("#{WREST_ROOT}/../log/test.log", 'a'))
+
+def p(*args)
+ super *(args << caller[0])
+end
+
+Spec::Runner.configure do |config|
+  config.include(CustomMatchers)
+end

data/spec/wrest/mappers/attributes_container_spec.rb

@@ -0,0 +1,184 @@
+# 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::Mappers
+  describe AttributesContainer do
+    class HumanBeing
+      include AttributesContainer
+      has_attributes :id
+    end
+
+    it "should allow instantiation with no attributes" do
+      lambda{ HumanBeing.new }.should_not raise_error
+    end
+
+    describe 'has_attributes' do
+      describe 'method creation' do
+        before :each do
+          @Demon = Class.new
+        end
+
+        it "should define attribute getters at the class level" do
+          kai_wren = @Demon.new
+          kai_wren.methods.should_not include('trainer')
+
+          @Demon.class_eval{
+            include AttributesContainer
+            has_attributes :trainer
+          }
+
+          kai_wren.methods.should include('trainer')
+        end
+
+        it "should define attribute setters at the class level" do
+          kai_wren = @Demon.new
+          kai_wren.methods.should_not include('trainer=')
+
+          @Demon.class_eval{
+            include AttributesContainer
+            has_attributes :trainer
+          }
+
+          kai_wren.methods.should include('trainer=')
+        end
+
+        it "should define attribute query methods at the class level" do
+          kai_wren = @Demon.new
+          kai_wren.methods.should_not include('trainer?')
+
+          @Demon.class_eval{
+            include AttributesContainer
+            has_attributes :trainer
+          }
+          kai_wren.methods.should include('trainer?')
+        end
+      end
+
+      describe 'method functionality' do
+        before :each do
+          @Demon = Class.new
+          @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
+              # by overriding method_missing
+              raise NoMethodError.new("Method #{method_name} was invoked, but doesn't exist", method_name)
+            end
+          }
+          @kai_wren = @Demon.new
+        end
+
+        it "should define attribute getters at the class level" do
+          @kai_wren.instance_variable_get("@attributes")[:trainer] = 'Viss'
+          @kai_wren.trainer.should == 'Viss'
+        end
+
+        it "should define attribute setters at the class level" do
+          @kai_wren.trainer = 'Viss'
+          @kai_wren.instance_variable_get("@attributes")[:trainer].should == 'Viss'
+        end
+
+        it "should define attribute query methods at the class level" do
+          @kai_wren.trainer?.should be_false
+          @kai_wren.instance_variable_get("@attributes")[:trainer] = 'Viss'
+          @kai_wren.trainer?.should be_true
+        end
+      end
+    end
+
+    describe 'provides an attributes interface which' do
+      before :each do
+        @li_piao = HumanBeing.new(:id => 5, :profession => 'Natural Magician', 'enhanced_by' => 'Kai Wren')
+      end
+
+      it "should provide a generic key based getter that requires symbols" do
+        @li_piao[:profession].should == "Natural Magician"
+        @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
+
+      it "should provide getter methods for attributes" do
+        @li_piao.profession.should == 'Natural Magician'
+        @li_piao.enhanced_by.should == 'Kai Wren'
+      end
+
+      it "should respond to getter methods for attributes" do
+        @li_piao.should respond_to(:profession)
+        @li_piao.should respond_to(:enhanced_by)
+      end
+
+      it "should not respond to getter methods for attributes that don't exist" do
+        @li_piao.should_not respond_to(:gods)
+      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'
+        @li_piao.niece.should == 'Li Plum'
+      end
+
+      it "should provide setter methods for attributes" do
+        @li_piao.enhanced_by = 'He of the Towers of Light'
+        @li_piao.instance_variable_get('@attributes')[:enhanced_by].should == 'He of the Towers of Light'
+      end
+
+      it "should respond to setter methods for attributes" do
+        @li_piao.should respond_to(:profession=)
+        @li_piao.should respond_to(:enhanced_by=)
+      end
+
+      it "should not respond to setter methods for attributes that don't exist" do
+        @li_piao.should_not respond_to(:god=)
+      end
+
+      it "should fail when query methods for attributes that don't exist are invoked" do
+        lambda{ @li_piao.ooga? }.should raise_error(NoMethodError)
+      end
+
+      it "should provide query methods for attributes" do
+        li_piao = HumanBeing.new( :profession => 'Natural Magician', :enhanced_by => nil)
+        li_piao.profession?.should be_true
+        li_piao.enhanced_by?.should be_false
+      end
+
+      it "should respond to query methods for attributes" do
+        @li_piao.should respond_to(:profession?)
+        @li_piao.should respond_to(:enhanced_by?)
+      end
+
+      it "should not respond to query methods for attributes that don't exist" do
+        @li_piao.should_not respond_to(:theronic?)
+      end
+
+      it "should override methods which already exist on the container" do
+        @li_piao.id.should == 5
+        @li_piao.id = 6
+        @li_piao.id.should == 6
+      end
+    end
+  end
+end

data/spec/wrest/mappers/resource/base_spec.rb

@@ -0,0 +1,158 @@
+require File.dirname(__FILE__) + '/../../../spec_helper'
+
+class Glassware < Wrest::Mappers::Resource::Base
+  set_host "http://localhost:3000"
+end
+
+class BottledUniverse < Glassware
+  set_host "http://localhost:3001"
+end
+
+module Wrest::Mappers
+  describe Resource::Base do
+    it "should not affect other classes when setting up its macros" do
+      Class.should_not respond_to(:host=)
+      Object.should_not respond_to(:host=)
+    end
+
+    it "should not affect itself when subclasses use its macros" do
+      Resource::Base.should_not respond_to(:host)
+    end
+
+    describe 'subclasses' do
+      before(:each) do
+        @BottledUniverse = Class.new(Resource::Base)
+        @BottledUniverse.class_eval do
+          set_resource_name 'BottledUniverse'
+        end
+      end
+
+      it "should know its name as a resource by default" do
+        BottledUniverse.resource_name.should == 'BottledUniverse'
+      end
+
+      it "should allow its name as a resource to be configured for anonymous classes" do
+        @BottledUniverse.resource_name.should == 'BottledUniverse'
+      end
+
+      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.name.should == "Wooz"
+        universe.owner_id.should be_nil
+        universe.id.should == 1
+      end
+
+      it "should allow instantiation with no attributes" do
+        lambda{ @BottledUniverse.new }.should_not raise_error
+      end
+
+      it "should have a method to set the host url" do
+        @BottledUniverse.should respond_to(:set_host)
+      end
+
+      it "should have a method to retrive the host url after it is set" do
+        @BottledUniverse.class_eval{ set_host "http://localhost:3000" }
+        @BottledUniverse.should respond_to(:host)
+      end
+
+      it "should know what its site is" do
+        @BottledUniverse.class_eval{ set_host "http://localhost:3000" }
+        @BottledUniverse.host.should == "http://localhost:3000"
+      end
+
+      it "should not use the same string" do
+        url = "http://localhost:3000"
+        @BottledUniverse.class_eval{ set_host  url }
+        url.upcase!
+        @BottledUniverse.host.should == "http://localhost:3000"
+      end
+
+      it "should know its resource path" do
+        Glassware.resource_path.should == '/glasswares'
+      end
+    end
+
+    describe 'subclasses of sublasses' do
+      it "should configure its host without affecting its superclass" do
+        Glassware.host.should == "http://localhost:3000"
+        BottledUniverse.host.should == "http://localhost:3001"
+      end
+
+      it "should know its resource path when it is a subclass of a subclass" do
+        BottledUniverse.resource_path.should == '/bottled_universes'
+      end
+    end
+
+    describe 'attribute interface' do
+      it "should fail when getter methods for attributes that don't exist are invoked" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        lambda{ universe.ooga }.should raise_error(NoMethodError)
+      end
+
+      it "should provide getter methods for attributes" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.owner.should == 'Kai Wren'
+        universe.guardian.should == 'Lung Shan'
+      end
+
+      it "should respond to getter methods for attributes" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.should respond_to(:owner)
+        universe.should respond_to(:guardian)
+      end
+
+      it "should not respond to getter methods for attributes that don't exist" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.should_not respond_to(:theronic)
+      end
+
+      it "should create a setter method when one is invoked for attributes that don't exist" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.fu_dog = 'Shiriki'
+        universe.attributes[:fu_dog].should == 'Shiriki'
+        universe.fu_dog.should == 'Shiriki'
+      end
+
+      it "should provide setter methods for attributes" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.guardian = 'Effervescent Tiger'
+        universe.attributes[:guardian].should == 'Effervescent Tiger'
+      end
+
+      it "should respond to setter methods for attributes" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.should respond_to(:owner=)
+        universe.should respond_to(:guardian=)
+      end
+
+      it "should not respond to setter methods for attributes that don't exist" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.should_not respond_to(:theronic=)
+      end
+
+      it "should fail when query methods for attributes that don't exist are invoked" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        lambda{ universe.ooga? }.should raise_error(NoMethodError)
+      end
+
+      it "should provide query methods for attributes" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => nil)
+        universe.owner?.should be_true
+        universe.guardian?.should be_false
+      end
+
+      it "should respond to query methods for attributes" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.should respond_to(:owner?)
+        universe.should respond_to(:guardian?)
+      end
+
+      it "should not respond to query methods for attributes that don't exist" do
+        universe = Glassware.new(:owner => 'Kai Wren', :guardian => 'Lung Shan')
+        universe.should_not respond_to(:theronic?)
+      end
+    end
+  end
+end

data/spec/wrest/mappers/simple_resource_spec.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module Wrest::Mappers
+  describe SimpleResource do
+    it "should do something"
+  end
+end

data/spec/wrest/response_spec.rb

@@ -0,0 +1,21 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+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)
+    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.should_receive(:deserialise_using).with(Translators::Xml)
+
+      response.deserialise
+    end
+  end
+end