Use HEAD instead of GET to ping Colore (#26)

Reduces the amount of data received and the stress on the server
ifad · Jan 20, 2025 · f8492e3 · f8492e3
1 parent c50d2d6
commit f8492e3
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 51 deletions.
diff --git a/lib/colore/client.rb b/lib/colore/client.rb
@@ -65,7 +65,7 @@ def generate_doc_id
     # Tests the connection with Colore. Will raise an error if the connection cannot be
     # established.
     def ping
-      send_request :get, '/'
+      send_request :head, '/'
       true
     end
 

diff --git a/spec/fixtures/cassettes/Colore_Client/_ping/runs.yml b/spec/fixtures/cassettes/Colore_Client/_ping/runs.yml
diff --git a/spec/lib/colore/client_spec.rb b/spec/lib/colore/client_spec.rb
@@ -29,7 +29,7 @@
     end
 
     it 'raises ColoreUnavailable on ECONNREFUSED' do
-      allow(client.send(:connection)).to receive(:get) { raise Faraday::ConnectionFailed }
+      allow(client.send(:connection)).to receive(:head) { raise Faraday::ConnectionFailed }
       expect { client.ping }.to raise_error(Colore::Errors::ColoreUnavailable)
     end
   end