grape-kaminari 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b08eab293223b2ad7369fe8c005894a97d6a674a
-  data.tar.gz: bb86d66fc3b9e8b013d9c34f0de183bcdb84a01b
+  metadata.gz: 4fb24c245069275a376233ac2b1ab9ea14bacf83
+  data.tar.gz: 1f74c3dd9df09d1bc3f015e23dd2f2289239eed2
 SHA512:
-  metadata.gz: e293e4e23a6d4ba7c3e024fa0112c2c012add6efe86ec578a581887a40a9b42b6c8776d9b19f30790ae0a447898860faf6c3595b55e552d53c63e322db93e0c4
-  data.tar.gz: 0c1330a4d198b4221c7c5a88924dabb678c467055afb118bdd3b3087b98316178d8eb37a4900be6890609503dc05aa57f4a67f3c18c38bdc10cc9a8e525b176f
+  metadata.gz: 3f2fbb8ce000c0938fe14adc08e7c646bae1be1f2341fba2eff44e21e59133766db1152ceb873ea482d62ea17992a0eb8c7bdd381935b1c952999e778520fb6d
+  data.tar.gz: 8d87799ba47f32584ed935f7f1f8db84ed71fbb8d4b92c937c8370570ab0aa577309268957eeb23fe3baa9b894211001f2ee74a77b7c8a54c5d9c44b1f133280

data/README.md

@@ -1,4 +1,4 @@
-# Grape::Kaminari [![Gem Version](https://badge.fury.io/rb/grape-kaminari.png)](http://badge.fury.io/rb/grape-kaminari)
+# 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)
 
 [kaminari](https://github.com/amatsuda/kaminari) paginator integration for [grape](https://github.com/intridea/grape) API framework.
 
@@ -33,11 +33,16 @@ class MyApi < Grape::API
     desc 'Return a list of posts.'
 
     # Annotate action with `paginate`.
-    # This will add two optional params: page and per_page
+    # This will add three optional params: page, per_page, and offset
+    #
     # You can optionally overwrite the default :per_page setting (10)
     # and the :max_per_page(false/disabled) setting which will use a validator to
     # check that per_page is below the given number.
-    paginate :per_page => 20, :max_per_page => 30
+    #
+    # 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
 
     get do
       posts = Post.where(...)
@@ -46,6 +51,14 @@ class MyApi < Grape::API
       # with arguments automatically passed from params
       paginate(posts)
     end
+
+    get do
+      things = ['a', 'standard', 'array', 'of', 'things', '...']
+
+      # Use `Kaminari.paginate_array` method to convert the array
+      # into an object that can be passed to `paginate` helper.
+      paginate(Kaminari.paginate_array(things))
+    end
   end
 end
 ```

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+task default: :spec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new

data/grape-kaminari.gemspec

@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec', '~> 2.9'
 end

data/lib/grape/kaminari.rb

@@ -23,7 +23,8 @@ module Grape
         def self.paginate(options = {})
           options.reverse_merge!(
             per_page: ::Kaminari.config.default_per_page || 10,
-            max_per_page: ::Kaminari.config.max_per_page
+            max_per_page: ::Kaminari.config.max_per_page,
+            offset: 0
           )
           params do
             optional :page,     type: Integer, default: 1,
@@ -31,7 +32,10 @@ module Grape
             optional :per_page, type: Integer, default: options[:per_page],
                                 desc: 'Number of results to return per page.',
                                 max_value: options[:max_per_page]
-            optional :offset,   type: Integer, default: 0
+            if  options[:offset].is_a? Numeric
+              optional :offset, type: Integer, default: options[:offset],
+                                desc: 'Pad a number of results.'
+            end
           end
         end
       end

data/lib/grape/kaminari/max_value_validator.rb

@@ -6,7 +6,11 @@ module Grape
 
         attr = params[attr_name]
         if attr && @option && attr > @option
-          raise Grape::Exceptions::Validation, param: @scope.full_name(attr_name), message: "must be less than #{@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
       end
     end

data/lib/grape/kaminari/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Kaminari
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/spec/kaminari_spec.rb

@@ -0,0 +1,130 @@
+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
+
+  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
+  end
+
+  describe 'default paginated api' do
+    subject { Class.new(PaginatedAPI) }
+
+    it 'adds to declared parameters' do
+      subject.paginate
+      expect(subject.settings[:declared_params]).to eq([:page, :per_page, :offset])
+    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 '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
+
+      it 'validates :page as Integer' do
+        expect(params['page'][:type]).to eq('Integer')
+      end
+
+      it 'validates :per_page as Integer' do
+        expect(params['per_page'][:type]).to eq('Integer')
+      end
+
+      it 'validates :offset as Integer' do
+        expect(params['offset'][:type]).to eq('Integer')
+      end
+
+      it 'defaults :page to 1' do
+        expect(params['page'][:default]).to eq(1)
+      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 'defaults :offset to 0' do
+        expect(params['offset'][:default]).to eq(0)
+      end
+
+
+    end
+
+  end
+
+  describe 'custom paginated api' do
+    subject { Class.new(PaginatedAPI) }
+    def app; subject; end
+
+    before do
+      subject.paginate per_page:99, max_per_page: 999, offset: 9
+      subject.get '/' do; end
+    end
+    let(:params) {subject.routes.first.route_params}
+
+    it 'defaults :per_page to customized value' do
+      expect(params['per_page'][:default]).to eq(99)
+    end
+
+    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 '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/
+    end
+
+    it 'defaults :offset to customized value' do
+      expect(params['offset'][:default]).to eq(9)
+    end
+
+  end
+
+  describe 'paginated api without :offset' do
+    subject { Class.new(PaginatedAPI) }
+
+    it 'excludes :offset from declared params' do
+      subject.paginate offset: false
+      expect(subject.settings[:declared_params]).not_to include(:offset)
+    end
+
+  end
+
+end

data/spec/paginate_helper_spec.rb

@@ -0,0 +1,56 @@
+require 'spec_helper'
+
+class PaginatedAPI < Grape::API
+  include Grape::Kaminari
+
+  paginate
+  get '' do
+    paginate(Kaminari.paginate_array((1..10).to_a))
+  end
+
+  paginate offset: false
+  get 'no-offset' do
+    paginate(Kaminari.paginate_array((1..10).to_a))
+  end
+end
+
+describe Grape::Kaminari do
+  subject { PaginatedAPI.new }
+  def app; subject; end
+  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]
+    end
+
+    it 'returns the second page' do
+      get '/', page: 2, per_page: 3
+      expect(json).to eq [4, 5, 6]
+    end
+
+    # This is here to ensure that Kaminari can handle `padding(false)`
+    # and still do the right thing.
+    it 'works when offset is false' do
+      get '/no-offset', page: 1, per_page: 3
+      expect(json).to eq [1, 2, 3]
+    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'
+    end
+
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,19 @@
+$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}
+
+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.order = 'random'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-kaminari
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Tymon Tobolski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-23 00:00:00.000000000 Z
+date: 2014-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -66,6 +66,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.9'
 description: kaminari paginator integration for grape API framework
 email:
 - tymon.tobolski@monterail.com
@@ -83,6 +97,9 @@ files:
 - lib/grape/kaminari.rb
 - lib/grape/kaminari/max_value_validator.rb
 - lib/grape/kaminari/version.rb
+- spec/kaminari_spec.rb
+- spec/paginate_helper_spec.rb
+- spec/spec_helper.rb
 homepage: ''
 licenses:
 - MIT
@@ -107,4 +124,7 @@ rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
 summary: kaminari integration for grape
-test_files: []
+test_files:
+- spec/kaminari_spec.rb
+- spec/paginate_helper_spec.rb
+- spec/spec_helper.rb