grape-kaminari 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f7a8c5230ae29829672e54245091c948c65b12be
-  data.tar.gz: 3d43e68afdbebfc4987eebb206296c376d8a3abb
+  metadata.gz: 821c1238aa91cec3b1fc14a13a38fa2a56400947
+  data.tar.gz: 4b6d71cd54352512607b1ca306975601421ca833
 SHA512:
-  metadata.gz: 1bded3a46f9aa34a8006b1941a4a5d6ab4b47a9c2ef6c88889cc28adfdcde5bae158b43d517042da1031929d3882933d3b7a54a4ee41c7ce22d2eabaa1b977bc
-  data.tar.gz: 2024105c17eed72397afad38716b771425ae7de82bb1f2f341870bc3617d4facc95afbf640e1d00403371c8c377b5660f7fe8815d2d8e5eb1ec6b6175872c167
+  metadata.gz: 3ceb594a017b53ef808c3b61b1ae13e2d3644ef0d03bebf3b7608a4167512efd4706e15a04e2159ee18424bf99c9dbbd763485ccfac7d0e7cbec148b43d0f063
+  data.tar.gz: 53ee0596172838efd88fcf8d2f7f728a2f92786b76c318eb0df11a828f0a76e358ed67b0890044e72a8d28899389797bcc48ecc7c3aefa7f4b346b13f59408f1

data/LICENSE.txt

@@ -1,22 +1,20 @@
-Copyright (c) 2013 Monterail.com
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2013-2014 Monterail.com LLC
 
-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 the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
+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
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
 
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,4 +1,4 @@
-# Grape::Kaminari
+# Grape::Kaminari [![Gem Version](https://badge.fury.io/rb/grape-kaminari.png)](http://badge.fury.io/rb/grape-kaminari)
 
 [kaminari](https://github.com/amatsuda/kaminari) paginator integration for [grape](https://github.com/intridea/grape) API framework.
 
@@ -35,7 +35,9 @@ class MyApi < Grape::API
     # Annotate action with `paginate`.
     # This will add two optional params: page and per_page
     # You can optionally overwrite the default :per_page setting (10)
-    paginate :per_page => 20
+    # 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
 
     get do
       posts = Post.where(...)
@@ -54,7 +56,7 @@ Now you can make a HTTP request to you are endpoint with `page` (and `per_page`)
 curl -v http://host.dev/api/posts?page=3
 ```
 
-and the response wil be paginated and also will include pagination headers
+and the response will be paginated and also will include pagination headers
 
 ```
 X-Total: 42

data/lib/grape/kaminari/max_value_validator.rb

@@ -0,0 +1,14 @@
+module Grape
+  module Kaminari
+    class MaxValueValidator < Grape::Validations::SingleOptionValidator
+      def validate_param!(attr_name, params)
+        return unless params[attr_name]
+
+        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}"
+        end
+      end
+    end
+  end
+end

data/lib/grape/kaminari/version.rb

@@ -1,5 +1,5 @@
 module Grape
   module Kaminari
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

data/lib/grape/kaminari.rb

@@ -1,4 +1,5 @@
 require "grape/kaminari/version"
+require "grape/kaminari/max_value_validator"
 require "kaminari/grape"
 
 module Grape
@@ -17,12 +18,16 @@ module Grape
         end
 
         def self.paginate(options = {})
-          options.reverse_merge!(per_page: 10)
+          options.reverse_merge!(
+            per_page: 10,
+            max_per_page: false
+          )
           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.'
+                                desc: 'Number of results to return per page.',
+                                max_value: options[:max_per_page]
           end
         end
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-kaminari
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tymon Tobolski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-06 00:00:00.000000000 Z
+date: 2014-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -81,6 +81,7 @@ files:
 - grape-kaminari.gemspec
 - lib/grape-kaminari.rb
 - lib/grape/kaminari.rb
+- lib/grape/kaminari/max_value_validator.rb
 - lib/grape/kaminari/version.rb
 homepage: ''
 licenses: