dogapi 1.32.0 → 1.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb35c84da1609020a097b950e0b5ed81425ffee7b4891f723541e97f9b10777b
-  data.tar.gz: dd495d053ac3704d69512bdca0ed25db64e68cf8ce400143ebb27533d8261728
+  metadata.gz: ec1cf46eb8ec6d3e512ac08b5385d62d70f6f28caa48a7681724cdacefc68b45
+  data.tar.gz: 47ca869de7d878e680a8bf1f12c315a02a9075d452aa7f1bb69100c03e8ccb11
 SHA512:
-  metadata.gz: cafcc7e0883a743adbfa82c1fce713e5b6e6bebf67c4337c8c7cca91a10d7c844a58280e9adbaf120de09984a1b05462b31b0c5391629fe5d6b926358c0ae6ef
-  data.tar.gz: 732984573605a233f81de6f17d6f8b2cbe3d4d1e158dbe2206a2b0ef2c443266c0b31f8a71995369a41e8aafff2164187b0c7fcd9166e11a3b683d3d43919481
+  metadata.gz: 54c9fe2f7463c547e96c769e0cfd9d8f30c4ebe4651c1d921d8737d4ba4c901b899d6b990e41ed221e008dc7d419ddac8e4f7a6989a2c39879763aa4c2d85fbb
+  data.tar.gz: bbe2fb112fb558b719896153ad7016e787ca376cc40f68e22ab7fe2e24ae2957ee52c2868d148958e613d49e8e3e3abaeb85752ec7f404d3eb76d97ddf1ceccd

data/.travis.yml

@@ -1,4 +1,3 @@
-sudo: false
 language: ruby
 rvm:
 - 2.0

data/CHANGELOG.md

@@ -1,9 +1,14 @@
 # Changes
 
+## 1.33.0 / 2019-02-13
+
+* [IMPROVEMENT] Add submission types mentioned in the API documentation. See [#165][], thanks [@TaylURRE][]
+* [FEATURE] Add support for the new Dashboard API. See [#167][], thanks [@enbashi][]
+
 ## 1.32.0 / 2018-10-23
 
-* [FEATURE] Added [monitor search](https://docs.datadoghq.com/api/?lang=ruby#monitors-search) and [monitor groups search](https://docs.datadoghq.com/api/?lang=ruby#monitors-group-search) API endpoints. See #163.
-* [FIX] Add project metadata to the gemspec. See #162, thanks @orien.
+* [FEATURE] Added [monitor search](https://docs.datadoghq.com/api/?lang=ruby#monitors-search) and [monitor groups search](https://docs.datadoghq.com/api/?lang=ruby#monitors-group-search) API endpoints. See [#163][].
+* [FIX] Add project metadata to the gemspec. See [#162][], thanks [@orien][].
 
 ## 1.31.0 / 2018-10-01
 
@@ -216,8 +221,13 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#152]: https://github.com/DataDog/dogapi-rb/issues/152
 [#159]: https://github.com/DataDog/dogapi-rb/issues/159
 [#160]: https://github.com/DataDog/dogapi-rb/issues/160
+[#162]: https://github.com/DataDog/dogapi-rb/issues/162
+[#163]: https://github.com/DataDog/dogapi-rb/issues/163
+[#165]: https://github.com/DataDog/dogapi-rb/issues/165
+[#167]: https://github.com/DataDog/dogapi-rb/issues/167
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
+[@TaylURRE]: https://github.com/TaylURRE
 [@acroos]: https://github.com/acroos
 [@ansel1]: https://github.com/ansel1
 [@arielo]: https://github.com/arielo
@@ -225,13 +235,15 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [@byroot]: https://github.com/byroot
 [@casperisfine]: https://github.com/casperisfine
 [@edwardkenfox]: https://github.com/edwardkenfox
+[@enbashi]: https://github.com/enbashi
 [@haohcraft]: https://github.com/haohcraft
 [@hnovikov]: https://github.com/hnovikov
 [@jimmyngo]: https://github.com/jimmyngo
 [@martinisoft]: https://github.com/martinisoft
 [@miknight]: https://github.com/miknight
 [@nots]: https://github.com/nots
+[@orien]: https://github.com/orien
 [@rmoriz]: https://github.com/rmoriz
 [@treeder]: https://github.com/treeder
 [@winebarrel]: https://github.com/winebarrel
-[@yyuu]: https://github.com/yyuu
+[@yyuu]: https://github.com/yyuu

data/dogapi.gemspec

@@ -25,7 +25,6 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.has_rdoc = true
   spec.extra_rdoc_files = ['README.rdoc']
   spec.rdoc_options << '--title' << 'DogAPI -- Datadog Client' <<
                     '--main' << 'README.rdoc' <<
@@ -33,7 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency 'multi_json'
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler', '>= 1.3'
   spec.add_development_dependency 'rake', '~> 10'
   spec.add_development_dependency 'rdoc'
 end

data/lib/dogapi/facade.rb

@@ -34,6 +34,7 @@ module Dogapi
       @comment_svc = Dogapi::V1::CommentService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @search_svc = Dogapi::V1::SearchService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @dash_service = Dogapi::V1::DashService.new(@api_key, @application_key, silent, timeout, @datadog_host)
+      @dashboard_service = Dogapi::V1::DashboardService.new(@api_key, @application_key, silent, timeout, @datadog_host)
       @dashboard_list_service = Dogapi::V1::DashboardListService.new(
         @api_key, @application_key, silent, timeout, @datadog_host
       )
@@ -276,6 +277,30 @@ module Dogapi
       @dash_service.delete_dashboard(dash_id)
     end
 
+    #
+    # DASHBOARDS
+    #
+
+    # Create a dashboard.
+    def create_board(title, widgets, layout_type, options= {})
+      @dashboard_service.create_board(title, widgets, layout_type, options)
+    end
+
+    # Update a dashboard.
+    def update_board(dashboard_id, title, widgets, layout_type, options= {})
+      @dashboard_service.update_board(dashboard_id, title, widgets, layout_type, options)
+    end
+
+    # Fetch the given dashboard.
+    def get_board(dashboard_id)
+      @dashboard_service.get_board(dashboard_id)
+    end
+
+    # Delete the given dashboard.
+    def delete_board(dashboard_id)
+      @dashboard_service.delete_board(dashboard_id)
+    end
+
     #
     # DASHBOARD LISTS
     #

data/lib/dogapi/v1.rb

@@ -1,6 +1,7 @@
 require 'dogapi/v1/alert'
 require 'dogapi/v1/comment'
 require 'dogapi/v1/dash'
+require 'dogapi/v1/dashboard'
 require 'dogapi/v1/dashboard_list'
 require 'dogapi/v1/embed'
 require 'dogapi/v1/event'

data/lib/dogapi/v1/dashboard.rb

@@ -0,0 +1,92 @@
+require 'dogapi'
+
+module Dogapi
+  class V1 # for namespacing
+
+    # Dashboard API
+    class DashboardService < Dogapi::APIService
+
+      API_VERSION = 'v1'
+      RESOURCE_NAME = 'dashboard'
+
+      # Create new dashboard
+      #
+      # Required arguments:
+      # :title                 => String: Title of the dashboard
+      # :widgets               => JSON: List of widgets to display on the dashboard
+      # :layout_type           => String: Layout type of the dashboard
+      #                           (for now, only "ordered" layout - current timeboard layout - is supported)
+      # Optional arguments:
+      # :description           => String: Description of the dashboard
+      # :is_read_only          => Boolean: Whether this dashboard is read-only.
+      #                           If True, only the author and admins can make changes to it.
+      # :notify_list           => JSON: List of handles of users to notify when changes are made to this dashboard
+      #                           e.g. '["user1@domain.com", "user2@domain.com"]'
+      # :template_variables    => JSON: List of template variables for this dashboard.
+      #                           e.g. [{"name": "host", "prefix": "host", "default": "my-host"}]
+      def create_board(title, widgets, layout_type, options)
+        # Required arguments
+        body = {
+          title: title,
+          widgets: widgets,
+          layout_type: layout_type
+        }
+        # Optional arguments
+        body[:description] = options[:description] if options[:description]
+        body[:is_read_only] = options[:is_read_only] if options[:is_read_only]
+        body[:notify_list] = options[:notify_list] if options[:notify_list]
+        body[:template_variables] = options[:template_variables] if options[:template_variables]
+
+        request(Net::HTTP::Post, "/api/#{API_VERSION}/#{RESOURCE_NAME}", nil, body, true)
+      end
+
+      # Update a dashboard
+      #
+      # Required arguments:
+      # :dashboard_id          => String: ID of the dashboard
+      # :title                 => String: Title of the dashboard
+      # :widgets               => JSON: List of widgets to display on the dashboard
+      # :layout_type           => String: Layout type of the dashboard
+      #                           (for now, only "ordered" layout - current timeboard layout - is supported)
+      # Optional arguments:
+      # :description           => String: Description of the dashboard
+      # :is_read_only          => Boolean: Whether this dashboard is read-only.
+      #                           If True, only the author and admins can make changes to it.
+      # :notify_list           => JSON: List of handles of users to notify when changes are made to this dashboard
+      #                           e.g. '["user1@domain.com", "user2@domain.com"]'
+      # :template_variables    => JSON: List of template variables for this dashboard.
+      #                           e.g. [{"name": "host", "prefix": "host", "default": "my-host"}]
+      def update_board(dashboard_id, title, widgets, layout_type, options)
+        # Required arguments
+        body = {
+          title: title,
+          widgets: widgets,
+          layout_type: layout_type
+        }
+        # Optional arguments
+        body[:description] = options[:description] if options[:description]
+        body[:is_read_only] = options[:is_read_only] if options[:is_read_only]
+        body[:notify_list] = options[:notify_list] if options[:notify_list]
+        body[:template_variables] = options[:template_variables] if options[:template_variables]
+
+        request(Net::HTTP::Put, "/api/#{API_VERSION}/#{RESOURCE_NAME}/#{dashboard_id}", nil, body, true)
+      end
+
+      # Fetch the given dashboard
+      #
+      # :dashboard_id          => String: ID of the dashboard
+      def get_board(dashboard_id)
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/#{RESOURCE_NAME}/#{dashboard_id}", nil, nil, false)
+      end
+
+      # Delete the given dashboard
+      #
+      # :dashboard_id          => String: ID of the dashboard
+      def delete_board(dashboard_id)
+        request(Net::HTTP::Delete, "/api/#{API_VERSION}/#{RESOURCE_NAME}/#{dashboard_id}", nil, nil, false)
+      end
+
+    end
+
+  end
+end

data/lib/dogapi/v1/metric.rb

@@ -61,8 +61,8 @@ module Dogapi
         begin
           typ = options[:type] || 'gauge'
 
-          if typ != 'gauge' && typ != 'counter'
-            raise ArgumentError, 'metric type must be gauge or counter'
+          if typ != 'gauge' && typ != 'counter' && typ != 'count' && typ != 'rate'
+            raise ArgumentError, 'metric type must be gauge or counter or count or rate'
           end
 
           metric_payload = {

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = '1.32.0'
+  VERSION = '1.33.0'
 end

data/spec/integration/dashboard_spec.rb

@@ -0,0 +1,64 @@
+require_relative '../spec_helper'
+
+describe Dogapi::Client do
+  DASHBOARD_ID = '3er-f8j-eus'.freeze
+  TITLE = 'My awesome dashboard'.freeze
+  WIDGETS = [{
+    'definition' => {
+      'requests ' => [
+        { 'q' => 'avg:system.mem.free{*}' }
+      ],
+      'title' => 'Average Memory Free',
+      'type' => 'timeseries'
+    },
+    'id' => 1234
+  }].freeze
+  LAYOUT_TYPE = 'ordered'.freeze
+  DESCRIPTION = 'Lorem ipsum'.freeze
+  IS_READ_ONLY = true
+  NOTIFY_LIST = ['user@domain.com'].freeze
+  TEMPLATE_VARIABLES = [{
+    'name' => 'host1',
+    'prefix' => 'host',
+    'default' => 'my-host'
+  }].freeze
+
+  REQUIRED_ARGS = {
+    title: TITLE,
+    widgets: WIDGETS,
+    layout_type: LAYOUT_TYPE
+  }.freeze
+
+  OPTIONS = {
+    description: DESCRIPTION,
+    is_read_only: IS_READ_ONLY,
+    notify_list: NOTIFY_LIST,
+    template_variables: TEMPLATE_VARIABLES
+  }
+  DASHBOARD_ARGS = REQUIRED_ARGS.values + [OPTIONS]
+  DASHBOARD_PAYLOAD = REQUIRED_ARGS.merge(OPTIONS)
+
+  describe '#create_board' do
+    it_behaves_like 'an api method',
+                    :create_board, DASHBOARD_ARGS,
+                    :post, '/dashboard', DASHBOARD_PAYLOAD
+  end
+
+  describe '#update_board' do
+    it_behaves_like 'an api method',
+                    :update_board, [DASHBOARD_ID] + DASHBOARD_ARGS,
+                    :put, "/dashboard/#{DASHBOARD_ID}", DASHBOARD_PAYLOAD
+  end
+
+  describe '#get_board' do
+    it_behaves_like 'an api method',
+                    :get_board, [DASHBOARD_ID],
+                    :get, "/dashboard/#{DASHBOARD_ID}"
+  end
+
+  describe '#delete_board' do
+    it_behaves_like 'an api method',
+                    :delete_board, [DASHBOARD_ID],
+                    :delete, "/dashboard/#{DASHBOARD_ID}"
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.32.0
+  version: 1.33.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-10-23 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -28,14 +28,14 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
@@ -102,6 +102,7 @@ files:
 - lib/dogapi/v1/alert.rb
 - lib/dogapi/v1/comment.rb
 - lib/dogapi/v1/dash.rb
+- lib/dogapi/v1/dashboard.rb
 - lib/dogapi/v1/dashboard_list.rb
 - lib/dogapi/v1/embed.rb
 - lib/dogapi/v1/event.rb
@@ -121,6 +122,7 @@ files:
 - spec/integration/common_spec.rb
 - spec/integration/dash_spec.rb
 - spec/integration/dashboard_list_spec.rb
+- spec/integration/dashboard_spec.rb
 - spec/integration/embed_spec.rb
 - spec/integration/event_spec.rb
 - spec/integration/metadata_spec.rb
@@ -165,8 +167,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.1
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: Ruby bindings for Datadog's API
@@ -176,6 +177,7 @@ test_files:
 - spec/integration/common_spec.rb
 - spec/integration/dash_spec.rb
 - spec/integration/dashboard_list_spec.rb
+- spec/integration/dashboard_spec.rb
 - spec/integration/embed_spec.rb
 - spec/integration/event_spec.rb
 - spec/integration/metadata_spec.rb