acfs 1.4.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f998ff3e28801676c732fa44df93e18f651e96eb986c857c61b7f25b312a2c1
-  data.tar.gz: a122064cb630a664489629ef658d5ecde917ced4cdc43a600b49d0e18e00bea7
+  metadata.gz: 3cbc57dd595fa4242fa029498d90ca5a497216d2003674296209b679b84a6df2
+  data.tar.gz: 31a009d88f2a028e2fc11513b68dd011f5cfa0b7f11a83238f167e807c365b35
 SHA512:
-  metadata.gz: 7801c96d794f08ad03b9ad204f8e7c8b611300922b12714ce7864a33c5a6268bc47c42e66b86c410358f17a0439d382c358ba15283eee07ff092d19a1f86a8be
-  data.tar.gz: 78b2c804251fb6aaee270d9c894ff36b7b8dc7bb777148de55963255847fc28adcdbff9c7132352c5448bef7b9980fd72e6a14ffceda38540d661aceaf1e5e9d
+  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
 
@@ -14,6 +15,31 @@
 ### Breaks
 
 
+## 1.6.0 - (2021-01-07)
+---
+
+### New
+* 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`
+
+
+## 1.5.0 - (2020-06-19)
+---
+
+### New
+* Error classes for more HTTP error responses: `400`, `401`, `403`, `500`, `502`, `503`, `504`.
+
+### Changes
+* Replace deprecated MultiJson with core JSON module
+
+
 ## 1.4.0 - (2020-06-12)
 ---
 

data/README.md

@@ -8,13 +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:
 
@@ -24,6 +27,7 @@ Or install it yourself as:
 
     > gem install acfs
 
+
 ## Usage
 
 First you need to define your service(s):
@@ -119,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
 
@@ -145,6 +149,7 @@ 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`:
@@ -176,18 +181,17 @@ 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
@@ -198,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
 [
@@ -219,6 +222,7 @@ Acfs.run
 @computer[2].class # => Pc
 ```
 
+
 ## Stubbing
 
 You can stub resources in applications using an Acfs service client:
@@ -243,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
@@ -260,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
 ```
 
@@ -279,11 +283,10 @@ it 'should find user number one' do
 end
 ```
 
-## Instrumentation
 
-Acfs supports [instrumentation via active support][1].
+## Instrumentation
 
-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.
@@ -291,26 +294,11 @@ 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
 
-## Roadmap
-
-* Update
-    * Better new? detection eg. storing ETag from request resources.
-    * Use PATCH for with only changed attributes and `If-Unmodifed-Since`
-      and `If-Match` header fields if resource was surly loaded from service
-      and not created with an id (e.g `User.new id: 5, name: "john"`).
-    * Conflict detection (ETag / If-Unmodified-Since)
-* High level features
-    * Support for custom mime types on client and server side. (`application/vnd.myservice.user.v2+msgpack`)
-    * Server side components
-        * Reusing model definitions for generating responses?
-        * Rails responders providing REST operations with integrated ETag,
-          Modified Headers, conflict detection, ...
-* Documentation
 
 ## Contributing
 
@@ -322,14 +310,9 @@ Read [official guide][2] to see to to subscribe.
 7. Push to the branch (`git push origin my-new-feature`)
 8. Create new Pull Request
 
-## Contributors
-
-* [Nicolas Fricke](https://github.com/nicolas-fricke)
-* [Tino Junge](https://github.com/tino-junge)
-* [Malte Swart](https://github.com/mswart)
 
 ## License
 
 MIT License
 
-Copyright (c) 2013 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.*)
@@ -25,22 +27,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = %w[lib]
 
-  spec.add_runtime_dependency 'actionpack', '>= 4.2'
-  spec.add_runtime_dependency 'activemodel', '>= 4.2'
-  spec.add_runtime_dependency 'activesupport', '>= 4.2'
-  spec.add_runtime_dependency 'multi_json'
-
-  # Bundle update w/o version resolves to 0.3.3 ...
-  spec.add_runtime_dependency 'typhoeus', '~> 1.0'
+  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.add_development_dependency 'bundler'
-
-  if ENV['TRAVIS_BUILD_NUMBER'] && !ENV['TRAVIS_TAG']
-    # Append travis build number for auto-releases
-    # rubocop:disable Gemspec/DuplicatedAssignment
-    spec.version = "#{spec.version}.1.b#{ENV['TRAVIS_BUILD_NUMBER']}"
-    # rubocop:enable Gemspec/DuplicatedAssignment
-  end
 end

data/lib/acfs/adapter/base.rb

@@ -5,6 +5,8 @@ module Acfs::Adapter
   # and processing.
   #
   class Base
+    def initialize(*); end
+
     # Start processing queued requests.
     #
     def start; end

data/lib/acfs/adapter/typhoeus.rb

@@ -7,14 +7,19 @@ module Acfs
     DEFAULT_OPTIONS = {
       tcp_keepalive: true,
       tcp_keepidle: 5,
-      tcp_keepintvl: 5
+      tcp_keepintvl: 5,
     }.freeze
 
     # Adapter for Typhoeus.
     #
     class Typhoeus < Base
-      def initialize(opts: {}, **kwargs)
-        @opts = DEFAULT_OPTIONS.merge(opts)
+      def initialize(**kwargs)
+        super
+
+        extra_opts = kwargs.delete(:opts)
+
+        @opts = DEFAULT_OPTIONS
+        @opts = @opts.merge(extra_opts) if extra_opts
         @kwargs = kwargs
       end
 
@@ -47,22 +52,22 @@ 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.merge(opts))
+        request = ::Typhoeus::Request.new(req.url, **@opts, **opts)
 
         request.on_complete do |response|
-          if response.timed_out?
-            raise ::Acfs::TimeoutError.new(req)
-          elsif response.code.zero?
+          raise ::Acfs::TimeoutError.new(req) if response.timed_out?
+
+          if response.code.zero?
             # Failed to get HTTP response
             raise ::Acfs::RequestError.new(req, response.return_message)
-          else
-            req.complete! convert_response(req, response)
           end
+
+          req.complete! convert_response(req, response)
         end
 
         request

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, &_block)
         opts[:url]
       end
 

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
@@ -26,7 +26,7 @@ module Acfs
 
   class TimeoutError < RequestError
     def initialize(request)
-      super(request, "Timeout reached")
+      super(request, 'Timeout reached')
     end
   end
 
@@ -38,13 +38,13 @@ module Acfs
     def initialize(opts = {})
       @response = opts[:response]
 
-      if response
-        message = (opts[:message] ? opts[:message] + ':' : 'Received') +
-                  " #{response.code} for #{response.request.method.upcase}" \
-                  " #{response.request.url} #{response.request.format}"
-      else
-        message = opts[:message] || 'Received erroneous response'
-      end
+      message = if response
+                  (opts[:message] ? "#{opts[:message]}:" : 'Received') +
+                    " #{response.code} for #{response.request.method.upcase}" \
+                    " #{response.request.url} #{response.request.format}"
+                else
+                  opts[:message] || 'Received erroneous response'
+                end
 
       super opts, message
     end
@@ -67,11 +67,19 @@ module Acfs
     end
   end
 
-  # Resource not found error raised on a 404 response
-  #
-  class ResourceNotFound < ErroneousResponse
-  end
+  # 400
+  class BadRequest < ErroneousResponse; end
+
+  # 401
+  class Unauthorized < ErroneousResponse; end
+
+  # 403
+  class Forbidden < ErroneousResponse; end
 
+  # 404
+  class ResourceNotFound < ErroneousResponse; end
+
+  # 422
   class InvalidResource < ErroneousResponse
     attr_reader :errors, :resource
 
@@ -79,18 +87,31 @@ module Acfs
       @errors   = opts.delete :errors
       @resource = opts.delete :resource
 
-      if @errors.is_a?(Hash)
-        opts[:message] ||= @errors.each_pair.map do |k, v|
-          @errors.is_a?(Array) ? "#{k}: #{v.join(', ')}" : "#{k}: #{v}"
-        end.join ', '
-      elsif @errors.is_a?(Array)
-        opts[:message] ||= @errors.join ', '
+      case @errors
+        when Hash
+          opts[:message] ||= @errors.each_pair.map do |k, v|
+            @errors.is_a?(Array) ? "#{k}: #{v.join(', ')}" : "#{k}: #{v}"
+          end.join ', '
+        when Array
+          opts[:message] ||= @errors.join ', '
       end
 
       super
     end
   end
 
+  # 500
+  class ServerError < ErroneousResponse; end
+
+  # 502
+  class BadGateway < ErroneousResponse; end
+
+  # 503
+  class ServiceUnavailable < ErroneousResponse; end
+
+  # 504
+  class GatewayTimeout < ErroneousResponse; end
+
   # A ResourceNotLoaded error will be thrown when calling some
   # modifing methods on not loaded resources as it is usally
   # unwanted to call e.g. `update_attributes` on a not loaded
@@ -111,8 +132,7 @@ module Acfs
   # parent resource. Check if the type is set to the correct
   # Acfs::Resource Name
   class ResourceTypeError < Error
-    attr_reader :base_class
-    attr_reader :type_name
+    attr_reader :base_class, :type_name
 
     def initialize(opts = {})
       @base_class    = opts.delete :base_class

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

@@ -6,36 +6,31 @@ module Acfs
   # Describes a URL with placeholders.
   #
   class Location
-    attr_reader :arguments, :raw, :struct, :args
+    attr_reader :arguments, :raw, :struct, :vars
 
     REGEXP = /^:([A-z][A-z0-9_]*)$/.freeze
 
-    def initialize(uri, args = {})
+    def initialize(uri, vars = {})
       @raw       = URI.parse uri
-      @args      = args
+      @vars      = vars
       @struct    = raw.path.split('/').reject(&:empty?).map {|s| s =~ REGEXP ? Regexp.last_match[1].to_sym : s }
       @arguments = struct.select {|s| s.is_a?(Symbol) }
     end
 
-    def build(args = {})
-      unless args.is_a?(Hash)
-        raise ArgumentError.new "URI path arguments must be a hash, `#{args.inspect}' given."
-      end
-
-      self.class.new raw.to_s, args.merge(self.args)
+    def build(vars)
+      self.class.new raw.to_s, vars.stringify_keys.merge(self.vars)
     end
 
     def extract_from(*args)
-      args = {}.tap do |collect|
-        arguments.each {|key| collect[key] = extract_arg key, args }
-      end
+      vars = {}
+      arguments.each {|key| vars[key.to_s] = extract_arg(key, args) }
 
-      build args
+      build(vars)
     end
 
     def str
       uri = raw.dup
-      uri.path = '/' + struct.map {|s| lookup_arg(s, args) }.join('/')
+      uri.path = "/#{struct.map {|s| lookup_variable(s) }.join('/')}"
       uri.to_s
     end
 
@@ -49,34 +44,33 @@ module Acfs
     def extract_arg(key, hashes)
       hashes.each_with_index do |hash, index|
         if hash.key?(key)
-          return (index == 0 ? hash.delete(key) : hash.fetch(key))
+          return (index.zero? ? hash.delete(key) : hash.fetch(key))
         end
       end
 
       nil
     end
 
-    def lookup_arg(arg, args)
-      arg.is_a?(Symbol) ? lookup_replacement(arg, args) : arg
-    end
+    def lookup_variable(name)
+      return name unless name.is_a?(Symbol)
+
+      value = vars.fetch(name.to_s) do
+        if @raise.nil? || @raise
+          raise ArgumentError.new <<~ERROR.strip
+            URI path argument `#{name}' missing on `#{self}'. Given: `#{vars}.inspect'
+          ERROR
+        end
 
-    def lookup_replacement(sym, args)
-      value = get_replacement(sym, args).to_s
-      return ::URI.encode_www_form_component(value) unless value.empty?
+        ":#{name}"
+      end
 
-      raise ArgumentError.new "Cannot replace path argument `#{sym}' with empty string."
-    end
+      value = value.to_s.strip
 
-    def get_replacement(sym, args)
-      args.fetch(sym.to_s) do
-        args.fetch(sym) do
-          if args[:raise].nil? || args[:raise]
-            raise ArgumentError.new "URI path argument `#{sym}' missing on `#{self}'. Given: `#{args}.inspect'"
-          else
-            ":#{sym}"
-          end
-        end
+      if value.empty?
+        raise ArgumentError.new "Cannot replace path argument `#{name}' with empty string."
       end
+
+      ::URI.encode_www_form_component(value)
     end
   end
 end

data/lib/acfs/middleware/base.rb

@@ -8,9 +8,9 @@ module Acfs
     class Base
       attr_reader :app, :options
 
-      def initialize(app, options = {})
+      def initialize(app, **opts)
         @app     = app
-        @options = options
+        @options = opts
       end
 
       def call(request)

data/lib/acfs/middleware/json.rb

@@ -12,11 +12,13 @@ module Acfs
       end
 
       def encode(data)
-        ::MultiJson.dump data
+        ::MultiJson.dump(data)
       end
 
       def decode(body)
-        ::MultiJson.load body
+        ::MultiJson.load(body)
+      rescue ::MultiJson::ParseError => e
+        raise ::JSON::ParserError.new(e)
       end
     end
 

data/lib/acfs/middleware/logger.rb

@@ -7,19 +7,17 @@ module Acfs
     # Log requests and responses.
     #
     class Logger < Base
-      def initialize(app, options = {})
+      attr_reader :logger
+
+      def initialize(app, **opts)
         super
-        @logger = options[:logger] if options[:logger]
+        @logger = options[:logger] || ::Logger.new($stdout)
       end
 
       def response(res, nxt)
         logger.info "[ACFS] #{res.request.method.to_s.upcase} #{res.request.url} -> #{res.status}"
         nxt.call res
       end
-
-      def logger
-        @logger ||= ::Logger.new STDOUT
-      end
     end
   end
 end

data/lib/acfs/middleware/serializer.rb

@@ -29,7 +29,7 @@ module Acfs
         request.headers['Accept'] = accept.join(',')
 
         request.on_complete do |response, nxt|
-          response.data = decode response.body if mime == response.content_type
+          response.data = decode(response.body) if mime == response.content_type
 
           nxt.call response
         end