dogapi 1.19.0 → 1.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: de64563ab5144d6702205f3880a060f67df51241
-  data.tar.gz: f05d0e0f8ee326fa9d894ca79dccc7b60de1a936
+  metadata.gz: c4468399eb2562412f21f437bac47ce6eee96d64
+  data.tar.gz: 02b6507f392f7fdfa051104d466b0378841570fa
 SHA512:
-  metadata.gz: 5b4ab9bf5dff9e693be19c9c06e3d4e73650565f79eda03241415d10173df6002ca907ce0a5f8f3ec3101a0ca543f04bb7b311efefebef5d94b586aa912f9769
-  data.tar.gz: 9863d208e81b87f6fa0f353126253c4d0fe2c1ec6d0b6ff13d6308e5ed4bab1ed8c53027e6f19adac7d9a1107c95b1d1b3636728a3cd8dcd4a4a20351937e269
+  metadata.gz: 249b343d68784129d73fadebe8622e73eb2401d5f62f294007cdd7152ae01d1e0461b4eaafc4263d005d71b65f4632abb7e9bd63cd00eec47a9fe06254264ad8
+  data.tar.gz: 8170e19e1531983963a4ec44273838d30c8a31b249f192b3b4ba80cd1acd5d3e90caf038f23539c7718dbbcccf8a2ca6f95af084399405c74cdc4733ae5ea3af

data/CHANGELOG.md

@@ -1,6 +1,9 @@
 Changes
 =======
 
+# 1.20.0 / 2015-07-29
+* [FEATURE] Embeddable graphs API. See [#73][]
+
 # 1.19.0 / 2015-06-22
 * [FEATURE] Revoke a shared a Screenboard. See [#69][]
 
@@ -130,6 +133,7 @@ Changes
 [#62]: https://github.com/DataDog/dogapi-rb/issues/62
 [#64]: https://github.com/DataDog/dogapi-rb/issues/64
 [#69]: https://github.com/DataDog/dogapi-rb/issues/69
+[#73]: https://github.com/DataDog/dogapi-rb/issues/73
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@ansel1]: https://github.com/ansel1
@@ -137,4 +141,4 @@ Changes
 [@byroot]: https://github.com/byroot
 [@treeder]: https://github.com/treeder
 [@winebarrel]: https://github.com/winebarrel
-[@yyuu]: https://github.com/yyuu
+[@yyuu]: https://github.com/yyuu

data/lib/dogapi/facade.rb

@@ -37,6 +37,7 @@ module Dogapi
       @alert_svc = Dogapi::V1::AlertService.new(@api_key, @application_key, silent, timeout)
       @user_svc = Dogapi::V1::UserService.new(@api_key, @application_key, silent, timeout)
       @snapshot_svc = Dogapi::V1::SnapshotService.new(@api_key, @application_key, silent, timeout)
+      @embed_svc = Dogapi::V1::EmbedService.new(@api_key, @application_key, silent, timeout)
       @screenboard_svc = Dogapi::V1::ScreenboardService.new(@api_key, @application_key, silent, timeout)
       @monitor_svc = Dogapi::V1::MonitorService.new(@api_key, @application_key, silent, timeout)
       @service_check_svc = Dogapi::V1::ServiceCheckService.new(@api_key, @application_key, silent, timeout)
@@ -295,6 +296,29 @@ module Dogapi
       @snapshot_svc.snapshot(metric_query, start_ts, end_ts, event_query)
     end
 
+    #
+    # EMBEDS
+    #
+    def get_all_embeds()
+      @embed_svc.get_all_embeds()
+    end
+
+    def get_embed(embed_id, description= {})
+      @embed_svc.get_embed(embed_id, description)
+    end
+
+    def create_embed(graph_json, description= {})
+      @embed_svc.create_embed(graph_json, description)
+    end
+
+    def enable_embed(embed_id)
+      @embed_svc.enable_embed(embed_id)
+    end
+
+    def revoke_embed(embed_id)
+      @embed_svc.revoke_embed(embed_id)
+    end
+
     #
     # SCREENBOARD
     #

data/lib/dogapi/v1.rb

@@ -7,6 +7,7 @@ require 'dogapi/v1/dash'
 require 'dogapi/v1/alert'
 require 'dogapi/v1/user'
 require 'dogapi/v1/snapshot'
+require 'dogapi/v1/embed'
 require 'dogapi/v1/screenboard'
 require 'dogapi/v1/monitor'
 require 'dogapi/v1/service_check'

data/lib/dogapi/v1/embed.rb

@@ -0,0 +1,106 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    # ================
+    #    EMBED API 
+    # ================
+    class EmbedService < Dogapi::APIService
+
+      API_VERSION = "v1"
+
+      # Get all embeds for the API user's org
+      def get_all_embeds()
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Get a specific embed
+      #
+      # :embed_id       => String: embed token for a specific embed
+      # :size           => String: "small", "medium"(defualt), "large", or "xlarge". 
+      # :legend         => String: "yes" or "no"(default)
+      # :template_vars  => String: variable name => variable value (any number of template vars)
+      def get_embed(embed_id, description= {})
+        begin
+          # Initialize parameters and merge with description
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key,
+          }.merge(description)
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Create an embeddable graph
+      #
+      # :graph_json  => JSON: graph definition
+      # :timeframe   => String: representing the interval of the graph. Default is "1_hour"
+      # :size        => String: representing the size of the graph. Default is "medium".
+      # :legend      => String: flag representing whether a legend is displayed. Default is "no".
+      # :title       => String: represents title of the graph. Default is "Embed created through API."
+      def create_embed(graph_json, description= {})
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          body = {
+            :graph_json => graph_json,
+          }.merge(description)
+
+          request(Net::HTTP::Post, "/api/#{API_VERSION}/graph/embed", params, body, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Enable a specific embed
+      #
+      # :embed_id  => String: embed token for a specific embed
+      def enable_embed(embed_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}/enable", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Revoke a specific embed
+      #
+      # :embed_id  => String: embed token for a specific embed
+      def revoke_embed(embed_id)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/graph/embed/#{embed_id}/revoke", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = "1.19.0"
+  VERSION = "1.20.0"
 end

data/tests/test_embed.rb

@@ -0,0 +1,194 @@
+require 'dogapi'
+require 'time'
+require 'test_base.rb'
+
+class TestEmbed < Test::Unit::TestCase
+  include TestBase
+
+  def test_get_all_embeds
+    dog = Dogapi::Client.new(@api_key, @app_key)
+
+    # Attempt API Call
+    status, result = dog.get_all_embeds()
+    # Sanity check results
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert result.has_key?("embedded_graphs")
+  end
+
+  def test_create_embed
+    dog = Dogapi::Client.new(@api_key, @app_key)
+    # create an embed using the embed id and verify that it is valid
+    graph_json = '{
+      "viz": "toplist",
+      "requests": [{
+        "q": "top(system.disk.free{$var} by {device}, 10, \'mean\', \'desc\')",
+        "style": {
+          "palette": "dog_classic"
+        },
+        "conditional_formats": [{
+          "palette": "red",
+          "comparator": ">",
+          "value": 50000000000
+        }, {
+          "palette": "green",
+          "comparator": ">",
+          "value": 30000000000
+        }]
+      }]
+    }'
+    timeframe = "1_hour"
+    size = "medium"
+    legend = "no"
+    title = "Sick Title!"
+    description = {
+      :timeframe => timeframe,
+      :size => size,
+      :legend => legend,
+      :title => title
+    }
+    status, result = dog.create_embed(graph_json, description)
+    # Sanity check results
+    assert result["graph_title"] == title
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert result["html"].include? "legend=false"
+    assert result["html"].include? "height=300"
+    assert result["html"].include? "width=600"
+  end
+  
+  def test_get_embed
+    dog = Dogapi::Client.new(@api_key, @app_key)
+    # Create an Embed to get a valid embed_id
+    graph_json = '{
+      "viz": "toplist",
+      "requests": [{
+        "q": "top(system.disk.free{$var} by {device}, 10, \'mean\', \'desc\')",
+        "style": {
+          "palette": "dog_classic"
+        },
+        "conditional_formats": [{
+          "palette": "red",
+          "comparator": ">",
+          "value": 50000000000
+        }, {
+          "palette": "green",
+          "comparator": ">",
+          "value": 30000000000
+        }]
+      }]
+    }'
+    timeframe = "1_hour"
+    size = "medium"
+    legend = "no"
+    title = "Sick Title!"
+    description = {
+      :timeframe => timeframe,
+      :size => size,
+      :legend => legend,
+      :title => title
+    }
+    status, create_result = dog.create_embed(graph_json, description)
+    # Sanity check results
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert create_result["html"].include? "legend=false"
+    assert create_result["html"].include? "height=300"
+    assert create_result["html"].include? "width=600"
+    embed_id = create_result["embed_id"]
+    # Get the embed using that embed id
+    status, embed_without_var = dog.get_embed(embed_id)
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    get_embed_description = {
+      :size => size,
+      :legend => legend,
+      :var => "val"
+    }
+    status, embed_with_var = dog.get_embed(embed_id, get_embed_description)
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    # Verify that the get requests are good
+    assert embed_without_var["html"] == create_result["html"]
+    assert embed_with_var["html"] != embed_without_var["html"]
+    assert embed_with_var["html"].include? "legend=false"
+    assert embed_with_var["html"].include? "height=300"
+    assert embed_with_var["html"].include? "width=600"
+    assert embed_with_var["html"].include? "var=val"
+  end
+
+  def test_enable_embed
+    dog = Dogapi::Client.new(@api_key, @app_key)
+    # Create an Embed to get a valid embed_id
+    graph_json = '{
+      "viz": "toplist",
+      "requests": [{
+        "q": "top(system.disk.free{$var} by {device}, 10, \'mean\', \'desc\')",
+        "style": {
+          "palette": "dog_classic"
+        },
+        "conditional_formats": [{
+          "palette": "red",
+          "comparator": ">",
+          "value": 50000000000
+        }, {
+          "palette": "green",
+          "comparator": ">",
+          "value": 30000000000
+        }]
+      }]
+    }'
+    timeframe = "1_hour"
+    size = "medium"
+    legend = "no"
+    title = "Sick Title!"
+    description = {
+      :timeframe => timeframe,
+      :size => size,
+      :legend => legend,
+      :title => title
+    }
+    status, create_result = dog.create_embed(graph_json, description)
+    # Sanity check results
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    embed_id = create_result["embed_id"]
+    status, result = dog.enable_embed(embed_id)
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert result.has_key?("success")
+  end
+
+  def test_revoke_embed
+    dog = Dogapi::Client.new(@api_key, @app_key)
+    # Create an Embed to get a valid embed_id
+    graph_json = '{
+      "viz": "toplist",
+      "requests": [{
+        "q": "top(system.disk.free{$var} by {device}, 10, \'mean\', \'desc\')",
+        "style": {
+          "palette": "dog_classic"
+        },
+        "conditional_formats": [{
+          "palette": "red",
+          "comparator": ">",
+          "value": 50000000000
+        }, {
+          "palette": "green",
+          "comparator": ">",
+          "value": 30000000000
+        }]
+      }]
+    }'
+    timeframe = "1_hour"
+    size = "medium"
+    legend = "no"
+    title = "Sick Title!"
+    description = {
+      :timeframe => timeframe,
+      :size => size,
+      :legend => legend,
+      :title => title
+    }
+    status, create_result = dog.create_embed(graph_json, description)
+    # Sanity check results
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    embed_id = create_result["embed_id"]
+    status, result = dog.revoke_embed(embed_id)
+    assert_equal status, "200", "invalid HTTP response => #{status}"
+    assert result.has_key?("success")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.19.0
+  version: 1.20.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-22 00:00:00.000000000 Z
+date: 2015-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -100,6 +100,7 @@ files:
 - lib/dogapi/v1/alert.rb
 - lib/dogapi/v1/comment.rb
 - lib/dogapi/v1/dash.rb
+- lib/dogapi/v1/embed.rb
 - lib/dogapi/v1/event.rb
 - lib/dogapi/v1/metric.rb
 - lib/dogapi/v1/monitor.rb
@@ -131,6 +132,7 @@ files:
 - tests/test_client.rb
 - tests/test_comments.rb
 - tests/test_dashes.rb
+- tests/test_embed.rb
 - tests/test_monitors.rb
 - tests/test_screenboard.rb
 - tests/test_search.rb
@@ -162,7 +164,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.4
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Datadog's API
@@ -183,3 +185,4 @@ test_files:
 - spec/support/cassettes/Facade/Events/emits_events_and_retrieves_them.yml
 - spec/support/cassettes/Facade/Events/emits_events_with_specified_priority.yml
 - spec/support/cassettes/Facade/Tags/adds_updates_and_detaches_tags.yml
+has_rdoc: true