hal-client 2.5.0 → 3.0

data/README.md

@@ -131,6 +131,10 @@ Or install it yourself as:
 
     $ gem install hal-client
 
+## Upgrading from 2.x to 3.x
+
+For most uses no change to client code is required. At 3.0 the underlying HTTP library changed to <https://rubygems.org/gems/http> to better support our parallelism needs. This changes the interface of `#get` and `#post` on `HalClient` and `HalClient::Representation` in the situation where the response is not a valid HAL document. In those situations the return value is now a `HTTP::Response` object, rather than a `RestClient::Response`.
+
 ## Upgrading from 1.x to 2.x
 
 The signature of `HalClient::Representation#new` changed such that keyword arguments are required. Any direct uses of that method must be changed. This is the only breaking change.

data/hal-client.gemspec

@@ -18,13 +18,13 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "rest-client", "~> 1.6"
+  spec.add_dependency "http", "~> 0.6.1"
   spec.add_dependency "addressable", "~> 2.3"
   spec.add_dependency "multi_json", "~> 1.9"
 
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.1"
   spec.add_development_dependency "rspec", "~> 3.0.0.beta"
-  spec.add_development_dependency "webmock", "~> 1.16"
+  spec.add_development_dependency "webmock", ["~> 1.17", ">= 1.17.4"]
   spec.add_development_dependency "rspec-collection_matchers"
 end

data/lib/hal_client/errors.rb

@@ -1,4 +1,23 @@
 class HalClient
+  # The representation is not a valid HAL document.
   InvalidRepresentationError = Class.new(StandardError)
+
+  # The representation is not a HAL collection
   NotACollectionError = Class.new(StandardError)
+
+  # Server responded with a non-200 status code
+  class HttpError < StandardError
+    def initialize(message, response)
+      @response = response
+      super(message)
+    end
+
+    attr_reader :response
+  end
+
+  # Server response with a 4xx status code
+  HttpClientError = Class.new(HttpError)
+
+  # Server responded with a 5xx status code
+  HttpServerError = Class.new(HttpError)
 end

data/lib/hal_client/version.rb

@@ -1,3 +1,3 @@
 class HalClient
-  VERSION = "2.5.0"
+  VERSION = "3.0"
 end

data/lib/hal_client.rb

@@ -1,5 +1,5 @@
 require "hal_client/version"
-require 'rest-client'
+require 'http'
 require 'multi_json'
 
 # Adapter used to access resources.
@@ -11,6 +11,9 @@ class HalClient
   autoload :Collection, 'hal_client/collection'
   autoload :InvalidRepresentationError, 'hal_client/errors'
   autoload :NotACollectionError, 'hal_client/errors'
+  autoload :HttpError, 'hal_client/errors'
+  autoload :HttpClientError, 'hal_client/errors'
+  autoload :HttpServerError, 'hal_client/errors'
 
   # Initializes a new client instance
   #
@@ -21,52 +24,133 @@ class HalClient
   #     prepended to the `Content-Type` header field of each request.
   #   :headers - a hash of other headers to send on each request.
   def initialize(options={})
-    accept       = options.fetch(:accept, 'application/hal+json')
-    content_type = options.fetch(:content_type, 'application/hal+json')
-    headers      = options.fetch(:headers, {})
+    @default_message_request_headers = HTTP::Headers.new
+    @default_entity_request_headers = HTTP::Headers.new
+
+    default_message_request_headers.set('Accept', options[:accept]) if
+      options[:accept]
+    # Explicit accept option has precedence over accepts in the
+    # headers option.
+
+    options.fetch(:headers, {}).each do |name, value|
+      if entity_header_field? name
+        default_entity_request_headers.add(name, value)
+      else
+        default_message_request_headers.add(name, value)
+      end
+    end
+
+    default_entity_request_headers.set('Content-Type', options[:content_type]) if
+      options[:content_type]
+    # Explicit content_content options has precedence over content
+    # type in the headers option.
+
+    default_entity_request_headers.set('Content-Type', 'application/hal+json') unless
+      default_entity_request_headers['Content-Type']
+    # We always want a content type. If the user doesn't explicitly
+    # specify one we provide a default.
 
-    @headers = {accept: accept, content_type: content_type}.merge(headers)
+    accept_values = Array(default_message_request_headers.get('Accept')) +
+      ['application/hal+json;q=0']
+    default_message_request_headers.set('Accept', accept_values.join(", "))
+    # We can work with HAL so provide a back stop accept.
   end
 
   # Returns a `Representation` of the resource identified by `url`.
   #
   # url - The URL of the resource of interest.
-  # options - set of options to pass to `RestClient#get`
-  def get(url, options={})
-    resp = RestClient.get url, get_options(options)
-    Representation.new hal_client: self, parsed_json: MultiJson.load(resp)
+  # headers - custom header fields to use for this request
+  def get(url, headers={})
+    interpret_response client_for_get(override_headers: headers).get(url)
   end
 
   # Post a `Representation` or `String` to the resource identified at `url`.
   #
   # url - The URL of the resource of interest.
   # data - a `String` or an object that responds to `#to_hal`
-  # options - set of options to pass to `RestClient#post`
-  def post(url, data, options={})
-    resp = RestClient.post url, data, post_options(options)
-
-    begin
-      Representation.new hal_client: self, parsed_json: MultiJson.load(resp)
-    rescue MultiJson::ParseError, InvalidRepresentationError => e
-      resp
-    end
+  # headers - custom header fields to use for this request
+  def post(url, data, headers={})
+    req_body = if data.respond_to? :to_hal
+                 data.to_hal
+               else
+                 data
+               end
+
+    interpret_response client_for_post(headers).post(url, body: req_body)
   end
 
   protected
 
   attr_reader :headers
 
-  # Exclude headers that shouldn't go with a GET
-  def get_options(overrides)
-    @cleansed_get_options ||= headers.dup.tap do |get_headers|
-      get_headers.delete(:content_type)
+  def interpret_response(resp)
+    case resp.status
+    when 200...300
+      begin
+        Representation.new hal_client: self, parsed_json: MultiJson.load(resp.to_s)
+      rescue MultiJson::ParseError, InvalidRepresentationError => e
+        resp
+      end
+
+    when 400...500
+      raise HttpClientError.new(nil, resp)
+
+    when 500...600
+      raise HttpServerError.new(nil, resp)
+
+    else
+      raise HttpError.new(nil, resp)
+
+    end
+  end
+
+  # Returns the HTTP client to be used to make get requests.
+  #
+  # options
+  #   :override_headers -
+  def client_for_get(options={})
+    override_headers = options[:override_headers]
+
+    if !override_headers
+      @client_for_get ||= base_client.with_headers(default_message_request_headers)
+    else
+      client_for_get.with_headers(override_headers)
+    end
+  end
+
+  # Returns the HTTP client to be used to make post requests.
+  #
+  # options
+  #   :override_headers -
+  def client_for_post(options={})
+    override_headers = options[:override_headers]
+
+    if !override_headers
+      @client_for_post ||=
+        base_client.with_headers(default_entity_and_message_request_headers)
+    else
+      client_for_post.with_headers(override_headers)
     end
+  end
+
+  # Returns an HTTP client.
+  def base_client
+    @base_client ||= HTTP::Client.new
+  end
+
+  attr_reader :default_entity_request_headers, :default_message_request_headers
+
+  def default_entity_and_message_request_headers
+    @default_entity_and_message_request_headers ||=
+      default_message_request_headers.merge(default_entity_request_headers)
+  end
 
-    @cleansed_get_options.merge overrides
+  def default_entity_request_headers
+    @default_entity_request_headers
   end
 
-  def post_options(overrides)
-    headers.merge(overrides)
+  def entity_header_field?(field_name)
+    [:content_type, /^content-type$/i].any?{|pat| pat === field_name}
   end
 
   module EntryPointCovenienceMethods

data/spec/hal_client_spec.rb

@@ -7,6 +7,8 @@ describe HalClient do
     it { should be_kind_of HalClient }
   end
 
+  subject(:client) { HalClient.new }
+
   describe '.new w/ custom accept' do
     subject { HalClient.new(accept: "application/vnd.myspecialmediatype") }
     it { should be_kind_of HalClient }
@@ -25,7 +27,7 @@ describe HalClient do
       it("should have been made") { should have_been_made }
 
       it "sends accept header" do
-        expect(request.with(headers: {'Accept' => 'application/hal+json'})).
+        expect(request.with(headers: {'Accept' => /application\/hal\+json/i})).
           to have_been_made
       end
     end
@@ -33,7 +35,7 @@ describe HalClient do
     context "explicit accept" do
       subject(:client) { HalClient.new accept: 'app/test' }
       it "sends specified accept header" do
-        expect(request.with(headers: {'Accept' => 'app/test'})).
+        expect(request.with(headers: {'Accept' => /app\/test/i})).
           to have_been_made
       end
     end
@@ -41,7 +43,7 @@ describe HalClient do
     context "explicit content type" do
       subject(:client) { HalClient.new content_type: 'custom' }
       it "does not send the content type header" do
-        expect(request.with(headers: {'Accept' => 'application/hal+json'})).to have_been_made
+        expect(request.with(headers: {'Accept' => /application\/hal\+json/i})).to have_been_made
       end
     end
 
@@ -61,6 +63,54 @@ describe HalClient do
     end
   end
 
+  context "server responds with client error" do
+    let!(:request) { stub_request(:any, "http://example.com/foo").
+      to_return body: "Bad client! No cookie!", status: 400  }
+
+    it "#get raises HttpClientError" do
+      expect{client.get "http://example.com/foo"}.to raise_exception HalClient::HttpClientError
+    end
+
+    it "#get attaches response to the raised error" do
+      err = client.get("http://example.com/foo") rescue $!
+      expect(err.response).to be_kind_of HTTP::Response
+    end
+
+
+    it "#post raises HttpClientError" do
+      expect{client.post "http://example.com/foo", "foo"}.to raise_exception HalClient::HttpClientError
+    end
+
+    it "#post attaches response to the raise error" do
+      err = client.post("http://example.com/foo", "") rescue $!
+      expect(err.response).to be_kind_of HTTP::Response
+    end
+  end
+
+  context "server responds with server error" do
+    let!(:request) { stub_request(:any, "http://example.com/foo").
+      to_return body: "Bad server! No cookie!", status: 500  }
+
+    it "#get raises HttpServerError" do
+      expect{client.get "http://example.com/foo"}.to raise_exception HalClient::HttpServerError
+    end
+
+    it "#get attaches response to the raised error" do
+      err = client.get("http://example.com/foo") rescue $!
+      expect(err.response).to be_kind_of HTTP::Response
+    end
+
+
+    it "#post raises HttpServerError" do
+      expect{client.post "http://example.com/foo", "foo"}.to raise_exception HalClient::HttpServerError
+    end
+
+    it "#post attaches response to the raise error" do
+      err = client.post("http://example.com/foo", "") rescue $!
+      expect(err.response).to be_kind_of HTTP::Response
+    end
+  end
+
   describe ".get(<url>)" do
     let!(:return_val) { HalClient.get "http://example.com/foo" }
 
@@ -73,7 +123,7 @@ describe HalClient do
       it("should have been made") { should have_been_made }
 
       it "sends accept header" do
-        expect(request.with(headers: {'Accept' => 'application/hal+json'})).
+        expect(request.with(headers: {'Accept' => /application\/hal\+json/})).
           to have_been_made
       end
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal-client
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: '3.0'
   prerelease: 
 platform: ruby
 authors:
@@ -9,16 +9,16 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: http
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.6.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.6'
+        version: 0.6.1
 - !ruby/object:Gem::Dependency
   name: addressable
   requirement: !ruby/object:Gem::Requirement
@@ -114,7 +114,10 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.17.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -122,7 +125,10 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '1.17'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.17.4
 - !ruby/object:Gem::Dependency
   name: rspec-collection_matchers
   requirement: !ruby/object:Gem::Requirement
@@ -184,7 +190,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1272540946785022860
+      hash: -442637899348440832
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -193,7 +199,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1272540946785022860
+      hash: -442637899348440832
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23