acfs 1.6.0 → 2.0.0

data/README.md

@@ -1,30 +1,33 @@
 # 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)
 
 Acfs is a library to develop API client libraries for single services within a larger service oriented application.
 
-Acfs covers model and service abstraction, convenient query and filter methods, full middleware stack for pre-processing requests and responses on a per service level and automatic request queuing and parallel processing. See Usage for more.
-
+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:
 
-    gem 'acfs', '~> 1.3'
+```ruby
+gem 'acfs', '~> 2.0'
+```
 
 And then execute:
 
-    > bundle
+```console
+bundle
+```
 
 Or install it yourself as:
 
-    > gem install acfs
-
+```console
+gem install acfs
+```
 
 ## Usage
 
@@ -32,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.
@@ -118,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 params will be sent as `GET` parameters and can be used for filtering in the service's controller.
+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
 
@@ -129,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:
@@ -147,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`:
@@ -179,19 +183,16 @@ my_single.save # sends PUT request to /single
 my_single.delete # sends DELETE request to /single
 ```
 
-You also can pass parameters to the find call, these will sent as GET params to the index action:
+You also can pass parameters to the find call. They will be sent as query parameters to the index action:
 
 ```ruby
 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:
+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:
 
 ```ruby
 class Computer < Acfs::Resource
@@ -202,8 +203,7 @@ class Pc < Computer end
 class Mac < Computer end
 ```
 
-With the following response on `GET /computers` the collection will contain the appropriate
-subclass resources:
+With the following response on `GET /computers` the collection will contain the appropriate subclass resources:
 
 ```json
 [
@@ -223,7 +223,6 @@ Acfs.run
 @computer[2].class # => Pc
 ```
 
-
 ## Stubbing
 
 You can stub resources in applications using an Acfs service client:
@@ -248,9 +247,9 @@ it 'should find user number one' do
   user = MyUser.find 1
   Acfs.run
 
-  expect(user.id).to be == 1
-  expect(user.name).to be == 'John Smith'
-  expect(user.age).to be == 32
+  expect(user.id).to eq 1
+  expect(user.name).to eq 'John Smith'
+  expect(user.age).to eq 32
 
   expect(@stub).to be_called
   expect(@stub).to_not be_called 5.times
@@ -265,12 +264,12 @@ end
 it 'should allow stub resource creation' do
   session = Session.create! ident: 'john@exmaple.org', password: 's3cr3t'
 
-  expect(session.id).to be == 'longhash'
-  expect(session.user).to be == 1
+  expect(session.id).to eq 'longhash'
+  expect(session.user).to eq 1
 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
@@ -284,12 +283,9 @@ it 'should find user number one' do
 end
 ```
 
-
 ## Instrumentation
 
-Acfs supports [instrumentation via active support][1].
-
-Acfs expose to following events
+Acfs supports [instrumentation via active support][1] and exposes the following events:
 
 * `acfs.operation.complete(operation, response)`: Acfs operation completed
 * `acfs.runner.sync_run(operation)`: Run operation right now skipping queue.
@@ -297,25 +293,21 @@ Acfs expose to following events
 * `acfs.before_run`: directly before `acfs.run`
 * `acfs.run`: Run all queued operations.
 
-Read [official guide][2] to see to to subscribe.
+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-2020 Jan Graichen. MIT license, see LICENSE for more details.
+[MIT License](LICENSE)

data/acfs.gemspec

@@ -16,23 +16,22 @@ Gem::Specification.new do |spec|
     An abstract API base client for service oriented application.
   SUMMARY
 
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
   spec.files = Dir['**/*'].grep(%r{
     ^((bin|lib|test|spec|features)/|
     .*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)
   }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.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.required_ruby_version = '>= 3.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

data/lib/acfs/adapter/typhoeus.rb

@@ -7,7 +7,7 @@ module Acfs
     DEFAULT_OPTIONS = {
       tcp_keepalive: true,
       tcp_keepidle: 5,
-      tcp_keepintvl: 5
+      tcp_keepintvl: 5,
     }.freeze
 
     # Adapter for Typhoeus.
@@ -16,8 +16,10 @@ module Acfs
       def initialize(**kwargs)
         super
 
+        extra_opts = kwargs.delete(:opts)
+
         @opts = DEFAULT_OPTIONS
-        @opts = @opts.merge(opts) if (opts = kwargs.delete(:opts))
+        @opts = @opts.merge(extra_opts) if extra_opts
         @kwargs = kwargs
       end
 
@@ -50,9 +52,9 @@ module Acfs
           params: req.params,
           headers: req.headers.merge(
             'Expect' => '',
-            'Transfer-Encoding' => ''
+            'Transfer-Encoding' => '',
           ),
-          body: req.body
+          body: req.body,
         }
 
         request = ::Typhoeus::Request.new(req.url, **@opts, **opts)

data/lib/acfs/collections/paginatable.rb

@@ -5,7 +5,7 @@ module Acfs::Collections
     extend ActiveSupport::Concern
 
     included do
-      def self.operation(_action, **opts, &_block)
+      def self.operation(_action, **opts, &)
         opts[:url]
       end
 
@@ -17,26 +17,26 @@ module Acfs::Collections
       setup_headers response.headers
     end
 
-    def next_page(&block)
-      page 'next', &block
+    def next_page(&)
+      page('next', &)
     end
 
-    def prev_page(&block)
-      page 'prev', &block
+    def prev_page(&)
+      page('prev', &)
     end
 
-    def first_page(&block)
-      page 'first', &block
+    def first_page(&)
+      page('first', &)
     end
 
-    def last_page(&block)
-      page 'last', &block
+    def last_page(&)
+      page('last', &)
     end
 
-    def page(rel, &block)
+    def page(rel, &)
       return unless relations[rel]
 
-      @resource_class.all nil, url: relations[rel], &block
+      @resource_class.all(nil, url: relations[rel], &)
     end
 
     private

data/lib/acfs/configuration.rb

@@ -28,7 +28,7 @@ module Acfs
     #
     def configure(&block)
       if block.arity.positive?
-        block.call self
+        yield self
       else
         instance_eval(&block)
       end
@@ -70,8 +70,8 @@ module Acfs
     # @return [undefined]
     #
     def load(filename)
-      config = YAML.safe_load(File.read(filename), [], [], true)
-      env    = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
+      config = load_yaml_file(filename)
+      env = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
 
       config = config[env] if config.key? env
       config.each do |key, value|
@@ -116,5 +116,15 @@ module Acfs
         @current = configuration if configuration.is_a? Configuration
       end
     end
+
+    private
+
+    def load_yaml_file(path)
+      if YAML.respond_to?(:safe_load_file)
+        YAML.safe_load_file(path, aliases: true)
+      else
+        YAML.safe_load_file(path, [], [], true)
+      end
+    end
   end
 end

data/lib/acfs/errors.rb

@@ -5,8 +5,8 @@ module Acfs
   #
   class Error < StandardError
     def initialize(opts = {}, message = nil)
-      opts.merge! message: message if message
-      super opts[:message]
+      opts[:message] = message if message
+      super(opts[:message])
     end
   end
 
@@ -20,7 +20,7 @@ module Acfs
 
       message = "#{message}: #{request.method.upcase} #{request.url}"
 
-      super message: message
+      super(message: message)
     end
   end
 
@@ -40,13 +40,13 @@ module Acfs
 
       message = if response
                   (opts[:message] ? "#{opts[:message]}:" : 'Received') +
-                    " #{response.code} for #{response.request.method.upcase}" \
-                    " #{response.request.url} #{response.request.format}"
+                    " #{response.code} for #{response.request.method.upcase} " \
+                    "#{response.request.url} #{response.request.format}"
                 else
                   opts[:message] || 'Received erroneous response'
                 end
 
-      super opts, message
+      super(opts, message)
     end
   end
 
@@ -63,7 +63,7 @@ module Acfs
                 "on #{operation.resource}.\n" +
                 stubs.map {|s| "  #{s.opts.pretty_inspect}" }.join
 
-      super opts, message
+      super(opts, message)
     end
   end
 

data/lib/acfs/global.rb

@@ -41,8 +41,8 @@ module Acfs
     # @return [undefined]
     # @see Configuration#configure
     #
-    def configure(&block)
-      Configuration.current.configure(&block)
+    def configure(&)
+      Configuration.current.configure(&)
     end
 
     # @api public
@@ -71,12 +71,12 @@ module Acfs
     def add_callback(resource, &block)
       unless resource.respond_to?(:__callbacks__)
         raise ArgumentError.new 'Given resource is not an Acfs resource ' \
-          "delegator but a: #{resource.class.name}"
+                                "delegator but a: #{resource.class.name}"
       end
       return false if block.nil?
 
       if resource.nil? || resource.loaded?
-        block.call resource
+        yield resource
       else
         resource.__callbacks__ << block
       end

data/lib/acfs/location.rb

@@ -8,7 +8,7 @@ module Acfs
   class Location
     attr_reader :arguments, :raw, :struct, :vars
 
-    REGEXP = /^:([A-z][A-z0-9_]*)$/.freeze
+    REGEXP = /^:([A-z][A-z0-9_]*)$/
 
     def initialize(uri, vars = {})
       @raw       = URI.parse uri
@@ -30,7 +30,7 @@ module Acfs
 
     def str
       uri = raw.dup
-      uri.path = "/#{struct.map(&method(:lookup_variable)).join('/')}"
+      uri.path = "/#{struct.map {|s| lookup_variable(s) }.join('/')}"
       uri.to_s
     end
 

data/lib/acfs/operation.rb

@@ -56,7 +56,7 @@ module Acfs
 
     def request
       request = ::Acfs::Request.new url, method: method, params: params,
-                                         data: data, operation: self
+        data: data, operation: self
       request.on_complete do |response|
         ::ActiveSupport::Notifications.instrument 'acfs.operation.complete',
           operation: self,

data/lib/acfs/request/callbacks.rb

@@ -21,7 +21,7 @@ module Acfs
       # @return [ Acfs::Request ] The request itself.
       #
       def on_complete(&block)
-        callbacks.insert 0, block if block_given?
+        callbacks.insert 0, block if block
         self
       end
 

data/lib/acfs/request.rb

@@ -22,7 +22,7 @@ module Acfs
 
       @operation = options.delete(:operation) || nil
 
-      on_complete(&block) if block_given?
+      on_complete(&block) if block
     end
 
     def data?

data/lib/acfs/resource/attributes/uuid.rb

@@ -11,7 +11,7 @@ module Acfs::Resource::Attributes
   #   end
   #
   class UUID < Base
-    UUID_REGEXP = /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i.freeze
+    UUID_REGEXP = /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/i
 
     # @api public
     #
@@ -35,7 +35,7 @@ module Acfs::Resource::Attributes
     def cast_value(value)
       if value.blank?
         nil
-      elsif value.to_s =~ UUID_REGEXP
+      elsif UUID_REGEXP.match?(value.to_s)
         value
       else
         raise TypeError.new "Invalid UUID: `#{value}'"

data/lib/acfs/resource/attributes.rb

@@ -264,7 +264,7 @@ end
 
 # Load attribute type classes.
 #
-Dir[File.join(__dir__, 'attributes/*.rb')].sort.each do |path|
+Dir[File.join(__dir__, 'attributes/*.rb')].each do |path|
   filename = File.basename(path)
   require "acfs/resource/attributes/#{filename}"
 end

data/lib/acfs/resource/dirty.rb

@@ -17,7 +17,7 @@ class Acfs::Resource
     # @api private
     #
     def save!(**kwargs)
-      super(**kwargs).tap {|_| changes_applied }
+      super.tap {|_| changes_applied }
     end
 
     # @api private

data/lib/acfs/resource/locatable.rb

@@ -116,8 +116,8 @@ class Acfs::Resource
       return nil if need_primary_key? && !primary_key?
 
       self.class.service
-          .location(self.class, **opts, action: :read)
-          .build(attributes).str
+        .location(self.class, **opts, action: :read)
+        .build(attributes).str
     end
 
     # @api private

data/lib/acfs/resource/operational.rb

@@ -12,14 +12,14 @@ class Acfs::Resource
   module Operational
     extend ActiveSupport::Concern
 
-    def operation(*args, **kwargs, &block)
-      self.class.operation(*args, **kwargs, &block)
+    def operation(...)
+      self.class.operation(...)
     end
 
     module ClassMethods
       # Invoke CRUD operation.
-      def operation(action, **opts, &block)
-        Acfs.runner.process ::Acfs::Operation.new(self, action, **opts, &block)
+      def operation(...)
+        Acfs.runner.process ::Acfs::Operation.new(self, ...)
       end
     end
   end

data/lib/acfs/resource/query_methods.rb

@@ -56,11 +56,11 @@ class Acfs::Resource
       #
       #   @return [Collection] Collection of requested resources.
       #
-      def find(id_or_ids, **opts, &block)
+      def find(id_or_ids, **opts, &)
         if id_or_ids.respond_to? :each
-          find_multiple id_or_ids, opts, &block
+          find_multiple(id_or_ids, opts, &)
         else
-          find_single id_or_ids, opts, &block
+          find_single(id_or_ids, opts, &)
         end
       end
 
@@ -139,7 +139,7 @@ class Acfs::Resource
         find_by params do |m|
           if m.nil?
             raise Acfs::ResourceNotFound.new message: 'Received erroneous ' \
-              "response: no `#{name}` with params #{params} found"
+                                                      "response: no `#{name}` with params #{params} found"
           end
           block&.call m
         end
@@ -210,7 +210,7 @@ class Acfs::Resource
         model = Acfs::Util::ResourceDelegator.new new
 
         opts[:params] ||= {}
-        opts[:params].merge! id: id unless id.nil?
+        opts[:params][:id] = id unless id.nil?
 
         model.__callbacks__ << block unless block.nil?
 

data/lib/acfs/response/status.rb

@@ -9,7 +9,7 @@ module Acfs
       # request was not executed or failed on client side.
       #
       def status_code
-        return @status.to_i if defined? :@status
+        @status.to_i if defined?(@status)
         # return response.response_code unless response.nil?
         # 0
       end

data/lib/acfs/runner.rb

@@ -17,16 +17,16 @@ module Acfs
     # Process an operation. Synchronous operations will be run
     # and parallel operations will be queued.
     #
-    def process(op)
-      ::ActiveSupport::Notifications.instrument 'acfs.operation.before_process', operation: op
-      op.synchronous? ? run(op) : enqueue(op)
+    def process(operation)
+      ::ActiveSupport::Notifications.instrument('acfs.operation.before_process', operation: operation)
+      operation.synchronous? ? run(operation) : enqueue(operation)
     end
 
     # Run operation right now skipping queue.
     #
-    def run(op)
-      ::ActiveSupport::Notifications.instrument 'acfs.runner.sync_run', operation: op do
-        op_request(op) {|req| adapter.run req }
+    def run(operation)
+      ::ActiveSupport::Notifications.instrument('acfs.runner.sync_run', operation: operation) do
+        operation_request(operation) {|req| adapter.run req }
       end
     end
 
@@ -38,12 +38,12 @@ module Acfs
 
     # Enqueue operation to be run later.
     #
-    def enqueue(op)
-      ::ActiveSupport::Notifications.instrument 'acfs.runner.enqueue', operation: op do
+    def enqueue(operation)
+      ::ActiveSupport::Notifications.instrument('acfs.runner.enqueue', operation: operation) do
         if running?
-          op_request(op) {|req| adapter.queue req }
+          operation_request(operation) {|req| adapter.queue req }
         else
-          queue << op
+          queue << operation
         end
       end
     end
@@ -82,15 +82,15 @@ module Acfs
     end
 
     def enqueue_operations
-      while (op = queue.shift)
-        op_request(op) {|req| adapter.queue req }
+      while (operation = queue.shift)
+        operation_request(operation) {|req| adapter.queue req }
       end
     end
 
-    def op_request(op)
-      return if Acfs::Stub.enabled? && Acfs::Stub.stubbed(op)
+    def operation_request(operation)
+      return if Acfs::Stub.enabled? && Acfs::Stub.stubbed(operation)
 
-      req = op.service.prepare op.request
+      req = operation.service.prepare(operation.request)
       return unless req.is_a? Acfs::Request
 
       req = prepare req

data/lib/acfs/service/middleware.rb

@@ -35,9 +35,9 @@ module Acfs
         #   @param [Proc] block Block passed to klass initialize
         #   @return [undefined]
         #
-        def use(klass, *args, &block)
+        def use(klass, ...)
           # Backward compatible behavior
-          middleware.insert(0, klass, *args, &block)
+          middleware.insert(0, klass, ...)
         end
 
         # @api private

data/lib/acfs/singleton_resource.rb

@@ -59,8 +59,8 @@ module Acfs
       #
       #   @return [ self ] Resource object.
       #
-      def find(*attrs, &block)
-        find_single nil, params: attrs.extract_options!, &block
+      def find(*attrs, &)
+        find_single(nil, params: attrs.extract_options!, &)
       end
 
       # @api public