auth0 4.8.0 → 4.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3ed0c706e0b34dba7cd8175c2b9a4e0abd8b319d3ee6128885a8fdcfb6b37d9c
-  data.tar.gz: 165ab41e867b81ba5d2d70f11f3e753c9b3fb49617a354a2b3ec747bee86fddb
+  metadata.gz: 858abdf1d6f43a1c046e45f1ad9c70df2115e96c75d78e135261dd3477e630d2
+  data.tar.gz: bf9f13ae3f7cb4e6881a5852fe9a0f95f2dcb7b3b5181c72388c785a2fc6032b
 SHA512:
-  metadata.gz: 4ab60f3ca91020f2113f7d804298b0ee483b2aca0b39c28713252ddbdf274de9f2d5fff0834de345fe04d0580a63961aa5b7a71010e3d73ac843de8337781a58
-  data.tar.gz: 4b7c48d5a4caec35b982cd62a541dfea0b5761789e37343e28cad955bad770971ad2b31e04f65648c244c17d5dac7d9c3704f18378cf7993beadd7b8d004e43d
+  metadata.gz: f9e9da5fd0c9aadbead0bb27e2e587893bc7b32cf670fc5237e2ae9adf29fd8d0e315e0b1135f5a68c4d0acd0be7570a803155d1c6e2a32a73a7c7eaf4439694
+  data.tar.gz: 6676874d86123b45e996228cfe3d019baae92ffb6ad1f319cde212bd23bb44480a4e7ac434ca034ad303d4290b712ed80eeb957e2bc75216b00cc2dd7a7d2cdd

data/.circleci/config.yml

@@ -15,6 +15,7 @@ jobs:
           paths:
             - Gemfile
             - Gemfile.lock
+            - .snyk
       - save_cache:
           key: gems-v2--{{ checksum "Gemfile.lock" }}
           paths:

data/CHANGELOG.md

@@ -1,5 +1,24 @@
 # Change Log
 
+## [v4.9.0](https://github.com/auth0/ruby-auth0/tree/v4.9.0) (2019-09-25)
+[Full Changelog](https://github.com/auth0/ruby-auth0/compare/v4.8.0...v4.9.0)
+
+
+**Closed issues:**
+
+- Dot in role name makes description disappear [\#194](https://github.com/auth0/ruby-auth0/issues/194)
+- Missing require Permission [\#192](https://github.com/auth0/ruby-auth0/issues/192)
+- Token required even when not necessary [\#190](https://github.com/auth0/ruby-auth0/issues/190)
+
+**Fixed:**
+
+- Fix request timeout [\#188](https://github.com/auth0/ruby-auth0/pull/188) ([makoto-matsumoto](https://github.com/makoto-matsumoto))
+- Fix missing Permissions mixin [\#196](https://github.com/auth0/ruby-auth0/pull/196) ([joshcanhelp](https://github.com/joshcanhelp))
+
+**Added:**
+
+- Add Management API Guardian enrollments endpoint [\#182](https://github.com/auth0/ruby-auth0/pull/182) ([tomgi](https://github.com/tomgi))
+
 ## [v4.8.0](https://github.com/auth0/ruby-auth0/tree/v4.8.0) (2019-08-01)
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v4.7.0...v4.8.0)
 

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    auth0 (4.8.0)
-      rest-client (~> 2.0)
+    auth0 (4.9.0)
+      rest-client (~> 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.6.0)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     codecov (0.1.14)
       json
@@ -16,12 +16,12 @@ GEM
       url
     coderay (1.1.2)
     concurrent-ruby (1.1.5)
-    coveralls (0.8.23)
-      json (>= 1.8, < 3)
-      simplecov (~> 0.16.1)
-      term-ansicolor (~> 1.3)
-      thor (>= 0.19.4, < 2.0)
-      tins (~> 1.6)
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
     crack (0.4.3)
       safe_yaml (~> 1.0.0)
     diff-lcs (1.3)
@@ -39,7 +39,7 @@ GEM
       rspec-core (~> 3.0)
       ruby-progressbar (~> 1.4)
     gem-release (0.7.4)
-    guard (2.15.0)
+    guard (2.15.1)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -66,16 +66,17 @@ GEM
       ruby_dep (~> 1.2)
     lumberjack (1.0.13)
     method_source (0.8.2)
-    mime-types (3.2.2)
+    mime-types (3.3)
       mime-types-data (~> 3.2015)
-    mime-types-data (3.2019.0331)
+    mime-types-data (3.2019.0904)
+    multi_json (1.13.1)
     nenv (0.3.0)
     netrc (0.11.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
     parallel (1.17.0)
-    parser (2.6.3.0)
+    parser (2.6.4.1)
       ast (~> 2.4.0)
     pry (0.10.4)
       coderay (~> 1.1.0)
@@ -83,7 +84,7 @@ GEM
       slop (~> 3.4)
     pry-nav (0.2.4)
       pry (>= 0.9.10, < 0.11.0)
-    public_suffix (3.1.1)
+    public_suffix (4.0.1)
     rack (1.6.11)
     rack-test (0.8.3)
       rack (>= 1.0, < 3)
@@ -120,7 +121,7 @@ GEM
     ruby_dep (1.5.0)
     safe_yaml (1.0.5)
     shellany (0.0.1)
-    simplecov (0.16.1)
+    simplecov (0.17.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
       simplecov-html (~> 0.10.0)
@@ -137,7 +138,7 @@ GEM
     unicode-display_width (1.6.0)
     url (0.3.2)
     vcr (5.0.0)
-    webmock (3.6.2)
+    webmock (3.7.5)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)

data/README.md

@@ -72,7 +72,16 @@ class AllUsersController < ApplicationController
   def auth0_client
     @auth0_client ||= Auth0Client.new(
       client_id: ENV['AUTH0_RUBY_CLIENT_ID'],
-      token: ENV['AUTH0_RUBY_API_TOKEN'],
+      client_secret: ENV['AUTH0_RUBY_CLIENT_SECRET'],
+      # If you pass in a client_secret value, the SDK will automatically try to get a 
+      # Management API token for this application. Make sure your Application can make a 
+      # Client Credentials grant (Application settings in Auth0 > Advanced > Grant Types
+      # tab) and that the Application is authorized for the Management API:
+      # https://auth0.com/docs/api-auth/config/using-the-auth0-dashboard
+      #
+      # Otherwise, you can pass in a Management API token directly for testing or temporary
+      # access using the key below. 
+      # token: ENV['AUTH0_RUBY_API_TOKEN'],
       domain: ENV['AUTH0_RUBY_DOMAIN'],
       api_version: 2,
       timeout: 15 # optional, defaults to 10

data/auth0.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
 
-  s.add_runtime_dependency 'rest-client', '~> 2.0'
+  s.add_runtime_dependency 'rest-client', '~> 2.0.0'
 
   s.add_development_dependency 'rake', '~> 10.4'
   s.add_development_dependency 'fuubar', '~> 2.0'

data/lib/auth0/api/v2.rb

@@ -16,6 +16,7 @@ require 'auth0/api/v2/tenants'
 require 'auth0/api/v2/tickets'
 require 'auth0/api/v2/logs'
 require 'auth0/api/v2/resource_servers'
+require 'auth0/api/v2/guardian'
 
 module Auth0
   module Api
@@ -39,6 +40,7 @@ module Auth0
       include Auth0::Api::V2::Tickets
       include Auth0::Api::V2::Logs
       include Auth0::Api::V2::ResourceServers
+      include Auth0::Api::V2::Guardian
     end
   end
 end

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

@@ -0,0 +1,142 @@
+module Auth0
+  module Api
+    module V2
+      # Methods to use the guardian endpoints
+      module Guardian
+        include Auth0::Mixins::Validation
+
+        # Retrieves a list of Guardian factors.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_factors
+        # @return [json] Returns the list of all Guardian factors.
+        def guardian_factors
+          get(guardian_factors_path)
+        end
+        alias get_guardian_factors guardian_factors
+
+        # Retrieves a single Guardian enrollment.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_enrollments_by_id
+        # @param enrollment_id [string] The enrollment_id of the Guardian enrollment to delete.
+        # @return [json] Returns details of the Guardian enrollment.
+        def guardian_enrollment(enrollment_id)
+          raise Auth0::MissingParameter, 'Must supply a valid enrollment_id' if enrollment_id.to_s.empty?
+
+          path = "#{guardian_enrollments_path}/#{enrollment_id}"
+          get(path)
+        end
+        alias get_guardian_enrollment guardian_enrollment
+
+        # Deletes a single Guardian enrollment given its id.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/delete_enrollments_by_id
+        # @param enrollment_id [string] The enrollment_id of the Guardian enrollment to delete.
+        def delete_guardian_enrollment(enrollment_id)
+          raise Auth0::MissingParameter, 'Must supply a valid enrollment_id' if enrollment_id.to_s.empty?
+
+          path = "#{guardian_enrollments_path}/#{enrollment_id}"
+          delete(path)
+        end
+
+        # Retrieves SMS enrollment and verification templates.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_templates
+        # @return [json] Returns enrollment and verification templates.
+        def guardian_sms_templates
+          path = "#{guardian_factors_path}/sms/templates"
+          get(path)
+        end
+        alias get_guardian_sms_templates guardian_sms_templates
+
+        # Updates SMS enrollment and verification SMS templates.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_templates
+        # @param body [hash] The parameters to update.
+        #
+        # @return [json] Returns updated SMS enrollment and verification templates.
+        def guardian_update_enrollment_verification_templates(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/sms/templates"
+          put(path, body)
+        end
+
+        # Retrieves provider configuration for AWS SNS.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_sns
+        # @return [json] Returns provider configuration for AWS SNS.
+        def guardian_sns_provider_config
+          path = "#{guardian_factors_path}/push-notification/providers/sns"
+          get(path)
+        end
+        alias get_guardian_sns_provider_config guardian_sns_provider_config
+
+        # Updates provider configuration for AWS SNS.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_sns
+        # @param body [hash] The parameters to update.
+        #
+        # @return [json] Returns updated provider configuration for AWS SNS.
+        def guardian_update_sns_provider_config(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/push-notification/providers/sns"
+          put(path, body)
+        end
+
+        # Retrieves provider configuration for Twilio.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/get_twilio
+        # @return [json] Returns provider configuration for Twilio.
+        def guardian_twillo_provider_config
+          path = "#{guardian_factors_path}/sms/providers/twilio"
+          get(path)
+        end
+        alias get_guardian_twillo_provider_config guardian_twillo_provider_config
+
+        # Updates provider configuration for Twilio.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_twilio
+        # @param body [hash] The parameters to update.
+        #
+        # @return [json] Returns updated provider configuration for Twilio.
+        def guardian_update_twillo_provider_config(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/sms/providers/twilio"
+          put(path, body)
+        end
+
+        # Creates a Guardian enrollment ticket.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/post_ticket
+        # @param body [hash] User details to create enrollment ticket for.
+        # @return [json] Returns details of created enrollment ticket.
+        def guardian_create_enrollment_ticket(body)
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_enrollments_path}/ticket"
+          post(path, body)
+        end
+
+        # Updates a Guardian factor.
+        # @see https://auth0.com/docs/api/management/v2#!/Guardian/put_factors_by_name
+        # @param name [string] Name of Guardian factor to update.
+        # @param body [hash] The parameters to update.
+        # @return [json] Returns details of updated Guardian factor.
+        def guardian_update_factor(name, body)
+          raise Auth0::MissingParameter, 'Must supply a valid name' if name.to_s.empty?
+          raise Auth0::InvalidParameter, 'Must supply a valid body' if body.to_s.empty?
+
+          path = "#{guardian_factors_path}/#{name}"
+          put(path, body)
+        end
+
+        private
+
+        # Guardian API path
+        def guardian_path
+          @guardian_path ||= '/api/v2/guardian'
+        end
+
+        def guardian_enrollments_path
+          @guardian_enrollments_path ||= "#{guardian_path}/enrollments"
+        end
+
+        def guardian_factors_path
+          @guardian_factors_path ||= "#{guardian_path}/factors"
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,3 @@
-require 'auth0/mixins/validation'
-
 module Auth0
   module Api
     module V2

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

@@ -1,5 +1,3 @@
-require 'auth0/mixins/validation'
-
 module Auth0
   module Api
     module V2

data/lib/auth0/mixins.rb

@@ -1,14 +1,19 @@
 require 'base64'
 require 'rest-client'
 require 'uri'
-require 'auth0/mixins/httpproxy'
-require 'auth0/mixins/initializer'
-require 'auth0/mixins/headers'
+
 require 'auth0/mixins/access_token_struct'
 require 'auth0/mixins/api_token_struct'
+require 'auth0/mixins/headers'
+require 'auth0/mixins/httpproxy'
+require 'auth0/mixins/initializer'
+require 'auth0/mixins/permission_struct'
+require 'auth0/mixins/validation'
+
 require 'auth0/api/authentication_endpoints'
 require 'auth0/api/v1'
 require 'auth0/api/v2'
+
 module Auth0
   # Collecting dependencies here
   module Mixins

data/lib/auth0/mixins/httpproxy.rb

@@ -68,7 +68,7 @@ module Auth0
       rescue RestClient::Exception => e
         case e
         when RestClient::RequestTimeout
-          raise Auth0::RequestTimeout
+          raise Auth0::RequestTimeout.new(e.message)
         else
           return e.response
         end

data/lib/auth0/version.rb

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

data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_add_role_permissions/should_add_a_Permission_to_the_Role_successfully.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://auth0-sdk-tests.auth0.com/api/v2/roles/rol_rSi7DH8MezaQ229K/permissions
+    uri: https://auth0-sdk-tests.auth0.com/api/v2/roles/rol_Me7CwJxYruZRfq7q/permissions
     body:
       encoding: UTF-8
       string: '{"permissions":[{"permission_name":"rubytest-test-permission","resource_server_identifier":"rubytest-test-api-for-roles"}]}'
@@ -16,7 +16,7 @@ http_interactions:
       Content-Type:
       - application/json
       Auth0-Client:
-      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjcuMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
+      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjguMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
       Authorization:
       - Bearer API_TOKEN
       Content-Length:
@@ -29,29 +29,31 @@ http_interactions:
       message: Created
     headers:
       Date:
-      - Fri, 28 Jun 2019 19:10:36 GMT
+      - Wed, 25 Sep 2019 16:28:53 GMT
       Content-Type:
       - application/json; charset=utf-8
       Transfer-Encoding:
       - chunked
       Connection:
       - keep-alive
+      Server:
+      - nginx
       Ot-Tracer-Spanid:
-      - 00b2c56e5846715b
+      - 1e7797637343dafb
       Ot-Tracer-Traceid:
-      - 3e8125b1094f3ea3
+      - 7dfc59340554541b
       Ot-Tracer-Sampled:
       - 'true'
       X-Ratelimit-Limit:
       - '10'
       X-Ratelimit-Remaining:
-      - '9'
+      - '4'
       X-Ratelimit-Reset:
-      - '1561749038'
+      - '1569428937'
       Vary:
       - origin,accept-encoding
       Cache-Control:
-      - private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      - no-cache
       Content-Encoding:
       - gzip
       Strict-Transport-Security:
@@ -63,5 +65,5 @@ http_interactions:
       string: !binary |-
         H4sIAAAAAAAAA6uuBQBDv6ajAgAAAA==
     http_version: 
-  recorded_at: Fri, 28 Jun 2019 19:10:37 GMT
-recorded_with: VCR 4.0.0
+  recorded_at: Wed, 25 Sep 2019 16:28:53 GMT
+recorded_with: VCR 5.0.0

data/spec/fixtures/vcr_cassettes/Auth0_Api_V2_Roles/_add_role_users/should_add_a_User_to_the_Role_successfully.yml

@@ -2,10 +2,10 @@
 http_interactions:
 - request:
     method: post
-    uri: https://auth0-sdk-tests.auth0.com/api/v2/roles/rol_rSi7DH8MezaQ229K/users
+    uri: https://auth0-sdk-tests.auth0.com/api/v2/roles/rol_Me7CwJxYruZRfq7q/users
     body:
       encoding: UTF-8
-      string: '{"users":["auth0|5d16662237b1960d45b50e7c"]}'
+      string: '{"users":["auth0|5d8b95c1d48d580ddc880536"]}'
     headers:
       Accept:
       - "*/*"
@@ -16,7 +16,7 @@ http_interactions:
       Content-Type:
       - application/json
       Auth0-Client:
-      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjcuMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
+      - eyJuYW1lIjoicnVieS1hdXRoMCIsInZlcnNpb24iOiI0LjguMCIsImVudiI6eyJydWJ5IjoiMi41LjEifX0=
       Authorization:
       - Bearer API_TOKEN
       Content-Length:
@@ -29,29 +29,31 @@ http_interactions:
       message: OK
     headers:
       Date:
-      - Fri, 28 Jun 2019 19:10:32 GMT
+      - Wed, 25 Sep 2019 16:28:52 GMT
       Content-Type:
       - application/json; charset=utf-8
       Transfer-Encoding:
       - chunked
       Connection:
       - keep-alive
+      Server:
+      - nginx
       Ot-Tracer-Spanid:
-      - '095d0db570914f57'
+      - 63afc16a03cb3c38
       Ot-Tracer-Traceid:
-      - '009605b14993633d'
+      - 1d60153a4e9d6b5f
       Ot-Tracer-Sampled:
       - 'true'
       X-Ratelimit-Limit:
       - '10'
       X-Ratelimit-Remaining:
-      - '9'
+      - '6'
       X-Ratelimit-Reset:
-      - '1561749034'
+      - '1569428935'
       Vary:
       - origin,accept-encoding
       Cache-Control:
-      - private, no-store, no-cache, must-revalidate, post-check=0, pre-check=0
+      - no-cache
       Content-Encoding:
       - gzip
       Strict-Transport-Security:
@@ -63,5 +65,5 @@ http_interactions:
       string: !binary |-
         H4sIAAAAAAAAA6uuBQBDv6ajAgAAAA==
     http_version: 
-  recorded_at: Fri, 28 Jun 2019 19:10:32 GMT
-recorded_with: VCR 4.0.0
+  recorded_at: Wed, 25 Sep 2019 16:28:52 GMT
+recorded_with: VCR 5.0.0