wrest 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb64013e477c67348f9d540e039f2b473bdcd74b
-  data.tar.gz: fc87882ddf3f179b67b8cb1a29857c766f946f44
+  metadata.gz: 387bf7a48ff0337789fb3efefc9d7ba43d5e3610
+  data.tar.gz: cc9eafb4f54b2269975be55e5ed2e00c05319ffe
 SHA512:
-  metadata.gz: bb7689e3c04a4bd87a743d8f8e613bf4256af9137c6dc27b757930958ff838c54603292c393fcf16d6034b48c254af74076ce08c8fc9ab11e8c6fcc3b6f57b02
-  data.tar.gz: 8b967f2f73f24ad24453a6cfec637c413c4df064ee5952e39ac84d4baa6a3df175e63d77d7faf3462bfb42577405625209aa54ea2473d05307fc300e9e194624
+  metadata.gz: 6c91d9d500c5173755a2714d6db85d1b0e6fb02bba70031d39dd019869e11fc8a19210de1ddadd00d43e402b3e684f734d69d7ad09668aa70cecc68e4e2c3748
+  data.tar.gz: ae1f2a1df23dfd81a3432d04dc1dea3a2f82c945ef04fb93b1d04a0567fb26bf8262edc45bc44041b9089449ab19a8fcbf372a658be8b2eb1148fa96dfcf1c5f

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.5.2
+ * Updated dependencies - ActiveSupport, MultipartPost, Dalli and JRuby OpenSSL
+ 
 == 1.5.1
  * Supports Ruby 2.x.x, JRuby 1.7.6 (and higher), JRuby 9.0.0.0.pre2
 

data/{README.rdoc → README.md}

@@ -1,58 +1,70 @@
-= Wrest 1.5.1
+[![Build Status](https://travis-ci.org/c42/wrest.svg?branch=master)](https://travis-ci.org/c42/wrest)
 
-(c) Copyright 2009-2011 {Sidu Ponnappa}[http://blog.sidu.in]. All Rights Reserved.
+# Wrest 1.5.1
 
-{CI Status:}[http://ci.c42.in/projects/wrest] http://ci.c42.in/projects/wrest.png
+(c) Copyright 2009-2011 [Sidu Ponnappa](http://blog.sidu.in). All Rights Reserved.
 
 Wrest is a ruby REST/HTTP client library which
 
 * Allows you to use Net::HTTP or libCurl
-* Allows you to pick your Ruby: use 2.x.x, JRuby 1.7.6 (and higher), JRuby 9.0.0.0.pre2 ({Continuous Integration server}[http://ci.c42.in])
-* Supports RFC 2616 based {caching}[https://github.com/kaiwren/wrest/blob/caching/Caching.markdown]
-* [Alpha] Allows you to go async: use Threads or EventMachine
+* Allows you to pick your Ruby: use 2.x.x, JRuby 1.7.6 (and higher), JRuby 9.0.0.0.pre2 ([Continuous Integration server](http://ci.c42.in))
+* Supports RFC 2616 based [caching](https://github.com/kaiwren/wrest/blob/caching/Caching.markdown)
+* **_Alpha_**
+
+      Allows you to go async: use Threads or EventMachine
+
 * Allows you to quickly build object oriented wrappers around any web service
 * Is designed to be used as a library, not just a command line REST client (fewer class/static methods, more object oriented)
 * 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
 * Provides convenient HTTP wrappers, redirect handling, serialisation, deserialisation and xpath based lookup
 
-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, please subscribe to my [twitter feed](http://twitter.com/ponnappa).
 
-== Examples
+##Examples
 
 For Facebook, Twitter, Delicious, GitHub and other API examples, see http://github.com/kaiwren/wrest/tree/master/examples
 
-=== Basic Http Calls
+### Basic Http Calls
 
-==== GET
+#### GET
 
 * Basic API calls
 
+    ```
     'http://twitter.com/statuses/public_timeline.json'.to_uri.get.deserialise  # works with json and xml out of the box
 
     'http://twitter.com/statuses/public_timeline.xml'.to_uri.get.deserialise   # see lib/wrest/components/translators to add other formats
+    ```
 
 * Timeout support
 
+    ```
     'http://twitter.com/statuses/public_timeline.json'.to_uri.get(:timeout => 5).body
+    ```
 
 * Redirect support
 
+    ```
     'http://google.com'.to_uri(:follow_redirects => false).get
 
     'http://google.com'.to_uri(:follow_redirects_limit => 1).get
+    ```
 
   :follow_redirects_limit defaults to 5 if not specified.
 
 * Deserialise with XPath filtering
 
+    ```
     ActiveSupport::XmlMini.backend = 'REXML'
 
     'http://twitter.com/statuses/public_timeline.xml'.to_uri.get.deserialise(
                                                   :xpath => '//user/name/text()'
                                                 )
+    ```
 
 * More complex request with parameters and a custom deserialiser
 
+    ```
     'http://search.yahooapis.com/NewsSearchService/V1/newsSearch'.to_uri.get(
                   :appid  => 'YahooDemo',
                   :output => 'xml',
@@ -62,18 +74,26 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
                 ).deserialise_using(
                   Wrest::Components::Translators::Xml
                 )
+    ```
+
 * Basic HTTP auth and URI extensions using Wrest::Uri#[]
 
+    ```
     base_uri = 'https://api.del.icio.us/v1'.to_uri(:username => 'kaiwren', :password => 'fupupp1es')
     bookmarks = base_uri['/posts/get'].get.deserialise
+    ```
 
-==== POST
+#### POST
 
 * Regular, vanilla Post with a body and headers
 
+    ```
     'http://my.api.com'.to_uri.post('YAML encoded body', 'Content-Type' => 'text/x-yaml')
+    ```
+
 * Form encoded post
 
+    ```
     'https://api.del.icio.us/v1/posts/add'.to_uri(
              :username => 'kaiwren', :password => 'fupupp1es'
           ).post_form(
@@ -82,69 +102,86 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
              :extended => "All posts tagged with 'ruby'",
              :tags => 'ruby hacking'
           )
+    ```
+
 * Multipart posts
 
+    ```
    'http://imgur.com/api/upload.xml'.to_uri.post_multipart(
      :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
+# DELETE
 
 To delete a resource:
 
+```
  'https://api.del.icio.us/v1/posts/delete'.to_uri(
                                               :username => 'kaiwren',
                                               :password => 'fupupp1es'
                                             ).delete(
                                               :url => 'http://c2.com'
                                             )
+```
 
-=== Caching
+### Caching
 
 Wrest supports caching with pluggable back-ends.
 
+```
     Wrest::Caching.default_to_hash!     # Hash should NEVER be used in a production environment. It is unbounded and will keep increasing in size.
     c42 = "http://c42.in".to_uri.get
+```
 
-A Memcached based caching back-end is available in Wrest. You can get instructions on how to install Memcached on your system {here}[http://code.google.com/p/memcached/wiki/NewInstallFromPackage].
+A Memcached based caching back-end is available in Wrest. You can get instructions on how to install Memcached on your system [here](http://code.google.com/p/memcached/wiki/NewInstallFromPackage).
 The Dalli gem is used by Wrest to interface with Memcached. Install dalli using 'gem install dalli'.
 
 Use the following method to enable caching for all requests, and set Memcached as the default back-end.
 
+```
     Wrest::Caching.default_to_memcached!
+```
 
 For fine-grained control over the cache store (or to use multiple cache stores in the same codebase), you can use this API:
 
+```
     r1 = "http://c42.in".to_uri.using_memcached.get
     r2 = "http://c42.in".to_uri.using_hash.get
+```
 
-A detailed writeup regarding caching as defined by RFC 2616, and how Wrest implements caching is at {Wrest Caching Doc}[https://github.com/kaiwren/wrest/blob/master/Caching.markdown]
+A detailed writeup regarding caching as defined by RFC 2616, and how Wrest implements caching is at [Wrest Caching Doc](https://github.com/kaiwren/wrest/blob/master/Caching.markdown)
 
 You can create your own back-ends for Wrest caching by implementing the interface implemented in https://github.com/kaiwren/wrest/blob/master/lib/wrest/components/cache_store/memcached.rb
 
 To explicitly disable caching for specific requests:
 
+```
     "http://c42.in".to_uri.disable_cache.get
+```
 
-=== Callbacks
+### Callbacks
 
-==== Uri level callbacks
+#### Uri level callbacks
 
 You can define a set of callbacks that are invoked based on the http codes of the responses to any requests on a given uri.
 
+```
   "http://google.com".to_uri(:callback => {
               200      => lambda {|response| Wrest.logger.info "Ok." },
               400..499 => lambda {|response| Wrest.logger.error "Invalid. #{response.body}"},
               300..302 => lambda {|response| Wrest.logger.debug "Redirected. #{response.message}" }
             }).get
+```
 
-==== Per request callbacks
+#### Per request callbacks
 
 You can also define callbacks that are invoked based on the http code of the response to a particular request.
 
+```
   "http://google.com".to_uri.get do |callback|
     callback.on_ok do |response|
       Wrest.logger.info "Ok."
@@ -158,16 +195,18 @@ You can also define callbacks that are invoked based on the http code of the res
       Wrest.logger.info "Successful."
     end
   end
+```
 
 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
 
 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.
 
 Asynchronous requests support pluggable backends. The default backend used for asynchronous requests is ruby threads.
 
+```
   "http://c42.in".to_uri.get_async do |callback|
     callback.on_ok do |response|
       Wrest.logger.info "Ok."
@@ -175,29 +214,35 @@ Asynchronous requests support pluggable backends. The default backend used for a
   end
 
   sleep 1 # Causes thread created by get_async to execute
+```
 
 You can change the default to eventmachine.
 
+```
   Wrest::AsyncRequest.default_to_em!
+```
 
 You can also override the default on Uri objects.
 
+```
   "http://c42.in".to_uri.using_em.get_async do |callback|
     callback.on_ok do |response|
       Wrest.logger.info "Ok."
     end
   end
+```
 
 Note: The current implementation of asynchronous requests is currently in alpha and should not be used in production.
 
-=== Other useful stuff
+### Other useful stuff
 
-==== Hash container with ActiveResource-like semantics
+#### 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:
 
+```
  class Demon
    include Wrest::Components::Container
 
@@ -214,75 +259,97 @@ Example:
  kai_wren.chi      # => #<Chi:0x113af8c @count="1024">
  kai_wren.energy   # => #<Chi:0x113af8c @count="1024">
  kai_wren.teacher  # => 'Viss'
+```
+
+#### Opt-out of core extensions
 
-==== Opt-out of core extensions
+Uncomfortable with extending `String` to add `to_uri`? Simply do
 
-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.
+```
+
+in your Gemfile. You can now do `Uri.new('http://localhost')` to build Uris.
 
-=== Logging
+### 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 = Rails.logger
+```
 
-=== Json Backend
+### 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.
+For more information, look up the [multi_json](http://github.com/intridea/multi_json) documentation.
 
-=== Build
+### Build
 
-Standard options are available and can be listed using <tt>rake -T</tt>. Use rake:rcov for coverage and rake:rdoc to generate documentation. The link to the continuous integration build is over at the C42 Engineering {open source}[http://c42.in/open_source] page.
+Standard options are available and can be listed using `rake -T`. Use rake:rcov for coverage and rake:rdoc to generate documentation. The link to the continuous integration build is over at the C42 Engineering [open source](http://c42.in/open_source) page.
 
-== Documentation
+## Documentation
 
 Wrest RDocs can be found at http://wrest.rubyforge.org
 
-== Roadmap
+## Roadmap
 
-Features that are planned, in progress or already implemented are documented in the {CHANGELOG}[http://github.com/kaiwren/wrest/tree/master/CHANGELOG] starting from version 0.0.8.
+Features that are planned, in progress or already implemented are documented in the [CHANGELOG](http://github.com/kaiwren/wrest/tree/master/CHANGELOG) starting from version 0.0.8.
 
-== Installation
+## Installation
 
 The source is available at git://github.com/kaiwren/wrest.git
 
-To install the Wrest gem, do <tt>(sudo) gem install wrest</tt>.
+To install the Wrest gem, do `(sudo) gem install wrest`.
 
 Wrest is currently available as a gem for for Ruby and JRuby.
 
-=== Shell
+### Shell
+
+You can launch the interactive Wrest shell by running bin/wrest if you have the source or invoking `wrest` from your prompt if you've installed the gem.
 
-You can launch the interactive Wrest shell by running bin/wrest if you have the source or invoking <tt>wrest</tt> from your prompt if you've installed the gem.
+```
   $ wrest
   >> y 'http://twitter.com/statuses/public_timeline.json'.to_uri(:timeout => 5).get.deserialise
+```
 
-=== Testing
+### Testing
 
 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
+
+```
   /usr/local/bin/memcached
+```
 
 Run the tests in a different terminal:
 
+```
   # Run the normal test suite.
   rake
 
   # Runs the functional test suite.
   rake rspec:functional
-
-== Contributors
-
-* Sidu Ponnappa : {kaiwren}[http://github.com/kaiwren]
-* Niranjan Paranjape : {achamian}[http://github.com/achamian]
-* Aakash Dharmadhkari : {aakashd}[http://github.com/aakashd]
-* Srushti : {srushti}[http://github.com/srushti]
-* Preethi Ramdev : {preethiramdev}[http://github.com/preethiramdev]
-* Nikhil Vallishayee : {nikhilvallishayee}[http://github.com/nikhilvallishayee]
-* Jacques Crocker : {railsjedi}[http://github.com/railsjedi]
-* Jasim A Basheer: {jasim}[http://github.com/jasim]
-* Arvind Laxminarayan: {ardsrk}[http://github.com/ardsrk]
+```
+
+## Contributors
+
+* Sidu Ponnappa : [kaiwren](http://github.com/kaiwren)
+* Niranjan Paranjape : [achamian](http://github.com/achamian)
+* Aakash Dharmadhkari : [aakashd](http://github.com/aakashd)
+* Srushti : [srushti](http://github.com/srushti)
+* Preethi Ramdev : [preethiramdev](http://github.com/preethiramdev)
+* Nikhil Vallishayee : [nikhilvallishayee](http://github.com/nikhilvallishayee)
+* Jacques Crocker : [railsjedi](http://github.com/railsjedi)
+* Jasim A Basheer: [jasim](http://github.com/jasim)
+* Arvind Laxminarayan: [ardsrk](http://github.com/ardsrk)

data/lib/wrest.rb

@@ -23,9 +23,9 @@ require 'active_support/core_ext/object'
 
 module Wrest
   Root = File.dirname(__FILE__)
-  
+
   $:.unshift Root
-  
+
   def self.logger=(logger)
     @logger = logger
   end
@@ -50,7 +50,7 @@ module Wrest
   end
 end
 
-Wrest.logger = ActiveSupport::BufferedLogger.new(STDOUT)
+Wrest.logger = ActiveSupport::Logger.new(STDOUT)
 Wrest.logger.level = Logger::DEBUG
 
 require "wrest/core_ext/string"

data/lib/wrest/caching/memcached.rb

@@ -1,7 +1,7 @@
 begin
-  gem 'dalli', '~> 1.0.1'
+  gem 'dalli', '~> 2'
 rescue Gem::LoadError => e
-  Wrest.logger.debug "Dalli ~> 1.0.1 not found. Dalli is necessary to use the memcached caching back-end. To install dalli run `(sudo) gem install dalli`."
+  Wrest.logger.debug "Dalli ~> 2 not found. Dalli is necessary to use the memcached caching back-end. To install dalli run `(sudo) gem install dalli`."
   raise e
 end
 

data/lib/wrest/multipart.rb

@@ -8,9 +8,9 @@
 # See the License for the specific language governing permissions and limitations under the License.
 
 begin
-  gem 'multipart-post', '~> 1.0'
+  gem 'multipart-post', '~> 2.0'
 rescue Gem::LoadError => e
-  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'"
+  Wrest.logger.debug "Multipart Post ~> 2.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
 

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.5.1"
+  VERSION = "1.5.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrest
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Sidu Ponnappa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-23 00:00:00.000000000 Z
+date: 2015-07-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubyforge
@@ -73,14 +73,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '4'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
@@ -118,11 +118,11 @@ executables:
 - wrest
 extensions: []
 extra_rdoc_files:
-- README.rdoc
+- README.md
 files:
 - CHANGELOG
 - LICENCE
-- README.rdoc
+- README.md
 - bin/wrest
 - bin/wrest_shell.rb
 - lib/wrest.rb
@@ -230,3 +230,4 @@ specification_version: 4
 summary: Wrest is a fluent, object oriented HTTP client library for 2.x.x, JRuby 1.7.6
   (and higher), JRuby 9.0.0.0.pre2.
 test_files: []
+has_rdoc: