allow user to override timeout

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
 

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

lib/plants.rb

@@ -17,6 +17,12 @@ def token=(new_value)
       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

lib/plants/client.rb

@@ -35,7 +35,7 @@ def get(resource, params: {})
     # @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

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

lib/plants/version.rb

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

spec/plants/client_spec.rb

@@ -28,6 +28,7 @@
 
       it do
         expect(config).to receive(:token).and_return(nil)
+        expect(config).to receive(:timeout).and_return(10)
         expect(subject).to be_instance_of(HTTP::Response)
         expect(a_request(:get, "#{Plants::Client::URL}/plants")).to have_been_made
       end

spec/plants/config_spec.rb

@@ -25,4 +25,21 @@
       expect(config.token).to eql('secret')
     end
   end
+
+  describe '#timeout' do
+    subject { config.timeout }
+
+    it do
+      expect(subject).to be_instance_of(Integer)
+    end
+  end
+
+  describe '#timeout=' do
+    subject { config.timeout = 5 }
+
+    it do
+      subject
+      expect(config.timeout).to eql(5)
+    end
+  end
 end

spec/plants_spec.rb

@@ -16,6 +16,17 @@
     end
   end
 
+  describe '.timeout=' do
+    after(:each) { Plants.timeout = 10 }
+
+    subject { Plants.timeout = 5 }
+
+    it do
+      subject
+      expect(Plants.config.timeout).to eql 5
+    end
+  end
+
   describe '.config' do
     subject { Plants.config }