wrest 2.1.7 → 2.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 091ff99d9b7472c8cfcf9a27a0ea15b265109c4e
-  data.tar.gz: 79e6ef34679174763066b807603f1bbf6dac011d
+  metadata.gz: 69a30e75377430e134d3be264b50b1e97e823152
+  data.tar.gz: f721a616192a527d21afa74c0adba3dd3dfd5b41
 SHA512:
-  metadata.gz: cbb24475f771990b01557028d14b779d1c456b0b15e271974e5542929694fb2fa39e8137851de5870b9f8ad4090965fc3f095d47e7a40b27e3fd75162d1ec8d8
-  data.tar.gz: 0306fa8fba478fbfb0404d1fbefa3c4d69adf0c9391941c27035f38b45129544e98aecb1f6a7a51ad4fabfd2bf9d5671e0f3b067073364e0320a15f6348e540a
+  metadata.gz: 94db9fae0c8540e80497fb182b2d8634fbc6fdc8e7fd374fe13931b348244513ffaab8128c76369a92b2fb45bd018cbd7817d6529fc80b4ad5077f085fb47165
+  data.tar.gz: 1e411d00090ff33e317774678a9072b20689862f3e2879715f4b5d95baea7b90459a52d7a0e00e21a85b9ac9922d55305018dcf83d99c21ca0eca04e2d83a4ce

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.
 
+== 2.1.9
+ * Switch to using concurrent-ruby
+
 == 2.1.6
  * Logging payload by default
 

data/README.md

@@ -1,13 +1,13 @@
 [![Build Status](https://travis-ci.org/c42/wrest.svg?branch=master)](https://travis-ci.org/c42/wrest)
 
-# Wrest 2.1.4
+# Wrest 2.1.9
 
 (c) Copyright 2009-2016 [Sidu Ponnappa](http://twitter.com/ponnappa). All Rights Reserved.
 
 Wrest is a ruby REST/HTTP client library which
 
 * 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
+* Allows you to pick your Ruby: use 2.x.x, JRuby 9.x.x
 * 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
 * Allows you to quickly build object oriented wrappers around any web service
@@ -37,15 +37,15 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
 * Timeout support
 
     ```
-    'https://api.github.com/repos/c42/wrest/issues'.to_uri.get(:timeout => 5).body
+    'https://api.github.com/repos/c42/wrest/issues'.to_uri.get(timeout: 5).body
     ```
 
 * Redirect support
 
     ```
-    'http://google.com'.to_uri(:follow_redirects => false).get
+    'http://google.com'.to_uri(follow_redirects: false).get
 
-    'http://google.com'.to_uri(:follow_redirects_limit => 1).get
+    'http://google.com'.to_uri(follow_redirects_limit: 1).get
     ```
 
   :follow_redirects_limit defaults to 5 if not specified.
@@ -56,7 +56,7 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
     ActiveSupport::XmlMini.backend = 'REXML'
 
     'http://twitter.com/statuses/public_timeline.xml'.to_uri.get.deserialise(
-                                                  :xpath => '//user/name/text()'
+                                                  xpath: '//user/name/text()'
                                                 )
     ```
 
@@ -64,8 +64,8 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
 
     ```
     'api.openweathermap.org/data/2.5/weather'.to_uri.get(
-                  :lat  => 35,
-                  :lon => 139
+                  lat: 35,
+                  lon: 139
                   ).deserialise_using(
                   Wrest::Components::Translators::Xml
                 )
@@ -74,10 +74,16 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
 * Basic HTTP auth and URI extensions using Wrest::Uri#[]
 
     ```
-    base_uri = 'https://api.del.icio.us/v1'.to_uri(:username => 'kaiwren', :password => 'fupupp1es')
+    base_uri = 'https://api.del.icio.us/v1'.to_uri(username: 'kaiwren', password: 'fupupp1es')
     bookmarks = base_uri['/posts/get'].get.deserialise
     ```
 
+* Detailed debugging and logging (NOT FOR USE IN PRODUCTION! SEE API DOCS!)
+
+    ```
+    'https://api.github.com/repos/c42/wrest/issues'.to_uri(detailed_http_logging: $stdout).get.deserialize
+    ```
+
 #### POST
 
 * Regular, vanilla Post with a body and headers
@@ -90,12 +96,12 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
 
     ```
     'https://api.del.icio.us/v1/posts/add'.to_uri(
-             :username => 'kaiwren', :password => 'fupupp1es'
+             username: 'kaiwren', password: 'fupupp1es'
           ).post_form(
-             :url => 'http://blog.sidu.in/search/label/ruby',
-             :description => 'The Ruby related posts on my blog!',
-             :extended => "All posts tagged with 'ruby'",
-             :tags => 'ruby hacking'
+             url: 'http://blog.sidu.in/search/label/ruby',
+             description: 'The Ruby related posts on my blog!',
+             extended: "All posts tagged with 'ruby'",
+             tags: 'ruby hacking'
           )
     ```
 
@@ -103,8 +109,8 @@ For Facebook, Twitter, Delicious, GitHub and other API examples, see http://gith
 
     ```
    'http://imgur.com/api/upload.xml'.to_uri.post_multipart(
-     :image => UploadIO.new(File.open(file_path), "image/png", file_path),
-     :key => imgur_key
+     image: UploadIO.new(File.open(file_path), "image/png", file_path),
+     key: imgur_key
     ).deserialise
     ```
 
@@ -116,13 +122,14 @@ To delete a resource:
 
 ```
  'https://api.del.icio.us/v1/posts/delete'.to_uri(
-                                              :username => 'kaiwren',
-                                              :password => 'fupupp1es'
+                                              username: 'kaiwren',
+                                              password: 'fupupp1es'
                                             ).delete(
-                                              :url => 'http://c2.com'
+                                              url: 'http://c2.com'
                                             )
 ```
 
+
 ### Caching
 
 Wrest supports caching with the following pluggable back-ends:
@@ -199,7 +206,7 @@ To explicitly disable caching for specific requests:
 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 => {
+  "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}" }
@@ -339,6 +346,13 @@ The response log consists of request type that generated the response (POST), ha
 
 The thread id, request hash and connection hashes are used to track requests and their corresponding responses when using asynchronous requests and/or http connection pooling.
 
+Detailed http debug logging can be turned on like so (DO NOT USE IN PRODUCTION! SEE API DOCS.):
+
+    ```
+    'https://api.github.com/repos/c42/wrest/issues'.to_uri(detailed_http_logging: $stdout).get.deserialize
+    ```
+
+
 ### 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:
@@ -375,7 +389,7 @@ You can launch the interactive Wrest shell by running bin/wrest if you have the
 
 ```
   $ wrest
-  >> y 'http://twitter.com/statuses/public_timeline.json'.to_uri(:timeout => 5).get.deserialise
+  >> y 'http://twitter.com/statuses/public_timeline.json'.to_uri(timeout: 5).get.deserialise
 ```
 
 ### Testing

data/lib/wrest/async_request/thread_pool.rb

@@ -11,56 +11,16 @@ module Wrest
   module AsyncRequest
     class ThreadPool
       def initialize(number_of_threads)
-        @threads = []
-        @number_of_threads = number_of_threads
-        @queue = Queue.new
+        @pool = Concurrent::FixedThreadPool.new(number_of_threads)
       end
       
       def execute_eventually(request)
-        initialize_thread_pool if @threads.empty?
-        @queue.push(request)
+        @pool.post { request.invoke }
         nil
       end
       
       def join_pool_threads!
-        @threads.each do |thread|
-          thread.join if thread.alive?
-        end
-      end
-      
-      private
-      def initialize_thread_pool
-        halt_on_sigint
-        halt_on_int
-        main_thread = Thread.current
-        @threads =  @number_of_threads.times.map do |i|
-          Thread.new do |thread|
-            while request = @queue.pop
-              request.invoke
-            end
-          end
-        end
-      end
-      
-      def halt_on_sigint
-        trap('SIGINT') do
-          halt
-        end
-      end
-    
-      def halt_on_int
-        trap('INT') do
-          halt
-        end
-      end
-    
-      def halt
-        unless @threads.empty?
-          Wrest.logger.debug "Wrest: Shutting down ThreadPool..."
-          @threads.each(&:terminate)
-          Wrest.logger.debug "Wrest: Halted ThreadPool, continuing with shutdown."
-        end
-        Process.exit
+        @pool.wait_for_termination
       end
     end
   end

data/lib/wrest/native/request.rb

@@ -13,7 +13,7 @@ module Wrest::Native
   # or Wrest::Native::Get etc. instead.
   class Request
     attr_reader :http_request, :uri, :body, :headers, :username, :password, :follow_redirects,
-                :follow_redirects_limit, :follow_redirects_count, :timeout, :connection, :parameters, 
+                :follow_redirects_limit, :follow_redirects_count, :timeout, :connection, :parameters,
                 :cache_store, :verify_mode, :options, :ca_path
     # Valid tuples for the options are:
     #   :username => String, defaults to nil
@@ -25,10 +25,10 @@ module Wrest::Native
     #                              For example, if you set this to 1, the very first redirect
     #                              will raise the exception.
     #   :follow_redirects_count => Integer, defaults to 0. This is a count of the hops made to
-    #                              get to this request and increases by one for every redirect 
+    #                              get to this request and increases by one for every redirect
     #                              until the follow_redirects_limit is hit. You should never set
     #                              this option yourself.
-    #   :timeout => The period, in seconds, after which a Timeout::Error is raised 
+    #   :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.
@@ -38,7 +38,7 @@ module Wrest::Native
     #                        eg: { <response code> => lambda { |response| some_operation } }
     #  The following options are Net::HTTP specific config options
     #   :detailed_http_logging => nil/$stdout/$stderr or File/Logger/IO object. Defaults to nil (recommended).
-    #                             *WARNING* : detailed_http_logging causes a serious security hole. Never use it in production code.  
+    #                             *WARNING* : detailed_http_logging causes a serious security hole. Never use it in production code.
     #   :verify_mode => The verification mode to be used for Net::HTTP https connections. Defaults to OpenSSL::SSL::VERIFY_PEER
     #   :ca_path => The path to the certificates
     def initialize(wrest_uri, http_request_klass, parameters = {}, body = nil, headers = {}, options = {})
@@ -65,20 +65,20 @@ module Wrest::Native
 
     # Makes a request, runs the appropriate callback if any 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 
+    # The type of request is mentioned in caps, followed by a hash
     # 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 (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.
@@ -89,15 +89,13 @@ module Wrest::Native
       http_request.basic_auth username, password unless username.nil? || password.nil?
 
       prefix = "#{http_request.method} #{self.hash} #{@connection.hash} #{Thread.current.object_id}"
-      
+
       Wrest.logger.debug "<- (#{prefix}) #{@uri.protocol}://#{@uri.host}:#{@uri.port}#{@http_request.path}"
       Wrest.logger.debug "<- Body: #{@body}"
       time = Benchmark.realtime { response = Wrest::Native::Response.new( do_request ) }
-      Wrest.logger.debug "-> (#{prefix}) %d %s (%d bytes %.2fs)" % [response.code, response.message, response.body ? response.body.length : 0, time]
-      Wrest.logger.debug "#{response.body}"
 
       execute_callback_if_any(response)
-      
+
       @follow_redirects ? response.follow(@options) : response
     rescue Timeout::Error => e
       raise Wrest::Exceptions::Timeout.new(e)
@@ -111,7 +109,7 @@ module Wrest::Native
         request_klass.new(parameters.empty? ? "#{uri.uri_path}" : "#{uri.uri_path}?#{parameters.to_query}", headers)
       end
     end
-  
+
     #:nodoc:
     def do_request
       @connection.request(@http_request, @body)

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 = "2.1.7"
+  VERSION = "2.1.9"
 end

data/lib/wrest.rb

@@ -15,6 +15,7 @@ require 'base64'
 require 'logger'
 require 'benchmark'
 require 'multi_json'
+require 'concurrent'
 require 'active_support'
 require 'active_support/core_ext/string'
 require 'active_support/core_ext/hash'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrest
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.9
 platform: ruby
 authors:
 - Sidu Ponnappa
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-22 00:00:00.000000000 Z
+date: 2017-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -95,9 +95,37 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  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'
+- !ruby/object:Gem::Dependency
+  name: json
+  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'
 description: Wrest is a fluent, easy-to-use, object oriented Ruby HTTP/REST client
   library with support for RFC2616 HTTP caching, multiple HTTP backends and async
-  calls using EventMachine. It runs on CRuby and JRuby.
+  calls. It runs on CRuby and JRuby and is in production use at substantial scale.
 email:
 - sidu@c42.in
 executables:
@@ -201,7 +229,7 @@ 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.1
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Wrest is a fluent, object oriented HTTP client library for 2.x.x, JRuby 1.7.6