Merge pull request #35 from ahx/customize-faraday

Allow to pass a block to Store.new to customize faraday

README.md

@@ -225,6 +225,20 @@ You can add an *Authorization* header to all your requests by configuring the st
 store = Lurch::Store.new("...", authorization: "Bearer eyJhbGciOiJub25lIiwidHlwIjoiSldUIn0.eyJzdWIiOjEsIm5hbWUiOiJCb2IifQ.")
 ```
 
+## Customize Faraday
+
+You can customize [faraday](https://rubygems.org/gems/faraday) by passing a block to `Store.new`.
+Use this to add arbitrary headers or faraday middlewares.
+
+```ruby
+store = Lurch::Store.new("http://example.com/api") do |conn|
+  # conn.use MyFaradayMiddleware
+  conn.headers['X-Request-Id'] = '123'
+end
+
+store.from(:people).all
+```
+
 ## Contributing
 
 1.  Fork it (<https://github.com/peek-travel/lurch/fork>)

TODO.md

@@ -10,7 +10,7 @@
 * [x] Configurable field and path adapters (dasherized vs underscored vs ~~camelcased~~)
 * [x] Configurable pluralization/singularization (don't assume urls and types are always plural)
 * [x] Handle paginated results
-* [ ] Allow arbitrary headers
+* [x] Allow arbitrary headers
 * [x] Allow arbitrary query params
 * [ ] Singleton resources
 * [ ] Handle links better?

lib/lurch/client.rb

@@ -13,9 +13,10 @@ class Client
       422 => Errors::UnprocessableEntity
     }.freeze
 
-    def initialize(url, config)
+    def initialize(url, config, &block)
       @url = url
       @config = config
+      @customize_faraday = block if block_given?
     end
 
     def get(path)
@@ -87,6 +88,7 @@ def client
 
         conn.request :jsonapi
         conn.response :jsonapi
+        @customize_faraday&.yield(conn)
 
         conn.adapter :typhoeus
       end

lib/lurch/store.rb

@@ -2,9 +2,9 @@
 
 module Lurch
   class Store
-    def initialize(url, options = {})
+    def initialize(url, options = {}, &block)
       @config = StoreConfiguration.new(options)
-      @client = Client.new(url, @config)
+      @client = Client.new(url, @config, &block)
       @store = Hash.new { |hash, key| hash[key] = {} }
     end
 

test/lurch/test_customize_faraday.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "../test_helper"
+
+class TestCustomizeFaraday < Minitest::Test
+  include LurchTest
+
+  def test_customize_faraday
+    stub = stub_request(
+      :get,
+      "#{@url}/people"
+    ).with(headers: { 'X-Request-Id' => '123' })
+
+    store = Lurch::Store.new(@url) do |conn|
+      conn.headers['X-Request-Id'] = '123'
+    end
+
+    store.from(:people).all
+
+    assert_requested(stub)
+  end
+end