grape-pagy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 52b012ea708cc341716fae9dc594335ef2b2de57498dca9643e89cb38caf97e2
+  data.tar.gz: 264bcfea9ce1e8e7310c12e2e68e9e70a5482d6a7d2fd6f506c5d8ed9bac6715
+SHA512:
+  metadata.gz: ac1d11277bb770f7a56f9b88d966ba2e948d593fec46f28140a1b7961c2a14df95b2c7e48f48a59a4dafa8008c4498e89ea7d1050956398a54a9a1816bdfd9fc
+  data.tar.gz: 8e23241b263e2fa2164674847b915517d93831ede7da6a49add2b4f5252ddb2a3621d215922799649335d79459a2727c8372fdfd563e8a0b64f4300fd29f6a26

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+.rubocop-https?--*

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_from:
+  - https://gitlab.com/bsm/misc/raw/master/rubocop/default.yml
+
+AllCops:
+  TargetRubyVersion: "2.5"
+
+Naming/FileName:
+  Exclude: ["lib/grape-pagy.rb"]

data/.travis.yml

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

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+### 0.1.0
+
+* Initial release

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,114 @@
+PATH
+  remote: .
+  specs:
+    grape-pagy (0.1.0)
+      grape (>= 1.5)
+      pagy
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.3)
+      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)
+    minitest (5.14.2)
+    mustermann (1.1.1)
+      ruby2_keywords (~> 0.0.1)
+    mustermann-grape (1.0.1)
+      mustermann (>= 1.0.0)
+    pagy (3.8.3)
+    parallel (1.19.2)
+    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.1)
+    rexml (3.2.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.3)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    rubocop (0.92.0)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
+      rexml
+      rubocop-ast (>= 0.5.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.7.1)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    ruby2_keywords (0.0.2)
+    thread_safe (0.3.6)
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.7.0)
+    zeitwerk (2.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  grape-pagy!
+  rack-test
+  rake
+  rspec
+  rubocop
+
+BUNDLED WITH
+   2.1.4

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright 2020 Black Square Media Ltd
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+  http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/README.md

@@ -0,0 +1,83 @@
+# Grape::Pagy
+
+[![Build Status](https://travis-ci.org/bsm/grape-pagy.png?branch=master)](https://travis-ci.org/bsm/grape-pagy)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
+
+[Pagy](https://github.com/ddnexus/pagy) pagination for [grape](https://github.com/ruby-grape/grape) API framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-pagy'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install grape-pagy
+```
+
+## Usage
+
+```ruby
+class MyApi < Grape::API
+  # Include helpers in your API.
+  helpers Grape::Pagy::Helpers
+
+  resource :posts do
+    desc 'Return a list of posts.'
+    params do
+      # This will add two optional params: :page and :items.
+      # The parameter names can be globally configured by adjusting
+      # global Pagy::VARS[:page_param] and Pagy::VARS[:item_param]
+      # settings.
+      use :pagination
+    end
+    get do
+      posts = Post.all.order(created_at: :desc)
+      paginate(posts)
+    end
+  end
+
+  resource :strings do
+    params do
+      # Override the number items returned, defaults to Pagy::VARS[:items].
+      use :pagination, items: 2
+    end
+    get do
+      words = %w[an array of words]
+      # This supports array as well as relations.
+      # Allows to override global Pagy::VARS settings.
+      paginate(words, max_items: )
+    end
+  end
+end
+```
+
+Example request:
+
+```shell
+curl -si http://localhost:8080/api/posts?page=3&items=5
+```
+
+The response will be paginated and also will include the following headers:
+
+```
+Current-Page: 3
+Page-Items: 5
+Total-Count: 22
+Total-Pages: 5
+Link: <http://localhost:8080/api/posts?page=1&items=5>; rel="first", <http://localhost:8080/api/posts?page=4&items=5>; rel="next", <http://localhost:8080/api/posts?page=2&items=5>; rel="prev", <http://localhost:8080/api/posts?page=5&items=5>; rel="last"),
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/bsm/grape-pagy.

data/Rakefile

@@ -0,0 +1,8 @@
+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-pagy.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-pagy'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Black Square Media']
+  spec.email         = ['info@blacksquaremedia.com']
+  spec.description   = 'Pagy paginator for grape API'
+  spec.summary       = ''
+  spec.homepage      = ''
+  spec.license       = 'Apache-2.0'
+
+  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.5'
+  spec.add_runtime_dependency 'pagy'
+
+  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-pagy.rb

@@ -0,0 +1 @@
+require 'grape/pagy'

data/lib/grape/pagy.rb

@@ -0,0 +1,45 @@
+require 'grape'
+require 'pagy'
+require 'pagy/extras/arel'
+require 'pagy/extras/array'
+require 'pagy/extras/headers'
+require 'pagy/extras/items'
+require 'pagy/extras/overflow'
+
+module Grape
+  module Pagy
+    Pager = Struct.new :request, :params do
+      include ::Pagy::Backend
+
+      def paginate(collection, via: nil, **opts, &block)
+        pagy_with_items(opts)
+        via ||= if collection.respond_to?(:arel_table)
+                  :arel
+                elsif collection.is_a?(Array)
+                  :array
+                end
+
+        method = [:pagy, via].compact.join('_')
+        page, scope = send(method, collection, **opts)
+
+        pagy_headers(page).each(&block)
+        scope
+      end
+    end
+
+    module Helpers
+      extend Grape::API::Helpers
+
+      params :pagination do |items: ::Pagy::VARS[:items]|
+        optional ::Pagy::VARS[:page_param], type: Integer, default: 1, desc: 'Page offset to fetch.'
+        optional ::Pagy::VARS[:items_param], type: Integer, default: items, desc: 'Number of items to return per page.'
+      end
+
+      def paginate(collection, via: nil, **opts)
+        Pager.new(request, params).paginate(collection, via: via, **opts) do |key, value|
+          header key, value
+        end
+      end
+    end
+  end
+end

data/spec/grape/pagy_spec.rb

@@ -0,0 +1,73 @@
+require 'spec_helper'
+
+describe Grape::Pagy do
+  include Rack::Test::Methods
+
+  let(:app) { TestAPI }
+
+  it 'should paginate' do
+    get '/'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Current-Page' => '1',
+      'Link'         => %(<http://example.org/?page=1>; rel="first", <http://example.org/?page=2>; rel="next", <http://example.org/?page=3>; rel="last"),
+      'Page-Items'   => '5',
+      'Total-Count'  => '12',
+      'Total-Pages'  => '3',
+    )
+    expect(last_response.body).to eq(%([1, 2, 3, 4, 5]))
+  end
+
+  it 'should accept page and items parameters' do
+    get '/?page=2&items=3'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Current-Page' => '2',
+      'Page-Items'   => '3',
+      'Total-Count'  => '12',
+      'Total-Pages'  => '4',
+    )
+    expect(last_response.body).to eq(%([4, 5, 6]))
+  end
+
+  it 'should cap items' do
+    get '/?items=10'
+    expect(last_response.headers).to include('Page-Items' => '6')
+    expect(last_response.body).to eq(%([1, 2, 3, 4, 5, 6]))
+
+    get '/?items=3'
+    expect(last_response.headers).to include('Page-Items' => '3')
+    expect(last_response.body).to eq(%([1, 2, 3]))
+  end
+
+  it 'should ignore overflow' do
+    get '/?page=99'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Current-Page' => '99',
+      'Total-Pages'  => '3',
+    )
+    expect(last_response.body).to eq(%([]))
+  end
+
+  it 'should inherit helper' do
+    get '/sub'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Current-Page' => '1',
+      'Page-Items'   => '10',
+      'Total-Count'  => '12',
+      'Total-Pages'  => '2',
+    )
+    expect(last_response.body).to eq(%([1, 2, 3, 4, 5, 6, 7, 8, 9, 10]))
+
+    get '/sub?items=20'
+    expect(last_response.status).to eq(200)
+    expect(last_response.headers).to include(
+      'Current-Page' => '1',
+      'Page-Items'   => '20',
+      'Total-Count'  => '12',
+      'Total-Pages'  => '1',
+    )
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+ENV['RACK_ENV'] ||= 'test'
+
+require 'rspec'
+require 'grape/pagy'
+require 'rack/test'
+
+Pagy::VARS[:items] = 10
+Pagy::VARS[:max_items] = 20
+
+class TestAPI < Grape::API
+  helpers Grape::Pagy::Helpers
+
+  params do
+    use :pagination, items: 5
+  end
+  get '' do
+    paginate (1..12).to_a, max_items: 6
+  end
+
+  resource :sub do
+    params do
+      use :pagination
+    end
+    get '/' do
+      paginate (1..12).to_a
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include Rack::Test::Methods
+  config.raise_errors_for_deprecations!
+end

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: grape-pagy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Black Square Media
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: pagy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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
+    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: rspec
+  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: rubocop
+  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'
+description: Pagy paginator for grape API
+email:
+- info@blacksquaremedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- grape-pagy.gemspec
+- lib/grape-pagy.rb
+- lib/grape/pagy.rb
+- spec/grape/pagy_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.5'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- spec/grape/pagy_spec.rb
+- spec/spec_helper.rb