pack_api 1.0.11 → 1.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60ffd472512cc31d089307740bd4126ee2e0a21153ef1d5ec31e1a93374b4278
-  data.tar.gz: f85e543b0d98d63a9ad8bbe5ce3c87e4277421d417bcab46b367801bddba0693
+  metadata.gz: 202cffcdf9c46adf8f8228a91426a4b788db29370001ccaaeb28cf8bc8315b03
+  data.tar.gz: 60c10be7fc9ac5dcec8d045442ed9122eba404c363250c1d1b417065b93174dd
 SHA512:
-  metadata.gz: 8b1e465d3c140343af94dfe1ed09ce260ca2aa1eebcd6dd4d6779a90426a7e999351809137517c5c473207f0a549aa1a6b07ee28732c3b077aa904e63af1df00
-  data.tar.gz: a8aaab427e1c8e49c6d38236f22fde02df5d37699a302a1bcde300f6c36a1114ab93c7cea52504ab84f6927017891073a4370d6790b37555b731432744e09633
+  metadata.gz: 2c093365199196ec7372fecb715e55febae238bdc94db6ce9e940beff59057d15090c49ef60cb36e69d8447297f58a7e0e836559380e20b37988281af75a183f
+  data.tar.gz: b5a1242131bdedb8bce7918b05629d1be33703f58c2766803d5b91698a6349a23d76abf2a952e69b033ef2a5b73272d9311913d1ccd84c3c3070749a756c5e3d

data/lib/pack_api/pagination/paginator.rb

@@ -32,7 +32,6 @@ module PackAPI::Pagination
     attr_accessor :query, :sort, :total_items, :per_page, :offset, :metadata
 
     DEFAULT_PER_PAGE = 20
-    DEFAULT_SORT = 'id asc'
 
     ###
     # The range of items included in the results.

data/lib/pack_api/pagination/paginator_builder.rb

@@ -25,6 +25,8 @@
 #
 module PackAPI::Pagination
   class PaginatorBuilder
+    DEFAULT_SORT = 'id asc'
+
     attr_accessor :paginator
 
     def self.build
@@ -65,7 +67,7 @@ module PackAPI::Pagination
         @recordset_changed = original_query.to_json != @paginator.query.to_json
       end
 
-      @paginator.sort ||= Paginator::DEFAULT_SORT
+      @paginator.sort ||= DEFAULT_SORT
       if sort.present?
         @recordset_changed = sort.to_json != @paginator.sort.to_json
         @paginator.sort = sort.presence

data/lib/pack_api/querying/dynamic_enum_filter.rb

@@ -6,10 +6,17 @@ module PackAPI::Querying
     class_methods do
       def type = :dynamic_enum
 
-      def search_for_options(relation:, search:) = raise NotImplementedError
+      ###
+      # Retrieve options for this filter based on user input.
+      # @param relation [ActiveRecord::Relation] The base relation to query against for options.
+      # @param search [String, nil] An optional search term to filter options by (using wildcard matching)
+      # @param value [String, Array<String>, nil] An optional value or array of values to filter options by (exact match)
+      def dynamic_options(relation:, search: nil, value: nil) = raise NotImplementedError
 
       private
 
+      ###
+      # Static filter options is an empty array.
       def filter_options(**) = PackAPI::FrozenEmpty::ARRAY
     end
   end

data/lib/pack_api/types/collection_result_metadata.rb

@@ -4,6 +4,7 @@ module PackAPI::Types
   class CollectionResultMetadata < Dry::Struct
     attribute :first_item, Types::Integer
     attribute :last_item, Types::Integer
+    attribute :per_page, Types::Integer
     attribute :total_items, Types::Integer
 
     ###
@@ -25,7 +26,8 @@ module PackAPI::Types
       new(
         first_item: 1,
         last_item: 1,
-        total_items: 1
+        total_items: 1,
+        per_page: 1
       )
     end
 
@@ -34,6 +36,7 @@ module PackAPI::Types
         first_item: paginator.item_range.begin,
         last_item: paginator.item_range.end,
         total_items: paginator.total_items,
+        per_page: paginator.per_page,
         next_page_cursor: paginator.next_page_cursor,
         previous_page_cursor: paginator.previous_page_cursor,
         current_page_cursor: paginator.current_page_cursor,

data/lib/pack_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PackAPI
-  VERSION = "1.0.11"
+  VERSION = "1.0.13"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pack_api
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.13
 platform: ruby
 authors:
 - Flytedesk