acfs 0.42.0 → 0.43.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59a4956dd778b88066cb532992954728f8a38001
-  data.tar.gz: 4a2f14333a5665525a7726687025e2090178364a
+  metadata.gz: 0f1766a2689f9c913392aa1043fe386ecef50182
+  data.tar.gz: de21e2406b4178106c085594630a24fe6a591f99
 SHA512:
-  metadata.gz: 5acf90afb3909391f0110986b30728154607038ec3d19c71b9234a40cd5570aee2efdd94ab9e10c450d34245ceac7582fa88ecef22bfe337ae8f5cdd8f512e95
-  data.tar.gz: 720856b5184ac360193393672befdf31df29fce15b5c77fcc2d875f2e03ded3d4851867bf62a4cc9a9919868614990ac489a38db39abf220b45911b70393cb6c
+  metadata.gz: fb2415918968e9bc642a3d4762acbfa3a4fb9222beb16b4f1eafe138a2aeb9e53dedcd7789b14908aff2428eb6948a800f3ebe59e138fef3e5aed03d089b775f
+  data.tar.gz: 57ac583c1f24ff0f1c12e9d4041496e96476675c8be3d60ace5d98c1f0cec270d6419d9edf7eff533c5e218db689368a4ee92ac58172370c8f12a27b9b754c5b

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 0.43.0
+
+* Remove `Acfs::Model` (inherit from `Acfs::Resource`)
+* Stub does only a partial match of `:with` attributes now
+* Allow blocks as stub `:return`s
+
 ## 0.42.0
 
 * Add simple dict attribute type

data/README.md

@@ -1,11 +1,11 @@
 # Acfs - *API client for services*
 
-[![Gem Version](https://badge.fury.io/rb/acfs.png)](http://badge.fury.io/rb/acfs)
-[![Build Status](https://travis-ci.org/jgraichen/acfs.png?branch=stable-0)](https://travis-ci.org/jgraichen/acfs)
-[![Coverage Status](https://coveralls.io/repos/jgraichen/acfs/badge.png?branch=stable-0)](https://coveralls.io/r/jgraichen/acfs)
-[![Code Climate](https://codeclimate.com/github/jgraichen/acfs.png)](https://codeclimate.com/github/jgraichen/acfs)
-[![Dependency Status](https://gemnasium.com/jgraichen/acfs.png)](https://gemnasium.com/jgraichen/acfs)
-[![RubyDoc Documentation](http://b.repl.ca/v1/rubydoc-here-blue.png)](http://rubydoc.info/github/jgraichen/acfs/master/frames)
+[![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)
+[![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.
 
@@ -250,8 +250,8 @@ it 'should find user number one' do
   expect(user.name).to be == 'John Smith'
   expect(user.age).to be == 32
 
-  expect(@stub).to has_called
-  expect(@stub).to_not have_called 5.times
+  expect(@stub).to be_called
+  expect(@stub).to_not be_called 5.times
 end
 
 it 'should not find user number two' do
@@ -288,7 +288,6 @@ Acfs supports [instrumentation via active support][1].
 
 Acfs expose to following events
 
-* `acfs.operation.before_process(operation)`: Acfs operation about to process
 * `acfs.operation.complete(operation, response)`: Acfs operation completed
 * `acfs.runner.sync_run(operation)`: Run operation right now skipping queue.
 * `acfs.runner.enqueue(operation)`: Enqueue operation to be run later.

data/acfs.gemspec

@@ -8,13 +8,13 @@ Gem::Specification.new do |spec|
   spec.version       = Acfs::VERSION
   spec.authors       = ['Jan Graichen']
   spec.email         = %w(jg@altimos.de)
-  spec.description   = %q{API Client For Services}
-  spec.summary       = %q{An abstract API base client for service oriented application.}
+  spec.description   = 'API Client For Services'
+  spec.summary       = 'An abstract API base client for service oriented application.'
   spec.homepage      = 'https://github.com/jgraichen/acfs'
   spec.license       = 'MIT'
 
   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.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)
 

data/lib/acfs.rb

@@ -15,7 +15,6 @@ module Acfs
   require 'acfs/collection'
   require 'acfs/configuration'
   require 'acfs/location'
-  require 'acfs/model'
   require 'acfs/operation'
   require 'acfs/request'
   require 'acfs/resource'
@@ -48,4 +47,3 @@ module Acfs
     require 'acfs/adapter/typhoeus'
   end
 end
-

data/lib/acfs/adapter/base.rb

@@ -1,10 +1,8 @@
 module Acfs::Adapter
-
   # Base adapter handling operation queuing
   # and processing.
   #
   class Base
-
     # Start processing queued requests.
     #
     def start

data/lib/acfs/adapter/typhoeus.rb

@@ -2,11 +2,9 @@ require 'typhoeus'
 
 module Acfs
   module Adapter
-
     # Adapter for Typhoeus.
     #
     class Typhoeus < Base
-
       def start
         hydra.run
       rescue
@@ -14,9 +12,7 @@ module Acfs
         raise
       end
 
-      def abort
-        hydra.abort
-      end
+      delegate :abort, to: :hydra
 
       def run(request)
         convert_request(request).run
@@ -26,7 +22,8 @@ module Acfs
         hydra.queue convert_request request
       end
 
-    protected
+      protected
+
       def hydra
         @hydra ||= ::Typhoeus::Hydra.new
       end
@@ -50,9 +47,9 @@ module Acfs
 
       def convert_response(request, response)
         Acfs::Response.new request,
-                           status: response.code,
-                           headers: response.headers,
-                           body: response.body
+          status: response.code,
+          headers: response.headers,
+          body: response.body
       end
     end
   end

data/lib/acfs/collection.rb

@@ -1,12 +1,12 @@
 require 'delegate'
 
-require 'acfs/model/loadable'
+require 'acfs/resource/loadable'
 require 'acfs/collections/paginatable'
 
 module Acfs
-
+  #
   class Collection < ::Delegator
-    include Model::Loadable
+    include Resource::Loadable
     include Acfs::Util::Callbacks
     include Collections::Paginatable
 

data/lib/acfs/collections/paginatable.rb

@@ -1,19 +1,14 @@
 module Acfs::Collections
+  #
   module Paginatable
     extend ActiveSupport::Concern
 
     included do
-      def self.operation(action, opts = {}, &block)
+      def self.operation(_action, opts = {}, &_block)
         opts[:url]
       end
-    end
-
-    def total_pages
-      @total_pages
-    end
 
-    def current_page
-      @current_page
+      attr_reader :total_pages, :current_page
     end
 
     def process_response(response)
@@ -38,20 +33,21 @@ module Acfs::Collections
     end
 
     def page(rel, &block)
-      if relations[rel]
-        @resource_class.all nil, url: relations[rel], &block
-      else
-        raise ArgumentError.new "No relative page `#{rel}'."
-      end
+      return unless relations[rel]
+
+      @resource_class.all nil, url: relations[rel], &block
     end
 
     private
+
     def relations
       @relations ||= {}
     end
 
     def setup_headers(headers)
-      @total_pages  = Integer(headers['X-Total-Pages']) if headers['X-Total-Pages']
+      if headers['X-Total-Pages']
+        @total_pages = Integer(headers['X-Total-Pages'])
+      end
 
       setup_links headers['Link'] if headers['Link']
     end
@@ -59,13 +55,17 @@ module Acfs::Collections
     def setup_links(links)
       links.split(/,\s+/).each do |link|
         if link =~ /^\s*<([^>]+)>.*\s+rel="([\w_-]+)".*$/
-          relations[$2] = $1
+          relations[Regexp.last_match[2]] = Regexp.last_match[1]
         end
       end
     end
 
     def setup_params(params)
-      @current_page = Integer(params.fetch(:page, 1)) rescue params[:page]
+      @current_page = begin
+        Integer params.fetch(:page, 1)
+      rescue ArgumentError
+        params[:page]
+      end
     end
   end
 end

data/lib/acfs/configuration.rb

@@ -2,7 +2,6 @@ require 'uri'
 require 'yaml'
 
 module Acfs
-
   # Acfs configuration is used to locate services and get their base URLs.
   #
   class Configuration
@@ -28,7 +27,7 @@ module Acfs
       if block.arity > 0
         block.call self
       else
-        instance_eval &block
+        instance_eval(&block)
       end
     end
 
@@ -64,10 +63,10 @@ module Acfs
     # @return [undefined]
     #
     def load(filename)
-      config = YAML::load File.read filename
+      config = YAML.load File.read filename
       env    = ENV['RACK_ENV'] || ENV['RAILS_ENV'] || 'development'
 
-      config = config[env] if config.has_key? env
+      config = config[env] if config.key? env
       config.each do |key, value|
         case key
           when 'services' then load_services value
@@ -88,7 +87,6 @@ module Acfs
     end
 
     class << self
-
       # @api private
       #
       # Return current configuration object.

data/lib/acfs/errors.rb

@@ -1,5 +1,4 @@
 module Acfs
-
   # Acfs base error.
   #
   class Error < StandardError
@@ -9,6 +8,8 @@ module Acfs
     end
   end
 
+  class UnsupportedOperation < StandardError; end
+
   # Response error containing the responsible response object.
   #
   class ErroneousResponse < Error
@@ -21,20 +22,20 @@ module Acfs
         message << ": #{response.code}"
         if response.data
           message << "\n  with content:\n    "
-          message << response.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
+          message << response.data.map {|k, v| "#{k.inspect}: #{v.inspect}" }.join("\n    ")
         end
         if response.headers.any?
           message << "\n  with headers:\n    "
-          message << response.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
+          message << response.headers.map {|k, v| "#{k}: #{v}" }.join("\n    ")
         end
         message << "\nbased on request: #{response.request.method.upcase} #{response.request.url} #{response.request.format}"
         if response.request.data
           message << "\n  with content:\n    "
-          message << response.request.data.map{|k,v| "#{k.inspect}: #{v.inspect}"}.join("\n    ")
+          message << response.request.data.map {|k, v| "#{k.inspect}: #{v.inspect}" }.join("\n    ")
         end
         if response.request.headers.any?
           message << "\n  with headers:\n    "
-          message << response.request.headers.map{|k,v| "#{k}: #{v}"}.join("\n    ")
+          message << response.request.headers.map {|k, v| "#{k}: #{v}" }.join("\n    ")
         end
       end
       super opts, message
@@ -50,7 +51,6 @@ module Acfs
 
       super opts, 'Ambiguous stubs.'
     end
-
   end
 
   # Resource not found error raised on a 404 response
@@ -58,13 +58,14 @@ module Acfs
   class ResourceNotFound < ErroneousResponse
   end
 
+  #
   class InvalidResource < ErroneousResponse
     attr_reader :errors, :resource
 
     def initialize(opts = {})
       @errors   = opts.delete :errors
       @resource = opts.delete :resource
-      opts[:message] ||= @errors.map{ |k,v| "#{k}: #{v.join ', '}" }.join ', ' if @errors.is_a? Hash
+      opts[:message] ||= @errors.map {|k, v| "#{k}: #{v.join ', '}" }.join ', ' if @errors.is_a? Hash
       opts[:message] ||= @errors.join ', ' if @errors.is_a? Array
       super
     end

data/lib/acfs/global.rb

@@ -75,7 +75,7 @@ module Acfs
     def on(*resources)
       resources.each do |resource|
         add_callback resource do |_|
-          yield(*resources) unless resources.any?{|res| !res.loaded? }
+          yield(*resources) unless resources.any? {|res| !res.loaded? }
         end
       end
     end

data/lib/acfs/location.rb

@@ -1,5 +1,4 @@
 module Acfs
-
   # @api private
   #
   # Describes a URL with placeholders.
@@ -7,17 +6,17 @@ module Acfs
   class Location
     attr_reader :arguments, :raw, :struct, :args
 
-    REGEXP= /^:([A-z][A-z0-9_]*)$/
+    REGEXP = /^:([A-z][A-z0-9_]*)$/
 
     def initialize(uri, args = {})
       @raw       = URI.parse uri
       @args      = args
-      @struct    = raw.path.split('/').reject(&:empty?).map{|s| s =~ REGEXP ? $1.to_sym : s }
-      @arguments = struct.select{|s| Symbol === s }
+      @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 Hash === args
+      unless args.is_a?(Hash)
         raise ArgumentError.new "URI path arguments must be a hash, `#{args.inspect}' given."
       end
 
@@ -25,8 +24,8 @@ module Acfs
     end
 
     def extract_from(*args)
-      args = Hash.new.tap do |collect|
-        arguments.each{|key| collect[key] = extract_arg key, args }
+      args = {}.tap do |collect|
+        arguments.each {|key| collect[key] = extract_arg key, args }
       end
 
       build args
@@ -34,7 +33,7 @@ module Acfs
 
     def str
       uri = raw.dup
-      uri.path = URI.escape '/' + struct.map{|s| lookup_arg(s, args) }.join('/')
+      uri.path = URI.escape '/' + struct.map {|s| lookup_arg(s, args) }.join('/')
       uri.to_s
     end
 
@@ -44,16 +43,17 @@ module Acfs
     alias_method :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.has_key?(key)
+        return (index == 0 ? hash.delete(key) : hash.fetch(key)) if hash.key?(key)
       end
 
       nil
     end
 
     def lookup_arg(arg, args)
-      Symbol === arg ? lookup_replacement(arg, args) : arg
+      arg.is_a?(Symbol) ? lookup_replacement(arg, args) : arg
     end
 
     def lookup_replacement(sym, args)
@@ -67,7 +67,7 @@ module Acfs
       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 `#{to_s}'. Given: `#{args}.inspect'"
+            raise ArgumentError.new "URI path argument `#{sym}' missing on `#{self}'. Given: `#{args}.inspect'"
           else
             ":#{sym}"
           end

data/lib/acfs/middleware/base.rb

@@ -1,6 +1,5 @@
 module Acfs
   module Middleware
-
     # A base middleware that does not modify request or response.
     # Can be used as super class for custom middleware implementations.
     #
@@ -13,7 +12,7 @@ module Acfs
       end
 
       def call(request)
-        request.on_complete { |res, nxt| response(res, nxt) } if respond_to? :response
+        request.on_complete {|res, nxt| response(res, nxt) } if respond_to? :response
         app.call(request)
       end
     end

data/lib/acfs/middleware/json.rb

@@ -2,7 +2,6 @@ require 'multi_json'
 
 module Acfs
   module Middleware
-
     # A middleware to encore request data using JSON.
     #
     class JSON < Serializer

data/lib/acfs/middleware/logger.rb

@@ -2,11 +2,9 @@ require 'logger'
 
 module Acfs
   module Middleware
-
     # Log requests and responses.
     #
     class Logger < Base
-
       def initialize(app, options = {})
         super
         @logger = options[:logger] if options[:logger]