wrest 1.4.2-universal-java-1.6 → 1.5.0-universal-java-1.6

data/CHANGELOG

@@ -2,6 +2,25 @@ 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.5.0
+ * Introducing content type text/plain - pull request by buchin
+
+== 1.4.7
+ * Switch to using multi_json to manage Json backend to play nice with Rails 3.1.
+
+== 1.4.6
+ * Bump Builder dependency to allow both Builder 2.x and 3.x to be used
+
+== 1.4.5
+ * GH#107 alias :deserialize :deserialise
+
+== 1.4.4
+ * GH#105 Reduce Rubgems version requirements to 1.3.x or greater from > 1.5
+ 
+== 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,6 +1,8 @@
-= Wrest 1.4.2
+= Wrest 1.5.0
 
-(c) Copyright 2009-2011 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
+(c) Copyright 2009-2011 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved. 
+
+{CI Status:}[http://ci.c42.in/projects/wrest] http://ci.c42.in/projects/wrest.png
 
 Wrest is a ruby REST/HTTP client library which
 
@@ -58,7 +60,7 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
                   :results=> '3',
                   :start  => '1'
                 ).deserialise_using(
-                  Wrest::Translators::Xml
+                  Wrest::Components::Translators::Xml
                 )
 * Basic HTTP auth and URI extensions using Wrest::Uri#[]
   
@@ -86,6 +88,8 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
      :image => UploadIO.new(File.open(file_path), "image/png", file_path), 
      :key => imgur_key
     ).deserialise
+    
+Note: To enable Multipart support, you'll have to explicitly require 'wrest/multipart', which depends on the multipart-post gem.
 
 ==== DELETE
 
@@ -188,6 +192,8 @@ Note: The current implementation of asynchronous requests is currently in alpha
 
 === Other useful stuff
 
+==== Hash container with ActiveResource-like semantics
+
 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.
 
 Example:
@@ -209,10 +215,23 @@ Example:
  kai_wren.energy   # => #<Chi:0x113af8c @count="1024">
  kai_wren.teacher  # => 'Viss'
 
+==== Opt-out of core extensions
+
+Uncomfortable with extending <tt>String</tt> to add <tt>to_uri</tt>? Simply do
+ gem "wrest", :require => "wrest_no_ext"
+in your Gemfile. You can now do <tt>Uri.new('http://localhost')</tt> to build Uris.
+
 === 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
+
+=== Json Backend
+
+Wrest uses the multi_json gem to manage Json backends, allowing it to play nice with Rails 3.1. To change the backend used, you can do the following:
+  MultiJson.engine = :json_gem
+  
+For more information, look up the {multi_json}[http://github.com/intridea/multi_json] documentation.
 
 === Build
 
@@ -242,7 +261,7 @@ You can launch the interactive Wrest shell by running bin/wrest if you have the
 
 === Testing
 
-Start the Sinatra test server for functional test.
+Start the Sinatra test server for functional test. The dependencies for the test app are managed separately by a Gemfile under spec/sample_app.
   rake -f spec/sample_app/Rakefile  # runs on port 3000
 
 Start a memcached daemon/process on port 11211

data/bin/rdoc

@@ -0,0 +1,16 @@
+#!/usr/bin/env jruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rdoc' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rdoc', 'rdoc')

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/async_request.rb

@@ -12,7 +12,7 @@ module Wrest
   module AsyncRequest
     # Loads Wrest eventmachine backend alongwith eventmachine gem
     def self.enable_em
-      require "#{Wrest::Root}/wrest/async_request/event_machine_backend"
+      require "wrest/async_request/event_machine_backend"
     end
 
     # Assign default backend to be used for asynchronous request. Default is to use threads

data/lib/wrest/caching.rb

@@ -11,7 +11,7 @@ module Wrest
   module Caching
     # Loads the Memcached caching back-end and the Dalli gem 
     def self.enable_memcached
-      require "#{Wrest::Root}/wrest/caching/memcached"
+      require "wrest/caching/memcached"
     end
 
     # Configures Wrest to cache all requests. This will use a Ruby Hash.

data/lib/wrest/components/container.rb

@@ -12,8 +12,8 @@ module Wrest
   end
 end
 
-require "#{Wrest::Root}/wrest/components/container/typecaster"
-require "#{Wrest::Root}/wrest/components/container/alias_accessors"
+require "wrest/components/container/typecaster"
+require "wrest/components/container/alias_accessors"
 
 module Wrest::Components
 

data/lib/wrest/components/mutators.rb

@@ -32,9 +32,9 @@ module Wrest
     end
   end
 end
-require "#{Wrest::Root}/wrest/core_ext/hash"
-require "#{Wrest::Root}/wrest/components/mutators/base"
-require "#{Wrest::Root}/wrest/components/mutators/xml_simple_type_caster"
-require "#{Wrest::Root}/wrest/components/mutators/xml_mini_type_caster"
-require "#{Wrest::Root}/wrest/components/mutators/camel_to_snake_case"
+require "wrest/core_ext/hash"
+require "wrest/components/mutators/base"
+require "wrest/components/mutators/xml_simple_type_caster"
+require "wrest/components/mutators/xml_mini_type_caster"
+require "wrest/components/mutators/camel_to_snake_case"
 

data/lib/wrest/components/translators/content_types.rb

@@ -14,7 +14,8 @@ module Wrest
       'application/xml' => Wrest::Components::Translators::Xml,
       'text/xml' => Wrest::Components::Translators::Xml,
       'application/json' => Wrest::Components::Translators::Json,
-      'text/javascript' => Wrest::Components::Translators::Json
+      'text/javascript' => Wrest::Components::Translators::Json,
+      'text/plain' => Wrest::Components::Translators::Txt
     }
   end
 end

data/lib/wrest/components/translators/json.rb

@@ -13,13 +13,21 @@ module Wrest
     module Translators::Json
       extend self
 
-      def deserialise(response,options = {})
+      def deserialise(response, options = {})
         ActiveSupport::JSON.decode(response.body)
       end
 
+      def deserialize(response, options = {})
+        deserialise(response, options)
+      end
+      
       def serialise(hash, options = {})
         hash.to_json(options)
       end
+      
+      def serialize(hash, options = {})
+        serialise(hash, options)
+      end
     end
   end
 end

data/lib/wrest/components/translators/txt.rb

@@ -0,0 +1,31 @@
+# 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 Components::Translators
+    module Txt
+      extend self
+
+      def deserialise(response,options={})
+        response.body
+      end
+
+      def deserialize(response, options = {})
+        deserialise(response, options)
+      end
+
+      def serialise(hash, options = {})
+        hash.inspect
+      end
+      
+      def serialize(hash, options = {})
+        serialise(hash, options)
+      end
+    end
+  end
+end

data/lib/wrest/components/translators/xml.rb

@@ -19,9 +19,17 @@ module Wrest
         end
       end
 
+      def deserialize(response, options = {})
+        deserialise(response, options)
+      end
+
       def serialise(hash, options = {})
         hash.to_xml(options)
       end
+      
+      def serialize(hash, options = {})
+        serialise(hash, options)
+      end
     end
   end
 end

data/lib/wrest/components/translators.rb

@@ -23,6 +23,7 @@ module Wrest
   end
 end
 
-require "#{Wrest::Root}/wrest/components/translators/xml"
-require "#{Wrest::Root}/wrest/components/translators/json"
-require "#{Wrest::Root}/wrest/components/translators/content_types"
+require "wrest/components/translators/txt"
+require "wrest/components/translators/xml"
+require "wrest/components/translators/json"
+require "wrest/components/translators/content_types"

data/lib/wrest/components.rb

@@ -15,5 +15,5 @@ module Wrest
   end
 end
 
-require "#{Wrest::Root}/wrest/components/container"
-require "#{Wrest::Root}/wrest/components/translators"
+require "wrest/components/container"
+require "wrest/components/translators"

data/lib/wrest/core_ext/hash.rb

@@ -1,4 +1,4 @@
-require "#{Wrest::Root}/wrest/core_ext/hash/conversions"
+require "wrest/core_ext/hash/conversions"
 
 class Hash #:nodoc:
   include Wrest::CoreExt::Hash::Conversions

data/lib/wrest/core_ext/string.rb

@@ -1,4 +1,4 @@
-require "#{Wrest::Root}/wrest/core_ext/string/conversions"
+require "wrest/core_ext/string/conversions"
 
 class String #:nodoc:
   include Wrest::CoreExt::String::Conversions unless Wrest.const_defined?('NoStringExtensions')

data/lib/wrest/curl/response.rb

@@ -37,12 +37,20 @@ module Wrest #:nodoc:
       end
 
       def deserialise(options = {})
-          @deserialised_body ||= deserialise_using(Wrest::Components::Translators.lookup(content_type),options)
+        @deserialised_body ||= deserialise_using(Wrest::Components::Translators.lookup(content_type),options)
       end
-
-      def deserialise_using(translator,options={})
+      
+      def deserialize(options = {})
+        deserialise(options)
+      end
+      
+      def deserialise_using(translator, options={})
         translator.deserialise(@http_response,options)
       end
+
+      def deserialize_using(options = {})
+        deserialise_using(options)
+      end
       
       def code
         @http_response.status

data/lib/wrest/curl.rb

@@ -8,9 +8,9 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 begin
-  gem 'patron', '~> 0.4.11'
+  gem 'patron', '~> 0.4'
 rescue Gem::LoadError => e
-  Wrest.logger.debug "Patron ~> 0.4.11 not found. Patron is necessary to use libcurl. To install Patron run `sudo gem install patron` (patron is not available on JRuby, but you shouldn't need it anyway)."
+  Wrest.logger.debug "Patron ~> 0.4.x not found. Patron is necessary to use libcurl. To install Patron run `sudo gem install patron` (patron is not available on JRuby, but you shouldn't need it anyway)."
   raise e
 end
 require 'patron'
@@ -39,13 +39,13 @@ module Patron #:nodoc:
   end
 end
 
-require "#{Wrest::Root}/wrest/curl/response"
-require "#{Wrest::Root}/wrest/curl/request"
-require "#{Wrest::Root}/wrest/curl/get"
-require "#{Wrest::Root}/wrest/curl/put"
-require "#{Wrest::Root}/wrest/curl/post"
-require "#{Wrest::Root}/wrest/curl/delete"
-require "#{Wrest::Root}/wrest/curl/options"
-require "#{Wrest::Root}/wrest/curl/post_multipart"
-require "#{Wrest::Root}/wrest/curl/put_multipart"
-# require "#{Wrest::Root}/wrest/curl/session"
+require "wrest/curl/response"
+require "wrest/curl/request"
+require "wrest/curl/get"
+require "wrest/curl/put"
+require "wrest/curl/post"
+require "wrest/curl/delete"
+require "wrest/curl/options"
+require "wrest/curl/post_multipart"
+require "wrest/curl/put_multipart"
+# require "wrest/curl/session"

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/http_shared/standard_tokens.rb

@@ -13,6 +13,7 @@ module Wrest
       Close = 'close'
       KeepAlive = 'keep-alive'
       FormEncoded = 'application/x-www-form-urlencoded'
+      ApplicationXml = 'application/xml'
     end
   end
 end

data/lib/wrest/http_shared.rb

@@ -14,9 +14,9 @@ module Wrest
   end
 end
 
-require "#{Wrest::Root}/wrest/http_shared/headers"
-require "#{Wrest::Root}/wrest/http_shared/standard_headers"
-require "#{Wrest::Root}/wrest/http_shared/standard_tokens"
+require "wrest/http_shared/headers"
+require "wrest/http_shared/standard_headers"
+require "wrest/http_shared/standard_tokens"
 
 # Set up a shorter convenience API for constants
 Wrest::H = Wrest::HttpShared::StandardHeaders

data/lib/wrest/multipart.rb

@@ -50,7 +50,6 @@ module Wrest
     # This implementation of asynchronous post_multipart is currently in alpha. Hence, it should not be used in production.
     def post_multipart_async(parameters = {}, headers = {}, &block)
       (@options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend).execute(Http::PostMultipart.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options))
-      nil
     end
     
     # Makes a multipart/form-data encoded PUT request to this URI. This is a convenience API
@@ -66,7 +65,6 @@ module Wrest
     # This implementation of asynchronous put_multipart is currently in alpha. Hence, it should not be used in production.
     def put_multipart_async(parameters = {}, headers = {}, &block)
       (@options[:asynchronous_backend] || Wrest::AsyncRequest.default_backend).execute(Http::PutMultipart.new(self, parameters, headers, block ? @options.merge(:callback_block => block) : @options))
-      nil
     end
   end
   

data/lib/wrest/native/response.rb

@@ -74,13 +74,21 @@ module Wrest #:nodoc:
 
 
       def deserialise(options = {})
-          @deserialised_body ||= deserialise_using(Wrest::Components::Translators.lookup(@http_response.content_type),options)
+        @deserialised_body ||= deserialise_using(Wrest::Components::Translators.lookup(@http_response.content_type),options)
+      end
+
+      def deserialize(options = {})
+        deserialise(options)
       end
 
       def deserialise_using(translator,options = {})
         translator.deserialise(@http_response,options)
       end
 
+      def deserialize_using(options = {})
+        deserialise_using(options)
+      end
+
       # Gives a hash of the response headers. The keys of the hash are case-insensitive.
       def headers
         return @headers if @headers

data/lib/wrest/native.rb

@@ -18,16 +18,16 @@ module Wrest
   end
 end
 
-require "#{Wrest::Root}/wrest/native/connection_factory"
-require "#{Wrest::Root}/wrest/native/response"
-require "#{Wrest::Root}/wrest/native/redirection"
-require "#{Wrest::Root}/wrest/native/request"
-require "#{Wrest::Root}/wrest/native/get"
-require "#{Wrest::Root}/wrest/native/put"
-require "#{Wrest::Root}/wrest/native/post"
-require "#{Wrest::Root}/wrest/native/delete"
-require "#{Wrest::Root}/wrest/native/options"
-require "#{Wrest::Root}/wrest/native/session"
+require "wrest/native/connection_factory"
+require "wrest/native/response"
+require "wrest/native/redirection"
+require "wrest/native/request"
+require "wrest/native/get"
+require "wrest/native/put"
+require "wrest/native/post"
+require "wrest/native/delete"
+require "wrest/native/options"
+require "wrest/native/session"
 
 # default to using Native libs
 Wrest::Http = Wrest::Native

data/lib/wrest/test.rb

@@ -1 +1 @@
-require "#{Wrest::Root}/wrest/test/request_patches"
+require "wrest/test/request_patches"

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