dogapi 1.6.0 → 1.7.1

data/README.rdoc

@@ -1,9 +1,19 @@
-= Ruby client for Datadog API v1.6.0
+= Ruby client for Datadog API v1.7.1
 
 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.
 
 = What's new?
 
+== v1.7.1
+
+* Add an API for inviting users
+* Add an API for taking graph snapshots
+* Fix bug in capistrano integration with logging of nil (thanks @arielo)
+
+== v1.7.0
+
+* Not released.
+
 == v1.6.0
 
 * Support for setting `source` type when submitting host tags

data/lib/capistrano/datadog.rb

@@ -97,7 +97,7 @@ module Capistrano
           type  = "deploy"
           alert_type = "success"
           source_type = "capistrano"
-          message = "@@@" + "\n" + @logging_output[name].join('') + "@@@"
+          message = "@@@" + "\n" + (@logging_output[name] || []).join('') + "@@@"
 
           Dogapi::Event.new(message,
             :msg_title        => title,

data/lib/dogapi/facade.rb

@@ -33,6 +33,8 @@ module Dogapi
       @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent)
       @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent)
       @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent)
+      @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent)
+      @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent)
 
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
     end
@@ -273,6 +275,16 @@ module Dogapi
       @alert_svc.unmute_alerts()
     end
 
+    # User invite
+    def invite(emails, options={})
+      @user_svc.invite(emails, options)
+    end
+
+    # Graph snapshot
+    def graph_snapshot(metric_query, start_ts, end_ts, event_query=nil)
+      @snapshot_svc.snapshot(metric_query, start_ts, end_ts, event_query)
+    end
+
     private
 
     def override_scope(host, device)

data/lib/dogapi/v1.rb

@@ -5,3 +5,5 @@ require 'dogapi/v1/comment'
 require 'dogapi/v1/search'
 require 'dogapi/v1/dash'
 require 'dogapi/v1/alert'
+require 'dogapi/v1/user'
+require 'dogapi/v1/snapshot'

data/lib/dogapi/v1/snapshot.rb

@@ -0,0 +1,30 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    class SnapshotService < Dogapi::APIService
+
+      API_VERSION = "v1"
+
+      def snapshot(metric_query, start_ts, end_ts, event_query=nil)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key,
+            :metric_query => metric_query,
+            :start => start_ts,
+            :end => end_ts,
+            :event_query => event_query
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/snapshot", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/user.rb

@@ -0,0 +1,29 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    class UserService < Dogapi::APIService
+
+      API_VERSION = "v1"
+
+      def invite(emails, options={})
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = {
+            'emails' => emails,
+          }.merge options
+
+          request(Net::HTTP::Post, "/api/#{API_VERSION}/invite_users", params, body, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+    end
+
+  end
+end

data/tests/test_snapshot.rb

@@ -0,0 +1,28 @@
+require 'dogapi'
+require 'time'
+require 'test_base.rb'
+
+class TestSnapshot < Test::Unit::TestCase
+  include TestBase
+
+  def test_snapshot
+    dog = Dogapi::Client.new(@api_key, @app_key)
+
+    metric_query = "system.load.1{*}"
+    event_query = "*"
+    end_ts = Time.now().to_i
+    start_ts = end_ts - 60 * 60 # go back 1 hour
+
+    # Try without an event query
+    status, result = dog.graph_snapshot(metric_query, start_ts, end_ts)
+    assert_equal status, "200", "invalid HTTP response: #{status}"
+    assert result["metric_query"] = metric_query
+
+    # Try with an event query
+    status, result = dog.graph_snapshot(metric_query, start_ts, end_ts,
+                                  event_query=event_query)
+    assert_equal status, "200", "invalid HTTP response: #{status}"
+    assert result["metric_query"] = metric_query
+    assert result["event_query"] = event_query
+  end
+end

data/tests/test_users.rb

@@ -0,0 +1,16 @@
+require 'dogapi'
+require 'time'
+require 'test_base.rb'
+
+class TestUsers < Test::Unit::TestCase
+  include TestBase
+
+  def test_users
+    dog = Dogapi::Client.new(@api_key, @app_key)
+
+    emails = ["notarealperson@datadoghq.com", "alsoreallyfake@datadoghq.com"]
+
+    invited = dog.invite(emails)
+    assert_equal emails, invited[1]["emails"], invited
+  end
+end

metadata

@@ -1,105 +1,90 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dogapi
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 1
-  - 6
-  - 0
-  segments_generated: true
-  version: 1.6.0
+version: !ruby/object:Gem::Version
+  version: 1.7.1
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2013-02-19 00:00:00 -05:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 1
-        - 5
-        - 1
-        segments_generated: true
-        version: 1.5.1
+date: 2013-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  requirement: *id001
+  requirement: &6638840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
   prerelease: false
+  version_requirements: *6638840
 description: 
 email: packages@datadoghq.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
-- lib/capistrano/datadog.rb
+files:
 - lib/capistrano/README.md
+- lib/capistrano/datadog.rb
+- lib/dogapi.rb
 - lib/dogapi/common.rb
 - lib/dogapi/event.rb
 - lib/dogapi/facade.rb
 - lib/dogapi/metric.rb
+- lib/dogapi/v1.rb
 - lib/dogapi/v1/alert.rb
 - lib/dogapi/v1/comment.rb
 - lib/dogapi/v1/dash.rb
 - lib/dogapi/v1/event.rb
 - lib/dogapi/v1/metric.rb
 - lib/dogapi/v1/search.rb
+- lib/dogapi/v1/snapshot.rb
 - lib/dogapi/v1/tag.rb
-- lib/dogapi/v1.rb
-- lib/dogapi.rb
+- lib/dogapi/v1/user.rb
 - tests/test_alerts.rb
 - tests/test_base.rb
 - tests/test_client.rb
 - tests/test_comments.rb
 - tests/test_dashes.rb
 - tests/test_search.rb
+- tests/test_snapshot.rb
+- tests/test_users.rb
 - README.rdoc
-has_rdoc: true
 homepage: http://datadoghq.com/
-licenses: 
+licenses:
 - BSD
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --title
 - DogAPI -- DataDog Client
 - --main
 - README.rdoc
 - --line-numbers
 - --inline-source
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      segments_generated: true
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      segments_generated: true
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for Datadog's API
-test_files: 
+test_files:
 - tests/test_client.rb