acfs 1.4.0 → 1.7.0

data/lib/acfs/service.rb

@@ -28,33 +28,27 @@ module Acfs
 
     # @api private
     #
-    def initialize(options = {})
+    def initialize(**options)
       @options = options
     end
 
     # @api private
     # @return [Location]
     #
-    def location(resource_class, opts = {})
-      opts.reverse_merge! options
+    def location(resource_class, path: nil, action: :list, **)
+      path ||= options[:path]
 
-      action = opts[:action] || :list
+      if path.is_a?(Hash) && path.key?(action)
+        path = path.fetch(action)
+      else
+        path = path.is_a?(Hash) ? path[:all].to_s : path.to_s
 
-      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
-
-               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
+        path = resource_class.location_default_path(action, path.strip)
+      end
 
       if path.nil?
         raise ArgumentError.new "Location for `#{action}' explicit disabled by set to nil."
@@ -87,7 +81,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/singleton_resource.rb

@@ -27,10 +27,10 @@ module Acfs
     # @return [undefined]
     # @see #delete
     #
-    def delete!(opts = {})
+    def delete!(**opts)
       opts[:params] ||= {}
 
-      operation :delete, opts do |data|
+      operation(:delete, **opts) do |data|
         update_with data
         freeze
       end

data/lib/acfs/stub.rb

@@ -16,16 +16,16 @@ 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
 
-    def accept?(op)
-      return opts[:with].call op if opts[:with].respond_to? :call
+    def accept?(operation)
+      return opts[:with].call(operation) if opts[:with].respond_to?(:call)
 
-      params = op.full_params.stringify_keys
-      data   = op.data.stringify_keys
+      params = operation.full_params.stringify_keys
+      data   = operation.data.stringify_keys
       with   = opts[:with]
 
       return true if with.nil?
@@ -33,10 +33,10 @@ module Acfs
       case opts.fetch(:match, :inclusion)
         when :legacy
           return true if with.empty? && params.empty? && data.empty?
-          if with.reject {|_, v| v.nil? } == params.reject {|_, v| v.nil? }
+          if with.compact == params.compact
             return true
           end
-          if with.reject {|_, v| v.nil? } == data.reject {|_, v| v.nil? }
+          if with.compact == data.compact
             return true
           end
 
@@ -53,28 +53,30 @@ 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
 
-    def call(op)
-      calls << op
+    def call(operation)
+      calls << operation
 
       err  = opts[:raise]
       data = opts[:return]
 
       if err
-        raise_error op, err, opts[:return]
+        raise_error(operation, err, opts[:return])
       elsif data
-        data = data.call(op) if data.respond_to?(:call)
+        data = data.call(operation) if data.respond_to?(:call)
 
-        response = Acfs::Response.new op.request,
+        response = Acfs::Response.new(
+          operation.request,
           headers: opts[:headers] || {},
           status: opts[:status] || 200,
-          data: data || {}
-        op.call data, response
+          data: data || {},
+        )
+
+        operation.call(data, response)
       else
         raise ArgumentError.new 'Unsupported stub.'
       end
@@ -82,12 +84,18 @@ module Acfs
 
     private
 
-    def raise_error(op, name, data)
+    def raise_error(operation, name, data)
       raise name if name.is_a? Class
 
-      data.stringify_keys! if data.respond_to? :stringify_keys!
+      data.stringify_keys! if data.respond_to?(:stringify_keys!)
 
-      op.handle_failure ::Acfs::Response.new op.request, status: Rack::Utils.status_code(name), data: data
+      operation.handle_failure(
+        ::Acfs::Response.new(
+          operation.request,
+          status: Rack::Utils.status_code(name),
+          data: data,
+        ),
+      )
     end
 
     class << self
@@ -137,33 +145,35 @@ module Acfs
         @stubs ||= {}
       end
 
-      def stub_for(op)
-        return false unless (classes = stubs[op.resource])
-        return false unless (stubs = classes[op.action])
+      def stub_for(operation)
+        return false unless (classes = stubs[operation.resource])
+        return false unless (stubs = classes[operation.action])
 
-        accepted_stubs = stubs.select {|stub| stub.accept? op }
+        accepted_stubs = stubs.select {|stub| stub.accept?(operation) }
 
         if accepted_stubs.size > 1
-          raise AmbiguousStubError.new stubs: accepted_stubs, operation: op
+          raise AmbiguousStubError.new(stubs: accepted_stubs, operation: operation)
         end
 
         accepted_stubs.first
       end
 
-      def stubbed(op)
-        stub = stub_for op
+      def stubbed(operation)
+        stub = stub_for(operation)
         unless stub
           return false if allow_requests?
 
-          raise RealRequestsNotAllowedError.new <<-MSG.strip.gsub(/^[ ]{12}/, '')
-            No stub found for `#{op.action}' on `#{op.resource.name}' with params `#{op.full_params.inspect}', data `#{op.data.inspect}' and id `#{op.id}'.
+          raise RealRequestsNotAllowedError.new <<~ERROR
+            No stub found for `#{operation.action}' on `#{operation.resource.name}' \
+            with params `#{operation.full_params.inspect}', data `#{operation.data.inspect}' \
+            and id `#{operation.id}'.
 
             Available stubs:
             #{pretty_print}
-          MSG
+          ERROR
         end
 
-        stub.call op
+        stub.call(operation)
         true
       end
 

data/lib/acfs/version.rb

@@ -3,11 +3,11 @@
 module Acfs
   module VERSION
     MAJOR = 1
-    MINOR = 4
+    MINOR = 7
     PATCH = 0
     STAGE = nil
 
-    STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.')
+    STRING = [MAJOR, MINOR, PATCH, STAGE].compact.join('.')
 
     def self.to_s
       STRING

data/spec/acfs/adapter/typhoeus_spec.rb

@@ -19,8 +19,8 @@ describe Acfs::Adapter::Typhoeus do
     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 }.not_to raise_error
   end
 
   it 'raises timeout' do

data/spec/acfs/collection_spec.rb

@@ -6,149 +6,174 @@ describe Acfs::Collection do
   let(:model) { MyUser }
 
   describe 'Pagination' do
+    subject do
+      Acfs.run
+      collection
+    end
+
     let(:params) { {} }
     let!(:collection) { model.all params }
 
-    subject { Acfs.run; collection }
-
     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',
-              'X-Total-Count' => '10'
-            })
+              'X-Total-Count' => '10',
+            },)
       end
 
-      its(:total_pages) { should eq 2 }
-      its(:current_page) { should eq 1 }
-      its(:total_count) { should eq 10 }
+      its(:total_pages) { is_expected.to eq 2 }
+      its(:current_page) { is_expected.to eq 1 }
+      its(:total_count) { is_expected.to 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',
-              'X-Total-Count' => '10'
-            })
+              'X-Total-Count' => '10',
+            },)
       end
 
-      its(:total_pages) { should eq 2 }
-      its(:current_page) { should eq 2 }
-      its(:total_count) { should eq 10 }
+      its(:total_pages) { is_expected.to eq 2 }
+      its(:current_page) { is_expected.to eq 2 }
+      its(:total_count) { is_expected.to 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',
-              'X-Total-Count' => '10'
-            })
+              'X-Total-Count' => '10',
+            },)
       end
 
-      its(:total_pages) { should eq 2 }
-      its(:current_page) { should eq 'e546f5' }
-      its(:total_count) { should eq 10 }
+      its(:total_pages) { is_expected.to eq 2 }
+      its(:current_page) { is_expected.to eq 'e546f5' }
+      its(:total_count) { is_expected.to eq 10 }
     end
 
     describe '#next_page' do
+      subject(:request_page) do
+        Acfs.run
+        collection.next_page
+      end
+
       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"'
-            })
+              '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([])
       end
       let!(:collection) { model.all }
-      subject { Acfs.run; collection.next_page }
 
-      it { should be_a Acfs::Collection }
+      it { is_expected.to be_a Acfs::Collection }
 
-      it 'should have fetched page 2' do
-        subject
+      it 'has fetched page 2' do
+        request_page
         Acfs.run
         expect(req).to have_been_requested
       end
     end
 
     describe '#prev_page' do
+      subject(:request_page) do
+        Acfs.run
+        collection.prev_page
+      end
+
       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"'
-            })
+              'Link' => '<http://users.example.org/users>; rel="prev"',
+            },)
       end
+
       let!(:req) do
         stub_request(:get, 'http://users.example.org/users').to_return response([])
       end
       let!(:collection) { model.all page: 2 }
-      subject { Acfs.run; collection.prev_page }
 
-      it { should be_a Acfs::Collection }
+      it { is_expected.to be_a Acfs::Collection }
 
-      it 'should have fetched page 1' do
-        subject
+      it 'has fetched page 1' do
+        request_page
         Acfs.run
         expect(req).to have_been_requested
       end
     end
 
     describe '#first_page' do
+      subject(:request_page) do
+        Acfs.run
+        collection.first_page
+      end
+
       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"'
-            })
+              'Link' => '<http://users.example.org/users>; rel="first"',
+            },)
       end
+
       let!(:req) do
         stub_request(:get, 'http://users.example.org/users').to_return response([])
       end
       let!(:collection) { model.all page: 2 }
-      subject { Acfs.run; collection.first_page }
 
-      it { should be_a Acfs::Collection }
+      it { is_expected.to be_a Acfs::Collection }
 
-      it 'should have fetched page 1' do
-        subject
+      it 'has fetched page 1' do
+        request_page
         Acfs.run
         expect(req).to have_been_requested
       end
     end
 
     describe '#last_page' do
+      subject(:request_page) do
+        Acfs.run
+        collection.last_page
+      end
+
       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"'
-            })
+              '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([])
       end
       let!(:collection) { model.all page: 2 }
-      subject { Acfs.run; collection.last_page }
 
-      it { should be_a Acfs::Collection }
+      it { is_expected.to be_a Acfs::Collection }
 
-      it 'should have fetched page 1' do
-        subject
+      it 'has fetched page 1' do
+        request_page
         Acfs.run
         expect(req).to have_been_requested
       end

data/spec/acfs/configuration_spec.rb

@@ -4,11 +4,16 @@ require 'spec_helper'
 
 describe Acfs::Configuration do
   let(:cfg) { Acfs::Configuration.new }
-  before { @configuration = Acfs::Configuration.current.dup }
-  after { Acfs::Configuration.set @configuration }
+
+  around do |example|
+    configuration = Acfs::Configuration.current.dup
+    example.run
+  ensure
+    Acfs::Configuration.set(configuration)
+  end
 
   describe 'Acfs.configure' do
-    it 'should invoke configure on current configuration' do
+    it 'invokes configure on current configuration' do
       expect(Acfs::Configuration.current).to receive(:configure).once.and_call_original
 
       Acfs.configure do |c|
@@ -18,26 +23,31 @@ describe Acfs::Configuration do
   end
 
   describe '.load' do
-    it 'should be able to load YAML' do
+    it 'is able to load YAML' do
       cfg.configure do
         load 'spec/fixtures/config.yml'
       end
 
-      expect(cfg.locate(UserService).to_s).to be == 'http://localhost:3001/'
-      expect(cfg.locate(CommentService).to_s).to be == 'http://localhost:3002/'
+      expect(cfg.locate(UserService).to_s).to eq 'http://localhost:3001/'
+      expect(cfg.locate(CommentService).to_s).to eq 'http://localhost:3002/'
     end
 
     context 'with RACK_ENV' do
-      before { @env = ENV['RACK_ENV']; ENV['RACK_ENV'] = 'production' }
-      after  { ENV['RACK_ENV'] = @env }
+      around do |example|
+        env = ENV['RACK_ENV']
+        ENV['RACK_ENV'] = 'production'
+        example.run
+      ensure
+        ENV['RACK_ENV'] = env
+      end
 
-      it 'should load ENV block' do
+      it 'loads ENV block' do
         cfg.configure do
           load 'spec/fixtures/config.yml'
         end
 
-        expect(cfg.locate(UserService).to_s).to be == 'http://user.example.org/'
-        expect(cfg.locate(CommentService).to_s).to be == 'http://comment.example.org/'
+        expect(cfg.locate(UserService).to_s).to eq 'http://user.example.org/'
+        expect(cfg.locate(CommentService).to_s).to eq 'http://comment.example.org/'
       end
     end
   end
@@ -45,7 +55,7 @@ describe Acfs::Configuration do
   describe '#adapter' do
     let(:object) { Object.new }
 
-    it 'should be a accessor' do
+    it 'is a accessor' do
       cfg.adapter = object
       expect(cfg.adapter).to eq object
     end

data/spec/acfs/global_spec.rb

@@ -28,7 +28,8 @@ describe ::Acfs::Global do
       before do
         ::ActiveSupport::Notifications.subscribe 'acfs.run', collector
       end
-      it 'should trigger event' do
+
+      it 'triggers event' do
         Acfs.run
         expect(collector.events).to have(1).items
       end
@@ -38,7 +39,8 @@ describe ::Acfs::Global do
       before do
         ::ActiveSupport::Notifications.subscribe 'acfs.reset', collector
       end
-      it 'should trigger event' do
+
+      it 'triggers event' do
         Acfs.reset
         expect(collector.events).to have(1).items
       end
@@ -50,11 +52,11 @@ describe ::Acfs::Global do
       stub_request(:get, %r{http://users.example.org/users/\d+}).to_return(
         status: 200,
         body: '{}',
-        headers: {'Content-Type' => 'application/json'}
+        headers: {'Content-Type' => 'application/json'},
       )
     end
 
-    it 'should invoke when both resources' do
+    it 'invokes when both resources' do
       user1 = MyUser.find 1
       user2 = MyUser.find 2
 
@@ -64,7 +66,7 @@ describe ::Acfs::Global do
       end.to yield_with_args(user1, user2)
     end
 
-    it 'should invoke when both resources when loaded' do
+    it 'invokes when both resources when loaded' do
       user1 = MyUser.find 1
       user2 = MyUser.find 2
 
@@ -82,7 +84,7 @@ describe ::Acfs::Global do
           .to_return(
             status: 200,
             body: '{}',
-            headers: {'Content-Type' => 'application/json'}
+            headers: {'Content-Type' => 'application/json'},
           )
       end
 
@@ -122,10 +124,10 @@ 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
+      expect(runner1).not_to equal runner2
     end
 
     it 'uses configurated adapter' do

data/spec/acfs/location_spec.rb

@@ -5,7 +5,7 @@ require 'spec_helper'
 describe ::Acfs::Location do
   let(:location) { described_class.new(uri, args) }
   let(:uri)      { 'http://localhost/users/:id' }
-  let(:args)     { {id: 4} }
+  let(:args)     { {'id' => 4} }
 
   describe '#str' do
     subject(:str) { location.str }
@@ -15,7 +15,7 @@ describe ::Acfs::Location do
     end
 
     context 'with special characters' do
-      let(:args) { {id: '4 [@(\/!^$'} }
+      let(:args) { {'id' => '4 [@(\/!^$'} }
 
       it 'escapes special characters' do
         expect(str).to eq 'http://localhost/users/4+%5B%40%28%5C%2F%21%5E%24'

data/spec/acfs/middleware/json_spec.rb

@@ -16,18 +16,32 @@ describe Acfs::Middleware::JSON do
 
   describe 'encode' do
     context 'with not serialized request' do
-      it 'should set Content-Type' do
+      it 'sets Content-Type' do
         expect(request.headers['Content-Type']).to eq 'application/json'
       end
 
-      it 'should append Accept header' do
+      it 'appends Accept header' do
         expect(request.headers['Accept']).to eq 'application/json;q=1'
       end
 
-      it 'should serialize data to JSON' do
+      it 'serializes data to JSON' do
         expect(JSON.parse(request.body)).to eq data.map(&:stringify_keys)
       end
     end
+
+    context 'with #to_json objects' do
+      let(:data) do
+        Class.new do
+          def to_json(*)
+            '{"a": 1, "b": 2}'
+          end
+        end.new
+      end
+
+      it 'serializes data with #to_json' do
+        expect(JSON.parse(request.body)).to eq 'a' => 1, 'b' => 2
+      end
+    end
   end
 
   describe 'decode' do
@@ -35,10 +49,10 @@ describe Acfs::Middleware::JSON do
       let(:headers) { {'Content-Type' => 'application/json; charset=utf-8'} }
       let(:body)    { data.to_json }
 
-      it 'should decode body data' do
+      it 'decodes body data' do
         request.complete! response
 
-        expect(response.data).to be == data.map(&:stringify_keys)
+        expect(response.data).to eq data.map(&:stringify_keys)
       end
     end
 
@@ -46,8 +60,8 @@ describe Acfs::Middleware::JSON do
       let(:headers) { {'Content-Type' => 'application/json'} }
       let(:body)    { data.to_json[4..-4] }
 
-      it 'should raise an error' do
-        expect { request.complete! response }.to raise_error(MultiJson::LoadError)
+      it 'raises an error' do
+        expect { request.complete! response }.to raise_error(::JSON::ParserError)
       end
     end
 
@@ -55,7 +69,7 @@ describe Acfs::Middleware::JSON do
       let(:headers) { {'Content-Type' => 'application/text'} }
       let(:body)    { data.to_json }
 
-      it 'should not decode non-JSON encoded responses' do
+      it 'does not decode non-JSON encoded responses' do
         request.complete! response
 
         expect(response.data).to be_nil