async-rest 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e7750b0f06535c7c980e2774a768b5c2b2617959964965adeb3dfbcced0e76f0
-  data.tar.gz: ff05ab03fe24812120d5c3d1a50e0a029c641c7338c6ad413fa5cd8be0fe8b6d
+  metadata.gz: 2a25bf93c109edc39f017bd8897b6f40cd588f9d09cd49ab0c121019a1aeb581
+  data.tar.gz: 29ada9fd6af46ba978cf89a24b7741ce94bcb779c0f1beaf87c174b33a98cd63
 SHA512:
-  metadata.gz: 2416bb4bebe3af462c90b42f94d4a3a20e73f3d3faac9ef2c8b69ff40175aa16601fb84f2807d76d48ecfa068d1538a35f2deeac0de8cc7691012390c7273f52
-  data.tar.gz: 22c58ca1c2e508f6199ab41fc7e8c6072267b7aef1f644f94545769e0fc1fe90541f95e95d1e3cd165a50e34309b0c09920779f996a8625007d25d59150e04b3
+  metadata.gz: d9667632e07ff0d8a72c26eb1cdf68f9f765b390cddbf604402b67f79e70cb493860d172dd25eab00dd3c2934f5f69ddfbdb6fe14e5585845420bff0cd84bf02
+  data.tar.gz: 01c2a95426350e1b53dbc477176f9c6e75f0d244974c8308c6244678524cf5f3a67f797f2acf3ab3b835806caeeea9f9b1c0026e2996e551df773990b7aa072e

data/lib/async/rest/representation.rb

@@ -1,12 +1,12 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 # Copyright, 2021, by Terry Kerr.
 
-require_relative 'error'
-require_relative 'resource'
-require_relative 'wrapper/json'
+require_relative "error"
+require_relative "resource"
+require_relative "wrapper/json"
 
 module Async
 	module REST
@@ -31,21 +31,32 @@ module Async
 			end
 			
 			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|
+				::Protocol::HTTP::Methods.each do |name, method|
+					define_method(method.downcase) do |resource, payload = nil, &block|
+						self::WRAPPER.call(resource, method, payload) do |response|
 							return self.for(resource, response, &block)
 						end
 					end
 				end
 			end
 			
+			# Instantiate a new representation from a resource and response.
+			#
+			# If a block is given, it is called with the resource and response, and the return value is used as the representation.
+			#
+			# @returns [Representation] the representation of the resource.
 			def self.for(resource, response, &block)
 				if block_given?
-					block.call(response)
+					if block.arity == 1
+						# Original behaviour:
+						yield(response)
+					else
+						# New behaviour:
+						return yield(resource, response)
+					end
+				else
+					return self.new(resource, value: response.read, metadata: response.headers)
 				end
-				
-				return self.new(resource, value: response.read, metadata: response.headers)
 			end
 			
 			# @param resource [Resource] the RESTful resource that this representation is of.

data/lib/async/rest/resource.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
-require 'async'
-require 'async/http/client'
-require 'async/http/endpoint'
+require "async"
+require "async/http/client"
+require "async/http/endpoint"
 
-require 'protocol/http/accept_encoding'
-require 'protocol/http/reference'
+require "protocol/http/accept_encoding"
+require "protocol/http/reference"
 
 module Async
 	module REST

data/lib/async/rest/version.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
 module Async
 	module REST
-		VERSION = "0.14.0"
+		VERSION = "0.15.0"
 	end
 end

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

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require_relative 'json'
-require_relative 'url_encoded'
+require_relative "json"
+require_relative "url_encoded"
 
 module Async
 	module REST
@@ -21,11 +21,11 @@ module Async
 				
 				def prepare_request(request, payload)
 					@content_types.each_key do |key|
-						request.headers.add('accept', key)
+						request.headers.add("accept", key)
 					end
 					
 					if payload
-						request.headers['content-type'] = URLEncoded::APPLICATION_FORM_URLENCODED
+						request.headers["content-type"] = URLEncoded::APPLICATION_FORM_URLENCODED
 						
 						request.body = ::Protocol::HTTP::Body::Buffered.new([
 							::Protocol::HTTP::URL.encode(payload)
@@ -34,7 +34,7 @@ module Async
 				end
 				
 				def parser_for(response)
-					if content_type = response.headers['content-type']
+					if content_type = response.headers["content-type"]
 						if parser = @content_types[content_type]
 							return parser
 						end

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
 module Async
 	module REST

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
-require 'json'
+require "json"
 
-require 'protocol/http/body/wrapper'
-require 'protocol/http/body/buffered'
+require "protocol/http/body/wrapper"
+require "protocol/http/body/buffered"
 
-require_relative 'generic'
+require_relative "generic"
 
 module Async
 	module REST
@@ -28,10 +28,10 @@ module Async
 				end
 				
 				def prepare_request(request, payload)
-					request.headers['accept'] ||= @content_type
+					request.headers["accept"] ||= @content_type
 					
 					if payload
-						request.headers['content-type'] = @content_type
+						request.headers["content-type"] = @content_type
 						
 						request.body = ::Protocol::HTTP::Body::Buffered.new([
 							::JSON.dump(payload)
@@ -46,7 +46,7 @@ module Async
 				end
 				
 				def parser_for(response)
-					if content_type = response.headers['content-type']
+					if content_type = response.headers["content-type"]
 						if content_type.start_with? @content_type
 							return Parser
 						end

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

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2023, by Samuel Williams.
+# Copyright, 2019-2024, by Samuel Williams.
 
-require 'json'
+require "json"
 
-require 'protocol/http/body/wrapper'
-require 'protocol/http/body/buffered'
+require "protocol/http/body/wrapper"
+require "protocol/http/body/buffered"
 
-require_relative 'generic'
+require_relative "generic"
 
 module Async
 	module REST
@@ -27,10 +27,10 @@ module Async
 				end
 				
 				def prepare_request(request, payload)
-					request.headers['accept'] ||= @content_type
+					request.headers["accept"] ||= @content_type
 					
 					if payload
-						request.headers['content-type'] = @content_type
+						request.headers["content-type"] = @content_type
 						
 						request.body = ::Protocol::HTTP::Body::Buffered.new([
 							::Protocol::HTTP::URL.encode(payload)
@@ -45,7 +45,7 @@ module Async
 				end
 				
 				def parser_for(response)
-					if content_type = response.headers['content-type']
+					if content_type = response.headers["content-type"]
 						if content_type.start_with? @content_type
 							return Parser
 						end

data/lib/async/rest.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2023, by Samuel Williams.
+# Copyright, 2018-2024, by Samuel Williams.
 
-require_relative 'rest/version'
-require_relative 'rest/representation'
+require_relative "rest/version"
+require_relative "rest/representation"

data/readme.md

@@ -27,8 +27,8 @@ We welcome contributions to this project.
 
 ### 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.
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
 
-### Contributor Covenant
+### Community Guidelines
 
-This project is governed by the [Contributor Covenant](https://www.contributor-covenant.org/). All contributors and participants agree to abide by its terms.
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: async-rest
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-09-10 00:00:00.000000000 Z
+date: 2024-09-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http