auth0 4.6.0 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 44aa1a52cec04f4b9e2f8ac6f6d032cf599223f962f8f31f5ea75ac66f85a310
-  data.tar.gz: 522d4c589930e8c4036570b8c87fbccb3362cc386dbbc13ec828cc8134bce43a
+  metadata.gz: 37765b52eeb99f419d48fb8166e496c566e71dbee391ab8a6d964eab4196e32b
+  data.tar.gz: 463bdc63eb772dbdb361c955aa51dc6e0e3c72bdfe37a2dafec92924f947bf75
 SHA512:
-  metadata.gz: d1aec8459dc67d87089273a12d5ab1c02b40509d92442d84d29123d2472c4499a8e252b325c6bc333ac7fc22bc2910bf9ed95cf6429444ec0d7c27b5ee8fe780
-  data.tar.gz: b44f46446c0ea25470b4ff7bfecba848983602cec4404b6221029aac21839e2127a9462ab2560e64b3869ef7f5d4fa212bf32e9b3a06c3858af8d1bc3de5fdaf
+  metadata.gz: ae51583299385b8f3bda6ce6b549690ee9ed4e28c95acfad8a66b0479e3aff0a06964773bcc61cfd881ed67eb226ca83a0858dc8ebdbea811c170b25e1dec4f3
+  data.tar.gz: '018345873306b64d9960fec8d2d7ea50f60f236bced1e546aa3a5bfe098c2291db4a0da9f129e03d9ca3e75f6f6d780b0a4b44b0270e28e748c2f756dc9d8d86'

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Change Log
 
+## [v4.7.0](https://github.com/auth0/ruby-auth0/tree/v4.7.0) (2019-03-19)
+[Full Changelog](https://github.com/auth0/ruby-auth0/compare/v4.6.0...v4.7.0)
+
+**Closed issues**
+- No method to update/patch resource servers [\#156](https://github.com/auth0/ruby-auth0/issues/156)
+- No method to get all resource servers [\#154](https://github.com/auth0/ruby-auth0/issues/154)
+
+**Added**
+- Add Client ID to send_verification_email [\#162](https://github.com/auth0/ruby-auth0/pull/162) ([joshcanhelp](https://github.com/joshcanhelp))
+- More password change params [\#159](https://github.com/auth0/ruby-auth0/pull/159) ([nhusher](https://github.com/nhusher))
+- Add patch resource server [\#157](https://github.com/auth0/ruby-auth0/pull/157) ([philomory](https://github.com/philomory))
+- Get all resource servers [\#155](https://github.com/auth0/ruby-auth0/pull/155) ([philomory](https://github.com/philomory))
+
 ## [v4.6.0](https://github.com/auth0/ruby-auth0/tree/v4.6.0) (2018-12-17)
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v4.5.0...v4.6.0)
 

data/DEPLOYMENT.md

@@ -3,12 +3,13 @@
 bundle install
 
 # Run all tests
-MODE=full bundle exec rake all
+bundle exec rake test
 
 # Create a release branch
 git checkout master
 git pull
 git checkout -b release-X.X.X
+git push --set-upstream origin release-X.X.X
 
 # Update the version number
 bundle exec gem bump --version x.y.z

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

@@ -3,29 +3,29 @@ module Auth0
     module V2
       # Methods to use the jobs endpoints
       module Jobs
-        attr_reader :jobs_path
-
         # Retrieves a job. Useful to check its status.
         # @see https://auth0.com/docs/api/v2#!/Jobs/get_jobs_by_job_id
-        # @param job_id [string] The id of the job.
+        # @param job_id [string] The ID of the job.
         #
         # @return [json] Returns the job status and properties.
         def get_job(job_id)
           raise Auth0::InvalidParameter, 'Must specify a job id' if job_id.to_s.empty?
+
           path = "#{jobs_path}/#{job_id}"
           get(path)
         end
 
         # Imports users to a connection from a file using a long running job.
-        # Important: The documentation for the file format is at https://docs.auth0.com/bulk-import.
+        # Documentation for the file format: https://docs.auth0.com/bulk-import
         # @see https://auth0.com/docs/api/v2#!/Jobs/post_users_imports
         # @param users_file [file] A file containing the users to import.
-        # @param connection_id [string] The connection id of the connection to which users will be inserted.
+        # @param connection_id [string] Database connection ID to import to.
         #
         # @return [json] Returns the job status and properties.
         def import_users(users_file, connection_id)
           raise Auth0::InvalidParameter, 'Must specify a valid file' if users_file.to_s.empty?
           raise Auth0::InvalidParameter, 'Must specify a connection_id' if connection_id.to_s.empty?
+
           request_params = {
             users: users_file,
             connection_id: connection_id
@@ -34,16 +34,39 @@ module Auth0
           post_file(path, request_params)
         end
 
+        # Export all users to a file using a long running job.
+        # @see https://auth0.com/docs/api/v2#!/Jobs/post_users_exports
+        # @param options [hash] The options used to configure the output file.
+        #   :connection_id [string] Database connection ID to export from.
+        #   :format [string] The format of the file. Valid values are: "json" and "csv".
+        #   :limit [integer] Limit the number of users to export.
+        #   :fields [array] A list of fields to be included in the CSV.
+        #     If omitted, a set of predefined fields will be exported.
+        #
+        # @return [json] Returns the job status and properties.
+        def export_users(options = {})
+          request_params = {
+            connection_id: options.fetch(:connection_id, nil),
+            format: options.fetch(:format, nil),
+            limit: options.fetch(:limit, nil),
+            fields: fields_for_export(options.fetch(:fields, nil))
+          }
+          path = "#{jobs_path}/users-exports"
+          post(path, request_params)
+        end
+
         # Send an email to the specified user that asks them to click a link to verify their email address.
-        # @see https://auth0.com/docs/api/v2#!/Jobs/post_verification_email
+        # @see https://auth0.com/docs/api/management/v2#!/Jobs/post_verification_email
         # @param user_id [string] The user_id of the user to whom the email will be sent.
+        # @param client_id [string] Client ID to send an Application-specific email.
         #
         # @return [json] Returns the job status and properties.
-        def send_verification_email(user_id)
+        def send_verification_email(user_id, client_id = nil)
           raise Auth0::InvalidParameter, 'Must specify a user id' if user_id.to_s.empty?
-          request_params = {
-            user_id: user_id
-          }
+
+          request_params = { user_id: user_id }
+          request_params[:client_id] = client_id unless client_id.nil?
+
           path = "#{jobs_path}/verification-email"
           post(path, request_params)
         end
@@ -54,6 +77,16 @@ module Auth0
         def jobs_path
           @jobs_path ||= '/api/v2/jobs'
         end
+
+        # Map array of field names for export to array of objects
+        # @param fields [array] Field names to be included in the export
+
+        # @return [array] Returns the fields mapped as array of objects for the export_users endpoint
+        def fields_for_export(fields)
+          return nil if fields.to_s.empty?
+
+          fields.map { |field| { name: field } }
+        end
       end
     end
   end

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

@@ -5,6 +5,20 @@ module Auth0
       module ResourceServers
         attr_reader :resource_servers_path
 
+        # Retrieves a list of all resource servers.
+        # @see https://auth0.com/docs/api/management/v2#!/Resource_servers/get_resource_servers
+        # @param page [int] Page number to get, 0-based.
+        # @param per_page [int] Results per page if also passing a page number.
+        # @return [json] Returns the resource servers.
+        def resource_servers(page: nil, per_page: nil)
+          request_params = {
+            page: !page.nil? ? page.to_i : nil,
+            per_page: !page.nil? && !per_page.nil? ? per_page.to_i : nil
+          }
+          get(resource_servers_path, request_params)
+        end
+        alias get_resource_servers resource_servers
+
         # Retrieves a resource server by its ID.
         # @see https://auth0.com/docs/api/management/v2#!/Resource_Servers/get_resource_servers_by_id
         # @param resource_server_id [string] The id of the resource server to retrieve.
@@ -48,6 +62,17 @@ module Auth0
           delete(path)
         end
 
+        # Updates a resource server.
+        # @see https://auth0.com/docs/api/management/v2#!/Resource_Servers/patch_resource_servers_by_id
+        # @param id [string] The id or audience of the resource server to update.
+        # @param body [hash] The Hash options used to define the resource servers's properties.
+        def patch_resource_server(id, body)
+          raise Auth0::InvalidParameter, 'Must specify a resource server id or audience' if id.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must specify a valid body' if body.to_s.empty?
+          path = "#{resource_servers_path}/#{id}"
+          patch(path, body)
+        end
+        
         private
 
         # Resource Servers API path

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

@@ -29,22 +29,42 @@ 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 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 user_id [string] The user_id of for which the ticket is to be created.
         # @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.
+        # @param ttl_sec [integer] The ticket's lifetime in seconds starting from the moment of creation. After
+        # expiration, the ticket cannot be used to change the user's password. If not specified or if you send 0,
+        # the Auth0 default lifetime of 5 days will be applied.
+        # @param mark_email_as_verified [boolean] true if email_verified attribute must be set to true once password is
+        # changed, false if email_verified attribute should not be updated
+        # @param includeEmailInRedirect [boolean] Whether or not we include the email as part of the returnUrl
+        # in the reset_email
+        # @param new_password [string] The password to be set for the user once the ticket is used.
         #
         # @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)
+        def post_password_change(
+            result_url: nil,
+            user_id: nil,
+            connection_id: nil,
+            email: nil,
+            ttl_sec: nil,
+            mark_email_as_verified: nil,
+            includeEmailInRedirect: nil,
+            new_password: nil)
+
+          booleans = [true, false]
           path = "#{tickets_path}/password-change"
           request_params = {
-            user_id: user_id,
             result_url: result_url,
-            new_password: new_password,
+            user_id: user_id,
             connection_id: connection_id,
-            email: email
+            email: email,
+            ttl_sec: ttl_sec.is_a?(Integer) ? ttl_sec : nil,
+            mark_email_as_verified: booleans.include?(mark_email_as_verified) ? mark_email_as_verified : nil,
+            includeEmailInRedirect: booleans.include?(includeEmailInRedirect) ? includeEmailInRedirect : nil,
+            new_password: new_password
           }
           post(path, request_params)
         end

data/lib/auth0/mixins/httpproxy.rb

@@ -21,6 +21,7 @@ module Auth0
                    elsif method == :delete
                      call(:delete, url(safe_path), timeout, add_headers({params: body}))
                    elsif method == :post_file
+                     body.merge!(multipart: true)
                      call(:post, url(safe_path), timeout, headers, body)
                    else
                      call(method, url(safe_path), timeout, headers, body.to_json)
@@ -54,7 +55,13 @@ module Auth0
       end
 
       def call(method, url, timeout, headers, body = nil)
-        RestClient::Request.execute(method: method, url: url, timeout: timeout, headers: headers, payload: body)
+        RestClient::Request.execute(
+          method: method,
+          url: url,
+          timeout: timeout,
+          headers: headers,
+          payload: body
+        )
       rescue RestClient::Exception => e
         case e
         when RestClient::RequestTimeout

data/lib/auth0/version.rb

@@ -1,4 +1,4 @@
 # current version of gem
 module Auth0
-  VERSION = '4.6.0'.freeze
+  VERSION = '4.7.0'.freeze
 end

data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_export_users_and_get_job/should_create_an_export_users_job_successfully.yml

@@ -0,0 +1,61 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://auth0-sdk-tests.auth0.com/api/v2/jobs/users-exports
+    body:
+      encoding: UTF-8
+      string: '{"connection_id":"con_Xx4Kruoab04wvlYX"}'
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin17.7.0 x86_64) ruby/2.5.1p57
+      Content-Type:
+      - application/json
+      Auth0-Client:
+      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjYuMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
+      Authorization:
+      - Bearer API_TOKEN
+      Content-Length:
+      - '40'
+      Host:
+      - auth0-sdk-tests.auth0.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 27 Feb 2019 16:13:15 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Ratelimit-Limit:
+      - '10'
+      X-Ratelimit-Remaining:
+      - '8'
+      X-Ratelimit-Reset:
+      - '1551283997'
+      Vary:
+      - origin,accept-encoding
+      Cache-Control:
+      - private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Encoding:
+      - gzip
+      Strict-Transport-Security:
+      - max-age=15724800
+      X-Robots-Tag:
+      - noindex, nofollow, nosnippet, noarchive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA1WOPQ+CMBCG/0tnMRQRlM3FxcVETZClKe2pJdKS9vgwxv/uyeZ4z/vc3ftm+OqAFawP4IOAqXMe2YIFlNgH4h1YbeydkHLWgkLjrDCaEppFOaUH3ztZx+k4PK8laTfnW4m/PAx/W4Qu9MTKFqKjDGF0Xke7Hh9g0Sg5K+R7kAhazCeSmG+jOImS/Myzgq8Kvl4m+bYib67QuFqcNi5k1bjXcaNM5hX7fAHRdXvC1AAAAA==
+    http_version: 
+  recorded_at: Wed, 27 Feb 2019 16:13:15 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_export_users_and_get_job/should_get_the_export_users_job.yml

@@ -0,0 +1,117 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://auth0-sdk-tests.auth0.com/api/v2/jobs/users-exports
+    body:
+      encoding: UTF-8
+      string: '{"connection_id":"con_Xx4Kruoab04wvlYX"}'
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin17.7.0 x86_64) ruby/2.5.1p57
+      Content-Type:
+      - application/json
+      Auth0-Client:
+      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjYuMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
+      Authorization:
+      - Bearer API_TOKEN
+      Content-Length:
+      - '40'
+      Host:
+      - auth0-sdk-tests.auth0.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 27 Feb 2019 16:13:15 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Ratelimit-Limit:
+      - '10'
+      X-Ratelimit-Remaining:
+      - '7'
+      X-Ratelimit-Reset:
+      - '1551283998'
+      Vary:
+      - origin,accept-encoding
+      Cache-Control:
+      - private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Encoding:
+      - gzip
+      Strict-Transport-Security:
+      - max-age=15724800
+      X-Robots-Tag:
+      - noindex, nofollow, nosnippet, noarchive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA1WOyw6CMBBF/6VrMbyN7NgZ2ZggCbhpCoxalJa0w8MY/92Rncs598zMfTN8DcASNlowlsMyaINswywKHC3xAVQr1Y1Qo5WCBqVWXLaU0MzLJczMqEXthvP0rErSrtr0An+5nf62CBX0RIkenJOwdtamddIR76BQNmJVyDcgEFq+nvBdb++4vuPvzl6ceEHiRdsoiC7krRU6XfOuyB9xejhWjcmmacnZ5wu9hN4Y1AAAAA==
+    http_version: 
+  recorded_at: Wed, 27 Feb 2019 16:13:15 GMT
+- request:
+    method: get
+    uri: https://auth0-sdk-tests.auth0.com/api/v2/jobs/job_jUSk6AHJYcrKvvxS
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin17.7.0 x86_64) ruby/2.5.1p57
+      Content-Type:
+      - application/json
+      Auth0-Client:
+      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjYuMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
+      Authorization:
+      - Bearer API_TOKEN
+      Host:
+      - auth0-sdk-tests.auth0.com
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 27 Feb 2019 16:13:15 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Ratelimit-Limit:
+      - '10'
+      X-Ratelimit-Remaining:
+      - '7'
+      X-Ratelimit-Reset:
+      - '1551283998'
+      Vary:
+      - origin,accept-encoding
+      Cache-Control:
+      - private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Encoding:
+      - gzip
+      Strict-Transport-Security:
+      - max-age=15724800
+      X-Robots-Tag:
+      - noindex, nofollow, nosnippet, noarchive
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA1WOyw6CMBBF/6VrMbyN7NgZ2ZggCbhpCoxalJa0w8MY/92Rncs598zMfTN8DcASNlowlsMyaINswywKHC3xAVQr1Y1Qo5WCBqVWXLaU0MzLJczMqEXthvP0rErSrtr0An+5nf62CBX0RIkenJOwdtamddIR76BQNmJVyDcgEFq+nvBdb++4vuPvzl6ceEHiRdsoiC7krRU6XfOuyB9xejhWjcmmacnZ5wu9hN4Y1AAAAA==
+    http_version: 
+  recorded_at: Wed, 27 Feb 2019 16:13:15 GMT
+recorded_with: VCR 4.0.0

data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Jobs/_import_users_and_get_job/should_create_an_import_users_job_successfully.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://auth0-sdk-tests.auth0.com/api/v2/jobs/users-imports
+    body:
+      encoding: ASCII-8BIT
+      string: "------RubyFormBoundary7fUORMCp03LhWn7G\r\nContent-Disposition: form-data;
+        name=\"users\"; filename=\"api-jobs-spec-import-users.json\"\r\nContent-Type:
+        application/json\r\n\r\n[{\"email\":\"rubytestzulema_haag@example.com\",\"email_verified\":false,\"app_metadata\":{\"roles\":[\"admin\"]},\"user_metadata\":{\"theme\":\"light\"}}]\r\n------RubyFormBoundary7fUORMCp03LhWn7G\r\nContent-Disposition:
+        form-data; name=\"connection_id\"\r\n\r\ncon_Xx4Kruoab04wvlYX\r\n------RubyFormBoundary7fUORMCp03LhWn7G--\r\n"
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (darwin17.7.0 x86_64) ruby/2.5.1p57
+      Content-Type:
+      - multipart/form-data; boundary=----RubyFormBoundary7fUORMCp03LhWn7G
+      Auth0-Client:
+      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjYuMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
+      Authorization:
+      - Bearer API_TOKEN
+      Content-Length:
+      - '463'
+      Host:
+      - auth0-sdk-tests.auth0.com
+  response:
+    status:
+      code: 202
+      message: Accepted
+    headers:
+      Date:
+      - Wed, 27 Feb 2019 16:14:17 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      X-Ratelimit-Limit:
+      - '10'
+      X-Ratelimit-Remaining:
+      - '9'
+      X-Ratelimit-Reset:
+      - '1551284058'
+      Vary:
+      - origin,accept-encoding
+      Cache-Control:
+      - private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA1XNMQvCMBAF4P+S2UgSQ4vdCk6K4FChdQlpGzRik5BcrCL+d49ujvfex7sPgXcwpCI5mZiUnYKPQFYkgYacMA/GjdZdMRq8c2YA652yIzZ4q/YlDzF73TM5Px9d+8fQnHHV6cnQk05p9nGkdYabcWAHvRD00Wgwo9KAXjC+pUxQUTa8qLiseLmWBbugW37efa+aQoqOzfu6ro/hutmR7w/HprJfxQAAAA==
+    http_version: 
+  recorded_at: Wed, 27 Feb 2019 16:14:17 GMT
+recorded_with: VCR 4.0.0