Add User-Agent inside the pre-defined headers

This commit also exposes a way to add any other header to the request

lib/meilisearch/http_request.rb

@@ -79,6 +79,7 @@ def http_delete(relative_path = '')
     def build_default_options_headers
       header = {
         'Content-Type' => 'application/json',
+        'User-Agent' => [@options[:user_agent], MeiliSearch.qualified_version].compact.join(' ; '),
         'Authorization' => ("Bearer #{@api_key}" unless @api_key.nil?)
       }.compact
     end

lib/meilisearch/version.rb

@@ -2,4 +2,8 @@
 
 module MeiliSearch
   VERSION = '0.18.0'
+
+  def self.qualified_version
+    "MeiliSearch Ruby (v#{VERSION})"
+  end
 end

spec/meilisearch/index/base_spec.rb

@@ -103,6 +103,7 @@
     options = { timeout: 2, max_retries: 1 }
     expected_headers = {
       'Authorization' => "Bearer #{MASTER_KEY}",
+      'User-Agent' => MeiliSearch.qualified_version,
     }
 
     new_client = MeiliSearch::Client.new(URL, MASTER_KEY, options)

spec/meilisearch_spec.rb

@@ -5,6 +5,10 @@
     expect(MeiliSearch::VERSION).not_to be nil
   end
 
+  it 'has a qualified version number' do
+    expect(MeiliSearch.qualified_version).to eq("MeiliSearch Ruby (v#{MeiliSearch::VERSION})")
+  end
+
   it 'raises an exception when it is impossible to connect' do
     new_client = MeiliSearch::Client.new('http://127.0.0.1:8800', 'masterKey')
     expect do
@@ -24,4 +28,18 @@
       new_client.indexes
     end.to raise_error(Timeout::Error)
   end
+
+  it 'has a pre-defined header with current version' do
+    new_client = MeiliSearch::Client.new(URL, MASTER_KEY)
+
+    expect(new_client.headers).to have_key('User-Agent')
+    expect(new_client.headers['User-Agent']).to eq(MeiliSearch.qualified_version)
+  end
+
+  it 'has a way to add other headers along the pre-defined ones' do
+    new_client = MeiliSearch::Client.new(URL, MASTER_KEY, user_agent: 'custom client')
+
+    expect(new_client.headers['User-Agent']).to \
+      eq(['custom client', MeiliSearch.qualified_version].join(' ; '))
+  end
 end