dogapi 1.8.1 → 1.9.0

data/.rspec

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

data/.tailor

@@ -0,0 +1,106 @@
+#------------------------------------------------------------------------------
+# Horizontal Whitespace
+#------------------------------------------------------------------------------
+# allow_hard_tabs         True to let hard tabs be considered a single space.
+#                         Default:      false
+#
+# allow_trailing_line_spaces
+#                         True to skip detecting extra spaces at the ends of
+#                         lines.
+#                         Default:      false
+#
+# indentation_spaces      The number of spaces to consider a proper indent.
+#                         Default:      2
+#
+# max_line_length         The maximum number of characters in a line before
+#                         tailor complains.
+#                         Default:      80
+# spaces_after_comma      Number of spaces to expect after a comma.
+#                         Default:      1
+#
+# spaces_before_comma     Number of spaces to expect before a comma.
+#                         Default:      0
+#
+# spaces_after_lbrace     The number of spaces to expect after an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_lbrace    The number of spaces to expect before an lbrace ('{').
+#                         Default:      1
+#
+# spaces_before_rbrace    The number of spaces to expect before an rbrace ('}').
+#                         Default:      1
+#
+# spaces_in_empty_braces  The number of spaces to expect between braces when
+#                         there's nothing in the braces (i.e. {}).
+#                         Default:      0
+#
+# spaces_after_lbracket   The number of spaces to expect after an
+#                         lbracket ('[').
+#                         Default:      0
+#
+# spaces_before_rbracket  The number of spaces to expect before an
+#                         rbracket (']').
+#                         Default:      0
+#
+# spaces_after_lparen     The number of spaces to expect after an
+#                         lparen ('(').
+#                         Default:      0
+#
+# spaces_before_rparen    The number of spaces to expect before an
+#                         rbracket (')').
+#                         Default:      0
+#
+#------------------------------------------------------------------------------
+# Naming
+#------------------------------------------------------------------------------
+# allow_camel_case_methods
+#                         Setting to true skips detection of camel-case method
+#                         names (i.e. def myMethod).
+#                         Default:      false
+#
+# allow_screaming_snake_case_classes
+#                         Setting to true skips detection of screaming
+#                         snake-case class names (i.e. My_Class).
+#                         Default:      false
+#
+#------------------------------------------------------------------------------
+# Vertical Whitespace
+#------------------------------------------------------------------------------
+# max_code_lines_in_class The number of lines of code in a class to allow before
+#                         tailor will warn you.
+#                         Default:      300
+#
+# max_code_lines_in_method
+#                         The number of lines of code in a method to allow
+#                         before tailor will warn you.
+#                         Default:      30
+#
+# trailing_newlines       The number of newlines that should be at the end of
+#                         the file.
+#                         Default:      1
+#
+Tailor.config do |config|
+  config.formatters "text"
+  config.file_set 'lib/**/*.rb' do |style|
+    style.allow_camel_case_methods false, level: :error
+    style.allow_hard_tabs false, level: :error
+    style.allow_screaming_snake_case_classes false, level: :error
+    style.allow_trailing_line_spaces false, level: :error
+    style.allow_invalid_ruby false, level: :warn
+    style.indentation_spaces 2, level: :error
+    style.max_code_lines_in_class 300, level: :error
+    style.max_code_lines_in_method 33, level: :error
+    style.max_line_length 160, level: :warn
+    style.spaces_after_comma 1, level: :error
+    style.spaces_after_lbrace 1, level: :error
+    style.spaces_after_lbracket 0, level: :error
+    style.spaces_after_lparen 0, level: :error
+    style.spaces_before_comma 0, level: :error
+    style.spaces_before_lbrace 1, level: :error
+    style.spaces_before_rbrace 1, level: :error
+    style.spaces_before_rbracket 0, level: :error
+    style.spaces_before_rparen 0, level: :error
+    style.spaces_in_empty_braces 0, level: :error
+    style.trailing_newlines 1, level: :error
+  end
+end

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 Changes
 =======
 
+# 1.9.0 / 2013-09-06
+* When emitting a metric without an explicit host, default to local hostname.
+
 # 1.8.1 / 2013-08-22
 * Update Dash API to support template variables.
 

data/Gemfile

@@ -5,4 +5,11 @@ gemspec
 group :test do
   gem 'rake', '>= 2.4.2'
   gem 'rdoc'
+  gem 'rspec'
+  gem 'vcr'
+  gem 'webmock'
+end
+
+group :quality do
+  gem 'tailor'
 end

data/README.rdoc

@@ -1,4 +1,7 @@
-= Ruby client for Datadog API v1.8.0
+= Ruby Client for Datadog API
+
+{<img src="https://badge.fury.io/rb/dogapi.png" alt="Gem Version" />}[http://badge.fury.io/rb/dogapi]
+
 {<img src="https://travis-ci.org/DataDog/dogapi-rb.png?branch=master" alt="Build Status" />}[https://travis-ci.org/DataDog/dogapi-rb]
 
 The Ruby client is a library suitable for inclusion in existing Ruby projects or for development of standalone scripts. It provides an abstraction on top of Datadog's raw HTTP interface for reporting events and metrics.

data/Rakefile

@@ -1,12 +1,36 @@
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rdoc/task'
+require 'rspec/core/rake_task'
 
 # Assign some test keys if they aren't already set.
 ENV["DATADOG_API_KEY"] ||= '9775a026f1ca7d1c6c5af9d94d9595a4'
 ENV["DATADOG_APP_KEY"] ||= '87ce4a24b5553d2e482ea8a8500e71b8ad4554ff'
 
-task :default => [:test]
+default_tests = [:spec, :test]
+
+case RbConfig::CONFIG['ruby_version']
+when '1.8'
+  # do nothing
+else
+  # Since Tailor uses methods that don't exist in Ruby 1.8.7
+  require 'tailor/rake_task'
+  default_tests.unshift(:tailor)
+
+  Tailor::RakeTask.new do |task|
+    task.file_set 'lib/**/*.rb', :code do |style|
+      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'
@@ -23,4 +47,9 @@ RDoc::Task.new do |rd|
   rd.title = 'DogAPI -- DataDog Client'
 end
 
-task :default => [:test]
+RSpec::Core::RakeTask.new(:spec)
+
+desc "Find notes in code"
+task :notes do
+  puts `grep --exclude=Rakefile -r 'OPTIMIZE:\\|FIXME:\\|TODO:' .`
+end

data/lib/capistrano/datadog.rb

@@ -13,16 +13,16 @@ module Capistrano
   class Configuration
     module Execution
       # Attempts to locate the task at the given fully-qualified path, and
-      # execute it. If no such task exists, a Capistrano::NoSuchTaskError 
+      # execute it. If no such task exists, a Capistrano::NoSuchTaskError
       # will be raised.
-      # Also, capture the time the task took to execute, and the logs it 
+      # 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
         timing = Benchmark.measure(task.fully_qualified_name) do
-          # Set the current task so that the logger knows which task to 
+          # Set the current task so that the logger knows which task to
           # associate the logs with
           reporter.current_task = task.fully_qualified_name
           trigger(hooks[:before], task) if hooks[:before]
@@ -75,7 +75,7 @@ module Capistrano
       end
 
       def record_log(message)
-        if not @logging_output[@current_task] 
+        if not @logging_output[@current_task]
           @logging_output[@current_task] = []
         end
         @logging_output[@current_task] << message
@@ -128,7 +128,7 @@ module Capistrano
     namespace :datadog do
       desc "Submit the tasks that have run to Datadog as events"
       task :submit do |ns|
-        begin 
+        begin
           api_key = variables[:datadog_api_key]
           if api_key
             dog = Dogapi::Client.new(api_key)
@@ -147,8 +147,4 @@ module Capistrano
     end
   end
 
-
 end
-
-
-

data/lib/dogapi/common.rb

@@ -116,7 +116,7 @@ module Dogapi
       resp = nil
       connect do |conn|
         if params and params.size > 0
-          qs_params = params.map { |k,v| k.to_s + "=" + v.to_s }
+          qs_params = params.map { |k, v| k.to_s + "=" + v.to_s }
           qs = "?" + qs_params.join("&")
           url = url + qs
         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 => '',
@@ -48,13 +48,13 @@ module Dogapi
       @event_type = options[:event_type]
       @source_type_name = options[:source_type_name]
     end
-    
-    # Copy and pasted from the internets 
+
+    # Copy and pasted from the internets
     # http://stackoverflow.com/a/5031637/25276
     def to_hash
-        hash = {}
-        instance_variables.each {|var| hash[var.to_s[1..-1].to_sym] = instance_variable_get(var) }
-        hash
+      hash = {}
+      instance_variables.each { |var| hash[var.to_s[1..-1].to_sym] = instance_variable_get(var) }
+      hash
     end
   end
 

data/lib/dogapi/facade.rb

@@ -23,7 +23,8 @@ module Dogapi
 
       @datadog_host = Dogapi.find_datadog_host()
 
-      @host = host
+      @host = host ||= Dogapi.find_localhost()
+
       @device = device
 
       @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent)
@@ -53,13 +54,15 @@ module Dogapi
     #
     # options[:type] = "counter" to specify a counter metric
     # options[:tags] = ["tag1", "tag2"] to tag the point
-    def emit_point(metric, value, options={})
-      defaults = {:timestamp => Time.now, :host => nil, :device => nil}
+    def emit_point(metric, value, options = {})
+      defaults = { :timestamp => Time.now }
       options = defaults.merge(options)
 
-      self.emit_points(metric,
-                       [[options[:timestamp], value]],
-                       options)
+      self.emit_points(
+        metric,
+        [[options[:timestamp], value]],
+        options
+      )
     end
 
     # Record a set of points of metric data
@@ -73,11 +76,8 @@ module Dogapi
     #
     # options[:type] = "counter" to specify a counter metric
     # options[:tags] = ["tag1", "tag2"] to tag the point
-    def emit_points(metric, points, options={})
-      defaults = {:host => nil, :device => nil}
-      options = defaults.merge(options)
-
-      scope = override_scope options[:host], options[:device]
+    def emit_points(metric, points, options = {})
+      scope = override_scope options
 
       points.each do |p|
         p[0].kind_of? Time or raise "Not a Time"
@@ -96,11 +96,8 @@ module Dogapi
     # Optional arguments:
     #  :host        => String
     #  :device      => String
-    def emit_event(event, options={})
-      defaults = {:host => nil, :device => nil}
-      options = defaults.merge(options)
-
-      scope = override_scope(options[:host], options[:device])
+    def emit_event(event, options = {})
+      scope = override_scope options
 
       @event_svc.post(event, scope)
     end
@@ -122,18 +119,18 @@ module Dogapi
     #   :priority   => "normal" or "low"
     #   :sources    => String, see https://github.com/DataDog/dogapi/wiki/Event for a current list of sources
     #   :tags       => Array of Strings
-    def stream(start, stop, options={})
+    def stream(start, stop, options = {})
       @event_svc.stream(start, stop, options)
     end
 
     # <b>DEPRECATED:</b> Recording events with a duration has been deprecated.
     # The functionality will be removed in a later release.
-    def start_event(event, options={})
+    def start_event(event, options = {})
       warn "[DEPRECATION] Dogapi::Client.start_event() is deprecated. Use `emit_event` instead."
-      defaults = {:host => nil, :device => nil, :source_type => nil}
+      defaults = { :source_type => nil }
       options = defaults.merge(options)
 
-      scope = override_scope options[:host], options[:device]
+      scope = override_scope options
 
       @legacy_event_svc.start(@api_key, event, scope, options[:source_type]) do
         yield
@@ -145,12 +142,12 @@ module Dogapi
     #
 
     # Post a comment
-    def comment(message, options={})
+    def comment(message, options = {})
       @comment_svc.comment(message, options)
     end
 
     # Post a comment
-    def update_comment(comment_id, options={})
+    def update_comment(comment_id, options = {})
       @comment_svc.update_comment(comment_id, options)
     end
 
@@ -173,14 +170,14 @@ module Dogapi
     #
 
     # Get all tags and their associated hosts at your org
-    def all_tags(source=nil)
+    def all_tags(source = nil)
       @tag_svc.get_all(source)
     end
 
     # Get all tags for the given host
     #
     # +host_id+ can be the host's numeric id or string name
-    def host_tags(host_id, source=nil, by_source=false)
+    def host_tags(host_id, source = nil, by_source = false)
       @tag_svc.get(host_id, source, by_source)
     end
 
@@ -189,7 +186,7 @@ module Dogapi
     # +host_id+ can be the host's numeric id or string name
     #
     # +tags+ is and Array of Strings
-    def add_tags(host_id, tags, source=nil)
+    def add_tags(host_id, tags, source = nil)
       @tag_svc.add(host_id, tags, source)
     end
 
@@ -198,7 +195,7 @@ module Dogapi
     # +host_id+ can be the host's numeric id or string name
     #
     # +tags+ is and Array of Strings
-    def update_tags(host_id, tags, source=nil)
+    def update_tags(host_id, tags, source = nil)
       @tag_svc.update(host_id, tags, source)
     end
 
@@ -211,7 +208,7 @@ module Dogapi
     # Remove all tags from the given host
     #
     # +host_id+ can be the host's numeric id or string name
-    def detach_tags(host_id, source=nil)
+    def detach_tags(host_id, source = nil)
       @tag_svc.detach(host_id, source)
     end
 
@@ -220,12 +217,12 @@ module Dogapi
     #
 
     # Create a dashboard.
-    def create_dashboard(title, description, graphs, template_variables=nil)
+    def create_dashboard(title, description, graphs, template_variables = nil)
       @dash_service.create_dashboard(title, description, graphs, template_variables)
     end
 
     # Update a dashboard.
-    def update_dashboard(dash_id, title, description, graphs, template_variables=nil)
+    def update_dashboard(dash_id, title, description, graphs, template_variables = nil)
       @dash_service.update_dashboard(dash_id, title, description, graphs, template_variables)
     end
 
@@ -248,11 +245,11 @@ module Dogapi
     # ALERTS
     #
 
-    def alert(query, options={})
+    def alert(query, options = {})
       @alert_svc.alert(query, options)
     end
 
-    def update_alert(alert_id, query, options={})
+    def update_alert(alert_id, query, options = {})
       @alert_svc.update_alert(alert_id, query, options)
     end
 
@@ -277,12 +274,12 @@ module Dogapi
     end
 
     # User invite
-    def invite(emails, options={})
+    def invite(emails, options = {})
       @user_svc.invite(emails, options)
     end
 
     # Graph snapshot
-    def graph_snapshot(metric_query, start_ts, end_ts, event_query=nil)
+    def graph_snapshot(metric_query, start_ts, end_ts, event_query = nil)
       @snapshot_svc.snapshot(metric_query, start_ts, end_ts, event_query)
     end
 
@@ -311,18 +308,10 @@ module Dogapi
 
     private
 
-    def override_scope(host, device)
-      if host
-        h = host
-      else
-        h = @host
-      end
-      if device
-        d = device
-      else
-        d = @device
-      end
-      Scope.new(h, d)
+    def override_scope(options= {})
+      defaults = { :host => @host, :device => @device }
+      options = defaults.merge(options)
+      Scope.new(options[:host], options[:device])
     end
   end
 end