kobana 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c043850d8aa7c1f2df33d4956d25b6606c7318ec32350589ddd2da9fe75ea28
-  data.tar.gz: 81f645783198fa6a2e48f5fd660200c90c8c85cfe8439a4ec4de29a4fe299b0b
+  metadata.gz: fb9688ae8ad7106ca655b5db3b61f0a901c740ed818a60339c9f506833cbae32
+  data.tar.gz: 4d9d89c6a37ef389ea0c30ff33d8e6e29cf29e94c1e7cb6760a73b3a99750e5f
 SHA512:
-  metadata.gz: d165e5d9808c537d5966edaed2734c11b7f1679fd8d98baa37b82870a2f9a2bd9bc104af292af11caabeffd1a7ab28f9e66400d675934646a017cde0a4e3d0e3
-  data.tar.gz: 25e70219061793ec35b1747d193cbee5b524a9abb82a7fc102071b423391a9c18257453fc19c309ef45c76b94363767e1436150d2382598df3b761f866b1c97b
+  metadata.gz: 5d3246c4cbb7357282c1bef55d9dbb0dbd00e092e96e1c4c95acc354183589eedbd47baa9c27cae48732f29e8b7e2b20579bb31577cc5fa5237c48a79ee2b17a
+  data.tar.gz: 9e4cf09cc138db4cee8cfd52fcb1312043c9833d38e2676eb8e808a39b183722e1bd2c5f63cfa594881be428f4a95d515f10f67aa893b9be0e36e284dc2a0c7c

data/CHANGELOG.md

@@ -1,5 +1,6 @@
 ## [Unreleased]
 
+- Add configurable HTTP timeouts (`config.open_timeout` / `config.timeout`, in seconds, passed to Faraday). Default `nil` (no timeout) keeps existing behavior; set them to fail fast instead of blocking when the API is slow.
 - Add debug option
 
 ## [0.1.0] - 2023-10-27

data/README.md

@@ -88,6 +88,24 @@ client.configure do |config|
 end
 ```
 
+#### HTTP timeouts
+
+By default the client has **no** HTTP timeout, so a slow or hanging API call
+blocks the caller until the underlying socket gives up. Set `open_timeout`
+(connection establishment) and/or `timeout` (response read), in seconds, to fail
+fast instead — both are passed straight to Faraday:
+
+```ruby
+Kobana.configure do |config|
+  config.api_token = 'YOUR_API_TOKEN'
+  config.open_timeout = 2 # seconds to establish the TCP connection
+  config.timeout = 8      # seconds to read the response
+end
+```
+
+When unset (`nil`), behavior is unchanged. Tune `timeout` above the longest
+expected operation (e.g. large multipart uploads / batch exports).
+
 ### Usage
 
 The gem supports both global configuration (backward compatible) and multi-client usage patterns.

data/lib/kobana/configuration.rb

@@ -2,11 +2,18 @@
 
 module Kobana
   class Configuration
-    attr_accessor :api_token, :environment, :custom_headers, :debug
+    # `open_timeout` and `timeout` are passed straight to Faraday (in seconds).
+    # Both default to nil (no timeout) to preserve historical behavior; set them
+    # to fail fast instead of blocking the caller when the API is slow/hanging.
+    attr_accessor :api_token, :environment, :custom_headers, :debug, :api_version,
+                  :open_timeout, :timeout
 
     def initialize
       @custom_headers = {}
       @environment = :sandbox
+      # nil means "no global override" — each resource uses its own declared
+      # api_version (see Resources::Base). Set this to force a version globally.
+      @api_version = nil
     end
 
     def inspect

data/lib/kobana/resources/base.rb

@@ -23,9 +23,11 @@ module Kobana
 
         def inherited(subclass)
           super
+          # Set defaults only if not already set by parent classes
           subclass.resource_endpoint ||= infer_resource_endpoint(subclass)
           subclass.primary_key ||= :uid
-          subclass.api_version ||= :v2
+          # Don't override api_version if it's already been set
+          subclass.api_version = :v2 unless subclass.instance_variable_defined?(:@api_version)
           subclass.errors ||= []
           subclass.default_attributes ||= {}
         end

data/lib/kobana/resources/connection.rb

@@ -45,10 +45,18 @@ module Kobana
             faraday.request :json
             faraday.adapter Faraday.default_adapter
             faraday.headers = headers
+            apply_timeouts(faraday, config)
             faraday.response :logger, logger if config.debug
           end
         end
 
+        # Applies Faraday connect/read timeouts from the configuration when set.
+        # No-op when unset, so the default behavior (no timeout) is preserved.
+        def apply_timeouts(faraday, config)
+          faraday.options.open_timeout = config.open_timeout if config.open_timeout
+          faraday.options.timeout = config.timeout if config.timeout
+        end
+
         public
 
         def multipart_connection
@@ -67,6 +75,7 @@ module Kobana
             faraday.headers = headers.merge(
               "Content-Type" => "multipart/form-data"
             )
+            apply_timeouts(faraday, config)
             faraday.response :logger, logger if config.debug
           end
         end
@@ -106,7 +115,9 @@ module Kobana
 
         def base_url
           config = client&.configuration || Kobana.configuration
-          BASE_URI[api_version&.to_sym][config.environment&.to_sym]
+          # Prioritize client configuration api_version over class api_version
+          version = config.api_version&.to_sym || api_version&.to_sym
+          BASE_URI[version][config.environment&.to_sym]
         end
       end
     end

data/lib/kobana/resources/operations.rb

@@ -68,7 +68,7 @@ module Kobana
           return unless response[:data].is_a?(Hash)
 
           @errors = response[:data][:errors] if response[:data].key?(:errors)
-          @errors = [title: response[:data][:error]] if response[:data].key?(:error)
+          @errors = [{ title: response[:data][:error] }] if response[:data].key?(:error)
         end
       end
 

data/lib/kobana/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kobana
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: kobana
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Kivanio Barbosa
@@ -104,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.2.6
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 4.0.13
 specification_version: 4
 summary: Kobana API Client
 test_files: []