wrest 1.5.4 → 2.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2ef12f85a25ae1566e9dc1b687a364d765f6a08
-  data.tar.gz: fb83d920f115473b271d16cad06195fb73524d00
+  metadata.gz: 71e16e78be5f22404a1639ad9166c893c35a40b2
+  data.tar.gz: 4713b8f3483fc1b80a48b4feac5802c7a991db63
 SHA512:
-  metadata.gz: a88c38044cafcad5a161e4fd974b8023600c830865f1734451a5e948720d647b828f73caeca7b89ef008b6f8c472c44e2a05cc8b4602458939280427dd7121ab
-  data.tar.gz: baff6d4f993a61763836866bd838b0517c802aaa1547593aeb07b92c5a599defa77a70db5616e2e3bdacec48b343c4c78f1513990e4bb1727d537d69f5a17688
+  metadata.gz: 04113e29601ed0953ca5c8f995f0771d15cc722c6712403dd31761ad1c9fea19adfe66b5e0aeb22e9c5edb567f16e5788f195a5b57a6e4b896d2042d0874786d
+  data.tar.gz: fad5508d9f0baee2ba934f6cfa7712f103b1d48c110ebe838423b61929dd09759965fdda4717a760f8f3b49e386eec2aa685795ec9f07ad1df681b900ab902d1

data/CHANGELOG

@@ -2,6 +2,12 @@ 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.
 
+== 2.1.1
+ * Including Redis as a Caching Backend
+
+== 2.0.0
+ * Removing support for libcurl
+
 == 1.5.4
  * Make thread pool configurable
 

data/README.md

@@ -1,12 +1,12 @@
 [![Build Status](https://travis-ci.org/c42/wrest.svg?branch=master)](https://travis-ci.org/c42/wrest)
 
-# Wrest 1.5.4
+# Wrest 2.1.0
 
 (c) Copyright 2009-2015 [Sidu Ponnappa](http://twitter.com/ponnappa). All Rights Reserved.
 
 Wrest is a ruby REST/HTTP client library which
 
-* Allows you to use Net::HTTP or libCurl
+* Allows you to use Net::HTTP
 * Allows you to pick your Ruby: use 2.x.x, JRuby 1.7.6 (and higher), JRuby 9.0.0.0.pre2
 * Supports RFC 2616 based [caching](https://github.com/kaiwren/wrest/blob/caching/Caching.markdown)
 * Async http calls using Threads (reliable only on JRuby) or EventMachine
@@ -19,7 +19,7 @@ To receive notifications whenever new features are added to Wrest, please subscr
 
 ##Examples
 
-For Facebook, Twitter, Delicious, GitHub and other API examples, see http://github.com/kaiwren/wrest/tree/master/examples
+For Facebook, Twitter, Delicious, GitHub and other API examples, see http://github.com/c42/wrest/tree/master/examples
 
 ### Basic Http Calls
 
@@ -63,13 +63,10 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
 * More complex request with parameters and a custom deserialiser
 
     ```
-    'http://search.yahooapis.com/NewsSearchService/V1/newsSearch'.to_uri.get(
-                  :appid  => 'YahooDemo',
-                  :output => 'xml',
-                  :query  => 'India',
-                  :results=> '3',
-                  :start  => '1'
-                ).deserialise_using(
+    'api.openweathermap.org/data/2.5/weather'.to_uri.get(
+                  :lat  => 35,
+                  :lon => 139
+                  ).deserialise_using(
                   Wrest::Components::Translators::Xml
                 )
     ```
@@ -113,7 +110,7 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
 
 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:
 
@@ -128,13 +125,29 @@ To delete a resource:
 
 ### Caching
 
-Wrest supports caching with pluggable back-ends.
+Wrest supports caching with the following pluggable back-ends:
+  - Hash
+  - Memcached
+  - Redis
+
+####Hash
+
+Use the following method to enable caching for all requests, and set Hash as the default cache store.
+Note: Hash should NEVER be used in a production environment. It is unbounded and will keep increasing in size.
 
 ```
-    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
+    Wrest::Caching.default_to_hash!
+    c42 = 'http://c42.in'.to_uri.get
 ```
 
+To use Hash as a cache store in an explicit request (without setting hash as default), use the following API:
+
+```
+    r1 = "http://c42.in".to_uri.using_hash.get
+```
+
+####Memcached
+
 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'.
 
@@ -144,16 +157,34 @@ Use the following method to enable caching for all requests, and set Memcached a
     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:
+To use Memcached as a cache store in an explicit request (without setting memcached as default), use the following API:
+
+```
+    Wrest::Caching.enable_memcached
+    r2 = "http://c42.in".to_uri.using_memcached.get
+```
+
+####Redis
+
+Wrest also supports a Redis based caching back-end. Follow the guide [here](http://redis.io/topics/quickstart) to install Redis in your system.
+It uses [redis-rd](https://github.com/redis/redis-rb) to interface with Redis. Install redis-rb using `gem install redis`.
+
+Use the following method to enable caching for all requests, and set Redis as the default back-end.
+
+```
+    Wrest::Caching.default_to_redis!
+```
+
+To use Redis as a cache store in an explicit request (without setting redis as default), use the following API:
 
 ```
-    r1 = "http://c42.in".to_uri.using_memcached.get
-    r2 = "http://c42.in".to_uri.using_hash.get
+    Wrest::Caching.enable_redis
+    r3 = "http://c42.in".to_uri.using_redis.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/c42/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
+You can create your own back-ends for Wrest caching by implementing the interface implemented in https://github.com/c42/wrest/blob/master/lib/wrest/caching/redis.rb
 
 To explicitly disable caching for specific requests:
 

data/lib/wrest.rb

@@ -42,12 +42,6 @@ module Wrest
   def self.use_native!
     silence_warnings{ Wrest.const_set('Http', Wrest::Native) }
   end
-
-  # Switch Wrest to using libcurl.
-  def self.use_curl!
-    require "wrest/curl"
-    silence_warnings{ Wrest.const_set('Http', Wrest::Curl) }
-  end
 end
 
 Wrest.logger = ActiveSupport::Logger.new(STDOUT)

data/lib/wrest/caching.rb

@@ -13,12 +13,17 @@ module Wrest
     def self.enable_memcached
       require "wrest/caching/memcached"
     end
+    
+    # Loads the Redis caching back-end and the Redis gem 
+    def self.enable_redis
+      require "wrest/caching/redis"
+    end
 
     # Configures Wrest to cache all requests. This will use a Ruby Hash.
-    # WARNING: This should NEVER be used in a real environment. The Hash will keep on growing since Wrest does not limit the size of a cache store.
+    # WARNING: This should NEVER be used in a real environment. The Hash will 
+    # keep growing since Wrest does not limit the size of a cache store.
     #
-    # Use the Memcached caching back-end for production since the Memcached process uses an LRU based cache removal policy
-    # that keeps the number of entries stored within bounds.
+    # Please switch to the memcached or redis back-end for production use.
     def self.default_to_hash!
       self.default_store = Hash.new
     end
@@ -28,6 +33,14 @@ module Wrest
       self.enable_memcached
       self.default_store = Wrest::Caching::Memcached.new 
     end
+    
+    # Default Wrest to using redis for caching requests.
+    # 
+    # Options to configuring the redis gem can be passed as arguments.
+    def self.default_to_redis!(redis_options = {})
+      self.enable_redis
+      self.default_store = Wrest::Caching::Redis.new(redis_options)
+    end
 
     # Assign the default cache store to be used. Default is none.
     def self.default_store=(store)

data/lib/wrest/caching/memcached.rb

@@ -1,7 +1,7 @@
 begin
   gem 'dalli', '~> 2'
 rescue Gem::LoadError => e
-  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`."
+  Wrest.logger.debug "Dalli ~> 2 not found. The Dalli gem is necessary to use the memcached caching back-end."
   raise e
 end
 

data/lib/wrest/caching/redis.rb

@@ -0,0 +1,37 @@
+begin
+  gem 'redis', '~> 3'
+rescue Gem::LoadError => e
+  Wrest.logger.debug "Redis ~> 3 not found. The Redis gem is necessary to use redis as a caching back-end."
+  raise e
+end
+
+require 'redis'
+require 'yaml'
+
+module Wrest::Caching
+  class Redis
+
+    def initialize(redis_options = {})
+      @redis = ::Redis.new(redis_options)
+    end
+
+    def [](key)
+      value = @redis.get(key)
+      unmarshalled_value = value.nil? ? nil : YAML::load(value)
+      unmarshalled_value
+    end
+
+    def []=(key, value)
+      marshalled_value = YAML::dump(value)
+      @redis.set(key, marshalled_value)
+    end
+
+    def delete(key)
+      value = self[key]
+      
+      @redis.del(key)
+
+      return value
+    end
+  end
+end

data/lib/wrest/multipart.rb

@@ -21,7 +21,7 @@ module Wrest
   # To enable Multipart support, use
   #  require 'wrest/multipart'
   #
-  # Multipart support is currently only available on Net::Http and not when using libcurl.
+  # Multipart support is currently only available on Net::Http
   # It depends on the multipart-post gem being available. To install multipart-post
   #   (sudo) gem install multipart-post
   #

data/lib/wrest/uri.rb

@@ -173,7 +173,6 @@ module Wrest #:nodoc:
 
     # 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.
     #
     # Remember to escape all parameter strings if necessary, using URI.escape
     def post(body = '', headers = {}, parameters = {}, &block)
@@ -182,8 +181,6 @@ module Wrest #:nodoc:
 
     # 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.

data/lib/wrest/uri/builders.rb

@@ -27,6 +27,10 @@ module Wrest
         clone(:cache_store => Wrest::Caching::Memcached.new)
       end
 
+      def using_redis
+        clone(:cache_store => Wrest::Caching::Redis.new)
+      end
+
       # Disables using the globally configured cache for GET requests 
       # made using the Uri returned by this method.
       def disable_cache

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.4"
+  VERSION = "2.1.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrest
 version: !ruby/object:Gem::Version
-  version: 1.5.4
+  version: 2.1.1
 platform: ruby
 authors:
 - Sidu Ponnappa
@@ -9,90 +9,90 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-05 00:00:00.000000000 Z
+date: 2015-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '3.3'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: metric_fu
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '4'
 - !ruby/object:Gem::Dependency
   name: builder
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">"
+    - - '>'
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.0'
 description: Wrest is a fluent, easy-to-use, object oriented Ruby HTTP/REST client
@@ -106,58 +106,43 @@ extensions: []
 extra_rdoc_files:
 - README.md
 files:
-- CHANGELOG
-- LICENCE
-- README.md
 - bin/wrest
 - bin/wrest_shell.rb
-- lib/wrest.rb
-- lib/wrest/async_request.rb
 - lib/wrest/async_request/event_machine_backend.rb
 - lib/wrest/async_request/thread_backend.rb
 - lib/wrest/async_request/thread_pool.rb
+- lib/wrest/async_request.rb
 - lib/wrest/cache_proxy.rb
-- lib/wrest/caching.rb
 - lib/wrest/caching/memcached.rb
+- lib/wrest/caching/redis.rb
+- lib/wrest/caching.rb
 - lib/wrest/callback.rb
-- lib/wrest/components.rb
-- lib/wrest/components/container.rb
 - lib/wrest/components/container/alias_accessors.rb
 - lib/wrest/components/container/typecaster.rb
-- lib/wrest/components/mutators.rb
+- lib/wrest/components/container.rb
 - lib/wrest/components/mutators/base.rb
 - lib/wrest/components/mutators/camel_to_snake_case.rb
 - lib/wrest/components/mutators/xml_mini_type_caster.rb
 - lib/wrest/components/mutators/xml_simple_type_caster.rb
-- lib/wrest/components/translators.rb
+- lib/wrest/components/mutators.rb
 - lib/wrest/components/translators/content_types.rb
 - lib/wrest/components/translators/json.rb
 - lib/wrest/components/translators/txt.rb
 - lib/wrest/components/translators/xml.rb
-- lib/wrest/core_ext/hash.rb
+- lib/wrest/components/translators.rb
+- lib/wrest/components.rb
 - lib/wrest/core_ext/hash/conversions.rb
-- lib/wrest/core_ext/string.rb
+- lib/wrest/core_ext/hash.rb
 - lib/wrest/core_ext/string/conversions.rb
-- lib/wrest/curl.rb
-- lib/wrest/curl/delete.rb
-- lib/wrest/curl/get.rb
-- lib/wrest/curl/options.rb
-- lib/wrest/curl/post.rb
-- lib/wrest/curl/post_multipart.rb
-- lib/wrest/curl/put.rb
-- lib/wrest/curl/put_multipart.rb
-- lib/wrest/curl/request.rb
-- lib/wrest/curl/response.rb
-- lib/wrest/curl/session.rb
+- lib/wrest/core_ext/string.rb
 - lib/wrest/exceptions.rb
 - lib/wrest/hash_with_case_insensitive_access.rb
 - lib/wrest/http_codes.rb
-- lib/wrest/http_shared.rb
 - lib/wrest/http_shared/headers.rb
 - lib/wrest/http_shared/standard_headers.rb
 - lib/wrest/http_shared/standard_tokens.rb
+- lib/wrest/http_shared.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
@@ -170,38 +155,43 @@ files:
 - lib/wrest/native/request.rb
 - lib/wrest/native/response.rb
 - lib/wrest/native/session.rb
-- lib/wrest/test.rb
+- lib/wrest/native.rb
 - lib/wrest/test/request_patches.rb
-- lib/wrest/uri.rb
+- lib/wrest/test.rb
 - lib/wrest/uri/builders.rb
+- lib/wrest/uri.rb
 - lib/wrest/uri_template.rb
 - lib/wrest/version.rb
-- lib/wrest/xml_mini.rb
-- lib/wrest/xml_mini/jdom.rb
 - lib/wrest/xml_mini/jdom/xpath_filter.rb
-- lib/wrest/xml_mini/libxml.rb
+- lib/wrest/xml_mini/jdom.rb
 - lib/wrest/xml_mini/libxml/xpath_filter.rb
-- lib/wrest/xml_mini/nokogiri.rb
+- lib/wrest/xml_mini/libxml.rb
 - lib/wrest/xml_mini/nokogiri/xpath_filter.rb
-- lib/wrest/xml_mini/rexml.rb
+- lib/wrest/xml_mini/nokogiri.rb
 - lib/wrest/xml_mini/rexml/xpath_filter.rb
+- lib/wrest/xml_mini/rexml.rb
+- lib/wrest/xml_mini.rb
+- lib/wrest.rb
 - lib/wrest_no_ext.rb
+- README.md
+- CHANGELOG
+- LICENCE
 homepage: http://c42.in/open_source
 licenses: []
 metadata: {}
 post_install_message: 
 rdoc_options:
-- "--charset=UTF-8"
+- --charset=UTF-8
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - '>='
     - !ruby/object:Gem::Version
       version: 1.3.0
 requirements:
@@ -211,10 +201,9 @@ requirements:
   (and should be unneccessary) on jruby.
 - To use eventmachine as a parallel backend, install the 'eventmachine' gem.
 rubyforge_project: wrest
-rubygems_version: 2.4.5
+rubygems_version: 2.0.14
 signing_key: 
 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: 

data/lib/wrest/curl.rb

@@ -1,51 +0,0 @@
-# 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.
-
-begin
-  gem 'patron', '~> 0.4'
-rescue Gem::LoadError => e
-  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'
-
-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.
-  #
-  # This functionality is under development and the Wrest API
-  # may not cover using it fully.
-  #
-  # Note:
-  # * The Curl based APIs do *not* support the HTTP 'options' verb.
-  # * Since auto-redirect is natively supported by Curl, auto-redirect may 
-  #   behave differently from the native implementation for now.
-  module Curl
-    include Wrest::HttpShared
-  end
-end
-
-module Patron #:nodoc:
-  # Patching Patron::Session#handle_request to make it public.
-  class Session
-    public :handle_request
-  end
-end
-
-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/curl/delete.rb

@@ -1,23 +0,0 @@
-# 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::Curl
-  class Delete < Request
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      super(
-            wrest_uri, 
-            :delete, 
-            parameters,
-            nil,
-            headers,
-            options
-          )
-    end
-  end
-end

data/lib/wrest/curl/get.rb

@@ -1,23 +0,0 @@
-# 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::Curl
-  class Get < Request
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      super(
-        wrest_uri,
-        :get,
-        parameters,
-        nil,
-        headers,
-        options
-      )
-    end
-  end
-end

data/lib/wrest/curl/options.rb

@@ -1,16 +0,0 @@
-# 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::Curl
-  class Options < Request
-    def initialize(*args)
-      raise Wrest::Exceptions::UnsupportedHttpVerb, 'Options'
-    end
-  end
-end

data/lib/wrest/curl/post.rb

@@ -1,23 +0,0 @@
-# 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::Curl
-  class Post < Request
-    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
-      super(
-        wrest_uri,
-        :post,
-        parameters,
-        body,
-        headers,
-        options
-      )
-    end
-  end
-end

data/lib/wrest/curl/post_multipart.rb

@@ -1,31 +0,0 @@
-# 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.
-
-module Wrest::Curl
-  class PostMultipart < Request
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      parameters = parameters.symbolize_keys
-
-      data = parameters[:data] ? {:data => parameters[:data]} : {:data => " "}
-      file = parameters[:file].is_a?(File) ? {:file => parameters[:file].path} : {:file => parameters[:file]}
-
-      options = options.merge({:data => data, :file => file, :multipart => true})
-      parameters.delete(:data)
-      parameters.delete(:file)
-      super(
-        wrest_uri,
-        :post,
-        parameters,
-        options[:data],
-        headers,
-        options
-      )
-    end
-  end
-end

data/lib/wrest/curl/put.rb

@@ -1,23 +0,0 @@
-# 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::Curl
-  class Put < Request
-    def initialize(wrest_uri, body = '', headers = {}, parameters = {}, options = {})
-      super(
-        wrest_uri,
-        :put,
-        parameters,
-        body,
-        headers,
-        options
-      )
-    end
-  end
-end

data/lib/wrest/curl/put_multipart.rb

@@ -1,16 +0,0 @@
-# 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.
-
-module Wrest::Curl
-  class PutMultipart < Request
-    def initialize(wrest_uri, parameters = {}, headers = {}, options = {})
-      raise Wrest::Exceptions::UnsupportedFeature, 'put_multipart'
-    end
-  end
-end

data/lib/wrest/curl/request.rb

@@ -1,102 +0,0 @@
-# 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 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, :multipart, :file_name
-      # 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
-        @multipart = @options[:multipart]
-        @file_name = @options[:file]
-        @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.headers = headers
-        @http_request.username = username
-        @http_request.password = password
-        @http_request.multipart = multipart
-        @http_request.upload_data = body 
-        @http_request.file_name = file_name
-        @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::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
-      #
-      # 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?
-
-        prefix = "#{http_request.action.to_s.upcase} #{http_request.hash} #{connection.hash} #{Thread.current.object_id}"
-
-        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
-      rescue Patron::TimeoutError => e
-        raise Wrest::Exceptions::Timeout.new(e)
-      end
-    end
-  end
-end

data/lib/wrest/curl/response.rb

@@ -1,85 +0,0 @@
-# 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 #:nodoc:
-  module Curl #:nodoc:
-    # Decorates a response providing support for deserialisation.
-    #
-    # Also provides set of HTTP response code checkers. For instance, the method ok? checks if the response was
-    # successful with HTTP code 200.
-    # See HttpCodes for a list of all such response checkers.
-    class Response              
-      attr_reader :http_response
-      attr_accessor :deserialised_body
-      include HttpShared::Headers
-      include HttpCodes
-      
-      extend Forwardable
-      def_delegators  :@http_response, :body, :headers
-      
-      def initialize_http_header
-        headers.merge!(headers.inject({}) do |downcased_headers, tuple|
-          key, value = tuple
-          downcased_headers[key.downcase] = value
-          downcased_headers
-        end)
-      end
-      
-      def initialize(http_response)
-        @http_response = http_response
-        initialize_http_header
-      end
-
-      def deserialise(options = {})
-        @deserialised_body ||= deserialise_using(Wrest::Components::Translators.lookup(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
-      
-      def code
-        @http_response.status
-      end
-      
-      def message
-        @http_response.status_line
-      end
-      
-      def content_length
-        self[H::ContentLength].try(:to_i)
-      end
-    
-      def content_type
-        self[H::ContentType].split(';').first
-      end
-            
-      # A null object implementation - invoking this method on
-      # a response simply returns the same response unless
-      # the response is a Redirection (code 3xx), in which case a 
-      # get is invoked on the url stored in the response headers
-      # under the key 'location' and the new Response is returned.
-      def follow(redirect_request_options = {})
-        self
-      end
-      
-      def connection_closed?
-        self[StandardHeaders::Connection].downcase == StandardTokens::Close.downcase
-      end
-    end
-  end
-end

data/lib/wrest/curl/session.rb

@@ -1,57 +0,0 @@
-# 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::Curl
-  # This class is a wrapper for a keep-alive HTTP connection. It simply passes the
-  # same connection instance as an option to all Wrest::Native::Request instances created using it.
-  #
-  # If at any point the server closes an existing connection during a Session by returning a
-  # Connection: Close header the current connection is destroyed and a fresh one created for the next
-  # request.
-  #
-  # The Session constructor can accept either a String URI or a Wrest::Uri as a parameter. If you
-  # need HTTP authentication, you should use a Wrest::Uri.
-  class Session
-    attr_reader :uri
-    def initialize(uri)
-      @uri = Wrest::Uri.new(uri)
-      @default_headers = { StandardHeaders::Connection => StandardTokens::KeepAlive }
-
-      yield(self) if block_given?
-    end
-
-    def connection
-      @connection ||= @uri.create_connection
-    end
-
-    def get(path = '', parameters = {}, headers = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].get(parameters, headers.merge(@default_headers))
-    end
-
-    def post(path = '', body = '', headers = {}, params = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].post(body, headers.merge(@default_headers), params)
-    end
-    
-    def put(path = '', body = '', headers = {}, params = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].put(body, headers.merge(@default_headers), params)
-    end
-
-    def delete(path = '', parameters = {}, headers = {})
-      maybe_destroy_connection @uri[path, {:connection => self.connection}].delete(parameters, headers.merge(@default_headers))
-    end
-    
-    def maybe_destroy_connection(response)
-      if response.connection_closed?
-        Wrest.logger.warn "Connection #{@connection.hash} has been closed by the server"
-        @connection = nil 
-      end
-      response
-    end
-  end
-end