smplkit 3.0.9 → 3.0.11

data/lib/smplkit/audit/actions.rb

@@ -11,25 +11,26 @@ module Smplkit
     # specific resource_type, powering the cascading-filter behavior
     # on the Activity tab.
     #
-    # ADR-047 §2.5. Sorted alphabetically; cursor pagination via
-    # +page_after+.
+    # ADR-047 §2.5. Sorted alphabetically; offset pagination
+    # (+page_number+ / +page_size+) per ADR-014.
     class Actions
       def initialize(api)
         @api = api
       end
 
-      def list(filter_resource_type: nil, page_size: nil, page_after: nil)
+      def list(filter_resource_type: nil, page_number: nil, page_size: nil, meta_total: nil)
         opts = {}
         opts[:filter_resource_type] = filter_resource_type if filter_resource_type
+        opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
-        opts[:page_after] = page_after if page_after
+        opts[:meta_total] = meta_total unless meta_total.nil?
 
         resp = Smplkit::Audit.call_api { @api.list_actions(opts) }
         rows = (resp.data || []).map { |r| Action.from_resource(r) }
-        ActionListPage.new(rows, Smplkit::Audit.next_cursor(resp.links&._next))
+        ActionListPage.new(rows, Smplkit::Audit.extract_pagination(resp.meta))
       end
     end
 
-    ActionListPage = Struct.new(:actions, :next_cursor)
+    ActionListPage = Struct.new(:actions, :pagination)
   end
 end

data/lib/smplkit/audit/models.rb

@@ -35,6 +35,20 @@ module Smplkit
       amp ? token[0...amp] : token
     end
 
+    # Pull the offset-pagination block out of a JSON:API +meta+ envelope.
+    # Returns a hash with +:page+/+:size+ (and +:total+/+:total_pages+ when
+    # the request opted into +meta[total]=true+). Always returns a hash so
+    # callers don't have to nil-check before reading individual keys.
+    def self.extract_pagination(meta)
+      pagination = meta&.pagination
+      return {} if pagination.nil?
+
+      out = { page: pagination.page, size: pagination.size }
+      out[:total] = pagination.total unless pagination.total.nil?
+      out[:total_pages] = pagination.total_pages unless pagination.total_pages.nil?
+      out
+    end
+
     # Public-facing enum for SIEM streaming destination types.
     #
     # Mirrors the +ForwarderType+ enum the audit OpenAPI spec emits

data/lib/smplkit/audit/resource_types.rb

@@ -7,24 +7,25 @@ module Smplkit
     #
     # Backed by a maintain-by-write side table (ADR-047 §2.5), so the
     # response time is independent of how many years of events the
-    # account has accumulated. Sorted alphabetically; cursor pagination
-    # via +page_after+.
+    # account has accumulated. Sorted alphabetically; offset pagination
+    # (+page_number+ / +page_size+) per ADR-014.
     class ResourceTypes
       def initialize(api)
         @api = api
       end
 
-      def list(page_size: nil, page_after: nil)
+      def list(page_number: nil, page_size: nil, meta_total: nil)
         opts = {}
+        opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
-        opts[:page_after] = page_after if page_after
+        opts[:meta_total] = meta_total unless meta_total.nil?
 
         resp = Smplkit::Audit.call_api { @api.list_resource_types(opts) }
         rows = (resp.data || []).map { |r| ResourceType.from_resource(r) }
-        ResourceTypeListPage.new(rows, Smplkit::Audit.next_cursor(resp.links&._next))
+        ResourceTypeListPage.new(rows, Smplkit::Audit.extract_pagination(resp.meta))
       end
     end
 
-    ResourceTypeListPage = Struct.new(:resource_types, :next_cursor)
+    ResourceTypeListPage = Struct.new(:resource_types, :pagination)
   end
 end

data/lib/smplkit/management/audit.rb

@@ -49,16 +49,17 @@ module Smplkit
         Smplkit::Audit::Forwarder.from_resource(resp.data)
       end
 
-      def list(forwarder_type: nil, enabled: nil, page_size: nil, page_after: nil)
+      def list(forwarder_type: nil, enabled: nil, page_number: nil, page_size: nil, meta_total: nil)
         opts = {}
         opts[:filter_forwarder_type] = Smplkit::Audit::ForwarderType.coerce(forwarder_type) if forwarder_type
         opts[:filter_enabled] = enabled unless enabled.nil?
+        opts[:page_number] = page_number if page_number
         opts[:page_size] = page_size if page_size
-        opts[:page_after] = page_after if page_after
+        opts[:meta_total] = meta_total unless meta_total.nil?
 
         resp = Smplkit::Audit.call_api { @api.list_forwarders(opts) }
         forwarders = (resp.data || []).map { |r| Smplkit::Audit::Forwarder.from_resource(r) }
-        ForwarderListPage.new(forwarders, Smplkit::Audit.next_cursor(resp.links&._next))
+        ForwarderListPage.new(forwarders, Smplkit::Audit.extract_pagination(resp.meta))
       end
 
       def get(forwarder_id)
@@ -106,6 +107,6 @@ module Smplkit
       end
     end
 
-    ForwarderListPage = Struct.new(:forwarders, :next_cursor)
+    ForwarderListPage = Struct.new(:forwarders, :pagination)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: smplkit
 version: !ruby/object:Gem::Version
-  version: 3.0.9
+  version: 3.0.11
 platform: ruby
 authors:
 - Smpl Solutions LLC
@@ -421,8 +421,6 @@ files:
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/api_model_base.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/configuration.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/action_attributes.rb
-- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/action_list_links.rb
-- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/action_list_meta.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/action_list_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/action_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/event.rb
@@ -434,21 +432,21 @@ files:
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/event_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_list_links.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_list_meta.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_list_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_delivery_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_http.rb
-- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_list_links.rb
-- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_list_meta.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_list_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_request.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/forwarder_type.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/http_header.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/list_meta.rb
+- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/pagination_meta.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_attributes.rb
-- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_links.rb
-- lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_meta.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_response.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_resource.rb
 - lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/retry_failed_deliveries_summary.rb
@@ -464,8 +462,6 @@ files:
 - lib/smplkit/_generated/audit/spec/api/resource_types_api_spec.rb
 - lib/smplkit/_generated/audit/spec/api/usage_api_spec.rb
 - lib/smplkit/_generated/audit/spec/models/action_attributes_spec.rb
-- lib/smplkit/_generated/audit/spec/models/action_list_links_spec.rb
-- lib/smplkit/_generated/audit/spec/models/action_list_meta_spec.rb
 - lib/smplkit/_generated/audit/spec/models/action_list_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/action_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/event_list_links_spec.rb
@@ -475,13 +471,13 @@ files:
 - lib/smplkit/_generated/audit/spec/models/event_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/event_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/event_spec.rb
+- lib/smplkit/_generated/audit/spec/models/forwarder_delivery_list_links_spec.rb
+- lib/smplkit/_generated/audit/spec/models/forwarder_delivery_list_meta_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_delivery_list_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_delivery_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_delivery_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_delivery_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_http_spec.rb
-- lib/smplkit/_generated/audit/spec/models/forwarder_list_links_spec.rb
-- lib/smplkit/_generated/audit/spec/models/forwarder_list_meta_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_list_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_request_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_resource_spec.rb
@@ -489,9 +485,9 @@ files:
 - lib/smplkit/_generated/audit/spec/models/forwarder_spec.rb
 - lib/smplkit/_generated/audit/spec/models/forwarder_type_spec.rb
 - lib/smplkit/_generated/audit/spec/models/http_header_spec.rb
+- lib/smplkit/_generated/audit/spec/models/list_meta_spec.rb
+- lib/smplkit/_generated/audit/spec/models/pagination_meta_spec.rb
 - lib/smplkit/_generated/audit/spec/models/resource_type_attributes_spec.rb
-- lib/smplkit/_generated/audit/spec/models/resource_type_list_links_spec.rb
-- lib/smplkit/_generated/audit/spec/models/resource_type_list_meta_spec.rb
 - lib/smplkit/_generated/audit/spec/models/resource_type_list_response_spec.rb
 - lib/smplkit/_generated/audit/spec/models/resource_type_resource_spec.rb
 - lib/smplkit/_generated/audit/spec/models/retry_failed_deliveries_summary_spec.rb
@@ -605,6 +601,7 @@ files:
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/configuration.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/error.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/error_response.rb
+- lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/list_meta.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/log_group.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/log_group_list_response.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/log_group_request.rb
@@ -621,6 +618,7 @@ files:
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger_source.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger_source_list_response.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/logger_source_resource.rb
+- lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/pagination_meta.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/service_list_response.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/service_resource.rb
 - lib/smplkit/_generated/logging/lib/smplkit_logging_client/models/usage_attributes.rb
@@ -634,6 +632,7 @@ files:
 - lib/smplkit/_generated/logging/spec/api/usage_api_spec.rb
 - lib/smplkit/_generated/logging/spec/models/error_response_spec.rb
 - lib/smplkit/_generated/logging/spec/models/error_spec.rb
+- lib/smplkit/_generated/logging/spec/models/list_meta_spec.rb
 - lib/smplkit/_generated/logging/spec/models/log_group_list_response_spec.rb
 - lib/smplkit/_generated/logging/spec/models/log_group_request_spec.rb
 - lib/smplkit/_generated/logging/spec/models/log_group_resource_spec.rb
@@ -650,6 +649,7 @@ files:
 - lib/smplkit/_generated/logging/spec/models/logger_source_resource_spec.rb
 - lib/smplkit/_generated/logging/spec/models/logger_source_spec.rb
 - lib/smplkit/_generated/logging/spec/models/logger_spec.rb
+- lib/smplkit/_generated/logging/spec/models/pagination_meta_spec.rb
 - lib/smplkit/_generated/logging/spec/models/service_list_response_spec.rb
 - lib/smplkit/_generated/logging/spec/models/service_resource_spec.rb
 - lib/smplkit/_generated/logging/spec/models/usage_attributes_spec.rb

data/lib/smplkit/_generated/audit/lib/smplkit_audit_client/models/resource_type_list_links.rb

@@ -1,148 +0,0 @@
-=begin
-#smplkit Audit API
-
-#Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
-
-The version of the OpenAPI document: 0.1.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.22.0
-
-=end
-
-require 'date'
-require 'time'
-
-module SmplkitGeneratedClient::Audit
-  class ResourceTypeListLinks < ApiModelBase
-    attr_accessor :_next
-
-    # Attribute mapping from ruby-style variable name to JSON key.
-    def self.attribute_map
-      {
-        :'_next' => :'next'
-      }
-    end
-
-    # Returns attribute mapping this model knows about
-    def self.acceptable_attribute_map
-      attribute_map
-    end
-
-    # Returns all the JSON keys this model knows about
-    def self.acceptable_attributes
-      acceptable_attribute_map.values
-    end
-
-    # Attribute type mapping.
-    def self.openapi_types
-      {
-        :'_next' => :'String'
-      }
-    end
-
-    # List of attributes with nullable: true
-    def self.openapi_nullable
-      Set.new([
-        :'_next'
-      ])
-    end
-
-    # Initializes the object
-    # @param [Hash] attributes Model attributes in the form of hash
-    def initialize(attributes = {})
-      if (!attributes.is_a?(Hash))
-        fail ArgumentError, "The input argument (attributes) must be a hash in `SmplkitGeneratedClient::Audit::ResourceTypeListLinks` initialize method"
-      end
-
-      # check to see if the attribute exists and convert string to symbol for hash key
-      acceptable_attribute_map = self.class.acceptable_attribute_map
-      attributes = attributes.each_with_object({}) { |(k, v), h|
-        if (!acceptable_attribute_map.key?(k.to_sym))
-          fail ArgumentError, "`#{k}` is not a valid attribute in `SmplkitGeneratedClient::Audit::ResourceTypeListLinks`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
-        end
-        h[k.to_sym] = v
-      }
-
-      if attributes.key?(:'_next')
-        self._next = attributes[:'_next']
-      end
-    end
-
-    # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properties with the reasons
-    def list_invalid_properties
-      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
-      invalid_properties = Array.new
-      invalid_properties
-    end
-
-    # Check to see if the all the properties in the model are valid
-    # @return true if the model is valid
-    def valid?
-      warn '[DEPRECATED] the `valid?` method is obsolete'
-      true
-    end
-
-    # Checks equality by comparing each attribute.
-    # @param [Object] Object to be compared
-    def ==(o)
-      return true if self.equal?(o)
-      self.class == o.class &&
-          _next == o._next
-    end
-
-    # @see the `==` method
-    # @param [Object] Object to be compared
-    def eql?(o)
-      self == o
-    end
-
-    # Calculates hash code according to all attributes.
-    # @return [Integer] Hash code
-    def hash
-      [_next].hash
-    end
-
-    # Builds the object from hash
-    # @param [Hash] attributes Model attributes in the form of hash
-    # @return [Object] Returns the model itself
-    def self.build_from_hash(attributes)
-      return nil unless attributes.is_a?(Hash)
-      attributes = attributes.transform_keys(&:to_sym)
-      transformed_hash = {}
-      openapi_types.each_pair do |key, type|
-        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = nil
-        elsif type =~ /\AArray<(.*)>/i
-          # check to ensure the input is an array given that the attribute
-          # is documented as an array but the input is not
-          if attributes[attribute_map[key]].is_a?(Array)
-            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
-          end
-        elsif !attributes[attribute_map[key]].nil?
-          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
-        end
-      end
-      new(transformed_hash)
-    end
-
-    # Returns the object in the form of hash
-    # @return [Hash] Returns the object in the form of hash
-    def to_hash
-      hash = {}
-      self.class.attribute_map.each_pair do |attr, param|
-        value = self.send(attr)
-        if value.nil?
-          is_nullable = self.class.openapi_nullable.include?(attr)
-          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
-        end
-
-        hash[param] = _to_hash(value)
-      end
-      hash
-    end
-
-  end
-
-end

data/lib/smplkit/_generated/audit/spec/models/forwarder_list_links_spec.rb

@@ -1,36 +0,0 @@
-=begin
-#smplkit Audit API
-
-#Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
-
-The version of the OpenAPI document: 0.1.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.22.0
-
-=end
-
-require 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for SmplkitGeneratedClient::Audit::ForwarderListLinks
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe SmplkitGeneratedClient::Audit::ForwarderListLinks do
-  #let(:instance) { SmplkitGeneratedClient::Audit::ForwarderListLinks.new }
-
-  describe 'test an instance of ForwarderListLinks' do
-    it 'should create an instance of ForwarderListLinks' do
-      # uncomment below to test the instance creation
-      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::ForwarderListLinks)
-    end
-  end
-
-  describe 'test attribute "_next"' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-end

data/lib/smplkit/_generated/audit/spec/models/resource_type_list_links_spec.rb

@@ -1,36 +0,0 @@
-=begin
-#smplkit Audit API
-
-#Append-only change-history substrate for smpl.* resources and customer-application events. ADR-047.
-
-The version of the OpenAPI document: 0.1.0
-
-Generated by: https://openapi-generator.tech
-Generator version: 7.22.0
-
-=end
-
-require 'spec_helper'
-require 'json'
-require 'date'
-
-# Unit tests for SmplkitGeneratedClient::Audit::ResourceTypeListLinks
-# Automatically generated by openapi-generator (https://openapi-generator.tech)
-# Please update as you see appropriate
-describe SmplkitGeneratedClient::Audit::ResourceTypeListLinks do
-  #let(:instance) { SmplkitGeneratedClient::Audit::ResourceTypeListLinks.new }
-
-  describe 'test an instance of ResourceTypeListLinks' do
-    it 'should create an instance of ResourceTypeListLinks' do
-      # uncomment below to test the instance creation
-      #expect(instance).to be_instance_of(SmplkitGeneratedClient::Audit::ResourceTypeListLinks)
-    end
-  end
-
-  describe 'test attribute "_next"' do
-    it 'should work' do
-      # assertion here. ref: https://rspec.info/features/3-12/rspec-expectations/built-in-matchers/
-    end
-  end
-
-end