wrest 1.2.1 → 1.3.0

data/CHANGELOG

@@ -2,6 +2,9 @@ Features under the section marked 'Current' are completed but pending release as
 
 Features under a numbered section are complete and available in the Wrest gem.
 
+=== 1.3.0
+ * GH#95 Asynchronous requests on Wrest::Uri.
+
 == 1.2.1 
  * GH#91 Remove dependency on tzinfo
 

data/README.rdoc

@@ -1,4 +1,4 @@
-= Wrest 1.2.1
+= Wrest 1.3.0
 
 (c) Copyright 2009-2011 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
 
@@ -156,6 +156,17 @@ You can also define callbacks that are invoked based on the http code of the res
 
 Please note that Wrest is a synchronous library. All requests are blocking, and will not return till the request is completed and appropriate callbacks executed.
 
+=== Asynchronous requests
+
+Asynchronous requests are non-blocking. They do not return a response and the request is executed on a separate thread. The only way to access the response 
+while using asynchronous request is through callbacks. 
+
+  "http://www.google.com".to_uri.get_async do |callback|
+    callback.on_ok do |response|
+      Wrest.logger.info "Ok."
+    end
+  end
+
 === Other useful stuff
 
 Allows any class to hold an attributes hash, somewhat like ActiveResource. It also supports several extensions to this base fuctionality such as support for typecasting attribute values. See examples/twitter.rb and examples/wow_realm_status.rb for more samples.

data/lib/wrest/multipart.rb

@@ -37,12 +37,41 @@ module Wrest
     def post_multipart(parameters = {}, headers = {}, &block)
       Http::PostMultipart.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options).invoke
     end
+
+    # Makes a multipart/form-data encoded POST request to this URI. This is a convenience API
+    # that mimics a multipart form being posted; some allegedly 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_async('file' => UploadIO.new(file, "image/jpg", '/path/to/image.jpg'))
+    #   end
+    #
+    # Note: post_multipart_async does not return a response and the response should be accessed through callbacks
+    # This implementation of asynchronous post_multipart is very naive and should not be used in production.
+    # Stable implementation of asynchronous requests involving thread pools would be out soon.
+    def post_multipart_async(parameters = {}, headers = {}, &block)
+      Thread.new do
+        post_multipart(parameters, headers, &block)
+      end
+    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 = {}, &block)
       Http::PutMultipart.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @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.
+    #
+    # Note: put_multipart_async does not return a response and the response should be accessed through callbacks
+    # This implementation of asynchronous put_multipart is very naive and should not be used in production.
+    # Stable implementation of asynchronous requests involving thread pools would be out soon.
+    def put_multipart_async(parameters = {}, headers = {}, &block)
+      Thread.new do
+        put_multipart(parameters, headers, &block)
+      end
+    end
   end
   
   class Uri

data/lib/wrest/uri.rb

@@ -95,6 +95,20 @@ module Wrest #:nodoc:
       Http::Get.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options).invoke
     end
 
+    # Make a GET request to this URI. This is a convenience API
+    # that creates a Wrest::Native::Get.
+    # 
+    # Remember to escape all parameter strings if necessary, using URI.escape
+    #
+    # Note: get_async does not return a response and the response should be accessed through callbacks.
+    # This implementation of asynchronous get is very naive and should not be used in production.
+    # Stable implementation of asynchronous requests involving thread pools would be out soon.
+    def get_async(parameters = {}, headers = {}, &block)
+      Thread.new do
+        get(parameters, headers, &block)
+      end
+    end
+
     # Make a PUT request to this URI. This is a convenience API
     # that creates a Wrest::Native::Put, executes it and returns a Wrest::Native::Response.
     #
@@ -103,6 +117,20 @@ module Wrest #:nodoc:
       Http::Put.new(self, body.to_s, headers, parameters, block ? @options.merge(:callback_block => block) : @options).invoke
     end
 
+    # Make a PUT request to this URI. This is a convenience API
+    # that creates a Wrest::Native::Put.
+    #
+    # Remember to escape all parameter strings if necessary, using URI.escape
+    #
+    # Note: put_async does not return a response and the response should be accessed through callbacks.
+    # This implementation of asynchronous put is very naive and should not be used in production.
+    # Stable implementation of asynchronous requests involving thread pools would be out soon.
+    def put_async(body = '', headers = {}, parameters = {}, &block)
+      Thread.new do
+        put(body, headers, parameters, &block)
+      end
+    end
+
     # Makes a POST request to this URI. This is a convenience API
     # that creates a Wrest::Native::Post, executes it and returns a Wrest::Native::Response.
     # Note that sending an empty body will blow up if you're using libcurl.
@@ -111,6 +139,21 @@ module Wrest #:nodoc:
     def post(body = '', headers = {}, parameters = {}, &block)
       Http::Post.new(self, body.to_s, headers, parameters, block ? @options.merge(:callback_block => block) : @options).invoke
     end
+
+    # Makes a POST request to this URI. This is a convenience API
+    # that creates a Wrest::Native::Post.
+    # Note that sending an empty body will blow up if you're using libcurl.
+    #
+    # Remember to escape all parameter strings if necessary, using URI.escape
+    #
+    # Note: post_async does not return a response and the response should be accessed through callbacks.
+    # This implementation of asynchronous post is very naive and should not be used in production.
+    # Stable implementation of asynchronous requests involving thread pools would be out soon.
+    def post_async(body = '', headers = {}, parameters = {}, &block)
+      Thread.new do
+        post(body, headers, parameters, &block)
+      end
+    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 
@@ -125,6 +168,23 @@ module Wrest #:nodoc:
       Http::Post.new(self, body, headers, {}, block ? @options.merge(:callback_block => block) : @options).invoke
     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.
+    #
+    # Form encoding involves munging the parameters into a string and placing them
+    # in the body, as well as setting the Content-Type header to
+    # application/x-www-form-urlencoded
+    #
+    # Note: post_form_async does not return a response and the response should be accessed through callbacks.
+    # This implementation of asynchronous post_form is very naive and should not be used in production.
+    # Stable implementation of asynchronous requests involving thread pools would be out soon.
+    def post_form_async(parameters = {}, headers = {}, &block)
+      Thread.new do
+        post_form(parameters, headers, &block)
+      end
+    end
+
     # Makes a DELETE request to this URI. This is a convenience API
     # that creates a Wrest::Native::Delete, executes it and returns a Wrest::Native::Response.
     #
@@ -133,6 +193,20 @@ module Wrest #:nodoc:
       Http::Delete.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options).invoke
     end
 
+    # Makes a DELETE request to this URI. This is a convenience API
+    # that creates a Wrest::Native::Delete.
+    #
+    # Remember to escape all parameter strings if necessary, using URI.escape
+    #
+    # Note: delete_async does not return a response and the response should be accessed through callbacks.
+    # This implementation of asynchronous delete is very naive and should not be used in production.
+    # Stable implementation of asynchronous requests involving thread pools would be out soon.
+    def delete_async(parameters = {}, headers = {}, &block)
+      Thread.new do
+        delete(parameters, headers, &block)
+      end
+    end
+
     # Makes an OPTIONS request to this URI. This is a convenience API
     # that creates a Wrest::Native::Options, executes it and returns the Wrest::Native::Response.
     def options

data/lib/wrest/version.rb

@@ -8,5 +8,5 @@
 # See the License for the specific language governing permissions and limitations under the License. 
 
 module Wrest
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

metadata

@@ -2,7 +2,7 @@
 name: wrest
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors: 
 - Sidu Ponnappa
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-04 00:00:00 +05:30
+date: 2011-02-08 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency