auth0 4.0.0 → 4.1.0

data/lib/auth0/api/v2/rules.rb

@@ -10,10 +10,10 @@ module Auth0
         # The rule's stage of executing could be set to the following values login_success,
         # login_failure or pre_authorize
         # @see https://auth0.com/docs/api/v2#!/Rules/get_rules
-        # @param enabled [boolean]  If provided retrieves rules that match the value, otherwise all rules are retrieved
+        # @param enabled [boolean] If provided retrieves rules that match the value, otherwise all rules are retrieved.
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean]  If the fields specified are to be included in the result, false otherwise
-        # @param stage [string]  Retrieves rules that match the execution stage (defaults to login_success)
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
+        # @param stage [string] Retrieves rules that match the execution stage (defaults to login_success).
         #
         # @return [json] Returns the existing rules.
         def rules(enabled: nil, fields: nil, include_fields: nil, stage: nil)
@@ -26,17 +26,17 @@ module Auth0
           get(rules_path, request_params)
         end
 
-        alias_method :get_rules, :rules
+        alias get_rules rules
 
         # Retrieves a rule by its ID. Accepts a list of fields to include or exclude in the result.
         # @see https://auth0.com/docs/api/v2#!/Rules/get_rules_by_id
-        # @param rule_id [string]   The id of the rule to retrieve
+        # @param rule_id [string] The id of the rule to retrieve.
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean]  If the fields specified are to be included in the result, false otherwise
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         #
         # @return [json] Returns the rule.
         def rule(rule_id, fields: nil, include_fields: nil)
-          fail Auth0::InvalidParameter, 'Must supply a valid rule id' if rule_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid rule id' if rule_id.to_s.empty?
           path = "#{rules_path}/#{rule_id}"
           request_params = {
             fields:   fields,
@@ -45,22 +45,22 @@ module Auth0
           get(path, request_params)
         end
 
-        alias_method :get_rule, :rule
+        alias get_rule rule
 
         # Creates a new rule according to the JSON object received in body.
         # @see https://auth0.com/docs/api/v2#!/Rules/post_rules
-        # @param name [string]   The name of the rule. Can only contain alphanumeric characters, spaces and '-'.
-        # @param script [string] A script that contains the rule's code
+        # @param name [string] The name of the rule. Can only contain alphanumeric characters, spaces and '-'.
+        # @param script [string] A script that contains the rule's code.
         # @param order [integer] The rule's order in relation to other rules. A rule with a lower order than another rule
-        # executes first. If no order is provided it will automatically be one greater than the current maximum
-        # @param enabled [string] true if the rule is enabled, false otherwise
+        # executes first. If no order is provided it will automatically be one greater than the current maximum.
+        # @param enabled [string] True if the rule is enabled, false otherwise.
         # @param stage [string] The rule's execution stage 'login_success' or 'login_failure' or 'pre_authorize' or
-        # 'user_registration' or 'user_blocked'
+        # 'user_registration' or 'user_blocked'.
         #
-        # @return [json] Returns the rule.
+        # @return [json] Returns the created rule.
         def create_rule(name, script, order = nil, enabled = true, stage = 'login_success')
-          fail Auth0::InvalidParameter, 'Must supply a valid name' if name.to_s.empty?
-          fail Auth0::InvalidParameter, 'Must supply a valid script' if script.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid name' if name.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid script' if script.to_s.empty?
           request_params = {
             name: name,
             enabled: enabled,
@@ -73,11 +73,12 @@ module Auth0
 
         # Updates a rule.
         # @see https://auth0.com/docs/api/v2#!/Rules/patch_rules_by_id
-        # @param rule_id [string] The id of the rule to retrieve
+        # @param rule_id [string] The id of the rule to retrieve.
         # @param fields_to_update [hash] The Hash fields_to_update used to define the rule's properties.
+        #
         # @return [json] Returns the updated rule.
         def update_rule(rule_id, fields_to_update = {})
-          fail Auth0::InvalidParameter, 'Must supply a valid rule id' if rule_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid rule id' if rule_id.to_s.empty?
 
           path = "#{rules_path}/#{rule_id}"
           patch(path, fields_to_update)
@@ -85,9 +86,9 @@ module Auth0
 
         # Deletes a rule.
         # @see https://auth0.com/docs/api/v2#!/Rules/delete_rules_by_id
-        # @param rule_id [string] The id of the rule to retrieve
+        # @param rule_id [string] The id of the rule to delete.
         def delete_rule(rule_id)
-          fail Auth0::InvalidParameter, 'Must supply a valid rule id' if rule_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid rule id' if rule_id.to_s.empty?
           path = "#{rules_path}/#{rule_id}"
           delete(path)
         end

data/lib/auth0/api/v2/stats.rb

@@ -8,7 +8,7 @@ module Auth0
         # Gets the active users count (logged in during the last 30 days).
         # @see https://auth0.com/docs/api/v2#!/Stats/get_active_users
         #
-        # @return [integer] Returns numbers
+        # @return [integer] Returns the active users count.
         def active_users
           path = "#{stats_path}/active-users"
           get(path)
@@ -16,7 +16,7 @@ module Auth0
 
         # Gets the daily stats for a particular period.
         # @see https://auth0.com/docs/api/v2#!/Stats/get_daily
-        # @param from [string]  The first day of the period (inclusive) in YYYYMMDD format.
+        # @param from [string] The first day of the period (inclusive) in YYYYMMDD format.
         # @param to [string] The last day of the period (inclusive) in YYYYMMDD format.
         #
         # @return [json] Returns the daily stats.

data/lib/auth0/api/v2/tenants.rb

@@ -8,7 +8,8 @@ module Auth0
         # Gets tenants settings.
         # @see https://auth0.com/docs/api/v2#!/Tenants/get_settings
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] If the fields specified are to be included in the result, false otherwise
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
+        #
         # @return [json] Returns tenants settings.
         def get_tenant_settings(fields: nil, include_fields: true)
           request_params = {
@@ -20,10 +21,11 @@ module Auth0
 
         # Updates tenants settings.
         # @see https://auth0.com/docs/api/v2#!/Tenants/patch_settings
-        # @param body [hash] The Hash body used to define the tenants settings's properties.
-        # @return [json] Returns updated tenants settings.
+        # @param body [hash] The Hash body used to define the tenant settings' values.
+        #
+        # @return [json] Returns the updated tenant settings.
         def update_tenant_settings(body)
-          fail Auth0::InvalidParameter, 'Must supply a valid body to update tenant settings' if body.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body to update tenant settings' if body.to_s.empty?
           patch(tenant_path, body)
         end
 

data/lib/auth0/api/v2/tickets.rb

@@ -7,12 +7,13 @@ module Auth0
 
         # Create an email verification ticket
         # @see https://auth0.com/docs/api/v2#!/Tickets/post_email_verification
-        # @param user_id [string] The user_id of for which the ticket is to be created
-        # @param result_url [string] The user will be redirected to this endpoint once the ticket is used
-        # @return [json] Returns ticket url
+        # @param user_id [string] The user_id of for which the ticket is to be created.
+        # @param result_url [string] The user will be redirected to this endpoint once the ticket is used.
+        #
+        # @return [json] Returns the created ticket url.
         def post_email_verification(user_id, result_url: nil)
           if user_id.to_s.empty?
-            fail Auth0::InvalidParameter, 'Must supply a valid user id to post an email verification'
+            raise Auth0::InvalidParameter, 'Must supply a valid user id to post an email verification'
           end
           path = "#{tickets_path}/email-verification"
           request_params = {
@@ -24,17 +25,15 @@ module Auth0
 
         # Create a password change ticket
         # @see https://auth0.com/docs/api/v2#!/Tickets/post_password_change
-        # @param new_password [string] The password to set for the user once the ticket is used
-        # @param user_id [string] The user_id of for which the ticket is to be created
-        # @param result_url [string] The user will be redirected to this endpoint once the ticket is used
+        # @param new_password [string] The password to be set for the user once the ticket is used.
+        # @param user_id [string] The user_id of for which the ticket is to be created.
+        # @param result_url [string] The user will be redirected to this endpoint once the ticket is used.
         # @param connection_id [string] The connection that provides the identity for which the password is to be
-        # changed. If sending this parameter, the email is also required and the user_id is invalid
-        # @param email [string] The user's email
-        # @return [json] Returns ticket url
-        def post_password_change(new_password, user_id: nil, result_url: nil, connection_id: nil, email: nil)
-          if new_password.to_s.empty?
-            fail Auth0::InvalidParameter, 'Must supply a valid new password to post a password-change'
-          end
+        # changed. If sending this parameter, the email is also required and the user_id is invalid.
+        # @param email [string] The user's email.
+        #
+        # @return [json] Returns the created ticket url.
+        def post_password_change(new_password: nil, user_id: nil, result_url: nil, connection_id: nil, email: nil)
           path = "#{tickets_path}/password-change"
           request_params = {
             user_id: user_id,

data/lib/auth0/api/v2/user_blocks.rb

@@ -0,0 +1,62 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the User Blocks endpoints
+      module UserBlocks
+        attr_reader :user_blocks_path
+
+        # Retrieves the user blocks
+        # @see https://auth0.com/docs/api/management/v2#!/User_Blocks/get_user_blocks
+        # @param identifier [string]  Should be any of: username, phone_number, email.
+        #
+        # @return [json] the user blocks
+        def user_blocks(identifier)
+          raise Auth0::InvalidParameter, 'Must specify a valid identifier' if identifier.to_s.empty?
+          request_params = {
+            identifier: identifier
+          }
+          get(user_blocks_path, request_params)
+        end
+
+        # Deletes the user blocks
+        # @see https://auth0.com/docs/api/management/v2#!/User_Blocks/delete_user_blocks
+        # @param identifier [string]  Should be any of: username, phone_number, email.
+        def delete_user_blocks(identifier)
+          raise Auth0::InvalidParameter, 'Must specify a valid identifier' if identifier.to_s.empty?
+          # path = "#{user_blocks_path}?identifier=#{identifier}"
+          request_params = {
+            identifier: identifier
+          }
+          delete(user_blocks_path, request_params)
+        end
+
+        # Retrieves a user's blocks
+        # @see https://auth0.com/docs/api/management/v2#!/User_Blocks/get_user_blocks_by_id
+        # @param user_id [string]  The user_id of the user to retrieve
+        #
+        # @return [json] the user blocks
+        def user_blocks_by_id(user_id)
+          raise Auth0::InvalidParameter, 'Must specify a valid identifier' if user_id.to_s.empty?
+          path = "#{user_blocks_path}/#{user_id}"
+          get(path)
+        end
+
+        # Deletes a user's blocks
+        # @see https://auth0.com/docs/api/management/v2#!/User_Blocks/delete_user_blocks_by_id
+        # @param user_id [string]  The user_id of the user to retrieve
+        def delete_user_blocks_by_id(user_id)
+          raise Auth0::InvalidParameter, 'Must specify a valid identifier' if user_id.to_s.empty?
+          path = "#{user_blocks_path}/#{user_id}"
+          delete(path)
+        end
+
+        private
+
+        # User Blocks API path
+        def user_blocks_path
+          @user_blocks_path ||= '/api/v2/user-blocks'
+        end
+      end
+    end
+  end
+end

data/lib/auth0/api/v2/users.rb

@@ -7,17 +7,17 @@ module Auth0
 
         # Retrieves a list of existing users.
         # @see https://auth0.com/docs/api/v2#!/Users/get_users
-        # @param per_page [integer] The amount of entries per page. Default: 50. Max value: 100
-        # @param page [integer]  The page number. Zero based
-        # @param include_totals [boolean] true if a query summary must be included in the result
-        # @param sort [string] The field to use for sorting. 1 == ascending and -1 == descending
-        # @param connection [string] Connection filter
+        # @param per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
+        # @param page [integer]  The page number. Zero based.
+        # @param include_totals [boolean] True if a query summary must be included in the result.
+        # @param sort [string] The field to use for sorting. 1 == ascending and -1 == descending.
+        # @param connection [string] Connection filter.
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] if the fields specified are to be included in the result, false otherwise.
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         # @param q [string] Query in Lucene query string syntax. Only fields in app_metadata, user_metadata or the
         # normalized user profile are searchable.
         #
-        # @return [json] The list of existing users.
+        # @return [json] Returns the list of existing users.
         def users(options = {})
           request_params = {
             per_page:       options.fetch(:per_page, nil),
@@ -32,16 +32,16 @@ module Auth0
           request_params[:search_engine] = :v2 if request_params[:q]
           get(users_path, request_params)
         end
-        alias_method :get_users, :users
+        alias get_users users
 
         # Creates a new user according to optional parameters received.
         # The attribute connection is always mandatory but depending on the type of connection you are using there
         # could be others too. For instance, Auth0 DB Connections require email and password.
         # @see https://auth0.com/docs/api/v2#!/Users/post_users
-        # @param name [string] the user name
-        # @param connection [string] The connection the user belongs to
+        # @param name [string] The user name.
+        # @param connection [string] The connection the user belongs to.
         #
-        # @return [json]
+        # @return [json] Returns the created user.
         def create_user(name, options = {})
           request_params = Hash[options.map { |(k, v)| [k.to_sym, v] }]
           request_params[:name] = name
@@ -56,13 +56,13 @@ module Auth0
 
         # Retrieves a user given a user_id
         # @see https://auth0.com/docs/api/v2#!/Users/get_users_by_id
-        # @param user_id [string] The user_id of the user to retrieve
+        # @param user_id [string] The user_id of the user to retrieve.
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] if the fields specified are to be included in the result, false otherwise.
+        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         #
-        # @return [json] the user with the given user_id if exists
+        # @return [json] Returns the user with the given user_id if it exists.
         def user(user_id, fields: nil, include_fields: true)
-          fail Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
           path = "#{users_path}/#{user_id}"
           request_params = {
             fields:         fields,
@@ -73,9 +73,9 @@ module Auth0
 
         # Deletes a single user given its id
         # @see https://auth0.com/docs/api/v2#!/Users/delete_users_by_id
-        # @param user_id [string] The user_id of the user to delete
+        # @param user_id [string] The user_id of the user to delete.
         def delete_user(user_id)
-          fail Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
           path = "#{users_path}/#{user_id}"
           delete(path)
         end
@@ -93,23 +93,23 @@ module Auth0
         # If your are updating email or phone_number you need to specify the connection and the client_id properties.
         # @see https://auth0.com/docs/api/v2#!/Users/patch_users_by_id
         # @param user_id [string] The user_id of the user to update.
-        # @param body [hash] The optional parametes to update
+        # @param body [hash] The optional parametes to update.
         #
-        # @return [json] the updated user
+        # @return [json] Returns the updated user.
         def patch_user(user_id, body)
-          fail Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
-          fail Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
           path = "#{users_path}/#{user_id}"
           patch(path, body)
         end
 
         # Delete a user's multifactor provider
         # @see https://auth0.com/docs/api/v2#!/Users/delete_multifactor_by_provider
-        # @param user_id [string] The user_id of the user to delete
-        # @param provider_name [string] The multifactor provider. Supported values 'duo' or 'google-authenticator'
+        # @param user_id [string] The user_id of the user to delete the multifactor provider from.
+        # @param provider_name [string] The multifactor provider. Supported values 'duo' or 'google-authenticator'.
         def delete_user_provider(user_id, provider_name)
-          fail Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
-          fail Auth0::InvalidParameter, 'Must supply a valid provider name' if provider_name.to_s.empty?
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid provider name' if provider_name.to_s.empty?
           path = "#{users_path}/#{user_id}/multifactor/#{provider_name}"
           delete(path)
         end
@@ -126,10 +126,10 @@ module Auth0
         # @param user_id [string] The user_id of the primary identity where you are linking the secondary account to.
         # @param body [string] the options to link the account to.
         #
-        # @return [json] the new array of the primary account identities.
+        # @return [json] Returns the new array of the primary account identities.
         def link_user_account(user_id, body)
-          fail Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
-          fail Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
           path = "#{users_path}/#{user_id}/identities"
           post(path, body)
         end
@@ -140,15 +140,46 @@ module Auth0
         # @param provider [string] The type of identity provider.
         # @param secondary_user_id [string] The unique identifier for the user for the identity.
         #
-        # @return [json] the array of the unlinked account identities.
+        # @return [json] Returns the array of the unlinked account identities.
         def unlink_users_account(user_id, provider, secondary_user_id)
-          fail Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
-          fail Auth0::MissingUserId, 'Must supply a valid secondary user_id' if secondary_user_id.to_s.empty?
-          fail Auth0::InvalidParameter, 'Must supply a valid provider' if provider.to_s.empty?
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+          raise Auth0::MissingUserId, 'Must supply a valid secondary user_id' if secondary_user_id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid provider' if provider.to_s.empty?
           path = "#{users_path}/#{user_id}/identities/#{provider}/#{secondary_user_id}"
           delete(path)
         end
 
+        # Retrieve every log event for a specific user id
+        # @see https://auth0.com/docs/api/management/v2#!/Users/get_logs_by_user
+        # @param user_id [string] The user_id of the logs to retrieve.
+        # @param per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
+        # @param page [integer]  The page number. Zero based.
+        # @param include_totals [boolean] True if a query summary must be included in the result.
+        # @param sort [string] The field to use for sorting. 1 == ascending and -1 == descending.
+        #
+        # @return [json] Returns the list of existing log entries for the given user_id.
+        # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
+        def user_logs(user_id, options = {})
+          raise Auth0::MissingUserId, 'Must supply a valid user_id' if user_id.to_s.empty?
+          path = "#{users_path}/#{user_id}/logs"
+          request_params = {
+            user_id:        user_id,
+            per_page:       options.fetch(:per_page, nil),
+            page:           options.fetch(:page, nil),
+            include_totals: options.fetch(:include_totals, nil),
+            sort:           options.fetch(:sort, nil)
+          }
+          if request_params[:per_page].to_i > 100
+            raise Auth0::InvalidParameter, 'The total amount of entries per page should be less than 100'
+          end
+          sort_pattern = /^(([a-zA-Z0-9_\.]+))\:(1|-1)$/
+          if !request_params[:sort].nil? && !sort_pattern.match(request_params[:sort])
+            raise Auth0::InvalidParameter, 'Sort does not match pattern ^(([a-zA-Z0-9_\\.]+))\\:(1|-1)$'
+          end
+          get(path, request_params)
+        end
+        alias get_user_log_events user_logs
+
         private
 
         # Users API path

data/lib/auth0/client.rb

@@ -3,7 +3,5 @@ module Auth0
   # All Api calls are suposed to return hashes, but delete actions return strings.
   class Client
     include Auth0::Mixins
-    include HTTMultiParty
-    base_uri 'http://auth0.com'
   end
 end

data/lib/auth0/mixins.rb

@@ -1,6 +1,7 @@
-require 'httmultiparty'
+require 'base64'
+require 'rest-client'
 require 'uri'
-require 'auth0/mixins/httparty_proxy'
+require 'auth0/mixins/httpproxy'
 require 'auth0/mixins/initializer'
 require 'auth0/api/authentication_endpoints'
 require 'auth0/api/v1'
@@ -8,7 +9,7 @@ require 'auth0/api/v2'
 module Auth0
   # Collecting dependencies here
   module Mixins
-    include Auth0::Mixins::HTTPartyProxy
+    include Auth0::Mixins::HTTPProxy
     include Auth0::Mixins::Initializer
   end
 end

data/lib/auth0/mixins/httpproxy.rb

@@ -0,0 +1,55 @@
+module Auth0
+  module Mixins
+    # here's the proxy for Rest calls based on rest-client, we're building all request on that gem
+    # for now, if you want to feel free to use your own http client
+    module HTTPProxy
+      attr_accessor :headers, :base_uri, :timeout
+
+      # proxying requests from instance methods to HTTP class methods
+      %i(get post post_file put patch delete).each do |method|
+        define_method(method) do |path, body = {}|
+          safe_path = URI.escape(path)
+          body = body.delete_if { |_, v| v.nil? }
+          result = if [:get, :delete].include?(method)
+                     call(method, url(safe_path), timeout, add_headers(params: body))
+                   elsif method == :post_file
+                     call(:post, url(safe_path), timeout, headers, body)
+                   else
+                     call(method, url(safe_path), timeout, headers, body.to_json)
+                   end
+          case result.code
+          when 200...226 then safe_parse_json(result.body)
+          when 400       then raise Auth0::BadRequest, result.to_s
+          when 401       then raise Auth0::Unauthorized, result.body
+          when 403       then raise Auth0::AccessDenied, result.body
+          when 404       then raise Auth0::NotFound, result.body
+          when 500       then raise Auth0::ServerError, result.body
+          else                raise Auth0::Unsupported, result.body
+          end
+        end
+      end
+
+      def url(path)
+        "#{base_uri}#{path}"
+      end
+
+      def add_headers(h = {})
+        raise ArgumentError, 'Headers must be an object which responds to #to_hash' unless h.respond_to?(:to_hash)
+        @headers ||= {}
+        @headers.merge!(h.to_hash)
+      end
+
+      def safe_parse_json(body)
+        JSON.parse(body.to_s)
+      rescue JSON::ParserError
+        body
+      end
+
+      def call(method, url, timeout, headers, body = nil)
+        RestClient::Request.execute(method: method, url: url, timeout: timeout, headers: headers, payload: body)
+      rescue RestClient::Exception => e
+        e.response
+      end
+    end
+  end
+end