hal-client 3.3.2 → 3.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 454803feafd3de62522b145857cf25b91bceea18
-  data.tar.gz: 279121c58f7ebc9456d2b8575a342d9069346883
+  metadata.gz: 74de1dba1a4d7fcb4b836da48535915b9694219b
+  data.tar.gz: 5e3ebfbb756110e9adaefff3e339e34532fdd982
 SHA512:
-  metadata.gz: c4591e0f1bbfc67522893bf2e79781d40ad765030e8cefb9a3bdfddf9d5c1146107ffbdc8dbb401914a0abf3404b0ab75aacc64f35a15996c5b1fc558fb732f9
-  data.tar.gz: 1a12ff06dea5247600ddd62b8799b0e00f130b07088aee4de2f5d3507dd48bf9173d72b0b79f2f9ab6f5fdec307f241e7a33647e471791c9dec84a5c5693955c
+  metadata.gz: c30ea673a86d148156f8783afbdb05e663e5445910a30aedbcf67edd2775e66d9bb7fa46d4770e165f13607cdeb29b3db6c517d8cb27679aa97a3a4bd92d0f7f
+  data.tar.gz: 223ce6546a7d0adcc61ed5d1e0306fb5087b99ad15c1d9a8c6ceca5dfca5e91600f02027db42198f76240b238de9b06812311441b71c82731da1c2fa9deec526

data/lib/hal_client/version.rb

@@ -1,3 +1,3 @@
 class HalClient
-  VERSION = "3.3.2"
+  VERSION = "3.4.2"
 end

data/lib/hal_client.rb

@@ -24,10 +24,15 @@ class HalClient
   #     prepended to the `Accept` header field of each request.
   #   :content_type - a single content type that should be
   #     prepended to the `Content-Type` header field of each request.
+  #   :authorization - a `#call`able which takes the url being
+  #     requested and returns the authorization header value to use
+  #     for the request or a string which will always be the value of
+  #     the authorization header
   #   :headers - a hash of other headers to send on each request.
   def initialize(options={})
     @default_message_request_headers = HTTP::Headers.new
     @default_entity_request_headers = HTTP::Headers.new
+    @auth_helper = as_callable(options.fetch(:authorization, NullAuthHelper))
 
     default_message_request_headers.set('Accept', options[:accept]) if
       options[:accept]
@@ -63,57 +68,71 @@ class HalClient
   # url - The URL of the resource of interest.
   # headers - custom header fields to use for this request
   def get(url, headers={})
+    headers = auth_headers(url).merge(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`
-  # headers - custom header fields to use for this request
-  def post(url, data, headers={})
-    req_body = if data.respond_to? :to_hal
+  class << self
+    protected
+
+    def def_unsafe_request(method)
+      define_method(method) do |url, data, headers={}|
+        headers = auth_headers(url).merge(headers)
+
+        req_body = if data.respond_to? :to_hal
                  data.to_hal
                else
                  data
                end
 
-    interpret_response client_for_post(override_headers: headers).post(url, body: req_body)
+        interpret_response client_for_post(override_headers: headers)
+                            .request(method, url, body: req_body)
+      end
+    end
   end
 
-  # Put a `Representation` or `String` to the resource identified at `url`.
+  # 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`
   # headers - custom header fields to use for this request
-  def put(url, data, headers={})
-    req_body = if data.respond_to? :to_hal
-                 data.to_hal
-               else
-                 data
-               end
+  def_unsafe_request :post
 
-    interpret_response client_for_post(override_headers: headers).put(url, body: req_body)
-  end
+  # Put 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`
+  # headers - custom header fields to use for this request
+  def_unsafe_request :put
 
   # Patch 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`
   # headers - custom header fields to use for this request
-  def patch(url, data, headers={})
-    req_body = if data.respond_to? :to_hal
-                 data.to_hal
-               else
-                 data
-               end
-
-    interpret_response client_for_post(override_headers: headers).patch(url, body: req_body)
-  end
+  def_unsafe_request :patch
 
   protected
 
-  attr_reader :headers
+  attr_reader :headers, :auth_helper
+
+  NullAuthHelper = ->(_url) { nil }
+
+  def as_callable(thing)
+    if thing.respond_to?(:call)
+      thing
+    else
+      ->(*_args) { thing }
+    end
+  end
+
+  def auth_headers(url)
+    if h_val = auth_helper.call(url)
+      {"Authorization" => h_val}
+    else
+      {}
+    end
+  end
 
   def interpret_response(resp)
     case resp.status

data/spec/hal_client_spec.rb

@@ -47,6 +47,22 @@ describe HalClient do
       end
     end
 
+    context "explicit authorization helper" do
+      subject(:client) { HalClient.new authorization: ->(_url) { "Bearer hello" } }
+      it "sends specified accept header" do
+        expect(request.with(headers: {'Authorization' => "Bearer hello"})).
+          to have_been_made
+      end
+    end
+
+    context "explicit authorization string" do
+      subject(:client) { HalClient.new authorization: "Bearer hello" }
+      it "sends specified accept header" do
+        expect(request.with(headers: {'Authorization' => "Bearer hello"})).
+          to have_been_made
+      end
+    end
+
     context "other headers" do
       let(:headers) { {"Authorization" => "Bearer f73c04b0970f1deb6005fab53edd1708"} }
       subject(:client) { HalClient.new headers: headers }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hal-client
 version: !ruby/object:Gem::Version
-  version: 3.3.2
+  version: 3.4.2
 platform: ruby
 authors:
 - Peter Williams