feat: make user-agent headers more descriptive (#168)

rarruda · web-flow · commit 4fe999649b59 · 2024-03-13T09:42:34.000+01:00
diff --git a/lib/unleash/configuration.rb b/lib/unleash/configuration.rb
@@ -51,6 +51,7 @@ def refresh_backup_file!
 
     def http_headers
       {
+        'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
         'UNLEASH-INSTANCEID' => self.instance_id,
         'UNLEASH-APPNAME' => self.app_name,
         'Unleash-Client-Spec' => '5.0.2'
diff --git a/spec/unleash/client_spec.rb b/spec/unleash/client_spec.rb
@@ -11,7 +11,7 @@
           'Accept' => '*/*',
           'Content-Type' => 'application/json',
           'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -22,7 +22,7 @@
           'Accept' => '*/*',
           'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
           'Content-Type' => 'application/json',
-          'User-Agent' => 'Ruby'
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]"
         }
       )
       .to_return(status: 200, body: "", headers: {})
@@ -46,7 +46,7 @@
           'Content-Type' => 'application/json',
           'Unleash-Appname' => 'my-test-app',
           'Unleash-Instanceid' => 'rspec/test',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -117,7 +117,7 @@
           'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
           'Unleash-Appname' => 'my-test-app',
           'Unleash-Instanceid' => 'rspec/test',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -158,7 +158,7 @@
           'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
           'Unleash-Appname' => 'my-test-app',
           'Unleash-Instanceid' => 'rspec/test',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -256,7 +256,7 @@
           'Accept' => '*/*',
           'Content-Type' => 'application/json',
           'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -270,7 +270,7 @@
           'Content-Type' => 'application/json',
           'Unleash-Appname' => 'my-test-app',
           'Unleash-Instanceid' => 'rspec/test',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -304,7 +304,7 @@
           'Accept' => '*/*',
           'Content-Type' => 'application/json',
           'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -328,7 +328,7 @@
           'Content-Type' => 'application/json',
           'Unleash-Appname' => 'my-test-app',
           'Unleash-Instanceid' => 'rspec/test',
-          'User-Agent' => 'Ruby',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
           'X-Api-Key' => '123'
         }
       )
@@ -606,7 +606,7 @@
             'Content-Type' => 'application/json',
             'Unleash-Appname' => 'my-test-app',
             'Unleash-Instanceid' => 'rspec/test',
-            'User-Agent' => 'Ruby',
+            'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
             'X-Api-Key' => '123'
           }
         )
@@ -620,7 +620,7 @@
             'Content-Type' => 'application/json',
             'Unleash-Appname' => 'my-test-app',
             'Unleash-Instanceid' => 'rspec/test',
-            'User-Agent' => 'Ruby',
+            'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",
             'X-Api-Key' => '123'
           }
         )
diff --git a/spec/unleash/configuration_spec.rb b/spec/unleash/configuration_spec.rb
@@ -146,7 +146,8 @@
           'X-API-KEY' => '123',
           'UNLEASH-APPNAME' => 'test-app',
           'UNLEASH-INSTANCEID' => config.instance_id,
-          'Unleash-Client-Spec' => '5.0.2'
+          'Unleash-Client-Spec' => '5.0.2',
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]"
         }
       )
       expect(custom_headers_proc).to have_received(:call).exactly(1).times
diff --git a/spec/unleash/metrics_reporter_spec.rb b/spec/unleash/metrics_reporter_spec.rb
@@ -69,7 +69,7 @@
           'Content-Type' => 'application/json',
           'Unleash-Appname' => 'my-test-app',
           'Unleash-Instanceid' => 'rspec/test',
-          'User-Agent' => 'Ruby'
+          'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]"
         }
       )
       .to_return(status: 200, body: "", headers: {})

Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@ def refresh_backup_file!`
`51`	`51`
`52`	`52`	`def http_headers`
`53`	`53`	`{`
	`54`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`54`	`55`	`'UNLEASH-INSTANCEID' => self.instance_id,`
`55`	`56`	`'UNLEASH-APPNAME' => self.app_name,`
`56`	`57`	`'Unleash-Client-Spec' => '5.0.2'`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@`
`11`	`11`	`'Accept' => '/',`
`12`	`12`	`'Content-Type' => 'application/json',`
`13`	`13`	`'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',`
`14`		`- 'User-Agent' => 'Ruby',`
	`14`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`15`	`15`	`'X-Api-Key' => '123'`
`16`	`16`	`}`
`17`	`17`	`)`
`@@ -22,7 +22,7 @@`
`22`	`22`	`'Accept' => '/',`
`23`	`23`	`'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',`
`24`	`24`	`'Content-Type' => 'application/json',`
`25`		`- 'User-Agent' => 'Ruby'`
	`25`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]"`
`26`	`26`	`}`
`27`	`27`	`)`
`28`	`28`	`.to_return(status: 200, body: "", headers: {})`
`@@ -46,7 +46,7 @@`
`46`	`46`	`'Content-Type' => 'application/json',`
`47`	`47`	`'Unleash-Appname' => 'my-test-app',`
`48`	`48`	`'Unleash-Instanceid' => 'rspec/test',`
`49`		`- 'User-Agent' => 'Ruby',`
	`49`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`50`	`50`	`'X-Api-Key' => '123'`
`51`	`51`	`}`
`52`	`52`	`)`
`@@ -117,7 +117,7 @@`
`117`	`117`	`'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',`
`118`	`118`	`'Unleash-Appname' => 'my-test-app',`
`119`	`119`	`'Unleash-Instanceid' => 'rspec/test',`
`120`		`- 'User-Agent' => 'Ruby',`
	`120`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`121`	`121`	`'X-Api-Key' => '123'`
`122`	`122`	`}`
`123`	`123`	`)`
`@@ -158,7 +158,7 @@`
`158`	`158`	`'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',`
`159`	`159`	`'Unleash-Appname' => 'my-test-app',`
`160`	`160`	`'Unleash-Instanceid' => 'rspec/test',`
`161`		`- 'User-Agent' => 'Ruby',`
	`161`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`162`	`162`	`'X-Api-Key' => '123'`
`163`	`163`	`}`
`164`	`164`	`)`
`@@ -256,7 +256,7 @@`
`256`	`256`	`'Accept' => '/',`
`257`	`257`	`'Content-Type' => 'application/json',`
`258`	`258`	`'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',`
`259`		`- 'User-Agent' => 'Ruby',`
	`259`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`260`	`260`	`'X-Api-Key' => '123'`
`261`	`261`	`}`
`262`	`262`	`)`
`@@ -270,7 +270,7 @@`
`270`	`270`	`'Content-Type' => 'application/json',`
`271`	`271`	`'Unleash-Appname' => 'my-test-app',`
`272`	`272`	`'Unleash-Instanceid' => 'rspec/test',`
`273`		`- 'User-Agent' => 'Ruby',`
	`273`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`274`	`274`	`'X-Api-Key' => '123'`
`275`	`275`	`}`
`276`	`276`	`)`
`@@ -304,7 +304,7 @@`
`304`	`304`	`'Accept' => '/',`
`305`	`305`	`'Content-Type' => 'application/json',`
`306`	`306`	`'Accept-Encoding' => 'gzip;q=1.0,deflate;q=0.6,identity;q=0.3',`
`307`		`- 'User-Agent' => 'Ruby',`
	`307`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`308`	`308`	`'X-Api-Key' => '123'`
`309`	`309`	`}`
`310`	`310`	`)`
`@@ -328,7 +328,7 @@`
`328`	`328`	`'Content-Type' => 'application/json',`
`329`	`329`	`'Unleash-Appname' => 'my-test-app',`
`330`	`330`	`'Unleash-Instanceid' => 'rspec/test',`
`331`		`- 'User-Agent' => 'Ruby',`
	`331`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`332`	`332`	`'X-Api-Key' => '123'`
`333`	`333`	`}`
`334`	`334`	`)`
`@@ -606,7 +606,7 @@`
`606`	`606`	`'Content-Type' => 'application/json',`
`607`	`607`	`'Unleash-Appname' => 'my-test-app',`
`608`	`608`	`'Unleash-Instanceid' => 'rspec/test',`
`609`		`- 'User-Agent' => 'Ruby',`
	`609`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`610`	`610`	`'X-Api-Key' => '123'`
`611`	`611`	`}`
`612`	`612`	`)`
`@@ -620,7 +620,7 @@`
`620`	`620`	`'Content-Type' => 'application/json',`
`621`	`621`	`'Unleash-Appname' => 'my-test-app',`
`622`	`622`	`'Unleash-Instanceid' => 'rspec/test',`
`623`		`- 'User-Agent' => 'Ruby',`
	`623`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]",`
`624`	`624`	`'X-Api-Key' => '123'`
`625`	`625`	`}`
`626`	`626`	`)`
Original file line number	Diff line number	Diff line change
`@@ -146,7 +146,8 @@`
`146`	`146`	`'X-API-KEY' => '123',`
`147`	`147`	`'UNLEASH-APPNAME' => 'test-app',`
`148`	`148`	`'UNLEASH-INSTANCEID' => config.instance_id,`
`149`		`- 'Unleash-Client-Spec' => '5.0.2'`
	`149`	`+ 'Unleash-Client-Spec' => '5.0.2',`
	`150`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]"`
`150`	`151`	`}`
`151`	`152`	`)`
`152`	`153`	`expect(custom_headers_proc).to have_received(:call).exactly(1).times`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@`
`69`	`69`	`'Content-Type' => 'application/json',`
`70`	`70`	`'Unleash-Appname' => 'my-test-app',`
`71`	`71`	`'Unleash-Instanceid' => 'rspec/test',`
`72`		`- 'User-Agent' => 'Ruby'`
	`72`	`+ 'User-Agent' => "UnleashClientRuby/#{Unleash::VERSION} #{RUBY_ENGINE}/#{RUBY_VERSION} [#{RUBY_PLATFORM}]"`
`73`	`73`	`}`
`74`	`74`	`)`
`75`	`75`	`.to_return(status: 200, body: "", headers: {})`