acfs 1.0.0.dev.1.b305 → 1.0.0

data/lib/acfs/service.rb

@@ -1,7 +1,6 @@
 require 'acfs/service/middleware'
 
 module Acfs
-
   # User {Acfs::Service} to define your services. That includes
   # an identity used to identify the service in configuration files
   # and middlewares the service uses.
@@ -35,14 +34,14 @@ module Acfs
     # @return [Location]
     #
     def location(resource_class, opts = {})
-      opts.reverse_merge! self.options
+      opts.reverse_merge! options
 
       action = opts[:action] || :list
 
-      path = if Hash === opts[:path] && opts[:path].has_key?(action)
+      path = if opts[:path].is_a?(Hash) && opts[:path].key?(action)
                opts[:path].fetch(action)
              else
-               path = if Hash === opts[:path]
+               path = if opts[:path].is_a?(Hash)
                         opts[:path][:all].to_s
                       else
                         opts[:path].to_s
@@ -59,7 +58,6 @@ module Acfs
     end
 
     class << self
-
       # @api public
       #
       # @overload identity()
@@ -83,7 +81,7 @@ module Acfs
       #
       def base_url
         unless (base = Acfs::Configuration.current.locate identity)
-          raise ArgumentError, "#{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/service/middleware.rb

@@ -1,6 +1,7 @@
+require 'acfs/service/middleware/stack'
+
 module Acfs
   class Service
-
     # Module providing all function to register middlewares
     # on services and process queued request through the
     # middleware stack.
@@ -16,28 +17,25 @@ module Acfs
       end
 
       module ClassMethods
-
-        # @api public
+        # @!method use(klass, *args, &block)
+        #   @api public
         #
-        # Register a new middleware to be used for this service.
+        #   Register a new middleware to be used for this service.
         #
-        # @example
-        #   class MyService < Acfs::Service
-        #     self.base_url = 'http://my.srv'
-        #     use Acfs::Middleware::JsonDecoder
-        #   end
+        #   @example
+        #     class MyService < Acfs::Service
+        #       self.base_url = 'http://my.srv'
+        #       use Acfs::Middleware::JSON
+        #     end
         #
-        # @param [Class] klass Middleware class to instantiate and append to middleware stack.
-        # @param [Hash, Object] options Options to delegate to middleware class initializer.
-        # @return [undefined]
+        #   @param [Class] klass Middleware class to append
+        #   @param [Array<Object>] args Arguments passed to klass initialize
+        #   @param [Proc] block Block passed to klass initialize
+        #   @return [undefined]
         #
-        def use(klass, options = {})
-          @middlewares ||= []
-
-          return false if @middlewares.include? klass
-
-          @middlewares << klass
-          @middleware = klass.new(middleware, options)
+        def use(klass, *args, &block)
+          # Backward compatible behavior
+          middleware.insert(0, klass, *args, &block)
         end
 
         # @api private
@@ -47,19 +45,11 @@ module Acfs
         # @return [#call]
         #
         def middleware
-          @middleware ||= proc { |request| request}
+          @middleware ||= Stack.new
         end
 
-        # @api public
-        #
-        # Clear all registered middlewares.
-        #
-        # @return [undefined]
-        #
-        def clear
-          @middleware  = nil
-          @middlewares = []
-        end
+        # @deprecated
+        delegate :clear, to: :middleware
       end
     end
   end

data/lib/acfs/service/middleware/stack.rb

@@ -0,0 +1,63 @@
+module Acfs
+  class Service
+    module Middleware
+      class Stack
+        include Enumerable
+
+        MUTEX = Mutex.new
+        IDENTITY = -> (i) { i }
+
+        attr_reader :middlewares
+
+        def initialize
+          @middlewares = []
+        end
+
+        def call(request)
+          build! unless @app
+
+          @app.call request
+        end
+
+        def build!
+          return if @app
+
+          MUTEX.synchronize do
+            return if @app
+
+            @app = build
+          end
+        end
+
+        def build(app = IDENTITY)
+          middlewares.reverse.inject(app) do |next_middleware, current_middleware|
+            klass, args, block = current_middleware
+            args ||= []
+
+            if klass.is_a?(Class)
+              klass.new(next_middleware, *args, &block)
+            elsif klass.respond_to?(:call)
+              lambda do |env|
+                next_middleware.call(klass.call(env, *args))
+              end
+            else
+              fail "Invalid middleware, doesn't respond to `call`: #{klass.inspect}"
+            end
+          end
+        end
+
+        def insert(index, klass, *args, &block)
+          middlewares.insert(index, [klass, args, block])
+        end
+
+        def each
+          middlewares.each { |x| yield x.first }
+        end
+
+        def clear
+          middlewares.clear
+        end
+      end
+    end
+  end
+end

data/lib/acfs/singleton_resource.rb

@@ -1,5 +1,4 @@
 module Acfs
-
   # Acfs SingletonResources
   #
   # Usage explanation:
@@ -14,7 +13,6 @@ module Acfs
   # always only a single instance of the resource is being returned
   #
   class SingletonResource < Acfs::Resource
-
     # @api public
     #
     # Destroy resource by sending a DELETE request.

data/lib/acfs/stub.rb

@@ -1,7 +1,6 @@
 require 'rack/utils'
 
 module Acfs
-
   # Global handler for stubbing resources.
   #
   class Stub
@@ -14,7 +13,7 @@ module Acfs
 
       @opts[:with].stringify_keys! if @opts[:with].is_a? Hash
       @opts[:return].stringify_keys! if @opts[:return].is_a? Hash
-      @opts[:return].map! { |h| h.stringify_keys! if h.is_a? Hash } if @opts[:return].is_a? Array
+      @opts[:return].map! {|h| h.stringify_keys! if h.is_a? Hash } if @opts[:return].is_a? Array
     end
 
     def accept?(op)
@@ -22,14 +21,21 @@ module Acfs
 
       params = op.full_params.stringify_keys
       data   = op.data.stringify_keys
-
-      return true if opts[:with] == params || data == opts[:with]
-      return true if (opts[:with].nil? && params.empty? && data.empty?)
-
-      return true if opts[:with].reject { |k, v| v.nil? } == params.reject { |k, v| v.nil? }
-      return true if opts[:with].reject { |k, v| v.nil? } == data.reject { |k, v| v.nil? }
-
-      false
+      with   = opts[:with]
+
+      return true if with.nil?
+
+      case opts.fetch(:match, :inclusion)
+        when :legacy
+          return true if with.empty? && params.empty? && data.empty?
+          return true if with.reject {|_, v| v.nil? } == params.reject {|_, v| v.nil? }
+          return true if with.reject {|_, v| v.nil? } == data.reject {|_, v| v.nil? }
+          false
+        when :inclusion
+          with.each_pair.all? do |k, v|
+            (params.key?(k) && params[k] == v) || (data.key?(k) && data[k] == v)
+          end
+      end
     end
 
     def calls
@@ -50,17 +56,20 @@ module Acfs
       if err
         raise_error op, err, opts[:return]
       elsif data
+        data = data.call(op) if data.respond_to?(:call)
+
         response = Acfs::Response.new op.request,
-                                      headers: opts[:headers] || {},
-                                      status:  opts[:status] || 200,
-                                      data:    data || {}
+          headers: opts[:headers] || {},
+          status:  opts[:status] || 200,
+          data:    data || {}
         op.call data, response
       else
-        raise ArgumentError, 'Unsupported stub.'
+        raise ArgumentError.new 'Unsupported stub.'
       end
     end
 
     private
+
     def raise_error(op, name, data)
       raise name if name.is_a? Class
       data.stringify_keys! if data.respond_to? :stringify_keys!
@@ -69,13 +78,12 @@ module Acfs
     end
 
     class << self
-
       # Stub a resource with given handler block. An already created handler
       # for same resource class will be overridden.
       #
-      def resource(klass, action, opts = {}, &block)
+      def resource(klass, action, opts = {}, &_block)
         action = action.to_sym
-        raise ArgumentError, "Unknown action `#{action}`." unless ACTIONS.include? action
+        raise ArgumentError.new "Unknown action `#{action}`." unless ACTIONS.include? action
 
         Stub.new(opts).tap do |stub|
           stubs[klass]         ||= {}
@@ -96,11 +104,11 @@ module Acfs
         @enabled ||= false
       end
 
-      def enable;
+      def enable
         @enabled = true
       end
 
-      def disable;
+      def disable
         @enabled = false
       end
 
@@ -118,7 +126,7 @@ module Acfs
         return false unless (classes = stubs[op.resource])
         return false unless (stubs = classes[op.action])
 
-        accepted_stubs = stubs.select { |stub| stub.accept? op }
+        accepted_stubs = stubs.select {|stub| stub.accept? op }
 
         raise AmbiguousStubError.new stubs: accepted_stubs, operation: op if accepted_stubs.size > 1
 
@@ -142,8 +150,9 @@ module Acfs
       end
 
       private
+
       def pretty_print
-        out = String.new
+        out = ''
         stubs.each do |klass, actions|
           out << '  ' << klass.name << ":\n"
           actions.each do |action, stubs|

data/lib/acfs/util.rb

@@ -7,7 +7,7 @@ module Acfs
       end
 
       def __invoke__
-        __callbacks__.each{|c| c.call self}
+        __callbacks__.each {|c| c.call self }
       end
     end
 

data/lib/acfs/version.rb

@@ -3,10 +3,12 @@ module Acfs
     MAJOR = 1
     MINOR = 0
     PATCH = 0
-    STAGE = 'dev'
+    STAGE = nil
 
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
 
-    def self.to_s; STRING end
+    def self.to_s
+      STRING
+    end
   end
 end

data/spec/acfs/adapter/typhoeus_spec.rb

@@ -5,16 +5,24 @@ describe Acfs::Adapter::Typhoeus do
   before { WebMock.allow_net_connect! }
 
   it 'raises an error' do
-    request1 = Acfs::Request.new 'http://altimos.de/404.1' do |rsp|
+    request1 = Acfs::Request.new 'http://altimos.de/404.1' do |_rsp|
       raise '404-1'
     end
-    request2 = Acfs::Request.new 'http://altimos.de/404.2' do |rsp|
+    request2 = Acfs::Request.new 'http://altimos.de/404.2' do |_rsp|
       raise '404-2'
     end
     adapter.queue request1
     adapter.queue request2
 
-    expect{ adapter.start }.to raise_error /404\-[12]/
-    expect{ adapter.start }.to_not raise_error
+    expect { adapter.start }.to raise_error(/404\-[12]/)
+    expect { adapter.start }.to_not raise_error
+  end
+
+  it 'passes arguments to typhoeus hydra' do
+    value = {key: 1, key2: 2}
+
+    expect(::Typhoeus::Hydra).to receive(:new).with(value)
+
+    described_class.new(**value).send :hydra
   end
 end

data/spec/acfs/collection_spec.rb

@@ -11,47 +11,59 @@ describe Acfs::Collection do
 
     context 'without explicit page parameter' do
       before do
-        stub_request(:get, 'http://users.example.org/users').
-            to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
-                               headers: {'X-Total-Pages' => '2'})
+        stub_request(:get, 'http://users.example.org/users')
+          .to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
+            headers: {
+              'X-Total-Pages' => '2',
+              'X-Total-Count' => '10'
+            })
       end
 
       its(:total_pages) { should eq 2 }
       its(:current_page) { should eq 1 }
+      its(:total_count) { should eq 10 }
     end
 
     context 'with page parameter' do
       let(:params) { {page: 2} }
       before do
-        stub_request(:get, 'http://users.example.org/users?page=2').
-            to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
-                               headers: {'X-Total-Pages' => '2'})
+        stub_request(:get, 'http://users.example.org/users?page=2')
+          .to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
+            headers: {
+              'X-Total-Pages' => '2',
+              'X-Total-Count' => '10'
+            })
       end
 
       its(:total_pages) { should eq 2 }
       its(:current_page) { should eq 2 }
+      its(:total_count) { should eq 10 }
     end
 
     context 'with non-numerical page parameter' do
       let(:params) { {page: 'e546f5'} }
       before do
-        stub_request(:get, 'http://users.example.org/users?page=e546f5').
-            to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
-                               headers: {'X-Total-Pages' => '2'})
+        stub_request(:get, 'http://users.example.org/users?page=e546f5')
+          .to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
+            headers: {
+              'X-Total-Pages' => '2',
+              'X-Total-Count' => '10'
+            })
       end
 
       its(:total_pages) { should eq 2 }
       its(:current_page) { should eq 'e546f5' }
+      its(:total_count) { should eq 10 }
     end
 
     describe '#next_page' do
       before do
-        stub_request(:get, 'http://users.example.org/users').
-            to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
-                               headers: {
-                                   'X-Total-Pages' => '2',
-                                   'Link'          => '<http://users.example.org/users?page=2>; rel="next"'
-                               })
+        stub_request(:get, 'http://users.example.org/users')
+          .to_return response([{id: 1, name: 'Anon', age: 12, born_at: 'Berlin'}],
+            headers: {
+              'X-Total-Pages' => '2',
+              'Link'          => '<http://users.example.org/users?page=2>; rel="next"'
+            })
       end
       let!(:req) do
         stub_request(:get, 'http://users.example.org/users?page=2').to_return response([])
@@ -70,12 +82,12 @@ describe Acfs::Collection do
 
     describe '#prev_page' do
       before do
-        stub_request(:get, 'http://users.example.org/users?page=2').
-            to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
-                               headers: {
-                                   'X-Total-Pages' => '2',
-                                   'Link'          => '<http://users.example.org/users>; rel="prev"'
-                               })
+        stub_request(:get, 'http://users.example.org/users?page=2')
+          .to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
+            headers: {
+              'X-Total-Pages' => '2',
+              'Link'          => '<http://users.example.org/users>; rel="prev"'
+            })
       end
       let!(:req) do
         stub_request(:get, 'http://users.example.org/users').to_return response([])
@@ -94,12 +106,12 @@ describe Acfs::Collection do
 
     describe '#first_page' do
       before do
-        stub_request(:get, 'http://users.example.org/users?page=2').
-            to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
-                               headers: {
-                                   'X-Total-Pages' => '2',
-                                   'Link'          => '<http://users.example.org/users>; rel="first"'
-                               })
+        stub_request(:get, 'http://users.example.org/users?page=2')
+          .to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
+            headers: {
+              'X-Total-Pages' => '2',
+              'Link'          => '<http://users.example.org/users>; rel="first"'
+            })
       end
       let!(:req) do
         stub_request(:get, 'http://users.example.org/users').to_return response([])
@@ -118,12 +130,12 @@ describe Acfs::Collection do
 
     describe '#last_page' do
       before do
-        stub_request(:get, 'http://users.example.org/users?page=2').
-            to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
-                               headers: {
-                                   'X-Total-Pages' => '2',
-                                   'Link'          => '<http://users.example.org/users?page=12>; rel="last"'
-                               })
+        stub_request(:get, 'http://users.example.org/users?page=2')
+          .to_return response([{id: 2, name: 'Anno', age: 1604, born_at: 'Santa Maria'}],
+            headers: {
+              'X-Total-Pages' => '2',
+              'Link'          => '<http://users.example.org/users?page=12>; rel="last"'
+            })
       end
       let!(:req) do
         stub_request(:get, 'http://users.example.org/users?page=12').to_return response([])