plants 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8e9b712b2177d93408282db2d2b6efc283fb9fbfb84d17d6fc80efcc58a710b
-  data.tar.gz: e51872144774793b602adac46640d515ae2a353a07e89fa3beb70d33b50a4ffc
+  metadata.gz: 0aa2440db1c107756d88cca164f0dbdb0258dab428bb3c28ab282b09c0dfdbf7
+  data.tar.gz: ff4cd3faf204460a05376632b42e762518a7dbdd71d754f7d28f2207433385c1
 SHA512:
-  metadata.gz: 3df27aab14d6ed43639c9837cbaa53b4ccf18790929af2f5966d25608735535057f43969c5185d7e4c4b0d7e578acf815ce2b7e30c144f1193760bed8a15ca9f
-  data.tar.gz: c3094796cde53a394b4b819047e1d1d38c492efb2e20d0b5c736f7ee891a46ce5eca065f43b2a063237fb215fdbf0a8921de19421b68b5cd2ad349c06ea7d31a
+  metadata.gz: ba78c624f382d3d63ffba79e2d9774de426057dfcde4209d537915e2ba9a0a7ac1baee303b04fc9653a1e19ed7cff5e95f69874facde550c25bf740cca288dfb
+  data.tar.gz: 6b1a5de74246ace188e2c0156325f0aa4c19698c8e9e876083171a9b1bbec0322d54185dd239a6d4f4f82dd429164a49061ae251ab6413229931690165d0c6de

data/CHANGELOG.md

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

data/README.md

@@ -2,7 +2,7 @@
 Gem to interact with the [trefle](https://docs.trefle.io/reference) API.
 
 ## Install
-`spec.add_dependency 'plants', ~> 0`
+`spec.add_dependency 'plants', '~> 0'`
 
 ## Usage
 You need an authorization token, [see this](https://docs.trefle.io/docs/guides/getting-started).
@@ -11,7 +11,19 @@ Plants.token = 'your token here'
 Plants.list_plants # ... 
 ```
 
+If you wish to override the log:
+```ruby
+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/log.rb

@@ -48,6 +48,12 @@ module Plants
       def instance
         @_instance ||= new
       end
+
+      # @param other_logger [#debug, #info, #warn, #error, #fatal]
+      # @return [void]
+      def instance=(other_logger)
+        @_instance = other_logger
+      end
     end
   end
 end

data/lib/plants/version.rb

@@ -2,5 +2,5 @@
 
 module Plants
   # @return [String]
-  VERSION = "0.1.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.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Xero
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-02-28 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: []