async-rest 0.19.1 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae3aeb21790cedb9bbbe38afbf40b3d5990b28cb1a6eaf076495fab5a25a77e1
-  data.tar.gz: 4c8fd49d8c4be1fe367f62fe50231f527ad9fb440a8533d40e34e4bd15fe5c60
+  metadata.gz: cea32789d5d2ec88da49bb30446fa3296485091225741be2491d30455008888f
+  data.tar.gz: 89e35b8658d1dd55ffeb3f47cb2479bb49315108c142eec0c62ec29e70767984
 SHA512:
-  metadata.gz: cf1569c2fb59d7e216d3e677504e2b846cd3d47bf3411d55c5027c8cfb26334d3946996bb2e2c9e0180b2b040d543a6fa806a4af6e7952888387cce2f80b1dc2
-  data.tar.gz: 1fe580a38cc6a60d43943eb64ff28efddf32e3399b43c371fafeb7e6f6d39263bf66c45c2148742eaf628bfa5a6f123933859b2052f87b23c4e2e3b259a32737
+  metadata.gz: d8f2e5496baaf8aef8f021543bd0539d4b0c2f42b3d0043475e9320cd0fc6482ad4fc00cda51be13a4cda69324985268474fd9bcc538bf4048ec7a12631648a1
+  data.tar.gz: 8fae801bb41b7e40e96583bceb43d724fdb26d6de0091b4e9cef121e7c7fa4aa8cfc6081d38ac4d3c42683001f788c887af3868a206997dff4b078c5c67321b6

checksums.yaml.gz.sig

@@ -1 +1,5 @@
-4`��ٍ
t��z�pged�Y�k\�K$bXr�������v0���V��Mb�B�jV˄l*[ǐ�o�=WI�TZY����P�=.���7�����E���`�M��odc��բ7)i��	^��y����i��`�ħF۔©�*\�&C^'9�W�P骽�뺌��]5���DZe
�)�CI��)�i�����_���ٳ��#��B�\[AV�:�(�LJ�l��e*�V�:�/��%V?�O4fj����p�����k�JZ���'`��k2�,�<!��I�׋�yH������*{Y�]Z
��A�<7� �~��kf��(��}�����Ѕ�Ȭ�=��+����OW�h��s�h�#_�i���щ�F�؍^����<
+{i�(ΗD]y-�N&s�����+��<�ωw�0�>����A�jq�v—��������䔏�s�`5����K
+�Hm�gC|�4F�-w'�~�ߺO�Sy�ƕ�%B���|l���h�
+,E�"�\���Cŋ�^
+ݙ.��I"�0���fZ�^�t����w���]ղ���덥����=‰za���uH(��wy�e�p���/`������u���?��Ĭ?�A4�~n���+�㐠'�P-��ET�'�p�;� z']�@�c֋�GH
+��;O*Y'��	��4�)��

data/context/getting-started.md

@@ -0,0 +1,61 @@
+# Getting Started
+
+This guide explains the design of the `async-rest` gem and how to use it to access RESTful APIs.
+
+## Installation
+
+Add the gem to your project:
+
+``` shell
+$ bundle add async-rest
+```
+
+## Core Concepts
+
+The `async-rest` gem has two core concepts:
+
+- A {ruby Async::REST::Resource} instance represents a specific resource and a delegate (HTTP connection) for accessing that resource.
+- A {ruby Async::REST::Representation} instance represents a specific representation of a resource - usually a specific request to a URL that returns a response with a given content type.
+
+Just as a webpage has hyperlinks, forms and buttons for connecting information and performing actions, a representation may also carry associated links to actions that can be performed on a resource. However, many services define a fixed set of actions that can be performed on a given resource using a schema. As such, the `async-rest` gem does not have a standard mechanism for discovering actions on a resource at runtime (or follow a design that requires this).
+
+## Usage
+
+Generally speaking, you should model your interface around representations. Each representation should be a subclass of {ruby Async::REST::Representation} and define methods that represent the actions that can be performed on that resource.
+
+```ruby
+require "async/rest"
+
+module DNS
+	class Query < Async::REST::Representation[Async::REST::Wrapper::JSON]
+		def question
+			value[:Question]
+		end
+		
+		def answer
+			value[:Answer]
+		end
+	end
+	
+	class Client < Async::REST::Resource
+		# This is the default endpoint to use unless otherwise specified:
+		ENDPOINT = Async::HTTP::Endpoint.parse("https://dns.google/resolve")
+		
+		# Resolve a DNS query.
+		def resolve(name, type)
+			Query.get(self.with(parameters: { name: name, type: type }))
+		end
+	end
+end
+
+DNS::Client.open do |client|
+	query = client.resolve("example.com", "AAAA")
+	
+	puts query.question
+	# {:name=>"example.com.", :type=>28}
+	puts query.answer
+	# {:name=>"example.com.", :type=>28, :TTL=>13108, :data=>"2606:2800:220:1:248:1893:25c8:1946"}
+end
+```
+
+It should be noted that the above client is not a representation, but a resource. That is because `https://dns.google.com/resolve` is a fixed endpoint that does not have a schema for discovering actions at runtime. The `resolve` method is a convenience method that creates a new representation and performs a GET request to the endpoint.

data/context/index.yaml

@@ -0,0 +1,12 @@
+# Automatically generated context index for Utopia::Project guides.
+# Do not edit then files in this directory directly, instead edit the guides and then run `bake utopia:project:agent:context:update`.
+---
+description: A library for RESTful clients (and hopefully servers).
+metadata:
+  documentation_uri: https://socketry.github.io/async-rest/
+  source_code_uri: https://github.com/socketry/async-rest.git
+files:
+- path: getting-started.md
+  title: Getting Started
+  description: This guide explains the design of the `async-rest` gem and how to use
+    it to access RESTful APIs.

data/lib/async/rest/resource.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2018-2024, by Samuel Williams.
+# Copyright, 2018-2025, by Samuel Williams.
 
 require "async"
 require "async/http/client"
 require "async/http/endpoint"
 
 require "protocol/http/accept_encoding"
-require "protocol/http/reference"
+require "protocol/url/reference"
 
 module Async
 	module REST
@@ -20,9 +20,9 @@ module Async
 			
 			# 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.
+			# @returns [Tuple(Async::HTTP::Client, ::Protocol::URL::Reference)] the client and reference.
 			def self.connect(endpoint)
-				reference = ::Protocol::HTTP::Reference.parse(endpoint.path)
+				reference = ::Protocol::URL::Reference.parse(endpoint.path)
 				
 				return ::Protocol::HTTP::AcceptEncoding.new(HTTP::Client.new(endpoint)), reference
 			end
@@ -54,9 +54,9 @@ module Async
 			end
 			
 			# @parameter delegate [Async::HTTP::Middleware] the delegate that will handle requests.
-			# @parameter reference [::Protocol::HTTP::Reference] the resource identifier (base request path/parameters).
+			# @parameter reference [::Protocol::URL::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)
+			def initialize(delegate, reference = ::Protocol::URL::Reference.parse, headers = ::Protocol::HTTP::Headers.new)
 				super(delegate)
 				
 				@reference = reference

data/lib/async/rest/version.rb

@@ -5,6 +5,6 @@
 
 module Async
 	module REST
-		VERSION = "0.19.1"
+		VERSION = "0.20.0"
 	end
 end

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
+# Copyright, 2025, by Ayush Newatia.
 
 require_relative "json"
 require_relative "url_encoded"
@@ -28,16 +29,15 @@ module Async
 						request.headers["content-type"] = URLEncoded::APPLICATION_FORM_URLENCODED
 						
 						request.body = ::Protocol::HTTP::Body::Buffered.new([
-							::Protocol::HTTP::URL.encode(payload)
+							::Protocol::URL::Encoding.encode(payload)
 						])
 					end
 				end
 				
 				def parser_for(response)
-					if content_type = response.headers["content-type"]
-						if parser = @content_types[content_type]
-							return parser
-						end
+					media_type, _ = response.headers["content-type"].split(";")
+					if media_type && parser = @content_types[media_type]
+						return parser
 					end
 					
 					return super

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 # Released under the MIT License.
-# Copyright, 2019-2024, by Samuel Williams.
+# Copyright, 2019-2025, by Samuel Williams.
 
 require "json"
 
@@ -33,14 +33,14 @@ module Async
 						request.headers["content-type"] = @content_type
 						
 						request.body = ::Protocol::HTTP::Body::Buffered.new([
-							::Protocol::HTTP::URL.encode(payload)
+							::Protocol::URL::Encoding.encode(payload)
 						])
 					end
 				end
 				
 				class Parser < ::Protocol::HTTP::Body::Wrapper
 					def join
-						::Protocol::HTTP::URL.decode(super, symbolize_keys: true)
+						::Protocol::URL::Encoding.decode(super, symbolize_keys: true)
 					end
 				end
 				

data/lib/async/rest/wrapper.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "wrapper/form"
+require_relative "wrapper/json"
+require_relative "wrapper/url_encoded"

data/lib/async/rest.rb

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

data/license.md

@@ -1,9 +1,10 @@
 # MIT License
 
-Copyright, 2018-2024, by Samuel Williams.  
+Copyright, 2018-2025, by Samuel Williams.  
 Copyright, 2019, by Cyril Roelandt.  
 Copyright, 2020-2021, by Olle Jonsson.  
 Copyright, 2021, by Terry Kerr.  
+Copyright, 2025, by Ayush Newatia.  
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/readme.md

@@ -15,6 +15,57 @@ Please see the [project documentation](https://socketry.github.io/async-rest/) f
 
   - [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.
 
+## Releases
+
+Please see the [project releases](https://socketry.github.io/async-rest/releases/index) for all releases.
+
+### v0.20.0
+
+  - Migrated to `protocol-url` gem for URL handling.
+  - Ensured instances are properly closed after use to prevent resource leaks.
+  - All wrappers are now required by default from main `async/rest.rb` entry point.
+  - Fixed logic to correctly parse JSON responses in `Form` wrapper.
+
+### v0.19.1
+
+  - Fixed `retry-after` header handling to treat it as a single value header.
+
+### v0.19.0
+
+  - Added support for standard `retry-after` rate limiting.
+  - Improved response body handling to only replace the body if a parser is found.
+
+### v0.18.0
+
+  - Minor improvements and fixes to `Mutable`.
+
+### v0.17.0
+
+  - Bug fixes and minor improvements.
+
+### v0.16.0
+
+  - Removed legacy behaviour for cleaner implementation.
+
+### v0.15.0
+
+  - `Representation.for` can now take a block and return a custom representation.
+  - Renamed methods to prefer `method` rather than `verb` for HTTP operations.
+
+### v0.14.0
+
+  - Fixed constant names.
+  - Removed unused and legacy requires.
+
+### v0.13.0
+
+  - Better support for streaming responses.
+  - Simplified interface for resources and representations.
+
+### v0.12.4
+
+  - Fixed `self.new` to use `self.class.new` for proper subclass instantiation.
+
 ## See Also
 
   - [async-ollama](https://github.com/socketry/async-ollama) - A client for Ollama, a local large language model server.

data/releases.md

@@ -0,0 +1,146 @@
+# Releases
+
+## v0.20.0
+
+  - Migrated to `protocol-url` gem for URL handling.
+  - Ensured instances are properly closed after use to prevent resource leaks.
+  - All wrappers are now required by default from main `async/rest.rb` entry point.
+  - Fixed logic to correctly parse JSON responses in `Form` wrapper.
+
+## v0.19.1
+
+  - Fixed `retry-after` header handling to treat it as a single value header.
+
+## v0.19.0
+
+  - Added support for standard `retry-after` rate limiting.
+  - Improved response body handling to only replace the body if a parser is found.
+
+## v0.18.0
+
+  - Minor improvements and fixes to `Mutable`.
+
+## v0.17.0
+
+  - Bug fixes and minor improvements.
+
+## v0.16.0
+
+  - Removed legacy behaviour for cleaner implementation.
+
+## v0.15.0
+
+  - `Representation.for` can now take a block and return a custom representation.
+  - Renamed methods to prefer `method` rather than `verb` for HTTP operations.
+
+## v0.14.0
+
+  - Fixed constant names.
+  - Removed unused and legacy requires.
+
+## v0.13.0
+
+  - Better support for streaming responses.
+  - Simplified interface for resources and representations.
+
+## v0.12.4
+
+  - Fixed `self.new` to use `self.class.new` for proper subclass instantiation.
+
+## v0.12.3
+
+  - Ensured correct wrapper class is used when making derived representations.
+  - Improved argument handling with `*arguments` syntax.
+
+## v0.12.2
+
+  - Fixed adding composite headers.
+
+## v0.12.1
+
+  - Improved error handling to raise a response error if the response was non-200 status.
+  - Better overall error handling throughout the library.
+
+## v0.12.0
+
+  - Added `Form` wrapper which behaves like a standard HTML form.
+  - Improved error handling.
+  - Added GitHub feed example.
+  - Added example showing multiple simultaneous requests.
+  - Added example for scraping HTML programmatically.
+
+## v0.10.1
+
+  - Ensured response is closed if it causes an exception.
+
+## v0.10.0
+
+  - Renamed `url` parameter to `endpoint` for clarity (with backwards compatibility).
+
+## v0.9.0
+
+  - Simplified handling of wrapped responses.
+  - Improved consistency and flexibility of `Representation`.
+  - Added path computation checks.
+
+## v0.8.2
+
+  - Added base `Error` class.
+  - Better handling of resource references.
+
+## v0.8.1
+
+  - Updated dependencies.
+
+## v0.8.0
+
+  - Fixed URL usage throughout the library.
+  - Updated dependencies.
+
+## v0.7.3
+
+  - Fixed circular loading issue.
+  - Increased rate limiting delay.
+
+## v0.7.2
+
+  - Fixed missing `require` for `representation`.
+
+## v0.7.1
+
+  - Relaxed gem dependencies.
+
+## v0.7.0
+
+  - Added support for URL encoded payloads.
+
+## v0.6.0
+
+  - **Breaking**: RESTful design based on Fielding's thesis.
+
+## v0.5.2
+
+  - Fixed bad require statement.
+
+## v0.5.1
+
+  - Simplified sub-resources implementation.
+
+## v0.4.0
+
+  - Updated dependencies.
+
+## v0.3.0
+
+  - Added `@wrapper` instance to handle request and response encoding/decoding logic.
+  - Implemented middleware-style JSON serialization/deserialization.
+  - Moved compression functionality into `Async::HTTP::Compressor`.
+
+## v0.2.0
+
+  - Added compression support.
+  - General code cleanup and improvements.
+
+## v0.1.0
+
+  - Initial release split from `async-http`.

data.tar.gz.sig

@@ -1 +1,3 @@
-~�7�t�O�<�����q3i��$m�M	
�����0i�ktL���б&�544���	���E��S\����Vhbm����ڨ� =h1�[�m���CžD��J4�5��c|07|�Њ��mJ\�.Ħ����Sܑ�����ə�s7�o�2�v��6�˿�Y�Rz`��7��us�?�_^Z���k�����VG�����1~Wk���[W�@�<
+B(z^�O��������� �͙*��L�1%�K$�c��P�f\��;u[�@B�
+�,h�o.@����j)$����W��$�$M^|�y��B[���&��m�q��m��y���G`
+�X��sl+����p��K�G��T�N�>�w

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: async-rest
 version: !ruby/object:Gem::Version
-  version: 0.19.1
+  version: 0.20.0
 platform: ruby
 authors:
 - Samuel Williams
+- Ayush Newatia
 - Olle Jonsson
 - Cyril Roelandt
 - Terry Kerr
-autorequire:
 bindir: bin
 cert_chain:
 - |
@@ -40,7 +40,7 @@ cert_chain:
   Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
   voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
   -----END CERTIFICATE-----
-date: 2024-11-26 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: async-http
@@ -57,43 +57,44 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0.42'
 - !ruby/object:Gem::Dependency
-  name: protocol-http
+  name: protocol-url
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.45'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.45'
-description:
-email:
+        version: '0.2'
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- context/getting-started.md
+- context/index.yaml
 - lib/async/rest.rb
 - lib/async/rest/error.rb
 - lib/async/rest/representation.rb
 - lib/async/rest/resource.rb
 - lib/async/rest/version.rb
+- lib/async/rest/wrapper.rb
 - lib/async/rest/wrapper/form.rb
 - lib/async/rest/wrapper/generic.rb
 - lib/async/rest/wrapper/json.rb
 - lib/async/rest/wrapper/url_encoded.rb
 - license.md
 - readme.md
+- releases.md
 homepage: https://github.com/socketry/async-rest
 licenses:
 - MIT
 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:
 - lib
@@ -101,15 +102,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.1'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
-signing_key:
+rubygems_version: 3.7.2
 specification_version: 4
 summary: A library for RESTful clients (and hopefully servers).
 test_files: []