auth0 4.4.0 → 5.1.2

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

@@ -0,0 +1,70 @@
+require 'spec_helper'
+describe Auth0::Api::V2::Branding do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Branding)
+    dummy_instance.extend(Auth0::Mixins::Initializer)
+    @instance = dummy_instance
+  end
+
+  context '.branding' do
+    it { expect(@instance).to respond_to(:branding) }
+
+    it 'is expected to call get /api/v2/branding' do
+      expect(@instance).to receive(:get).with('/api/v2/branding')
+      expect { @instance.branding }.not_to raise_error
+    end
+
+    it 'is expected to respond to a get_branding method' do
+      expect(@instance).to respond_to(:get_branding)
+    end
+  end
+
+  context '.patch_branding' do
+    it { expect(@instance).to respond_to(:patch_branding) }
+    it 'is expected to call post /api/v2/branding' do
+      expect(@instance).to receive(:patch).with(
+        '/api/v2/branding',
+        template: 'Test'
+      )
+      expect { @instance.patch_branding({ template: 'Test' }) }.not_to raise_error
+    end
+
+    it 'is expected to respond to a get_branding method' do
+      expect(@instance).to respond_to(:update_branding)
+    end
+  end
+
+  context '.branding_templates_for_universal_login' do
+    it { expect(@instance).to respond_to(:branding) }
+
+    it 'is expected to call get /api/v2/branding/templates/universal-login' do
+      expect(@instance).to receive(:get).with('/api/v2/branding/templates/universal-login')
+      expect { @instance.branding_templates_for_universal_login }.not_to raise_error
+    end
+
+    it 'is expected to respond to a get_branding_templates_for_universal_login method' do
+      expect(@instance).to respond_to(:get_branding_templates_for_universal_login)
+    end
+  end
+
+  context '.put_branding_templates_for_universal_login' do
+    it { expect(@instance).to respond_to(:put_branding_templates_for_universal_login) }
+    it 'is expected to call put /api/v2/branding/templates/universal-login' do
+      expect(@instance).to receive(:put).with(
+        '/api/v2/branding/templates/universal-login', template: 'Template'
+      )
+      expect do
+        @instance.put_branding_templates_for_universal_login(template: 'Template')
+      end.not_to raise_error
+    end
+  end
+
+  context '.delete_branding_templates_for_universal_login' do
+    it { expect(@instance).to respond_to(:delete_branding_templates_for_universal_login) }
+    it 'is expected to call delete /api/v2/branding/templates/universal-login' do
+      expect(@instance).to receive(:delete).with('/api/v2/branding/templates/universal-login')
+      expect { @instance.delete_branding_templates_for_universal_login() }.not_to raise_error
+    end
+  end
+end

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

@@ -5,13 +5,45 @@ describe Auth0::Api::V2::ClientGrants do
     dummy_instance.extend(Auth0::Api::V2::ClientGrants)
     @instance = dummy_instance
   end
+
   context '.client_grants' do
     it { expect(@instance).to respond_to(:client_grants) }
     it { expect(@instance).to respond_to(:get_all_client_grants) }
-    it 'is expected to send get request to /api/v2/client_grants/' do
-      expect(@instance).to receive(:get).with('/api/v2/client-grants')
+
+    it 'is expected to get /api/v2/client-grants/' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/client-grants',
+        client_id: nil,
+        audience: nil,
+        page: nil,
+        per_page: nil
+      )
       expect { @instance.client_grants }.not_to raise_error
     end
+
+    it 'is expected to send get /api/v2/client-grants/ with client_id and audience' do
+      audience = "https://samples.auth0.com/api/v2/"
+
+      expect(@instance).to receive(:get).with(
+        '/api/v2/client-grants',
+        client_id: '1',
+        audience: audience,
+        page: nil,
+        per_page: nil
+      )
+      expect { @instance.client_grants(client_id: '1', audience: audience) }.not_to raise_error
+    end
+
+    it 'is expected to send get /api/v2/client-grants/ with pagination' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/client-grants',
+        client_id: nil,
+        audience: nil,
+        page: 1,
+        per_page: 2
+      )
+      expect { @instance.client_grants(page: 1, per_page: 2) }.not_to raise_error
+    end
   end
 
   context '.create_client_grant' do

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

@@ -5,18 +5,62 @@ describe Auth0::Api::V2::Clients do
     dummy_instance.extend(Auth0::Api::V2::Clients)
     @instance = dummy_instance
   end
+
   context '.clients' do
     it { expect(@instance).to respond_to(:clients) }
     it { expect(@instance).to respond_to(:get_clients) }
-    it 'is expected to send get request to /api/v2/clients/' do
-      expect(@instance).to receive(:get).with('/api/v2/clients', fields: nil, include_fields: nil)
+
+    it 'is expected to send get request to the Clients endpoint' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/clients',
+        fields: nil,
+        include_fields: nil,
+        page: nil,
+        per_page: nil
+      )
       expect { @instance.clients }.not_to raise_error
     end
-    it 'is expected to send get request to /api/v2/clients?fields=name' do
-      expect(@instance).to receive(:get).with('/api/v2/clients', include_fields: true, fields: [:name])
-      expect { @instance.clients(fields: [:name], include_fields: true) }.not_to raise_error
+
+    it 'is expected to send get request to the Clients endpoint with a name parameter' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/clients',
+        include_fields: true,
+        fields: 'name',
+        page: nil,
+        per_page: nil
+      )
+      expect {
+        @instance.clients(fields: 'name', include_fields: true)
+      }.not_to raise_error
+    end
+
+    it 'is expected to send get request to Clients endpoint using an array of fields' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/clients',
+        include_fields: true,
+        fields: 'name,app_type',
+        page: nil,
+        per_page: nil
+      )
+      expect {
+        @instance.clients(fields: ['name','app_type'], include_fields: true)
+      }.not_to raise_error
+    end
+
+    it 'is expected to send get request to Clients endpoint with pagination' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/clients',
+        page: 1,
+        per_page: 10,
+        fields: nil,
+        include_fields: nil
+      )
+      expect {
+        @instance.clients(page: 1, per_page: 10)
+      }.not_to raise_error
     end
   end
+
   context '.client' do
     it { expect(@instance).to respond_to(:client) }
     it 'is expected to send get request to /api/v2/clients/1' do
@@ -38,6 +82,7 @@ describe Auth0::Api::V2::Clients do
     end
     it { expect { @instance.create_client('') }.to raise_error 'Must specify a valid client name' }
   end
+
   context '.delete_client' do
     it { expect(@instance).to respond_to(:delete_client) }
     it 'is expected to send delete to /api/v2/clients/1' do

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

@@ -14,11 +14,59 @@ describe Auth0::Api::V2::Connections do
       expect(@instance).to receive(:get).with(
         '/api/v2/connections',
         strategy: nil,
+        name: nil,
         fields: nil,
-        include_fields: true
+        include_fields: nil,
+        page: nil,
+        per_page: nil
       )
       expect { @instance.connections }.not_to raise_error
     end
+
+    it 'is expected to send get request to /api/v2/connections?fields=name' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/connections',
+        include_fields: true,
+        fields: 'name',
+        strategy: nil,
+        name: nil,
+        page: nil,
+        per_page: nil
+      )
+      expect {
+        @instance.connections(fields: 'name', include_fields: true)
+      }.not_to raise_error
+    end
+
+    it 'is expected to convert fields param from Array to string' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/connections',
+        include_fields: true,
+        fields: 'name,strategy',
+        strategy: nil,
+        name: nil,
+        page: nil,
+        per_page: nil
+      )
+      expect {
+        @instance.connections(fields: ['name','strategy'], include_fields: true)
+      }.not_to raise_error
+    end
+
+    it 'is expected to add pagination' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/connections',
+        page: 1,
+        per_page: 10,
+        strategy: nil,
+        name: nil,
+        fields: nil,
+        include_fields: nil
+      )
+      expect {
+        @instance.connections(page: 1, per_page: 10)
+      }.not_to raise_error
+    end
   end
 
   context '.create_connection' do

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

@@ -0,0 +1,154 @@
+require 'spec_helper'
+describe Auth0::Api::V2::Guardian do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::Guardian)
+    @instance = dummy_instance
+  end
+
+  context '.guardian_factors' do
+    it 'is expected to respond to a guardian_factors method' do
+      expect(@instance).to respond_to(:guardian_factors)
+    end
+
+    it 'is expected to respond to a get_guardian_factors method' do
+      expect(@instance).to respond_to(:get_guardian_factors)
+    end
+
+    it 'is expected to get /api/v2/guardian/factors' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/guardian/factors'
+      )
+      expect { @instance.guardian_factors }.not_to raise_error
+    end
+  end
+
+  context '.guardian_enrollment' do
+    it 'is expected to respond to a guardian_enrollment method' do
+      expect(@instance).to respond_to(:guardian_enrollment)
+    end
+
+    it 'is expected to call get request to /api/v2/guardian/enrollments/ENROLLMENT_ID' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/guardian/enrollments/ENROLLMENT_ID'
+      )
+      expect { @instance.guardian_enrollment('ENROLLMENT_ID') }.not_to raise_error
+    end
+
+    it 'is expected to raise an exception when the enrollment ID is empty' do
+      expect { @instance.guardian_enrollment(nil) }.to raise_exception(Auth0::MissingParameter)
+    end
+  end
+
+  context '.delete_guardian_enrollment' do
+    it 'is expected to respond to a delete_guardian_enrollment method' do
+      expect(@instance).to respond_to(:delete_guardian_enrollment)
+    end
+
+    it 'is expected to delete /api/v2/guardian/enrollments/ENROLLMENT_ID' do
+      expect(@instance).to receive(:delete).with('/api/v2/guardian/enrollments/ENROLLMENT_ID')
+      @instance.delete_guardian_enrollment('ENROLLMENT_ID')
+    end
+
+    it 'is expected not to delete /api/v2/guardian/enrollments/ENROLLMENT_ID if enrollment_id is blank' do
+      expect(@instance).not_to receive(:delete)
+      expect { @instance.delete_guardian_enrollment(nil) }.to raise_exception(
+        Auth0::MissingParameter
+      )
+    end
+  end
+
+  context '.guardian_sms_templates' do
+    it 'is expected to respond to a guardian_sms_templates method' do
+      expect(@instance).to respond_to(:guardian_sms_templates)
+    end
+
+    it 'is expected to call get request to /api/v2/guardian/factors/sms/templates' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/guardian/factors/sms/templates'
+      )
+      expect { @instance.guardian_sms_templates }.not_to raise_error
+    end
+  end
+
+  context '.guardian_update_enrollment_verification_templates' do
+    it 'is expected to respond to a guardian_update_enrollment_verification_templates method' do
+      expect(@instance).to respond_to(:guardian_update_enrollment_verification_templates)
+    end
+
+    it 'is expected to patch /api/v2/guardian/factors/sms/templates' do
+      expect(@instance).to receive(:put).with('/api/v2/guardian/factors/sms/templates', 'BODY')
+      @instance.guardian_update_enrollment_verification_templates('BODY')
+    end
+  end
+
+  context '.guardian_sns_provider_config' do
+    it 'is expected to respond to a guardian_sns_provider_config method' do
+      expect(@instance).to respond_to(:guardian_sns_provider_config)
+    end
+
+    it 'is expected to call get request to /api/v2/guardian/factors/push-notification/providers/sns' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/guardian/factors/push-notification/providers/sns'
+      )
+      expect { @instance.guardian_sns_provider_config }.not_to raise_error
+    end
+  end
+
+  context '.guardian_update_sns_provider_config' do
+    it 'is expected to respond to a guardian_update_sns_provider_config method' do
+      expect(@instance).to respond_to(:guardian_update_sns_provider_config)
+    end
+
+    it 'is expected to patch /api/v2/guardian/factors/push-notification/providers/sns' do
+      expect(@instance).to receive(:put).with('/api/v2/guardian/factors/push-notification/providers/sns', 'BODY')
+      @instance.guardian_update_sns_provider_config('BODY')
+    end
+  end
+
+  context '.guardian_twillo_provider_config' do
+    it 'is expected to respond to a guardian_twillo_provider_config method' do
+      expect(@instance).to respond_to(:guardian_twillo_provider_config)
+    end
+
+    it 'is expected to call get request to /api/v2/guardian/factors/sms/providers/twilio' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/guardian/factors/sms/providers/twilio'
+      )
+      expect { @instance.guardian_twillo_provider_config }.not_to raise_error
+    end
+  end
+
+  context '.guardian_update_twillo_provider_config' do
+    it 'is expected to respond to a guardian_update_twillo_provider_config method' do
+      expect(@instance).to respond_to(:guardian_update_twillo_provider_config)
+    end
+
+    it 'is expected to patch /api/v2/guardian/factors/sms/providers/twilio' do
+      expect(@instance).to receive(:put).with('/api/v2/guardian/factors/sms/providers/twilio', 'BODY')
+      @instance.guardian_update_twillo_provider_config('BODY')
+    end
+  end
+
+  context '.guardian_create_enrollment_ticket' do
+    it 'is expected to respond to a guardian_create_enrollment_ticket method' do
+      expect(@instance).to respond_to(:guardian_create_enrollment_ticket)
+    end
+
+    it 'is expected to post /api/v2/guardian/enrollments/ticket' do
+      expect(@instance).to receive(:post).with('/api/v2/guardian/enrollments/ticket', 'BODY')
+      @instance.guardian_create_enrollment_ticket('BODY')
+    end
+  end
+
+  context '.guardian_update_factor' do
+    it 'is expected to respond to a guardian_update_factor method' do
+      expect(@instance).to respond_to(:guardian_update_factor)
+    end
+
+    it 'is expected to patch /api/v2/guardian/factors/NAME' do
+      expect(@instance).to receive(:put).with('/api/v2/guardian/factors/NAME', 'BODY')
+      @instance.guardian_update_factor('NAME', 'BODY')
+    end
+  end
+end

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

@@ -13,24 +13,127 @@ describe Auth0::Api::V2::Jobs do
     end
     it { expect { @instance.get_job('') }.to raise_error('Must specify a job id') }
   end
+  context '.get_job_errors' do
+    it { expect(@instance).to respond_to(:get_job_errors) }
+    it 'expect client to send get to /api/v2/jobs/3/errors' do
+      expect(@instance).to receive(:get).with('/api/v2/jobs/3/errors')
+      expect { @instance.get_job_errors(3) }.not_to raise_error
+    end
+    it { expect { @instance.get_job_errors('') }.to raise_error('Must specify a job id') }
+  end
   context '.import_users' do
     it { expect(@instance).to respond_to(:import_users) }
     it 'expect client to send post to /api/v2/jobs/users-imports' do
       expect(@instance).to receive(:post_file).with(
-        '/api/v2/jobs/users-imports', users: 'file', connection_id: 'connnection_id'
+        '/api/v2/jobs/users-imports',
+        users: 'file',
+        connection_id: 'connnection_id',
+        upsert: false,
+        external_id: nil,
+        send_completion_email: true
       )
       expect { @instance.import_users('file', 'connnection_id') }.not_to raise_error
     end
+    it 'expect client to send post to /api/v2/jobs/users-imports with options' do
+      expect(@instance).to receive(:post_file).with(
+        '/api/v2/jobs/users-imports',
+        users: 'file',
+        connection_id: 'connnection_id',
+        upsert: true,
+        external_id: 'external_1',
+        send_completion_email: false
+      )
+      expect do
+        @instance.import_users(
+          'file',
+          'connnection_id',
+          upsert: true,
+          external_id: 'external_1',
+          send_completion_email: false
+        )
+      end.not_to raise_error
+    end
     it { expect { @instance.import_users('', 'connnection_id') }.to raise_error('Must specify a valid file') }
     it { expect { @instance.import_users('users', '') }.to raise_error('Must specify a connection_id') }
   end
+  context '.export_users' do
+    it { expect(@instance).to respond_to(:export_users) }
+    it { expect { @instance.export_users }.not_to raise_error }
+    it 'sends post to /api/v2/jobs/users-exports with correct params' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/jobs/users-exports',
+        fields: [{ name: 'author' }],
+        connection_id: 'test-connection',
+        format: 'csv',
+        limit: 10
+      )
+      @instance.export_users(
+        fields: ['author'],
+        connection_id: 'test-connection',
+        format: 'csv',
+        limit: 10
+      )
+    end
+  end
 
   context '.send_verification_email' do
-    it { expect(@instance).to respond_to(:send_verification_email) }
-    it 'expect client to send post to /api/v2/jobs/verification-email' do
-      expect(@instance).to receive(:post).with('/api/v2/jobs/verification-email', user_id: 'user_id')
-      expect { @instance.send_verification_email('user_id') }.not_to raise_error
+    it 'should respond to a send_verification_email method' do
+      expect(@instance).to respond_to(:send_verification_email)
+    end
+
+    it 'should post to the jobs email verification endpoint' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/jobs/verification-email',
+        user_id: 'test_user_id'
+      )
+      expect do
+        @instance.send_verification_email('test_user_id')
+      end.not_to raise_error
+    end
+
+    it 'should post to the jobs email verification endpoint with a client_id' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/jobs/verification-email',
+        user_id: 'test_user_id',
+        client_id: 'test_client_id'
+      )
+      expect do
+        @instance.send_verification_email('test_user_id', 'test_client_id')
+      end.not_to raise_error
+    end
+
+    it 'expect client to accept hash identity' do
+      expect(@instance).to receive(:post).with('/api/v2/jobs/verification-email', user_id: 'user_id',
+                                                                                  identity: {
+                                                                                    provider: "auth0",
+                                                                                    user_id: "user_id"
+                                                                                  })
+      expect {
+        @instance.send_verification_email('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.send_verification_email('user_id', identity: "nonhash") }.to raise_error(
+        'Identity must be a hash send an email verification'
+      )
+    end
+
+    it 'expect client to accept organization_id' do
+      expect(@instance).to receive(:post).with('/api/v2/jobs/verification-email',
+        user_id: 'user_id',
+        organization_id: 'org_id'
+      )
+
+      expect {
+        @instance.send_verification_email('user_id', organization_id: 'org_id')
+      }.not_to raise_error
+    end
+
+    it 'should raise an error if the user_id is empty' do
+      expect do
+        @instance.send_verification_email('')
+      end.to raise_error('Must specify a user id')
     end
-    it { expect { @instance.send_verification_email('') }.to raise_error('Must specify a user id') }
   end
 end

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

@@ -0,0 +1,84 @@
+require 'spec_helper'
+describe Auth0::Api::V2::LogStreams do
+  before :all do
+    dummy_instance = DummyClass.new
+    dummy_instance.extend(Auth0::Api::V2::LogStreams)
+    dummy_instance.extend(Auth0::Mixins::Initializer)
+    @instance = dummy_instance
+  end
+
+  context '.log_streams' do
+    it { expect(@instance).to respond_to(:log_streams) }
+    it { expect(@instance).to respond_to(:get_log_streams) }
+    it 'is expected to call get /api/v2/log-streams' do
+      expect(@instance).to receive(:get).with(
+        '/api/v2/log-streams'
+      )
+      expect { @instance.log_streams }.not_to raise_error
+    end
+  end
+
+  context '.log_stream' do
+    it { expect(@instance).to respond_to(:log_stream) }
+    it 'is expected to call get /api/v2/log-streams/test' do
+      expect(@instance).to receive(:get).with('/api/v2/log-streams/test')
+      expect { @instance.log_stream('test') }.not_to raise_error
+    end
+    it 'expect to raise an error when calling with empty log stream id' do
+      expect { @instance.log_stream(nil) }.to raise_error 'Must supply a valid log stream id'
+    end
+  end
+
+  context '.create_log_stream' do
+    it { expect(@instance).to respond_to(:create_log_stream) }
+    it 'is expected to call post /api/v2/log-streams' do
+      expect(@instance).to receive(:post).with(
+        '/api/v2/log-streams',
+        name: 'test',
+        type: 'https',
+        sink: {
+          httpEndpoint: "https://mycompany.com",
+          httpContentType: "string",
+          httpContentFormat: "JSONLINES",
+          httpAuthorization: "string"
+        }
+      )
+
+      @instance.create_log_stream('test', 'https',
+        httpEndpoint: "https://mycompany.com",
+        httpContentType: "string",
+        httpContentFormat: "JSONLINES",
+        httpAuthorization: "string")
+    end
+    it 'expect to raise an error when calling with empty name' do
+      expect { @instance.create_log_stream('', '', '') }.to raise_error 'Name must contain at least one character'
+    end
+    it 'expect to raise an error when calling with empty type' do
+      expect { @instance.create_log_stream('name', '', '') }.to raise_error 'Must specify a valid type'
+    end
+    it 'expect to raise an error when calling without options' do
+      expect { @instance.create_log_stream('name', 'https', nil) }.to raise_error 'Must supply a valid hash for options'
+    end
+  end
+
+  context '.delete_log_stream' do
+    it { expect(@instance).to respond_to(:delete_log_stream) }
+    it 'is expected to call delete /api/v2/log-streams/test' do
+      expect(@instance).to receive(:delete).with('/api/v2/log-streams/test')
+      expect { @instance.delete_log_stream('test') }.not_to raise_error
+    end
+    it 'expect to raise an error when calling with empty log stream id' do
+      expect { @instance.delete_log_stream(nil) }.to raise_error 'Must supply a valid log stream id'
+    end
+  end
+
+  context '.patch_log_stream' do
+    it { expect(@instance).to respond_to(:patch_log_stream) }
+    it 'is expected to send patch to /api/v2/log_streams/test' do
+      expect(@instance).to receive(:patch).with('/api/v2/log-streams/test', status: 'paused')
+      expect { @instance.patch_log_stream('test', 'paused') }.not_to raise_error
+    end
+    it { expect { @instance.patch_log_stream('', nil) }.to raise_error 'Must specify a log stream id' }
+    it { expect { @instance.patch_log_stream('test', nil) }.to raise_error 'Must specify a valid status' }
+  end
+end