auth0 3.6.1 → 4.0.0

data/lib/auth0/api/v1.rb

@@ -1,8 +1,8 @@
-require "auth0/api/v1/users"
-require "auth0/api/v1/clients"
-require "auth0/api/v1/connections"
-require "auth0/api/v1/rules"
-require "auth0/api/v1/logs"
+require 'auth0/api/v1/users'
+require 'auth0/api/v1/clients'
+require 'auth0/api/v1/connections'
+require 'auth0/api/v1/rules'
+require 'auth0/api/v1/logs'
 module Auth0
   # Space for all API calls
   module Api

data/lib/auth0/api/v1/clients.rb

@@ -5,15 +5,15 @@ module Auth0
       module Clients
         # {https://auth0.com/docs/api#!#get--api-clients}
         def clients
-          path = "/api/clients"
+          path = '/api/clients'
           get(path)
         end
 
-        alias :get_clients :clients
+        alias_method :get_clients, :clients
 
         # {https://auth0.com/docs/api#!#post--api-clients}
-        def create_client(name, callbacks="")
-          path = "/api/clients"
+        def create_client(name, callbacks = '')
+          path = '/api/clients'
           request_params = {
             name: name,
             callbacks: callbacks
@@ -23,8 +23,8 @@ module Auth0
 
         # @deprecated use {#patch_client}
         # {https://auth0.com/docs/api#!#put--api-clients--client-id-}
-        def update_client(name, callbacks="", client_id=@client_id)
-          warn "This endpoint has been deprecated in favor of PATCH."
+        def update_client(name, callbacks = '', client_id = @client_id)
+          warn 'This endpoint has been deprecated in favor of PATCH.'
           path = "/api/clients/#{client_id}"
           request_params = {
             name: name,
@@ -34,7 +34,7 @@ module Auth0
         end
 
         # {https://auth0.com/docs/api#!#patch--api-clients--client-id-}
-        def patch_client(name, callbacks="", client_id=@client_id)
+        def patch_client(name, callbacks = '', client_id = @client_id)
           path = "/api/clients/#{client_id}"
           request_params = {
             name: name,

data/lib/auth0/api/v1/connections.rb

@@ -5,39 +5,38 @@ module Auth0
       module Connections
         # {https://auth0.com/docs/api#!#get--api-connections}
         def connections
-          get("/api/connections")
+          get('/api/connections')
         end
-        alias :get_connections :connections
+        alias_method :get_connections, :connections
 
         # {https://auth0.com/docs/api#!#get--api-connections--connection-name-}
         def connection(connection_name)
-          path = "/api/connections/#{connection_name.to_s}"
+          path = "/api/connections/#{connection_name}"
           get(path)
         end
-        alias :get_connection :connection
+        alias_method :get_connection, :connection
 
         # {https://auth0.com/docs/api#!#delete--api-connections--connection-name-}
         def delete_connection(connection_name)
-          path = "/api/connections/#{connection_name.to_s}"
+          path = "/api/connections/#{connection_name}"
           delete(path)
         end
 
         # {https://auth0.com/docs/api#!#post--api-connections}
-        def create_connection(connection_name, strategy, tenant_domain, domain_aliases=nil)
-          path = "/api/connections"
+        def create_connection(connection_name, strategy, tenant_domain, domain_aliases = nil)
+          path = '/api/connections'
           request_params = {
             name: connection_name,
             strategy: strategy,
             options: {
               tenant_domain: tenant_domain,
-              domain_aliases: domain_aliases
-            }
+              domain_aliases: domain_aliases }
           }
           post(path, request_params)
         end
 
         # {https://auth0.com/docs/api#!#put--api-connections--connection-name-}
-        def update_connection(connection_name, tenant_domain, status=true)
+        def update_connection(connection_name, tenant_domain, status = true)
           path = "/api/connections/#{connection_name}"
           request_params = {
             status: status,

data/lib/auth0/api/v1/logs.rb

@@ -3,26 +3,19 @@ module Auth0
     module V1
       # {https://auth0.com/docs/api#logs}
       module Logs
-        # {https://auth0.com/docs/api#!#get--api-logs-page--number--per_page--items--sort--field----1-1--fields--fields--exclude_fields-true-false-}
-        #
-        # {https://auth0.com/docs/api#!#get--api-logs-search--criteria-}
-        #
-        # {https://auth0.com/docs/api#!#get--api-logs-from--checkpointId--take--count-}
-        def logs(options={})
+        # https://auth0.com/docs/api/v1#!#logs
+        def logs(options = {})
           acceptable_params = %i(take from search_criteria page per_page sort fields exclude_fields)
-          options.reject! do |key,value|
-            if key.nil? ||\
-                value.nil? ||\
-                !acceptable_params.include?(key.to_sym)
-              warn "#{key} is not in acceptable params list: #{acceptable_params}"
-              true
-            end
+          options.reject! do |key, value|
+            next unless key.nil? || value.nil? || !acceptable_params.include?(key.to_sym)
+            warn "#{key} is not in acceptable params list: #{acceptable_params}"
+            true
           end
-          path= "/api/logs?"+URI.encode_www_form(options)
+          path = "/api/logs?#{URI.encode_www_form(options)}"
           get(path)
         end
 
-        alias :search_logs :logs
+        alias_method :search_logs, :logs
 
         # {https://auth0.com/docs/api#!#get--api-logs--_id-}
         def log(id)
@@ -31,7 +24,7 @@ module Auth0
         end
 
         # {https://auth0.com/docs/api#!#get--api-users--user_id--logs-page--number--per_page--items-}
-        def user_logs(user_id, page=0, per_page=50)
+        def user_logs(user_id, page = 0, per_page = 50)
           path = "/api/users/#{user_id}/logs?page=#{page}&per_page=#{per_page}"
           get(path)
         end

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

@@ -5,15 +5,15 @@ module Auth0
       module Rules
         # https://auth0.com/docs/api#!#get--api-rules
         def rules
-          path = "/api/rules"
+          path = '/api/rules'
           get(path)
         end
 
-        alias :get_rules :rules
+        alias_method :get_rules, :rules
 
         # https://auth0.com/docs/api#!#post--api-rules
-        def create_rule(name, script, order=nil,status=true)
-          path = "/api/rules"
+        def create_rule(name, script, order = nil, status = true)
+          path = '/api/rules'
           request_params = {
             name: name,
             status: status,
@@ -24,7 +24,7 @@ module Auth0
         end
 
         # https://auth0.com/docs/api#!#put--api-rules--rule-name-
-        def update_rule(name, script, order=nil,status=true)
+        def update_rule(name, script, order = nil, status = true)
           path = "/api/rules/#{name}"
           request_params = {
             status: status,

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

@@ -1,19 +1,20 @@
 module Auth0
   module Api
+    # rubocop:disable Metrics/ModuleLength
     module V1
       # {https://auth0.com/docs/api#users}
       module Users
         # {https://auth0.com/docs/api#!#get--api-users}
         #
         # {https://auth0.com/docs/api#!#get--api-users-search--criteria-}
-        def users(search=nil)
-          path = "/api/users"
-          path += "?search=#{search.to_s}" unless search.to_s.empty?
+        def users(search = nil)
+          path = '/api/users'
+          path += "?search=#{search}" unless search.to_s.empty?
           get(path)
         end
 
-        alias :users_search :users
-        alias :get_users :users
+        alias_method :users_search, :users
+        alias_method :get_users, :users
 
         # {https://auth0.com/docs/api#!#get--api-users--user_id-}
         def user(user_id)
@@ -21,7 +22,7 @@ module Auth0
           get(path)
         end
 
-        alias :get_user :user
+        alias_method :get_user, :user
 
         # {https://auth0.com/docs/api#!#get--api-users--user_id--devices}
         def user_devices(user_id)
@@ -31,37 +32,37 @@ module Auth0
 
         # {https://auth0.com/docs/api#!#get--api-connections--connection--users}
         # {https://auth0.com/docs/api#!#get--api-connections--connection--users-search--criteria-}
-        def connection_users(connection_name, search=nil)
+        def connection_users(connection_name, search = nil)
           path = "/api/connections/#{connection_name}/users"
-          path += "?search=#{search.to_s}" unless search.to_s.empty?
+          path += "?search=#{search}" unless search.to_s.empty?
           get(path)
         end
 
-        alias :search_connection_users :connection_users
+        alias_method :search_connection_users, :connection_users
 
         # {https://auth0.com/docs/api#!#get--api-enterpriseconnections-users-search--criteria-}
-        def enterpriseconnections_users(search_criteria=nil, per_page=500)
-          path = "/api/enterpriseconnections/users?search=#{search_criteria.to_s}&per_page=#{per_page.to_i.to_s}"
+        def enterpriseconnections_users(search_criteria = nil, per_page = 500)
+          path = "/api/enterpriseconnections/users?search=#{search_criteria}&per_page=#{per_page.to_i}"
           get(path)
         end
 
         # {https://auth0.com/docs/api#!#get--api-socialconnections-users-search--criteria-}
-        def socialconnections_users(search_criteria=nil, per_page=500)
-          path =  "/api/socialconnections/users?search=#{search_criteria.to_s}&per_page=#{per_page.to_i.to_s}"
+        def socialconnections_users(search_criteria = nil, per_page = 500)
+          path = "/api/socialconnections/users?search=#{search_criteria}&per_page=#{per_page.to_i}"
           get(path)
         end
 
         # {https://auth0.com/docs/api#!#get--api-clients--client-id--users}
-        def client_users(client_id=@client_id)
+        def client_users(client_id = @client_id)
           path = "/api/clients/#{client_id}/users"
           get(path)
         end
 
         # {https://auth0.com/docs/api#!#post--api-users}
-        def create_user(email, password, connection_name, request_params={})
+        def create_user(email, password, connection_name, request_params = {})
           options = { email: email, password: password, connection: connection_name }
           request_params.merge!(options)
-          path = "/api/users"
+          path = '/api/users'
           post(path, request_params)
         end
 
@@ -72,15 +73,15 @@ module Auth0
         end
 
         # {https://auth0.com/docs/api#!#post--api-users--user_id--change_password_ticket}
-        def change_password_ticket(user_id, new_password, result_url=nil)
-          request_params = { "newPassword" => new_password, "resultUrl" => result_url }
+        def change_password_ticket(user_id, new_password, result_url = nil)
+          request_params = { 'newPassword' => new_password, 'resultUrl' => result_url }
           path = "/api/users/#{user_id}/change_password_ticket"
           post(path, request_params)
         end
 
         # {https://auth0.com/docs/api#!#post--api-users--user_id--verification_ticket}
-        def verification_ticket(user_id, result_url=nil)
-          request_params = {"resultUrl" => result_url}
+        def verification_ticket(user_id, result_url = nil)
+          request_params = { 'resultUrl' => result_url }
           path = "/api/users/#{user_id}/verification_ticket"
           post(path, request_params)
         end
@@ -93,7 +94,7 @@ module Auth0
         end
 
         # {https://auth0.com/docs/api#!#put--api-users--user_id--email}
-        def update_user_email(user_id, email, verify=true)
+        def update_user_email(user_id, email, verify = true)
           path = "/api/users/#{user_id}/email"
           request_params = { email: email, verify: verify }
           put(path, request_params)
@@ -101,20 +102,20 @@ module Auth0
 
         # {https://auth0.com/docs/api#!#put--api-users--user_id--metadata}
         # This will overwrite user's metadata, be really carefull, preffer using patch instead
-        def update_user_metadata(user_id, metadata={})
+        def update_user_metadata(user_id, metadata = {})
           path = "/api/users/#{user_id}/metadata"
           put(path, metadata)
         end
 
         # {https://auth0.com/docs/api#!#put--api-users--user_id--password}
-        def update_user_password(user_id, password, verify=true)
+        def update_user_password(user_id, password, verify = true)
           path = "/api/users/#{user_id}/password"
           request_params = { password: password, verify: verify }
           put(path, request_params)
         end
 
         # {https://auth0.com/docs/api#!#put--api-users--email--password}
-        def update_user_password_using_email(email, password, connection_name, verify=true)
+        def update_user_password_using_email(email, password, connection_name, verify = true)
           request_params = {
             email:      email,
             password:   password,
@@ -126,7 +127,7 @@ module Auth0
         end
 
         # {https://auth0.com/docs/api#!#patch--api-users--user_id--metadata}
-        def patch_user_metadata(user_id, metadata={})
+        def patch_user_metadata(user_id, metadata = {})
           path = "/api/users/#{user_id}/metadata"
           patch(path, metadata)
         end
@@ -135,13 +136,13 @@ module Auth0
         #
         # This will remove all your users
         def delete_users
-          path = "/api/users/"
+          path = '/api/users/'
           delete(path)
         end
 
         # {https://auth0.com/docs/api#!#delete--api-users--user_id-}
         def delete_user(user_id)
-          raise Auth0::MissingUserId, "if you want to remove all users user delete_users method" if user_id.to_s.empty?
+          fail Auth0::MissingUserId, 'if you want to remove all users use delete_users method' if user_id.to_s.empty?
           path = "/api/users/#{user_id}"
           delete(path)
         end

data/lib/auth0/api/v2.rb

@@ -1,20 +1,28 @@
-require "auth0/api/v2/clients"
-require "auth0/api/v2/users"
-require "auth0/api/v2/blacklists"
-require "auth0/api/v2/jobs"
-require "auth0/api/v2/stats"
-require "auth0/api/v2/connections"
+require 'auth0/api/v2/blacklists'
+require 'auth0/api/v2/clients'
+require 'auth0/api/v2/connections'
+require 'auth0/api/v2/emails'
+require 'auth0/api/v2/jobs'
+require 'auth0/api/v2/rules'
+require 'auth0/api/v2/stats'
+require 'auth0/api/v2/users'
+require 'auth0/api/v2/tenants'
+require 'auth0/api/v2/tickets'
 
 module Auth0
   module Api
     # https://auth0.com/docs/apiv2
     module V2
-      include Auth0::Api::V2::Clients
-      include Auth0::Api::V2::Users
       include Auth0::Api::V2::Blacklists
+      include Auth0::Api::V2::Clients
+      include Auth0::Api::V2::Connections
+      include Auth0::Api::V2::Emails
       include Auth0::Api::V2::Jobs
+      include Auth0::Api::V2::Rules
       include Auth0::Api::V2::Stats
-      include Auth0::Api::V2::Connections
+      include Auth0::Api::V2::Users
+      include Auth0::Api::V2::Tenants
+      include Auth0::Api::V2::Tickets
     end
   end
 end

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

@@ -1,22 +1,43 @@
 module Auth0
   module Api
     module V2
-      # https://auth0.com/docs/apiv2#!/blacklists
+      # Methods to use the blacklist endpoints
       module Blacklists
-        # https://auth0.com/docs/apiv2#!/blacklists/get_tokens
-        def blacklisted_tokens
-          path = "/api/v2/blacklists/tokens"
-          get(path)
+        attr_reader :blacklists_path
+
+        # Retrieves the jti and aud of all tokens in the blacklist.
+        # @see https://auth0.com/docs/api/v2#!/Blacklists/get_tokens
+        # @param aud [string] The JWT's aud claim. The client_id of the client for which it was issued
+        #
+        # @return [json] Returns the blacklisted tokens
+        #
+        def blacklisted_tokens(aud = nil)
+          request_params = {
+            aud: aud
+          }
+          get(blacklists_path, request_params)
         end
 
-        # https://auth0.com/docs/apiv2#!/blacklists/post_tokens
-        def add_token_to_blacklist(jti, aud=nil)
+        # Adds the token identified by the jti to a blacklist for the tenant.
+        # @see https://auth0.com/docs/api/v2#!/blacklists/post_tokens
+        # @param jti [string] The jti of the JWT to blacklist
+        # @param aud [string] The JWT's aud claim. The client_id of the client for which it was issued
+        # @return [json] Returns the blacklisted token
+        #
+        def add_token_to_blacklist(jti, aud = nil)
+          fail Auth0::MissingParameter, 'Must specify a valid JTI' if jti.to_s.empty?
           request_params = {
             jti: jti,
             aud: aud
           }
-          path = "/api/v2/blacklists/tokens"
-          post(path, request_params)
+          post(blacklists_path, request_params)
+        end
+
+        private
+
+        # Blacklists API path
+        def blacklists_path
+          @blacklists_path ||= '/api/v2/blacklists/tokens'
         end
       end
     end

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

@@ -1,40 +1,81 @@
 module Auth0
   module Api
     module V2
-      #https://auth0.com/docs/apiv2#!/clients
+      # Methods to use the client endpoints
       module Clients
-        #https://auth0.com/docs/apiv2#!/clients/get_clients
-        def clients(options={})
-          path = "/api/v2/clients"
-          get(path, options)
+        attr_reader :clients_path
+
+        # Retrieves a list of all client applications. Accepts a list of fields to include or exclude.
+        # @see https://auth0.com/docs/api/v2#!/clients/get_clients
+        # @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
+        #
+        # @return [json] Returns the clients applications.
+        def clients(fields: nil, include_fields: nil)
+          include_fields = true if !fields.nil? && include_fields.nil?
+          request_params = {
+            fields: fields,
+            include_fields: include_fields
+          }
+          get(clients_path, request_params)
         end
-        alias :get_clients :clients
+        alias_method :get_clients, :clients
 
-        #https://auth0.com/docs/apiv2#!/clients/post_clients
-        def create_client(name, options={})
-          request_params = Hash[options.map{|(k,v)| [k.to_sym,v]}]
+        # Creates a new client application.
+        # @see https://auth0.com/docs/api/v2#!/clients/post_clients
+        # @param name [string] The name of the client. Must contain at least one character. Does not allow '<' or '>'
+        # @param options [hash] The Hash options used to define the client's properties.
+        # @return  [json] Returns the created client application.
+        def create_client(name, options = {})
+          fail Auth0::MissingParameter, 'Must specify a valid client name' if name.to_s.empty?
+          request_params = Hash[options.map { |(k, v)| [k.to_sym, v] }]
           request_params[:name] = name
-          path = "/api/v2/clients"
-          post(path, request_params)
+          post(clients_path, request_params)
         end
 
-        #https://auth0.com/docs/apiv2#!/clients/get_clients_by_id
-        def client(client_id, options={})
-          path = "/api/v2/clients/" + client_id.to_s
-          get(path, options)
+        # Retrieves a client by its id.
+        # @see https://auth0.com/docs/api/v2#!/Clients/get_clients_by_id
+        # @param client_id [string] The id of the client 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
+        # @return  [json] Returns the requested client application.
+        def client(client_id, fields: nil, include_fields: nil)
+          fail Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
+          include_fields = true if !fields.nil? && include_fields.nil?
+          request_params = {
+            fields: fields,
+            include_fields: include_fields
+          }
+          path = "#{clients_path}/#{client_id}"
+          get(path, request_params)
         end
 
-        #https://auth0.com/docs/apiv2#!/clients/delete_clients_by_id
+        # Deletes a client and all its related assets (like rules, connections, etc) given its id.
+        # @see https://auth0.com/docs/api/v2#!/Clients/delete_clients_by_id
+        # @param client_id [string] The id of the client to delete
         def delete_client(client_id)
-          path = "/api/v2/clients/#{client_id}"
+          fail Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
+          path = "#{clients_path}/#{client_id}"
           delete(path)
         end
 
-        #https://auth0.com/docs/apiv2#!/clients/patch_clients_by_id
+        # Updates a client.
+        # @see https://auth0.com/docs/api/v2#!/Clients/patch_clients_by_id
+        # @param client_id [string] The id of the client to update
+        # @param options [hash] The Hash options used to define the client's properties.
         def patch_client(client_id, options)
-          path = "/api/v2/clients/#{client_id}"
+          fail Auth0::MissingClientId, 'Must specify a client id' if client_id.to_s.empty?
+          fail Auth0::MissingParameter, 'Must specify a valid body' if options.to_s.empty?
+          path = "#{clients_path}/#{client_id}"
           patch(path, options)
         end
+
+        private
+
+        # Clients API path
+        def clients_path
+          @clients_path ||= '/api/v2/clients'
+        end
       end
     end
   end