reamaze_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8e117f4f567c26ad33a009c651600dacefdeaaa2
-  data.tar.gz: b617e08ac63b8c0792f64da222a6c0d422c2714c
+  metadata.gz: f6ec9222307b2003945f7caa24a03c0488607dfd
+  data.tar.gz: ce976a2b44f32b5f0ab0847f56aa3c278c9f92f5
 SHA512:
-  metadata.gz: 029895529560b1eb8e71e42120f517ca85359ab7e0d2476f62d80a8ae8f5f5e5301773947632f4434e592e741739bf21c0de337b7a84860baf46a7ffa433226f
-  data.tar.gz: aafe067d2ea6a1e0537c5943a204b2fd216305ab13e53c994bfbe5bdacf69afbb6a3727da2bf48c8a010d7ca482d382667b84a297757d0beff379ed5dd4d33c3
+  metadata.gz: 6fcfa3aceaa6de884c933c0662b7d5f71587435fc60b1dd3bfd601cb2b93e5bb4da5cdfbef29d34ea3d127a02f3fe08fc45c83ec62c3c284ea18c7d51f3cf70e
+  data.tar.gz: 46e113b6446bcf32858fb606849ef33b5b769c06c2e42f6ab655c0fa32db1b4cddd5325d4fd756003c7c8615239c4eebc69600578363b04b1112b21d3df24b65

data/README.md

@@ -9,7 +9,7 @@ Ruby library for working with the [Reamaze API][].
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'reamaze_api'
+gem "reamaze_api"
 ```
 
 And then execute:
@@ -74,6 +74,23 @@ Net::HTTP. To configure a different HTTP adapter you can set
 Faraday.default_adapter = :httpclient
 ```
 
+If you need more customization for Faraday, for example, to add additional
+middleware or change request headers, you can call `ReamazeAPI.new` with a
+block:
+
+```ruby
+class MyCoolMiddleware < Faraday::Response::Middleware
+end
+
+Faraday::Response.register_middleware \
+  my_cool_middleware: MyCoolMiddleware
+
+client = ReamazeAPI.new do |http|
+  http.response :my_cool_middleware
+  http.headers["User-Agent"] = "My Reamaze Client"
+end
+```
+
 [Faraday]: https://github.com/lostisland/faraday
 
 ## Development

data/lib/reamaze_api.rb

@@ -30,6 +30,8 @@ module ReamazeAPI
   #                 :brand - Brand name (subdomain from your Reamaze URL)
   #                 :login - Reamaze login
   #                 :token - Reamaze API token
+  # block         - Optional block that yields a Faraday::Connection instance
+  #                 (for customizing middleware, headers, etc)
   #
   # The credentials passed to the API can be configured globally via
   # `ReamazeAPI.config` or passed to this method. Credentials passed directly
@@ -38,7 +40,9 @@ module ReamazeAPI
   # Raises ArgumentError if a brand, login or token cannot be found.
   #
   # Returns a ReamazeAPI::Client instance.
-  def self.new(**credentials)
-    Client.new(**config.to_h.select { |_, value| value }.merge(credentials))
+  def self.new(**credentials, &block)
+    params = config.to_h.select { |_, value| value }.merge(credentials)
+
+    Client.new(**params, &block)
   end
 end

data/lib/reamaze_api/client.rb

@@ -27,12 +27,19 @@ module ReamazeAPI
     # Returns a String.
     API_URL = "https://%{brand}.reamaze.com/api/v1".freeze
 
+    # Public: HTTP adapter used for API requests.
+    #
+    # Returns a Faraday::Connection.
+    attr_reader :http
+
     # Public: Initialize a new Client instance.
     #
     # brand: Brand name (subdomain from your Reamaze URL)
     # login: Reamaze login
     # token: Reamaze API token
     #
+    # Yields a Faraday::Connection if a block is given.
+    #
     # Returns nothing.
     def initialize(brand:, login:, token:)
       @url = URI.parse(API_URL % { brand: brand })
@@ -42,6 +49,8 @@ module ReamazeAPI
         builder.response   :json
         builder.adapter    Faraday.default_adapter
         builder.basic_auth login, token
+
+        yield builder if block_given?
       end
     end
 

data/lib/reamaze_api/version.rb

@@ -1,3 +1,3 @@
 module ReamazeAPI
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: reamaze_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Joshua Priddle