wrest 0.0.8-java → 0.0.9-java

data/lib/wrest/components/attributes_container/typecaster.rb

@@ -26,19 +26,61 @@ module Wrest
         klass.class_eval{ include Typecaster::InstanceMethods }
         klass.alias_method_chain  :initialize,  :typecasting
       end
+      
+      module Helpers
+        def as_base64Binary
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['base64Binary']
+        end
+
+        def as_boolean
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['boolean']
+        end
+
+        def as_decimal
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['decimal']
+        end
+
+        def as_date
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['date']
+        end
+
+        def as_datetime
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['datetime']
+        end
+
+        def as_float
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['float']
+        end
+
+        def as_integer
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['integer']
+        end
 
+        def as_symbol
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['symbol']
+        end
+
+        def as_yaml
+          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['yaml']
+        end
+      end
+        
       module ClassMethods
         # Accepts a set of attribute-name/lambda pairs which are used
         # to typecast string values injected through the constructor.
         # Typically needed when populating an +AttributesContainer+
         # directly from request params. Typecasting kicks in for
-        # a given value _only_ if it is a string.
+        # a given value _only_ if it is a String, Hash or Array, the
+        # three classes that deserilisation can produce.
         #
         # Typecast information is inherited by subclasses; however be
         # aware that explicitly invoking +typecast+ in a subclass will
         # discard inherited typecast information leaving only the casts
         # defined in the subclass.
         #
+        # Note that this _will_ increase the time needed to initialize
+        # instances.
+        #
         # Common typecasts such as integer, float, datetime etc. are
         # available through predefined helpers. See TypecastHelpers
         # for a full list.
@@ -69,42 +111,6 @@ module Wrest
             {}
           end
         end
-
-        def as_base64Binary
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['base64Binary']
-        end
-
-        def as_boolean
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['boolean']
-        end
-
-        def as_decimal
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['decimal']
-        end
-
-        def as_date
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['date']
-        end
-
-        def as_datetime
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['datetime']
-        end
-
-        def as_float
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['float']
-        end
-
-        def as_integer
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['integer']
-        end
-
-        def as_symbol
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['symbol']
-        end
-
-        def as_yaml
-          ActiveSupport::CoreExtensions::Hash::Conversions::XML_PARSING['yaml']
-        end
       end
 
       module InstanceMethods # :nodoc:
@@ -112,7 +118,7 @@ module Wrest
           initialize_without_typecasting(attributes)
           self.class.typecast_map.each do |key, typecaster|
             value = @attributes[key]
-            @attributes[key] = typecaster.call(value) if value.is_a?(String)
+            @attributes[key] = typecaster.call(value) if (value.is_a?(String) || value.is_a?(Hash) || value.is_a?(Array))
           end
         end
       end

data/lib/wrest/components/mutators/base.rb

@@ -49,7 +49,7 @@ module Wrest
 
       protected
       def do_mutate(tuple)
-        raise Wrest::Exceptions::MethodNotOverriddenException
+        raise Wrest::Exceptions::MethodNotOverridden
       end
     end
   end

data/lib/wrest/components/translators.rb

@@ -17,7 +17,7 @@ module Wrest
       # the content type
       def self.lookup(content_type)
         translator = CONTENT_TYPES[content_type]
-        translator || (raise Wrest::Exceptions::UnsupportedContentTypeException.new("Unsupported content type #{content_type}"))
+        translator || (raise Wrest::Exceptions::UnsupportedContentType.new("Unsupported content type #{content_type}"))
       end
     end
   end

data/lib/wrest/core_ext/string/conversions.rb

@@ -15,7 +15,7 @@ module Wrest
 
         # A convenience method equivalent to Wrest::Uri.new(string)
         def to_uri(options = {})
-          Wrest::Uri.new(self, options)
+          Wrest::Uri.new(self.strip, options)
         end
       end
     end

data/lib/wrest/exceptions.rb

@@ -1,6 +1,18 @@
 module Wrest
   module Exceptions #:nodoc:
+    # Raised when a base method that should be overriden
+    # is invoked on a subclass that has not implemented it.
+    class MethodNotOverridden < StandardError
+    end
+
+    # Raised when a translator for an unregisterd response content type
+    # is requested. See Translators.
+    class UnsupportedContentType < StandardError
+    end
+    
+    # Raised when a request auto redirects more times than are allowed
+    # by its follow_redirects_limit. See Wrest::Http::Redirection.
+    class AutoRedirectLimitExceeded < StandardError
+    end
   end
 end
-require "#{WREST_ROOT}/wrest/exceptions/unsupported_content_type_exception"
-require "#{WREST_ROOT}/wrest/exceptions/method_not_overridden_exception"

data/lib/wrest/http.rb

@@ -16,6 +16,7 @@ module Wrest #:nodoc:
 end
 
 require "#{WREST_ROOT}/wrest/http/response"
+require "#{WREST_ROOT}/wrest/http/redirection"
 require "#{WREST_ROOT}/wrest/http/request"
 require "#{WREST_ROOT}/wrest/http/get"
 require "#{WREST_ROOT}/wrest/http/put"

data/lib/wrest/http/get.rb

@@ -10,6 +10,8 @@
 module Wrest::Http
   class Get < Request
     def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+      follow_redirects = options[:follow_redirects]
+      options[:follow_redirects] = (follow_redirects == nil ? true : follow_redirects)
       super(
             wrest_uri, 
             Net::HTTP::Get, 

data/lib/wrest/http/redirection.rb

@@ -0,0 +1,35 @@
+# 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:
+  module Http #:nodoc:
+    # Constructed by Wrest::Response.new if the HTTP response code is 3xx 
+    # (http://en.wikipedia.org/wiki/300_Multiple_Choices#3xx_Redirection)
+    class Redirection < Response
+      
+      # A get is invoked on the url stored in the response headers
+      # under the key 'location' and the new Response is returned.
+      #
+      # The follow_redirects_count and follow_redirects_limit options 
+      # should be present. follow_redirects_count will be incremented by 1.
+      #
+      # This method will raise a Wrest::Exceptions::AutoRedirectLimitExceeded
+      # if the follow_redirects_count equals the follow_redirects_limit.
+      def follow(redirect_request_options = {})
+        target = self['location']
+        redirect_request_options = redirect_request_options.clone
+
+        raise Wrest::Exceptions::AutoRedirectLimitExceeded if (redirect_request_options[:follow_redirects_count] += 1) >= redirect_request_options[:follow_redirects_limit]
+
+        Wrest.logger.debug "--| Redirecting to #{target}"
+        target.to_uri(redirect_request_options).get
+      end
+    end
+  end
+end

data/lib/wrest/http/request.rb

@@ -8,16 +8,39 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 module Wrest::Http
+  # This represents a HTTP request. Typically you will never need to instantiate
+  # one of these yourself - you can use one of the more conveient APIs via Wrest::Uri
+  # or Wrest::Http::Get etc. instead.
   class Request
-    attr_reader :http_request, :uri, :body, :headers, :username, :password
+    attr_reader :http_request, :uri, :body, :headers, :username, :password, :follow_redirects, 
+                :follow_redirects_limit, :follow_redirects_count, :timeout
+    # Valid tuples for the options are:
+    # :username => String, defaults to nil
+    # :password => String, defaults to nil
+    # :follow_redirects => Boolean, defaults to true for Get, false for anything else
+    # :follow_redirects_limit =>  Integer, defaults to 5. This is the number of redirects 
+    #                             that Wrest will automatically follow before raising an 
+    #                             Wrest::Exceptions::AutoRedirectLimitExceeded exception.
+    #                             For example, if you set this to 1, the very first redirect
+    #                             will raise the exception.
+    # :follow_redirects_count =>  Integer, defaults to 0. This is a count of the hops made to
+    #                             get to this request and increases by one for every redirect 
+    #                             until the follow_redirects_limit is hit. You should never set
+    #                             this option yourself.
+    # :timeout => The period, in seconds, after which a Timeout::Error is raised 
+    #             in the event of a connection failing to open. Defaults to 60.
     def initialize(wrest_uri, http_request_klass, parameters = {}, body = nil, headers = {}, options = {})
       @uri = wrest_uri
       @headers = headers.stringify_keys
       @http_request = http_request_klass.new(parameters.empty? ? wrest_uri.full_path : "#{wrest_uri.full_path}?#{parameters.to_query}", @headers)
       @body = body
-      @options = options
-      @username = options[:username]
-      @password = options[:password]
+      @options = options.clone
+      @username = @options[:username]
+      @password = @options[:password]
+      @follow_redirects = (@options[:follow_redirects] ||= false)
+      @follow_redirects_count = (@options[:follow_redirects_count] ||= 0)
+      @follow_redirects_limit = (@options[:follow_redirects_limit] ||= 5)
+      @timeout = (@options[:timeout] ||= 60)
     end
 
     # Makes a request and returns a Wrest::Http::Response. 
@@ -26,23 +49,24 @@ module Wrest::Http
       response = nil
 
       prefix = "#{http_request.method} #{http_request.hash}"
-      http_request.basic_auth username, password
+      http_connection = create_connection(timeout)
+      http_request.basic_auth username, password      
 
       Wrest.logger.debug "--> (#{prefix}) #{@uri.protocol}://#{@uri.host}:#{@uri.port}#{@http_request.path}"
-      time = Benchmark.realtime { response = Wrest::Http::Response.new( http.request(@http_request, @body) ) }
+      time = Benchmark.realtime { response = Wrest::Http::Response.new( http_connection.request(@http_request, @body) ) }
       Wrest.logger.debug "<-- (#{prefix}) %d %s (%d bytes %.2fs)" % [response.code, response.message, response.body ? response.body.length : 0, time]
 
-      response
+      @follow_redirects ? response.follow(@options) : response
     end
 
-    private
-    def http
-      http = Net::HTTP.new(@uri.host, @uri.port)
+    def create_connection(timeout)
+      connection = Net::HTTP.new(@uri.host, @uri.port)
+      connection.read_timeout = timeout
       if @uri.https?
-        http.use_ssl     = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        connection.use_ssl     = true
+        connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
       end
-      http
+      connection
     end
   end
 end

data/lib/wrest/http/response.rb

@@ -24,6 +24,14 @@ module Wrest #:nodoc:
               :[], :content_length, :content_type, :each_header, :each_name, :each_value, :fetch,
               :get_fields, :key?, :type_params
 
+      # We're overriding :new to act as a factory so 
+      # we can build the appropriate Response instance
+      def self.new(http_response)
+        instance = ((300..399).include?(http_response.code.to_i) ? Wrest::Http::Redirection : self).allocate
+        instance.send :initialize, http_response
+        instance
+      end
+              
       def initialize(http_response)
         @http_response = http_response
       end
@@ -39,6 +47,15 @@ module Wrest #:nodoc:
       def headers
         @http_response.to_hash
       end
+      
+      # A null object implementation - invoking this method on
+      # a response simply returns the same response unless
+      # the response is a Redirection (code 3xx), in which case a 
+      # get is invoked on the url stored in the response headers
+      # under the key 'location' and the new Response is returned.
+      def follow(redirect_request_options = {})
+        self
+      end
     end
   end
 end

data/lib/wrest/resource/base.rb

@@ -12,7 +12,6 @@ module Wrest::Resource #:nodoc:
   # It is a REST client targetted at Rails REST apps.
   class Base
     include Wrest::Components::AttributesContainer
-    include Wrest::Components::AttributesContainer::Typecaster
 
     always_has      :id
     typecast        :id => as_integer
@@ -43,7 +42,7 @@ module Wrest::Resource #:nodoc:
       # we often do while writing tests.
       # By default, the resource name is set to the name of the class.
       def set_resource_name(resource_name)
-        self.class_eval "def self.resource_name; '#{resource_name.underscore}';end"
+        self.class_eval "def self.resource_name; '#{resource_name.to_s.underscore}';end"
       end
 
       # Allows the host url at which the resource is found to be configured

data/lib/wrest/uri.rb

@@ -23,6 +23,8 @@ module Wrest #:nodoc:
   # You can find examples that use real APIs (like delicious) under the wrest/examples directory.
   class Uri
     attr_reader :uri, :username, :password
+    
+    # See Wrest::Http::Request for the available options and their default values.
     def initialize(uri_string, options = {})
       @options = options
       @uri_string = uri_string.clone

data/lib/wrest/version.rb

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

data/spec/functional/sample_rails_app/README

@@ -0,0 +1,3 @@
+== Wrest's Sample Rails App
+
+This dummy application is what Wrest's live functional tests run against. RESTful behaviour is supported by the {resource_full}[http://github.com/bguthrie/resource_full] plugin (see vendor/plugins inside the sample app).

data/spec/functional/sample_rails_app/Rakefile

@@ -0,0 +1,10 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require(File.join(File.dirname(__FILE__), 'config', 'boot'))
+
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+
+require 'tasks/rails'

data/spec/functional/sample_rails_app/app/controllers/application_controller.rb

@@ -0,0 +1,10 @@
+# Filters added to this controller apply to all controllers in the application.
+# Likewise, all the methods added will be available for all controllers.
+
+class ApplicationController < ActionController::Base
+  helper :all # include all helpers, all the time
+  # protect_from_forgery # See ActionController::RequestForgeryProtection for details
+  # session :off
+  # Scrub sensitive parameters from your log
+  # filter_parameter_logging :password
+end

data/spec/functional/sample_rails_app/app/controllers/lead_bottles_controller.rb

@@ -0,0 +1,7 @@
+class LeadBottlesController < ResourceFull::Base
+  queryable_with :name, :fuzzy => true
+  
+
+  responds_to :xml
+  responds_to :json
+end

data/spec/functional/sample_rails_app/app/helpers/application_helper.rb

@@ -0,0 +1,3 @@
+# Methods added to this helper will be available to all templates in the application.
+module ApplicationHelper
+end

data/spec/functional/sample_rails_app/app/models/bottle.rb

@@ -0,0 +1,3 @@
+class Bottle < ActiveRecord::Base
+end
+  

data/spec/functional/sample_rails_app/app/models/glass_bottle.rb

@@ -0,0 +1,3 @@
+class GlassBottle < Bottle
+end
+  

data/spec/functional/sample_rails_app/app/models/lead_bottle.rb

@@ -0,0 +1,3 @@
+class LeadBottle < Bottle
+end
+  

data/spec/functional/sample_rails_app/config/boot.rb

@@ -0,0 +1,110 @@
+# Don't change this file!
+# Configure your app in config/environment.rb and config/environments/*.rb
+
+RAILS_ROOT = "#{File.dirname(__FILE__)}/.." unless defined?(RAILS_ROOT)
+
+module Rails
+  class << self
+    def boot!
+      unless booted?
+        preinitialize
+        pick_boot.run
+      end
+    end
+
+    def booted?
+      defined? Rails::Initializer
+    end
+
+    def pick_boot
+      (vendor_rails? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_rails?
+      File.exist?("#{RAILS_ROOT}/vendor/rails")
+    end
+
+    def preinitialize
+      load(preinitializer_path) if File.exist?(preinitializer_path)
+    end
+
+    def preinitializer_path
+      "#{RAILS_ROOT}/config/preinitializer.rb"
+    end
+  end
+
+  class Boot
+    def run
+      load_initializer
+      Rails::Initializer.run(:set_load_path)
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_initializer
+      require "#{RAILS_ROOT}/vendor/rails/railties/lib/initializer"
+      Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_initializer
+      self.class.load_rubygems
+      load_rails_gem
+      require 'initializer'
+    end
+
+    def load_rails_gem
+      if version = self.class.gem_version
+        gem 'rails', version
+      else
+        gem 'rails'
+      end
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(Missing the Rails #{version} gem. Please `gem install -v=#{version} rails`, update your RAILS_GEM_VERSION setting in config/environment.rb for the Rails version you do have installed, or comment out RAILS_GEM_VERSION to use the latest version installed.)
+      exit 1
+    end
+
+    class << self
+      def rubygems_version
+        Gem::RubyGemsVersion rescue nil
+      end
+
+      def gem_version
+        if defined? RAILS_GEM_VERSION
+          RAILS_GEM_VERSION
+        elsif ENV.include?('RAILS_GEM_VERSION')
+          ENV['RAILS_GEM_VERSION']
+        else
+          parse_gem_version(read_environment_rb)
+        end
+      end
+
+      def load_rubygems
+        require 'rubygems'
+        min_version = '1.3.1'
+        unless rubygems_version >= min_version
+          $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
+          exit 1
+        end
+
+      rescue LoadError
+        $stderr.puts %Q(Rails requires RubyGems >= #{min_version}. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+        exit 1
+      end
+
+      def parse_gem_version(text)
+        $1 if text =~ /^[^#]*RAILS_GEM_VERSION\s*=\s*["']([!~<>=]*\s*[\d.]+)["']/
+      end
+
+      private
+        def read_environment_rb
+          File.read("#{RAILS_ROOT}/config/environment.rb")
+        end
+    end
+  end
+end
+
+# All that for this:
+Rails.boot!