grape-pagination 0.0.1

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/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Eric J. Holmes
+
+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,42 @@
+# Grape Pagination
+
+Provides helpers for paginating collections in [Grape](https://github.com/intridea/grape)
+endpoints. Currently only works with with [will\_paginate](https://github.com/mislav/will_paginate),
+or something that responds to the same `paginate` interface.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'grape-pagination'
+```
+
+## Usage
+
+Tag your endpoint as supporting pagination params, then use the `paginate`
+helper.
+
+```ruby
+class API < Grape::API
+  desc 'Gets everything!'
+  paginate
+  get do
+    paginate collection
+  end
+end
+```
+
+Which would result in a paginated collection and the following headers set:
+
+```
+X-Total: 150
+```
+
+## 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,10 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+
+require 'rspec/core/rake_task'
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = 'spec/**/*_spec.rb'
+end

data/grape-pagination.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'grape/pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-pagination'
+  spec.version       = Grape::Pagination::VERSION
+  spec.authors       = ['Eric J. Holmes']
+  spec.email         = ['eric@ejholmes.net']
+  spec.description   = %q{Pagination helpers for Grape}
+  spec.summary       = %q{Pagination helpers for Grape}
+  spec.homepage      = 'https://github.com/remind101/grape-pagination'
+  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_dependency 'grape', '~> 0.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rake'
+end

data/lib/grape/pagination/configuration.rb

@@ -0,0 +1,9 @@
+module Grape::Pagination
+  class Configuration
+    attr_reader :total_proc
+
+    def total_proc
+      @total_proc ||= lambda { |collection| collection.count }
+    end
+  end
+end

data/lib/grape/pagination/extensions.rb

@@ -0,0 +1,17 @@
+module Grape::Pagination
+  module Extensions
+    def paginate(options = {})
+      options.reverse_merge!(per_page: 30)
+      params do
+        optional :page,
+          type: Integer,
+          desc: 'Page offset to fetch.',
+          default: 1
+        optional :per_page,
+          type: Integer,
+          desc: 'Number of results to return per page.',
+          default: options[:per_page]
+      end
+    end
+  end
+end

data/lib/grape/pagination/helpers.rb

@@ -0,0 +1,7 @@
+module Grape::Pagination
+  module Helpers
+    def paginate(*args)
+      Grape::Pagination::Paginator.paginate(self, *args)
+    end
+  end
+end

data/lib/grape/pagination/paginator.rb

@@ -0,0 +1,56 @@
+module Grape::Pagination
+  class Paginator
+    extend Forwardable
+
+    TOTAL_HEADER = 'X-Total'.freeze
+    LINK_HEADER  = 'Link'.freeze
+
+    attr_reader :endpoint
+    attr_reader :collection
+    attr_reader :options
+
+    def self.paginate(*args)
+      new(*args).paginate
+    end
+
+    def initialize(endpoint, collection, options = {})
+      @endpoint   = endpoint
+      @collection = collection
+      @options    = options
+    end
+
+    def paginate
+      header TOTAL_HEADER, total
+      collection.paginate(page_params)
+    end
+  
+  private
+
+    def_delegators :endpoint, :header, :params, :request
+
+    def query_hash
+      @query_hash ||= Rack::Utils.parse_nested_query(uri.query)
+    end
+
+    def uri
+      @uri ||= URI.parse(request.url)
+    end
+
+    def page_params
+      @page_params ||= params.slice(:page, :per_page).to_h.symbolize_keys
+    end
+
+    def total
+      options[:total] || total_proc.call(collection)
+    end
+
+    def total_proc
+      options[:total_proc] || configuration.total_proc
+    end
+
+    def configuration
+      Grape::Pagination.configuration
+    end
+
+  end
+end

data/lib/grape/pagination/version.rb

@@ -0,0 +1,5 @@
+module Grape
+  module Pagination
+    VERSION = "0.0.1"
+  end
+end

data/lib/grape/pagination.rb

@@ -0,0 +1,22 @@
+require 'grape'
+require 'grape/pagination/version'
+
+module Grape
+  module Pagination
+    autoload :Configuration, 'grape/pagination/configuration'
+    autoload :Extensions,    'grape/pagination/extensions'
+    autoload :Helpers,       'grape/pagination/helpers'
+    autoload :Paginator,     'grape/pagination/paginator'
+
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    def self.configure
+      yield configuration
+    end
+
+    Grape::API.send :extend, Grape::Pagination::Extensions
+    Grape::Endpoint.send :include, Grape::Pagination::Helpers
+  end
+end

data/lib/grape-pagination.rb

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

data/spec/grape/pagination/paginator_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Grape::Pagination::Paginator do
+  let(:request      ) { double(Rack::Request, url: 'https://localhost:5000/api/v1/tweets?page=1&per_page=30') }
+  let(:endpoint     ) { double(Grape::Endpoint, request: request, header: nil, params: Hashie::Mash.new(page: 1, per_page: 30)) }
+  let(:collection   ) { double('collection', count: 4, paginate: nil) }
+  subject(:paginator) { described_class.new endpoint, collection }
+
+  describe '.paginate' do
+    it 'sets the X-Total header' do
+      endpoint.should_receive(:header).with('X-Total', 4)
+      paginator.paginate
+    end
+
+    it 'paginates the collection' do
+      collection.should_receive(:paginate).with(page: 1, per_page: 30)
+      paginator.paginate
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+Bundler.require :default, :test
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each {|f| require f}

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: grape-pagination
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Eric J. Holmes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Pagination helpers for Grape
+email:
+- eric@ejholmes.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- grape-pagination.gemspec
+- lib/grape-pagination.rb
+- lib/grape/pagination.rb
+- lib/grape/pagination/configuration.rb
+- lib/grape/pagination/extensions.rb
+- lib/grape/pagination/helpers.rb
+- lib/grape/pagination/paginator.rb
+- lib/grape/pagination/version.rb
+- spec/grape/pagination/paginator_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/remind101/grape-pagination
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2291269891516805911
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2291269891516805911
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Pagination helpers for Grape
+test_files:
+- spec/grape/pagination/paginator_spec.rb
+- spec/spec_helper.rb