wrest 1.4.2 → 1.4.3

data/CHANGELOG

@@ -2,6 +2,10 @@ 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.4.3
+ * GH#104 Allow default headers to be added to the uri that are then used for all requests
+ * GH#31 Add explicit API for cookies
+
 == 1.4.2
  * GH#102 Code and gemspec mismatch for json-jruby
 

data/README.rdoc

@@ -1,4 +1,4 @@
-= Wrest 1.4.2
+= Wrest 1.4.3
 
 (c) Copyright 2009-2011 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
 
@@ -212,7 +212,7 @@ Example:
 === 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 adding a config/initializers/wrest.rb file with the following contents :
-  Wrest.logger = ActiveRecord::Base.logger
+  Wrest.logger = Rails.logger
 
 === Build
 

data/lib/wrest.rb

@@ -79,6 +79,7 @@ Wrest::AsyncRequest.default_to_threads!
 require "#{Wrest::Root}/wrest/caching"
 
 # Load Wrest Wrappers
+require "#{Wrest::Root}/wrest/uri/builders"
 require "#{Wrest::Root}/wrest/uri"
 require "#{Wrest::Root}/wrest/uri_template"
 require "#{Wrest::Root}/wrest/exceptions"

data/lib/wrest/async_request/event_machine_backend.rb

@@ -19,9 +19,9 @@ require 'eventmachine'
 module Wrest
   module AsyncRequest
     class EventMachineBackend 
-      def execute(block)
+      def execute(request)
         EventMachine.run do
-          block.invoke
+          request.invoke
           EventMachine.stop
         end
       end

data/lib/wrest/async_request/thread_backend.rb

@@ -10,9 +10,9 @@
 module Wrest
   module AsyncRequest
     class ThreadBackend 
-      def execute(block)
+      def execute(request)
         Thread.new do
-          block.invoke
+          request.invoke
         end
       end
     end

data/lib/wrest/http_shared/standard_headers.rb

@@ -14,6 +14,7 @@ module Wrest
       ContentType = 'content-type'
       ContentLength = 'content-length'
       IfNoneMatch = 'if-none-match'
+      Cookie = 'cookie'
     end
   end
 end

data/lib/wrest/uri.rb

@@ -22,22 +22,38 @@ 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, :uri_string, :uri_path, :query 
-        
-    # See Wrest::Native::Request for the available options and their default values.
+    attr_reader :uri, :username, :password, :uri_string, :uri_path, :query, :default_headers
+    
+    # Valid tuples for the options are:
+    #   :asynchronous_backend => Can currently be set to either Wrest::AsyncRequest::EventMachineBackend.new
+    #                            or Wrest::AsyncRequest::ThreadBackend.new. Easier to do using Uri#using_em and
+    #                            Uri#using_threads.
+    #   :callback             => Accepts a hash where the keys are response codes or ranges of response codes and
+    #                            the values are the corresponding blocks that will be invoked should the response
+    #                            code match the key.
+    #   :default_headers      => Accepts a hash containing a set of default request headers with which the headers
+    #                            passed to Uri#get, Uri#post etc. are merged. Incoming headers will override the
+    #                            defaults if there are any clashes. Use this to set cookies or use OAuth2 Authorize
+    #                            headers. When extending or cloning a Uri, passing in a new set of default_headers
+    #                            will result in the old set being overridden.
+    # See Wrest::Native::Request for other available options and their default values.
     def initialize(uri_string, options = {})
-        @options = options.clone
-        @uri_string = uri_string.to_s
-        @uri = URI.parse(@uri_string)
-        uri_scheme = URI.split(@uri_string)
-        @uri_path = uri_scheme[-4].split('?').first || ''
-        @uri_path = (@uri_path.empty? ? '/' : @uri_path) 
-        @query = uri_scheme[-2] || ''
-        @username = (@options[:username] ||= @uri.user)
-        @password = (@options[:password] ||= @uri.password)
-        @options[:callback] = Callback.new(@options[:callback]) if @options[:callback]
+      @options = options.clone
+      @uri_string = uri_string.to_s
+      @uri = URI.parse(@uri_string)
+      uri_scheme = URI.split(@uri_string)
+      @uri_path = uri_scheme[-4].split('?').first || ''
+      @uri_path = (@uri_path.empty? ? '/' : @uri_path) 
+      @query = uri_scheme[-2] || ''
+      @username = (@options[:username] ||= @uri.user)
+      @password = (@options[:password] ||= @uri.password)
+      @asynchronous_backend = @options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend
+      @options[:callback] = Callback.new(@options[:callback]) if @options[:callback]
+      @default_headers = @options[:default_headers] || {}
     end 
     
+    # Builds a Wrest::UriTemplate by extending the current URI 
+    # with the pattern passed to it.
     def to_template(pattern)
       template_pattern = URI.join(uri_string,pattern).to_s
       UriTemplate.new(template_pattern, @options)
@@ -88,49 +104,39 @@ module Wrest #:nodoc:
       uri_string
     end
     
-    # Returns a Uri object that uses threads to perform asynchronous requests.
-    def using_threads
-      options = @options.clone
-      options[:asynchronous_backend] = Wrest::AsyncRequest::ThreadBackend.new
-      Uri.new(uri_string, options)
+    #:nodoc:
+    def build_get(parameters = {}, headers = {}, &block)
+      Http::Get.new(self, parameters, default_headers.merge(headers), block ? @options.merge(:callback_block => block) : @options)
     end
-
-    # Returns a Uri object that uses eventmachine to perform asynchronous requests.
-    def using_em
-      options = @options.clone
-      Wrest::AsyncRequest.enable_em
-      options[:asynchronous_backend] = Wrest::AsyncRequest::EventMachineBackend.new
-      Uri.new(uri_string, options)
+    
+    #:nodoc:
+    def build_put(body = '', headers = {}, parameters = {}, &block)
+      Http::Put.new(self, body.to_s, default_headers.merge(headers), parameters, block ? @options.merge(:callback_block => block) : @options)
     end
-
-    # Returns a Uri object that uses hash for caching responses.
-    def using_hash
-      options = @options.clone
-      options[:cache_store] = Hash.new
-      Uri.new(uri_string, options)
+    
+    #:nodoc:
+    def build_post(body = '', headers = {}, parameters = {}, &block)
+      Http::Post.new(self, body.to_s, default_headers.merge(headers), parameters, block ? @options.merge(:callback_block => block) : @options)
     end
 
-    # Returns a Uri object that uses memcached for caching responses.
-    def using_memcached
-      options = @options.clone
-      Wrest::Caching.enable_memcached
-      options[:cache_store] = Wrest::Caching::Memcached.new
-      Uri.new(uri_string, options)
+    #:nodoc:
+    def build_post_form(parameters ={}, headers = {}, &block)
+      headers = default_headers.merge(headers).merge(Wrest::H::ContentType => Wrest::T::FormEncoded)
+      body = parameters.to_query
+      Http::Post.new(self, body, headers, {}, block ? @options.merge(:callback_block => block) : @options)
     end
 
-    def disable_cache
-      options = @options.clone
-      Wrest::Caching.enable_memcached
-      options[:disable_cache] = true 
-      Uri.new(uri_string, options)
+    #:nodoc:
+    def build_delete(parameters = {}, headers = {}, &block)
+      Http::Delete.new(self, parameters, default_headers.merge(headers), block ? @options.merge(:callback_block => block) : @options)
     end
-
+    
     # Make a GET request to this URI. This is a convenience API
     # that creates a Wrest::Native::Get, executes it and returns a Wrest::Native::Response.
     #
     # Remember to escape all parameter strings if necessary, using URI.escape
     def get(parameters = {}, headers = {}, &block)
-      Http::Get.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options).invoke
+      build_get(parameters, headers, &block).invoke
     end
 
     # Make a GET request to this URI. This is a convenience API
@@ -141,7 +147,7 @@ module Wrest #:nodoc:
     # Note: get_async does not return a response and the response should be accessed through callbacks.
     # This implementation of asynchronous get is currently in alpha. Hence, it should not be used in production.
     def get_async(parameters = {}, headers = {}, &block)
-      (@options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend).execute(Http::Get.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options))
+      @asynchronous_backend.execute(build_get(parameters, headers, &block))
       nil
     end
 
@@ -150,7 +156,7 @@ module Wrest #:nodoc:
     #
     # Remember to escape all parameter strings if necessary, using URI.escape
     def put(body = '', headers = {}, parameters = {}, &block)
-      Http::Put.new(self, body.to_s, headers, parameters, block ? @options.merge(:callback_block => block) : @options).invoke
+      build_put(body, headers, parameters, &block).invoke
     end
 
     # Make a PUT request to this URI. This is a convenience API
@@ -161,7 +167,7 @@ module Wrest #:nodoc:
     # Note: put_async does not return a response and the response should be accessed through callbacks.
     # This implementation of asynchronous put is currently in alpha. Hence, it should not be used in production.
     def put_async(body = '', headers = {}, parameters = {}, &block)
-      (@options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend).execute(Http::Put.new(self, body.to_s, headers, parameters, block ? @options.merge(:callback_block => block) : @options))
+      @asynchronous_backend.execute(build_put(body, headers, parameters, &block))
       nil
     end
 
@@ -171,7 +177,7 @@ module Wrest #:nodoc:
     #
     # Remember to escape all parameter strings if necessary, using URI.escape
     def post(body = '', headers = {}, parameters = {}, &block)
-      Http::Post.new(self, body.to_s, headers, parameters, block ? @options.merge(:callback_block => block) : @options).invoke
+      build_post(body, headers, parameters, &block).invoke
     end
 
     # Makes a POST request to this URI. This is a convenience API
@@ -183,7 +189,7 @@ module Wrest #:nodoc:
     # Note: post_async does not return a response and the response should be accessed through callbacks.
     # This implementation of asynchronous post is currently in alpha. Hence, it should not be used in production.
     def post_async(body = '', headers = {}, parameters = {}, &block)
-      (@options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend).execute(Http::Post.new(self, body.to_s, headers, parameters, block ? @options.merge(:callback_block => block) : @options))
+      @asynchronous_backend.execute(build_post(body, headers, parameters, &block))
       nil
     end
     
@@ -195,9 +201,7 @@ module Wrest #:nodoc:
     # in the body, as well as setting the Content-Type header to
     # application/x-www-form-urlencoded
     def post_form(parameters = {}, headers = {}, &block)
-      headers = headers.merge(Wrest::H::ContentType => Wrest::T::FormEncoded)
-      body = parameters.to_query
-      Http::Post.new(self, body, headers, {}, block ? @options.merge(:callback_block => block) : @options).invoke
+      build_post_form(parameters, headers, &block).invoke
     end
 
     # Makes a POST request to this URI. This is a convenience API
@@ -211,9 +215,7 @@ module Wrest #:nodoc:
     # Note: post_form_async does not return a response and the response should be accessed through callbacks.
     # This implementation of asynchronous post_form is currently in alpha. Hence, it should not be used in production.
     def post_form_async(parameters = {}, headers = {}, &block)
-      headers = headers.merge(Wrest::H::ContentType => Wrest::T::FormEncoded)
-      body = parameters.to_query
-      (@options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend).execute(Http::Post.new(self, body, headers, {}, block ? @options.merge(:callback_block => block) : @options))
+      @asynchronous_backend.execute(build_post_form(parameters, headers, &block))
       nil
     end
 
@@ -222,7 +224,7 @@ module Wrest #:nodoc:
     #
     # Remember to escape all parameter strings if necessary, using URI.escape
     def delete(parameters = {}, headers = {}, &block)
-      Http::Delete.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options).invoke
+      build_delete(parameters, headers, &block).invoke
     end
 
     # Makes a DELETE request to this URI. This is a convenience API
@@ -233,7 +235,7 @@ module Wrest #:nodoc:
     # Note: delete_async does not return a response and the response should be accessed through callbacks.
     # This implementation of asynchronous delete is currently in alpha. Hence, it should not be used in production.
     def delete_async(parameters = {}, headers = {}, &block)
-      (@options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend).execute(Http::Delete.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options))
+      @asynchronous_backend.execute(build_delete(parameters, headers, &block))
       nil
     end
 
@@ -269,5 +271,6 @@ module Wrest #:nodoc:
     end
     
     include Http::ConnectionFactory
+    include Uri::Builders
   end
 end

data/lib/wrest/uri/builders.rb

@@ -0,0 +1,42 @@
+module Wrest
+  class Uri
+    # Contains methods that depend on Uri#clone to build
+    # new Uris configured in particular ways.
+    module Builders
+      # Returns a Uri object that uses threads to perform asynchronous requests.
+      def using_threads
+        clone(:asynchronous_backend => Wrest::AsyncRequest::ThreadBackend.new)
+      end
+
+      # Returns a Uri object that uses eventmachine to perform asynchronous requests.
+      # Remember to do Wrest::AsyncRequest.enable_em first so that 
+      # EventMachine is available for use.
+      def using_em
+        clone(:asynchronous_backend => Wrest::AsyncRequest::EventMachineBackend.new)
+      end
+
+      # Returns a Uri object that uses hash for caching responses.
+      def using_hash
+        clone(:cache_store => {})
+      end
+
+      # Returns a Uri object that uses memcached for caching responses.
+      # Remember to do Wrest::AsyncRequest.enable_memcached first so that 
+      # memcached is available for use.
+      def using_memcached
+        clone(:cache_store => Wrest::Caching::Memcached.new)
+      end
+
+      # Disables using the globally configured cache for GET requests 
+      # made using the Uri returned by this method.
+      def disable_cache
+        clone(:disable_cache => true)
+      end
+      
+      # Sets the specified string as the cookie for the Uri
+      def using_cookie(cookie_string)
+        clone(:default_headers => {Wrest::H::Cookie => cookie_string})
+      end
+    end
+  end
+end

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.4.2"
+  VERSION = "1.4.3"
 end

data/lib/wrest/xml_mini.rb

@@ -6,5 +6,3 @@ module ActiveSupport
     delegate :filter, :to => :backend
   end
 end
-
-

metadata

@@ -2,7 +2,7 @@
 name: wrest
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 1.4.2
+  version: 1.4.3
 platform: ruby
 authors: 
 - Sidu Ponnappa
@@ -11,7 +11,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-05 00:00:00 +05:30
+date: 2011-05-02 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -174,6 +174,7 @@ files:
 - lib/wrest/native.rb
 - lib/wrest/test/request_patches.rb
 - lib/wrest/test.rb
+- lib/wrest/uri/builders.rb
 - lib/wrest/uri.rb
 - lib/wrest/uri_template.rb
 - lib/wrest/version.rb