auth0 4.4.0 → 4.5.0

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

@@ -7,10 +7,15 @@ module Auth0
 
         # Retrieves a list of all client grants.
         # @see https://auth0.com/docs/api/management/v2#!/client_grants/get_client_grants
-        #
+        # @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 client grants.
-        def client_grants
-          get(client_grants_path)
+        def client_grants (page: nil, per_page: nil)
+          request_params = {
+            page: page,
+            per_page: per_page
+          }
+          get(client_grants_path, request_params)
         end
         alias get_all_client_grants client_grants
 

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

@@ -6,16 +6,19 @@ module Auth0
         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.
+        # @see https://auth0.com/docs/api/management/v2#!/Clients/get_clients
+        # @param fields [string|Array] A comma separated list or an array of fields.
         # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
-        #
+        # @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 clients applications.
-        def clients(fields: nil, include_fields: nil)
+        def clients(fields: nil, include_fields: nil, page: nil, per_page: nil)
           include_fields = true if !fields.nil? && include_fields.nil?
           request_params = {
-            fields: fields,
-            include_fields: include_fields
+            fields: fields.is_a?(Array) ? fields.join(',') : fields,
+            include_fields: include_fields,
+            page: !page.nil? ? page.to_i : nil,
+            per_page: !page.nil? && !per_page.nil? ? per_page.to_i : nil
           }
           get(clients_path, request_params)
         end

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

@@ -7,18 +7,27 @@ module Auth0
 
         # Retrieves every connection matching the specified strategy. All connections are retrieved if no strategy is
         # being specified. Accepts a list of fields to include or exclude in the resulting list of connection objects.
-        # @see https://auth0.com/docs/api/v2#!/Connections/get_connections
-        # @param strategy [string] Provide a type of strategy to only retrieve connections with that strategy (e.g. 'ad',
-        # 'facebook', 'twitter').
+        # @see https://auth0.com/docs/api/management/v2#!/Connections/get_connections
+        # @param strategy [string] Strategy to filter connection results.
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
         # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
-        #
+        # @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 existing connections matching the strategy.
-        def connections(strategy: nil, fields: nil, include_fields: true)
+        def connections(
+          strategy: nil,
+          fields: nil,
+          include_fields: nil,
+          page: nil,
+          per_page: nil
+        )
+          include_fields = true if !fields.nil? && include_fields.nil?
           request_params = {
             strategy: strategy,
-            fields: fields,
-            include_fields: include_fields
+            fields: fields.is_a?(Array) ? fields.join(',') : fields,
+            include_fields: include_fields,
+            page: !page.nil? ? page.to_i : nil,
+            per_page: !page.nil? && !per_page.nil? ? per_page.to_i : nil
           }
           get(connections_path, request_params)
         end

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

@@ -14,14 +14,18 @@ module Auth0
         # @param fields [string] A comma separated list of fields to include or exclude from the result.
         # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         # @param stage [string] Retrieves rules that match the execution stage (defaults to login_success).
+        # @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 existing rules.
-        def rules(enabled: nil, fields: nil, include_fields: nil, stage: nil)
+        def rules(enabled: nil, fields: nil, include_fields: nil, stage: nil, page: nil, per_page: nil)
           request_params = {
             enabled:          enabled,
             fields:           fields,
             include_fields:   include_fields,
-            stage:            stage
+            stage:            stage,
+            page:             page,
+            per_page:         per_page
           }
           get(rules_path, request_params)
         end

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

@@ -5,18 +5,21 @@ module Auth0
       module Users
         attr_reader :users_path
 
-        # Retrieves a list of existing users.
-        # @see https://auth0.com/docs/api/v2#!/Users/get_users
-        # @param per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
-        # @param page [integer]  The page number. Zero based.
-        # @param include_totals [boolean] True if a query summary must be included in the result.
-        # @param sort [string] The field to use for sorting. 1 == ascending and -1 == descending.
-        # @param connection [string] Connection filter.
-        # @param fields [string] A comma separated list of fields to include or exclude from the result.
-        # @param include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
-        # @param q [string] Query in Lucene query string syntax. Only fields in app_metadata, user_metadata or the
-        # normalized user profile are searchable.
-        #
+        # Retrieves a list of Auth0 users.
+        # @see https://auth0.com/docs/api/management/v2#!/Users/get_users
+        # @param options - The Hash options used to refine the User results.
+        #   :per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
+        #   :page [integer] The page number. Zero based.
+        #   :include_totals [boolean] True if a query summary must be included in the result.
+        #   :sort [string] The field to use for sorting. 1 == ascending and -1 == descending.
+        #   :connection [string] Connection to filter results by.
+        #   :fields [string] A comma separated list of result fields.
+        #   :include_fields [boolean] True to include :fields, false to exclude.
+        #   :q [string] Query in Lucene query string syntax.
+        #   :search_engine [string] User search engine version.
+        #     - Will default to v2 if no value is passed.
+        #     - Default will change to v3 on 11/13/2018
+        #     - See https://auth0.com/docs/users/search/v3#migrate-from-search-engine-v2-to-v3
         # @return [json] Returns the list of existing users.
         def users(options = {})
           request_params = {
@@ -27,9 +30,9 @@ module Auth0
             connection:     options.fetch(:connection, nil),
             fields:         options.fetch(:fields, nil),
             include_fields: options.fetch(:include_fields, nil),
-            q:              options.fetch(:q, nil)
+            q:              options.fetch(:q, nil),
+            search_engine:  options.fetch(:search_engine, nil)
           }
-          request_params[:search_engine] = :v2 if request_params[:q]
           get(users_path, request_params)
         end
         alias get_users users

data/lib/auth0/version.rb

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

data/spec/integration/lib/auth0/api/api_authentication_spec.rb

@@ -1,78 +1,61 @@
 require 'spec_helper'
 describe Auth0::Api::AuthenticationEndpoints do
-  attr_reader :client, :impersonate_user, :impersonator_user, :global_client, :password
+  attr_reader :client,
+              :impersonate_user,
+              :global_client,
+              :password
 
   before(:all) do
     @client = Auth0Client.new(Credentials.v2_creds)
-    impersonate_username = Faker::Internet.user_name
-    impersonate_email = "#{entity_suffix}#{Faker::Internet.safe_email(impersonate_username)}"
-    @password = Faker::Internet.password
-    @impersonate_user = client.create_user(impersonate_username, 'email' => impersonate_email,
-                                                                 'password' => password,
-                                                                 'email_verified' => true,
-                                                                 'connection' =>
-                                                                  Auth0::Api::AuthenticationEndpoints::UP_AUTH,
-                                                                 'app_metadata' => {})
-
-    impersonator_username = Faker::Internet.user_name
-    impersonator_email = "#{entity_suffix}#{Faker::Internet.safe_email(impersonator_username)}"
-    @impersonator_user = client.create_user(impersonator_username, 'email' => impersonator_email,
-                                                                   'password' => password,
-                                                                   'email_verified' => true,
-                                                                   'connection' =>
-                                                                    Auth0::Api::AuthenticationEndpoints::UP_AUTH,
-                                                                   'app_metadata' => {})
-
     @global_client = Auth0Client.new(v1_global_creds)
-  end
 
-  after(:all) do
-    client.delete_user(impersonate_user['user_id'])
-    client.delete_user(impersonator_user['user_id'])
+    impersonate_username = Faker::Internet.user_name
+    impersonate_email = "#{entity_suffix}" \
+      "#{Faker::Internet.safe_email(impersonate_username)}"
+    @password = Faker::Internet.password
+    @impersonate_user = client.create_user(
+      impersonate_username,
+      'email' => impersonate_email,
+      'password' => password,
+      'email_verified' => true,
+      'connection' =>
+      Auth0::Api::AuthenticationEndpoints::UP_AUTH,
+      'app_metadata' => {}
+    )
   end
 
   describe '.obtain_access_token' do
-    let(:acces_token) { global_client.obtain_access_token }
+    let(:acces_token) { @global_client.obtain_access_token }
     it { expect(acces_token).to_not be_nil }
   end
 
   describe '.signup' do
     let(:signup_username) { Faker::Internet.user_name }
-    let(:signup_email) { "#{entity_suffix}#{Faker::Internet.safe_email(signup_username)}" }
-    let(:signup) { global_client.signup(signup_email, password) }
+    let(:signup_email) {
+      "#{entity_suffix}#{Faker::Internet.safe_email(signup_username)}"
+    }
+    let(:signup) { @global_client.signup(signup_email, @password) }
     it { expect(signup).to(include('_id', 'email')) }
     it { expect(signup['email']).to eq signup_email }
   end
 
   describe '.change_password' do
     let(:change_password) do
-      global_client.change_password(impersonate_user['user_id'], '')
+      @global_client.change_password(@impersonate_user['user_id'], '')
     end
-    it { expect(change_password).to(include('We\'ve just sent you an email to reset your password.')) }
-  end
-
-  skip '.start_passwordless_email_flow' do
-    let(:start_passwordless_email_flow) do
-      global_client.start_passwordless_email_flow(impersonate_user['email'])
+    it do
+      expect(@global_client.change_password(@impersonate_user['user_id'], ''))
+        .to(include('We\'ve just sent you an email to reset your password.'))
     end
-    it { expect(start_passwordless_email_flow['email']).to eq impersonate_user['email'] }
-    it { expect(start_passwordless_email_flow).to(include('_id', 'email')) }
-  end
-
-  skip '.start_passwordless_sms_flow' do
-    let(:phone_number) { '+19143686854' }
-    let(:start_passwordless_sms_flow) { global_client.start_passwordless_sms_flow(phone_number) }
-    it { expect(start_passwordless_sms_flow['phone_number']).to eq phone_number }
-    it { expect(start_passwordless_sms_flow).to(include('_id', 'phone_number', 'request_language')) }
   end
 
   describe '.saml_metadata' do
-    let(:saml_metadata) { global_client.saml_metadata }
+    let(:saml_metadata) { @global_client.saml_metadata }
     it { expect(saml_metadata).to(include('<EntityDescriptor')) }
   end
 
   describe '.wsfed_metadata' do
-    let(:wsfed_metadata) { global_client.wsfed_metadata }
+    let(:wsfed_metadata) { @global_client.wsfed_metadata }
     it { expect(wsfed_metadata).to(include('<EntityDescriptor')) }
   end
 end

data/spec/integration/lib/auth0/api/v2/api_client_grants_spec.rb

@@ -5,45 +5,49 @@ describe Auth0::Api::V2::ClientGrants do
   before(:all) do
     @client = Auth0Client.new(v2_creds)
     @client_id = v2_creds[:client_id]
-    sleep 1
-    @existing_client = client.create_client("client#{entity_suffix}")
-    sleep 1
+    @existing_client = client.create_client("client-grant-test-#{entity_suffix}")
     @audience = "https://#{client.clients[0]['tenant']}.auth0.com/api/v2/"
     @scope = [Faker::Lorem.word]
-    sleep 1
-    @existing_grant = client.create_client_grant('client_id' => existing_client['client_id'],
-                                                 'audience' => audience,
-                                                 'scope' => scope)
+    @existing_grant = client.create_client_grant(
+      'client_id' => existing_client['client_id'],
+      'audience' => audience,
+      'scope' => scope
+    )
   end
 
   after(:all) do
     grants = client.client_grants
     grants.each do |grant|
-      sleep 1
       client.delete_client_grant(grant['id'])
     end
   end
 
   describe '.client_grants' do
     let(:client_grants) do
-      sleep 1
       client.client_grants
     end
 
-    it do
-      sleep 1
+    it 'is expected to have a result' do
       expect(client_grants.size).to be > 0
     end
-    it do
-      sleep 1
+
+    it 'is expected to match the created grant' do
       expect(client_grants).to include(existing_grant)
     end
+
+    it 'is expected to return the first page of one result' do
+      results = client.client_grants(
+        page: 0,
+        per_page: 1
+      )
+      expect(results.first).to equal(results.last)
+      expect(results.first).to eq(existing_grant)
+    end
   end
 
   describe '.patch_client_grant' do
     let(:new_scope) { [Faker::Lorem.word] }
     it do
-      sleep 1
       expect(
         client.patch_client_grant(
           existing_grant['id'],
@@ -55,7 +59,6 @@ describe Auth0::Api::V2::ClientGrants do
 
   describe '.delete_client_grant' do
     it do
-      sleep 1
       expect { client.delete_client_grant(existing_grant['id']) }.to_not raise_error
     end
   end

data/spec/integration/lib/auth0/api/v2/api_clients_spec.rb

@@ -26,15 +26,31 @@ describe Auth0::Api::V2::Clients do
     context '#filters' do
       it do
         sleep 1
-        expect(client.clients(fields: [:name, :callbacks].join(',')).first).to(include('name', 'callbacks'))
+        expect(client.clients(
+          fields: [:name, :callbacks].join(',')
+        ).first).to(include('name', 'callbacks'))
       end
       it do
         sleep 1
-        expect(client.clients(fields: [:callbacks].join(',')).first).to_not(include('name'))
+        expect(client.clients(
+          fields: [:callbacks].join(',')).first
+        ).to_not(include('name'))
       end
       it do
         sleep 1
-        expect(client.clients(fields: [:callbacks].join(','), include_fields: false).first).to_not(include('callbacks'))
+        expect(client.clients(
+          fields: [:callbacks].join(','),
+          include_fields: false
+        ).first).to_not(include('callbacks'))
+      end
+      it do
+        sleep 1
+        results = client.clients(
+          fields: :name,
+          page: 0,
+          per_page: 1
+        )
+        expect(results.first).to equal(results.last)
       end
     end
   end

data/spec/integration/lib/auth0/api/v2/api_rules_spec.rb

@@ -16,47 +16,52 @@ describe Auth0::Api::V2::Rules do
   after(:all) do
     rules = client.rules
     rules.each do |rule|
-      sleep 1
       client.delete_rule(rule['id'])
     end
   end
 
   describe '.rules' do
     let(:rules) do
-      sleep 1
       client.rules
     end
 
     it do
-      sleep 1
       expect(rules.size).to be > 0
     end
 
     context '#filters' do
       it do
-        sleep 1
+        sleep 0.5
         expect(client.rules(enabled: true).size).to be >= 1
       end
 
       it do
-        sleep 1
+        sleep 0.5
         expect(client.rules(enabled: false).size).to be >= 1
       end
 
       it do
-        sleep 1
+        sleep 0.5
         expect(client.rules(enabled: true, fields: [:script, :order].join(',')).first).to(include('script', 'order'))
       end
+
       it do
-        sleep 1
+        sleep 0.5
         expect(client.rules(enabled: true, fields: [:script].join(',')).first).to_not(include('order', 'name'))
       end
+
+      it do
+        sleep 0.5
+        rule_1 = client.rules(fields: :name, page: 0, per_page: 2)
+        sleep 0.5
+        rule_2 = client.rules(fields: :name, page: 1, per_page: 1)
+        expect(rule_1.last).to eq(rule_2.first)
+      end
     end
   end
 
   describe '.rule' do
     it do
-      sleep 1
       expect(client.rule(enabled_rule['id'])).to(
         include('stage' => enabled_rule['stage'], 'order' => enabled_rule['order'], 'script' => enabled_rule['script'])
       )
@@ -64,21 +69,17 @@ describe Auth0::Api::V2::Rules do
 
     context '#filters' do
       let(:rule_include) do
-        sleep 1
         client.rule(enabled_rule['id'], fields: [:stage, :order, :script].join(','))
       end
       let(:rule_not_include) do
-        sleep 1
         client.rule(enabled_rule['id'], fields: :stage, include_fields: false)
       end
 
       it do
-        sleep 1
         expect(rule_include).to(include('stage', 'order', 'script'))
       end
 
       it do
-        sleep 1
         expect(rule_not_include).to(include('order', 'script'))
         expect(rule_not_include).to_not(include('stage'))
       end
@@ -91,29 +92,24 @@ describe Auth0::Api::V2::Rules do
     let(:script) { 'function(test)' }
     let(:enabled) { false }
     let!(:rule) do
-      sleep 1
       client.create_rule(name, script, nil, enabled, stage)
     end
     it do
-      sleep 1
       expect(rule).to include('name' => name, 'stage' => stage, 'script' => script)
     end
   end
 
   describe '.delete_rule' do
     it do
-      sleep 1
       expect { client.delete_rule(enabled_rule['id']) }.to_not raise_error
     end
     it do
-      sleep 1
       expect { client.delete_rule '' }.to raise_error(Auth0::InvalidParameter)
     end
   end
 
   describe '.update_rule' do
     it do
-      sleep 1
       expect(client.update_rule(disabled_rule['id'], enabled: true)).to(include('enabled' => true))
     end
   end