flexirest 1.2.6 → 1.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e9746fdcafdd6c3cf776ad61e5c1382d45d2a0f
-  data.tar.gz: 8dc300d322046a6cde7c8cd94ebdc9d4e5beca6d
+  metadata.gz: 71f15a9ae128d914e4299af6b2df98729145280b
+  data.tar.gz: 374b73a1124535bb95a8a4abebb90a08cd402cb0
 SHA512:
-  metadata.gz: 8a78959e3b2b15fcbb34e00a967187ecf2857796201f56d3279f18d28596539c0e51225712ba9f8c33c005600aaa8c0845693d9e2361aacf5af394a941288a70
-  data.tar.gz: e3e739a54e53b54218f6224ba8b52ef0261ea6f853b2ec819352fd2f60db86ea861a6b4513038b2ba3efcea33a891334602e717f622a0f8e7487ec771e812e31
+  metadata.gz: 98ef9ff1466118b4d1fb39c6b1539ea04c7eb0823cda405850faaa1b13b75c8c5ce424fab97f50429a8a4caa43680d36de8dc2843f31fbf9f4f3356e1ee6855e
+  data.tar.gz: 780454d7b0f960d595b0e921acf8e3a3fcd7dd962f3deeee348706508c0f43a37115c0129d834faaa983891046f2580bf54d1885ee8bdcc3222c73ff89f4f10e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## 1.2.7
+
+Features:
+
+- Adds a per request `timeout` option, for individually slow calls
+
 ## 1.2.5/1.2.6
 
 Bugfixes:

data/README.md

@@ -548,6 +548,16 @@ class Person < Flexirest::Base
 end
 ```
 
+### Per-request Timeouts
+
+There are times when an API is generally quick, but one call is very intensive.  You don't want to set a global timeout in the Faraday configuration block, you just want to increase the timeout for this single call. To do this, you can simply pass a `timeout` option when mapping the call containing the response (in seconds).
+
+```ruby
+class Person < Flexirest::Base
+  get :all, '/people', timeout: 5
+end
+```
+
 ### Raw Requests
 
 Sometimes you have have a URL that you just want to force through, but have the response handled in the same way as normal objects or you want to have the filters run (say for authentication).  The easiest way to do that is to call `_request` on the class:

data/lib/flexirest/connection.rb

@@ -38,6 +38,7 @@ module Flexirest
       set_defaults(options)
       make_safe_request(path) do
         @session.get(path) do |req|
+          set_per_request_timeout(req, options) if options[:timeout]
           req.headers = req.headers.merge(options[:headers])
           sign_request(req, options[:api_auth])
         end
@@ -48,6 +49,7 @@ module Flexirest
       set_defaults(options)
       make_safe_request(path) do
         @session.put(path) do |req|
+          set_per_request_timeout(req, options) if options[:timeout]
           req.headers = req.headers.merge(options[:headers])
           req.body = data
           sign_request(req, options[:api_auth])
@@ -59,6 +61,7 @@ module Flexirest
       set_defaults(options)
       make_safe_request(path) do
         @session.post(path) do |req|
+          set_per_request_timeout(req, options) if options[:timeout]
           req.headers = req.headers.merge(options[:headers])
           req.body = data
           sign_request(req, options[:api_auth])
@@ -70,6 +73,7 @@ module Flexirest
       set_defaults(options)
       make_safe_request(path) do
         @session.delete(path) do |req|
+          set_per_request_timeout(req, options) if options[:timeout]
           req.headers = req.headers.merge(options[:headers])
           sign_request(req, options[:api_auth])
         end
@@ -78,6 +82,11 @@ module Flexirest
 
     private
 
+    def set_per_request_timeout(req, options)
+      req.options.timeout = options[:timeout].to_i
+      req.options.open_timeout = options[:timeout].to_i
+    end
+
     def new_session
       Faraday.new({url: @base_url}, &Flexirest::Base.faraday_config)
     end

data/lib/flexirest/version.rb

@@ -1,3 +1,3 @@
 module Flexirest
-  VERSION = "1.2.6"
+  VERSION = "1.2.7"
 end

data/spec/lib/connection_spec.rb

@@ -98,6 +98,15 @@ describe Flexirest::Connection do
     end
   end
 
+  context 'with custom timeouts' do
+    it 'should set a custom timeout' do
+      stub_request(:get, "www.example.com/foo")
+        .to_return(body: "{result:true}")
+      expect_any_instance_of(Flexirest::Connection).to receive(:set_per_request_timeout)
+      @connection.get("/foo", {:timeout => "5"})
+    end
+  end
+
   context 'with api auth signing requests' do
     before(:each) do
       # Need to still call this to load the api_auth library so tests work

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: flexirest
 version: !ruby/object:Gem::Version
-  version: 1.2.6
+  version: 1.2.7
 platform: ruby
 authors:
 - Andy Jeffries
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-03 00:00:00.000000000 Z
+date: 2015-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler