restify 2.0.2 → 3.0.0.rc2

data/spec/restify/global_spec.rb

@@ -21,7 +21,7 @@ describe Restify::Global do
     end
 
     context 'with registry symbol' do
-      subject(:restify) { global.new(uri, **options) }
+      subject(:restify) { global.new(name, **options) }
 
       let(:name) { :registry_item_name }
       let(:uri)     { 'http://api.github.com/' }
@@ -38,4 +38,121 @@ describe Restify::Global do
       end
     end
   end
+
+  describe '#adapter' do
+    subject(:adapter) { global.adapter }
+
+    around do |example|
+      Restify.adapter.tap do |configured|
+        Restify.adapter = nil
+        example.run
+      ensure
+        Restify.adapter = configured
+      end
+    end
+
+    it 'defaults to Ethon adapter' do
+      expect(adapter).to be_a Restify::Adapter::Ethon
+    end
+  end
+
+  describe '#adapter=' do
+    let(:stub) { Object.new }
+
+    # Ensure to restore the configured adapter after these specs!
+    around do |example|
+      Restify.adapter.tap do |configured|
+        Restify.adapter = nil
+        example.run
+      ensure
+        Restify.adapter = configured
+      end
+    end
+
+    it 'sets a new adapter' do
+      global.adapter = stub
+      expect(global.adapter).to be stub
+    end
+  end
+
+  describe '#cache' do
+    subject(:cache) { global.cache }
+
+    it 'is not set by default' do
+      expect(cache).to be_nil
+    end
+  end
+
+  describe '#cache=' do
+    let(:stub) { Object.new }
+
+    # Ensure to reset cache after these specs!
+    after { Restify.cache = nil }
+
+    it 'sets a new cache' do
+      global.cache = stub
+      expect(global.cache).to be stub
+    end
+  end
+
+  describe '#logger' do
+    subject(:logger) { global.logger }
+
+    around do |example|
+      global.logger.tap do |configured|
+        global.logger = nil
+        example.run
+      ensure
+        global.logger = configured
+      end
+    end
+
+    it 'is not set by default' do
+      expect(logger).to be_nil
+    end
+
+    it 'does not log anything without a logger' do
+      loggable = Class.new { include Restify::Logging }.new
+
+      expect { loggable.debug('message') }.not_to output.to_stdout_from_any_process
+      expect { loggable.error(RuntimeError.new('kaboom')) }.not_to output.to_stderr_from_any_process
+    end
+  end
+
+  describe '#logger=' do
+    let(:configured) { Logger.new(nil) }
+
+    around do |example|
+      global.logger.tap do |previous|
+        example.run
+      ensure
+        global.logger = previous
+      end
+    end
+
+    it 'sets the logger' do
+      global.logger = configured
+
+      expect(global.logger).to be configured
+    end
+
+    it 'is used for messages from Restify' do
+      output = StringIO.new
+      global.logger = Logger.new(output, level: :debug)
+
+      Class.new { include Restify::Logging }.new.debug('message', key: 'value')
+
+      expect(output.string).to include 'message key=value'
+    end
+
+    it 'is used for errors from Restify' do
+      output = StringIO.new
+      global.logger = Logger.new(output)
+
+      stub_const('Loggable', Class.new { include Restify::Logging })
+      Loggable.new.error(RuntimeError.new('kaboom'))
+
+      expect(output.string).to include 'ERROR -- Loggable: kaboom (RuntimeError)'
+    end
+  end
 end

data/spec/restify/link_spec.rb

@@ -9,7 +9,7 @@ describe Restify::Link do
         links = described_class
           .parse('<http://example.org/search{?query}>; rel="search"')
 
-        expect(links).to have(1).item
+        expect(links.size).to eq(1)
         expect(links[0].uri).to eq 'http://example.org/search{?query}'
         expect(links[0].metadata).to eq 'rel' => 'search'
       end
@@ -18,7 +18,7 @@ describe Restify::Link do
         links = described_class
           .parse('<http://example.org/search{?query}>; rel=search')
 
-        expect(links).to have(1).item
+        expect(links.size).to eq(1)
         expect(links[0].uri).to eq 'http://example.org/search{?query}'
         expect(links[0].metadata).to eq 'rel' => 'search'
       end
@@ -27,7 +27,7 @@ describe Restify::Link do
         links = described_class
           .parse('<p://h.tld/p>; rel=abc, <p://h.tld/b>; a=b; c="d"')
 
-        expect(links).to have(2).item
+        expect(links.size).to eq(2)
         expect(links[0].uri).to eq 'p://h.tld/p'
         expect(links[0].metadata).to eq 'rel' => 'abc'
         expect(links[1].uri).to eq 'p://h.tld/b'
@@ -50,6 +50,16 @@ describe Restify::Link do
         expect { described_class.parse('</>; rel="s", abc-invalid') }
           .to raise_error ArgumentError, /Invalid token at \d+:/i
       end
+
+      it 'errors on invalid param' do
+        expect { described_class.parse('<https://example.org>; rel') }
+          .to raise_error ArgumentError, /Invalid token at \d+:/i
+      end
+
+      it 'errors on invalid param value' do
+        expect { described_class.parse('<https://example.org>; rel=') }
+          .to raise_error ArgumentError, /Invalid token at \d+:/i
+      end
     end
   end
 end

data/spec/restify/processors/json_spec.rb

@@ -31,6 +31,42 @@ describe Restify::Processors::Json do
 
     before { allow(response).to receive(:body).and_return(body) }
 
+    describe 'empty body' do
+      let(:body) { '' }
+
+      it { is_expected.to be_a Restify::Resource }
+      it { expect(resource.data).to be_nil }
+    end
+
+    describe 'invalid body' do
+      let(:body) { '{"json": ' }
+
+      before do
+        allow(response).to receive_messages(
+          uri: Addressable::URI.parse('http://test.host/'),
+          links: Restify::Link.parse('<http://test.host/other>; rel="other"'),
+        )
+      end
+
+      it { is_expected.to be_a Restify::Resource }
+      it { is_expected.to have_relation :other }
+      it { expect(resource.response).to be response }
+
+      it 'raises on accessing data' do
+        expect { resource.data }.to raise_error(Restify::ParseError) do |error|
+          expect(error.response).to be response
+          expect(error.cause).to be_a JSON::ParserError
+        end
+      end
+
+      it 'raises on accessing delegated data' do
+        expect { resource['json'] }.to raise_error Restify::ParseError
+      end
+
+      it { is_expected.not_to respond_to :each }
+      it { expect(resource.inspect).to include '@error=' }
+    end
+
     describe 'parsing' do
       context 'single object' do
         let(:body) do

data/spec/restify/processors/msgpack_spec.rb

@@ -41,6 +41,42 @@ describe Restify::Processors::Msgpack do
 
     before { allow(response).to receive(:body).and_return(body) }
 
+    describe 'empty body' do
+      let(:body) { '' }
+
+      it { is_expected.to be_a Restify::Resource }
+      it { expect(resource.data).to be_nil }
+    end
+
+    describe 'invalid body' do
+      let(:body) { "\xC1".b }
+
+      before do
+        allow(response).to receive_messages(
+          uri: Addressable::URI.parse('http://test.host/'),
+          links: Restify::Link.parse('<http://test.host/other>; rel="other"'),
+        )
+      end
+
+      it { is_expected.to be_a Restify::Resource }
+      it { is_expected.to have_relation :other }
+      it { expect(resource.response).to be response }
+
+      it 'raises on accessing data' do
+        expect { resource.data }.to raise_error(Restify::ParseError) do |error|
+          expect(error.response).to be response
+          expect(error.cause).to be_a MessagePack::MalformedFormatError
+        end
+      end
+
+      it 'raises on accessing delegated data' do
+        expect { resource['json'] }.to raise_error Restify::ParseError
+      end
+
+      it { is_expected.not_to respond_to :each }
+      it { expect(resource.inspect).to include '@error=' }
+    end
+
     describe 'parsing' do
       context 'single object' do
         let(:body) do

data/spec/restify/promise_spec.rb

@@ -81,6 +81,43 @@ describe Restify::Promise do
         end
       end
 
+      context 'when resolving the promise from a block' do
+        subject(:promise) do
+          described_class.create do |writer|
+            writer.set { block.call }
+          end
+        end
+
+        context 'with a returned value' do
+          let(:block) { -> { 42 } }
+
+          it 'fulfills the promise with it' do
+            expect(promise.fulfilled?).to be true
+            expect(promise.value!).to eq 42
+          end
+        end
+
+        context 'with a raised exception' do
+          let(:block) { -> { raise ArgumentError.new('nope') } }
+
+          it 'rejects the promise with it' do
+            expect(promise.rejected?).to be true
+            expect { promise.value! }.to raise_error ArgumentError, 'nope'
+          end
+        end
+
+        # Handlers can run from e.g. a libcurl callback, from where no
+        # exception must ever escape, not even a non-StandardError.
+        context 'with a raised non-StandardError' do
+          let(:block) { -> { raise NotImplementedError.new('nope') } }
+
+          it 'rejects the promise with it' do
+            expect(promise.rejected?).to be true
+            expect { promise.value! }.to raise_error NotImplementedError, 'nope'
+          end
+        end
+      end
+
       context 'when fulfilling the promise asynchronously' do
         subject(:promise) do
           described_class.create do |writer|
@@ -180,6 +217,51 @@ describe Restify::Promise do
     it 'can time out' do
       expect { promise.wait(0.1) }.to raise_error Timeout::Error
     end
+
+    context 'with a driver' do
+      subject(:promise) { described_class.create(driver:) {|w| writers << w } }
+
+      let(:driver) { instance_double(Restify::Adapter::Ethon) }
+      let(:writers) { [] }
+      let(:writer) { writers.first }
+
+      before { promise }
+
+      it 'lets the driver complete the promise in the waiting thread' do
+        expect(driver).to receive(:drive).once do |p, timeout|
+          expect(p).to be promise
+          expect(timeout).to be_a Restify::Timeout
+          writer.fulfill 42
+          true
+        end
+
+        expect(promise.value!).to eq 42
+      end
+
+      it 'waits as usual when the driver declines' do
+        allow(driver).to receive(:drive).and_return(false)
+
+        Thread.new do
+          sleep 0.05
+          writer.fulfill 42
+        end
+
+        expect(promise.value!).to eq 42
+      end
+
+      it 'times out when the driver returns without completing it' do
+        allow(driver).to receive(:drive).and_return(true)
+
+        expect { promise.wait(0.1) }.to raise_error Timeout::Error
+      end
+
+      it 'does not call the driver for a complete promise' do
+        expect(driver).not_to receive(:drive)
+        writer.fulfill 42
+
+        expect(promise.value!).to eq 42
+      end
+    end
   end
 
   describe '#value' do

data/spec/restify/relation_spec.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'spec_helper'
-require 'active_support'
 
 describe Restify::Relation do
   subject(:relation) { described_class.new context, pattern }
@@ -47,6 +46,16 @@ describe Restify::Relation do
       it { expect(expanded.to_s).to eq 'http://test.host/resource/true' }
     end
 
+    context 'with Object' do
+      # Without #to_param, e.g. from ActiveSupport
+      let(:object) { Class.new.new }
+      let(:params) { {id: object} }
+
+      it 'raise a TypeError from adressable' do
+        expect { expanded }.to raise_error(TypeError, /Can't convert #<Class:0x.*> into String or Array/)
+      end
+    end
+
     context 'with #to_param object' do
       let(:params) { {id: cls_to_param.new} }
 
@@ -213,15 +222,15 @@ describe Restify::Relation do
   end
 
   describe '#get' do
-    include_examples 'non-data-request', :get
+    it_behaves_like 'non-data-request', :get
   end
 
   describe '#head' do
-    include_examples 'non-data-request', :head
+    it_behaves_like 'non-data-request', :head
   end
 
   describe '#delete' do
-    include_examples 'non-data-request', :delete
+    it_behaves_like 'non-data-request', :delete
   end
 
   shared_examples 'data-request' do |method|
@@ -274,14 +283,20 @@ describe Restify::Relation do
   end
 
   describe '#post' do
-    include_examples 'data-request', :post
+    it_behaves_like 'data-request', :post
   end
 
   describe '#put' do
-    include_examples 'data-request', :put
+    it_behaves_like 'data-request', :put
   end
 
   describe '#patch' do
-    include_examples 'data-request', :patch
+    it_behaves_like 'data-request', :patch
+  end
+
+  describe '#to_s' do
+    subject(:string) { relation.to_s }
+
+    it { is_expected.to eq '/resource/{id}{?q*}' }
   end
 end

data/spec/restify/request_spec.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restify::Request do
+  subject(:request) { described_class.new(uri:) }
+
+  describe '#uri' do
+    context 'with a string' do
+      let(:uri) { 'https://example.org:8443/resources?page=2' }
+
+      it 'parses it' do
+        expect(request.uri).to be_a Addressable::URI
+        expect(request.uri.to_s).to eq uri
+      end
+    end
+
+    context 'with an Addressable::URI' do
+      let(:uri) { Addressable::URI.parse('https://example.org/resources') }
+
+      it 'keeps it as is' do
+        expect(request.uri).to be uri
+      end
+    end
+  end
+end

data/spec/restify/resource_spec.rb

@@ -118,4 +118,10 @@ describe Restify::Resource do
       end
     end
   end
+
+  describe '#inspect' do
+    subject(:inspect) { resource.inspect }
+
+    it { is_expected.to eq '#<Restify::Resource @data={} @relations={}>' }
+  end
 end

data/spec/restify/timeout_spec.rb

@@ -21,6 +21,17 @@ describe Restify::Timeout do
     end
   end
 
+  describe '#remaining' do
+    it 'returns the seconds left' do
+      expect(timer.remaining).to be_within(0.05).of(0.2)
+    end
+
+    it 'is not positive after having timed out' do
+      sleep timer.remaining
+      expect(timer.remaining).not_to be_positive
+    end
+  end
+
   describe '#wait_on!' do
     it 'calls block on IVar timeout' do
       expect do

data/spec/restify_spec.rb

@@ -161,7 +161,7 @@ describe Restify do
         users = users_relation.get.value!
 
         # We get a collection back (Restify::Collection).
-        expect(users).to have(2).items
+        expect(users.size).to eq(2)
 
         # Let's get the first one.
         user = users.first

data/spec/spec_helper.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
+require 'logger'
 require 'rspec'
-require 'rspec/collection_matchers'
 
 require 'simplecov'
 require 'simplecov-cobertura'
 
 SimpleCov.start do
-  add_filter 'spec'
+  skip %r{\Aspec/}i
 end
 
 SimpleCov.formatters = [
@@ -19,6 +19,9 @@ require 'restify'
 
 if ENV['ADAPTER']
   case ENV['ADAPTER'].to_s.downcase
+    when 'ethon'
+      require 'restify/adapter/ethon'
+      Restify.adapter = Restify::Adapter::Ethon.new
     when 'typhoeus'
       require 'restify/adapter/typhoeus'
       Restify.adapter = Restify::Adapter::Typhoeus.new
@@ -33,6 +36,8 @@ end
 require_relative 'support/opentelemetry'
 require_relative 'support/stub_server'
 
+require 'restify/webmock'
+
 RSpec.configure do |config|
   config.order = 'random'
 
@@ -47,11 +52,9 @@ RSpec.configure do |config|
     skip 'Spec not enabled for current adapter'
   end
 
-  config.before do
-    Ethon.logger = Logging.logger[Ethon] if defined?(Ethon)
-
-    Logging.logger.root.level = :debug
-    Logging.logger.root.add_appenders Logging.appenders.stdout
+  config.before(:suite) do
+    Restify.logger = Logger.new($stdout, level: ENV.fetch('LOG_LEVEL', 'debug'))
+    Ethon.logger = Restify.logger
   end
 
   config.warnings = true

data/spec/support/stub_server.rb

@@ -65,8 +65,8 @@ module Stub
 
   class Exception < ::StandardError; end
 
-  # Inject into base adapter to have HTTP 599 (missing stub) error raised as an
-  # extra exception, not just a server error.
+  # Inject into base adapter to have HTTP 599 (missing stub) error
+  # raised as an extra exception, not just a server error.
   module Patch
     def call(request)
       super.then do |response|
@@ -98,8 +98,8 @@ RSpec.configure do |config|
   config.before(:suite) do
     Stub.start_server!
 
-    # Net::HTTP adapter must be enabled, otherwise webmock fails to create mock
-    # responses from raw strings.
+    # Net::HTTP adapter must be enabled, otherwise webmock fails to
+    # create mock responses from raw strings.
     WebMock.disable!(except: %i[net_http])
   end