rails_api_kit 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3c6f2c6b595530d2b1c63ad4a4e582c83e2555e04bc26c4d5e5c0e31e879fd34
-  data.tar.gz: 4c1700476844577653e7311cf315c1eaeca1c7eb82b1a33cd0dedd646e330311
+  metadata.gz: 398056ff21cfe533837881bebaf65d87fff8c5abba87d5cdf8a9c708d55c90ef
+  data.tar.gz: 0b9de9c9f63c4312b898a03d5b8b142a57f82f7a353588f656a0b3cc8da2d290
 SHA512:
-  metadata.gz: 1c998192b4f161fb2cb4cd7f87253f94feb9a83e05b1e30e0f70a9e533130e2f0864da68205f9babbac0c8c8b26319606ef3567008ca25499e00b51f40566c0f
-  data.tar.gz: 05c8ffa12577ce6980e98750ff4e6050276c6b4cd5d4a7aaef2e2a24c693f470e39263106b0c96b28541fdd6dfe8959a15454553f61dd5a54a6088ff427efb70
+  metadata.gz: d965e94656b77eec9b146898305aed13c67aa744c589e101065f87a828433e1a99e9677145d79285b0e630d7c26d31c0f1e0c63365b281f84007477e235a1afe
+  data.tar.gz: 45b408f991bbf95bc9341396249e2d12900a906cc0359120a6e1877607c4c41f1898fb79862db405fc13a874087ddca3aecafee5014beabf40b6421d841ad079

data/README.md

@@ -292,7 +292,7 @@ This gem leverages these excellent libraries:
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/iakbudak/api_kit
+Bug reports and pull requests are welcome on GitHub at https://github.com/ismailakbudak/rails_api_kit
 
 This project follows the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 

data/lib/api_kit/pagination.rb

@@ -49,7 +49,9 @@ module ApiKit
         *api_path_parameters.keys.map(&:to_s)
       ).as_json.with_indifferent_access
 
-      original_params[:page] = original_params[:page].dup || {}
+      # A blank `page=` passed `api_pagination_params` as "no page"; links build a fresh one.
+      page = original_params[:page]
+      original_params[:page] = page.is_a?(Hash) ? page.dup : {}
       original_url = "?"
 
       pagination.each do |page_name, number|
@@ -132,7 +134,16 @@ module ApiKit
     #
     # @return [Array] with the offset, limit and the current page number
     def api_pagination_params
-      pagination = params[:page].try(:slice, :number, :size) || {}
+      page = params[:page]
+      # `page=` names no page: the defaults, like a missing `page`.
+      page = nil if page.is_a?(String) && page.blank?
+      # `page=2` (or a JSON array / number) is not `page[number]=2`: a client error like
+      # `params.expect`, not a 500 from #slice.
+      unless page.nil? || page.is_a?(ActionController::Parameters) || page.is_a?(Hash)
+        raise ActionController::ParameterMissing, :page
+      end
+
+      pagination = page.try(:slice, :number, :size) || {}
       per_page = api_page_size(pagination)
       num = [ 1, pagination[:number].to_f.to_i ].max
 

data/lib/api_kit/version.rb

@@ -1,3 +1,3 @@
 module ApiKit
-  VERSION = "1.0.1"
+  VERSION = "1.0.2"
 end

data/spec/filtering_spec.rb

@@ -40,11 +40,18 @@ RSpec.describe UsersController, type: :request do
       let(:user) { users.last }
 
       context 'returns filtered users' do
+        # FFaker names are random, so filter on a token that no other user
+        # can match by accident
+        let(:name_prefix) { 'Filterable' }
+        let(:filterable_name) { "#{name_prefix}#{third_user.id}" }
+
         let(:params) do
+          third_user.update(first_name: filterable_name)
+
           {
             filter: {
               last_name_or_first_name_cont_any: (
-                "#{third_user.first_name[0..5]}%,#{self.class.name}"
+                "#{name_prefix},#{self.class.name}"
               )
             }
           }
@@ -56,6 +63,27 @@ RSpec.describe UsersController, type: :request do
           expect(response_json['data'][0]['id']).to eql(third_user.id)
         end
 
+        # `cont` escapes LIKE wildcards, `matches` passes them through
+        context 'with a wildcard' do
+          let(:params) do
+            third_user.update(first_name: filterable_name)
+
+            {
+              filter: {
+                last_name_or_first_name_matches_any: (
+                  "#{name_prefix}%,#{self.class.name}"
+                )
+              }
+            }
+          end
+
+          it do
+            expect(response).to have_http_status(:ok)
+            expect(response_json['data'].size).to eq(1)
+            expect(response_json['data'][0]['id']).to eql(third_user.id)
+          end
+        end
+
         context 'with a comma' do
           let(:params) do
             third_user.update(first_name: third_user.first_name + ',')

data/spec/pagination_spec.rb

@@ -332,4 +332,50 @@ RSpec.describe UsersController, type: :request do
       end
     end
   end
+
+  describe 'GET /users with a scalar page' do
+    # `page=2` is not `page[number]=2`: ParameterMissing, a client error, not a 500 from
+    # String#slice. This controller has no ApiKit::Errors, so Rails answers 400; with it, 422.
+    [ 'page=2', 'page[]=2' ].each do |query|
+      it "answers #{query} with a client error" do
+        get("#{users_path}?#{query}", headers: api_headers)
+
+        expect(response).to have_http_status(:bad_request)
+      end
+    end
+  end
+
+  describe 'GET /users with a blank page' do
+    # `page=` names no page: the defaults, like a missing `page`.
+    [ 'page=', 'page=%20' ].each do |query|
+      it "answers #{query} with the first page" do
+        get("#{users_path}?#{query}", headers: api_headers)
+
+        expect(response).to have_http_status(:ok)
+        expect(response_json.dig('meta', 'pagination', 'current')).to eq(1)
+      end
+    end
+  end
+
+  describe '#api_pagination_params with a typed non-hash page' do
+    # A JSON body reaches it typed: an array or a number is malformed too, never a #slice error.
+    let(:controller_class) do
+      Class.new do
+        include ApiKit::Pagination
+
+        attr_reader :params
+
+        def initialize(params)
+          @params = ActionController::Parameters.new(params)
+        end
+      end
+    end
+
+    [ [], 2 ].each do |page|
+      it "raises ParameterMissing for #{page.inspect}" do
+        expect { controller_class.new(page: page).send(:api_pagination_params) }
+          .to raise_error(ActionController::ParameterMissing)
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_api_kit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - Ismail Akbudak
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-09-25 00:00:00.000000000 Z
+date: 2026-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ransack
@@ -247,7 +247,7 @@ files:
 - spec/sparse_fields_type_key_spec.rb
 - spec/spec_helper.rb
 - spec/support/api_kit_rspec.rb
-homepage: https://github.com/iakbudak/api_kit
+homepage: https://github.com/ismailakbudak/rails_api_kit
 licenses:
 - MIT
 metadata: {}
@@ -266,7 +266,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: A lightweight toolkit for building JSON:API compliant APIs with Rails.