acfs 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81eada64bf268a7ee4bdec316baf65e2f8ca0ac8cd80120474dfede36d4b4f51
-  data.tar.gz: b5a0d11f1eb60c8bfb16ccd66a8d7ee8f09fcaeea8976f47540239725a08d08b
+  metadata.gz: 6f998ff3e28801676c732fa44df93e18f651e96eb986c857c61b7f25b312a2c1
+  data.tar.gz: a122064cb630a664489629ef658d5ecde917ced4cdc43a600b49d0e18e00bea7
 SHA512:
-  metadata.gz: 2cb0a9482b37b1a57bfad86f4213040d27babbf2cd6d4496a93b3260e50435ff1c575d57ba4a0d48b22ada2a3fbda44289283da1032fe3ecdc6010fe39f7646e
-  data.tar.gz: b21823474d56cdda6ca816f21d3f76674aa00a4d2636ec0dedc15deecd17469ef55716688306a654952bee4438b5ce338cc2471b4db644852daaa09e0b2bbc4c
+  metadata.gz: 7801c96d794f08ad03b9ad204f8e7c8b611300922b12714ce7864a33c5a6268bc47c42e66b86c410358f17a0439d382c358ba15283eee07ff092d19a1f86a8be
+  data.tar.gz: 78b2c804251fb6aaee270d9c894ff36b7b8dc7bb777148de55963255847fc28adcdbff9c7132352c5448bef7b9980fd72e6a14ffceda38540d661aceaf1e5e9d

data/CHANGELOG.md

@@ -1,5 +1,55 @@
 # Changelog
 
+
+
+## Unreleased
+---
+
+### New
+
+### Changes
+
+### Fixes
+
+### Breaks
+
+
+## 1.4.0 - (2020-06-12)
+---
+
+### New
+* Use strict TCP keepalive 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
+
+
+## 1.3.3 - (2020-03-22)
+---
+
+### Changes
+* 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)
+
+
+---
+
+## 1.3.1 - (2019-07-02)
+
+### Fixes
+* 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.

data/README.md

@@ -1,10 +1,9 @@
 # Acfs - *API client for services*
 
-[![Gem Version](https://badge.fury.io/rb/acfs.svg)](http://badge.fury.io/rb/acfs)
-[![Build Status](http://img.shields.io/travis/jgraichen/acfs/master.svg)](https://travis-ci.org/jgraichen/acfs)
+[![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)
 [![Coverage Status](http://img.shields.io/coveralls/jgraichen/acfs/master.svg)](https://coveralls.io/r/jgraichen/acfs)
-[![Code Climate](http://img.shields.io/codeclimate/github/jgraichen/acfs.svg)](https://codeclimate.com/github/jgraichen/acfs)
-[![Dependency Status](http://img.shields.io/gemnasium/jgraichen/acfs.svg)](https://gemnasium.com/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.

data/acfs.gemspec

@@ -1,5 +1,6 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'acfs/version'
 
@@ -7,20 +8,26 @@ Gem::Specification.new do |spec|
   spec.name          = 'acfs'
   spec.version       = Acfs::VERSION
   spec.authors       = ['Jan Graichen']
-  spec.email         = %w(jg@altimos.de)
-  spec.description   = 'API Client For Services'
-  spec.summary       = 'An abstract API base client for service oriented application.'
+  spec.email         = %w[jgraichen@altimos.de]
   spec.homepage      = 'https://github.com/jgraichen/acfs'
   spec.license       = 'MIT'
+  spec.description   = 'API Client For Services'
+  spec.summary       = <<~SUMMARY.strip
+    An abstract API base client for service oriented application.
+  SUMMARY
+
+  spec.files = Dir['**/*'].grep(%r{
+    ^((bin|lib|test|spec|features)/|
+    .*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)
+  }xi)
 
-  spec.files         = Dir['**/*'].grep(%r{^((bin|lib|test|spec|features)/|.*\.gemspec|.*LICENSE.*|.*README.*|.*CHANGELOG.*)})
   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.require_paths = %w[lib]
 
-  spec.add_runtime_dependency 'activesupport', '>= 4.2'
-  spec.add_runtime_dependency 'activemodel', '>= 4.2'
   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 ...
@@ -28,10 +35,12 @@ Gem::Specification.new do |spec|
 
   spec.add_runtime_dependency 'rack'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  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.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support'
 require 'active_support/core_ext/hash'
 require 'active_support/core_ext/class'

data/lib/acfs/adapter/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Acfs::Adapter
   # Base adapter handling operation queuing
   # and processing.
@@ -5,22 +7,18 @@ module Acfs::Adapter
   class Base
     # Start processing queued requests.
     #
-    def start
-    end
+    def start; end
 
     # Abort running and queued requests.
     #
-    def abort
-    end
+    def abort; end
 
     # Run request right now skipping queue.
     #
-    def run(_)
-    end
+    def run(_); end
 
     # Enqueue request to be run later.
     #
-    def queue(_)
-    end
+    def queue(_); end
   end
 end

data/lib/acfs/adapter/typhoeus.rb

@@ -1,17 +1,26 @@
+# frozen_string_literal: true
+
 require 'typhoeus'
 
 module Acfs
   module Adapter
+    DEFAULT_OPTIONS = {
+      tcp_keepalive: true,
+      tcp_keepidle: 5,
+      tcp_keepintvl: 5
+    }.freeze
+
     # Adapter for Typhoeus.
     #
     class Typhoeus < Base
-      def initialize(**kwargs)
-        @options = kwargs
+      def initialize(opts: {}, **kwargs)
+        @opts = DEFAULT_OPTIONS.merge(opts)
+        @kwargs = kwargs
       end
 
       def start
         hydra.run
-      rescue
+      rescue StandardError
         @hydra = nil
         raise
       end
@@ -29,21 +38,31 @@ module Acfs
       protected
 
       def hydra
-        @hydra ||= ::Typhoeus::Hydra.new(**@options)
+        @hydra ||= ::Typhoeus::Hydra.new(**@kwargs)
       end
 
       def convert_request(req)
-        request = ::Typhoeus::Request.new req.url,
+        opts = {
           method: req.method,
           params: req.params,
           headers: req.headers.merge(
-            'Expect'            => '',
+            'Expect' => '',
             'Transfer-Encoding' => ''
           ),
           body: req.body
+        }
+
+        request = ::Typhoeus::Request.new(req.url, **@opts.merge(opts))
 
         request.on_complete do |response|
-          req.complete! convert_response(req, response)
+          if response.timed_out?
+            raise ::Acfs::TimeoutError.new(req)
+          elsif response.code.zero?
+            # Failed to get HTTP response
+            raise ::Acfs::RequestError.new(req, response.return_message)
+          else
+            req.complete! convert_response(req, response)
+          end
         end
 
         request

data/lib/acfs/collection.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 require 'delegate'
 
 require 'acfs/resource/loadable'
 require 'acfs/collections/paginatable'
 
 module Acfs
-  #
   class Collection < ::Delegator
     include Resource::Loadable
     include Acfs::Util::Callbacks

data/lib/acfs/collections/paginatable.rb

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 module Acfs::Collections
-  #
   module Paginatable
     extend ActiveSupport::Concern
 

data/lib/acfs/configuration.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'yaml'
 
@@ -25,7 +27,7 @@ module Acfs
     # @return [undefined]
     #
     def configure(&block)
-      if block.arity > 0
+      if block.arity.positive?
         block.call self
       else
         instance_eval(&block)
@@ -37,8 +39,12 @@ module Acfs
     # @overload locate(service, uri)
     #   Configures URL where a service can be reached.
     #
-    #   @param [Symbol] service Service identity key for service that is reachable under given URL.
-    #   @param [String] uri URL where service is reachable. Will be passed to {URI.parse}.
+    #   @param [Symbol] service
+    #     Service identity key for service that is reachable under given URL.
+    #
+    #   @param [String] uri
+    #     URL where service is reachable. Will be passed to {URI.parse}.
+    #
     #   @return [undefined]
     #
     # @overload locate(service)
@@ -64,7 +70,7 @@ module Acfs
     # @return [undefined]
     #
     def load(filename)
-      config = YAML.load File.read filename
+      config = YAML.safe_load(File.read(filename), [], [], true)
       env    = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
 
       config = config[env] if config.key? env
@@ -95,18 +101,19 @@ module Acfs
       # @return [Configuration]
       #
       def current
-        @configuration ||= new
+        @current ||= new
       end
 
       # @api private
       #
-      # Swap configuration object with given new one. Must be a {Configuration} object.
+      # Swap configuration object with given new one. Must be
+      # a {Configuration} object.
       #
       # @param [Configuration] configuration
       # @return [undefined]
       #
       def set(configuration)
-        @configuration = configuration if configuration.is_a? Configuration
+        @current = configuration if configuration.is_a? Configuration
       end
     end
   end

data/lib/acfs/errors.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Acfs
   # Acfs base error.
   #
@@ -10,6 +12,24 @@ module Acfs
 
   class UnsupportedOperation < StandardError; end
 
+  class RequestError < Error
+    attr_reader :request
+
+    def initialize(request, message)
+      @request = request
+
+      message = "#{message}: #{request.method.upcase} #{request.url}"
+
+      super message: message
+    end
+  end
+
+  class TimeoutError < RequestError
+    def initialize(request)
+      super(request, "Timeout reached")
+    end
+  end
+
   # Response error containing the responsible response object.
   #
   class ErroneousResponse < Error
@@ -17,17 +37,15 @@ module Acfs
 
     def initialize(opts = {})
       @response = opts[:response]
-      message = opts[:message]
+
       if response
-        if message
-          message << ':'
-        else
-          message = 'Received'
-        end
-        message << " #{response.code} for #{response.request.method.upcase} #{response.request.url} #{response.request.format}"
+        message = (opts[:message] ? opts[:message] + ':' : 'Received') +
+                  " #{response.code} for #{response.request.method.upcase}" \
+                  " #{response.request.url} #{response.request.format}"
       else
-        message ||= 'Received erroneous response'
+        message = opts[:message] || 'Received erroneous response'
       end
+
       super opts, message
     end
   end
@@ -41,8 +59,11 @@ module Acfs
       @stubs     = opts.delete :stubs
       @operation = opts.delete :operation
 
-      super opts, "Ambiguous stubs for #{operation.action} on #{operation.resource}.\n" +
-        stubs.map {|s| "  #{s.opts.pretty_inspect}" }.join
+      message = "Ambiguous stubs for #{operation.action} " \
+                "on #{operation.resource}.\n" +
+                stubs.map {|s| "  #{s.opts.pretty_inspect}" }.join
+
+      super opts, message
     end
   end
 
@@ -51,7 +72,6 @@ module Acfs
   class ResourceNotFound < ErroneousResponse
   end
 
-  #
   class InvalidResource < ErroneousResponse
     attr_reader :errors, :resource
 
@@ -97,7 +117,8 @@ module Acfs
     def initialize(opts = {})
       @base_class    = opts.delete :base_class
       @type_name     = opts.delete :type_name
-      opts[:message] = "Received resource type `#{type_name}` is no subclass of #{base_class}"
+      opts[:message] = "Received resource type `#{type_name}` " \
+                       "is no subclass of #{base_class}"
       super
     end
   end

data/lib/acfs/global.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Acfs
   #
   # Global Acfs module methods.
@@ -73,7 +75,7 @@ module Acfs
       end
       return false if block.nil?
 
-      if resource.loaded?
+      if resource.nil? || resource.loaded?
         block.call resource
       else
         resource.__callbacks__ << block
@@ -81,9 +83,17 @@ module Acfs
     end
 
     def on(*resources)
+      # If all resources have already been loaded, we run the callback immediately.
+      if resources.all? {|res| res.nil? || res.loaded? }
+        yield(*resources)
+        return
+      end
+
+      # Otherwise, we add a callback to *each* resource with a guard that ensures
+      # that only the very last resource being loaded executes the callback.
       resources.each do |resource|
         add_callback resource do |_|
-          yield(*resources) unless resources.any? {|res| !res.loaded? }
+          yield(*resources) if resources.all? {|res| res.nil? || res.loaded? }
         end
       end
     end

data/lib/acfs/location.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Acfs
   # @api private
   #
@@ -6,7 +8,7 @@ module Acfs
   class Location
     attr_reader :arguments, :raw, :struct, :args
 
-    REGEXP = /^:([A-z][A-z0-9_]*)$/
+    REGEXP = /^:([A-z][A-z0-9_]*)$/.freeze
 
     def initialize(uri, args = {})
       @raw       = URI.parse uri
@@ -33,20 +35,22 @@ module Acfs
 
     def str
       uri = raw.dup
-      uri.path = URI.escape '/' + struct.map {|s| lookup_arg(s, args) }.join('/')
+      uri.path = '/' + struct.map {|s| lookup_arg(s, args) }.join('/')
       uri.to_s
     end
 
     def raw_uri
       raw.to_s
     end
-    alias_method :to_s, :raw_uri
+    alias to_s raw_uri
 
     private
 
     def extract_arg(key, hashes)
       hashes.each_with_index do |hash, index|
-        return (index == 0 ? hash.delete(key) : hash.fetch(key)) if hash.key?(key)
+        if hash.key?(key)
+          return (index == 0 ? hash.delete(key) : hash.fetch(key))
+        end
       end
 
       nil
@@ -58,7 +62,7 @@ module Acfs
 
     def lookup_replacement(sym, args)
       value = get_replacement(sym, args).to_s
-      return value unless value.empty?
+      return ::URI.encode_www_form_component(value) unless value.empty?
 
       raise ArgumentError.new "Cannot replace path argument `#{sym}' with empty string."
     end