dogapi 1.22.0 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97fdf2da1be73b712ef0c63a980f060f12c4d39a
-  data.tar.gz: fb495d0a8975297a61d4f2155f8458b814de8f9b
+  metadata.gz: 6d44d23ffcc6ef539b6d85ae691647b700bba462
+  data.tar.gz: 0ea1557fa601f2c90b751ff9770bb53f15e90096
 SHA512:
-  metadata.gz: a6724cf647a38a2edd41a01d4842c8c2d328ff7b4d2693209b42a102807abf27999f459e2b410d7c14917b6db188253fed41dd712a8282b44c7ae4e0b8e02641
-  data.tar.gz: 55a23e31d1fd28dc2b16b2f02d8429cd5253745935f7ff16b2f88f242c17148fa977860b16f67188df72b07d1823b4092a8bb82dd09c7c65e59d0974bb695b02
+  metadata.gz: 3e2240ad05c8be24a809610af6155df3abbd170fe9e6a8c3ce6e69cefbd7f27272a54b68867ccd87f198ff892acbbfb779574b9212b4b94223c5fe368f89b6fc
+  data.tar.gz: 6606add9a66b617449930b3181e9ee6ca5cb467b7e9e701932630c39484006d0ad75c168fdf2b4886f6b96941cba5f6577ef317dce46e984e4ffaff1cdbcb6d2

data/.gitignore

@@ -5,6 +5,7 @@
 .ruby-version
 .rvm
 Gemfile.lock
+coverage
 doc/
 pkg/
 .idea

data/.rspec

@@ -1,2 +1,2 @@
 --color
---format documentation
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,13 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-08-15 12:22:34 -0400 using RuboCop version 0.42.0.
+# 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: 14
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 111

data/.travis.yml

@@ -1,8 +1,10 @@
 sudo: false
 language: ruby
 rvm:
+- 1.9
+- 2.0
 - 2.1
 - 2.2
-- 2.3.0
+- 2.3.1
 env:
   secure: hKn4OWJZ3gKvdGVZd5VTnpRb7GB5eEtF7qc0+zOwusL1bxxSXvuNTLecqvKZpDH5uCnRCx8Dz52hSA5KzNoBoH2dPhyeC8en4/gZWbxndHYg/2qFBeHO4FP/Li3B9DmZt247IkuzK1oI4k5GkFyVw7OVrjxSVb50hjbanddkkmg=

data/CHANGELOG.md

@@ -1,10 +1,19 @@
 Changes
 =======
 
-# 1.22.0 / Unreleased
+# 1.23.0 / Unreleased
+
+* [FEATURE] Add Datadog endpoint to configuration. See [#108][]
+* [FEATURE] Add delete method for events. See [#99][], [#109][]
+* [IMPROVEMENT] Add Capistrano 3.5+ compatibility. See [#96][]
+* [OTHER] Code style fixes. See [#106][] (thanks [@nots][])
+
+# 1.22.0 / 2016-04-14
+This release breaks compatibility with Ruby 1.8.
 * [FEATURE] Metric query API. See [#88][], [#90][] (thanks [@blakehilscher][])
 
 # 1.21.0 / 2015-10-30
+This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www.ruby-lang.org/en/news/2013/06/30/we-retire-1-8-7/))
 * [FEATURE] User CRUD API. See [#82][]
 * [IMPROVEMENT] Support capistrano SimpleTextFormatter (thanks [@rmoriz][] [#81][])
 
@@ -145,12 +154,18 @@ Changes
 [#82]: https://github.com/DataDog/dogapi-rb/issues/82
 [#88]: https://github.com/DataDog/dogapi-rb/issues/88
 [#90]: https://github.com/DataDog/dogapi-rb/issues/90
+[#96]: https://github.com/DataDog/dogapi-rb/issues/96
+[#99]: https://github.com/DataDog/dogapi-rb/issues/99
+[#106]: https://github.com/DataDog/dogapi-rb/issues/106
+[#108]: https://github.com/DataDog/dogapi-rb/issues/108
+[#109]: https://github.com/DataDog/dogapi-rb/issues/109
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@ansel1]: https://github.com/ansel1
 [@arielo]: https://github.com/arielo
 [@blakehilscher]: https://github.com/blakehilscher
 [@byroot]: https://github.com/byroot
+[@nots]: https://github.com/nots
 [@rmoriz]: https://github.com/rmoriz
 [@treeder]: https://github.com/treeder
 [@winebarrel]: https://github.com/winebarrel

data/Gemfile

@@ -3,14 +3,17 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
-  gem 'minitest'
   gem 'rake', '>= 2.4.2'
-  gem 'rdoc'
   gem 'rspec'
-  gem 'vcr'
+  gem 'rubocop', '~> 0.41.2'
+  gem 'simplecov'
   gem 'webmock'
+  if RbConfig::CONFIG['ruby_version'].start_with?("1.9")
+  	gem 'json', '< 2'
+  end
 end
 
 group :quality do
   gem 'tailor'
+  gem 'tins', '~> 1.6.0'
 end

data/README.rdoc

@@ -137,7 +137,7 @@ data point you will need to pass a list of +Time+, +float+ pairs, instead of a s
 
     query = 'sum:metric.count{*}.as_count()'
 
-    dog.get_points(from, to, query)
+    dog.get_points(query, from, to)
 
 
 

data/Rakefile

@@ -2,13 +2,12 @@ require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rdoc/task'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
-default_tests = [:spec, :test]
+default_tests = [:spec, :rubocop]
 
-case RbConfig::CONFIG['ruby_version']
-when -> (version) { version.start_with?("2.3") }
+if !RbConfig::CONFIG['ruby_version'].start_with?("2.3")
   # Not compatible with Ruby 2.3.x
-else
   require 'tailor/rake_task'
   default_tests.unshift(:tailor)
 
@@ -17,22 +16,11 @@ else
       style.max_line_length 160, :level => :warn
       style.max_code_lines_in_method 40, :level => :warn
     end
-    task.file_set 'spec/**/*.rb', :tests do |style|
-      style.max_line_length 160, :level => :warn
-      style.max_code_lines_in_method 40, :level => :warn
-    end
   end
-
 end
 
 task :default => default_tests
 
-Rake::TestTask.new(:test) do |test|
-  test.libs.push 'lib'
-  test.libs.push 'tests'
-  test.test_files = FileList['tests/test_*.rb']
-end
-
 # Doc stuff
 RDoc::Task.new do |rd|
   rd.main = 'README.rdoc'
@@ -44,6 +32,11 @@ end
 
 RSpec::Core::RakeTask.new(:spec)
 
+RuboCop::RakeTask.new do |task|
+  task.patterns = ['spec']
+end
+
+
 desc "Find notes in code"
 task :notes do
   puts `grep --exclude=Rakefile -r 'OPTIMIZE:\\|FIXME:\\|TODO:' .`

data/lib/capistrano/datadog.rb

@@ -1,8 +1,8 @@
-require "etc"
-require "digest/md5"
-require "timeout"
+require 'etc'
+require 'digest/md5'
+require 'timeout'
 
-require "dogapi"
+require 'dogapi'
 
 module Capistrano
   module Datadog
@@ -30,10 +30,10 @@ module Capistrano
             dog.emit_event event
           end
         else
-          puts "No api key set, not submitting to Datadog"
+          puts 'No api key set, not submitting to Datadog'
         end
       rescue Timeout::Error => e
-        puts "Could not submit to Datadog, request timed out."
+        puts 'Could not submit to Datadog, request timed out.'
       rescue => e
         puts "Could not submit to Datadog: #{e.inspect}\n#{e.backtrace.join("\n")}"
       end
@@ -77,7 +77,7 @@ module Capistrano
         @tasks.map do |task|
           name  = task[:name]
           roles = Array(task[:roles]).map(&:to_s).sort
-          tags  = ["#capistrano"] + (roles.map { |t| '#role:' + t })
+          tags  = ['#capistrano'] + (roles.map { |t| '#role:' + t })
           if !task[:stage].nil? and !task[:stage].empty? then
             tags << "#stage:#{task[:stage]}"
           end
@@ -85,15 +85,15 @@ module Capistrano
           if !task[:application].nil? and !task[:application].empty? then
             application = ' for ' + task[:application]
           end
-          title = "%s@%s ran %s%s on %s with capistrano in %.2f secs" % [user, hostname, name, application, roles.join(', '), task[:timing]]
-          type  = "deploy"
-          alert_type = "success"
-          source_type = "capistrano"
+          title = '%s@%s ran %s%s on %s with capistrano in %.2f secs' % [user, hostname, name, application, roles.join(', '), task[:timing]]
+          type  = 'deploy'
+          alert_type = 'success'
+          source_type = 'capistrano'
           message_content = (@logging_output[name] || []).join('')
           message = if !message_content.empty? then
             # Strip out color control characters
             message_content = sanitize_encoding(message_content).gsub(/\e\[(\d+)m/, '')
-            "@@@\n#{message_content}@@@" else "" end
+            "@@@\n#{message_content}@@@" else '' end
 
           Dogapi::Event.new(message,
             :msg_title        => title,

data/lib/capistrano/datadog/v2.rb

@@ -1,5 +1,5 @@
-require "benchmark"
-require "delegate"
+require 'benchmark'
+require 'delegate'
 
 # Capistrano v2
 
@@ -12,7 +12,7 @@ module Capistrano
       # will be raised.
       # Also, capture the time the task took to execute, and the logs it
       # outputted for submission to Datadog
-      def find_and_execute_task(path, hooks = {})
+      def find_and_execute_task(path, hooks= {})
         task = find_task(path) or raise NoSuchTaskError, "the task `#{path}' does not exist"
         result = nil
         reporter = Capistrano::Datadog.reporter
@@ -62,9 +62,9 @@ module Capistrano
       logger.device = Datadog::LogCapture.new logger.device
 
       # Trigger the Datadog submission once all the tasks have run
-      on :exit, "datadog:submit"
+      on :exit, 'datadog:submit'
       namespace :datadog do
-        desc "Submit the tasks that have run to Datadog as events"
+        desc 'Submit the tasks that have run to Datadog as events'
         task :submit do |ns|
           Capistrano::Datadog.submit variables[:datadog_api_key]
         end

data/lib/capistrano/datadog/v3.rb

@@ -1,6 +1,6 @@
-require "benchmark"
-require "sshkit/formatters/pretty"
-require "sshkit/formatters/simple_text"
+require 'benchmark'
+require 'sshkit/formatters/pretty'
+require 'sshkit/formatters/simple_text'
 
 # Capistrano v3 uses Rake's DSL instead of its own
 
@@ -30,7 +30,12 @@ module Capistrano
       end
 
       def write(*args)
-        @wrapped.write(*args)
+        # Check if Capistrano version >= 3.5.0
+        if Gem::Version.new(VERSION) >= Gem::Version.new('3.5.0')
+          @wrapped << args
+        else
+          @wrapped.write(*args)
+        end
         args.each { |arg| Capistrano::Datadog.reporter.record_log(arg) }
       end
       alias :<< :write

data/lib/dogapi/common.rb

@@ -28,7 +28,7 @@ module Dogapi
 
     # <b>DEPRECATED:</b> Going forward, use the newer APIService.
     def connect
-      warn "[DEPRECATION] Dogapi::Service has been deprecated in favor of the newer V1 services"
+      warn '[DEPRECATION] Dogapi::Service has been deprecated in favor of the newer V1 services'
       uri = URI.parse(@host)
       session = Net::HTTP.new(uri.host, uri.port)
       if 'https' == uri.scheme
@@ -41,7 +41,7 @@ module Dogapi
 
     # <b>DEPRECATED:</b> Going forward, use the newer APIService.
     def request(method, url, params)
-      warn "[DEPRECATION] Dogapi::Service has been deprecated in favor of the newer V1 services"
+      warn '[DEPRECATION] Dogapi::Service has been deprecated in favor of the newer V1 services'
       if !params.has_key? :api_key
         params[:api_key] = @api_key
       end
@@ -69,10 +69,10 @@ module Dogapi
 
   # Superclass that deals with the details of communicating with the DataDog API
   class APIService
-    def initialize(api_key, application_key, silent=true, timeout=nil)
+    def initialize(api_key, application_key, silent=true, timeout=nil, endpoint=nil)
       @api_key = api_key
       @application_key = application_key
-      @api_host = Dogapi.find_datadog_host()
+      @api_host = endpoint || Dogapi.find_datadog_host()
       @silent = silent
       @timeout = timeout || 5
     end
@@ -82,8 +82,8 @@ module Dogapi
       connection = Net::HTTP
 
       # After ruby 2.0 Net::HTTP looks for the env variable but not ruby 1.9
-      if RUBY_VERSION < "2.0.0"
-        proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"] || ENV["HTTP_PROXY"] || ENV["http_proxy"]
+      if RUBY_VERSION < '2.0.0'
+        proxy = ENV['HTTPS_PROXY'] || ENV['https_proxy'] || ENV['HTTP_PROXY'] || ENV['http_proxy']
         if proxy
           proxy_uri = URI.parse(proxy)
           connection = Net::HTTP::Proxy(proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password)
@@ -96,17 +96,15 @@ module Dogapi
       session.use_ssl = uri.scheme == 'https'
       session.start do |conn|
         conn.read_timeout = @timeout
-        yield(conn)
+        yield conn
       end
     end
 
     def suppress_error_if_silent(e)
-      if @silent
-        warn e
-        return -1, {}
-      else
-        raise e
-      end
+      raise e unless @silent
+
+      warn e
+      return -1, {}
     end
 
     # Prepares the request and handles the response
@@ -114,43 +112,50 @@ module Dogapi
     # +method+ is an implementation of Net::HTTP::Request (e.g. Net::HTTP::Post)
     #
     # +params+ is a Hash that will be converted to request parameters
-    def request(method, url, params, body, send_json)
-      resp_obj = nil
+    def request(method, url, extra_params, body, send_json, with_app_key=true)
       resp = nil
       connect do |conn|
-        if params and params.size > 0
-          qs_params = params.map { |k, v| k.to_s + "=" + v.to_s }
-          qs = "?" + qs_params.join("&")
-          url = url + qs
-        end
+        begin
+          current_url = url + prepare_params(extra_params, with_app_key)
+          req = method.new(current_url)
 
-        req = method.new(url)
+          if send_json
+            req.content_type = 'application/json'
+            req.body = MultiJson.dump(body)
+          end
 
-        if send_json
-          req.content_type = 'application/json'
-          req.body = MultiJson.dump(body)
+          resp = conn.request(req)
+          return handle_response(resp)
+        rescue Exception => e
+          suppress_error_if_silent e
         end
+      end
+    end
 
-        resp = conn.request(req)
-        resp_str = resp.body
+    def prepare_params(extra_params, with_app_key)
+      params = { api_key: @api_key }
+      params[:application_key] = @application_key if with_app_key
+      params = extra_params.merge params unless extra_params.nil?
+      qs_params = params.map { |k, v| k.to_s + '=' + v.to_s }
+      qs = '?' + qs_params.join('&')
+      qs
+    end
 
-        if resp.code != 204 and resp.body != '' and resp.body != 'null' and resp.body != nil
-          begin
-            resp_obj = MultiJson.load(resp.body)
-          rescue
-            raise 'Invalid JSON Response: ' + resp.body
-          end
-        else
-          resp_obj = {}
-        end
+    def handle_response(resp)
+      if resp.code == 204 || resp.body == '' || resp.body == 'null' || resp.body.nil?
+        return resp.code, {}
+      end
+      begin
+        return resp.code, MultiJson.load(resp.body)
+      rescue
+        raise 'Invalid JSON Response: ' + resp.body
       end
-      return resp.code, resp_obj
     end
   end
 
   def Dogapi.find_datadog_host
     # allow env-based overriding, useful for tests
-    ENV["DATADOG_HOST"] || "https://app.datadoghq.com"
+    ENV['DATADOG_HOST'] || 'https://app.datadoghq.com'
   end
 
   # Memoize the hostname as a module variable
@@ -161,8 +166,7 @@ module Dogapi
       # prefer hostname -f over Socket.gethostname
       @@hostname ||= %x[hostname -f].strip
     rescue
-      raise "Cannot determine local hostname via hostname -f"
+      raise 'Cannot determine local hostname via hostname -f'
     end
   end
-
 end

data/lib/dogapi/event.rb

@@ -26,7 +26,7 @@ module Dogapi
   #  :event_type    => String
   #  :source_type_name => String
   #  :aggregation_key => String
-    def initialize(msg_text, options = {})
+    def initialize(msg_text, options= {})
       defaults = {
         :date_happened => Time.now.to_i,
         :msg_title => '',
@@ -62,14 +62,14 @@ module Dogapi
   # removed in an upcoming release.
   class EventService < Dogapi::Service
 
-    API_VERSION = "1.0.0"
+    API_VERSION = '1.0.0'
     MAX_BODY_LENGTH = 4000
     MAX_TITLE_LENGTH = 100
 
     # <b>DEPRECATED:</b> Going forward, use the V1 services. This legacy service will be
     # removed in an upcoming release.
     def submit(api_key, event, scope=nil, source_type=nil)
-      warn "[DEPRECATION] Dogapi::EventService.submit() has been deprecated in favor of the newer V1 services"
+      warn '[DEPRECATION] Dogapi::EventService.submit() has been deprecated in favor of the newer V1 services'
       scope = scope || Dogapi::Scope.new()
       params = {
         :api_key => api_key,
@@ -99,7 +99,7 @@ module Dogapi
     # <b>DEPRECATED:</b> Going forward, use the V1 services. This legacy service will be
     # removed in an upcoming release.
     def start(api_key, event, scope, source_type=nil)
-      warn "[DEPRECATION] Dogapi::EventService.start() has been deprecated in favor of the newer V1 services"
+      warn '[DEPRECATION] Dogapi::EventService.start() has been deprecated in favor of the newer V1 services'
       response = submit api_key, event, scope, source_type
       success = nil