dogapi 1.20.0 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4468399eb2562412f21f437bac47ce6eee96d64
-  data.tar.gz: 02b6507f392f7fdfa051104d466b0378841570fa
+  metadata.gz: ca850c71e9c22f3b3b5c8ddfa2eb6eda2174807e
+  data.tar.gz: 4a6dff6932e1a05e3acb6a4af3dacd0cc3a1cf51
 SHA512:
-  metadata.gz: 249b343d68784129d73fadebe8622e73eb2401d5f62f294007cdd7152ae01d1e0461b4eaafc4263d005d71b65f4632abb7e9bd63cd00eec47a9fe06254264ad8
-  data.tar.gz: 8170e19e1531983963a4ec44273838d30c8a31b249f192b3b4ba80cd1acd5d3e90caf038f23539c7718dbbcccf8a2ca6f95af084399405c74cdc4733ae5ea3af
+  metadata.gz: 5fe2e6a80a0a60cf838e235bf00e82675638783bd05cb63012d89d5cc5c6babf9873a012bd6bb075343073a3e35ef74af21d35e1244eb7f26c9cca401aec3ca7
+  data.tar.gz: 34df781325d7bbdd49454e6e7681a932c8282d9992a74ae65d5725f1429d3aa39c91ff99a9fa884c4d02b95184dff5805cb68d4bee4b8b2f2e35bac2c84c2e6d

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 Changes
 =======
 
+# 1.21.0 / Unreleased
+* [FEATURE] User CRUD API. See [#82][]
+* [IMPROVEMENT] Support capistrano SimpleTextFormatter (thanks [@rmoriz][] [#81][])
+
 # 1.20.0 / 2015-07-29
 * [FEATURE] Embeddable graphs API. See [#73][]
 
@@ -134,6 +138,9 @@ Changes
 [#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
+[#81]: https://github.com/DataDog/dogapi-rb/issues/81
+[#82]: https://github.com/DataDog/dogapi-rb/issues/82
+
 [@ArjenSchwarz]: https://github.com/ArjenSchwarz
 [@Kaixiang]: https://github.com/Kaixiang
 [@ansel1]: https://github.com/ansel1
@@ -142,3 +149,4 @@ Changes
 [@treeder]: https://github.com/treeder
 [@winebarrel]: https://github.com/winebarrel
 [@yyuu]: https://github.com/yyuu
+[@rmoriz]: https://github.com/rmoriz

data/lib/capistrano/datadog/v3.rb

@@ -1,5 +1,6 @@
 require "benchmark"
 require "sshkit/formatters/pretty"
+require "sshkit/formatters/simple_text"
 
 # Capistrano v3 uses Rake's DSL instead of its own
 
@@ -48,6 +49,12 @@ module SSHKit
         super(Capistrano::Datadog::CaptureIO.new(oio))
       end
     end
+
+    class SimpleText
+      def initialize(oio)
+        super(Capistrano::Datadog::CaptureIO.new(oio))
+      end
+    end
   end
 end
 

data/lib/dogapi/facade.rb

@@ -291,6 +291,26 @@ module Dogapi
       @user_svc.invite(emails, options)
     end
 
+    def create_user(description = {})
+      @user_svc.create_user(description)
+    end
+
+    def get_all_users()
+      @user_svc.get_all_users()
+    end
+
+    def get_user(handle)
+      @user_svc.get_user(handle)
+    end
+
+    def update_user(handle, description = {})
+      @user_svc.update_user(handle, description)
+    end
+
+    def disable_user(handle)
+      @user_svc.disable_user(handle)
+    end
+
     # Graph snapshot
     def graph_snapshot(metric_query, start_ts, end_ts, event_query = nil)
       @snapshot_svc.snapshot(metric_query, start_ts, end_ts, event_query)

data/lib/dogapi/v1/user.rb

@@ -7,7 +7,10 @@ module Dogapi
 
       API_VERSION = "v1"
 
+      # <b>DEPRECATED:</b> Going forward, we're using a new and more restful API,
+      # the new methods are get_user, create_user, update_user, disable_user
       def invite(emails, options = {})
+        warn "[DEPRECATION] Dogapi::V1::UserService::invite has been deprecated in favor of Dogapi::V1::UserService::create_user"
         begin
           params = {
             :api_key => @api_key,
@@ -23,6 +26,87 @@ module Dogapi
           suppress_error_if_silent e
         end
       end
+
+      # Create a user
+      #
+      # :description => Hash: user description containing 'handle' and 'name' properties
+      def create_user(description = {})
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Post, "/api/#{API_VERSION}/user", params, description, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Retrieve user information
+      #
+      # :handle => String: user handle
+      def get_user(handle)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/user/#{handle}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Retrieve all users
+      def get_all_users()
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Get, "/api/#{API_VERSION}/user", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Update a user
+      #
+      # :handle => String: user handle
+      # :description => Hash: user description optionally containing 'name', 'email',
+      # 'is_admin', 'disabled' properties
+      def update_user(handle, description = {})
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Put, "/api/#{API_VERSION}/user/#{handle}", params, description, true)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
+      # Disable a user
+      #
+      # :handle => String: user handle
+      def disable_user(handle)
+        begin
+          params = {
+            :api_key => @api_key,
+            :application_key => @application_key
+          }
+
+          request(Net::HTTP::Delete, "/api/#{API_VERSION}/user/#{handle}", params, nil, false)
+        rescue Exception => e
+          suppress_error_if_silent e
+        end
+      end
+
     end
 
   end

data/lib/dogapi/version.rb

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

data/tests/test_monitors.rb

@@ -107,7 +107,7 @@ class TestAlerts < Test::Unit::TestCase
 
     # We shouldn't be able to mute a simple alert on a scope.
     status, _ = dog.mute_monitor(monitor_id, :scope => 'env:staging')
-    assert_equal status.to_i, 403, status.to_i
+    assert_equal status.to_i, 400, status.to_i
 
     query2 = 'avg(last_1h):sum:system.net.bytes_rcvd{*} by {host} > 100'
     monitor_id = dog.monitor('metric alert', query2)[1]['id']

data/tests/test_users.rb

@@ -8,9 +8,58 @@ class TestUsers < Test::Unit::TestCase
   def test_users
     dog = Dogapi::Client.new(@api_key, @app_key)
 
+    # user invite (deprecated)
     emails = ["notarealperson@datadoghq.com", "alsoreallyfake@datadoghq.com"]
 
     invited = dog.invite(emails)
     assert_equal emails, invited[1]["emails"], invited
+
+    # user CRUD
+    handle = 'user@test.com'
+    name = 'Test User'
+    alternate_name = 'Test User Alt'
+    alternate_email = 'user+1@test.com'
+
+    # test create user
+    # the user might already exist
+    dog.create_user({
+        'handle' => handle,
+        'name' => name,
+    })
+
+    # reset user to original status
+    status, res = dog.update_user(handle, {
+        'name' => name,
+        'email' => handle,
+        'disabled' => false,
+    })
+    assert_equal handle, res['user']['handle']
+    assert_equal name, res['user']['name']
+    assert_equal handle, res['user']['email']
+
+    # test get
+    status, res = dog.get_user(handle)
+    assert_equal handle, res['user']['handle']
+
+    # test update user
+    status, res = dog.update_user(handle, {
+        'name' => alternate_name,
+        'email' => alternate_email,
+    })
+    assert_equal handle, res['user']['handle']
+    assert_equal alternate_name, res['user']['name']
+    assert_equal alternate_email, res['user']['email']
+
+    # test disable user
+    status, res = dog.disable_user(handle)
+    assert_equal '200', status
+
+    # test get all users
+    status, res = dog.get_all_users()
+    assert_equal true, res['users'].length >= 1
+
   end
+
+
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dogapi
 version: !ruby/object:Gem::Version
-  version: 1.20.0
+  version: 1.21.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-29 00:00:00.000000000 Z
+date: 2015-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json