api-pagination 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 14e246231b1fb0265ddf083f1398814fffe6e76e
+  data.tar.gz: 52ea59f4a23f0e1465a46d550f2664e9db68ab3f
+SHA512:
+  metadata.gz: ca92332be7721468d76215eedf23f305a459bb0540b9c58ccd9023795d5ce8265aeb1ef9fad99b3922853c5a8a9d2b5a2d71655a5a5b00bacf4f4418d0219b83
+  data.tar.gz: 722c09db00aea404e2d0a2a7afd6f7e1bc5c685147177503a4f9c2e7f6b835f56c6044378776606a3e77bf768279b286ac695f0658a8e07ab3ec31d9d9b15a82

data/lib/api-pagination.rb

@@ -0,0 +1,33 @@
+require 'api-pagination/version'
+require 'kaminari'
+
+module ApiPagination
+  protected
+    def paginate(scope)
+      query_params = request.query_parameters
+      scope        = instance_variable_get(:"@#{scope}")
+      url          = request.original_url.sub(/\?.*$/, '')
+      pages        = {}
+      links        = []
+
+      unless scope.first_page?
+        pages[:first] = 1
+        pages[:prev]  = scope.current_page - 1
+      end
+
+      unless scope.last_page?
+        pages[:last] = scope.total_pages
+        pages[:next] = scope.current_page + 1
+      end
+
+      pages.each do |k, v|
+        new_params = query_params.merge({ :page => v })
+        links << %(<#{url}?#{new_params.to_param}>; rel="#{k}")
+      end
+
+      headers['Link'] = links.join(', ')
+    end
+end
+
+ActionController::Base.send(:include, ApiPagination) if defined?(ActionController::Base)
+ActionController::API.send(:include, ApiPagination)  if defined?(ActionController::API)

data/lib/api-pagination/version.rb

@@ -0,0 +1,7 @@
+module ApiPagination
+  MAJOR = 1
+  MINOR = 0
+  PATCH = 0
+
+  VERSION = [MAJOR, MINOR, PATCH].join('.')
+end

data/spec/controllers/numbers_controller_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+describe NumbersController do
+  describe 'GET #index' do
+    context 'without enough items to give more than one page' do
+      it 'should not paginate' do
+        get :index, count: 20
+        response.headers['Link'].should be_blank
+      end
+    end
+
+    context 'with enough items to paginate' do
+      context 'when on the first page' do
+        before(:each) do
+          get :index, count: 100
+
+          @links = response.headers['Link'].split(', ')
+        end
+
+        it 'should not give a link with rel "first"' do
+          @links.should_not include('rel="first"')
+        end
+
+        it 'should not give a link with rel "prev"' do
+          @links.should_not include('rel="prev"')
+        end
+
+        it 'should give a link with rel "last"' do
+          @links.should include('<http://test.host/numbers?count=100&page=4>; rel="last"')
+        end
+
+        it 'should give a link with rel "next"' do
+          @links.should include('<http://test.host/numbers?count=100&page=2>; rel="next"')
+        end
+      end
+
+      context 'when on the last page' do
+        before(:each) do
+          get :index, count: 100, page: 4
+
+          @links = response.headers['Link'].split(', ')
+        end
+
+        it 'should not give a link with rel "last"' do
+          @links.should_not include('rel="last"')
+        end
+
+        it 'should not give a link with rel "next"' do
+          @links.should_not include('rel="next"')
+        end
+
+        it 'should give a link with rel "first"' do
+          @links.should include('<http://test.host/numbers?count=100&page=1>; rel="first"')
+        end
+
+        it 'should give a link with rel "prev"' do
+          @links.should include('<http://test.host/numbers?count=100&page=3>; rel="prev"')
+        end
+      end
+
+      context 'when somewhere comfortably in the middle' do
+        it 'should give all pagination links' do
+          get :index, count: 100, page: 2
+
+          links = response.headers['Link'].split(', ')
+
+          links.should include('<http://test.host/numbers?count=100&page=1>; rel="first"')
+          links.should include('<http://test.host/numbers?count=100&page=4>; rel="last"')
+          links.should include('<http://test.host/numbers?count=100&page=3>; rel="next"')
+          links.should include('<http://test.host/numbers?count=100&page=1>; rel="prev"')
+        end
+      end
+    end
+  end
+end
+
+
+
+
+

data/spec/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks

data/spec/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,5 @@
+class ApplicationController < ActionController::Base
+  # Prevent CSRF attacks by raising an exception.
+  # For APIs, you may want to use :null_session instead.
+  protect_from_forgery with: :exception
+end

data/spec/dummy/app/controllers/numbers_controller.rb

@@ -0,0 +1,8 @@
+class NumbersController < ApplicationController
+  after_filter only: [:index] { paginate(:numbers) }
+
+  def index
+    @numbers = Kaminari.paginate_array((1..params[:count].to_i).to_a).page(params[:page])
+    render json: @numbers
+  end
+end

data/spec/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/spec/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/spec/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../../config/application',  __FILE__)
+require_relative '../config/boot'
+require 'rails/commands'

data/spec/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run

data/spec/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Rails.application

data/spec/dummy/config/application.rb

@@ -0,0 +1,28 @@
+require File.expand_path('../boot', __FILE__)
+
+# Pick the frameworks you want:
+# require "active_record/railtie"
+require "action_controller/railtie"
+# require "action_mailer/railtie"
+# require "sprockets/railtie"
+
+Bundler.require(*Rails.groups)
+require 'kaminari'
+require 'api-pagination'
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+  end
+end
+

data/spec/dummy/config/boot.rb

@@ -0,0 +1,5 @@
+# Set up gems listed in the Gemfile.
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../../../Gemfile', __FILE__)
+
+require 'bundler/setup' if File.exists?(ENV['BUNDLE_GEMFILE'])
+$LOAD_PATH.unshift File.expand_path('../../../../lib', __FILE__)

data/spec/dummy/config/database.yml

@@ -0,0 +1,25 @@
+# SQLite version 3.x
+#   gem install sqlite3
+#
+#   Ensure the SQLite 3 gem is defined in your Gemfile
+#   gem 'sqlite3'
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  pool: 5
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  pool: 5
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  pool: 5
+  timeout: 5000

data/spec/dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Dummy::Application.initialize!

data/spec/dummy/config/environments/development.rb

@@ -0,0 +1,29 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # In the development environment your application's code is reloaded on
+  # every request. This slows down response time but is perfect for development
+  # since you don't have to restart the web server when you make code changes.
+  config.cache_classes = false
+
+  # Do not eager load code on boot.
+  config.eager_load = false
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger.
+  config.active_support.deprecation = :log
+
+  # Raise an error on page load if there are pending migrations
+  # config.active_record.migration_error = :page_load
+
+  # Debug mode disables concatenation and preprocessing of assets.
+  # This option may cause significant delays in view rendering with a large
+  # number of complex assets.
+  config.assets.debug = true
+end

data/spec/dummy/config/environments/production.rb

@@ -0,0 +1,80 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # Code is not reloaded between requests.
+  config.cache_classes = true
+
+  # Eager load code on boot. This eager loads most of Rails and
+  # your application in memory, allowing both thread web servers
+  # and those relying on copy on write to perform better.
+  # Rake tasks automatically ignore this option for performance.
+  config.eager_load = true
+
+  # Full error reports are disabled and caching is turned on.
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Enable Rack::Cache to put a simple HTTP cache in front of your application
+  # Add `rack-cache` to your Gemfile before enabling this.
+  # For large-scale production use, consider using a caching reverse proxy like nginx, varnish or squid.
+  # config.action_dispatch.rack_cache = true
+
+  # Disable Rails's static asset server (Apache or nginx will already do this).
+  # config.serve_static_assets = false
+
+  # Compress JavaScripts and CSS.
+  # config.assets.js_compressor = :uglifier
+  # config.assets.css_compressor = :sass
+
+  # Do not fallback to assets pipeline if a precompiled asset is missed.
+  # config.assets.compile = false
+
+  # Generate digests for assets URLs.
+  # config.assets.digest = true
+
+  # Version of your assets, change this if you want to expire all your assets.
+  # config.assets.version = '1.0'
+
+  # Specifies the header that your server uses for sending files.
+  # config.action_dispatch.x_sendfile_header = "X-Sendfile" # for apache
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect' # for nginx
+
+  # Force all access to the app over SSL, use Strict-Transport-Security, and use secure cookies.
+  # config.force_ssl = true
+
+  # Set to :debug to see everything in the log.
+  config.log_level = :info
+
+  # Prepend all log lines with the following tags.
+  # config.log_tags = [ :subdomain, :uuid ]
+
+  # Use a different logger for distributed setups.
+  # config.logger = ActiveSupport::TaggedLogging.new(SyslogLogger.new)
+
+  # Use a different cache store in production.
+  # config.cache_store = :mem_cache_store
+
+  # Enable serving of images, stylesheets, and JavaScripts from an asset server.
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Precompile additional assets.
+  # application.js, application.css, and all non-JS/CSS in app/assets folder are already added.
+  # config.assets.precompile += %w( search.js )
+
+  # Ignore bad email addresses and do not raise email delivery errors.
+  # Set this to true and configure the email server for immediate delivery to raise delivery errors.
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found).
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners.
+  config.active_support.deprecation = :notify
+
+  # Disable automatic flushing of the log to improve performance.
+  # config.autoflush_log = false
+
+  # Use default logging formatter so that PID and timestamp are not suppressed.
+  config.log_formatter = ::Logger::Formatter.new
+end

data/spec/dummy/config/environments/test.rb

@@ -0,0 +1,36 @@
+Dummy::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb.
+
+  # The test environment is used exclusively to run your application's
+  # test suite. You never need to work with it otherwise. Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs. Don't rely on the data there!
+  config.cache_classes = true
+
+  # Do not eager load code on boot. This avoids loading your whole application
+  # just for the purpose of running a single test. If you are using a tool that
+  # preloads Rails for running tests, you may have to set it to true.
+  config.eager_load = false
+
+  # Configure static asset server for tests with Cache-Control for performance.
+  # config.serve_static_assets  = true
+  # config.static_cache_control = "public, max-age=3600"
+
+  # Show full error reports and disable caching.
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates.
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment.
+  config.action_controller.allow_forgery_protection = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  # config.action_mailer.delivery_method = :test
+
+  # Print deprecation notices to the stderr.
+  config.active_support.deprecation = :stderr
+end

data/spec/dummy/config/initializers/backtrace_silencers.rb

@@ -0,0 +1,7 @@
+# Be sure to restart your server when you modify this file.
+
+# You can add backtrace silencers for libraries that you're using but don't wish to see in your backtraces.
+# Rails.backtrace_cleaner.add_silencer { |line| line =~ /my_noisy_library/ }
+
+# You can also remove all the silencers if you're trying to debug a problem that might stem from framework code.
+# Rails.backtrace_cleaner.remove_silencers!

data/spec/dummy/config/initializers/filter_parameter_logging.rb

@@ -0,0 +1,4 @@
+# Be sure to restart your server when you modify this file.
+
+# Configure sensitive parameters which will be filtered from the log file.
+Rails.application.config.filter_parameters += [:password]

data/spec/dummy/config/initializers/inflections.rb

@@ -0,0 +1,16 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new inflection rules using the following format. Inflections
+# are locale specific, and you may define rules for as many different
+# locales as you wish. All of these examples are active by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.plural /^(ox)$/i, '\1en'
+#   inflect.singular /^(ox)en/i, '\1'
+#   inflect.irregular 'person', 'people'
+#   inflect.uncountable %w( fish sheep )
+# end
+
+# These inflection rules are supported but not enabled by default:
+# ActiveSupport::Inflector.inflections(:en) do |inflect|
+#   inflect.acronym 'RESTful'
+# end

data/spec/dummy/config/initializers/mime_types.rb

@@ -0,0 +1,5 @@
+# Be sure to restart your server when you modify this file.
+
+# Add new mime types for use in respond_to blocks:
+# Mime::Type.register "text/richtext", :rtf
+# Mime::Type.register_alias "text/html", :iphone