plants 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f19367bf655abf1c1d915f59af1efe4422864a9b0501c436b00fe7e466d36294
-  data.tar.gz: bbd93479682c27feb7531aa83361eba060efb63f7e317930e5b30cb7fa9a55b9
+  metadata.gz: 0aa2440db1c107756d88cca164f0dbdb0258dab428bb3c28ab282b09c0dfdbf7
+  data.tar.gz: ff4cd3faf204460a05376632b42e762518a7dbdd71d754f7d28f2207433385c1
 SHA512:
-  metadata.gz: 56e75eca4db0d770db6399322ba73b9e551baae162f5d412b78a8fe0a3df218c295db02dcb51f5d4a05184cfa266b1f3115fce06368e64dafeba27fd83aabe8b
-  data.tar.gz: 3f6370875a99aff8ca0a47d16e0fca8633f5b0ccb7ea5c4c0dfdb166607ebad9f0fac1875a305a5d0d8971734d697774f6ff0dfa49d2414d922df13f2c4b1927
+  metadata.gz: ba78c624f382d3d63ffba79e2d9774de426057dfcde4209d537915e2ba9a0a7ac1baee303b04fc9653a1e19ed7cff5e95f69874facde550c25bf740cca288dfb
+  data.tar.gz: 6b1a5de74246ace188e2c0156325f0aa4c19698c8e9e876083171a9b1bbec0322d54185dd239a6d4f4f82dd429164a49061ae251ab6413229931690165d0c6de

data/CHANGELOG.md

@@ -1,5 +1,8 @@
 ## [Unreleased]
 
+## [0.3.0] - 2024-03-07
+- allow user to override http timeout
+
 ## [0.2.0] - 2024-02-29
 - allow user to override logger
 

data/README.md

@@ -19,6 +19,11 @@ Plants::Log.instance = logger # Your logger here
 ### Endpoints
 All methods return an instance of [`HTTP::Response`](https://github.com/httprb/http/wiki/Response-Handling)
 
+The HTTP timeout is by default 10 seconds, you can override this by:
+```ruby
+Plants.timeout = 5 # new value here
+```
+
 #### Corrections
 ```ruby
 # List

data/lib/plants/client.rb

@@ -35,7 +35,7 @@ module Plants
     # @return [::HTTP::Client]
     def http
       HTTP
-        .timeout(10)
+        .timeout(config.timeout)
         .use(logging: { logger: Log.instance })
         .headers({ 'User-Agent' => "Plants #{Plants::VERSION} ruby-#{RUBY_VERSION}" })
     end

data/lib/plants/config.rb

@@ -3,11 +3,14 @@ module Plants
   #
   # @!attribute token
   #   @return [String]
+  # @!attribute timeout
+  #   @return [Integer]
   #
   class Config
     def initialize
       @token = nil
+      @timeout = 10
     end
-    attr_accessor :token
+    attr_accessor :token, :timeout
   end
 end

data/lib/plants/version.rb

@@ -2,5 +2,5 @@
 
 module Plants
   # @return [String]
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/plants.rb

@@ -17,6 +17,12 @@ module Plants
       client.config.token = new_value
     end
 
+    # @param new_value [Integer]
+    # @return [void]
+    def timeout=(new_value)
+      client.config.timeout = new_value
+    end
+
     # @return [Plants::Config]
     def config
       client.config

data/plants.gemspec

@@ -8,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.authors = ["Xero"]
   spec.email = ["vhector.1337@gmail.com"]
 
-  spec.summary = "Plants API gem."
+  spec.summary = "Trefle API gem."
   spec.description = "Gem to interact with Trefle API."
   spec.homepage = "https://github.com/one-m1nd/plants"
   spec.required_ruby_version = ">= 3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plants
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Xero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-29 00:00:00.000000000 Z
+date: 2024-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -81,5 +81,5 @@ requirements: []
 rubygems_version: 3.4.10
 signing_key: 
 specification_version: 4
-summary: Plants API gem.
+summary: Trefle API gem.
 test_files: []