async-http 0.49.1 → 0.50.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 234d08278fa38ecca5449b3c94220d956f53c564291fe6a71e5b5152e0f5bace
-  data.tar.gz: a60712a3e7483dc7bb60d220b439b6f749f15ca0ca70375d3aa10d1460849168
+  metadata.gz: 5db10f65827c5a336ba0d827f659f81411e87a65de7b2cf0ef512ce52bf4950e
+  data.tar.gz: 50461d80e6da099e33f71a4d6a476fa25609d99c69f401374509d6daf5f29116
 SHA512:
-  metadata.gz: 63f4a410af4f4d6777f6c1c00ca96855c8d8c6057ae4ce43a2f277798f29bf1385dc2bf7d4a3d1eaa76bb16d260d93cf8da1b1679b83defd46b5c7fb91508817
-  data.tar.gz: 136a88be9c5e3de646e7249a905627a1f9621d1218d3f4a36fc522aa31d60278b410262b5c7667dc03ac89dfce40ad7e53978f2d798860f9deef6ab0f74e8bd2
+  metadata.gz: d61522536ff249da6c1fbecbc6493d1f401cb005ce280c1a6ce278f107399a1a2fc43bce170123a52be21da4f88940f0e8783b949bda132609dbf41400c10628
+  data.tar.gz: fba11fe6d4b10036f288e120416efb85e6d7704ae556eeb1eb51f1d7eae7b2cb0ea3106677470d9f6024e5b9dfc0278ba54aab691f7982162f1c363bed0d1d24

data/.travis.yml

@@ -13,17 +13,17 @@ addons:
 
 matrix:
   include:
-    - rvm: 2.3
     - rvm: 2.4
     - rvm: 2.5
     - rvm: 2.6
+    - rvm: 2.7
     - rvm: 2.6
-      env: COVERAGE=Summary,Coveralls
+      env: COVERAGE=PartialSummary,Coveralls
     - rvm: truffleruby
     - rvm: jruby-head
       env: JRUBY_OPTS="--debug -X+O"
     - rvm: ruby-head
-    - rvm: 2.6
+    - rvm: 2.7
       os: osx
   allow_failures:
     - rvm: truffleruby

data/Gemfile

@@ -9,8 +9,3 @@ gemspec
 # gem "protocol-http1", path: "../protocol-http1"
 # gem "protocol-http2", path: "../protocol-http2"
 # gem "protocol-hpack", path: "../protocol-hpack"
-
-group :development do
-	gem 'pry'
-	gem 'ruby-prof', '~> 0.18'
-end

data/README.md

@@ -62,6 +62,72 @@ end
 
 Consider using [async-rest](https://github.com/socketry/async-rest) instead.
 
+### Multiple Requests
+
+To issue multiple requests concurrently, you should use a barrier, e.g.
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'async'
+require 'async/barrier'
+require 'async/http/internet'
+
+TOPICS = ["ruby", "python", "rust"]
+
+Async do
+	internet = Async::HTTP::Internet.new
+	barrier = Async::Barrier.new
+	
+	# Spawn an asynchronous task for each topic:
+	TOPICS.each do |topic|
+		barrier.async do
+			response = internet.get "https://www.google.com/search?q=#{topic}"
+			puts "Found #{topic}: #{response.read.scan(topic).size} times."
+		end
+	end
+	
+	# Ensure we wait for all requests to complete before continuing:
+	barrier.wait
+ensure
+	internet&.close
+end
+```
+
+#### Limiting Requests
+
+If you need to limit the number of simultaneous requests, use a semaphore.
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'async'
+require 'async/barrier'
+require 'async/semaphore'
+require 'async/http/internet'
+
+TOPICS = ["ruby", "python", "rust"]
+
+Async do
+	internet = Async::HTTP::Internet.new
+	barrier = Async::Barrier.new
+	semaphore = Async::Semaphore.new(2, parent: barrier)
+	
+	# Spawn an asynchronous task for each topic:
+	TOPICS.each do |topic|
+		semaphore.async do
+			response = internet.get "https://www.google.com/search?q=#{topic}"
+			puts "Found #{topic}: #{response.read.scan(topic).size} times."
+		end
+	end
+	
+	# Ensure we wait for all requests to complete before continuing:
+	barrier.wait
+ensure
+	internet&.close
+end
+```
+
 ### Downloading a File
 
 Here is an example showing how to download a file and save it to a local path:

data/Rakefile

@@ -1,9 +1,9 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:test)
+RSpec::Core::RakeTask.new
 
-task :default => :test
+task :default => :spec
 
 # Load all rake tasks:
 import(*Dir.glob('tasks/**/*.rake'))

data/async-http.gemspec

@@ -4,6 +4,7 @@ require_relative 'lib/async/http/version'
 Gem::Specification.new do |spec|
 	spec.name          = "async-http"
 	spec.version       = Async::HTTP::VERSION
+	spec.licenses      = ["MIT"]
 	spec.authors       = ["Samuel Williams"]
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 
@@ -18,6 +19,7 @@ Gem::Specification.new do |spec|
 	
 	spec.add_dependency("async", "~> 1.23")
 	spec.add_dependency("async-io", "~> 1.27.0")
+	spec.add_dependency("async-pool", "~> 0.2")
 	
 	spec.add_dependency("protocol-http", "~> 0.13.0")
 	spec.add_dependency("protocol-http1", "~> 0.10.0")

data/lib/async/http/client.rb

@@ -23,6 +23,8 @@
 require 'async/io/endpoint'
 require 'async/io/stream'
 
+require 'async/pool/controller'
+
 require 'protocol/http/body/streamable'
 require 'protocol/http/methods'
 
@@ -30,6 +32,9 @@ require_relative 'protocol'
 
 module Async
 	module HTTP
+		DEFAULT_RETRIES = 3
+		DEFAULT_CONNECTION_LIMIT = nil
+		
 		class Client < ::Protocol::HTTP::Methods
 			# Provides a robust interface to a server.
 			# * If there are no connections, it will create one.
@@ -40,7 +45,7 @@ module Async
 			# @param protocol [Protocol::HTTP1 | Protocol::HTTP2 | Protocol::HTTPS] the protocol to use.
 			# @param scheme [String] The default scheme to set to requests.
 			# @param authority [String] The default authority to set to requests.
-			def initialize(endpoint, protocol = endpoint.protocol, scheme = endpoint.scheme, authority = endpoint.authority, retries: 3, connection_limit: nil)
+			def initialize(endpoint, protocol = endpoint.protocol, scheme = endpoint.scheme, authority = endpoint.authority, retries: DEFAULT_RETRIES, connection_limit: DEFAULT_CONNECTION_LIMIT)
 				@endpoint = endpoint
 				@protocol = protocol
 				
@@ -129,7 +134,7 @@ module Async
 			protected
 			
 			def make_pool(connection_limit)
-				Pool.new(connection_limit) do
+				Async::Pool::Controller.wrap(limit: connection_limit) do
 					Async.logger.debug(self) {"Making connection to #{@endpoint.inspect}"}
 					
 					@protocol.client(@endpoint.connect)

data/lib/async/http/endpoint.rb

@@ -37,6 +37,17 @@ module Async
 				return self.new(url, endpoint, **options)
 			end
 			
+			# Construct an endpoint with a specified scheme, hostname, and options.
+			def self.for(scheme, hostname, **options)
+				# TODO: Consider using URI.for once it becomes available:
+				uri_klass = URI.scheme_list[scheme.upcase] || URI::HTTP
+				
+				self.new(
+					uri_klass.new(scheme, nil, hostname, nil, nil, nil, nil, nil, nil),
+					**options
+				)
+			end
+			
 			# @option scheme [String] the scheme to use, overrides the URL scheme.
 			# @option hostname [String] the hostname to connect to (or bind to), overrides the URL hostname (used for SNI).
 			# @option port [Integer] the port to bind to, overrides the URL port.
@@ -81,7 +92,7 @@ module Async
 			end
 			
 			def secure?
-				['https', 'wss'].include?(@url.scheme)
+				['https', 'wss'].include?(self.scheme)
 			end
 			
 			def protocol

data/lib/async/http/internet.rb

@@ -28,8 +28,9 @@ require 'protocol/http/body/buffered'
 module Async
 	module HTTP
 		class Internet
-			def initialize
+			def initialize(**options)
 				@clients = {}
+				@options = options
 			end
 			
 			def call(method, url, headers = [], body = nil)
@@ -48,7 +49,7 @@ module Async
 			end
 			
 			def client_for(endpoint)
-				Client.new(endpoint)
+				Client.new(endpoint, **@options)
 			end
 			
 			def close

data/lib/async/http/protocol.rb

@@ -35,10 +35,10 @@ module Async
 			
 			# A connection must implement the following interface:
 			# class Connection
-			# 	def multiplex -> can invoke call 1 or more times simultaneously.
+			# 	def concurrency -> can invoke call 1 or more times simultaneously.
 			# 	def reusable? -> can be used again/persistent connection.
 			
-			# 	def connected? -> Boolean
+			# 	def viable? -> Boolean
 			
 			# 	def call(request) -> Response
 			# 	def each -> (yield(request) -> Response)

data/lib/async/http/protocol/http1/connection.rb

@@ -62,12 +62,12 @@ module Async
 					
 					attr :count
 					
-					def multiplex
+					def concurrency
 						1
 					end
 					
 					# Can we use this connection to make requests?
-					def connected?
+					def viable?
 						@stream&.connected?
 					end
 					

data/lib/async/http/protocol/http2/connection.rb

@@ -113,12 +113,12 @@ module Async
 					
 					attr :count
 					
-					def multiplex
+					def concurrency
 						self.maximum_concurrent_streams
 					end
 					
 					# Can we use this connection to make requests?
-					def connected?
+					def viable?
 						@stream.connected?
 					end
 					

data/lib/async/http/protocol/https.rb

@@ -25,8 +25,6 @@ require_relative 'http11'
 
 require_relative 'http2'
 
-require_relative '../pool'
-
 require 'openssl'
 
 unless OpenSSL::SSL::SSLContext.instance_methods.include? :alpn_protocols=
@@ -66,7 +64,7 @@ module Async
 					if protocol = HANDLERS[name]
 						return protocol
 					else
-						throw ArgumentError.new("Could not determine protocol for connection (#{name.inspect}).")
+						raise ArgumentError, "Could not determine protocol for connection (#{name.inspect})."
 					end
 				end
 				

data/lib/async/http/relative_location.rb

@@ -26,6 +26,9 @@ require 'protocol/http/middleware'
 
 module Async
 	module HTTP
+		class TooManyRedirects < StandardError
+		end
+
 		# A client wrapper which transparently handles both relative and absolute redirects to a given maximum number of hops.
 		class RelativeLocation < ::Protocol::HTTP::Middleware
 			DEFAULT_METHOD = GET
@@ -69,7 +72,7 @@ module Async
 					end
 				end
 				
-				raise ArgumentError, "Redirected #{hops} times, exceeded maximum!"
+				raise TooManyRedirects, "Redirected #{hops} times, exceeded maximum!"
 			end
 		end
 	end

data/lib/async/http/server.rb

@@ -29,8 +29,8 @@ require 'protocol/http/middleware'
 module Async
 	module HTTP
 		class Server < ::Protocol::HTTP::Middleware
-			def self.for(*args, &block)
-				self.new(block, *args)
+			def self.for(*arguments, &block)
+				self.new(block, *arguments)
 			end
 			
 			def initialize(app, endpoint, protocol = endpoint.protocol, scheme = endpoint.scheme)

data/lib/async/http/version.rb

@@ -22,6 +22,6 @@
 
 module Async
 	module HTTP
-		VERSION = "0.49.1"
+		VERSION = "0.50.0"
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-http
 version: !ruby/object:Gem::Version
-  version: 0.49.1
+  version: 0.50.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-23 00:00:00.000000000 Z
+date: 2019-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.27.0
+- !ruby/object:Gem::Dependency
+  name: async-pool
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 - !ruby/object:Gem::Dependency
   name: protocol-http
   requirement: !ruby/object:Gem::Requirement
@@ -218,7 +232,6 @@ files:
 - lib/async/http/client.rb
 - lib/async/http/endpoint.rb
 - lib/async/http/internet.rb
-- lib/async/http/pool.rb
 - lib/async/http/protocol.rb
 - lib/async/http/protocol/http1.rb
 - lib/async/http/protocol/http1/client.rb
@@ -247,7 +260,8 @@ files:
 - tasks/h2spec.rake
 - tasks/server.rake
 homepage: https://github.com/socketry/async-http
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -264,7 +278,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: A HTTP client and server library.

data/lib/async/http/pool.rb

@@ -1,187 +0,0 @@
-# frozen_string_literal: true
-#
-# Copyright, 2017, by Samuel G. D. Williams. <http://www.codeotaku.com>
-# 
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-# 
-# The above copyright notice and this permission notice shall be included in
-# all copies or substantial portions of the Software.
-# 
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-# THE SOFTWARE.
-
-require 'async/logger'
-require 'async/notification'
-
-module Async
-	module HTTP
-		# Pool behaviours
-		# 
-		# - Single request per connection (HTTP/1 without keep-alive)
-		# - Multiple sequential requests per connection (HTTP1 with keep-alive)
-		# - Multiplex requests per connection (HTTP2)
-		# 
-		# In general we don't know the policy until connection is established.
-		#
-		# This pool doesn't impose a maximum number of open resources, but it WILL block if there are no available resources and trying to allocate another one fails.
-		#
-		# Resources must respond to
-		# 	#multiplex -> 1 or more.
-		# 	#reusable? -> can be used again.
-		#
-		class Pool
-			def initialize(limit = nil, &block)
-				@resources = {} # resource => count
-				@available = Async::Notification.new
-				
-				@limit = limit
-				
-				@constructor = block
-				@guard = Async::Semaphore.new(1)
-			end
-			
-			# The number of allocated resources.
-			def active
-				@resources.count
-			end
-			
-			# Whether there are resources which are currently in use.
-			def busy?
-				@resources.collect do |_, usage|
-					return true if usage > 0
-				end
-				
-				return false
-			end
-			
-			# Wait until a pool resource has been freed.
-			def wait
-				@available.wait
-			end
-			
-			# All allocated resources.
-			attr :resources
-			
-			def empty?
-				@resources.empty?
-			end
-			
-			def acquire
-				resource = wait_for_resource
-				
-				return resource unless block_given?
-				
-				begin
-					yield resource
-				ensure
-					release(resource)
-				end
-			end
-			
-			# Make the resource resources and let waiting tasks know that there is something resources.
-			def release(resource)
-				# A resource that is not good should also not be reusable.
-				if resource.reusable?
-					reuse(resource)
-				else
-					retire(resource)
-				end
-			end
-			
-			def close
-				@resources.each_key(&:close)
-				@resources.clear
-			end
-			
-			def to_s
-				"\#<#{self.class} resources=#{availability_string} limit=#{@limit.inspect}>"
-			end
-			
-			protected
-			
-			def availability_string
-				@resources.collect do |resource,usage|
-					"#{usage}/#{resource.multiplex}#{resource.connected? ? '' : '*'}/#{resource.count}"
-				end.join(";")
-			end
-			
-			def reuse(resource)
-				Async.logger.debug(self) {"Reuse #{resource}"}
-				
-				@resources[resource] -= 1
-				
-				@available.signal
-			end
-			
-			def retire(resource)
-				Async.logger.debug(self) {"Retire #{resource}"}
-				
-				@resources.delete(resource)
-				
-				resource.close
-				
-				@available.signal
-			end
-			
-			def wait_for_resource
-				# If we fail to create a resource (below), we will end up waiting for one to become resources.
-				until resource = available_resource
-					@available.wait
-				end
-				
-				Async.logger.debug(self) {"Wait for resource #{resource}"}
-				
-				if resource.multiplex
-					@available.signal
-				end
-				
-				return resource
-			end
-			
-			def create
-				# This might return nil, which means creating the resource failed.
-				if resource = @constructor.call
-					@resources[resource] = 1
-				end
-				
-				return resource
-			end
-			
-			def available_resource
-				# TODO This is a linear search... not ideal, but simple for now.
-				@resources.each do |resource, count|
-					if count < resource.multiplex
-						# We want to use this resource... but is it connected?
-						if resource.connected?
-							@resources[resource] += 1
-							
-							return resource
-						else
-							retire(resource)
-						end
-					end
-				end
-				
-				@guard.acquire do
-					if @limit.nil? or self.active < @limit
-						Async.logger.debug(self) {"No resources resources, allocating new one..."}
-						
-						return create
-					end
-				end
-				
-				return nil
-			end
-		end
-	end
-end