auth0 4.4.0 → 5.1.2

data/spec/lib/auth0/api/v2/resource_servers_spec.rb

@@ -7,6 +7,19 @@ describe Auth0::Api::V2::ResourceServers do
     @instance = dummy_instance
   end
 
+  context '.resource_servers' do
+    it { expect(@instance).to respond_to(:resource_servers) }
+    it { expect(@instance).to respond_to(:get_resource_servers) }
+    it 'is expected to call get /api/v2/resource-servers' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/resource-servers',
+        page: nil,
+        per_page: nil,
+      )
+      expect { @instance.resource_servers }.not_to raise_error
+    end
+  end
+
   context '.resource_server' do
     it { expect(@instance).to respond_to(:resource_server) }
     it 'is expected to call get /api/v2/resource-servers/test' do
@@ -60,4 +73,14 @@ describe Auth0::Api::V2::ResourceServers do
       expect { @instance.delete_resource_server(nil) }.to raise_error 'Must supply a valid resource server id'
     end
   end
+
+  context '.patch_resource_server' do
+    it { expect(@instance).to respond_to(:patch_resource_server) }
+    it 'is expected to send patch to /api/v2/resource_servers/1' do
+      expect(@instance).to receive(:patch).with('/api/v2/resource-servers/1', fields: 'fields')
+      expect { @instance.patch_resource_server('1', fields: 'fields') }.not_to raise_error
+    end
+    it { expect { @instance.patch_resource_server('', nil) }.to raise_error Auth0::InvalidParameter }
+    it { expect { @instance.patch_resource_server('some', nil) }.to raise_error Auth0::InvalidParameter }
+  end
 end

data/spec/lib/auth0/api/v2/roles_spec.rb

@@ -0,0 +1,362 @@
+require 'spec_helper'
+describe Auth0::Api::V2::Roles do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Roles)
+    @instance = dummy_instance
+  end
+
+  context '.get_roles' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:get_roles)
+    end
+
+    it 'is expected to have a roles alias' do
+      expect(@instance).to respond_to(:roles)
+    end
+
+    it 'is expected to get Roles with default parameters' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/roles',
+        per_page: nil,
+        page: nil,
+        include_totals: nil,
+        name_filter: nil
+      )
+      expect { @instance.get_roles }.not_to raise_error
+    end
+
+    it 'is expected to get Roles with custom parameters' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/roles',
+        per_page: 10,
+        page: 3,
+        include_totals: true,
+        name_filter: 'test'
+      )
+      expect do
+        @instance.get_roles(per_page: 10, page: 3, include_totals: true, name_filter: 'test')
+      end.not_to raise_error
+    end
+  end
+
+  context '.get_role' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:get_role)
+    end
+
+    it 'is expected to have a role alias' do
+      expect(@instance).to respond_to(:role)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:get)
+      expect do
+        @instance.get_role('')
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to get a Role by ID' do
+      expect(@instance).to receive(:get).with('/api/v2/roles/ROLE_ID')
+      expect { @instance.get_role('ROLE_ID') }.not_to raise_error
+    end
+  end
+
+  context '.create_role' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:create_role)
+    end
+
+    it 'is expected to raise an exception if an empty Role name is passed' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.create_role('')
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to post a new Role' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/roles',
+        name: 'ROLE_NAME',
+        description: 'ROLE_DESCRIPTION'
+      )
+      expect do
+        @instance.create_role(
+          'ROLE_NAME',
+          description: 'ROLE_DESCRIPTION'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.update_role' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:update_role)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:patch)
+      expect do
+        @instance.update_role('')
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to post an updated Role' do
+      expect(@instance).to receive(:patch).with(
+        '/api/v2/roles/ROLE_ID',
+        name: 'ROLE_NAME',
+        description: 'ROLE_DESCRIPTION'
+      )
+      expect do
+        @instance.update_role(
+          'ROLE_ID',
+          name: 'ROLE_NAME',
+          description: 'ROLE_DESCRIPTION'
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.delete_role' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:delete_role)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:delete)
+      expect do
+        @instance.delete_role('')
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to delete a Role' do
+      expect(@instance).to receive(:delete).with('/api/v2/roles/ROLE_ID')
+      expect { @instance.delete_role('ROLE_ID') }.not_to raise_error
+    end
+  end
+
+  context '.get_users' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:get_role_users)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:get)
+      expect do
+        @instance.get_role_users('')
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to get Users for a Role with default parameters' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/roles/ROLE_ID/users',
+        per_page: nil,
+        page: nil,
+        include_totals: nil
+      )
+      expect { @instance.get_role_users('ROLE_ID') }.not_to raise_error
+    end
+
+    it 'is expected to get Users for a Role with custom parameters' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/roles/ROLE_ID/users',
+        per_page: 30,
+        page: 4,
+        include_totals: true
+      )
+      expect do
+        @instance.get_role_users('ROLE_ID', per_page: 30, page: 4, include_totals: true)
+      end.not_to raise_error
+    end
+  end
+
+  context '.add_users' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:add_role_users)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.add_role_users('', [])
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to raise an exception if an array is not passed for Users' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.add_role_users('ROLE_ID', 'USERS')
+      end.to raise_exception Auth0::InvalidParameter
+    end
+
+    it 'is expected to raise an exception if no User IDs are passed' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.add_role_users('ROLE_ID', [])
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to add Users to a Role' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/roles/ROLE_ID/users',
+        users: %w[test|user-01 test|user-02]
+      )
+      expect do
+        @instance.add_role_users('ROLE_ID', %w[test|user-01 test|user-02])
+      end.not_to raise_error
+    end
+  end
+
+  context '.get_permissions' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:get_role_permissions)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:get)
+      expect do
+        @instance.get_role_permissions('')
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to get Roles with default parameters' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/roles/ROLE_ID/permissions',
+        per_page: nil,
+        page: nil,
+        include_totals: nil
+      )
+      expect { @instance.get_role_permissions('ROLE_ID') }.not_to raise_error
+    end
+
+    it 'is expected to get Roles with custom parameters' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/roles/ROLE_ID/permissions',
+        per_page: 15,
+        page: 5,
+        include_totals: true
+      )
+      expect do
+        @instance.get_role_permissions('ROLE_ID', per_page: 15, page: 5, include_totals: true)
+      end.not_to raise_error
+    end
+  end
+
+  context '.add_permissions' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:add_role_permissions)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.add_role_permissions('', [])
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to raise an exception if an array is not passed for permissions' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.add_role_permissions('ROLE_ID', 'PERMISSIONS')
+      end.to raise_exception Auth0::InvalidParameter
+    end
+
+    it 'is expected to raise an exception if an empty permissions array is passed' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.add_role_permissions('ROLE_ID', [])
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to raise an exception if the permissions array does not contain Permission structs' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.add_role_permissions('ROLE_ID', [1, 2, 3])
+      end.to raise_exception Auth0::InvalidParameter
+    end
+
+    it 'is expected to add permissions to a Role' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/roles/ROLE_ID/permissions',
+        permissions: [
+          {
+            permission_name: 'permission-name-1',
+            resource_server_identifier: 'server-id-1'
+          },
+          {
+            permission_name: 'permission-name-2',
+            resource_server_identifier: 'server-id-2'
+          }
+        ]
+      )
+      expect do
+        @instance.add_role_permissions(
+          'ROLE_ID',
+          [
+            Auth0::Permission.new('permission-name-1', 'server-id-1'),
+            Auth0::Permission.new('permission-name-2', 'server-id-2')
+          ]
+        )
+      end.not_to raise_error
+    end
+  end
+
+  context '.remove_permissions' do
+    it 'is expected to exist' do
+      expect(@instance).to respond_to(:remove_role_permissions)
+    end
+
+    it 'is expected to raise an exception if an empty Role ID is passed' do
+      expect(@instance).not_to receive(:delete_with_body)
+      expect do
+        @instance.remove_role_permissions('', [])
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to raise an exception if an array is not passed for permissions' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.remove_role_permissions('ROLE_ID', 'PERMISSIONS')
+      end.to raise_exception Auth0::InvalidParameter
+    end
+
+    it 'is expected to raise an exception if an empty permissions array is passed' do
+      expect(@instance).not_to receive(:delete_with_body)
+      expect do
+        @instance.remove_role_permissions('ROLE_ID', [])
+      end.to raise_exception Auth0::MissingParameter
+    end
+
+    it 'is expected to raise an exception if the permissions array does not contain Permission structs' do
+      expect(@instance).not_to receive(:post)
+      expect do
+        @instance.remove_role_permissions('ROLE_ID', [1, 2, 3])
+      end.to raise_exception Auth0::InvalidParameter
+    end
+
+    it 'is expected to remove permissions from a Role' do
+      expect(@instance).to receive(:delete_with_body).with(
+        '/api/v2/roles/ROLE_ID/permissions',
+        permissions: [
+          {
+            permission_name: 'permission-name-3',
+            resource_server_identifier: 'server-id-3'
+          },
+          {
+            permission_name: 'permission-name-4',
+            resource_server_identifier: 'server-id-4'
+          }
+        ]
+      )
+      expect do
+        @instance.remove_role_permissions(
+          'ROLE_ID',
+          [
+            Auth0::Permission.new('permission-name-3', 'server-id-3'),
+            Auth0::Permission.new('permission-name-4', 'server-id-4')
+          ]
+        )
+      end.not_to raise_error
+    end
+  end
+end

data/spec/lib/auth0/api/v2/rules_spec.rb

@@ -9,12 +9,34 @@ describe Auth0::Api::V2::Rules do
 
   context '.rules' do
     it { expect(@instance).to respond_to(:rules) }
+
     it 'is expected to call get /api/v2/rules' do
       expect(@instance).to receive(:get).with(
-        '/api/v2/rules', enabled: nil, fields: nil, include_fields: nil, stage: nil
+        '/api/v2/rules',
+        enabled: nil,
+        fields: nil,
+        include_fields: nil,
+        stage: nil,
+        page: nil,
+        per_page: nil
       )
       expect { @instance.rules }.not_to raise_error
     end
+
+    it 'is expected to call get /api/v2/rules with pagination' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/rules',
+        enabled: nil,
+        fields: nil,
+        include_fields: nil,
+        stage: nil,
+        page: 1,
+        per_page: 2
+      )
+      expect {
+        @instance.rules(page: 1, per_page: 2)
+      }.not_to raise_error
+    end
   end
 
   context '.rule' do

data/spec/lib/auth0/api/v2/tickets_spec.rb

@@ -7,22 +7,112 @@ describe Auth0::Api::V2::Tickets do
   context '.post_email_verification' do
     it { expect(@instance).to respond_to(:post_email_verification) }
     it 'expect client to send post to /api/v2/tickets/email-verification with body' do
-      expect(@instance).to receive(:post).with('/api/v2/tickets/email-verification', user_id: 'user_id', result_url: nil)
+      expect(@instance).to receive(:post).with('/api/v2/tickets/email-verification', user_id: 'user_id',
+                                                                                     result_url: nil, ttl_sec: nil)
       expect { @instance.post_email_verification('user_id') }.not_to raise_error
     end
+    it 'expect client to accept integer ttl_sec' do
+      expect(@instance).to receive(:post).with('/api/v2/tickets/email-verification', user_id: 'user_id',
+                                                                                     result_url: nil, ttl_sec: 300)
+      expect { @instance.post_email_verification('user_id', ttl_sec: 300) }.not_to raise_error
+    end
+    it 'expect client to return nil when calling with a non-integer ttl_sec' do
+      expect(@instance).to receive(:post).with('/api/v2/tickets/email-verification', user_id: 'user_id',
+                                                                                     result_url: nil, ttl_sec: nil)
+      expect { @instance.post_email_verification('user_id', ttl_sec: "noninteger") }.not_to raise_error
+    end
+    it 'expect client to accept hash identity' do
+      expect(@instance).to receive(:post).with('/api/v2/tickets/email-verification', user_id: 'user_id',
+                                                                                     result_url: nil, 
+                                                                                     ttl_sec: nil,
+                                                                                     identity: {
+                                                                                      provider: "auth0",
+                                                                                      user_id: "user_id"
+                                                                                     })
+      expect {
+        @instance.post_email_verification('user_id', identity: { provider: "auth0", user_id: "user_id"}) 
+      }.not_to raise_error
+    end
+    it 'expect client to return nil when calling with a non-hash identity' do
+      expect { @instance.post_email_verification('user_id', identity: "nonhash") }.to raise_error(
+        'Identity must be a hash to post an email verification'
+      )
+    end
     it 'expect client to rasie error when calling with empty body' do
       expect { @instance.post_email_verification(nil) }.to raise_error(
         'Must supply a valid user id to post an email verification'
       )
     end
   end
+
   context '.post_password_change' do
     it { expect(@instance).to respond_to(:post_password_change) }
     it 'expect client to send post to /api/v2/tickets/password-change with body' do
-      expect(@instance).to receive(:post).with('/api/v2/tickets/password-change', user_id: nil, result_url: nil,
-                                                                                  new_password: nil,
-                                                                                  connection_id: nil, email: nil)
-      expect { @instance.post_password_change }.not_to raise_error
+      expect(@instance).to receive(:post).with('/api/v2/tickets/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)
+      expect {@instance.post_password_change}.not_to raise_error
+    end
+    
+    it 'expect client to accept organization_id' do
+      expect(@instance).to receive(:post).with('/api/v2/tickets/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,
+        client_id: '123',
+        organization_id: '999'
+      )
+      expect {
+        @instance.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,
+          client_id: '123',
+          organization_id: '999')
+      }.not_to raise_error
+    end
+
+    it 'expect client to accept client_id' do
+      expect(@instance).to receive(:post).with('/api/v2/tickets/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,
+        client_id: '123'
+      )
+      expect {
+        @instance.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,
+          client_id: '123'
+        )
+      }.not_to raise_error
     end
   end
 end