dogapi 1.7.1 → 1.8.0

data/README.rdoc

@@ -1,9 +1,13 @@
-= Ruby client for Datadog API v1.7.1
+= Ruby client for Datadog API v1.8.0
 
 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.8.0
+
+* Add an API for interacting with Screenboards
+
 == v1.7.1
 
 * Add an API for inviting users

data/lib/dogapi/facade.rb

@@ -35,6 +35,7 @@ module Dogapi
       @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)
+      @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent)
 
       @legacy_event_svc = Dogapi::EventService.new(@datadog_host)
     end
@@ -285,6 +286,29 @@ module Dogapi
       @snapshot_svc.snapshot(metric_query, start_ts, end_ts, event_query)
     end
 
+    #
+    # SCREENBOARD
+    #
+    def create_screenboard(description)
+      @screenboard_svc.create_screenboard(description)
+    end
+
+    def update_screenboard(board_id, description)
+      @screenboard_svc.update_screenboard(board_id, description)
+    end
+
+    def get_screenboard(board_id)
+      @screenboard_svc.get_screenboard(board_id)
+    end
+
+    def delete_screenboard(board_id)
+      @screenboard_svc.delete_screenboard(board_id)
+    end
+
+    def share_screenboard(board_id)
+      @screenboard_svc.share_screenboard(board_id)
+    end
+
     private
 
     def override_scope(host, device)

data/lib/dogapi/v1.rb

@@ -7,3 +7,4 @@ require 'dogapi/v1/dash'
 require 'dogapi/v1/alert'
 require 'dogapi/v1/user'
 require 'dogapi/v1/snapshot'
+require 'dogapi/v1/screenboard'

data/lib/dogapi/v1/screenboard.rb

@@ -0,0 +1,85 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    class ScreenboardService < Dogapi::APIService
+
+      API_VERSION = "v1"
+
+      def create_screenboard(description)
+
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = description
+
+          request(Net::HTTP::Post, "/api/#{API_VERSION}/screen", params, description, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      def update_screenboard(board_id, description)
+
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = description
+
+          request(Net::HTTP::Put, "/api/#{API_VERSION}/screen/#{board_id}", params, body, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      def get_screenboard(board_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/screen/#{board_id}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      def delete_screenboard(board_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Delete, "/api/#{API_VERSION}/screen/#{board_id}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+
+      def share_screenboard(board_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/screen/share/#{board_id}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+    end
+
+  end
+end

data/tests/test_screenboard.rb

@@ -0,0 +1,74 @@
+require 'dogapi'
+require 'time'
+require 'test_base.rb'
+
+class TestScreenboard < Test::Unit::TestCase
+  include TestBase
+
+  def test_screenboard
+    dog = Dogapi::Client.new(@api_key, @app_key)
+
+        board = {
+            "width" => 1024,
+            "height" => 768,
+            "board_title" => "dogapi-rb test",
+            "widgets" => [
+                {
+                    "type" => "event_stream",
+                    "title" => false,
+                    "height" => 57,
+                    "width" => 59,
+                    "y" => 18,
+                    "x" => 84,
+                    "query" => "tags:release",
+                    "timeframe" => "1w"
+                },
+                {
+                  "type" => "image",
+                  "height" => 20,
+                  "width" => 32,
+                  "y" => 7,
+                  "x" => 32,
+                  "url" => "http://path/to/image.jpg"
+                }
+            ]
+        }
+
+        updated_board = {
+            "width" => 1024,
+            "height" => 768,
+            "board_title" => "dogapi test",
+            "widgets" => [
+                {
+                  "type" => "image",
+                  "height" => 20,
+                  "width" => 32,
+                  "y" => 7,
+                  "x" => 32,
+                  "url" => "http://path/to/image.jpg"
+                }
+            ]
+        }
+
+    status, result = dog.create_screenboard(board)
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert result["widgets"] == board["widgets"]
+
+    status, result = dog.get_screenboard(result["id"])
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert result["widgets"] == board["widgets"]
+
+    status, result = dog.update_screenboard(result["id"], updated_board)
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert result["widgets"] == updated_board["widgets"]
+
+    status, share_result = dog.share_screenboard(result["id"])
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert share_result["board_id"] == result["id"]
+
+    status, del_result = dog.delete_screenboard(result["id"])
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert del_result["id"] == result["id"]
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-27 00:00:00.000000000 Z
+date: 2013-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &6638840 !ruby/object:Gem::Requirement
+  requirement: &11482000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,7 +21,7 @@ dependencies:
         version: 1.5.1
   type: :runtime
   prerelease: false
-  version_requirements: *6638840
+  version_requirements: *11482000
 description: 
 email: packages@datadoghq.com
 executables: []
@@ -42,6 +42,7 @@ files:
 - lib/dogapi/v1/dash.rb
 - lib/dogapi/v1/event.rb
 - lib/dogapi/v1/metric.rb
+- lib/dogapi/v1/screenboard.rb
 - lib/dogapi/v1/search.rb
 - lib/dogapi/v1/snapshot.rb
 - lib/dogapi/v1/tag.rb
@@ -51,6 +52,7 @@ files:
 - tests/test_client.rb
 - tests/test_comments.rb
 - tests/test_dashes.rb
+- tests/test_screenboard.rb
 - tests/test_search.rb
 - tests/test_snapshot.rb
 - tests/test_users.rb