acfs 1.7.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3cbc57dd595fa4242fa029498d90ca5a497216d2003674296209b679b84a6df2
-  data.tar.gz: 31a009d88f2a028e2fc11513b68dd011f5cfa0b7f11a83238f167e807c365b35
+  metadata.gz: 45e81963e8044fcd6dbb2c5b3e8026de90c77d35e8ec5de2e73a8a3afaa839a5
+  data.tar.gz: 3507a04d6fcae2bfb6e637c3ef67eeaa9f9d02a154a635fe6b767e0d53669220
 SHA512:
-  metadata.gz: ba37a7c96e65b8774879835d93ccf43a5c91bcd77ce9cf604937544f0897ebf307ffbbf914d5e7304eb90e6f62139e37eb52b2e6406db4e86d454ef45bb4423b
-  data.tar.gz: 976193afda7d9e6d5bbdc3eef3ec7235a90abcaf23e79f055735cb663400c02448a683e734b9f3212b2a27c101fabad4055f0a0c5dff23a517885a7bda4cea43
+  metadata.gz: 2b0fc88443461e879c6c5b10375b7cef376d9690961935165d72be6acc91038a9101ea9073f2ff63f8f3efe1d19656ce7c431b37562ecf4d93deec78a0cbcfc2
+  data.tar.gz: 6518c3f15372487c8d3d4af937c0e9cb97e53f6aea08d5f2bd0a18da3043f105e7300c59b85ca154f7f7d20962587fe4812e8dc36e37bda082172c7e06d03223

data/CHANGELOG.md

@@ -1,12 +1,10 @@
 # Changelog
 
-
-
 ## Unreleased
+
 ---
 
 ### New
-* Support for Ruby 3.1 and Rails 7.0
 
 ### Changes
 
@@ -14,360 +12,390 @@
 
 ### Breaks
 
+## 2.0.0 - (2025-01-17)
+
+---
+
+### New
+
+- Add support for Rails 7.2 and 8.0
+- Add support for Ruby 3.3 and 3.4
+
+### Changes
+
+- Use newer Ruby syntax for performance and code improvements
+
+### Breaks
+
+- Require Ruby 3.1+ and Rails 7.0+
+
+## 1.7.0 - (2022-01-24)
+
+---
+
+### New
+
+- Support for Ruby 3.1 and Rails 7.0
 
 ## 1.6.0 - (2021-01-07)
+
 ---
 
 ### New
-* Support Ruby 3.0
-* Use keyword arguments in parameters and when calling methods
 
+- Support Ruby 3.0
+- Use keyword arguments in parameters and when calling methods
 
 ## 1.5.1 - (2020-12-30)
+
 ---
 
 ### Changes
-* Revert back to using `::MultiJson`
 
+- Revert to using `::MultiJson`
 
 ## 1.5.0 - (2020-06-19)
+
 ---
 
 ### New
-* Error classes for more HTTP error responses: `400`, `401`, `403`, `500`, `502`, `503`, `504`.
+
+- Error classes for more HTTP error responses: `400`, `401`, `403`, `500`, `502`, `503`, `504`.
 
 ### Changes
-* Replace deprecated MultiJson with core JSON module
 
+- Replace deprecated `MultiJson` with core JSON module
 
 ## 1.4.0 - (2020-06-12)
+
 ---
 
 ### New
-* Use strict TCP keepalive probing by default (5s/5s)
-* Adapter accepts curl request opts
 
+- Use strict TCP keep alive probing by default (5s/5s)
+- Adapter accepts curl request opts
 
 ## 1.3.4 - (2020-03-22)
+
 ---
 
 ### Fixes
-* Empty package build for Gem release 1.3.3
 
+- Empty package build for Gem release 1.3.3
 
 ## 1.3.3 - (2020-03-22)
+
 ---
 
 ### Changes
-* Improved handling of low-level connection errors and timeouts
 
+- Improved handling of low-level connection errors and timeouts
 
 ## 1.3.2 - (2019-09-24)
 
-
 ### Fixes
-* Fix Acfs.on callbacks for empty find_by results (#42)
 
+- Fix `Acfs.on` callbacks for empty `find_by` results (#42)
 
 ---
 
 ## 1.3.1 - (2019-07-02)
 
 ### Fixes
-* Improve URL argument encoding when building resource requests
+
+- Improve URL argument encoding when building resource requests
 
 ## 1.3.0
 
-* Change default error messages to a more compact representation to ease integration with error reporting services.
+- Change default error messages to a more compact representation to ease integration with error reporting services.
 
 ## 1.2.1
 
-* Fix issues with resources errors if response payload differs from the expected `field => [messages]`, such as `field => message` or `[messages]`.
+- Fix issues with resources errors if response payload differs from the expected `field => [messages]`, such as `field => message` or `[messages]`.
 
 ## 1.2.0
 
-* Add Rails 5.2 compatibility
+- Add Rails 5.2 compatibility
 
 ## 1.1.1
 
-* `each_item`: Pass collection to provided block (#40)
+- `each_item`: Pass collection to provided block (#40)
 
 ## 1.1.0
 
-* Add support for Rails 5.1
+- Add support for Rails 5.1
 
 ## 1.0.1
 
-* Fix deprecation warnings when using ::Mime
+- Fix deprecation warnings when using ::Mime
 
 ## 1.0.0
 
-* Switch to first non-development major as it's long time used in production.
-* Fix NewRelic RPM inference with middleware stack inherited from `ActionDispatch::MiddlewareStack`.
+- Switch to first non-development major as its long time used in production.
+- Fix NewRelic RPM inference with middleware stack inherited from `ActionDispatch::MiddlewareStack`.
 
 ## 0.48.0
 
-* Remove #attribute_types broke since f7e4109 (Sep 2013, v0.23)
-* Fix attribute inheritance on subclassing broken since commit 7cf1d11 (Apr 2014, v0.43)
+- Remove #attribute_types broke since f7e4109 (Sep 2013, v0.23)
+- Fix attribute inheritance on child classes broken since commit 7cf1d11 (Apr 2014, v0.43)
 
 ## 0.47.0
 
-* Change blank value handling of dict and list type (0a12ef1)
+- Change blank value handling of dict and list type (0a12ef1)
 
 ## 0.46.0
 
-* Rework types system (#39)
+- Rework types system (#39)
 
 ## 0.45.0
 
-* Fetching multiple records (`find(ary)`) is stable now, but untested (#38)
-* Middleware stack is build on ActionDispatch::MiddlewareStack now
-* Deprecate legacy middleware names (xyEncoder, xyDecoder)
+- Fetching multiple records (`find(ary)`) is stable now, but untested (#38)
+- Middleware stack is build on `ActionDispatch::MiddlewareStack` now
+- Deprecate legacy middleware names (`xyEncoder`, `xyDecoder`)
 
 ## 0.44.0
 
-* Add option to configure adapter creation and pass option to typhoeus adapter e.g.
-  limiting concurrency.
+- Add option to configure adapter creation and pass option to `typhoeus` adapter e.g. limiting concurrency.
 
 ## 0.43.2
 
-* add `total_count` for paginated collections
+- add `total_count` for paginated collections
 
 ## 0.43.1
 
-* Fix `:with` condition matching on stubs
+- Fix `:with` condition matching on stubs
 
 ## 0.43.0
 
-* Remove `Acfs::Model` (inherit from `Acfs::Resource`)
-* Stub does only a partial match of `:with` attributes now
-* Allow blocks as stub `:return`s
+- Remove `Acfs::Model` (inherit from `Acfs::Resource`)
+- Stub does only a partial match of `:with` attributes now
+- Allow blocks as stub `:return`s
 
 ## 0.42.0
 
-* Add simple dict attribute type
+- Add simple dict attribute type
 
 ## 0.40.0
 
-* Change `Resource#persisted?` to return true if it is not new
+- Change `Resource#persisted?` to return true if it is not new
 
 ## 0.39.1
 
-* Fix automatic path parameter handling for #destroy
+- Fix automatic path parameter handling for #destroy
 
 ## 0.39.0
 
-* Add new event acfs.operation.before_process
+- Add new event `acfs.operation.before_process`
 
 ## 0.38.0
 
-* Allow middlewares to abort request processing
-* Allow middlewares to receive the request operation object (via the request)
+- Allow middlewares to abort request processing
+- Allow middlewares to receive the request operation object (via the request)
 
 ## 0.37.0
 
-* Add Acfs.on
+- Add `Acfs.on`
 
 ## 0.36.0
 
-* Add #each_page and #each_item query methods
+- Add #each_page and #each_item query methods
 
 ## 0.35.0
 
-* Add instrumentation support
+- Add instrumentation support
 
 ## 0.34.1
 
-* Fix leaking failed requests in request queues
+- Fix leaking failed requests in request queues
 
 ## 0.34.0
 
-* Add support for will_paginate view helper used with `Acfs::Collection`s
-* Add support for pagination header added by [paginate-responder](https://github.com/jgraichen/paginate-responder)
-* Improve `Resource#new?` detection by using `loaded?` instead of presence of `:id` attribute
+- Add support for will_paginate view helper used with `Acfs::Collection`s
+- Add support for pagination header added by [paginate-responder](https://github.com/jgraichen/paginate-responder)
+- Improve `Resource#new?` detection by using `loaded?` instead of presence of `:id` attribute
 
 ## 0.33.0
 
-* Do not raise errors on unknown attributes by default, add :unknown option.
-* Add support to store unknown attributes
+- Do not raise errors on unknown attributes by default, add :unknown option.
+- Add support to store unknown attributes
 
 ## 0.32.1
 
-* Fix multiple callbacks on `QueryMethods#all`
+- Fix multiple callbacks on `QueryMethods#all`
 
 ## 0.32.0
 
-* Add new attribute type `UUID`
+- Add new attribute type `UUID`
 
 ## 0.31.0
 
-* Add experimental support for multiple and chained paths with placeholders
+- Add experimental support for multiple and chained paths with placeholders
 
 ## 0.30.0
 
-* Add experimental support for multiple operation callbacks (Acfs.add_callback)
+- Add experimental support for multiple operation callbacks (Acfs.add_callback)
 
 ## 0.29.1
 
-* Fix: rescue NameError and NoMethodError on invalid type
+- Fix: rescue `NameError` and `NoMethodError` on invalid type
 
 ## 0.29.0
 
-* Add find_by!
+- Add find_by!
 
 ## 0.28.0
 
-* Add find_by
+- Add find_by
 
 ## 0.27.0
 
-* Reset method to clear stubs, request queues, internal state
-* Add RSpec helper to enable stubs and clear state after each spec
+- Reset method to clear stubs, request queues, internal state
+- Add RSpec helper to enable stubs and clear state after each spec
 
 ## 0.26.0
 
-* Add support for singleton resources
+- Add support for singleton resources
 
 ## 0.25.0
 
-* Add option to allow blank attribute values (Johannes Jasper)
-* Internal changes
+- Add option to allow blank attribute values (Johannes Jasper)
+- Internal changes
 
 ## 0.24.0
 
-* Fix issues with stubs using type inheritance
-* Allow '1' as true value for bool attributes (Tino Junge)
+- Fix issues with stubs using type inheritance
+- Allow '1' as true value for boolean attributes (Tino Junge)
 
 ## 0.23.2
 
-* Fix regression in delegator usage by #find due to resource type inheritance.
+- Fix regression in delegator usage by #find due to resource type inheritance.
 
 ## 0.23.1
 
-* Fix error class name typo
+- Fix error class name typo
 
 ## 0.23.0
 
-* Add Resource Type Inheritance
+- Add Resource Type Inheritance
 
 ## 0.22.2
 
-* Preserve errors received from service on revalidation (2f1fc178)
-* Fix parameter ordering bug on stubs (1dc78dc8)
+- Preserve errors received from service on revalidation (2f1fc178)
+- Fix parameter ordering bug on stubs (1dc78dc8)
 
 ## 0.22.1
 
-* Fix hash modification on iteration bug on ActiveModel::Errors due to string keys in error hash
+- Fix hash modification on iteration bug on `ActiveModel::Errors` due to string keys in error hash
 
 ## 0.22.0
 
-* Fill local resource errors hash also on 422 responses when saving resources
+- Fill local resource errors hash also on 422 responses when saving resources
 
 ## 0.21.1
 
-* Fix wrong validation context
+- Fix wrong validation context
 
 ## 0.21.0
 
-* Add update_attributes
-* Add validation check to `save` method
-* Inherit attributes to subclasses
+- Add update_attributes
+- Add validation check to `save` method
+- Inherit attributes to subclasses
 
 ## 0.20.0
 
-* Remove messaging
-* Introduce `Acfs::Resource`
+- Remove messaging
+- Introduce `Acfs::Resource`
 
 ## 0.19.0
 
-* Add support for DateTime and Float attribute types
-* Add experimental list attribute type
-* Allow block usage in stub `with` option
-* Allow to test if operation stubs were called and how often
-* Fix bug on operation stubs
+- Add support for `DateTime` and `Float` attribute types
+- Add experimental list attribute type
+- Allow block usage in stub `with` option
+- Allow testing if operation stubs were called and how often
+- Fix bug on operation stubs
 
 ## 0.18.0
 
-* Basic DELETE operations
+- Basic DELETE operations
 
 ## 0.17.0
 
-* Basic messaging
-* Extensible YARD documentation
+- Basic messaging
+- Extensible YARD documentation
 
 ## 0.16.0
 
-* Add YAML configuration
-* Add external configuration for services
-* Add Rubinius support
+- Add YAML configuration
+- Add external configuration for services
+- Add Rubinius support
 
 ## 0.15.0
 
-* Add stubbing capabilities for resources
+- Add stubbing capabilities for resources
 
 ## 0.14.0 & 0.13.0
 
-* Fix response attributes
+- Fix response attributes
 
 ## 0.12.0
 
-* Add JRuby support
-* Improve handling of error respones (422)
+- Add JRuby support
+- Improve handling of error responses (422)
 
 ## 0.11.0
 
-* Add Logger Middleware
-* Add handling of error responses
+- Add Logger Middleware
+- Add handling of error responses
 
 ## 0.10.0
 
-* Return hash with indifferent access for resource attributes
+- Return hash with indifferent access for resource attributes
 
 ## 0.9.0
 
-* Add create operation
+- Add create operation
 
 ## 0.8.0
 
-* Add save operation (PUT and POST)
-* Add JSON and MessagePack encoder middlewares for encoding request data
-* ActiveModel::Dirty
-* Add persistant state methods
+- Add save operation (PUT and POST)
+- Add JSON and MessagePack encoder middlewares for encoding request data
+- `ActiveModel::Dirty`
+- Add persistent state methods
 
 ## 0.7.0
 
-* Per-service middleware stack
+- Per-service middleware stack
 
 ## 0.6.0
 
-* Add support for multiple ids for .find
-* Add MessagePack support
+- Add support for multiple IDs for `.find`
+- Add MessagePack support
 
 ## 0.5.1
 
-* Fix mime type parsing for mime types with aditional parameters (ActionPack < 4.0)
+- Fix mime type parsing for mime types with additional parameters (`ActionPack` < 4.0)
 
 ## 0.5.0
 
-* Add mime type support for respones
+- Add mime type support for responses
 
 ## 0.4.0
 
-* Improve JSON response detection
-* Add bool attribute type
+- Improve JSON response detection
+- Add boolean attribute type
 
 ## 0.3.0
 
-* Add tracking for loading state (if resource is loaded or queued)
-* Add JSON middleware to decode respones
-* Add middleware support
-* Add method to fetch single resources or list of resources
-* Use typhoeus as http library for parallel request processing
+- Add tracking for loading state (if resource is loaded or queued)
+- Add JSON middleware to decode responses
+- Add middleware support
+- Add method to fetch single resources or list of resources
+- Use typhoeus as HTTP library for parallel request processing
 
 ## 0.2.0
 
-* Allow to define resources and attributes
+- Allow defining resources and attributes
 
 ## 0.1.0
 
-* Project start
+- Project start

data/README.md

@@ -1,8 +1,7 @@
 # Acfs - *API client for services*
 
 [![Gem Version](https://img.shields.io/gem/v/acfs?logo=ruby)](https://rubygems.org/gems/acfs)
-[![Build Status](https://img.shields.io/travis/jgraichen/acfs/master?logo=travis)](https://travis-ci.org/jgraichen/acfs)
-[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/jgraichen/acfs/Test/master?logo=github)](https://github.com/jgraichen/acfs/actions?query=branch%3Amaster)
+[![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/jgraichen/acfs/test.yml?logo=github)](https://github.com/jgraichen/acfs/actions)
 [![Coverage Status](http://img.shields.io/coveralls/jgraichen/acfs/master.svg)](https://coveralls.io/r/jgraichen/acfs)
 [![RubyDoc Documentation](http://img.shields.io/badge/rubydoc-here-blue.svg)](http://rubydoc.info/github/jgraichen/acfs/master/frames)
 
@@ -10,23 +9,25 @@ Acfs is a library to develop API client libraries for single services within a l
 
 Acfs covers model and service abstraction, convenient query and filter methods, full middleware stack for pre-processing requests and responses, as well as automatic request queuing and parallel processing.
 
-
 ## Installation
 
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'acfs', '~> 1.7'
+gem 'acfs', '~> 2.0'
 ```
 
 And then execute:
 
-    > bundle
+```console
+bundle
+```
 
 Or install it yourself as:
 
-    > gem install acfs
-
+```console
+gem install acfs
+```
 
 ## Usage
 
@@ -34,7 +35,7 @@ First you need to define your service(s):
 
 ```ruby
 class UserService < Acfs::Service
-  self.base_url = 'http://users.myapp.org'
+  self.base_url = 'https://users.myapp.org'
 
   # You can configure middlewares you want to use for the service here.
   # Each service has it own middleware stack.
@@ -120,10 +121,11 @@ Acfs.run # This call will fire all request as parallel as possible.
 
 @user.name       # => "John
 @comments.size   # => 25
-@friends[0].name # => "Miraculix"
+@friends[0].name # => "Miracolix"
 ```
 
 Use `.find_by` to get first element only. `.find_by` will call the `index`-Action and return the first resource. Optionally passed parameters will be sent as `GET` parameters and can be used for filtering in the service's controller.
+
 ```ruby
 @user = User.find_by age: 24
 
@@ -131,6 +133,7 @@ Acfs.run # Will request `http://users.myapp.org/users?age=24`
 
 @user # Contains the first user object returned by the index action
 ```
+
 If no object can be found, `.find_by` will return `nil`. The optional callback will then be called with `nil` as parameter. Use `.find_by!` to raise an `Acfs::ResourceNotFound` exception if no object can be found. `.find_by!` will only invoke the optional callback if an object was successfully loaded.
 
 Acfs has basic update support using `PUT` requests:
@@ -149,7 +152,6 @@ Acfs has basic update support using `PUT` requests:
 @user.persisted? # => true
 ```
 
-
 ## Singleton resources
 
 Singletons can be used in Acfs by creating a new resource which inherits from `SingletonResource`:
@@ -188,7 +190,6 @@ my_single = Single.find name: 'Max'
 Acfs.run # sends GET request with param to /single?name=Max
 ```
 
-
 ## Resource Inheritance
 
 Acfs provides a resource inheritance similar to ActiveRecord Single Table Inheritance. If a `type` attribute exists and is a valid subclass of your resource they will be converted to you subclassed resources:
@@ -222,7 +223,6 @@ Acfs.run
 @computer[2].class # => Pc
 ```
 
-
 ## Stubbing
 
 You can stub resources in applications using an Acfs service client:
@@ -269,7 +269,7 @@ it 'should allow stub resource creation' do
 end
 ```
 
-By default Acfs raises an error when a non stubbed resource should be requested. You can switch of the behavior:
+By default, Acfs raises an error when a non stubbed resource should be requested. You can switch of the behavior:
 
 ```ruby
 before do
@@ -283,7 +283,6 @@ it 'should find user number one' do
 end
 ```
 
-
 ## Instrumentation
 
 Acfs supports [instrumentation via active support][1] and exposes the following events:
@@ -299,20 +298,16 @@ Read the [official guide][2] on how to subscribe to these events.
 [1]: http://guides.rubyonrails.org/active_support_instrumentation.html
 [2]: http://guides.rubyonrails.org/active_support_instrumentation.html#subscribing-to-an-event
 
-
 ## Contributing
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)
-4. Add specs for your feature
-5. Implement your feature
-6. Commit your changes (`git commit -am 'Add some feature'`)
-7. Push to the branch (`git push origin my-new-feature`)
-8. Create new Pull Request
-
+3. Add specs for your feature
+4. Implement your feature
+5. Commit your changes (`git commit -am 'Add some feature'`)
+6. Push to the branch (`git push origin my-new-feature`)
+7. Create new Pull Request
 
 ## License
 
-MIT License
-
-Copyright (c) 2013-2022 Jan Graichen. MIT license, see LICENSE for more details.
+[MIT License](LICENSE)

data/acfs.gemspec

@@ -24,17 +24,14 @@ Gem::Specification.new do |spec|
   }xi)
 
   spec.executables   = spec.files.grep(%r{^bin/}) {|f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w[lib]
 
-  spec.required_ruby_version = '>= 2.5.0'
+  spec.required_ruby_version = '>= 3.1.0'
 
-  spec.add_runtime_dependency 'actionpack', '>= 5.2'
-  spec.add_runtime_dependency 'activemodel', '>= 5.2'
-  spec.add_runtime_dependency 'activesupport', '>= 5.2'
-  spec.add_runtime_dependency 'multi_json', '~> 1.0'
-  spec.add_runtime_dependency 'rack'
-  spec.add_runtime_dependency 'typhoeus', '~> 1.0'
-
-  spec.add_development_dependency 'bundler'
+  spec.add_dependency 'actionpack', '>= 7.0'
+  spec.add_dependency 'activemodel', '>= 7.0'
+  spec.add_dependency 'activesupport', '>= 7.0'
+  spec.add_dependency 'multi_json', '~> 1.0'
+  spec.add_dependency 'rack'
+  spec.add_dependency 'typhoeus', '~> 1.0'
 end