dogapi 1.34.0 → 1.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cfe067279d23444bbc1c35c0978cab82aa5f2e24ec4fd989c392855f15063a9e
-  data.tar.gz: b8b74019176e0a732eb6800bb57693c54268f2b82a99acc0185b836d3e7cc379
+  metadata.gz: d244a23455c972c66ba9ea1a15da6f23a233f1ccf88792b0660266cf0f41989e
+  data.tar.gz: 5d5a59735ad5c52cb47fb349dcba9da76525a39a04c6fd76941fd5005f1d8e67
 SHA512:
-  metadata.gz: b4f44f988385adaac78e4dff13d4f9dda996848097cc6ca62f445c87f4c4ce7858dd5164ec01f04bbb08ea4f60b12769187d4f818b6733a74dbae7a407a279eb
-  data.tar.gz: 54d88863dd12a3a1b4e7dd3ddeeb017dd9ba245b1d811c65e041608c7b30917fef333ec08204c8cb6f1f1ee870458c28a5a991594fddb21e721d9ad67b1697ab
+  metadata.gz: '059749f5e615aeb4dc4ff5a782cb3e561c0adb8dd0d98ef949b974bd4ee9f7ab0fb2ddf36ddfcd4f2cc69395696290a333c46944e939dfeb6e6e3b62c2361e89'
+  data.tar.gz: c8a256db3095c70a676f7cfcf97ec966afefb5c00853d386da27cecbdbeb2d0ded3967fa99d7518af927112d9e7e42084300a6ce68f7227070405943717b98db

data/.rubocop_todo.yml

@@ -236,6 +236,7 @@ Style/AccessorMethodName:
     - 'lib/dogapi/v1/dash.rb'
     - 'lib/dogapi/v1/embed.rb'
     - 'lib/dogapi/v1/screenboard.rb'
+    - 'lib/dogapi/v1/dashboard.rb'
     - 'lib/dogapi/v1/user.rb'
 
 # Offense count: 1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changes
 
+## 1.35.0 / 2019-03-21
+
+* [FEATURE] Add get_all_boards and support for 'free' layout. See [#171][].
+
 ## 1.34.0 / 2019-03-08
 
 * [FEATURE] Add /integration endpoints. See [#170][], thanks [@davidcpell][].
@@ -230,6 +234,7 @@ This is the last release compatible with Ruby 1.8. ([EOL 2013-06-30](https://www
 [#165]: https://github.com/DataDog/dogapi-rb/issues/165
 [#167]: https://github.com/DataDog/dogapi-rb/issues/167
 [#170]: https://github.com/DataDog/dogapi-rb/issues/170
+[#171]: https://github.com/DataDog/dogapi-rb/issues/171
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@TaylURRE]: https://github.com/TaylURRE

data/lib/dogapi/facade.rb

@@ -297,6 +297,11 @@ module Dogapi
       @dashboard_service.get_board(dashboard_id)
     end
 
+    # Fetch all dashboards.
+    def get_all_boards()
+      @dashboard_service.get_all_boards()
+    end
+
     # Delete the given dashboard.
     def delete_board(dashboard_id)
       @dashboard_service.delete_board(dashboard_id)

data/lib/dogapi/v1/dashboard.rb

@@ -14,8 +14,8 @@ module Dogapi
       # 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)
+      # :layout_type           => String: Layout type of the dashboard.
+      #                             Allowed values: 'ordered' or 'free'
       # Optional arguments:
       # :description           => String: Description of the dashboard
       # :is_read_only          => Boolean: Whether this dashboard is read-only.
@@ -46,8 +46,8 @@ module Dogapi
       # :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)
+      # :layout_type           => String: Layout type of the dashboard.
+      #                             Allowed values: 'ordered' or 'free'
       # Optional arguments:
       # :description           => String: Description of the dashboard
       # :is_read_only          => Boolean: Whether this dashboard is read-only.
@@ -74,13 +74,20 @@ module Dogapi
 
       # Fetch the given dashboard
       #
+      # Required argument:
       # :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
 
+      # Fetch all custom dashboards
+      def get_all_boards
+        request(Net::HTTP::Get, "/api/#{API_VERSION}/#{RESOURCE_NAME}", nil, nil, false)
+      end
+
       # Delete the given dashboard
       #
+      # Required argument:
       # :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)

data/lib/dogapi/version.rb

@@ -1,3 +1,3 @@
 module Dogapi
-  VERSION = '1.34.0'
+  VERSION = '1.35.0'
 end

data/spec/integration/dashboard_spec.rb

@@ -56,6 +56,12 @@ describe Dogapi::Client do
                     :get, "/dashboard/#{DASHBOARD_ID}"
   end
 
+  describe '#get_all_boards' do
+    it_behaves_like 'an api method',
+                    :get_all_boards, [],
+                    :get, '/dashboard'
+  end
+
   describe '#delete_board' do
     it_behaves_like 'an api method',
                     :delete_board, [DASHBOARD_ID],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.34.0
+  version: 1.35.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json