acfs 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6f998ff3e28801676c732fa44df93e18f651e96eb986c857c61b7f25b312a2c1
-  data.tar.gz: a122064cb630a664489629ef658d5ecde917ced4cdc43a600b49d0e18e00bea7
+  metadata.gz: 53acc88297d3217a5d01db2ce713f935835b05438471fd2b69918029b5480954
+  data.tar.gz: d61a2f4e5014dab37d4e1a857d548df8dfb42afcaba219005556f203ea68da65
 SHA512:
-  metadata.gz: 7801c96d794f08ad03b9ad204f8e7c8b611300922b12714ce7864a33c5a6268bc47c42e66b86c410358f17a0439d382c358ba15283eee07ff092d19a1f86a8be
-  data.tar.gz: 78b2c804251fb6aaee270d9c894ff36b7b8dc7bb777148de55963255847fc28adcdbff9c7132352c5448bef7b9980fd72e6a14ffceda38540d661aceaf1e5e9d
+  metadata.gz: 35f66d3569256b183cb7c78fed7c41f0ce916f41ec081e60696693af8b869d47e797a53474942c4847cefb621e58d3d52ddf629168c63b7b2d558d1db23cf74a
+  data.tar.gz: 5e03be0b16cb469061b55a3c4467a4fa71496925caa086ed5d024ed79aaefdcc568afd970d526c284b08b8db06593f51886d8642f035f78f2ed7f89bd1b8f311

data/CHANGELOG.md

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

@@ -10,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:
@@ -24,6 +25,7 @@ Or install it yourself as:
 
     > gem install acfs
 
+
 ## Usage
 
 First you need to define your service(s):
@@ -145,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`:
@@ -183,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
@@ -219,6 +223,7 @@ Acfs.run
 @computer[2].class # => Pc
 ```
 
+
 ## Stubbing
 
 You can stub resources in applications using an Acfs service client:
@@ -279,6 +284,7 @@ it 'should find user number one' do
 end
 ```
 
+
 ## Instrumentation
 
 Acfs supports [instrumentation via active support][1].
@@ -296,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
 
@@ -322,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

@@ -25,15 +25,11 @@ 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.add_runtime_dependency 'actionpack', '>= 5.2'
+  spec.add_runtime_dependency 'activemodel', '>= 5.2'
+  spec.add_runtime_dependency 'activesupport', '>= 5.2'
   spec.add_runtime_dependency 'rack'
+  spec.add_runtime_dependency 'typhoeus', '~> 1.0'
 
   spec.add_development_dependency 'bundler'
 

data/lib/acfs/adapter/typhoeus.rb

@@ -55,14 +55,14 @@ module Acfs
         request = ::Typhoeus::Request.new(req.url, **@opts.merge(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

@@ -68,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/errors.rb

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

data/lib/acfs/location.rb

@@ -49,7 +49,7 @@ 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
 
@@ -72,9 +72,9 @@ module Acfs
         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
+
+          ":#{sym}"
         end
       end
     end

data/lib/acfs/middleware/json.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'multi_json'
+require 'json'
 
 module Acfs
   module Middleware
@@ -12,11 +12,11 @@ module Acfs
       end
 
       def encode(data)
-        ::MultiJson.dump data
+        ::JSON.dump data
       end
 
       def decode(body)
-        ::MultiJson.load body
+        ::JSON.load body
       end
     end
 

data/lib/acfs/operation.rb

@@ -8,6 +8,7 @@ module Acfs
   #
   class Operation
     attr_reader :action, :params, :resource, :data, :callback, :location, :url
+
     delegate :service, to: :resource
     delegate :call, to: :callback
 
@@ -71,10 +72,24 @@ module Acfs
 
     def handle_failure(response)
       case response.code
+        when 400
+          raise ::Acfs::BadRequest.new response: response
+        when 401
+          raise ::Acfs::Unauthorized.new response: response
+        when 403
+          raise ::Acfs::Forbidden.new response: response
         when 404
           raise ::Acfs::ResourceNotFound.new response: response
         when 422
           raise ::Acfs::InvalidResource.new response: response, errors: response.data.try(:[], 'errors')
+        when 500
+          raise ::Acfs::ServerError.new response: response
+        when 502
+          raise ::Acfs::BadGateway.new response: response
+        when 503
+          raise ::Acfs::ServiceUnavailable.new response: response
+        when 504
+          raise ::Acfs::GatewayTimeout.new response: response
         else
           raise ::Acfs::ErroneousResponse.new response: response
       end

data/lib/acfs/request.rb

@@ -11,7 +11,6 @@ module Acfs
     attr_reader :url, :headers, :params, :data, :method, :operation
 
     include Request::Callbacks
-
     def initialize(url, options = {}, &block)
       @url = URI.parse(url.to_s).tap do |_url|
         @data    = options.delete(:data) || nil
@@ -20,7 +19,9 @@ module Acfs
         @params  = options.delete(:params) || {}
         @method  = options.delete(:method) || :get
       end.to_s
+
       @operation = options.delete(:operation) || nil
+
       on_complete(&block) if block_given?
     end
 

data/lib/acfs/request/callbacks.rb

@@ -45,9 +45,9 @@ module Acfs
       private
 
       def call_callback(res, index)
-        if index < callbacks.size
-          callbacks[index].call res, proc {|bres| call_callback bres, index + 1 }
-        end
+        return if index >= callbacks.size
+
+        callbacks[index].call(res, proc {|bres| call_callback bres, index + 1 })
       end
     end
   end

data/lib/acfs/resource/attributes.rb

@@ -48,9 +48,11 @@ class Acfs::Resource
     # @return [HashWithIndifferentAccess{Symbol => Object}]
     #   Attributes and their values.
     #
+    # rubocop:disable Naming/MemoizedInstanceVariableName
     def attributes
       @_attrs ||= HashWithIndifferentAccess.new
     end
+    # rubocop:enable Naming/MemoizedInstanceVariableName
 
     # @api public
     #

data/lib/acfs/resource/persistence.rb

@@ -244,8 +244,6 @@ class Acfs::Resource
       end
     end
 
-    private
-
     def update_with(data)
       self.attributes = data
       loaded!

data/lib/acfs/resource/query_methods.rb

@@ -258,7 +258,7 @@ class Acfs::Resource
         end
 
         klass
-      rescue NameError, NoMethodError
+      rescue NameError
         raise Acfs::ResourceTypeError.new type_name: type, base_class: self
       end
     end

data/lib/acfs/service.rb

@@ -40,21 +40,23 @@ module Acfs
 
       action = opts[:action] || :list
 
-      path = if opts[:path].is_a?(Hash) && opts[:path].key?(action)
-               opts[:path].fetch(action)
-             else
-               path = if opts[:path].is_a?(Hash)
-                        opts[:path][:all].to_s
-                      else
-                        opts[:path].to_s
-                      end
+      path = begin
+        if opts[:path].is_a?(Hash) && opts[:path].key?(action)
+          opts[:path].fetch(action)
+        else
+          path = if opts[:path].is_a?(Hash)
+                   opts[:path][:all].to_s
+                 else
+                   opts[:path].to_s
+                 end
 
-               if path.blank?
-                 path = (resource_class.name || 'class').pluralize.underscore
-               end
+          if path.blank?
+            path = (resource_class.name || 'class').pluralize.underscore
+          end
 
-               resource_class.location_default_path(action, path.strip)
-             end
+          resource_class.location_default_path(action, path.strip)
+        end
+      end
 
       if path.nil?
         raise ArgumentError.new "Location for `#{action}' explicit disabled by set to nil."
@@ -87,7 +89,10 @@ module Acfs
       #
       def base_url
         unless (base = Acfs::Configuration.current.locate identity)
-          raise ArgumentError.new "#{identity} not configured. Add `locate '#{identity.to_s.underscore}', 'http://service.url/'` to your configuration."
+          raise ArgumentError.new \
+            "#{identity} not configured. Add `locate '" \
+            "#{identity.to_s.underscore}', 'http://service.url/'` " \
+            'to your configuration.'
         end
 
         base.to_s

data/lib/acfs/stub.rb

@@ -16,7 +16,7 @@ module Acfs
       @opts[:with].stringify_keys! if @opts[:with].is_a? Hash
       @opts[:return].stringify_keys! if @opts[:return].is_a? Hash
 
-      if @opts[:return].is_a? Array
+      if @opts[:return].is_a?(Array) # rubocop:disable Style/GuardClause
         @opts[:return].map! {|h| h.stringify_keys! if h.is_a? Hash }
       end
     end
@@ -53,9 +53,8 @@ module Acfs
     end
 
     def called?(count = nil)
-      if count.respond_to? :count
-        count = count.count
-      end # For `5.times` Enumerators
+      count = count.count if count.respond_to?(:count)
+
       count.nil? ? calls.any? : calls.size == count
     end
 

data/lib/acfs/version.rb

@@ -3,7 +3,7 @@
 module Acfs
   module VERSION
     MAJOR = 1
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
     STAGE = nil
 

data/spec/acfs/global_spec.rb

@@ -122,8 +122,8 @@ describe ::Acfs::Global do
 
   describe '#runner' do
     it 'returns per-thread runner' do
-      runner1 = Thread.new { acfs.runner } .value
-      runner2 = Thread.new { acfs.runner } .value
+      runner1 = Thread.new { acfs.runner }.value
+      runner2 = Thread.new { acfs.runner }.value
 
       expect(runner1).to_not equal runner2
     end

data/spec/acfs/middleware/json_spec.rb

@@ -47,7 +47,7 @@ describe Acfs::Middleware::JSON do
       let(:body)    { data.to_json[4..-4] }
 
       it 'should raise an error' do
-        expect { request.complete! response }.to raise_error(MultiJson::LoadError)
+        expect { request.complete! response }.to raise_error(::JSON::ParserError)
       end
     end
 

data/spec/acfs/resource/attributes/float_spec.rb

@@ -35,7 +35,7 @@ describe Acfs::Resource::Attributes::Float do
 
     context 'with -Infinity' do
       let(:value) { '-Infinity' }
-      it { expect(subject.call).to eq -::Float::INFINITY }
+      it { expect(subject.call).to eq(-::Float::INFINITY) }
     end
 
     context 'with NaN' do

data/spec/acfs/resource/attributes_spec.rb

@@ -85,11 +85,9 @@ describe Acfs::Resource::Attributes do
 
         it do
           expect do
-            begin
-              subject.call
-            rescue StandardError
-              true
-            end
+            subject.call
+          rescue StandardError
+            true
           end.to_not change(m, :attributes)
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acfs
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-06-12 00:00:00.000000000 Z
+date: 2020-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -16,44 +16,44 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '5.2'
 - !ruby/object:Gem::Dependency
-  name: multi_json
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,20 +80,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-- !ruby/object:Gem::Dependency
-  name: rack
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement