auth0 5.2.0 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b3563e4bf62c09fff26ea8b276131cbec25df91f0d25b85182490df7e71a6eea
-  data.tar.gz: 89cd204c4a5a0ef27ceec06f7bcb4af91328850013d0e6f8fa22b4cc718281af
+  metadata.gz: 1d21b8018643c7c1fbe1749efc7bd375c6fca4bc67b8a7f6c1036bf17594c886
+  data.tar.gz: 7b89fc89c380469c0db6c86ddd4f00e6c1502a68c5f13c4bfcbbc35d58c6a23f
 SHA512:
-  metadata.gz: b99d7e3483904fce1d4e657c5b309ade0c94b8031e00b86afe65a4d7decb5fbdc034d08179d393b7427005f3295a8e496d6f027b8bbb9e3d432e3e9f419bdac4
-  data.tar.gz: 26dd85e196c16c135a6b78f933e7ddb30958f74c28bfc18f798ce0a3529e50b06bcd970df9439d704f665744365e80db00cfad37d22812a0e086afe6c2fdff71
+  metadata.gz: 93fc45bd2a0c457d2f387291eb77cfabcad12c68bfa95d012b9ceeff3b62e25dfd31e8bd7ea67047c89a131f99ef375beb87dedaaabbaae391d6c210860b25cd
+  data.tar.gz: 694021376e92ab80198642919be1c2b94d27eb74a75862c4fdc15509251339faa6dd7eda013f7ab06df202ee4beeceab7465dfa0ae53b454e30c05e6338dbe09

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Change Log
 
+## [v5.3.0](https://github.com/auth0/ruby-auth0/tree/v5.3.0) (2021-07-23)
+
+[Full Changelog](https://github.com/auth0/ruby-auth0/compare/v5.2.0..v5.3.0)
+
+**Added**
+
+- Checkpoint Pagination [\#284](https://github.com/auth0/ruby-auth0/pull/284) ([davidpatrick](https://github.com/davidpatrick))
+
 ## [v5.2.0](https://github.com/auth0/ruby-auth0/tree/v5.2.0) (2021-07-20)
 
 [Full Changelog](https://github.com/auth0/ruby-auth0/compare/v5.1.2..v5.2.0)

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

@@ -16,8 +16,8 @@ module Auth0
         #   * :fields [string] A comma separated list of fields to include or exclude from the result.
         #   * :include_fields [boolean] True if the fields specified are to be included in the result, false otherwise.
         #   * :include_totals [string] True if a query summary must be included in the result, false otherwise.
-        #   * :from [string] Log Event Id to start retrieving logs. You can limit the amount of logs using the take parameter.
-        #   * :take [integer] The total amount of entries to retrieve when using the from parameter.
+        #   * :from [string] For checkpoint pagination, the ID from which to start selection from.
+        #   * :take [integer] For checkpoint pagination, the number of entries to retrieve. Default is 50.
         # Default: 50. Max value: 100.
         #
         # @return [json] Returns the list of existing log entries.

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

@@ -12,12 +12,16 @@ module Auth0
         # @param options [hash] The Hash options used to define the paging of rersults
         #   * :per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
         #   * :page [integer] The page number. Zero based.
+        #   * :from [string] For checkpoint pagination, the ID from which to start selection from.
+        #   * :take [integer] For checkpoint pagination, the number of entries to retrieve. Default is 50.
         #   * :include_totals [boolean] True to include query summary in the result, false or nil otherwise.
         # @return [json] All Organizations
         def organizations(options = {})
           request_params = {
             per_page:       options.fetch(:per_page, nil),
             page:           options.fetch(:page, nil),
+            from:           options.fetch(:from, nil),
+            take:           options.fetch(:take, nil),
             include_totals: options.fetch(:include_totals, nil)
           }
           get(organizations_path, request_params)
@@ -212,13 +216,25 @@ module Auth0
         # Get Members in a Organization
         # @see https://auth0.com/docs/api/management/v2/#!/Organizations/get_members
         # @param organization_id [string] The Organization ID
-        # @param user_id [string] The User ID
+        # @param options [hash] The Hash options used to define the paging of rersults
+        #   * :per_page [integer] The amount of entries per page. Default: 50. Max value: 100.
+        #   * :page [integer] The page number. Zero based.
+        #   * :from [string] For checkpoint pagination, the ID from which to start selection from.
+        #   * :take [integer] For checkpoint pagination, the number of entries to retrieve. Default is 50.
+        #   * :include_totals [boolean] True to include query summary in the result, false or nil otherwise.
         #
         # @return [json] Returns the members for the given organization
-        def get_organizations_members(organization_id)
+        def get_organizations_members(organization_id, options = {})
           raise Auth0::MissingOrganizationId, 'Must supply a valid organization_id' if organization_id.to_s.empty?
+          request_params = {
+            per_page:       options.fetch(:per_page, nil),
+            page:           options.fetch(:page, nil),
+            from:           options.fetch(:from, nil),
+            take:           options.fetch(:take, nil),
+            include_totals: options.fetch(:include_totals, nil)
+          }
           path = "#{organizations_members_path(organization_id)}"
-          get(path)
+          get(path, request_params)
         end
 
         # Add members in an organization

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

@@ -87,13 +87,17 @@ module Auth0
         # @param options [hash] A hash of options for getting Roles
         #   - per_page: Number of Roles to return.
         #   - page: Page number to return, zero-based.
-        #   - include_totals: True to include query summary in the result, false or nil otherwise.
+        #   * :from [string] For checkpoint pagination, the ID from which to start selection from.
+        #   * :take [integer] For checkpoint pagination, the number of entries to retrieve. Default is 50.
+        #   * :include_totals [boolean] True to include query summary in the result, false or nil otherwise.
         def get_role_users(role_id, options = {})
           raise Auth0::MissingParameter, 'Must supply a valid role_id' if role_id.to_s.empty?
 
           request_params = {
-            per_page: options.fetch(:per_page, nil),
-            page: options.fetch(:page, nil),
+            per_page:       options.fetch(:per_page, nil),
+            page:           options.fetch(:page, nil),
+            from:           options.fetch(:from, nil),
+            take:           options.fetch(:take, nil),
             include_totals: options.fetch(:include_totals, nil)
           }
           get "#{roles_path}/#{role_id}/users", request_params

data/lib/auth0/version.rb

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

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

@@ -20,6 +20,8 @@ describe Auth0::Api::V2::Organizations do
         '/api/v2/organizations',
         per_page: nil,
         page: nil,
+        from: nil,
+        take: nil,
         include_totals: nil
       )
       expect { @instance.organizations }.not_to raise_error
@@ -30,12 +32,16 @@ describe Auth0::Api::V2::Organizations do
         '/api/v2/organizations',
         per_page: 10,
         page: 1,
+        from: 'org_id',
+        take: 50,
         include_totals: true
       )
       expect do
         @instance.organizations(
           per_page: 10,
           page: 1,
+          from: 'org_id',
+          take: 50,
           include_totals: true
         )
       end.not_to raise_error
@@ -438,19 +444,38 @@ describe Auth0::Api::V2::Organizations do
       expect { @instance.get_organizations_members(nil) }.to raise_exception(Auth0::MissingOrganizationId)
     end
 
-    it 'is expected to get invitations for an org' do
+    it 'is expected to get members for an org' do
       expect(@instance).to receive(:get).with(
-        '/api/v2/organizations/org_id/members'
+        '/api/v2/organizations/org_id/members',
+        per_page: nil,
+        page: nil,
+        from: nil,
+        take: nil,
+        include_totals: nil
       )
-      expect { @instance.get_organizations_members('org_id') }.not_to raise_error
+      expect do
+        @instance.get_organizations_members('org_id')
+      end.not_to raise_error
     end
 
-    it 'is expected to get members for an org' do
+    it 'is expected to get /api/v2/organizations with custom parameters' do
       expect(@instance).to receive(:get).with(
-        '/api/v2/organizations/org_id/members'
+        '/api/v2/organizations/org_id/members',
+        per_page: 10,
+        page: 1,
+        from: 'org_id',
+        take: 50,
+        include_totals: true
       )
       expect do
-        @instance.get_organizations_members('org_id')
+        @instance.get_organizations_members(
+          'org_id',
+          per_page: 10,
+          page: 1,
+          from: 'org_id',
+          take: 50,
+          include_totals: true
+        )
       end.not_to raise_error
     end
   end

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

@@ -152,6 +152,8 @@ describe Auth0::Api::V2::Roles do
         '/api/v2/roles/ROLE_ID/users',
         per_page: nil,
         page: nil,
+        from: nil,
+        take: nil,
         include_totals: nil
       )
       expect { @instance.get_role_users('ROLE_ID') }.not_to raise_error
@@ -162,10 +164,12 @@ describe Auth0::Api::V2::Roles do
         '/api/v2/roles/ROLE_ID/users',
         per_page: 30,
         page: 4,
+        from: 'org_id',
+        take: 50,
         include_totals: true
       )
       expect do
-        @instance.get_role_users('ROLE_ID', per_page: 30, page: 4, include_totals: true)
+        @instance.get_role_users('ROLE_ID', per_page: 30, page: 4, from: 'org_id', take: 50, include_totals: true)
       end.not_to raise_error
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: auth0
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.3.0
 platform: ruby
 authors:
 - Auth0
@@ -11,7 +11,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-07-20 00:00:00.000000000 Z
+date: 2021-07-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client