wrest 1.5.2 → 1.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 387bf7a48ff0337789fb3efefc9d7ba43d5e3610
-  data.tar.gz: cc9eafb4f54b2269975be55e5ed2e00c05319ffe
+  metadata.gz: af75d10ad96bd8e0539620594008b533d1d19a1a
+  data.tar.gz: 5760c9925189879d52eb6a83c599fcac4788f700
 SHA512:
-  metadata.gz: 6c91d9d500c5173755a2714d6db85d1b0e6fb02bba70031d39dd019869e11fc8a19210de1ddadd00d43e402b3e684f734d69d7ad09668aa70cecc68e4e2c3748
-  data.tar.gz: ae1f2a1df23dfd81a3432d04dc1dea3a2f82c945ef04fb93b1d04a0567fb26bf8262edc45bc44041b9089449ab19a8fcbf372a658be8b2eb1148fa96dfcf1c5f
+  metadata.gz: e566458f7d00c59cda57695f0d8b55bc16d06d27e10d6980837584dbf184a7a74167e10644ba3b4c444d1073d0eaf8a9686cd51cda89a6825e2e13d4997a3edd
+  data.tar.gz: d1571b4cb17d98827dc391e616755d5e55d07c47da244fa09e5690c0dff1ac85a3f4480da7d46b856deecf598830363fbb48619bd3310fcdd6a952dfec45616e

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.5.3
+ * Implemented a thread pool for async requests using ThreadBackend
+ * Updated request/response logging to include current thread id
+    
 == 1.5.2
  * Updated dependencies - ActiveSupport, MultipartPost, Dalli and JRuby OpenSSL
  

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 1.5.1
+# Wrest 1.5.3
 
-(c) Copyright 2009-2011 [Sidu Ponnappa](http://blog.sidu.in). All Rights Reserved.
+(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 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))
+* 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)
 * **_Alpha_**
 
@@ -204,7 +204,7 @@ Please note that Wrest is a synchronous library. All requests are blocking, and
 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.
+Asynchronous requests support pluggable backends. The default backend used for asynchronous requests is ruby threads, which is only reliable when using JRuby.
 
 ```
   "http://c42.in".to_uri.get_async do |callback|
@@ -213,7 +213,8 @@ Asynchronous requests support pluggable backends. The default backend used for a
     end
   end
 
-  sleep 1 # Causes thread created by get_async to execute
+  # Wait until the background threads finish execution before letting the program end.
+  Wrest::AsyncRequest.wait_for_thread_pool!
 ```
 
 You can change the default to eventmachine.
@@ -279,6 +280,23 @@ The Wrest logger can be set and accessed through Wrest.logger and is configured
   Wrest.logger = Rails.logger
 ```
 
+Every request and response is logged at level `debug`.
+
+Here is an sample request log message:
+```
+<- (POST 515036017 732688777 2010) http://localhost:3000/events.json
+```
+
+The request log consists of request type (POST), request hash (515036017), connection hash (732688777), thread id (2010), URI (http://localhost:3000/events.json)
+
+Here is a sample response log message:
+```
+-> (POST 515036017 732688777 2010) 200 OK (0 bytes 0.01s)
+```
+The response log consists of request type that generated the response (POST), hash of the request that generated the response (515036017), hash of the connection (732688777), thread id (2010), status (200 OK), response body length (0 bytes) and time taken (0.01)s.
+
+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.
+
 ### 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:

data/lib/wrest.rb

@@ -67,9 +67,9 @@ require "wrest/http_codes"
 require "wrest/callback"
 require "wrest/native"
 
-require "wrest/async_request"
+require "wrest/async_request/thread_pool"
 require "wrest/async_request/thread_backend"
-Wrest::AsyncRequest.default_to_threads!
+require "wrest/async_request"
 
 require "wrest/caching"
 

data/lib/wrest/async_request.rb

@@ -31,9 +31,20 @@ module Wrest
       self.default_backend = Wrest::AsyncRequest::ThreadBackend.new
     end
 
-    # Returns the default backend
+    # Returns the default backend, which is the ThreadBackend
     def self.default_backend
-      @default_backend
+      @default_backend || default_to_threads!
+    end
+    
+    # Uses Thread#join to wait until all background requests
+    # are completed.
+    #
+    # Use this as the last instruction in a script to prevent it from
+    # exiting before background threads have completed running.
+    #
+    # Needs Wrest.default_backend to be an instance of ThreadBackend.
+    def self.wait_for_thread_pool!
+      default_backend.wait_for_thread_pool!
     end
   end
 end

data/lib/wrest/async_request/thread_backend.rb

@@ -9,11 +9,22 @@
 
 module Wrest
   module AsyncRequest
-    class ThreadBackend 
+    # Uses a pool of Threads to make requests.
+    # Only recommended for production use on JRuby.
+    class ThreadBackend
+      attr_reader :thread_pool
+      def initialize(number_of_threads = 5)
+        @thread_pool = ThreadPool.new(number_of_threads)
+      end
+      
       def execute(request)
-        Thread.new do
-          request.invoke
-        end
+        @thread_pool.execute_eventually(request)
+      end
+      
+      # Uses Thread#join to wait until all
+      # background requests are completed.
+      def wait_for_thread_pool!
+        @thread_pool.join_pool_threads!
       end
     end
   end

data/lib/wrest/async_request/thread_pool.rb

@@ -0,0 +1,65 @@
+# Copyright 2009-2015 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 native://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 AsyncRequest
+    class ThreadPool
+      def initialize(number_of_threads)
+        @threads = []
+        @number_of_threads = number_of_threads
+        @queue = Queue.new
+        halt_on_sigint
+        halt_on_int
+        initialize_thread_pool
+      end
+      
+      def execute_eventually(request)
+        @queue.push(request)
+        nil
+      end
+      
+      def join_pool_threads!
+        @threads.each do |thread|
+          thread.join if thread.alive?
+        end
+      end
+      
+      private
+      def initialize_thread_pool
+        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
+        Wrest.logger.debug "Shutting down ThreadPool..."
+        @threads.each(&:terminate)
+        Wrest.logger.debug "Halted ThreadPool, continuing with shutdown..."
+        Process.exit
+      end
+    end
+  end
+end

data/lib/wrest/curl/request.rb

@@ -87,7 +87,7 @@ module Wrest
         @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}"
+        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))}

data/lib/wrest/native/request.rb

@@ -88,7 +88,7 @@ module Wrest::Native
       @connection.set_debug_output @detailed_http_logging
       http_request.basic_auth username, password unless username.nil? || password.nil?
 
-      prefix = "#{http_request.method} #{self.hash} #{@connection.hash}"
+      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}"
       time = Benchmark.realtime { response = Wrest::Native::Response.new( do_request ) }

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.2"
+  VERSION = "1.5.3"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wrest
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.5.3
 platform: ruby
 authors:
 - Sidu Ponnappa
@@ -9,22 +9,8 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2015-08-04 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rubyforge
-  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: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +115,7 @@ files:
 - 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/cache_proxy.rb
 - lib/wrest/caching.rb
 - lib/wrest/caching/memcached.rb