wrest 0.0.4

data/lib/wrest/response.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. 
+
+module Wrest #:nodoc:
+  # Decorates a response providing support for deserialisation. 
+  #
+  # The following methods are also available (unlisted by rdoc because they're forwarded):
+  #
+  # <tt>:@http_response,  :code, :message, :body, :http_version, 
+  # :[], :content_length, :content_type, :each_header, :each_name, :each_value, :fetch,
+  # :get_fields, :key?, :type_params</tt>
+  #
+  # They behave exactly like their Net::HTTPResponse equivalents.
+  class Response
+    extend Forwardable
+    def_delegators  :@http_response,  :code, :message, :body, :http_version, 
+                    :[], :content_length, :content_type, :each_header, :each_name, :each_value, :fetch,
+                    :get_fields, :key?, :type_params
+    
+    def initialize(http_response)
+      @http_response = http_response
+    end
+    
+    def deserialise
+      deserialise_using(Wrest::Translators.load(@http_response.content_type))
+    end
+    
+    def deserialise_using(translator)
+      translator.call(@http_response)
+    end
+  end
+end

data/lib/wrest/translators/content_types.rb

@@ -0,0 +1,20 @@
+# 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 Translators
+    # Maps content types to deserialisers
+    CONTENT_TYPES = {
+      'application/xml' => Wrest::Translators::Xml,
+      'text/xml' => Wrest::Translators::Xml,
+      'application/json' => Wrest::Translators::Json,
+      'text/javascript' => Wrest::Translators::Json
+    }
+  end
+end

data/lib/wrest/translators/json.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 'json'
+
+module Wrest
+  module Translators
+    # Knows how to deserialise json. 
+    # Depends on the json gem.
+    Json = lambda{|response| 
+        JSON.parse(response.body)
+    }
+  end
+end
+    

data/lib/wrest/translators/typed_hash.rb

@@ -0,0 +1,4 @@
+module Wrest::Translators
+  class TypedHash
+  end
+end

data/lib/wrest/translators/xml.rb

@@ -0,0 +1,24 @@
+# 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 '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
+        )
+    }
+  end
+end
+    

data/lib/wrest/translators.rb

@@ -0,0 +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. 
+ 
+module Wrest
+  # Contains strategies/lambdas which know how to deserialise
+  # different content types.
+  module Translators
+    # Loads the appropriate desirialisation strategy based on
+    # the content type
+    def self.load(content_type)
+      translator = CONTENT_TYPES[content_type]
+      translator || (raise UnsupportedContentTypeException.new("Unsupported content type #{content_type}"))
+    end
+  end
+end
+
+require "#{WREST_ROOT}/wrest/translators/xml"
+require "#{WREST_ROOT}/wrest/translators/json"
+require "#{WREST_ROOT}/wrest/translators/content_types"
+require "#{WREST_ROOT}/wrest/translators/typed_hash"

data/lib/wrest/uri.rb

@@ -0,0 +1,74 @@
+# 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 #:nodoc:
+  # Wrest::Uri provides a simple api for
+  # REST calls. String#to_uri is a convenience
+  # method to build a Wrest::Uri from a string url.
+  class Uri
+    attr_reader :uri
+    def initialize(uri_string)
+      @uri = URI.parse(uri_string)
+    end
+    
+    def eql?(other)
+      self == other
+    end
+    
+    def ==(other)
+      return false if other.class != self.class
+      return other.uri == self.uri
+    end
+    
+    def hash
+      self.uri.hash + self.class.object_id
+    end
+    
+    # Make a HTTP get request to this URI.
+    # Remember to escape the parameter strings using URI.escape 
+    def get(parameters = {}, headers = {})
+      do_request 'get', parameters.empty? ? @uri.request_uri : "#{@uri.request_uri}?#{parameters.to_query}", headers.stringify_keys
+    end
+
+    def put(body = '', headers = {})
+      do_request 'put', @uri.request_uri, body.to_s, headers.stringify_keys
+    end
+
+    def post(body = '', headers = {})
+      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
+    end
+    
+    def do_request(method, url, *args)
+      response = nil
+
+      Wrest.logger.info  "#{method} -> #{url}"
+      time = Benchmark.realtime { response = Wrest::Response.new(http.send(method, url, *args)) }
+      Wrest.logger.info "--> %d %s (%d %.2fs)" % [response.code, response.message, response.body ? response.body.length : 0, time]
+
+      response
+    end
+    
+    def https?
+      @uri.is_a?(URI::HTTPS)
+    end
+
+    def http
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      if https?
+        http.use_ssl     = true
+        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      http
+    end
+  end
+end

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/lib/wrest.rb

@@ -0,0 +1,41 @@
+# 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 'rubygems'
+require 'net/http'
+require 'net/https'
+require 'forwardable'
+require 'date'
+require 'cgi'
+require 'base64'
+require 'logger'
+require 'benchmark'
+require 'active_support'
+
+WREST_ROOT = File.dirname(__FILE__)
+
+module Wrest
+  def self.logger=(logger)
+    @logger = logger
+  end
+  
+  def self.logger
+    @logger
+  end
+end
+
+Wrest.logger = Logger.new(STDOUT)
+Wrest.logger.level = Logger::DEBUG
+
+source_dirs = ["/wrest/core_ext/*.rb", "/wrest/*.rb"]
+
+source_dirs.each{|directory|
+  Dir["#{File.expand_path(File.dirname(__FILE__) + directory)}"].each { |file|
+    require file
+  }
+}

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