restify 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8910f0a86f7bab64dbcfe43794c8fddbe8d37fb289845105718f61de3228f245
-  data.tar.gz: 843c1fd568747ed129589f08a8d7e3e040315f49f49620e46cd40265e1df2411
+  metadata.gz: 4c8ac98ab3e0dab023e3ab8d312e9c1e88a58dd13b05652097bc514a3c1e6d23
+  data.tar.gz: eaad6494cb221afc8a3ee4175da1c754fa4cc0ca69c5fa4e12af54162672ae7b
 SHA512:
-  metadata.gz: 1697fecae910ceaf8c93f40416dcef77a1eba6a5bb0aa9fb67fffa520a7191fb273ac5a5bb9202ee00a7eec6ad559ccebd56f07b1a7c572077f4d44c9f7d3500
-  data.tar.gz: 4ad078a7595c6fdf7fc867eb367f658c7e1cec5297845467547668177834ad5722447520de2d3bcf1c0c1ff0d7924c903b7fe55cbe443bfa33605b5de2a8da0a
+  metadata.gz: 6a323d105962242cc5254373f7c6481956d04dbd3cc1baada59154bcc0256e44ddae3714f184c50d99632bd4f2ceff5e16c1d27fb826c5c07f0edbfaf7e19fc7
+  data.tar.gz: d215812e63850c400efe4339ec7ef6d770f844bf1990344a074c8811fe5c0868d92b432ad573f6ae0e2d716f48e191101c3321b889e6cf4d934bcd593fa245b0

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## 1.6.0
+
+* Specify headers on restify clients and individual requests (#14)
+
 ## 1.5.0
 
 * Tune typhoeus adapter to be more race-condition resilent

data/README.md

@@ -20,7 +20,8 @@ The HTTP adapters are mostly run in a background thread and may not survive mid-
 
 Included processors can handle:
 
-* Plain JSON with GitHub-Style relations
+* Plain JSON with GitHub-style relations
+* MessagePack with GitHub-style relations *(currently experimental)*
 
 (Beside HTTP Link header that's always supported)
 
@@ -31,7 +32,7 @@ Restify requires Ruby 2.0+.
 * HTTP cache
 * API versions via header
 * Content-Type and Language negotiation
-* Processors for MessagePack, JSON-HAL, etc.
+* Processors for JSON-HAL, etc.
 
 ## Installation
 

data/lib/restify/context.rb

@@ -48,12 +48,13 @@ module Restify
     end
 
     # rubocop:disable Metrics/MethodLength
-    def request(method, uri, data: nil, **kwargs)
-      request = Request.new(**kwargs,
+    def request(method, uri, data: nil, headers: {}, **kwargs)
+      request = Request.new(
+        headers: default_headers.merge(headers),
+        **kwargs,
         method: method,
         uri: join(uri),
-        data: data,
-        headers: headers
+        data: data
       )
 
       ret = cache.call(request) {|req| adapter.call(req) }
@@ -77,7 +78,7 @@ module Restify
     def marshal_dump
       {
         uri: uri.to_s,
-        headers: headers
+        headers: default_headers
       }
     end
 
@@ -96,7 +97,7 @@ module Restify
       options[:cache] || Restify.cache
     end
 
-    def headers
+    def default_headers
       options.fetch(:headers, {})
     end
 

data/lib/restify/version.rb

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

data/spec/restify/context_spec.rb

@@ -13,8 +13,8 @@ describe Restify::Context do
       describe '#uri' do
         subject { super().uri }
 
-        it { expect(subject).to be_a Addressable::URI }
-        it { expect(subject).to eq context.uri }
+        it { is_expected.to be_a Addressable::URI }
+        it { is_expected.to eq context.uri }
       end
 
       describe '#adapter' do
@@ -36,11 +36,11 @@ describe Restify::Context do
       end
 
       describe '#headers' do
-        let(:kwargs) { {headers: {'Accept': 'application/json'}} }
+        let(:kwargs) { {headers: {'Accept' => 'application/json'}} }
         subject { super().options[:headers] }
 
-        it do
-          expect(subject).to eq context.send :headers
+        it 'all headers are serialized' do
+          expect(subject).to eq({'Accept' => 'application/json'})
         end
       end
     end

data/spec/restify/features/request_headers_spec.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restify do
+  let!(:request_stub) do
+    stub_request(:get, 'http://localhost/base').to_return do
+      <<-EOF.gsub(/^ {8}/, '')
+        HTTP/1.1 200 OK
+        Content-Type: application/json
+        Transfer-Encoding: chunked
+        Link: <http://localhost/base>; rel="self"
+
+        { "response": "success" }
+      EOF
+    end
+  end
+
+  context 'with request headers configured for a single request' do
+    let(:context) { Restify.new('http://localhost/base') }
+
+    it 'sends the headers only for that request' do
+      root = context.get(
+        {},
+        headers: {'Accept' => 'application/msgpack, application/json'}
+      ).value!
+
+      root.rel(:self).get.value!
+
+      expect(request_stub).to have_been_requested.twice
+      expect(
+        request_stub.with(headers: {'Accept' => 'application/msgpack, application/json'})
+      ).to have_been_requested.once
+    end
+  end
+
+  context 'with request headers configured for context' do
+    let(:context) do
+      Restify.new(
+        'http://localhost/base',
+        headers: {'Accept' => 'application/msgpack, application/json'}
+      )
+    end
+
+    it 'sends the headers with each request' do
+      root = context.get.value!
+
+      root.rel(:self).get.value!
+
+      expect(
+        request_stub.with(headers: {'Accept' => 'application/msgpack, application/json'})
+      ).to have_been_requested.twice
+    end
+
+    it 'can overwrite headers for single requests' do
+      root = context.get(
+        {},
+        headers: {'Accept' => 'application/xml'}
+      ).value!
+
+      root.rel(:self).get.value!
+
+      expect(
+        request_stub.with(headers: {'Accept' => 'application/xml'})
+      ).to have_been_requested.once
+      expect(
+        request_stub.with(headers: {'Accept' => 'application/msgpack, application/json'})
+      ).to have_been_requested.once
+    end
+
+    it 'can add additional headers for single requests' do
+      root = context.get(
+        {},
+        headers: {'X-Custom' => 'foobar'}
+      ).value!
+
+      root.rel(:self).get.value!
+
+      expect(
+        request_stub.with(headers: {'Accept' => 'application/msgpack, application/json'})
+      ).to have_been_requested.twice
+      expect(
+        request_stub.with(headers: {'Accept' => 'application/msgpack, application/json', 'X-Custom' => 'foobar'})
+      ).to have_been_requested.once
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -47,7 +47,9 @@ RSpec.configure do |config|
     ::Logging.logger.root.add_appenders ::Logging.appenders.stdout
   end
 
-  config.after(:each) do
-    EventMachine.stop if defined?(EventMachine) && EventMachine.reactor_running?
+  config.after(:all) do
+    if defined?(EventMachine) && EventMachine.reactor_running?
+      EventMachine.stop
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restify
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Jan Graichen
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-31 00:00:00.000000000 Z
+date: 2018-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -171,6 +171,7 @@ files:
 - lib/restify/version.rb
 - spec/restify/cache_spec.rb
 - spec/restify/context_spec.rb
+- spec/restify/features/request_headers_spec.rb
 - spec/restify/global_spec.rb
 - spec/restify/link_spec.rb
 - spec/restify/processors/base_spec.rb
@@ -209,6 +210,7 @@ summary: An experimental hypermedia REST client.
 test_files:
 - spec/restify/cache_spec.rb
 - spec/restify/context_spec.rb
+- spec/restify/features/request_headers_spec.rb
 - spec/restify/global_spec.rb
 - spec/restify/link_spec.rb
 - spec/restify/processors/base_spec.rb