async-rest 0.12.3 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc914b22fd6a8a19da71676f835e23a606b8c9e6ebd981f25b17b9452422a791
-  data.tar.gz: d639c6647805c99501b9849ee4ebdc3a1650279b93b5053f00af513cb75c2e6b
+  metadata.gz: 6a36f4148f0e9f165370b96bd494036289b5b1d669a4218c5823ffc3e7d90dfb
+  data.tar.gz: 93a3b829c129a26172d612f7e0f5c606132d9bd1cdc864e809eb09ce81f2c170
 SHA512:
-  metadata.gz: 2fe066c918388cd94e92ba167f0910fd189991abb14565172946f74f9d8af3f24f66c18cef586a0b41a87d19c036af08da227404954f5619c313b1273fe64025
-  data.tar.gz: fe5226f20eb31178830ff77f37df8d03c0d3f66c0edc098ed700fcf7f394fee9ba4452cca6190e21c153390915227df23d7e29017e506f9c18f7e19000be33f5
+  metadata.gz: be6940b7aa4f462a888d1c2c4171f1c0d9501033d3a7aea7cdf7dfb79b4b2b14232badbc8f66ca73dd7432de710b1e5ab06f805284e204d612e71e4489cb8eba
+  data.tar.gz: d964f6876354324a8e8200ee4c9ea2320a6aa6254cbfba996e872a5f4e259e3eaa6ab657459b51058defcf01227eb3ad456ddd1c053eddea84b9e56ee280e1ac

data/lib/async/rest/error.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2019-2023, by Samuel Williams.
 
 module Async
 	module REST

data/lib/async/rest/representation.rb

@@ -1,24 +1,8 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2021, by Terry Kerr.
 
 require_relative 'error'
 require_relative 'resource'
@@ -26,51 +10,59 @@ require_relative 'wrapper/json'
 
 module Async
 	module REST
+		# A representation of a resource has a value at the time the representation was created or fetched. It is usually generated by performing an HTTP request.
+		#
 		# REST components perform actions on a resource by using a representation to capture the current or intended state of that resource and transferring that representation between components. A representation is a sequence of bytes, plus representation metadata to describe those bytes. Other commonly used but less precise names for a representation include: document, file, and HTTP message entity, instance, or variant.
 		# 
 		# A representation consists of data, metadata describing the data, and, on occasion, metadata to describe the metadata (usually for the purpose of verifying message integrity). Metadata is in the form of name-value pairs, where the name corresponds to a standard that defines the value's structure and semantics. Response messages may include both representation metadata and resource metadata: information about the resource that is not specific to the supplied representation.
 		class Representation
+			WRAPPER = Wrapper::JSON.new
+			
 			def self.[] wrapper
 				klass = Class.new(self)
 				
+				if wrapper.is_a?(Class)
+					wrapper = wrapper.new
+				end
+				
 				klass.const_set(:WRAPPER, wrapper)
 				
 				return klass
 			end
 			
-			def self.for(*arguments, **options)
-				representation = self.new(Resource.for(*arguments), **options)
-				
-				return representation unless block_given?
-				
-				Async do
-					begin
-						yield representation
-					ensure
-						representation.close
+			class << self
+				::Protocol::HTTP::Methods.each do |name, verb|
+					define_method(verb.downcase) do |resource, payload = nil, &block|
+						self::WRAPPER.call(resource, verb, payload) do |response|
+							return self.for(resource, response, &block)
+						end
 					end
 				end
 			end
 			
-			WRAPPER = Wrapper::JSON
+			def self.for(resource, response, &block)
+				if block_given?
+					block.call(response)
+				end
+				
+				return self.new(resource, value: response.read, metadata: response.headers)
+			end
 			
 			# @param resource [Resource] the RESTful resource that this representation is of.
-			# @param metadata [Hash | HTTP::Headers] the metadata associated wtih teh representation.
+			# @param metadata [Hash | HTTP::Headers] the metadata associated with the representation.
 			# @param value [Object] the value of the representation.
-			# @param wrapper [#prepare_request, #process_response] the wrapper for encoding/decoding the request/response body.
-			def initialize(resource, metadata: {}, value: nil, wrapper: self.class::WRAPPER.new)
+			def initialize(resource, value: nil, metadata: {})
 				@resource = resource
-				@wrapper = wrapper
 				
-				@metadata = metadata
 				@value = value
+				@metadata = metadata
 			end
 			
 			def with(klass = nil, **options)
 				if klass
-					klass.new(@resource.with(**options), wrapper: klass::WRAPPER.new)
+					klass.new(@resource.with(**options))
 				else
-					self.new(@resource.with(**options), wrapper: @wrapper)
+					self.class.new(@resource.with(**options))
 				end
 			end
 			
@@ -83,46 +75,16 @@ module Async
 			end
 			
 			attr :resource
-			attr :wrapper
-			
-			def prepare_request(verb, payload)
-				@resource.prepare_request(verb, payload, &@wrapper.method(:prepare_request))
-			end
-			
-			# If an exception propagates out of this method, the response will be closed.
-			def process_response(request, response)
-				@wrapper.process_response(request, response)
-			end
-			
-			::Protocol::HTTP::Methods.each do |name, verb|
-				# TODO when Ruby 3.0 lands, convert this to |payload = nil, **parameters|
-				# Blocked by https://bugs.ruby-lang.org/issues/14183
-				define_method(verb.downcase) do |payload = nil|
-					request = prepare_request(verb, payload)
-					
-					response = @resource.call(request)
-					
-					# If we exit this block because of an exception, we close the response. This ensures we don't have any dangling connections.
-					begin
-						return process_response(request, response)
-					rescue
-						response.close
-						
-						raise
-					end
-				end
-			end
-			
 			attr :metadata
 			
-			def value!
-				response = self.get
-				
-				if response.success?
-					@metadata = response.headers
-					@value = response.read
-				else
-					raise ResponseError, response
+			private def get
+				self.class::WRAPPER.call(@resource) do |response|
+					if response.success?
+						@metadata = response.headers
+						@value = response.read
+					else
+						raise ResponseError, response
+					end
 				end
 			end
 			
@@ -131,35 +93,38 @@ module Async
 			end
 			
 			def value
-				@value ||= value!
+				@value ||= self.get
 			end
 			
-			def value= value
-				@value = self.assign(value)
-			end
-			
-			def call(value)
-				if value
-					self.post(value)
-				else
-					self.delete
+			# Provides a way to mutate the value of the representation.
+			module Mutable
+				def value= value
+					@value = self.assign(value)
 				end
-			end
-			
-			def assign(value)
-				response = self.call(value)
 				
-				response.read
+				def call(value)
+					if value
+						self.post(value)
+					else
+						self.delete
+					end
+				end
 				
-				return @value
-			end
-			
-			def update
-				@value = assign(@value)
+				def assign(value)
+					response = self.call(value)
+					
+					response.read
+					
+					return @value
+				end
+				
+				def update
+					@value = assign(@value)
+				end
 			end
 			
 			def inspect
-				"\#<#{self.class} #{@resource.inspect}: value=#{@value.inspect}>"
+				"\#<#{self.class} #{@resource.inspect} value=#{@value.inspect}>"
 			end
 		end
 	end

data/lib/async/rest/resource.rb

@@ -1,22 +1,7 @@
-# Copyright, 2018, 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.
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 require 'async'
 require 'async/http/client'
@@ -27,75 +12,62 @@ require 'protocol/http/reference'
 
 module Async
 	module REST
+		# A resource is an abstract reference to some named entity, typically a URL with associated metatadata. Generally, your entry to any web service will be a resource, and that resource will create zero or more representations as you navigate through the service.
+		#
 		# The key abstraction of information in REST is a resource. Any information that can be named can be a resource: a document or image, a temporal service (e.g. "today's weather in Los Angeles"), a collection of other resources, a non-virtual object (e.g. a person), and so on. In other words, any concept that might be the target of an author's hypertext reference must fit within the definition of a resource. A resource is a conceptual mapping to a set of entities, not the entity that corresponds to the mapping at any particular point in time.
 		class Resource < ::Protocol::HTTP::Middleware
-			# @param delegate [Async::HTTP::Middleware] the delegate that will handle requests.
-			# @param reference [::Protocol::HTTP::Reference] the resource identifier (base request path/parameters).
-			# @param headers [::Protocol::HTTP::Headers] the default headers that will be supplied with the request.
-			def initialize(delegate, reference = ::Protocol::HTTP::Reference.parse, headers = ::Protocol::HTTP::Headers.new)
-				super(delegate)
-				
-				@reference = reference
-				@headers = headers
-			end
+			ENDPOINT = nil
 			
-			# @param endpoint [Async::HTTP::Endpoint] used to connect to the remote system and specify the base path.
+			# Connect to the given endpoint, returning the HTTP client and reference.
+			# @parameter endpoint [Async::HTTP::Endpoint] used to connect to the remote system and specify the base path.
+			# @returns [Tuple(Async::HTTP::Client, ::Protocol::HTTP::Reference)] the client and reference.
 			def self.connect(endpoint)
 				reference = ::Protocol::HTTP::Reference.parse(endpoint.path)
 				
 				return ::Protocol::HTTP::AcceptEncoding.new(HTTP::Client.new(endpoint)), reference
 			end
 			
-			def self.for(endpoint, *arguments)
-				# TODO This behaviour is deprecated and will probably be removed.
-				if endpoint.is_a? String
-					endpoint = HTTP::Endpoint.parse(endpoint)
+			# Create a new resource for the given endpoint.
+			def self.open(endpoint = self::ENDPOINT, **options)
+				if endpoint.is_a?(String)
+					endpoint = Async::HTTP::Endpoint.parse(endpoint)
 				end
 				
 				client, reference = connect(endpoint)
 				
-				resource = self.new(client, reference, *arguments)
+				resource = self.new(client, reference, **options)
 				
 				return resource unless block_given?
 				
-				Async do
-					begin
-						yield resource
-					ensure
-						resource.close
-					end
+				Sync do
+					yield resource
+				ensure
+					resource.close
 				end
 			end
 			
-			attr :reference
-			attr :headers
-			
-			def self.with(parent, *arguments, headers: {}, **options)
+			def self.with(parent, headers: {}, **options)
 				reference = parent.reference.with(**options)
+				headers = parent.headers.merge(headers)
 				
-				self.new(*arguments, parent.delegate, reference, parent.headers.merge(headers))
+				self.new(parent.delegate, reference, headers)
 			end
 			
-			def with(*arguments, **options)
-				self.class.with(self, *arguments, **options)
+			# @parameter delegate [Async::HTTP::Middleware] the delegate that will handle requests.
+			# @parameter reference [::Protocol::HTTP::Reference] the resource identifier (base request path/parameters).
+			# @parameter headers [::Protocol::HTTP::Headers] the default headers that will be supplied with the request.
+			def initialize(delegate, reference = ::Protocol::HTTP::Reference.parse, headers = ::Protocol::HTTP::Headers.new)
+				super(delegate)
+				
+				@reference = reference
+				@headers = headers
 			end
 			
-			def get(klass = Representation, **parameters)
-				klass.new(self.with(parameters: parameters)).tap(&:value)
-			end
+			attr :reference
+			attr :headers
 			
-			# @param verb [String] the HTTP verb to use.
-			# @param payload [Object] the object which will used to generate the body of the request.
-			def prepare_request(verb, payload)
-				if payload
-					headers = @headers.dup
-					body = yield payload, headers
-				else
-					headers = @headers
-					body = nil
-				end
-				
-				return ::Protocol::HTTP::Request[verb, @reference, headers, body]
+			def with(**options)
+				self.class.with(self, **options)
 			end
 			
 			def inspect
@@ -105,6 +77,13 @@ module Async
 			def to_s
 				"\#<#{self.class} #{@reference.to_s}>"
 			end
+			
+			def call(request)
+				request.path = @reference.with(path: request.path).to_s
+				request.headers = @headers.merge(request.headers)
+				
+				super
+			end
 		end
 	end
 end

data/lib/async/rest/version.rb

@@ -1,27 +1,10 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 module Async
 	module REST
-		VERSION = "0.12.3"
+		VERSION = "0.13.0"
 	end
 end

data/lib/async/rest/wrapper/form.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2019-2023, by Samuel Williams.
 
 require_relative 'json'
 require_relative 'url_encoded'
@@ -36,15 +19,15 @@ module Async
 					@content_types = content_types
 				end
 				
-				def prepare_request(payload, headers)
+				def prepare_request(request, payload)
 					@content_types.each_key do |key|
-						headers.add('accept', key)
+						request.headers.add('accept', key)
 					end
 					
 					if payload
-						headers['content-type'] = URLEncoded::APPLICATION_FORM_URLENCODED
+						request.headers['content-type'] = URLEncoded::APPLICATION_FORM_URLENCODED
 						
-						::Protocol::HTTP::Body::Buffered.new([
+						request.body = ::Protocol::HTTP::Body::Buffered.new([
 							::Protocol::HTTP::URL.encode(payload)
 						])
 					end

data/lib/async/rest/wrapper/generic.rb

@@ -1,33 +1,35 @@
 # frozen_string_literal: true
 
-# Copyright, 2019, 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.
+# Released under the MIT License.
+# Copyright, 2019-2023, by Samuel Williams.
 
 module Async
 	module REST
 		module Wrapper
 			class Generic
+				def call(resource, verb = "GET", payload = nil, &block)
+					request = ::Protocol::HTTP::Request[verb, nil]
+					self.prepare_request(request, payload)
+					
+					response = resource.call(request)
+					
+					# If we exit this block because of an exception, we close the response. This ensures we don't have any dangling connections.
+					begin
+						self.process_response(request, response)
+						
+						yield response
+					rescue
+						response.close
+						
+						raise
+					end
+				end
+				
 				# @param payload [Object] a request payload to send.
 				# @param headers [Protocol::HTTP::Headers] the mutable HTTP headers for the request.
 				# @return [Body | nil] an optional request body based on the given payload.
-				def prepare_request(payload, headers)
+				def prepare_request(request, payload)
+					request.body = ::Protocol::HTTP::Body::Buffered.wrap(payload)
 				end
 				
 				# @param request [Protocol::HTTP::Request] the request that was made.

data/lib/async/rest/wrapper/json.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 require 'json'
 
@@ -44,13 +27,13 @@ module Async
 					@content_type.split
 				end
 				
-				def prepare_request(payload, headers)
-					headers['accept'] ||= @content_type
+				def prepare_request(request, payload)
+					request.headers['accept'] ||= @content_type
 					
 					if payload
-						headers['content-type'] = @content_type
+						request.headers['content-type'] = @content_type
 						
-						HTTP::Body::Buffered.new([
+						request.body = HTTP::Body::Buffered.new([
 							::JSON.dump(payload)
 						])
 					end

data/lib/async/rest/wrapper/url_encoded.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2019-2023, by Samuel Williams.
 
 require 'json'
 
@@ -43,13 +26,13 @@ module Async
 					@content_type.split
 				end
 				
-				def prepare_request(payload, headers)
-					headers['accept'] ||= @content_type
+				def prepare_request(request, payload)
+					request.headers['accept'] ||= @content_type
 					
 					if payload
-						headers['content-type'] = @content_type
+						request.headers['content-type'] = @content_type
 						
-						::Protocol::HTTP::Body::Buffered.new([
+						request.body = ::Protocol::HTTP::Body::Buffered.new([
 							::Protocol::HTTP::URL.encode(payload)
 						])
 					end

data/lib/async/rest.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright, 2018, 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.
+# Released under the MIT License.
+# Copyright, 2018-2023, by Samuel Williams.
 
 require_relative 'rest/version'
 require_relative 'rest/representation'

data/license.md

@@ -0,0 +1,24 @@
+# MIT License
+
+Copyright, 2018-2024, by Samuel Williams.  
+Copyright, 2019, by Cyril Roelandt.  
+Copyright, 2020-2021, by Olle Jonsson.  
+Copyright, 2021, by Terry Kerr.  
+
+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.

data/readme.md

@@ -0,0 +1,34 @@
+# Async::REST
+
+Roy Thomas Fielding's thesis [Architectural Styles and the Design of Network-based Software Architectures](https://www.ics.uci.edu/~fielding/pubs/dissertation/top.htm) describes [Representational State Transfer](https://www.ics.uci.edu/~fielding/pubs/dissertation/rest_arch_style.htm) which comprises several core concepts:
+
+  - `Resource`: A conceptual mapping to one or more entities.
+  - `Representation`: An instance of a resource at a given point in time.
+
+This gem models these abstractions as closely and practically as possible and serves as a basis for building asynchronous web clients.
+
+[![Development Status](https://github.com/socketry/async-rest/workflows/Test/badge.svg)](https://github.com/socketry/async-rest/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/async-rest/) for more details.
+
+  - [Getting Started](https://socketry.github.io/async-rest/guides/getting-started/index) - This guide explains the design of the `async-rest` gem and how to use it to access RESTful APIs.
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+This project uses the [Developer Certificate of Origin](https://developercertificate.org/). All contributors to this project must agree to this document to have their contributions accepted.
+
+### Contributor Covenant
+
+This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.

metadata

@@ -1,14 +1,46 @@
 --- !ruby/object:Gem::Specification
 name: async-rest
 version: !ruby/object:Gem::Version
-  version: 0.12.3
+  version: 0.13.0
 platform: ruby
 authors:
 - Samuel Williams
+- Olle Jonsson
+- Cyril Roelandt
+- Terry Kerr
 autorequire:
 bindir: bin
-cert_chain: []
-date: 2021-05-11 00:00:00.000000000 Z
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 2024-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -38,76 +70,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.7'
-- !ruby/object:Gem::Dependency
-  name: async-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: bundler
-  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: covered
-  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: rake
-  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
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.6'
 description:
 email:
 executables: []
@@ -123,10 +85,14 @@ files:
 - lib/async/rest/wrapper/generic.rb
 - lib/async/rest/wrapper/json.rb
 - lib/async/rest/wrapper/url_encoded.rb
+- license.md
+- readme.md
 homepage: https://github.com/socketry/async-rest
 licenses:
 - MIT
-metadata: {}
+metadata:
+  documentation_uri: https://socketry.github.io/async-rest/
+  source_code_uri: https://github.com/socketry/async-rest.git
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -135,14 +101,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.0.dev
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A library for RESTful clients (and hopefully servers).

metadata.gz.sig

@@ -0,0 +1,2 @@
+N�*&�������v\�2�)�iHD+�@o�h����CNN"
��>��Y��}�uc0�h}�8�Gd�_H�P���Yg�d�	\ԍ����ԡ�}�����P+}�c���w��镮�K��|��wg9��tJ��|�d��?\g^,�E�휑&��*��x[�I�������%��3*(9�Y���v�c�X�:�X�D�"�v�:�G�
+�