wavefront-sdk 3.6.1 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b39db1a4f6e5f1899b8ae8f5fef5c2d0364775de94860054101a352b71e6abf4
-  data.tar.gz: a28e17f8e36429c3a954de36baa05ede7ba6a2972d0d30dede00a490fb4a05af
+  metadata.gz: e4f8e6e99d7124c4a1654be470312d6749c475d0cfbc23b33c72962d13fe0e1e
+  data.tar.gz: d2f43cb3bf00ddacce6cd24e92578d9876cfcbfa6b05cbdf6db68a5fbba732d9
 SHA512:
-  metadata.gz: b56fad2f699a16dff96774c857a04b4aad1ad559147bbd50d79b0316c24c0b217e2aa3fdbb5d17aced23b99b1498d820f889003f60cc5287c4389e2fd75d003b
-  data.tar.gz: 0b1bcbc888ebfe63fd96cbcd0c4d8569e22552ad416cdf4dc2bb216f76dc517300daf7954d345d24c253d57250ca5f8d9812545b2619f9199575f84a76b0525d
+  metadata.gz: b01743fb3be2eaa72ff58f857eac4f640354ec6264436e764b0f5852b987a54f16d5fde57235b29b3c7ed5623ebca1894d467da1624f56fb8a185c5becded20c
+  data.tar.gz: 81953b85f6638f802619f8481f70a0e98129f26139ed06d70c28ce100b266dfd13fa1279112698e13a7ecf74364d781608ad3e20feb9c4451ef21070e511516a

data/.rubocop.yml

@@ -1,7 +1,48 @@
 ---
 
 AllCops:
-  TargetRubyVersion: 2.3
+  TargetRubyVersion: 2.4
 
 Metrics/ClassLength:
-  Max: 124
+  Max: 150
+
+# New cops
+#
+Lint/RaiseException:
+  Enabled: true
+Lint/StructNewOverride:
+  Enabled: true
+Style/ExponentialNotation:
+  Enabled: true
+Style/HashEachMethods:
+  Enabled: true
+Style/HashTransformKeys:
+  Enabled: true
+Style/HashTransformValues:
+  Enabled: true
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+Style/SlicingWithRange:
+  Enabled: true
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+Style/RedundantRegexpEscape:
+  Enabled: true
+Style/AccessorGrouping:
+  Enabled: true
+Style/BisectedAttrAccessor:
+  Enabled: true
+Style/RedundantAssignment:
+  Enabled: true
+Style/RedundantFetchBlock:
+  Enabled: true
+
+# Is nothing sacred?
+Layout/LineLength:
+  Max: 80

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 cache: bundler
 rvm:
-  - 2.3.8
   - 2.4.9
   - 2.5.7
   - 2.6.5

data/HISTORY.md

@@ -1,5 +1,38 @@
 # Changelog
 
+## 5.0.1 (2020-07-08)
+* Reinstate `Wavefront::Role#grant` and `Wavefront::Role#revoke`, which were
+  accidentally removed prior to release of 5.0.0.
+
+## 5.0.0 (2020-07-08)
+* Remove `Wavefront::UserGroup#grant` and `Wavefront::UserGroup#revoke` as [the
+ API paths they used have been
+ removed](https://docs.wavefront.com/2020.06.x_release_notes.html#obsolete-and-deprecated-apis).
+ (Breaking change.)
+* Remove `Wavefront::MonitoredCluster` class, as it has been removed from the
+  public API.
+* Deprecate `Wavefront::User` class, as [the user API is now
+  deprecated](https://docs.wavefront.com/2020.06.x_release_notes.html#obsolete-and-deprecated-apis)
+* Add `Wavefront::Role` class, for managing roles.
+* Promote `Wavefront::Spy` class from unstable. It is now an official API.
+
+## 4.0.0 (2020-02-17)
+* Drop support for Ruby 2.3. (Breaking change.)
+* Add `Wavefront::MonitoredCluster` class.
+* Add `Wavefront::Unstable::Spy` class to speak to (undocumented) spy
+  interface.
+* Add `Wavefront::Unstable::Chart` class to speak to (undocumented) chart
+  interface.
+
+## 3.7.1 (2020-02-09)
+* `Response` object returned by `Wavefront::Write#write` includes a valid HTTP
+  code, rather than `nil`.
+
+## 3.7.0 (2020-01-23)
+* Add `Account`, `Usage` and `IngestionPolicy` classes.
+* Allow modification of `Wavefront::Response`'s `response` object.
+* Add `User#validate_users` method.
+
 ## 3.6.1 (2020-01-15)
 * Test build against, and fix warning messages on, Ruby 2.7.0
 

data/README.md

@@ -24,7 +24,7 @@ or to build locally,
 $ gem build wavefront-sdk.gemspec
 ```
 
-`wavefront-sdk` requires Ruby >= 2.3. All its dependencies are pure
+`wavefront-sdk` requires Ruby >= 2.4. All its dependencies are pure
 Ruby, right the way down, so a compiler should never be required to
 install it.
 
@@ -100,10 +100,11 @@ when you ask for a list of objects.
 
 You can set an offset and a limit when you list, but setting the
 limit to the magic value `:all` will return all items, without you
-having to deal with pagination.
+having to deal with pagination. When you do that, `offset` is repurposed as
+the number of results fetched with each call to the API.
 
 Calling a method with the limit set to `:lazy` returns a lazy
-enumerable.
+enumerable. Again, `offset` is the chunk size.
 
 ```ruby
 wf = Wavefront::Alert.new(creds.all)

data/lib/wavefront-sdk/account.rb

@@ -0,0 +1,303 @@
+# frozen_string_literal: true
+
+require_relative 'core/api'
+require_relative 'api_mixins/user'
+
+module Wavefront
+  #
+  # Manage and query Wavefront accounts. '/account/serviceaccount' API paths
+  # are covered in the Wavefront::ServiceAccount class.
+  #
+  # Many of these methods are duplicated in the User class. This reflects the
+  # layout of the API.
+  #
+  class Account < CoreApi
+    include Wavefront::Mixin::User
+    #
+    # GET /api/v2/account
+    # Get all accounts (users and service accounts) of a customer
+    # @param offset [Int] account at which the list begins
+    # @param limit [Int] the number of accounts to return
+    # @return [Wavefront::Response]
+    #
+    def list(offset = 0, limit = 100)
+      api.get('', offset: offset, limit: limit)
+    end
+
+    # DELETE /api/v2/account/{id}
+    # Deletes an account (user or service account) identified by id
+    # @param id [String] ID of the account
+    # @return [Wavefront::Response]
+    #
+    def delete(id)
+      wf_account_id?(id)
+      api.delete(id)
+    end
+
+    # GET /api/v2/account/{id}
+    # Get a specific account (user or service account)
+    # @param id [String] ID of the proxy
+    # @return [Wavefront::Response]
+    #
+    def describe(id)
+      wf_account_id?(id)
+      api.get(id)
+    end
+
+    # POST /api/v2/account/{id}/addRoles
+    # Add specific roles to the account (user or service account)
+    # @param id [String] ID of the account
+    # @param role_list [Array[String]] list of roles to add
+    # @return [Wavefront::Response]
+    #
+    def add_roles(id, role_list)
+      wf_account_id?(id)
+      validate_role_list(role_list)
+      api.post([id, 'addRoles'].uri_concat, role_list, 'application/json')
+    end
+
+    # POST /api/v2/account/{id}/addUserGroups
+    # Adds specific user groups to the account (user or service account)
+    # @param id [String] ID of the account
+    # @param group_list [Array[String]] list of groups to add
+    # @return [Wavefront::Response]
+    #
+    def add_user_groups(id, group_list)
+      wf_account_id?(id)
+      validate_usergroup_list(group_list)
+      api.post([id, 'addUserGroups'].uri_concat, group_list,
+               'application/json')
+    end
+
+    # GET /api/v2/account/{id}/businessFunctions
+    # Returns business functions of a specific account (user or service
+    # account).
+    # @param id [String] user ID
+    # @return [Wavefront::Response]
+    #
+    def business_functions(id)
+      wf_account_id?(id)
+      api.get([id, 'businessFunctions'].uri_concat)
+    end
+
+    # POST /api/v2/account/{id}/removeRoles
+    # Removes specific roles from the account (user or service account)
+    # @param id [String] ID of the account
+    # @param role_list [Array[String]] list of roles to remove
+    # @return [Wavefront::Response]
+    #
+    def remove_roles(id, role_list)
+      wf_account_id?(id)
+      validate_role_list(role_list)
+      api.post([id, 'removeRoles'].uri_concat, role_list, 'application/json')
+    end
+
+    # POST /api/v2/account/{id}/removeUserGroups
+    # Removes specific user groups from the account (user or service account)
+    # @param id [String] ID of the account
+    # @param group_list [Array[String]] list of groups to remove
+    # @return [Wavefront::Response]
+    #
+    def remove_user_groups(id, group_list)
+      wf_account_id?(id)
+      validate_usergroup_list(group_list)
+      api.post([id, 'removeUserGroups'].uri_concat, group_list,
+               'application/json')
+    end
+
+    # POST /api/v2/account/{id}/grant/{permission}
+    # Grants a specific permission to account (user or service account)
+    # POST /api/v2/account/grant/{permission}
+    # Grants a specific permission to multiple accounts (users or service
+    # accounts)
+    # @param id_list [Array[String],String] single account ID or list of
+    #   account IDs
+    # @param permission [String] permission group to grant to user.
+    # @return [Wavefront::Response]
+    #
+    def grant(id, permission)
+      if id.is_a?(String)
+        grant_to_id(id, permission)
+      else
+        grant_to_multiple(id, permission)
+      end
+    end
+
+    # POST /api/v2/account/{id}/revoke/{permission}
+    # Revokes a specific permission from account (user or service account)
+    # POST /api/v2/account/revoke/{permission}
+    # Revokes a specific permission from multiple accounts (users or service
+    # accounts
+    # @param id [String,Array[String]] ID of the user, or list of user IDs
+    # @param permission [String] permission group to revoke from user.
+    # @return [Wavefront::Response]
+    #
+    def revoke(id, permission)
+      if id.is_a?(String)
+        revoke_from_id(id, permission)
+      else
+        revoke_from_multiple(id, permission)
+      end
+    end
+
+    # POST /api/v2/account/addingestionpolicy
+    # Add a specific ingestion policy to multiple accounts
+    # @param policy_id [String] ID of the ingestion policy
+    # @param id_list [Array[String]] list of accounts to be put in policy
+    # @return [Wavefront::Response]
+    #
+    def add_ingestion_policy(policy_id, id_list)
+      wf_ingestionpolicy_id?(policy_id)
+      validate_account_list(id_list)
+      api.post('addingestionpolicy',
+               { ingestionPolicyId: policy_id,
+                 accounts: id_list },
+               'application/json')
+    end
+
+    # POST /api/v2/account/removeingestionpolicies
+    # Removes ingestion policies from multiple accounts. The API path says
+    # "policies" but I've made the method name "policy" for consistency.
+    # @param policy_id [String] ID of the ingestion policy
+    # @param id_list [Array[String]] list of accounts to be put in policy
+    # @return [Wavefront::Response]
+    #
+    def remove_ingestion_policy(policy_id, id_list)
+      wf_ingestionpolicy_id?(policy_id)
+      validate_account_list(id_list)
+      api.post('removeingestionpolicies',
+               { ingestionPolicyId: policy_id,
+                 accounts: id_list },
+               'application/json')
+    end
+
+    # POST /api/v2/account/deleteAccounts
+    # Deletes multiple accounts (users or service accounts)
+    # @param id [String] ID of the account
+    # @param group_list [Array[String]] list of accounts to delete
+    # @return [Wavefront::Response]
+    #
+    def delete_accounts(id_list)
+      validate_account_list(id_list)
+      api.post('deleteAccounts', id_list, 'application/json')
+    end
+
+    # GET /api/v2/account/user
+    # Get all user accounts
+    # @param offset [Int] user account at which the list begins
+    # @param limit [Int] the number of user accounts to return
+    # @return [Wavefront::Response]
+    #
+    def user_list(offset = 0, limit = 100)
+      api.get('user', offset: offset, limit: limit)
+    end
+
+    def user_create(body, send_email = false)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      uri = send_email ? "?sendEmail=#{send_email}" : 'user'
+
+      api.post(uri, body, 'application/json')
+    end
+
+    # POST /api/v2/account/user
+    # Creates or updates a user account
+    # @param id [String] a Wavefront user ID
+    # @param body [Hash] key-value hash of the parameters you wish to change
+    # @param modify [true, false] if true, use {#describe()} to get a hash
+    #   describing the existing object, and modify that with the new body. If
+    #   false, pass the new body straight through.
+    # @return [Wavefront::Response]
+    def user_update(body, modify = true)
+      raise ArgumentError unless body.is_a?(Hash)
+
+      return api.post('user', body, 'application/json') unless modify
+
+      api.post('user',
+               hash_for_update(describe(id).response, body),
+               'application/json')
+    end
+
+    # GET /api/v2/account/user/{id}
+    # Retrieves a user by identifier (email address)
+    # @param id [String] ID of the proxy
+    # @return [Wavefront::Response]
+    #
+    def user_describe(id)
+      wf_user_id?(id)
+      api.get(['user', id].uri_concat)
+    end
+
+    # POST /api/v2/account/user/invite
+    # Invite user accounts with given user groups and permissions.
+    # @param body [Array[Hash]] array of hashes, each hash describing a user.
+    #   See API docs for more details. It is your responsibility to validate
+    #   the data which describes each user.
+    # @return [Wavefront::Response]
+    #
+    def user_invite(body)
+      raise ArgumentError unless body.is_a?(Array)
+      raise ArgumentError unless body.first.is_a?(Hash)
+
+      api.post('user/invite', body, 'application/json')
+    end
+
+    # POST /api/v2/account/validateAccounts
+    # Returns valid accounts (users and service accounts), also invalid
+    # identifiers from the given list
+    # @param id_list [Array[String]] list of user IDs
+    # @return [Wavefront::Response]
+    #
+    def validate_accounts(id_list)
+      raise ArgumentError unless id_list.is_a?(Array)
+
+      api.post('validateAccounts', id_list, 'application/json')
+    end
+
+    private
+
+    # @param id [String] ID of the user
+    # @param permission [String] permission group to grant to user.
+    # @return [Wavefront::Response]
+    #
+    def grant_to_id(id, permission)
+      wf_account_id?(id)
+      wf_permission?(permission)
+      api.post([id, 'grant', permission].uri_concat)
+    end
+
+    # @param id_list [Array[String]] list of account IDs
+    # @param permission [String] permission group to grant to user.
+    # @return [Wavefront::Response]
+    #
+    def grant_to_multiple(id_list, permission)
+      validate_account_list(id_list)
+      wf_permission?(permission)
+      api.post(['grant', permission].uri_concat, id_list, 'application/json')
+    end
+
+    # @param id [String] ID of the user
+    # @param permission [String] permission group to revoke from user.
+    # @return [Wavefront::Response]
+    #
+    def revoke_from_id(id, permission)
+      wf_account_id?(id)
+      wf_permission?(permission)
+      api.post([id, 'revoke', permission].uri_concat)
+    end
+
+    # @param id_list [Array[String]] list of account IDs
+    # @param permission [String] permission group to revoke from user.
+    # @return [Wavefront::Response]
+    #
+    def revoke_from_multiple(id_list, permission)
+      validate_account_list(id_list)
+      wf_permission?(permission)
+      api.post(['revoke', permission].uri_concat, id_list, 'application/json')
+    end
+
+    def update_keys
+      %i[identifier groups userGroups roles ingestionPolicyId]
+    end
+  end
+end

data/lib/wavefront-sdk/api_mixins/user.rb

@@ -25,6 +25,26 @@ module Wavefront
 
         list.each { |id| wf_usergroup_id?(id) }
       end
+
+      # Validate a list of accounts.
+      # @param list [Array[String]] list of account IDs
+      # @raise Wavefront::Exception::InvalidAccount
+      #
+      def validate_account_list(list)
+        raise ArgumentError unless list.is_a?(Array)
+
+        list.each { |id| wf_account_id?(id) }
+      end
+
+      # Validate a list of roles
+      # @param list [Array[String]] list of role IDs
+      # @raise Wavefront::Exception::InvalidRole
+      #
+      def validate_role_list(list)
+        raise ArgumentError unless list.is_a?(Array)
+
+        list.each { |id| wf_role_id?(id) }
+      end
     end
   end
 end