wrest 0.0.4

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

data/spec/wrest/translators/typed_hash_spec.rb

@@ -0,0 +1,9 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module Wrest::Translators
+  describe TypedHash do
+    it "should description" do
+
+    end
+  end
+end

data/spec/wrest/translators/xml_spec.rb

@@ -0,0 +1,12 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+module Wrest::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"]}]}
+    end
+  end
+end

data/spec/wrest/translators_spec.rb

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

data/spec/wrest/uri_spec.rb

@@ -0,0 +1,131 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+module Wrest
+  describe Uri do
+    def build_ok_response(body = '')
+      returning mock(Net::HTTPOK) do |response|
+        response.stub!(:code).and_return('200')
+        response.stub!(:message).and_return('OK')
+        response.stub!(:body).and_return(body)
+      end
+    end
+
+    it "should respond to the four http actions" do
+      uri = Uri.new('http://localhost')
+      uri.should respond_to(:get)
+      uri.should respond_to(:post)
+      uri.should respond_to(:put)
+      uri.should respond_to(:delete)
+    end
+
+    it "should know when it is https" do
+      Uri.new('https://localhost:3000').should be_https
+    end
+
+    it "should know when it is not https" do
+      Uri.new('http://localhost:3000').should_not be_https
+    end
+
+    it "should understand equality" do
+      Uri.new('https://localhost:3000/ooga').should_not == 'https://localhost:3000/ooga'
+      Uri.new('https://localhost:3000/ooga').should_not == Uri.new('https://localhost:3000/booga')
+      Uri.new('https://localhost:3000').should_not == Uri.new('https://localhost:3500')
+      Uri.new('https://localhost:3000').should_not == Uri.new('http://localhost:3000')
+      Uri.new('http://localhost:3000').should == Uri.new('http://localhost:3000')
+    end
+    
+    
+    it "should have the same hash code if it is the same uri" do
+      Uri.new('https://localhost:3000').hash.should == Uri.new('https://localhost:3000').hash
+      Uri.new('https://localhost:3001').hash.should_not == Uri.new('https://localhost:3000').hash
+    end
+    
+    describe 'Get' do
+      it "should know how to get" do
+        uri = "http://localhost:3000/glassware".to_uri
+        uri.should_not be_https
+
+        http = mock(Net::HTTP)
+        Net::HTTP.should_receive(:new).with('localhost', 3000).and_return(http)
+
+        http.should_receive(:get).with('/glassware', {}).and_return(build_ok_response)
+
+        uri.get
+      end
+
+      it "should know how to get with parameters" do
+        uri = "http://localhost:3000/glassware".to_uri
+        uri.should_not be_https
+
+        http = mock(Net::HTTP)
+        Net::HTTP.should_receive(:new).with('localhost', 3000).and_return(http)
+
+        http.should_receive(:get).with('/glassware?owner=Kai&type=bottle', 'page' => '2', 'per_page' => '5').and_return(build_ok_response)
+
+        uri.get({:owner => 'Kai', :type => 'bottle'}, :page => '2', :per_page => '5')
+      end
+
+      it "should know how to get with parameters but without any headers" do
+        uri = "http://localhost:3000/glassware".to_uri
+        uri.should_not be_https
+
+        http = mock(Net::HTTP)
+        Net::HTTP.should_receive(:new).with('localhost', 3000).and_return(http)
+
+        http.should_receive(:get).with('/glassware?owner=Kai&type=bottle', {}).and_return(build_ok_response)
+
+        uri.get(:owner => 'Kai', :type => 'bottle')
+      end
+    end
+    
+    it "should know how to post" do
+      uri = "http://localhost:3000/glassware".to_uri
+      uri.should_not be_https
+
+      http = mock(Net::HTTP)
+      Net::HTTP.should_receive(:new).with('localhost', 3000).and_return(http)
+
+      http.should_receive(:post).with('/glassware', '<ooga>Booga</ooga>', {'page' => '2', 'per_page' => '5'}).and_return(build_ok_response)
+
+      uri.post '<ooga>Booga</ooga>', :page => '2', :per_page => '5'
+    end
+
+    it "should know how to put" do
+      uri = "http://localhost:3000/glassware".to_uri
+      uri.should_not be_https
+
+      http = mock(Net::HTTP)
+      Net::HTTP.should_receive(:new).with('localhost', 3000).and_return(http)
+
+      http.should_receive(:put).with('/glassware', '<ooga>Booga</ooga>', {'page' => '2', 'per_page' => '5'}).and_return(build_ok_response)
+
+      uri.put '<ooga>Booga</ooga>', :page => '2', :per_page => '5'
+    end
+
+    it "should know how to delete" do
+      uri = "http://localhost:3000/glassware".to_uri
+      uri.should_not be_https
+
+      http = mock(Net::HTTP)
+      Net::HTTP.should_receive(:new).with('localhost', 3000).and_return(http)
+
+      http.should_receive(:delete).with('/glassware', {'page' => '2', 'per_page' => '5'}).and_return(build_ok_response(nil))
+
+      uri.delete(:page => '2', :per_page => '5')
+    end
+
+    it "should not mutate state of the uri across requests" do
+      uri = "http://localhost:3000/glassware".to_uri
+      uri.should_not be_https
+
+      http = mock(Net::HTTP)
+      Net::HTTP.should_receive(:new).with('localhost', 3000).any_number_of_times.and_return(http)
+
+      http.should_receive(:get).with('/glassware?owner=Kai&type=bottle', 'page' => '2', 'per_page' => '5').and_return(build_ok_response)
+      http.should_receive(:post).with('/glassware', '<ooga>Booga</ooga>', {'page' => '2', 'per_page' => '5'}).and_return(build_ok_response)
+
+      uri.get({:owner => 'Kai', :type => 'bottle'}, :page => '2', :per_page => '5')
+      uri.post '<ooga>Booga</ooga>', :page => '2', :per_page => '5'
+    end
+  end
+end

data/spec/wrest/uri_template_spec.rb

@@ -0,0 +1,28 @@
+# 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
+  describe UriTemplate do
+    it "should not maintain a reference to the string it is initialized with" do
+      url_pattern = "http://localhost:3000/:resource/:id.:format"
+      template = UriTemplate.new(url_pattern)
+      url_pattern.gsub!(':', '!')
+      template.uri_pattern.should == "http://localhost:3000/:resource/:id.:format"
+    end
+
+    it "should know how to build a Wrest::Uri from the pattern given a set of replacement options" do
+      template = UriTemplate.new("http://localhost:3000/:resource/:id.:format")
+      template.to_uri(
+          :resource => 'shen_coins', :id => 5, :format => :json
+        ).should == "http://localhost:3000/shen_coins/5.json".to_uri
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification 
+name: wrest
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Sidu Ponnappa
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-19 00:00:00 +05:30
+default_executable: wrest
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.1.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.11
+    version: 
+description: Wrest is a REST client library which allows you to quickly build object oriented wrappers around any web service. It has two main components - Wrest Core and Wrest::Resource.
+email: ckponnappa@gmail.com
+executables: 
+- wrest
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- bin/wrest
+- lib/wrest.rb
+- lib/wrest/core_ext/string.rb
+- lib/wrest/core_ext/string/conversions.rb
+- lib/wrest/exceptions.rb
+- lib/wrest/exceptions/unsupported_content_type_exception.rb
+- lib/wrest/mappers.rb
+- lib/wrest/mappers/attributes_container.rb
+- lib/wrest/mappers/resource.rb
+- lib/wrest/mappers/resource/base.rb
+- lib/wrest/mappers/resource/collection.rb
+- lib/wrest/mappers/simple_resource.rb
+- lib/wrest/response.rb
+- lib/wrest/translators.rb
+- lib/wrest/translators/content_types.rb
+- lib/wrest/translators/json.rb
+- lib/wrest/translators/typed_hash.rb
+- lib/wrest/translators/xml.rb
+- lib/wrest/uri.rb
+- lib/wrest/uri_template.rb
+- lib/wrest/version.rb
+- spec/custom_matchers/custom_matchers.rb
+- spec/rcov.opts
+- spec/spec.opts
+- spec/spec_helper.rb
+- spec/wrest/mappers/attributes_container_spec.rb
+- spec/wrest/mappers/resource/base_spec.rb
+- spec/wrest/mappers/simple_resource_spec.rb
+- spec/wrest/response_spec.rb
+- spec/wrest/translators/typed_hash_spec.rb
+- spec/wrest/translators/xml_spec.rb
+- spec/wrest/translators_spec.rb
+- spec/wrest/uri_spec.rb
+- spec/wrest/uri_template_spec.rb
+has_rdoc: true
+homepage: http://github.com/kaiwren/wrest
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: wrest
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: REST client library for Ruby.
+test_files: 
+- spec/custom_matchers/custom_matchers.rb
+- spec/spec_helper.rb
+- spec/wrest/mappers/attributes_container_spec.rb
+- spec/wrest/mappers/resource/base_spec.rb
+- spec/wrest/mappers/simple_resource_spec.rb
+- spec/wrest/response_spec.rb
+- spec/wrest/translators/typed_hash_spec.rb
+- spec/wrest/translators/xml_spec.rb
+- spec/wrest/translators_spec.rb
+- spec/wrest/uri_spec.rb
+- spec/wrest/uri_template_spec.rb