dogapi 1.40.0 → 1.41.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03dcbb8f50795fb901c13effb712107ac78beb545d55bebccb9f2cfc83c92908
-  data.tar.gz: d6cbb3c3dd0807d8d684879fa3efb44e8a54acd7c07298261ebc11b5b9a099e4
+  metadata.gz: bedd02d8446f4dfce31b9a2b375da5376860490ea6122e3829db203c51f2120b
+  data.tar.gz: 8378113bb0b466b3cf6b9e05622c1386691492e474d8c64f5fe8c742b60b32ba
 SHA512:
-  metadata.gz: 4b969abe11bd88812b9eb70066fb1d1fb2ff5df49a5a95de7c92893357dde80af0e5636500b1a7ed9703ce525a96d10662ff4900d09fd2676db263be17dfcaaf
-  data.tar.gz: 3b63c822096ba541151e837c16d47c0aa298baff22257be5b098e13041bba0dd00bba328d479240d17b2c58c9a1c9cacfdbf33a9416752b5a61a4dd65a999457
+  metadata.gz: 84dd004b3f9cc6e55f4523339690ee1e8688e45d53febeb10d472cbf510b5a42caf9caeb0a9f0e86721887aba0fa48adc694a7b67aa21da4984d3752001a1d81
+  data.tar.gz: eb764eb19d7b150798e758487bf1457fc7d245cbbc9315d99b7616ea3eddf4d79d061e30cf423924aa6930cae9be98eb7ff88339ee11a3cb959f9c78f8dd6eec

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changes
 
+## 1.41.0 / 2020-07-27
+
+* [Added] Improve user-agent header to include telemetry information. See [#235](https://github.com/DataDog/dogapi-rb/pull/235).
+* [Added] Move setting hostname to end of method body in order to actually return it. See [#233](https://github.com/DataDog/dogapi-rb/pull/233).
+
 ## 1.40.0 / 2020-04-06
 
 * [Added] Re-add service level objectives support. See [#224](https://github.com/DataDog/dogapi-rb/pull/224).

data/lib/dogapi/common.rb

@@ -4,6 +4,7 @@
 
 require 'cgi'
 require 'net/https'
+require 'rbconfig'
 require 'socket'
 require 'uri'
 require 'English'
@@ -13,7 +14,16 @@ require 'multi_json'
 require 'set'
 require 'open3'
 
+require 'dogapi/version'
+
 module Dogapi
+  USER_AGENT = format(
+    'dogapi-rb/%<version>s (ruby %<ruver>s; os %<os>s; arch %<arch>s)',
+    version: VERSION,
+    ruver: RUBY_VERSION,
+    os: RbConfig::CONFIG['host_os'].downcase,
+    arch: RbConfig::CONFIG['host_cpu']
+  )
 
   # Metadata class to hold the scope of an API call
   class Scope
@@ -138,11 +148,11 @@ module Dogapi
     def prepare_request(method, url, params, body, send_json, with_app_key)
       url_with_params = url + params
       req = method.new(url_with_params)
+      req['User-Agent'] = USER_AGENT
       unless should_set_api_and_app_keys_in_params?(url)
         req['DD-API-KEY'] = @api_key
         req['DD-APPLICATION-KEY'] = @application_key if with_app_key
       end
-
       if send_json
         req.content_type = 'application/json'
         req.body = MultiJson.dump(body)
@@ -202,9 +212,9 @@ module Dogapi
   def Dogapi.find_localhost
     unless @@hostname
       out, status = Open3.capture2('hostname', '-f', err: File::NULL)
-      @@hostname = out.strip
       # Get status to check if the call was successful
       raise SystemCallError, 'Could not get hostname with `hostname -f`' unless status.exitstatus.zero?
+      @@hostname = out.strip
     end
   rescue SystemCallError
     @@hostname = Addrinfo.getaddrinfo(Socket.gethostname, nil, nil, nil, nil, Socket::AI_CANONNAME).first.canonname

data/lib/dogapi/version.rb

@@ -3,5 +3,5 @@
 # Copyright 2011-Present Datadog, Inc.
 
 module Dogapi
-  VERSION = '1.40.0'
+  VERSION = '1.41.0'
 end

data/spec/unit/common_spec.rb

@@ -134,6 +134,15 @@ describe 'Common' do
         expect(req['DD-APPLICATION-KEY']).to eq service.application_key
       end
     end
+
+    it 'properly sets User-Agent header' do
+      service = Dogapi::APIService.new('api_key', 'app_key', true, nil, 'https://app.example.com')
+      params = service.prepare_params(nil, '/api/v1/validate', true)
+      req = service.prepare_request(Net::HTTP::Get, '/api/v1/validate', params, nil, false, true)
+
+      expect(req.key?('User-Agent')).to be true
+      expect(req['User-Agent']).to match(%r{dogapi-rb\/[^\s]+ \(ruby [^\s]+; os [^\s]+; arch [^\s]+\)})
+    end
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.40.0
+  version: 1.41.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Datadog's API