dogapi 1.3.6 → 1.4.0

data/lib/dogapi/common.rb

@@ -97,6 +97,15 @@ module Dogapi
       end
     end
 
+    def suppress_error_if_silent(e)
+      if @silent
+        warn e
+        return -1, {}
+      else
+        raise e
+      end
+    end
+
     # Prepares the request and handles the response
     #
     # +method+ is an implementation of Net::HTTP::Request (e.g. Net::HTTP::Post)

data/lib/dogapi/facade.rb

@@ -29,6 +29,9 @@ module Dogapi
       @metric_svc = Dogapi::V1::MetricService.new(@api_key, @application_key, silent)
       @event_svc = Dogapi::V1::EventService.new(@api_key, @application_key, silent)
       @tag_svc = Dogapi::V1::TagService.new(@api_key, @application_key, silent)
+      @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent)
+      @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent)
+      @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent)
 
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
     end
@@ -133,21 +136,50 @@ module Dogapi
       end
     end
 
+    #
+    # COMMENTS
+    #
+
+    # Post a comment
+    def comment(message, options={})
+      @comment_svc.comment(message, options)
+    end
+
+    # Post a comment
+    def update_comment(comment_id, options={})
+      @comment_svc.update_comment(comment_id, options)
+    end
+
+    def delete_comment(comment_id)
+      @comment_svc.delete_comment(comment_id)
+    end
+
+    #
+    # SEARCH
+    #
+
+    # Run the given search query.
+    def search(query)
+      @search_svc.search query
+    end
+
+
     #
     # TAGS
-   
+    #
+
     # Get all tags and their associated hosts at your org
     def all_tags()
       @tag_svc.get_all()
     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)
       @tag_svc.get(host_id)
     end
-    
+
     # Add the tags to the given host
     #
     # +host_id+ can be the host's numeric id or string name
@@ -156,7 +188,7 @@ module Dogapi
     def add_tags(host_id, tags)
       @tag_svc.add(host_id, tags)
     end
-   
+
     # Replace the tags on the given host
     #
     # +host_id+ can be the host's numeric id or string name
@@ -179,6 +211,30 @@ module Dogapi
       @tag_svc.detach(host_id)
     end
 
+    #
+    # DASHES
+    #
+
+    # Create a dashboard.
+    def create_dashboard(title, description, graphs)
+      @dash_service.create_dashboard(title, description, graphs)
+    end
+
+    # Update a dashboard.
+    def update_dashboard(dash_id, title, description, graphs)
+      @dash_service.update_dashboard(dash_id, title, description, graphs)
+    end
+
+    # Fetch the given dashboard.
+    def get_dashboard(dash_id)
+      @dash_service.get_dashboard(dash_id)
+    end
+
+    # Delete the given dashboard.
+    def delete_dashboard(dash_id)
+      @dash_service.delete_dashboard(dash_id)
+    end
+
     private
 
     def override_scope(host, device)

data/lib/dogapi/v1.rb

@@ -1,3 +1,6 @@
 require 'dogapi/v1/event'
 require 'dogapi/v1/metric'
 require 'dogapi/v1/tag'
+require 'dogapi/v1/comment'
+require 'dogapi/v1/search'
+require 'dogapi/v1/dash'

data/lib/dogapi/v1/comment.rb

@@ -0,0 +1,62 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    class CommentService < Dogapi::APIService
+
+      API_VERSION = "v1"
+
+      # Submit a comment.
+      def comment(message, options={})
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = {
+           'message' => message,
+          }.merge options
+
+          request(Net::HTTP::Post, "/api/#{API_VERSION}/comments", params, body, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Update a comment.
+      def update_comment(comment_id, options={})
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          if options.empty?
+            raise "Must update something."
+          end
+
+          request(Net::HTTP::Put, "/api/#{API_VERSION}/comments/#{comment_id}", params, options, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      def delete_comment(comment_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Delete, "/api/#{API_VERSION}/comments/#{comment_id}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/dash.rb

@@ -0,0 +1,79 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    class DashService < Dogapi::APIService
+
+      API_VERSION = "v1"
+
+      def create_dashboard(title, description, graphs)
+
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = {
+            :title => title,
+            :description => description,
+            :graphs => graphs
+          }
+
+          request(Net::HTTP::Post, "/api/#{API_VERSION}/dash", params, body, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      def update_dashboard(dash_id, title, description, graphs)
+
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = {
+            :title => title,
+            :description => description,
+            :graphs => graphs
+          }
+
+          request(Net::HTTP::Put, "/api/#{API_VERSION}/dash/#{dash_id}", params, body, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      def get_dashboard(dash_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/dash/#{dash_id}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      def delete_dashboard(dash_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Delete, "/api/#{API_VERSION}/dash/#{dash_id}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/search.rb

@@ -0,0 +1,27 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    class SearchService < Dogapi::APIService
+
+      API_VERSION = "v1"
+
+      def search(query)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key,
+            :q => query
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/search", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+    end
+
+  end
+end

data/tests/test_base.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'dogapi'
+require 'time'
+
+unless Kernel.respond_to?(:require_relative)
+  module Kernel
+    def require_relative(path)
+      require File.join(File.dirname(caller[0]), path.to_str)
+    end
+  end
+end
+
+
+class TestBase < Test::Unit::TestCase
+
+  def config_client_test_env
+    @api_key = ENV['DATADOG_API_KEY']
+    @app_key = ENV['DATADOG_APP_KEY']
+    if not @api_key or not @app_key
+      puts "\n"
+      abort "To run tests in your environment, set 'DATADOG_API_KEY' and 'DATADOG_APP_KEY' to appropriate values for your account. Be aware that the tests will submit data, some of which won't be removed at the end.\n\n"
+    end
+  end
+
+  def setup
+    config_client_test_env()
+  end
+end
+

data/tests/test_client.rb

@@ -1,21 +1,8 @@
-require 'test/unit'
 require 'dogapi'
 require 'time'
+require_relative 'test_base.rb'
 
-class TestClient < Test::Unit::TestCase
-
-  def config_client_test_env
-    @api_key = ENV['DATADOG_API_KEY']
-    @app_key = ENV['DATADOG_APP_KEY']
-    if not @api_key or not @app_key
-      puts "\n"
-      abort "To run tests in your environment, set 'DATADOG_API_KEY' and 'DATADOG_APP_KEY' to appropriate values for your account. Be aware that the tests will submit data, some of which won't be removed at the end.\n\n"
-    end
-  end
-
-  def setup
-    config_client_test_env()
-  end
+class TestClient < TestBase
 
   def test_tags
     hostname = 'test.tag.host'

data/tests/test_comments.rb

@@ -0,0 +1,35 @@
+require 'dogapi'
+require 'time'
+require_relative 'test_base.rb'
+
+class TestComments < TestBase
+
+  def test_comments
+    dog = Dogapi::Client.new(@api_key, @app_key)
+
+    # Create a comment
+    dog.comment('test comment')
+
+    # Create a comment as a user.
+    handle = "carlo+14.1@datadoghq.com"
+    status, comment_response = dog.comment('test comment with handle', :handle => handle)
+    comment = comment_response["comment"]
+    assert_equal "200", status, "Comment did not succeed"
+
+    # Reply to a comment.
+    status, reply_response = dog.comment('replying!', :related_event_id => comment["id"])
+    reply = reply_response["comment"]
+    assert_equal "200", status, "Reply did not work."
+    # HACK: issue #900 on dogweb. id types should be the same.
+    assert_equal comment["id"].to_s, reply["related_event_id"]
+
+    # Update a comment.
+    dog.update_comment(reply["related_event_id"], :message => "Updating the comment")
+
+    # Delete a comment.
+    status, to_delete_response = dog.comment("im dead")
+    to_delete = to_delete_response["comment"]
+    dog.delete_comment(to_delete["id"])
+
+  end
+end

data/tests/test_dashes.rb

@@ -0,0 +1,71 @@
+require 'dogapi'
+require 'time'
+require_relative 'test_base.rb'
+
+class TestDashes < TestBase
+
+  def test_dashes
+    dog = Dogapi::Client.new(@api_key, @app_key)
+
+    # Create a dashboard.
+    title = 'foobar'
+    description = 'desc'
+    graphs =  [{
+      "definition" => {
+        "events" => [],
+        "requests "=> [
+          {"q" => "avg:system.mem.free{*}"}
+        ],
+      "viz" => "timeseries"
+      },
+      "title" => "Average Memory Free"
+    }]
+
+    status, dash_response = dog.create_dashboard(title, description, graphs)
+    assert_equal "200", status, "Creation failed"
+
+    dash_id = dash_response["dash"]["id"]
+
+    # Fetch the dashboard and assert all is well.
+    status, dash_response = dog.get_dashboard(dash_id)
+    assert_equal "200", status, "Fetch failed"
+    dash = dash_response["dash"]
+    assert_equal title, dash["title"]
+    assert_equal description, dash["description"]
+    assert_equal graphs, dash["graphs"]
+
+    # Update the dashboard.
+    title = 'blahfoobar'
+    description = 'asdfdesc'
+    graphs =  [{
+      "definition" => {
+        "events" => [],
+        "requests "=> [
+          {"q" => "sum:system.mem.free{*}"}
+        ],
+      "viz" => "timeseries"
+      },
+      "title" => "Sum Memory Free"
+    }]
+
+    status, dash_response = dog.update_dashboard(dash_id, title, description, graphs)
+    assert_equal "200", status, "Updated failed"
+
+    # Fetch the dashboard and assert all is well.
+    status, dash_response = dog.get_dashboard(dash_id)
+    assert_equal "200", status, "Fetch failed"
+    dash = dash_response["dash"]
+    assert_equal title, dash["title"]
+    assert_equal description, dash["description"]
+    assert_equal graphs, dash["graphs"]
+
+    # Delete the dashboard.
+    status, dash_response = dog.delete_dashboard(dash_id)
+    assert_equal "204", status, "Deleted failed"
+
+    # Fetch the dashboard and assert all it's gone.
+    status, dash_response = dog.get_dashboard(dash_id)
+    assert_equal "404", status, "Still there failed"
+
+  end
+end

data/tests/test_search.rb

@@ -0,0 +1,19 @@
+require 'dogapi'
+require 'time'
+require_relative 'test_base.rb'
+
+class TestSearch < TestBase
+
+  def test_search
+    dog = Dogapi::Client.new(@api_key, @app_key)
+
+    facets = ["hosts", "metrics"]
+    facets.each do |facet|
+      status, results_body = dog.search("#{facet}:foo")
+      results = results_body["results"]
+      assert_equal status, "200", "failed search #{facet} facet"
+      assert results[facet].kind_of?(Array), "#{facet} facet doesnt exist"
+    end
+
+  end
+end

metadata

@@ -1,97 +1,89 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: dogapi
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 1.4.0
   prerelease: 
-  segments: 
-  - 1
-  - 3
-  - 6
-  version: 1.3.6
 platform: ruby
-authors: 
+authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-07-25 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-09-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 1
-        - 5
-        - 1
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.5.1
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.5.1
 description: 
 email: packages@datadoghq.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - lib/capistrano/datadog.rb
 - lib/capistrano/README.md
 - lib/dogapi/common.rb
 - lib/dogapi/event.rb
 - lib/dogapi/facade.rb
 - lib/dogapi/metric.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/tag.rb
 - lib/dogapi/v1.rb
 - lib/dogapi.rb
+- tests/test_base.rb
 - tests/test_client.rb
+- tests/test_comments.rb
+- tests/test_dashes.rb
+- tests/test_search.rb
 - README.rdoc
 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 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
 rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Ruby bindings for Datadog's API
-test_files: 
+test_files:
 - tests/test_client.rb