acfs 1.3.2 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e970f81dff63a351279207100701f7a9be822272a77e5dfc3bd39d9e418a0db
-  data.tar.gz: 81b752674659595a097b951334bb41fa36f9a96de2f3b7ff0a1a82d3e03f0009
+  metadata.gz: 55e1388e9df4207138b2a54f1e9d56c349ac407e52364b849887e9682abfee7e
+  data.tar.gz: ccf1b3550de8f5222988333d14e480ec07742fb0398d3adfb9504be4ca4168b4
 SHA512:
-  metadata.gz: 4d8363f66d917672285318eaf1f68f03c3ef28c560373b4e74054f5d5d4da7dd0a443f6b54c9835fafbd290921e2d8316195a3c015970e539baa37fb8bead339
-  data.tar.gz: 73d009dc5601ba4e4cc06efb41a0990a58779726b86ebf4905c2967dba55de406085b83e9a7c3de71b860e748bae1ff39b2a59de91a2699c488ced2d689d9234
+  metadata.gz: d34c6fd3d4e83e22757633efc72c8d399778b86665f4b5bb6fb46c8d4f93782f996fe307904ac83f9b16701157ecb8418977466cad9d9c5a78c6ea1074e9ddd7
+  data.tar.gz: 3460436cd3a9d61241155658e4c46ef556b69d00fd389aca73c78ca6484b29bac9b3c45a0fd310b41259aba68f8aad55c7ca95a259e18075c2d88b2515bacd52

data/CHANGELOG.md

@@ -14,6 +14,45 @@
 ### Breaks
 
 
+## 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)
+---
+
+### 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)
 
 

data/README.md

@@ -1,7 +1,8 @@
 # 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)
 [![RubyDoc Documentation](http://img.shields.io/badge/rubydoc-here-blue.svg)](http://rubydoc.info/github/jgraichen/acfs/master/frames)
 
@@ -9,6 +10,7 @@ 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 on a per service level and automatic request queuing and parallel processing. See Usage for more.
 
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -23,6 +25,7 @@ Or install it yourself as:
 
     > gem install acfs
 
+
 ## Usage
 
 First you need to define your service(s):
@@ -144,6 +147,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`:
@@ -182,6 +186,7 @@ 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
@@ -218,6 +223,7 @@ Acfs.run
 @computer[2].class # => Pc
 ```
 
+
 ## Stubbing
 
 You can stub resources in applications using an Acfs service client:
@@ -278,6 +284,7 @@ it 'should find user number one' do
 end
 ```
 
+
 ## Instrumentation
 
 Acfs supports [instrumentation via active support][1].
@@ -295,21 +302,6 @@ Read [official guide][2] to see to to subscribe.
 [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
 
@@ -321,14 +313,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-2020 Jan Graichen. MIT license, see LICENSE for more details.

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,31 +8,29 @@ 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.add_runtime_dependency 'activesupport', '>= 4.2'
-  spec.add_runtime_dependency 'activemodel', '>= 4.2'
-  spec.add_runtime_dependency 'actionpack', '>= 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.require_paths = %w[lib]
 
+  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
-    spec.version = "#{spec.version}.1.b#{ENV['TRAVIS_BUILD_NUMBER']}"
-  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,20 +38,30 @@ 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|
+          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)
+          end
+
           req.complete! convert_response(req, response)
         end
 

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
 
@@ -67,8 +68,8 @@ module Acfs::Collections
     def setup_params(params)
       @current_page = begin
         Integer params.fetch(:page, 1)
-      rescue ArgumentError
-        params[:page]
+                      rescue ArgumentError
+                        params[:page]
       end
     end
   end

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}"
-      else
-        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
   end
@@ -41,17 +59,27 @@ 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
 
-  # 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
 
@@ -71,6 +99,18 @@ module Acfs
     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
@@ -97,7 +137,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