Async::REST
Roy Thomas Fielding's thesis Architectural Styles and the Design of Network-based Software Architectures describes Representational State Transfer 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.
Usage
Please browse the source code index or refer to the guides below.
Getting Started
This guide explains the design of the async-rest gem and how to use it to access RESTful APIs.
Releases
Please browse the releases for more details.
v0.20.0
- Migrated to
protocol-urlgem 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.rbentry point. - Fixed logic to correctly parse JSON responses in
Formwrapper.
v0.19.1
- Fixed
retry-afterheader handling to treat it as a single value header.
v0.19.0
- Added support for standard
retry-afterrate 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.forcan now take a block and return a custom representation.- Renamed methods to prefer
methodrather thanverbfor 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.newto useself.class.newfor proper subclass instantiation.
See Also
- async-ollama - A client for Ollama, a local large language model server.
- async-discord - A client for Discord, a popular chat platform.
- cloudflare - A client for Cloudflare, a popular CDN and DDoS protection service.
- async-slack - A client for Slack, a popular chat platform.
Contributing
We welcome contributions to this project.
- Fork the repository.
- Create your feature branch (
git checkout -b my-new-feature). - Commit your changes (
git commit -am 'Add some feature.'). - Push to the branch (
git push origin my-new-feature). - Create a new pull request.
Running Tests
To run the test suite:
bundle exec sus
Making Releases
To make a new release:
bundle exec bake gem:release:patch # or minor or major
Developer Certificate of Origin
In order to protect users of this project, we require all contributors to comply with the Developer Certificate of Origin. This ensures that all contributions are properly licensed and attributed.
Community Guidelines
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.