restify 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2f418e5e5915c208da950884e753c70e0c6da648978dde9eb75f067ba6feedc
-  data.tar.gz: 98d1d14d29a06ac14ecaf564b0788d7054a7685ddc3126b4c24e80771ab95e86
+  metadata.gz: 6209f25a9b9d70898ee86458568d669ee588dd7d01a0918855ca39c6995332dd
+  data.tar.gz: 32e35cd463f1ce87d76cf0ded3bcf3f8266f305a5d10aafbc62fb47ff3145315
 SHA512:
-  metadata.gz: eb15fbef6af84a77badcfea901c83676952359a509e3d7a91a8b46db4d2808fd7f4c552e151d9a2b7ede68b0f46aaca5c33c77f78bd4aaa614d10a04c31862f6
-  data.tar.gz: 858169275d7a141d641cf1ef492692c6546057aaa6c865b1c5277038d417448b12288ac57cdc7a3e26a260b90275c6fe448deb135154ebe48dca95787ebdbf84
+  metadata.gz: eb70a7e9edb83c76074566b8607c9439b585b8c95925806a84b343dee96872f2d497fb96edf2120109c8cbcc337a141c8c6447ad35ed88b83c51dddcdb2cb0c0
+  data.tar.gz: 38cc84e8835134df693ef1161cf1696d15823e28077d5c5c4214c939298db79a01127c3147fe1f9ecdbce08de5a782a592da2bc7d9bfc79afdb7e70d194f0324

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.8.0
+
+* Add HEAD request method (#16)
+
 ## 1.7.0
 
 * Introduce promise dependency timeouts (#15)

data/README.md

@@ -1,6 +1,8 @@
 # Restify
 
-Restify is an experimental hypermedia REST client that does parallel, concurrent and keep-alive requests by default.
+[![Build Status](https://travis-ci.org/jgraichen/restify.svg?branch=master)](https://travis-ci.org/jgraichen/restify)
+
+Restify is an hypermedia REST client that does parallel, concurrent and keep-alive requests by default.
 
 Restify scans Link headers and returned resource for links and relations to other resources, represented as RFC6570 URI Templates, and exposes those to the developer.
 
@@ -121,7 +123,7 @@ See commented example in main spec [`spec/restify_spec.rb`](https://github.com/j
 
 ## License
 
-Copyright (C) 2014-2015 Jan Graichen
+Copyright (C) 2014-2018 Jan Graichen
 
 This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
 

data/lib/restify/adapter/em.rb

@@ -37,6 +37,7 @@ module Restify
             requests << [request, writer, retried]
           end
         end
+        # rubocop:enable all
 
         def connection
           @connection ||= EventMachine::HttpRequest.new(origin)
@@ -101,12 +102,13 @@ module Restify
             else
               begin
                 raise "(#{req.response_header.status}) #{req.error}"
-              rescue => e
+              rescue StandardError => e
                 writer.reject e
               end
             end
           end
         end
+        # rubocop:enable all
       end
 
       def call_native(request, writer)
@@ -128,7 +130,7 @@ module Restify
         Thread.new do
           begin
             EventMachine.run {}
-          rescue => e
+          rescue StandardError => e
             puts "#{self.class} -> #{e}\n#{e.backtrace.join("\n")}"
             raise e
           end

data/lib/restify/adapter/pooled_em.rb

@@ -263,7 +263,7 @@ module Restify
         Thread.new do
           begin
             EventMachine.run {}
-          rescue => e
+          rescue StandardError => e
             logger.error(e)
             raise e
           end

data/lib/restify/adapter/typhoeus.rb

@@ -27,6 +27,8 @@ module Restify
         @sync
       end
 
+      # rubocop:disable AbcSize
+      # rubocop:disable MethodLength
       def call_native(request, writer)
         req = convert(request, writer)
 
@@ -34,20 +36,28 @@ module Restify
           req.run
         else
           @mutex.synchronize do
-            logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] [#{request.object_id}] request:add method=#{request.method.upcase} url=#{request.uri}" }
+            debug 'request:add',
+              tag: request.object_id,
+              method: request.method.upcase,
+              url: request.uri
+
             @hydra.queue(req)
             @hydra.dequeue_many
 
             thread.run unless thread.status
           end
 
-          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] [#{request.object_id}] request:signal" }
+          debug 'request:signal', tag: request.object_id
+
           @signal.signal
         end
       end
+      # rubocop:enable all
 
       private
 
+      # rubocop:disable AbcSize
+      # rubocop:disable MethodLength
       def convert(request, writer)
         ::Typhoeus::Request.new(
           request.uri,
@@ -59,18 +69,22 @@ module Restify
           connecttimeout: request.timeout
         ).tap do |req|
           req.on_complete do |response|
-            logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] [#{request.object_id}] request:complete status=#{response.code}" }
+            debug 'request:complete',
+              tag: request.object_id,
+              status: response.code
 
             if response.timed_out?
               writer.reject Restify::Timeout.new request
-            elsif response.code == 0
-              writer.reject Restify::NetworkError.new request, response.return_message
+            elsif response.code.zero?
+              writer.reject \
+                Restify::NetworkError.new(request, response.return_message)
             else
               writer.fulfill convert_back(response, request)
             end
           end
         end
       end
+      # rubocop:enable all
 
       def convert_back(response, request)
         uri     = request.uri
@@ -92,7 +106,8 @@ module Restify
       def thread
         if @thread.nil? || !@thread.status
           # Recreate thread if nil or dead
-          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:spawn" }
+          debug 'hydra:spawn'
+
           @thread = Thread.new { _loop }
         end
 
@@ -108,21 +123,27 @@ module Restify
         @hydra.queued_requests.any? || @hydra.multi.easy_handles.any?
       end
 
+      # rubocop:disable MethodLength
       def _run
-        logger.debug { "[#{self.object_id}/#{Process.pid}] hydra:run" }
+        debug 'hydra:run'
         @hydra.run while _ongoing?
-        logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:completed" }
+        debug 'hydra:completed'
 
         @mutex.synchronize do
           return if _ongoing?
 
-          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:pause" }
+          debug 'hydra:pause'
           @signal.wait(@mutex, 60)
-          logger.debug { "[#{self.object_id}/#{Thread.current.object_id}] hydra:resumed" }
+          debug 'hydra:resumed'
         end
       rescue StandardError => e
         logger.error(e)
       end
+      # rubocop:enable all
+
+      def _log_prefix
+        "[#{object_id}/#{Thread.current.object_id}]"
+      end
     end
   end
 end

data/lib/restify/context.rb

@@ -35,7 +35,7 @@ module Restify
     end
 
     def inherit(uri, **kwargs)
-      uri = self.uri unless uri
+      uri ||= self.uri
       Context.new uri, kwargs.merge(options)
     end
 
@@ -66,6 +66,7 @@ module Restify
         end
       end
     end
+    # rubocop:enable all
 
     def encode_with(coder)
       coder.map = marshal_dump

data/lib/restify/error.rb

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
 module Restify
-  #
-
   # A {NetworkError} is raised on unusual network exceptions such as
   # unresolvable hosts or disconnects.
   #

data/lib/restify/global.rb

@@ -33,9 +33,7 @@ module Restify
       ::Logging.logger[Restify]
     end
 
-    def logger=(logger)
-
-    end
+    def logger=(logger); end
 
     private
 

data/lib/restify/logging.rb

@@ -7,5 +7,24 @@ module Restify
     def logger
       @logger ||= ::Logging.logger[self]
     end
+
+    def debug(message = nil, tag: nil, **kwargs)
+      logger.debug do
+        [
+          _log_prefix,
+          *Array(tag),
+          message,
+          _fmt(**kwargs)
+        ].map(&:to_s).reject(&:empty?).join(' ')
+      end
+    end
+
+    def _log_prefix
+      nil
+    end
+
+    def _fmt(**kwargs)
+      kwargs.each.map {|k, v| "#{k}=#{v}" }.join(' ')
+    end
   end
 end

data/lib/restify/processors/base.rb

@@ -1,16 +1,12 @@
 # frozen_string_literal: true
 
 module Restify
-  #
   module Processors
-    #
     class Base
       extend Forwardable
 
-      #
       attr_reader :context
 
-      #
       attr_reader :response
 
       def initialize(context, response)

data/lib/restify/promise.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Restify
-  #
   class Promise < Concurrent::IVar
     def initialize(*dependencies, &task)
       @task         = task

data/lib/restify/relation.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Restify
-  #
   class Relation
     # Relation context
     #
@@ -28,6 +27,10 @@ module Restify
       request :get, nil, params, opts
     end
 
+    def head(params = {}, opts = {})
+      request :head, nil, params, opts
+    end
+
     def delete(params = {}, opts = {})
       request :delete, nil, params, opts
     end

data/lib/restify/request.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 module Restify
-  #
   class Request
     #
     # HTTP method.

data/lib/restify/resource.rb

@@ -3,7 +3,6 @@
 require 'delegate'
 
 module Restify
-  #
   class Resource < SimpleDelegator
     # @api private
     #
@@ -81,6 +80,7 @@ module Restify
         raise 'Nothing to follow'
       end
     end
+    # rubocop:enable all
 
     # @api private
     def _restify_relations

data/lib/restify/response.rb

@@ -104,6 +104,7 @@ module Restify
         end
       end
     end
+    # rubocop:enable all
 
     # Return content type header from response headers.
     #

data/lib/restify/version.rb

@@ -3,7 +3,7 @@
 module Restify
   module VERSION
     MAJOR = 1
-    MINOR = 7
+    MINOR = 8
     PATCH = 0
     STAGE = nil
     STRING = [MAJOR, MINOR, PATCH, STAGE].reject(&:nil?).join('.').freeze

data/spec/restify/context_spec.rb

@@ -40,7 +40,7 @@ describe Restify::Context do
         subject { super().options[:headers] }
 
         it 'all headers are serialized' do
-          expect(subject).to eq({'Accept' => 'application/json'})
+          expect(subject).to eq('Accept' => 'application/json')
         end
       end
     end

data/spec/restify/features/head_requests_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restify do
+  let!(:request_stub) do
+    stub_request(:head, 'http://localhost/base')
+      .with(query: hash_including({}))
+      .to_return do
+      <<-RESPONSE.gsub(/^ {8}/, '')
+        HTTP/1.1 200 OK
+        Content-Length: 333
+        Transfer-Encoding: chunked
+        Link: <http://localhost/other>; rel="neat"
+      RESPONSE
+    end
+  end
+
+  describe 'HEAD requests' do
+    subject { Restify.new('http://localhost/base').head(params).value! }
+    let(:params) { {} }
+
+    it 'returns a resource with access to headers' do
+      expect(subject.response.headers).to include('CONTENT_LENGTH' => '333')
+    end
+
+    it 'parses Link headers into relations' do
+      expect(subject).to have_relation :neat
+    end
+
+    context 'with params' do
+      let(:params) { {foo: 'bar'} }
+
+      it 'adds them to the query string' do
+        subject
+        expect(
+          request_stub.with(query: {foo: 'bar'})
+        ).to have_been_requested
+      end
+    end
+  end
+end

data/spec/restify/features/request_headers_spec.rb

@@ -5,14 +5,14 @@ require 'spec_helper'
 describe Restify do
   let!(:request_stub) do
     stub_request(:get, 'http://localhost/base').to_return do
-      <<-EOF.gsub(/^ {8}/, '')
+      <<-RESPONSE.gsub(/^ {8}/, '')
         HTTP/1.1 200 OK
         Content-Type: application/json
         Transfer-Encoding: chunked
         Link: <http://localhost/base>; rel="self"
 
         { "response": "success" }
-      EOF
+      RESPONSE
     end
   end
 
@@ -22,7 +22,7 @@ describe Restify do
     it 'sends the headers only for that request' do
       root = context.get(
         {},
-        headers: {'Accept' => 'application/msgpack, application/json'}
+        {headers: {'Accept' => 'application/msgpack, application/json'}}
       ).value!
 
       root.rel(:self).get.value!
@@ -55,7 +55,7 @@ describe Restify do
     it 'can overwrite headers for single requests' do
       root = context.get(
         {},
-        headers: {'Accept' => 'application/xml'}
+        {headers: {'Accept' => 'application/xml'}}
       ).value!
 
       root.rel(:self).get.value!
@@ -71,7 +71,7 @@ describe Restify do
     it 'can add additional headers for single requests' do
       root = context.get(
         {},
-        headers: {'X-Custom' => 'foobar'}
+        {headers: {'X-Custom' => 'foobar'}}
       ).value!
 
       root.rel(:self).get.value!

data/spec/restify/timeout_spec.rb

@@ -23,32 +23,32 @@ describe Restify::Timeout do
 
   describe '#wait_on!' do
     it 'calls block on IVar timeout' do
-      expect {
+      expect do
         timer.wait_on!(Concurrent::IVar.new)
-      }.to raise_error ::Restify::Timeout::Error
+      end.to raise_error ::Restify::Timeout::Error
     end
 
     it 'calls block on Promise timeout' do
-      expect {
+      expect do
         timer.wait_on!(Restify::Promise.new)
-      }.to raise_error ::Restify::Timeout::Error
+      end.to raise_error ::Restify::Timeout::Error
     end
 
     it 'does nothing on successful IVar' do
-      expect {
+      expect do
         Concurrent::IVar.new.tap do |ivar|
           Thread.new { ivar.set :success }
           expect(timer.wait_on!(ivar)).to eq :success
         end
-      }.to_not raise_error
+      end.to_not raise_error
     end
 
     it 'does nothing on successful Promise' do
-      expect {
+      expect do
         Restify::Promise.fulfilled(:success).tap do |p|
           expect(timer.wait_on!(p)).to eq :success
         end
-      }.to_not raise_error
+      end.to_not raise_error
     end
   end
 end

data/spec/restify_spec.rb

@@ -6,7 +6,7 @@ describe Restify do
   context 'as a dynamic HATEOAS client' do
     before do
       stub_request(:get, 'http://localhost/base').to_return do
-        <<-EOF.gsub(/^ {10}/, '')
+        <<-RESPONSE.gsub(/^ {10}/, '')
           HTTP/1.1 200 OK
           Content-Type: application/json
           Transfer-Encoding: chunked
@@ -18,11 +18,11 @@ describe Restify do
             "search_url": "http://localhost/base/search?q={query}",
             "mirror_url": null
           }
-        EOF
+        RESPONSE
       end
 
       stub_request(:get, 'http://localhost/base/users').to_return do
-        <<-EOF.gsub(/^ {10}/, '')
+        <<-RESPONSE.gsub(/^ {10}/, '')
           HTTP/1.1 200 OK
           Content-Type: application/json
           Transfer-Encoding: chunked
@@ -37,25 +37,25 @@ describe Restify do
              "name": "Jane Smith",
              "self_url": "http://localhost/base/user/jane.smith"
            }]
-        EOF
+        RESPONSE
       end
 
       stub_request(:post, 'http://localhost/base/users')
         .with(body: {})
         .to_return do
-        <<-EOF.gsub(/^ {12}/, '')
+        <<-RESPONSE.gsub(/^ {12}/, '')
             HTTP/1.1 422 Unprocessable Entity
             Content-Type: application/json
             Transfer-Encoding: chunked
 
             {"errors":{"name":["can't be blank"]}}
-          EOF
+        RESPONSE
       end
 
       stub_request(:post, 'http://localhost/base/users')
         .with(body: {name: 'John Smith'})
         .to_return do
-        <<-EOF.gsub(/^ {12}/, '')
+        <<-RESPONSE.gsub(/^ {12}/, '')
             HTTP/1.1 201 Created
             Content-Type: application/json
             Location: http://localhost/base/users/john.smith
@@ -67,12 +67,12 @@ describe Restify do
               "blurb_url": "http://localhost/base/users/john.smith/blurb",
               "languages": ["de", "en"]
             }
-          EOF
+        RESPONSE
       end
 
       stub_request(:get, 'http://localhost/base/users/john.smith')
         .to_return do
-        <<-EOF.gsub(/^ {10}/, '')
+        <<-RESPONSE.gsub(/^ {10}/, '')
           HTTP/1.1 200 OK
           Content-Type: application/json
           Link: <http://localhost/base/users/john.smith>; rel="self"
@@ -82,12 +82,12 @@ describe Restify do
             "name": "John Smith",
             "url": "http://localhost/base/users/john.smith"
           }
-        EOF
+        RESPONSE
       end
 
       stub_request(:get, 'http://localhost/base/users/john.smith/blurb')
         .to_return do
-        <<-EOF.gsub(/^ {10}/, '')
+        <<-RESPONSE.gsub(/^ {10}/, '')
           HTTP/1.1 200 OK
           Content-Type: application/json
           Link: <http://localhost/base/users/john.smith>; rel="user"
@@ -97,7 +97,7 @@ describe Restify do
             "title": "Prof. Dr. John Smith",
             "image": "http://example.org/avatar.png"
           }
-        EOF
+        RESPONSE
       end
     end
 

data/spec/spec_helper.rb

@@ -40,6 +40,10 @@ Dir[File.expand_path('spec/support/**/*.rb')].each {|f| require f }
 RSpec.configure do |config|
   config.order = 'random'
 
+  config.before(:suite) do
+    ::Restify::Timeout.default_timeout = 2
+  end
+
   config.before(:each) do
     Ethon.logger = ::Logging.logger[Ethon] if defined?(Ethon)
 
@@ -47,9 +51,7 @@ RSpec.configure do |config|
     ::Logging.logger.root.add_appenders ::Logging.appenders.stdout
   end
 
-  config.after(:all) do
-    if defined?(EventMachine) && EventMachine.reactor_running?
-      EventMachine.stop
-    end
+  config.after(:suite) do
+    EventMachine.stop if defined?(EventMachine) && EventMachine.reactor_running?
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restify
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-15 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -186,6 +186,7 @@ files:
 - lib/restify/version.rb
 - spec/restify/cache_spec.rb
 - spec/restify/context_spec.rb
+- spec/restify/features/head_requests_spec.rb
 - spec/restify/features/request_headers_spec.rb
 - spec/restify/global_spec.rb
 - spec/restify/link_spec.rb
@@ -226,6 +227,7 @@ summary: An experimental hypermedia REST client.
 test_files:
 - spec/restify/cache_spec.rb
 - spec/restify/context_spec.rb
+- spec/restify/features/head_requests_spec.rb
 - spec/restify/features/request_headers_spec.rb
 - spec/restify/global_spec.rb
 - spec/restify/link_spec.rb