acfs 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 46dc13b234cd5b704b67a731292b06ad8b32ee3fafb0a7a0af2a1003824e6df8
-  data.tar.gz: a35249f8e2a7a6cc49351b62c75b3fe641b26691132f4fb70b0a183ab041a380
+  metadata.gz: 3cbc57dd595fa4242fa029498d90ca5a497216d2003674296209b679b84a6df2
+  data.tar.gz: 31a009d88f2a028e2fc11513b68dd011f5cfa0b7f11a83238f167e807c365b35
 SHA512:
-  metadata.gz: 07132ad9797084fccd7fdeb31cc9f51572ddda1eb9dc88aaf875cd244000d15823223d3c6c503f0af7ac4cc1f59cb0b748eea75d8592323b807001e82c93d781
-  data.tar.gz: 6d6d15b6841820ae2ee672eec742b417113523ce613f1a7c7d493eeed50232b0915d7edcbf3df1b7060c5ced484bb82f59904e34fe6e17f70babe3b5ddf0a4e7
+  metadata.gz: ba37a7c96e65b8774879835d93ccf43a5c91bcd77ce9cf604937544f0897ebf307ffbbf914d5e7304eb90e6f62139e37eb52b2e6406db4e86d454ef45bb4423b
+  data.tar.gz: 976193afda7d9e6d5bbdc3eef3ec7235a90abcaf23e79f055735cb663400c02448a683e734b9f3212b2a27c101fabad4055f0a0c5dff23a517885a7bda4cea43

data/CHANGELOG.md

@@ -6,6 +6,7 @@
 ---
 
 ### New
+* Support for Ruby 3.1 and Rails 7.0
 
 ### Changes
 

data/README.md

@@ -8,14 +8,16 @@
 
 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', '~> 1.7'
+```
 
 And then execute:
 
@@ -121,7 +123,7 @@ Acfs.run # This call will fire all request as parallel as possible.
 @friends[0].name # => "Miraculix"
 ```
 
-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
 
@@ -179,7 +181,7 @@ 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'
@@ -189,9 +191,7 @@ 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 +202,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
 [
@@ -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,8 +264,8 @@ 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
 ```
 
@@ -287,9 +286,7 @@ 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,7 +294,7 @@ 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
@@ -318,4 +315,4 @@ Read [official guide][2] to see to to subscribe.
 
 MIT License
 
-Copyright (c) 2013-2020 Jan Graichen. MIT license, see LICENSE for more details.
+Copyright (c) 2013-2022 Jan Graichen. MIT license, see LICENSE for more details.

data/acfs.gemspec

@@ -16,6 +16,8 @@ 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.*)

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/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.read(path), [], [], true)
+      end
+    end
   end
 end

data/lib/acfs/errors.rb

@@ -5,7 +5,7 @@ module Acfs
   #
   class Error < StandardError
     def initialize(opts = {}, message = nil)
-      opts.merge! message: message if message
+      opts[:message] = message if message
       super opts[:message]
     end
   end

data/lib/acfs/global.rb

@@ -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

@@ -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

@@ -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/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/query_methods.rb

@@ -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/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/stub.rb

@@ -21,11 +21,11 @@ module Acfs
       end
     end
 
-    def accept?(op)
-      return opts[:with].call(op) if opts[:with].respond_to?(:call)
+    def accept?(operation)
+      return opts[:with].call(operation) if opts[:with].respond_to?(:call)
 
-      params = op.full_params.stringify_keys
-      data   = op.data.stringify_keys
+      params = operation.full_params.stringify_keys
+      data   = operation.data.stringify_keys
       with   = opts[:with]
 
       return true if with.nil?
@@ -33,10 +33,10 @@ module Acfs
       case opts.fetch(:match, :inclusion)
         when :legacy
           return true if with.empty? && params.empty? && data.empty?
-          if with.reject {|_, v| v.nil? } == params.reject {|_, v| v.nil? }
+          if with.compact == params.compact
             return true
           end
-          if with.reject {|_, v| v.nil? } == data.reject {|_, v| v.nil? }
+          if with.compact == data.compact
             return true
           end
 
@@ -58,22 +58,25 @@ module Acfs
       count.nil? ? calls.any? : calls.size == count
     end
 
-    def call(op)
-      calls << op
+    def call(operation)
+      calls << operation
 
       err  = opts[:raise]
       data = opts[:return]
 
       if err
-        raise_error op, err, opts[:return]
+        raise_error(operation, err, opts[:return])
       elsif data
-        data = data.call(op) if data.respond_to?(:call)
+        data = data.call(operation) if data.respond_to?(:call)
 
-        response = Acfs::Response.new op.request,
+        response = Acfs::Response.new(
+          operation.request,
           headers: opts[:headers] || {},
           status: opts[:status] || 200,
-          data: data || {}
-        op.call data, response
+          data: data || {},
+        )
+
+        operation.call(data, response)
       else
         raise ArgumentError.new 'Unsupported stub.'
       end
@@ -81,15 +84,17 @@ module Acfs
 
     private
 
-    def raise_error(op, name, data)
+    def raise_error(operation, name, data)
       raise name if name.is_a? Class
 
       data.stringify_keys! if data.respond_to?(:stringify_keys!)
 
-      op.handle_failure ::Acfs::Response.new(
-        op.request,
-        status: Rack::Utils.status_code(name),
-        data: data
+      operation.handle_failure(
+        ::Acfs::Response.new(
+          operation.request,
+          status: Rack::Utils.status_code(name),
+          data: data,
+        ),
       )
     end
 
@@ -140,35 +145,35 @@ module Acfs
         @stubs ||= {}
       end
 
-      def stub_for(op)
-        return false unless (classes = stubs[op.resource])
-        return false unless (stubs = classes[op.action])
+      def stub_for(operation)
+        return false unless (classes = stubs[operation.resource])
+        return false unless (stubs = classes[operation.action])
 
-        accepted_stubs = stubs.select {|stub| stub.accept? op }
+        accepted_stubs = stubs.select {|stub| stub.accept?(operation) }
 
         if accepted_stubs.size > 1
-          raise AmbiguousStubError.new stubs: accepted_stubs, operation: op
+          raise AmbiguousStubError.new(stubs: accepted_stubs, operation: operation)
         end
 
         accepted_stubs.first
       end
 
-      def stubbed(op)
-        stub = stub_for op
+      def stubbed(operation)
+        stub = stub_for(operation)
         unless stub
           return false if allow_requests?
 
           raise RealRequestsNotAllowedError.new <<~ERROR
-            No stub found for `#{op.action}' on `#{op.resource.name}' \
-            with params `#{op.full_params.inspect}', data `#{op.data.inspect}' \
-            and id `#{op.id}'.
+            No stub found for `#{operation.action}' on `#{operation.resource.name}' \
+            with params `#{operation.full_params.inspect}', data `#{operation.data.inspect}' \
+            and id `#{operation.id}'.
 
             Available stubs:
             #{pretty_print}
           ERROR
         end
 
-        stub.call op
+        stub.call(operation)
         true
       end
 

data/lib/acfs/version.rb

@@ -3,11 +3,11 @@
 module Acfs
   module VERSION
     MAJOR = 1
-    MINOR = 6
+    MINOR = 7
     PATCH = 0
     STAGE = nil
 
-    STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
+    STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.')
 
     def self.to_s
       STRING

data/spec/acfs/adapter/typhoeus_spec.rb

@@ -20,7 +20,7 @@ describe Acfs::Adapter::Typhoeus do
     adapter.queue request2
 
     expect { adapter.start }.to raise_error(/404-[12]/)
-    expect { adapter.start }.to_not raise_error
+    expect { adapter.start }.not_to raise_error
   end
 
   it 'raises timeout' do