wrest 0.1.0 → 0.1.1

data/CHANGELOG

@@ -7,11 +7,15 @@ Features under a numbered section are complete and available in the Wrest gem.
 == Coming soon
  * Cookie support
  * Proxy support
+ * Multi-part post support on curl
  
 == In progress
  * 304/ETag response caching
  * Keep-alive support for libcurl
 
+== Current
+ * Multipart post and put using Net::Http
+
 == 0.1.0
  * Added Nokogiri as a fallback for LibXML Ruby before we give up and use REXML. (Nokogiri is available on JRuby, unlike LibXML-ruby)
  * Added code to attempt to load JREXML (for what it's worth) when using REXML on JRuby

data/README.rdoc

@@ -1,13 +1,13 @@
-= Wrest 0.1.0
+= Wrest 0.1.1
 
 (c) Copyright 2009 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
 
 Wrest is a ruby REST client library which
 * allows allows you to quickly build object oriented wrappers around any web service 
 * is spec driven, strongly favours immutable objects and avoids class methods and setters making it better suited for use as a library, especially in multi-threaded environments 
-* runs on Ruby 1.8, 1.9 and JRuby, with MacRuy and IronRuby support on the way
+* runs on Ruby 1.8, 1.9 and JRuby, with MacRuby and IronRuby support on the way
 
-To receive notifications whenever new features are added to Wrest, please subscribe to my {twitter feed}[http://twitter.com/ponnappa].
+To receive notifications whenever new features are added to Wrest, pleasesubscribe to my {twitter feed}[http://twitter.com/ponnappa].
 
 (If you were wondering why the words 'demon', 'chi' and 'fu-puppies' show up in nearly every example and spec, it's because they're all references to {Roger Zelazny's}[http://en.wikipedia.org/wiki/Roger_Zelazny] last book, 'Lord Demon.')
 
@@ -44,12 +44,12 @@ You can launch the interactive Wrest shell by running bin/wrest if you have the
   require 'rubygems'
   require 'wrest'
   y "http://search.yahooapis.com/NewsSearchService/V1/newsSearch".to_uri.get(
-									:appid  => 'YahooDemo', 
-									:output => 'xml',
-									:query  => 'India',
-									:results=> '3',
-									:start  => '1'
-								)
+                  :appid  => 'YahooDemo', 
+                  :output => 'xml',
+                  :query  => 'India',
+                  :results=> '3',
+                  :start  => '1'
+                )
 === Usage: Basic Http Calls
 
 ==== GET
@@ -64,16 +64,16 @@ A couple of ways to get Yahoo news as a hash map.
  require 'wrest'
  include Wrest::Components
  y "http://search.yahooapis.com/NewsSearchService/V1/newsSearch".to_uri.get(
-									:appid  => 'YahooDemo', 
-									:output => 'xml',
-									:query  => 'India',
-									:results=> '3',
-									:start  => '1'
-								).deserialise_using(
-									Translators::Xml
-								).mutate_using(
-									Mutators::XmlMiniTypeCaster.new
-								)
+                  :appid  => 'YahooDemo', 
+                  :output => 'xml',
+                  :query  => 'India',
+                  :results=> '3',
+                  :start  => '1'
+                ).deserialise_using(
+                  Translators::Xml
+                ).mutate_using(
+                  Mutators::XmlMiniTypeCaster.new
+                )
 
 ==== DELETE
 
@@ -101,7 +101,7 @@ Allows any class to hold an attributes hash, somewhat like ActiveResource. It al
 Example:
 
  class Demon
-   include Wrest::Components::AttributesContainer
+   include Wrest::Components::Container
 
    always_has       :id
    typecast         :age          =>  as_integer,
@@ -119,7 +119,7 @@ Example:
 
 === Usage: Logging
 
-The Wrest logger can be set and accessed through Wrest.logger and is configured by default to log to STDOUT. If you're using Wrest in a Rails application, you can configure logging by placing the following line in your environment file:
+The Wrest logger can be set and accessed through Wrest.logger and is configured by default to log to STDOUT. If you're using Wrest in a Rails application, you can configure logging by adding a config/initializers/wrest.rb file with the following contents :
   Wrest.logger = ActiveRecord::Base.logger
 
 === Build
@@ -163,6 +163,7 @@ If you're looking for help doing this on Rails on the server side, take a look a
 * json (json-jruby on JRuby)
 * active_support
 * ruby-libxml or Nokogiri (Wrest tries ruby-libxml first, then nokogiri, and will finally fall back on REXML; be aware that Wrest uses ActiveSupport::XmlMini, so if you're using Wrest as a plugin in a Rails application, all xml parsing across the application will switch to using libxml if it's available. You're free to change this by hand by using the ActiveSupport::XmlMini.backend= method.)
+* multipart-post (needed only if multipart support is enabled)
 
 === Build
   
@@ -176,4 +177,5 @@ Features that are planned, in progress or already implemented are documented in
 
 == Licence
 
-Wrest is released under the Apache 2.0 licence
+Wrest is released under the Apache 2.0 licence
+

data/Rakefile

@@ -36,7 +36,7 @@ namespace :spec do
     task.spec_opts = ['--options', 'spec/spec.opts']
   end
   
-  desc "Run unit all specs"
+  desc "Run all live functional specs"
   Spec::Rake::SpecTask.new(:functional) do |task|
     task.spec_files = FileList['spec/functional/wrest/**/*_spec.rb']
     task.spec_opts = ['--options', 'spec/spec.opts']

data/VERSION.yml

@@ -1,4 +1,4 @@
 --- 
-:patch: 0
+:patch: 1
 :minor: 1
 :major: 0

data/examples/aws_simpledb.rb

@@ -0,0 +1,60 @@
+# 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.expand_path(File.dirname(__FILE__) + "/../lib/wrest")
+require 'pp'
+require 'openssl'
+require 'time'
+require "base64"
+
+Wrest.logger = Logger.new(STDOUT)
+Wrest.logger.level = Logger::DEBUG  # Set this to Logger::INFO or higher to disable request logging
+
+# AWS SDB API Reference
+# http://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/index.html?SDB_API.html
+
+module SimpleDB
+  Config = {
+    :aws_access_key_id => 'AKIAJOTOWFTQ6FRQIZZA',
+    :aws_secret_access_key => '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'
+  }
+  Uri = "https://sdb.amazonaws.com".to_uri
+  Digest  = OpenSSL::Digest::Digest.new('sha1')
+  
+  extend self
+  def invoke(action)
+    options = {
+      'Action' => action,
+      'AWSAccessKeyId' => SimpleDB::Config[:aws_access_key_id],
+      'DomainName' => 'LEDev',
+      'SignatureVersion' => '2',
+      'SignatureMethod' => 'HmacSHA256',
+      'Timestamp' => Time.now.iso8601,
+      'Version' => '2009-04-15'
+    }
+    Uri.get(options.merge('Signature' => signature_for(options)))
+  end
+  
+  # http://docs.amazonwebservices.com/AmazonSimpleDB/latest/DeveloperGuide/index.html?REST_RESTAuth.html
+  def signature_for(options)
+    data = [
+      "GET",
+      "sdb.amazonaws.com",
+      options.keys.sort.map{|k| "#{k}=#{CGI::escape(options[k])}"}.join('&')
+    ].join("\n")
+    CGI::escape(Base64.encode64(OpenSSL::HMAC.digest(Digest, Config[:aws_secret_access_key], data)))
+  end
+  
+  def list_domains
+    invoke('ListDomains').body
+  end
+end
+
+
+pp SimpleDB.list_domains

data/lib/wrest.rb

@@ -20,8 +20,11 @@ require 'benchmark'
 require 'active_support'
 
 
-module Wrest  #:nodoc:
+module Wrest
   Root = File.dirname(__FILE__)
+  
+  $:.unshift Root
+  
   def self.logger=(logger)
     @logger = logger
   end
@@ -30,10 +33,12 @@ module Wrest  #:nodoc:
     @logger
   end
 
+  # Switch Wrest to using Net::HTTP.
   def self.use_native
     silence_warnings{ Wrest.const_set('Http', Wrest::Native) }
   end
 
+  # Switch Wrest to using libcurl.
   def self.use_curl
     require "#{Wrest::Root}/wrest/curl"
     silence_warnings{ Wrest.const_set('Http', Wrest::Curl) }
@@ -68,13 +73,13 @@ end
 Dir["#{File.expand_path(File.dirname(__FILE__))}/wrest/core_ext/*.rb"].each { |file| require file }
 
 # Load Wrest Core
+require "#{Wrest::Root}/wrest/version"
 require "#{Wrest::Root}/wrest/http_shared"
 require "#{Wrest::Root}/wrest/native"
 
 # Load Wrest Wrappers
 require "#{Wrest::Root}/wrest/uri"
 require "#{Wrest::Root}/wrest/uri_template"
-require "#{Wrest::Root}/wrest/version"
 require "#{Wrest::Root}/wrest/exceptions"
 require "#{Wrest::Root}/wrest/components"
 

data/lib/wrest/curl.rb

@@ -15,8 +15,7 @@ rescue Gem::LoadError => e
 end
 require 'patron'
 
-module Wrest #:nodoc:
-
+module Wrest
   # Contains all HTTP protocol related classes such as
   # Get, Post, Request, Response etc. and uses Curl for
   # better performance, but works only on CRuby and only on a *nix OS.
@@ -33,7 +32,8 @@ module Wrest #:nodoc:
   end
 end
 
-module Patron
+module Patron #:nodoc:
+  # Patching Patron::Session#handle_request to make it public.
   class Session
     public :handle_request
   end

data/lib/wrest/curl/request.rb

@@ -7,89 +7,91 @@
 # 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::Curl
-  # 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, :follow_redirects,
-    :follow_redirects_limit, :timeout, :connection, :parameters, :auth_type
-    # 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.
-    # :timeout => The period, in seconds, after which a Timeout::Error is raised
-    #             in the event of a connection failing to open. Defaulted to 60 by Uri#create_connection.
-    # :connection => The HTTP Connection object to use. This is how a keep-alive connection can be
-    #             used for multiple requests. Not yet fully implemented for Curl.
-    #
-    # Curl specific options:
-    # :auth_type => This is a curl specific option and can be one of :basic, :digest, or :any. The default is :basic.
-    def initialize(wrest_uri, http_verb, parameters = {}, body = nil, headers = {}, options = {})
-      @uri = wrest_uri
-      @headers = headers.stringify_keys
-      @parameters = parameters      
-      @body = body
-            
-      @options = options.clone
-      @auth_type = @options[:auth_type] || :basic      
-      @username = @options[:username]
-      @password = @options[:password]
-      @follow_redirects = (@options[:follow_redirects] ||= false)
+module Wrest
+  module Curl
+    # 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::Curl::Get etc. instead.
+    class Request
+      attr_reader :http_request, :uri, :body, :headers, :username, :password, :follow_redirects,
+      :follow_redirects_limit, :timeout, :connection, :parameters, :auth_type
+      # 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.
+      #   :timeout => The period, in seconds, after which a Timeout::Error is raised
+      #               in the event of a connection failing to open. Defaulted to 60 by Uri#create_connection.
+      #   :connection => The HTTP Connection object to use. This is how a keep-alive connection can be
+      #                  used for multiple requests. Not yet fully implemented for Curl.
+      #
+      # Curl specific options:
+      #   :auth_type => This is a curl specific option and can be one of :basic, :digest, or :any. The default is :basic.
+      def initialize(wrest_uri, http_verb, parameters = {}, body = nil, headers = {}, options = {})
+        @uri = wrest_uri
+        @headers = headers.stringify_keys
+        @parameters = parameters
+        @body = body
 
-      @follow_redirects_limit = (@options[:follow_redirects_limit] ||= 5)
-      @timeout = @options[:timeout] || 60
-      @connection = @options[:connection]
-      
-      @http_request = Patron::Request.new
-      @http_request.action = http_verb
-      @http_request.upload_data = body
-      @http_request.headers = headers
-      @http_request.username = username
-      @http_request.password = password
-      @http_request.auth_type = auth_type
-      @http_request.url = parameters.empty? ? uri.to_s : "#{uri.to_s}?#{parameters.to_query}"
-      @http_request.max_redirects = follow_redirects_limit if follow_redirects
-      @http_request.timeout = @timeout
-    end
+        @options = options.clone
+        @auth_type = @options[:auth_type] || :basic
+        @username = @options[:username]
+        @password = @options[:password]
+        @follow_redirects = (@options[:follow_redirects] ||= false)
+
+        @follow_redirects_limit = (@options[:follow_redirects_limit] ||= 5)
+        @timeout = @options[:timeout] || 60
+        @connection = @options[:connection]
+
+        @http_request = Patron::Request.new
+        @http_request.action = http_verb
+        @http_request.upload_data = body
+        @http_request.headers = headers
+        @http_request.username = username
+        @http_request.password = password
+        @http_request.auth_type = auth_type
+        @http_request.url = parameters.empty? ? uri.to_s : "#{uri.to_s}?#{parameters.to_query}"
+        @http_request.max_redirects = follow_redirects_limit if follow_redirects
+        @http_request.timeout = @timeout
+      end
+
+      # Makes a request and returns a Wrest::Http::Response.
+      # Data about the request is and logged to Wrest.logger
+      # The log entry contains the following information:
+      #
+      #   --> indicates a request
+      #   <-- indicates a response
+      #
+      # The type of request is mentioned in caps, followed by a hash
+      # uniquely uniquely identifying a particular request/response pair.
+      # In a multi-process or multi-threaded scenario, this can be used
+      # to identify request-response pairs.
+      #
+      # The request hash is followed by a connection hash; requests using the
+      # same connection (effectively a keep-alive connection) will have the
+      # same connection hash.
+      #
+      # This is followed by the response code, the payload size and the time taken.
+      def invoke
+        response = nil
 
-    # Makes a request and returns a Wrest::Http::Response.
-    # Data about the request is and logged to Wrest.logger
-    # The log entry contains the following information:
-    #
-    # --> indicates a request
-    # <-- indicates a response
-    #
-    # The type of request is mentioned in caps, followed by a hash
-    # uniquely uniquely identifying a particular request/response pair.
-    # In a multi-process or multi-threaded scenario, this can be used
-    # to identify request-response pairs.
-    #
-    # The request hash is followed by a connection hash; requests using the
-    # same connection (effectively a keep-alive connection) will have the
-    # same connection hash.
-    #
-    # This is followed by the response code, the payload size and the time taken.
-    def invoke
-      response = nil
+        @connection ||= Patron::Session.new
+        raise ArgumentError, "Empty URL" if http_request.url.empty?
 
-      @connection ||= Patron::Session.new
-      raise ArgumentError, "Empty URL" if http_request.url.empty?      
+        prefix = "#{http_request.action.to_s.upcase} #{http_request.hash} #{connection.hash}"
 
-      prefix = "#{http_request.action.to_s.upcase} #{http_request.hash} #{connection.hash}"
+        Wrest.logger.debug "--> (#{prefix}) #{http_request.url}"
+        time = Benchmark.realtime { response =  Wrest::Curl::Response.new(connection.handle_request(http_request))}
+        Wrest.logger.debug "<-- (#{prefix}) %s (%d bytes %.2fs)" % [response.message, response.body ? response.body.length : 0, time]
 
-      Wrest.logger.debug "--> (#{prefix}) #{http_request.url}"
-      time = Benchmark.realtime { response =  Wrest::Curl::Response.new(connection.handle_request(http_request))}
-      Wrest.logger.debug "<-- (#{prefix}) %s (%d bytes %.2fs)" % [response.message, response.body ? response.body.length : 0, time]
-      
-      response
+        response
       rescue Patron::TimeoutError => e
         raise Wrest::Exceptions::Timeout.new(e)
+      end
     end
   end
 end

data/lib/wrest/http_shared.rb

@@ -7,9 +7,8 @@
 # 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:
-  
-  # Contains functionality the is independent of
+module Wrest
+  # Contains functionality that is independent of
   # the underlying HTTP libs
   module HttpShared
   end

data/lib/wrest/http_shared/standard_headers.rb

@@ -7,8 +7,8 @@
 # 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 HttpShared #:nodoc:
+module Wrest
+  module HttpShared
     module StandardHeaders
       Connection = 'connection'
       ContentType = 'content-type'

data/lib/wrest/http_shared/standard_tokens.rb

@@ -7,8 +7,8 @@
 # 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 HttpShared #:nodoc:
+module Wrest
+  module HttpShared
     module StandardTokens
       Close = 'close'
       KeepAlive = 'keep-alive'

data/lib/wrest/multipart.rb

@@ -0,0 +1,52 @@
+# Copyright 2009 - 2010 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.
+
+begin
+  gem 'multipart-post', '>= 1.0'
+rescue Gem::LoadError
+  Wrest.logger.debug "Multipart Post >= 1.0 not found. Multipart Post is necessary to be able to post multipart. To install Multipart Post run `sudo gem install multipart-post`"
+  raise e
+end
+
+require "wrest/native/post_multipart"
+require "wrest/native/put_multipart"
+
+module Wrest
+  # To enable Multipart support, use
+  #  require 'wrest/multipart'
+  #
+  # Multipart support is currently only available on Net::Http and not when using libcurl.
+  # It depends on the multipart-post gem being available. To install multipart-post
+  #   (sudo) gem install multipart-post
+  #
+  # The methods in this module are mixed into Wrest::Uri.
+  module Multipart
+    # Makes a multipart/form-data encoded POST request to this URI. This is a convenience API
+    # that mimics a multipart form being posted; some allegly RESTful APIs like FCBK require 
+    # this for file uploads.
+    #
+    #   File.open('/path/to/image.jpg') do |file|
+    #     'http://localhost:3000/uploads'.to_uri.post_multipart('file' => UploadIO.new(file, "image/jpg", '/path/to/image.jpg'))
+    #   end
+    def post_multipart(parameters = {}, headers = {})
+      Http::PostMultipart.new(self, parameters, headers, @options).invoke
+    end
+    
+    # Makes a multipart/form-data encoded PUT request to this URI. This is a convenience API
+    # that mimics a multipart form being put. I sincerely hope you never need to use this.
+    def put_multipart(parameters = {}, headers = {})
+      Http::PutMultipart.new(self, parameters, headers, @options).invoke
+    end
+  end
+  
+  class Uri
+    include Multipart
+  end
+end
+

data/lib/wrest/native.rb

@@ -7,11 +7,12 @@
 # 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 Wrest
   # Contains all native protocol related classes such as
   # Get, Post, Request, Response etc. and uses the native
-  # Ruby Net::native libraries.
+  # Ruby Net::HTTP libraries.
+  #
+  # Wrest::Http points to this module by default.
   module Native
     include Wrest::HttpShared
   end

data/lib/wrest/native/post_multipart.rb

@@ -0,0 +1,32 @@
+# Copyright 2009 - 2010 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 'net/http/post/multipart'
+
+module Wrest::Native
+  class PostMultipart < Request
+    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+      super(
+        wrest_uri,
+        Net::HTTP::Post::Multipart,
+        parameters,
+        nil,
+        headers,
+        options
+      )
+    end
+    
+    def build_request(request_klass, uri, parameters, headers)
+      request_klass.new(uri.full_path, parameters, headers)
+    end
+
+    def do_request
+      @connection.request(@http_request)
+    end
+  end
+end

data/lib/wrest/native/put_multipart.rb

@@ -0,0 +1,32 @@
+# Copyright 2009 - 2010 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 'net/http/post/multipart'
+
+module Wrest::Native
+  class PutMultipart < Request
+    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
+      super(
+        wrest_uri,
+        Net::HTTP::Put::Multipart,
+        parameters,
+        nil,
+        headers,
+        options
+      )
+    end
+    
+    def build_request(request_klass, uri, parameters, headers)
+      request_klass.new(uri.full_path, parameters, headers)
+    end
+
+    def do_request
+      @connection.request(@http_request)
+    end
+  end
+end

data/lib/wrest/native/request.rb

@@ -10,32 +10,31 @@
 module Wrest::Native
   # 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.
+  # or Wrest::Native::Get etc. instead.
   class Request
     attr_reader :http_request, :uri, :body, :headers, :username, :password, :follow_redirects,
                 :follow_redirects_limit, :follow_redirects_count, :timeout, :connection, :parameters
     # 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. Defaulted to 60 by Uri#create_connection.
-    # :connection => The HTTP Connection object to use. This is how a keep-alive connection can be
-    #             used for multiple requests.
+    #   :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. Defaulted to 60 by Uri#create_connection.
+    #   :connection => The HTTP Connection object to use. This is how a keep-alive connection can be
+    #                  used for multiple requests.
     def initialize(wrest_uri, http_request_klass, parameters = {}, body = nil, headers = {}, options = {})
       @uri = wrest_uri
       @headers = headers.stringify_keys
       @parameters = parameters
-      @http_request = http_request_klass.new(parameters.empty? ? wrest_uri.full_path : "#{wrest_uri.full_path}?#{parameters.to_query}", @headers)
       @body = body
       @options = options.clone
       @username = @options[:username]
@@ -45,14 +44,15 @@ module Wrest::Native
       @follow_redirects_limit = (@options[:follow_redirects_limit] ||= 5)
       @timeout = @options[:timeout]
       @connection = @options[:connection]
+      @http_request = self.build_request(http_request_klass, @uri, @parameters, @headers)
     end
 
     # Makes a request and returns a Wrest::Native::Response. 
     # Data about the request is and logged to Wrest.logger
     # The log entry contains the following information:
     #
-    # --> indicates a request
-    # <-- indicates a response
+    #   --> indicates a request
+    #   <-- indicates a response
     #
     # The type of request is mentioned in caps, followed by a hash 
     # uniquely uniquely identifying a particular request/response pair.
@@ -73,12 +73,20 @@ module Wrest::Native
       prefix = "#{http_request.method} #{http_request.hash} #{@connection.hash}"
       
       Wrest.logger.debug "--> (#{prefix}) #{@uri.protocol}://#{@uri.host}:#{@uri.port}#{@http_request.path}"
-      time = Benchmark.realtime { response = Wrest::Native::Response.new( @connection.request(@http_request, @body) ) }
+      time = Benchmark.realtime { response = Wrest::Native::Response.new( do_request ) }
       Wrest.logger.debug "<-- (#{prefix}) %d %s (%d bytes %.2fs)" % [response.code, response.message, response.body ? response.body.length : 0, time]
 
       @follow_redirects ? response.follow(@options) : response
     rescue Timeout::Error => e
       raise Wrest::Exceptions::Timeout.new(e)
     end
+
+    def build_request(request_klass, uri, parameters, headers)
+      request_klass.new(parameters.empty? ? uri.full_path : "#{uri.full_path}?#{parameters.to_query}", headers)
+    end
+  
+    def do_request
+      @connection.request(@http_request, @body)
+    end
   end
 end

data/lib/wrest/uri.rb

@@ -104,8 +104,8 @@ module Wrest #:nodoc:
     end
     
     # Makes a POST request to this URI. This is a convenience API
-    # that mimics a form being posted; some allegly RESTful APIs like FCBK
-    # require this to be used.
+    # that mimics a form being posted; some allegly RESTful APIs like FCBK require 
+    # this.
     #
     # Form encoding involves munging the parameters into a string and placing them
     # in the body, as well as setting the Content-Type header to

data/lib/wrest/version.rb

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

data/wrest.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{wrest}
-  s.version = "0.1.0"
+  s.version = "0.1.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sidu Ponnappa"]
-  s.date = %q{2009-12-21}
+  s.date = %q{2010-04-22}
   s.description = %q{Wrest is a HTTP and REST client library which allows you to quickly build well encapsulated, object oriented wrappers around any web service.}
   s.email = %q{ckponnappa@gmail.com}
   s.executables = ["wrest", "jwrest"]
@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
      "bin/jwrest",
      "bin/wrest",
      "bin/wrest_shell.rb",
+     "examples/aws_simpledb.rb",
      "examples/delicious.rb",
      "examples/facebook.rb",
      "examples/keep_alive.rb",
@@ -64,13 +65,16 @@ Gem::Specification.new do |s|
      "lib/wrest/http_shared/headers.rb",
      "lib/wrest/http_shared/standard_headers.rb",
      "lib/wrest/http_shared/standard_tokens.rb",
+     "lib/wrest/multipart.rb",
      "lib/wrest/native.rb",
      "lib/wrest/native/connection_factory.rb",
      "lib/wrest/native/delete.rb",
      "lib/wrest/native/get.rb",
      "lib/wrest/native/options.rb",
      "lib/wrest/native/post.rb",
+     "lib/wrest/native/post_multipart.rb",
      "lib/wrest/native/put.rb",
+     "lib/wrest/native/put_multipart.rb",
      "lib/wrest/native/redirection.rb",
      "lib/wrest/native/request.rb",
      "lib/wrest/native/response.rb",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: wrest
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors: 
 - Sidu Ponnappa
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-21 00:00:00 +05:30
+date: 2010-04-22 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -49,6 +49,7 @@ files:
 - bin/jwrest
 - bin/wrest
 - bin/wrest_shell.rb
+- examples/aws_simpledb.rb
 - examples/delicious.rb
 - examples/facebook.rb
 - examples/keep_alive.rb
@@ -89,13 +90,16 @@ files:
 - lib/wrest/http_shared/headers.rb
 - lib/wrest/http_shared/standard_headers.rb
 - lib/wrest/http_shared/standard_tokens.rb
+- lib/wrest/multipart.rb
 - lib/wrest/native.rb
 - lib/wrest/native/connection_factory.rb
 - lib/wrest/native/delete.rb
 - lib/wrest/native/get.rb
 - lib/wrest/native/options.rb
 - lib/wrest/native/post.rb
+- lib/wrest/native/post_multipart.rb
 - lib/wrest/native/put.rb
+- lib/wrest/native/put_multipart.rb
 - lib/wrest/native/redirection.rb
 - lib/wrest/native/request.rb
 - lib/wrest/native/response.rb