dogapi 1.30 → 1.31.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebee611bd7522efe9456a959522706572585e27cd7a7c702749584318bfc291b
-  data.tar.gz: 8d3fedc656c9443618b164fdcb0a9dd601f88dee81d000fc210f7338aacb3a34
+  metadata.gz: e9f77255b968b9091ed12bc8f849c06176ed6ff0b53a78b061c76432af14ad5f
+  data.tar.gz: d49bb8d4241f7b1232d13887908ddc211782931258bddaa4648d9ab2eafa1615
 SHA512:
-  metadata.gz: c4be6b9543da77c590ba0e155f2b92bb9c52befa16825d835d81721a3792cc7fd58e4a1a888a46a0856d7f099c124fd49eafa2674133660b3bda2ce0e6ab5bbf
-  data.tar.gz: 32e79e62b507f2c2d514bcd28449f1eb5d1c4856c8a8ebcb6b7a2204299f552b4e83fe0ff0b90be30fd21882ffdebed775a4806015681986d52866b0dd45038e
+  metadata.gz: 9e66a2caae73756e7882ed5b7bc7aa4830d3045c14bf2bb272f3c77e8cef6c3a7879e0daf725c52b2d6279f993d4ae8deb994f67e6ee39484a9cae281490d8bc
+  data.tar.gz: 63ea3b3ba9e1fd0d8d53ef9e714b96afc907977f2d98fc3044fd03aa25ff3346a3859557f1b8544a456e767a5d3fdf47611449230bc0434d47620c5df5106fe2

data/.rubocop_todo.yml

@@ -1,18 +1,11 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2018-03-23 17:40:12 -0400 using RuboCop version 0.49.1.
+# on 2018-10-01 12:52:09 +0200 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 3
-# Configuration parameters: Include.
-# Include: **/Gemfile, **/gems.rb
-Bundler/DuplicatedGem:
-  Exclude:
-    - 'Gemfile'
-
 # Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: Include, TreatCommentsAsGroupSeparators.
@@ -58,7 +51,7 @@ Layout/EmptyLines:
     - 'lib/capistrano/datadog/v2.rb'
     - 'lib/dogapi/facade.rb'
 
-# Offense count: 60
+# Offense count: 63
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
 # SupportedStyles: empty_lines, empty_lines_except_namespace, empty_lines_special, no_empty_lines
@@ -210,21 +203,21 @@ Lint/UselessAssignment:
 
 # Offense count: 11
 Metrics/AbcSize:
-  Max: 50
+  Max: 51
 
-# Offense count: 15
+# Offense count: 18
 # Configuration parameters: CountComments, ExcludedMethods.
 Metrics/BlockLength:
   Max: 96
 
-# Offense count: 1
+# Offense count: 2
 Metrics/CyclomaticComplexity:
-  Max: 7
+  Max: 8
 
 # Offense count: 15
 # Configuration parameters: CountComments.
 Metrics/MethodLength:
-  Max: 33
+  Max: 34
 
 # Offense count: 2
 # Configuration parameters: CountKeywordArgs.
@@ -233,7 +226,7 @@ Metrics/ParameterLists:
 
 # Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 8
+  Max: 9
 
 # Offense count: 11
 Style/AccessorMethodName:
@@ -316,7 +309,7 @@ Style/ConditionalAssignment:
   Exclude:
     - 'lib/capistrano/datadog.rb'
 
-# Offense count: 19
+# Offense count: 20
 # Cop supports --auto-correct.
 Style/DefWithParentheses:
   Exclude:
@@ -380,12 +373,11 @@ Style/HashSyntax:
     - 'lib/dogapi/v1/snapshot.rb'
     - 'lib/dogapi/v1/tag.rb'
 
-# Offense count: 16
+# Offense count: 15
 # Cop supports --auto-correct.
 # Configuration parameters: MaxLineLength.
 Style/IfUnlessModifier:
   Exclude:
-    - 'Gemfile'
     - 'lib/capistrano/datadog.rb'
     - 'lib/capistrano/datadog/v2.rb'
     - 'lib/capistrano/datadog/v3.rb'
@@ -401,7 +393,7 @@ Style/LineEndConcatenation:
   Exclude:
     - 'dogapi.gemspec'
 
-# Offense count: 14
+# Offense count: 15
 # Cop supports --auto-correct.
 Style/MethodCallWithoutArgsParentheses:
   Exclude:
@@ -410,13 +402,13 @@ Style/MethodCallWithoutArgsParentheses:
     - 'lib/dogapi/facade.rb'
     - 'lib/dogapi/v1/event.rb'
 
-# Offense count: 5
+# Offense count: 4
 # Cop supports --auto-correct.
 Style/MultilineIfThen:
   Exclude:
     - 'lib/capistrano/datadog.rb'
 
-# Offense count: 20
+# Offense count: 21
 # Cop supports --auto-correct.
 Style/MutableConstant:
   Enabled: false
@@ -478,6 +470,12 @@ Style/RedundantSelf:
     - 'lib/dogapi/facade.rb'
     - 'lib/dogapi/v1/metric.rb'
 
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RescueModifier:
+  Exclude:
+    - 'lib/capistrano/datadog.rb'
+
 # Offense count: 2
 # Cop supports --auto-correct.
 Style/SelfAssignment:
@@ -493,7 +491,7 @@ Style/SpecialGlobalVars:
   Exclude:
     - 'dogapi.gemspec'
 
-# Offense count: 23
+# Offense count: 22
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -520,13 +518,12 @@ Style/TrailingCommaInLiteral:
     - 'lib/dogapi/v1/snapshot.rb'
     - 'lib/dogapi/v1/user.rb'
 
-# Offense count: 3
+# Offense count: 2
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles, MinSize, WordRegex.
 # SupportedStyles: percent, brackets
 Style/WordArray:
   Exclude:
-    - 'Rakefile'
     - 'examples/custom_event.rb'
 
 # Offense count: 1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changes
 
+## 1.31.0 / 2018-10-01
+
+* [FIX] Handle nil values from benchmarks in Capistrano. See [#159][].
+* [IMPROVEMENT] Add getter/setter for datadog_host. See [#160][].
+
 ## 1.30 / 2018-06-05
 
 * [FIX] Change API endpoint. See [#147][].
@@ -204,6 +209,8 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#147]: https://github.com/DataDog/dogapi-rb/issues/147
 [#151]: https://github.com/DataDog/dogapi-rb/issues/151
 [#152]: https://github.com/DataDog/dogapi-rb/issues/152
+[#159]: https://github.com/DataDog/dogapi-rb/issues/159
+[#160]: https://github.com/DataDog/dogapi-rb/issues/160
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@acroos]: https://github.com/acroos

data/README.rdoc

@@ -49,6 +49,34 @@ to take advantage of automatic tagging with the host's tags.
 If you want to attach events and points to a specific device
 on a host, simply specify the device when calling emit functions.
 
+== Configure the Datadog API Url
+
+
+    require 'rubygems'
+    require 'dogapi'
+
+    api_key = "abcdef123456"
+    application_key = "fedcba654321"
+
+    # by default the API Url will be set to https://api.datadoghq.com
+    dog = Dogapi::Client.new(api_key, application_key)
+    p dog.datadog_host  # prints https://api.datadoghq.com
+
+    # API Url can be passed to the initializer...
+    dog = Dogapi::Client.new(api_key, application_key, nil, nil, nil, nil, 'https://myproxy.local')
+    p dog.datadog_host  # prints https://myproxy.local
+
+    # ...or set on the client instance directly
+    dog = Dogapi::Client.new(api_key, application_key)
+    dog.datadog_host = 'https://myproxy.local'
+    p dog.datadog_host  # prints https://myproxy.local
+
+    # in any case, contents of the DATADOG_HOST env var take precedence
+    ENV['DATADOG_HOST'] = https://myproxy.local
+    dog = Dogapi::Client.new(api_key, application_key)
+    p dog.datadog_host  # prints https://myproxy.local
+
+
 == Submit an event to Datadog
 
 

data/Rakefile

@@ -24,3 +24,7 @@ end
 task :rubocop do
   sh "rubocop"
 end
+
+task :rubocop_todo do
+  sh "rubocop --auto-gen-config"
+end

data/examples/custom_event.rb

@@ -25,13 +25,3 @@ dog.emit_event(Dogapi::Event.new("Now that's better",
                                  :alert_type      => "success",
                                  :tags            => ["ruby", "dogapi"]
                                  ))
-
-# You should see something like this in your stream:
-# screenshot: https://img.skitch.com/20120705-3s4icgxfc689x1jtrx1yr1m5k.png
-
-# And if you graph a metric and want to overlay these events on the graphs
-# You can use the following query: "tags:dogapi tags:ruby" in the graph editor
-# screenshot: https://img.skitch.com/20120705-m4h6f4377cbm2d3rctnd6biej9.png
-
-# Then you can see the events neatly overlaid on your graph
-# screenshot: https://img.skitch.com/20120705-xybhimti31u4s4m42ac854568h.png

data/lib/capistrano/datadog.rb

@@ -13,7 +13,9 @@ module Capistrano
 
     def self.cap_version()
       if @cap_version.nil? then
-        if Configuration.respond_to? :instance then
+        if !defined? Configuration
+          @cap_version = ''
+        elsif Configuration.respond_to? :instance
           @cap_version = :v2
         else
           @cap_version = :v3
@@ -108,8 +110,9 @@ module Capistrano
           if !task[:application].nil? and !task[:application].empty? then
             application = ' for ' + task[:application]
           end
+          timing = Float(task[:timing]).round(2) rescue 'n/a'
           title = "#{user}@#{hostname} ran #{name}#{application} on #{roles.join(', ')} "\
-                  "with capistrano in #{task[:timing].round(2)} secs"
+                  "with capistrano in #{timing} secs"
           type  = 'deploy'
           alert_type = 'success'
           source_type = 'capistrano'

data/lib/dogapi/facade.rb

@@ -12,6 +12,7 @@ module Dogapi
   # information about the JSON object structure is available in the HTTP API
   # documentation, here[https://github.com/DataDog/dogapi/wiki].
   class Client # rubocop:disable Metrics/ClassLength
+    attr_accessor :datadog_host
 
     def initialize(api_key, application_key=nil, host=nil, device=nil, silent=true, timeout=nil, endpoint=nil)
 

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = '1.30'
+  VERSION = '1.31.0'
 end

data/spec/unit/capistrano_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'capistrano/datadog'
+require 'benchmark'
+
+describe 'Capistrano' do
+  context 'Reporter' do
+    context 'report' do
+      before(:each) do
+        @task = {
+          name: 'ATask',
+          roles: [],
+          stage: 'AStage',
+          application: 'MyApp',
+          logs: [],
+          hosts: []
+        }
+        @reporter = Capistrano::Datadog.reporter
+      end
+
+      it 'normally works with float timing' do
+        @task[:timing] = 9.99999
+        expected = @task[:timing].round(2)
+        @reporter.instance_variable_set(:@tasks, [@task])
+        event = @reporter.report.first.first
+        expect(event.msg_title).to include("with capistrano in #{expected} secs")
+      end
+
+      it 'handles non-numeric timing' do
+        @task[:timing] = nil
+        @reporter.instance_variable_set(:@tasks, [@task])
+        event = @reporter.report.first.first
+        expect(event.msg_title).to include('with capistrano in n/a secs')
+      end
+    end
+  end
+end

data/spec/unit/common_spec.rb

@@ -1,6 +1,17 @@
 require_relative '../spec_helper'
 
 describe 'Common' do
+  describe Dogapi.find_datadog_host do
+    it 'gives precedence to DATADOG_HOST env var' do
+      allow(ENV).to receive(:[]).with('DATADOG_HOST').and_return('example.com')
+      expect(Dogapi.find_datadog_host).to eq 'example.com'
+    end
+    it 'falls back to default url when DATADOG_HOST env var is not set' do
+      allow(ENV).to receive(:[]).with('DATADOG_HOST').and_return(nil)
+      expect(Dogapi.find_datadog_host).to eq 'https://api.datadoghq.com'
+    end
+  end
+
   context 'Scope' do
     it 'validates the Scope class' do
       obj = Dogapi::Scope.new('somehost', 'somedevice')

data/spec/unit/facade_spec.rb

@@ -11,6 +11,19 @@ describe Dogapi::Client do
     end
   end
 
+  describe 'Datadog API url' do
+    it 'can be set in initializer' do
+      client = Dogapi::Client.new(api_key, app_key, nil, nil, nil, nil, 'example.com')
+      expect(client.datadog_host).to eq 'example.com'
+    end
+
+    it 'can be set with instance var' do
+      client = Dogapi::Client.new(api_key, app_key)
+      client.datadog_host = 'example.com'
+      expect(client.datadog_host).to eq 'example.com'
+    end
+  end
+
   describe '#emit_point' do
     it 'passes data' do
       @dogmock.emit_point('metric.name', 0, host: 'myhost')

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: '1.30'
+  version: 1.31.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-05 00:00:00.000000000 Z
+date: 2018-10-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -133,6 +133,7 @@ files:
 - spec/integration/tag_spec.rb
 - spec/integration/user_spec.rb
 - spec/spec_helper.rb
+- spec/unit/capistrano_spec.rb
 - spec/unit/common_spec.rb
 - spec/unit/facade_spec.rb
 homepage: http://datadoghq.com/
@@ -183,5 +184,6 @@ test_files:
 - spec/integration/tag_spec.rb
 - spec/integration/user_spec.rb
 - spec/spec_helper.rb
+- spec/unit/capistrano_spec.rb
 - spec/unit/common_spec.rb
 - spec/unit/facade_spec.rb