grape-kaminari 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f7a8c5230ae29829672e54245091c948c65b12be
+  data.tar.gz: 3d43e68afdbebfc4987eebb206296c376d8a3abb
+SHA512:
+  metadata.gz: 1bded3a46f9aa34a8006b1941a4a5d6ab4b47a9c2ef6c88889cc28adfdcde5bae158b43d517042da1031929d3882933d3b7a54a4ee41c7ce22d2eabaa1b977bc
+  data.tar.gz: 2024105c17eed72397afad38716b771425ae7de82bb1f2f341870bc3617d4facc95afbf640e1d00403371c8c377b5660f7fe8815d2d8e5eb1ec6b6175872c167

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in grape-kaminari.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Monterail.com
+
+MIT License
+
+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 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

@@ -0,0 +1,72 @@
+# Grape::Kaminari
+
+[kaminari](https://github.com/amatsuda/kaminari) paginator integration for [grape](https://github.com/intridea/grape) API framework.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-kaminari'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install grape-kaminari
+```
+
+## Usage
+
+```ruby
+class MyApi < Grape::API
+  # Include Grape::Kaminari module in your api
+  include Grape::Kaminari
+
+  resource :posts do
+    desc 'Return a list of posts.'
+
+    # 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
+
+    get do
+      posts = Post.where(...)
+
+      # Use `paginate` helper to execute kaminari methods
+      # with arguments automatically passed from params
+      paginate(posts)
+    end
+  end
+end
+```
+
+Now you can make a HTTP request to you are endpoint with `page` (and `per_page`) params
+
+```
+curl -v http://host.dev/api/posts?page=3
+```
+
+and the response wil be paginated and also will include pagination headers
+
+```
+X-Total: 42
+X-Total-Pages: 5
+X-Page: 3
+X-Per-Page: 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

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/grape-kaminari.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/kaminari/version'
+
+Gem::Specification.new do |spec|
+  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.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.add_runtime_dependency "grape"
+  spec.add_runtime_dependency "kaminari"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/lib/grape/kaminari/version.rb

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

data/lib/grape/kaminari.rb

@@ -0,0 +1,31 @@
+require "grape/kaminari/version"
+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]).tap do |data|
+              header "X-Total",       data.total_count.to_s
+              header "X-Total-Pages", data.num_pages.to_s
+              header "X-Page",        data.current_page.to_s
+              header "X-Per-Page",    params[:per_page].to_s
+            end
+          end
+        end
+
+        def self.paginate(options = {})
+          options.reverse_merge!(per_page: 10)
+          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.'
+          end
+        end
+      end
+    end
+  end
+end

data/lib/grape-kaminari.rb

@@ -0,0 +1 @@
+require "grape/kaminari"

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: grape-kaminari
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Tymon Tobolski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  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: kaminari
+  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: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+description: kaminari paginator integration for grape API framework
+email:
+- tymon.tobolski@monterail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-kaminari.gemspec
+- lib/grape-kaminari.rb
+- lib/grape/kaminari.rb
+- lib/grape/kaminari/version.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: kaminari integration for grape
+test_files: []