grape-kaminari 0.1.9 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d4c7f02a80485e75ee802043d9eef21f54479e2c
-  data.tar.gz: 6bb9d2a78c258d53026ebf5a351c7808e0bc6d22
+SHA256:
+  metadata.gz: d524d760fab53973250ae175e7e484a22c0e1d76ca3a427b42d51118660fd708
+  data.tar.gz: 2c1e66d494b6b2dafdd9e7831022a7f1a6b8b10652d19acc897da2f3b150d52b
 SHA512:
-  metadata.gz: 219b6b3bc7bf4e55892ac042858f671b7d665433bc709a20e16ca476bf20589dc4cf4e5a3f5734cc8337a95d5e5d7b12ed361ba419b8bf7b9338bfbad13505ac
-  data.tar.gz: 7560c7ac82858a49aadbd8569cc9ce46d124f248af0af69f263d2560d4a6c160913462eae15cb7386052cfebaa6936df0d18dd5ba287dc87388ce434d8aebcda
+  metadata.gz: '065287dc5984a1817a7d92142c806e15e23f3aca99d510fee6dfecb710c7d3eacfe2e755d37605f4055d4ec175f4cd0994367dd2b2cdf3de54f26c2cc89961b4'
+  data.tar.gz: a0ac7c9bdac412351c1581794942982213252e1b2d0907ed1727c3be384353c926d9865da30e2cbd694211f0ce4858c2032533b9ca8a215c33fcd76cec658cca

data/.gitignore

@@ -3,7 +3,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.rubocop.yml

@@ -0,0 +1,26 @@
+AllCops:
+  TargetRubyVersion: "2.5"
+  NewCops: enable
+
+Metrics/AbcSize:
+  Enabled: false
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*_spec.rb
+Metrics/MethodLength:
+  Max: 20
+
+Naming/FileName:
+  Exclude:
+    - lib/grape-kaminari.rb
+
+Style/Documentation:
+  Enabled: false
+Style/FrozenStringLiteralComment:
+  Enabled: false
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+cache: bundler
+rvm:
+  - 2.7
+  - 2.6
+  - 2.5

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+### 0.5.0 (Next)
+
+#### Features
+
+* Your contribution here.
+
+#### Fixes
+
+* Your contribution here.
+
+### 0.4.1
+
+#### Features
+
+* [#58](https://github.com/bsm/grape-kaminari/pull/58): Allow to paginate without counting - [@dim](https://github.com/dim).
+
+### 0.4.0
+
+#### Features
+
+* [#57](https://github.com/bsm/grape-kaminari/pull/57): Introduce new params based API - [@dim](https://github.com/dim).
+* [#56](https://github.com/bsm/grape-kaminari/pull/56): Introduce a CHANGELOG - [@dim](https://github.com/dim).
+
+#### Fixes
+
+* [#57](https://github.com/bsm/grape-kaminari/pull/57): Fix issues related to Grape v1.5 release - [@dim](https://github.com/dim).
+
+### 0.3.0 (2020/08/10)
+
+* [#54](https://github.com/bsm/grape-kaminari/pull/54): Inherit paginate helper - [@dim](https://github.com/dim).
+
+### 0.2.1 (2020/06/18)
+
+#### Fixes
+
+* [#52](https://github.com/bsm/grape-kaminari/pull/52): Skip per-page range validation for non-integer values - [@dim](https://github.com/dim).
+
+### 0.2.0 (2020/06/18)
+
+Revived project, migrated to [github.com/bsm/grape-kaminari](github.com/bsm/grape-kaminari).
+
+#### Features
+
+* [#51](https://github.com/bsm/grape-kaminari/pull/51): Support for Grape 1.x - [@dim](https://github.com/dim).
+
+#### Fixes
+
+* [#51](https://github.com/bsm/grape-kaminari/pull/51): Fixed code style - [@dim](https://github.com/dim).

data/Gemfile.lock

@@ -0,0 +1,117 @@
+PATH
+  remote: .
+  specs:
+    grape-kaminari (0.4.1)
+      grape (>= 1.0, != 1.4.0)
+      kaminari-grape
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    ast (2.4.1)
+    builder (3.2.4)
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    dry-configurable (0.11.6)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.4, >= 0.4.7)
+      dry-equalizer (~> 0.2)
+    dry-container (0.7.2)
+      concurrent-ruby (~> 1.0)
+      dry-configurable (~> 0.1, >= 0.1.3)
+    dry-core (0.4.9)
+      concurrent-ruby (~> 1.0)
+    dry-equalizer (0.3.0)
+    dry-inflector (0.2.0)
+    dry-logic (1.0.8)
+      concurrent-ruby (~> 1.0)
+      dry-core (~> 0.2)
+      dry-equalizer (~> 0.2)
+    dry-types (1.4.0)
+      concurrent-ruby (~> 1.0)
+      dry-container (~> 0.3)
+      dry-core (~> 0.4, >= 0.4.4)
+      dry-equalizer (~> 0.3)
+      dry-inflector (~> 0.1, >= 0.1.2)
+      dry-logic (~> 1.0, >= 1.0.2)
+    grape (1.5.0)
+      activesupport
+      builder
+      dry-types (>= 1.1)
+      mustermann-grape (~> 1.0.0)
+      rack (>= 1.3.0)
+      rack-accept
+    i18n (1.8.5)
+      concurrent-ruby (~> 1.0)
+    kaminari-core (1.2.1)
+    kaminari-grape (1.0.1)
+      grape
+      kaminari-core (~> 1.0)
+    minitest (5.14.2)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
+    parallel (1.20.0)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    rack (2.2.3)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    regexp_parser (1.8.2)
+    rexml (3.2.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+    rubocop (1.2.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8)
+      rexml
+      rubocop-ast (>= 1.0.1)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.1.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.8)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  grape-kaminari!
+  rack-test
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -1,6 +1,7 @@
 The MIT License (MIT)
 
 Copyright (c) 2013-2014 Monterail.com LLC
+Copyright (c) 2020 Black Square Media Ltd
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of
 this software and associated documentation files (the "Software"), to deal in

data/README.md

@@ -1,6 +1,9 @@
-# Grape::Kaminari [![Gem Version](https://badge.fury.io/rb/grape-kaminari.png)](http://badge.fury.io/rb/grape-kaminari) [![Circle CI](https://circleci.com/gh/monterail/grape-kaminari.png?style=shield)](https://circleci.com/gh/monterail/grape-kaminari)
+# Grape::Kaminari
 
-[kaminari](https://github.com/amatsuda/kaminari) paginator integration for [grape](https://github.com/intridea/grape) API framework.
+[![Build Status](https://travis-ci.org/bsm/grape-kaminari.png?branch=master)](https://travis-ci.org/bsm/grape-kaminari)
+[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+
+[kaminari](https://github.com/kaminari/kaminari) paginator integration for [grape](https://github.com/intridea/grape) API framework.
 
 ## Installation
 
@@ -32,7 +35,6 @@ class MyApi < Grape::API
   resource :posts do
     desc 'Return a list of posts.'
 
-    # Annotate action with `paginate`.
     # This will add three optional params: page, per_page, and offset
     #
     # You can optionally overwrite the default :per_page setting (10)
@@ -42,8 +44,9 @@ class MyApi < Grape::API
     # You can disable the offset parameter from appearing in the API
     # documentation by setting it to false.
     #
-    paginate per_page: 20, max_per_page: 30, offset: 5
-
+    params do
+      use :pagination, per_page: 20, max_per_page: 30, offset: 5
+    end
     get do
       posts = Post.where(...)
 
@@ -87,8 +90,4 @@ X-Offset: 10
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at https://github.com/bsm/grape-kaminari.

data/Rakefile

@@ -1,5 +1,8 @@
-require "bundler/gem_tasks"
-
-task default: :spec
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
 require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
 RSpec::Core::RakeTask.new
+
+task default: %i[rubocop spec]

data/grape-kaminari.gemspec

@@ -1,28 +1,28 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'grape/kaminari/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "grape-kaminari"
+  spec.name          = 'grape-kaminari'
   spec.version       = Grape::Kaminari::VERSION
-  spec.authors       = ["Tymon Tobolski"]
-  spec.email         = ["tymon.tobolski@monterail.com"]
-  spec.description   = %q{kaminari paginator integration for grape API framework}
-  spec.summary       = %q{kaminari integration for grape}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Tymon Tobolski', 'Black Square Media']
+  spec.email         = ['info@blacksquaremedia.com']
+  spec.description   = 'kaminari paginator integration for grape API framework'
+  spec.summary       = 'kaminari integration for grape'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.start_with?('spec/') }
+  spec.test_files    = `git ls-files -z -- spec/*`.split("\x0")
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.5'
 
+  spec.add_runtime_dependency 'grape', '>= 1.0', '!= 1.4.0'
+  spec.add_runtime_dependency 'kaminari-grape'
 
-  spec.add_runtime_dependency "grape"
-  spec.add_runtime_dependency "kaminari"
-
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec', '~> 2.9'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rubocop'
 end

data/lib/grape-kaminari.rb

@@ -1,11 +1 @@
-module Grape
-  module Kaminari
-    class << self
-      def post_0_9_0_grape?
-        Gem::Version.new(Grape::VERSION) > Gem::Version.new('0.9.0')
-      end
-    end
-  end
-end
-
-require "grape/kaminari"
+require 'grape/kaminari'

data/lib/grape/kaminari.rb

@@ -1,45 +1,65 @@
-require "grape"
-require "grape/kaminari/version"
-require "grape/kaminari/max_value_validator"
-require "kaminari/grape"
+require 'grape'
+require 'grape/kaminari/version'
+require 'grape/kaminari/max_value_validator'
+require 'kaminari/grape'
 
 module Grape
   module Kaminari
-    def self.included(base)
-      base.class_eval do
-        helpers do
-          def paginate(collection)
-            collection.page(params[:page]).per(params[:per_page]).padding(params[:offset]).tap do |data|
-              header "X-Total",       data.total_count.to_s
-              header "X-Total-Pages", data.total_pages.to_s
-              header "X-Per-Page",    data.limit_value.to_s
-              header "X-Page",        data.current_page.to_s
-              header "X-Next-Page",   data.next_page.to_s
-              header "X-Prev-Page",   data.prev_page.to_s
-              header "X-Offset",      params[:offset].to_s
-            end
-          end
+    extend ActiveSupport::Concern
+
+    included do
+      helpers HelperMethods
+    end
+
+    module HelperMethods # :nodoc:
+      extend Grape::API::Helpers
+
+      params :pagination do |opts = {}|
+        opts.reverse_merge!(
+          per_page: ::Kaminari.config.default_per_page || 10,
+          max_per_page: ::Kaminari.config.max_per_page,
+          offset: 0,
+        )
+
+        optional :page, type: Integer, default: 1,
+                        desc: 'Page offset to fetch.'
+        optional :per_page, type: Integer, default: opts[:per_page],
+                            desc: 'Number of results to return per page.',
+                            max_value: opts[:max_per_page]
+
+        if opts[:offset].is_a?(Integer)
+          optional :offset, type: Integer, default: opts[:offset],
+                            desc: 'Pad a number of results.'
         end
+      end
+
+      def paginate(collection, without_count: false)
+        coll = collection.page(params[:page].to_i)
+                         .per(params[:per_page].to_i)
+                         .padding(params[:offset].to_i)
+        coll = coll.without_count if without_count && coll.respond_to?(:without_count)
+
+        unless without_count
+          header 'X-Total', coll.total_count.to_s
+          header 'X-Total-Pages', coll.total_pages.to_s
+        end
+        header 'X-Per-Page',    coll.limit_value.to_s
+        header 'X-Page',        coll.current_page.to_s
+        header 'X-Next-Page',   coll.next_page.to_s
+        header 'X-Prev-Page',   coll.prev_page.to_s
+        header 'X-Offset',      params[:offset].to_s
+
+        coll
+      end
+    end
 
-        def self.paginate(options = {})
-          options.reverse_merge!(
-            per_page: ::Kaminari.config.default_per_page || 10,
-            max_per_page: ::Kaminari.config.max_per_page,
-            offset: 0
-          )
-          params do
-            optional :page,     type: Integer, default: 1,
-                                desc: 'Page offset to fetch.'
-            optional :per_page, type: Integer, default: options[:per_page],
-                                desc: 'Number of results to return per page.',
-                                max_value: options[:max_per_page]
-            if  options[:offset].is_a? Numeric
-              optional :offset, type: Integer, default: options[:offset],
-                                desc: 'Pad a number of results.'
-            end
-          end
+    module DSLMethods # :nodoc:
+      def paginate(opts = {})
+        params do
+          use(:pagination, opts)
         end
       end
     end
+    Grape::API::Instance.extend(DSLMethods)
   end
 end

data/lib/grape/kaminari/max_value_validator.rb

@@ -1,23 +1,14 @@
 module Grape
   module Kaminari
-    base = if post_0_9_0_grape?
-             Grape::Validations::Base
-           else
-             Grape::Validations::SingleOptionValidator
-           end
-
-    class MaxValueValidator < base
+    class MaxValueValidator < Grape::Validations::Base
       def validate_param!(attr_name, params)
-        return unless params[attr_name]
-
         attr = params[attr_name]
-        if attr && @option && attr > @option
-          if Gem::Version.new(Grape::VERSION) >= Gem::Version.new('0.9.0')
-            raise Grape::Exceptions::Validation, params: [@scope.full_name(attr_name)], message: "must be less than #{@option}"
-          else
-            raise Grape::Exceptions::Validation, param: @scope.full_name(attr_name), message: "must be less than #{@option}"
-          end
-        end
+        return unless attr.is_a?(Integer) && @option && attr > @option
+
+        raise Grape::Exceptions::Validation.new(
+          params: [@scope.full_name(attr_name)],
+          message: "must be less than or equal #{@option}",
+        )
       end
     end
   end

data/lib/grape/kaminari/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Kaminari
-    VERSION = "0.1.9"
+    VERSION = '0.4.1'.freeze
   end
 end

data/spec/kaminari_spec.rb

@@ -1,138 +1,131 @@
 require 'spec_helper'
 
-class UnPaginatedAPI < Grape::API
-  # Intentionally not including Grape::Kaminari
-end
-
 class PaginatedAPI < Grape::API
   include Grape::Kaminari
 end
 
 describe Grape::Kaminari do
+  subject { Class.new(PaginatedAPI) }
 
-  describe 'unpaginated api' do
-    subject { Class.new(UnPaginatedAPI) }
-
-    it 'raises an error' do
-      expect { subject.paginate }.to raise_error(NoMethodError, /undefined method `paginate' for/i)
-    end
+  def declared_params
+    subject.namespace_stackable(:declared_params).flatten
   end
 
-  describe 'default paginated api' do
-    subject { Class.new(PaginatedAPI) }
-
-    it 'adds to declared parameters' do
-      subject.paginate
-      if Grape::Kaminari.post_0_9_0_grape?
-        expect(subject.inheritable_setting.route[:declared_params]).to eq([:page, :per_page, :offset])
-      else
-        expect(subject.settings[:declared_params]).to eq([:page, :per_page, :offset])
-      end
-    end
-
-    describe 'descriptions, validation, and defaults' do
-      before do
-        subject.paginate
-        subject.get '/' do; end
-      end
-      let(:params) {subject.routes.first.route_params}
-
-      it 'does not require :page' do
-        expect(params['page'][:required]).to eq(false)
-      end
-
-      it 'does not require :per_page' do
-        expect(params['per_page'][:required]).to eq(false)
-      end
-
-      it 'does not require :offset' do
-        expect(params['offset'][:required]).to eq(false)
-      end
+  it 'adds to declared parameters' do
+    subject.params { use :pagination }
+    expect(declared_params).to eq(%i[page per_page offset])
+  end
 
-      it 'describes :page' do
-        expect(params['page'][:desc]).to eq('Page offset to fetch.')
-      end
+  it 'may exclude :offset' do
+    subject.params { use :pagination, offset: false }
+    expect(declared_params).to eq(%i[page per_page])
+  end
 
-      it 'describes :per_page' do
-        expect(params['per_page'][:desc]).to eq('Number of results to return per page.')
-      end
+  it 'should support legacy declarations' do
+    subject.paginate
+    expect(declared_params).to eq(%i[page per_page offset])
+  end
 
-      it 'describes :offset' do
-        expect(params['offset'][:desc]).to eq('Pad a number of results.')
-      end
+  it 'should not stumble across repeated declarations' do
+    subject.paginate offset: false
+    subject.params do
+      optional :extra
+    end
+    expect(declared_params).to eq(%i[page per_page extra])
+  end
 
-      it 'validates :page as Integer' do
-        expect(params['page'][:type]).to eq('Integer')
-      end
+  describe 'descriptions, validation, and defaults' do
+    let(:params) { subject.routes.first.params }
 
-      it 'validates :per_page as Integer' do
-        expect(params['per_page'][:type]).to eq('Integer')
-      end
+    before do
+      subject.params { use :pagination }
+      subject.get('/') { 'OK' }
+    end
 
-      it 'validates :offset as Integer' do
-        expect(params['offset'][:type]).to eq('Integer')
-      end
+    it 'does not require :page' do
+      expect(params['page'][:required]).to eq(false)
+    end
 
-      it 'defaults :page to 1' do
-        expect(params['page'][:default]).to eq(1)
-      end
+    it 'does not require :per_page' do
+      expect(params['per_page'][:required]).to eq(false)
+    end
 
-      it 'defaults :per_page to Kaminari.config.default_per_page' do
-        expect(params['per_page'][:default]).to eq(::Kaminari.config.default_per_page)
-      end
+    it 'does not require :offset' do
+      expect(params['offset'][:required]).to eq(false)
+    end
 
-      it 'defaults :offset to 0' do
-        expect(params['offset'][:default]).to eq(0)
-      end
+    it 'describes :page' do
+      expect(params['page'][:desc]).to eq('Page offset to fetch.')
+    end
 
+    it 'describes :per_page' do
+      expect(params['per_page'][:desc]).to eq('Number of results to return per page.')
+    end
 
+    it 'describes :offset' do
+      expect(params['offset'][:desc]).to eq('Pad a number of results.')
     end
 
-  end
+    it 'validates :page as Integer' do
+      expect(params['page'][:type]).to eq('Integer')
+    end
 
-  describe 'custom paginated api' do
-    subject { Class.new(PaginatedAPI) }
-    def app; subject; end
+    it 'validates :per_page as Integer' do
+      expect(params['per_page'][:type]).to eq('Integer')
+    end
 
-    before do
-      subject.paginate per_page:99, max_per_page: 999, offset: 9
-      subject.get '/' do; end
+    it 'validates :offset as Integer' do
+      expect(params['offset'][:type]).to eq('Integer')
     end
-    let(:params) {subject.routes.first.route_params}
 
-    it 'defaults :per_page to customized value' do
-      expect(params['per_page'][:default]).to eq(99)
+    it 'defaults :page to 1' do
+      expect(params['page'][:default]).to eq(1)
     end
 
-    it 'succeeds when :per_page is within :max_value' do
-      get('/', page: 1, per_page: 999)
-      expect(last_response.status).to eq 200
+    it 'defaults :per_page to Kaminari.config.default_per_page' do
+      expect(params['per_page'][:default]).to eq(::Kaminari.config.default_per_page)
     end
 
-    it 'ensures :per_page is within :max_value' do
-      get('/', page: 1, per_page: 1_000)
-      expect(last_response.status).to eq 400
-      expect(last_response.body).to match /per_page must be less than 999/
+    it 'defaults :offset to 0' do
+      expect(params['offset'][:default]).to eq(0)
     end
+  end
+end
 
-    it 'defaults :offset to customized value' do
-      expect(params['offset'][:default]).to eq(9)
+describe 'custom paginated api' do
+  subject { Class.new(PaginatedAPI) }
+  let(:app) { subject }
+  let(:params) { subject.routes.first.params }
+
+  before do
+    subject.params do
+      use :pagination, per_page: 99, max_per_page: 999, offset: 9
     end
+    subject.get('/') { 'OK' }
+  end
 
+  it 'defaults :per_page to customized value' do
+    expect(params['per_page'][:default]).to eq(99)
   end
 
-  describe 'paginated api without :offset' do
-    subject { Class.new(PaginatedAPI) }
+  it 'succeeds when :per_page is within :max_value' do
+    get('/', page: 1, per_page: 999)
+    expect(last_response.status).to eq(200)
+  end
 
-    it 'excludes :offset from declared params' do
-      subject.paginate offset: false
-      if Grape::Kaminari.post_0_9_0_grape?
-        expect(subject.inheritable_setting.route[:declared_params]).not_to include(:offset)
-      else
-        expect(subject.settings[:declared_params]).not_to include(:offset)
-      end
-    end
+  it 'ensures :per_page is within :max_value' do
+    get('/', page: 1, per_page: 1_000)
+    expect(last_response.status).to eq(400)
+    expect(last_response.body).to match(/per_page must be less than or equal 999/)
+  end
 
+  it 'ensures :per_page is numeric' do
+    get('/', page: 1, per_page: 'foo')
+    expect(last_response.status).to eq(400)
+    expect(last_response.body).to match(/per_page is invalid/)
   end
 
+  it 'defaults :offset to customized value' do
+    expect(params['offset'][:default]).to eq(9)
+  end
 end

data/spec/paginate_helper_spec.rb

@@ -4,25 +4,44 @@ require 'json'
 class PaginatedAPI < Grape::API
   include Grape::Kaminari
 
-  paginate
+  params do
+    use :pagination
+  end
   get '' do
     paginate(Kaminari.paginate_array((1..10).to_a))
   end
 
-  paginate offset: false
+  params do
+    use :pagination, offset: false
+  end
   get 'no-offset' do
     paginate(Kaminari.paginate_array((1..10).to_a))
   end
+
+  params do
+    use :pagination, offset: false
+  end
+  get 'no-count' do
+    paginate(Kaminari.paginate_array((1..10).to_a), without_count: true)
+  end
+
+  resource :sub do
+    params do
+      use :pagination, per_page: 2
+    end
+    get '/' do
+      paginate(Kaminari.paginate_array((1..10).to_a))
+    end
+  end
 end
 
 describe Grape::Kaminari do
   subject { PaginatedAPI.new }
-  def app; subject; end
+  let(:app)  { subject }
   let(:json) { JSON.parse(last_response.body) }
   let(:header) { last_response.header }
 
   describe 'paginated helper' do
-
     it 'returns the first page' do
       get '/', page: 1, per_page: 3
       expect(json).to eq [1, 2, 3]
@@ -40,18 +59,37 @@ describe Grape::Kaminari do
       expect(json).to eq [1, 2, 3]
     end
 
+    it 'works without count' do
+      get '/no-count', page: 2, per_page: 3
+      expect(json).to eq [4, 5, 6]
+      expect(header).to include(
+        'X-Per-Page' => '3',
+        'X-Page' => '2',
+        'X-Next-Page' => '3',
+        'X-Prev-Page' => '1',
+      )
+      expect(header).not_to include(
+        'X-Total',
+        'X-Total-Pages',
+      )
+    end
+
     it 'sets headers' do
       get '/', page: 3, per_page: 2, offset: 1
-      expect(header['X-Total']).to eq '10'
-      expect(header['X-Total-Pages']).to eq '5'
-      expect(header['X-Per-Page']).to eq '2'
-      expect(header['X-Page']).to eq '3'
-      expect(header['X-Next-Page']).to eq '4'
-      expect(header['X-Prev-Page']).to eq '2'
-      expect(header['X-Offset']).to eq '1'
+      expect(header).to include(
+        'X-Total' => '10',
+        'X-Total-Pages' => '5',
+        'X-Per-Page' => '2',
+        'X-Page' => '3',
+        'X-Next-Page' => '4',
+        'X-Prev-Page' => '2',
+        'X-Offset' => '1',
+      )
     end
 
+    it 'can be inherited' do
+      get '/sub', page: 1
+      expect(json).to eq [1, 2]
+    end
   end
-
-
 end

data/spec/spec_helper.rb

@@ -1,19 +1,15 @@
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
-require 'kaminari'
-require 'grape'
 require 'grape-kaminari'
 require 'rack/test'
 
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
-Dir['#{File.dirname(__FILE__)}/support/**/*.rb'].each {|f| require f}
+Dir[File.expand_path('./support/**/*.rb', __dir__)].sort.each { |f| require f }
 
 I18n.enforce_available_locales = false
 
 RSpec.configure do |config|
   config.include Rack::Test::Methods
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.raise_errors_for_deprecations!
   config.order = 'random'
 end

metadata

@@ -1,14 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: grape-kaminari
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.4.1
 platform: ruby
 authors:
 - Tymon Tobolski
+- Black Square Media
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-12 00:00:00.000000000 Z
+date: 2020-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -16,16 +17,22 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
+    - - "!="
+      - !ruby/object:Gem::Version
+        version: 1.4.0
 - !ruby/object:Gem::Dependency
-  name: kaminari
+  name: kaminari-grape
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -42,16 +49,30 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -70,25 +91,43 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.9'
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: kaminari paginator integration for grape API framework
 email:
-- tymon.tobolski@monterail.com
+- info@blacksquaremedia.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -112,15 +151,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: kaminari integration for grape