napa_pagination 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e016ee576bf219579c7fe3657e17dbc6d21daa8
+  data.tar.gz: 9cf55ebabf41fc5548ce881af3fb0ddd07ada7df
+SHA512:
+  metadata.gz: 70d76059dd628eecc843cfb5b4171710a6e811107d19b0115a4e8fb30f432b9340cb0baeaab1d7a8635549a4c42c5bd5cbca5f86434a7f14deb20fb7e00235fe
+  data.tar.gz: b31a2204b58fae09917da894a9973b97aa70f27fa8d8dc5403e9330638a0fc29d10fb9eadc67d21392c3535fdb26a3cef84d7d9e90342eaa3101acc2cf21eb54

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+language: ruby
+cache:
+  - bundler
+  - apt
+rvm:
+  - ruby-2.0.0
+
+script: "bundle exec rspec spec --color"

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,23 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 Bellycard Inc.
+
+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.
+
+"Napa", and the Napa logo are registered trademarks of Bellycard Inc. All rights reserved.

data/README.md

@@ -0,0 +1,63 @@
+# NapaPagination
+
+A simple pagination representer for Napa
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'napa_pagination'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install napa_pagination
+
+## Usage
+Once you have the gem installed, simply replace `represent` with the `paginate` when returning the response from your API. Below is an example based on the Napa Quickstart Guide.
+
+```ruby
+class PeopleApi < Grape::API
+  desc 'Get a list of people'
+  params do
+    optional :ids, type: String, desc: 'comma separated person ids'
+  end
+  get do
+    people = Person.filter(declared(params, include_missing: false))
+    # represent people, with: PersonRepresenter
+    paginate people, with: PersonRepresenter
+  end
+
+  ...
+end
+```
+
+By default, this will default to 25 results per page. If you want to change that you can pass in an override in the params block:
+
+```ruby
+class PeopleApi < Grape::API
+  desc 'Get a list of people'
+  params do
+    optional :ids, type: String, desc: 'comma separated person ids'
+    optional :per_page, type: Integer, desc: 'Results per page', default: 100
+  end
+  get do
+    people = Person.filter(declared(params, include_missing: false))
+    # represent people, with: PersonRepresenter
+    paginate people, with: PersonRepresenter
+  end
+
+  ...
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/napa_pagination/fork )
+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/lib/napa_pagination/grape_helpers.rb

@@ -0,0 +1,33 @@
+module NapaPagination
+  module GrapeHelpers
+    def paginate(data, with: nil, **args)
+      raise ArgumentError.new(":with option is required") if with.nil?
+
+      if data.respond_to?(:to_a)
+        return {}.tap do |r|
+          r[:data] = data.map{ |item| with.new(item).to_hash(args) }
+          r[:pagination] = NapaPagination::Pagination.new(represent_pagination(data)).to_h
+        end
+      else
+        return { data: with.new(data).to_hash(args)}
+      end
+    end
+
+    def represent_pagination(data)
+      # don't paginate if collection is already paginated
+      return data if data.respond_to?(:total_count)
+
+      page      = params.try(:page) || 1
+      per_page  = params.try(:per_page) || 25
+
+      if data.is_a?(Array)
+        Kaminari.paginate_array(data).page(page).per(per_page)
+      else
+        data.page(page).per(per_page)
+      end
+    end
+
+    # extend all endpoints to include this
+    Grape::Endpoint.send :include, self
+  end
+end

data/lib/napa_pagination/pagination.rb

@@ -0,0 +1,20 @@
+module NapaPagination
+  class Pagination
+    def initialize(object)
+      @object = object
+    end
+
+    def to_json(options = {})
+      to_h.to_json(options)
+    end
+
+    def to_h
+      {}.tap do |p|
+        p[:page]          = @object.current_page  if @object.respond_to?(:current_page)
+        p[:per_page]      = @object.limit_value   if @object.respond_to?(:limit_value)
+        p[:total_pages]   = @object.total_pages   if @object.respond_to?(:total_pages)
+        p[:total_count]   = @object.total_count   if @object.respond_to?(:total_count)
+      end
+    end
+  end
+end

data/lib/napa_pagination/version.rb

@@ -0,0 +1,3 @@
+module NapaPagination
+  VERSION = "0.0.1"
+end

data/lib/napa_pagination.rb

@@ -0,0 +1,7 @@
+require 'grape'
+require 'napa'
+require 'kaminari/grape'
+
+require 'napa_pagination/version'
+require 'napa_pagination/pagination'
+require 'napa_pagination/grape_helpers'

data/napa_pagination.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'napa_pagination/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "napa_pagination"
+  spec.version       = NapaPagination::VERSION
+  spec.authors       = ["Darby Frey"]
+  spec.email         = ["darby@bellycard.com"]
+  spec.summary       = %q{A simple pagination representer for Napa}
+  spec.description   = %q{A simple pagination representer for Napa}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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'
+  spec.add_dependency 'napa'
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'kaminari'
+  spec.add_development_dependency 'actionview'
+end

data/spec/grape_helpers_spec.rb

@@ -0,0 +1,91 @@
+require 'spec_helper'
+require 'napa_pagination/grape_helpers'
+
+class FooApi < Grape::API; end
+class FooRepresenter < Napa::Representer; end
+
+describe NapaPagination::GrapeHelpers do
+  before do
+    @endpoint = Grape::Endpoint.new(nil, {path: '/test', method: :get})
+  end
+
+  context '#represent_pagination' do
+    before do
+      Foo.create(word: 'bar')
+      Foo.create(word: 'baz')
+    end
+
+    after do
+      Foo.destroy_all
+    end
+
+    it 'returns the collection if it is already paginated' do
+      objects = Kaminari.paginate_array([Foo.new, Foo.new, Foo.new]).page(1)
+      output = @endpoint.represent_pagination(objects)
+
+      expect(output.class).to eq(objects.class)
+    end
+
+    it 'returns a paginated collection if given an array' do
+      output = @endpoint.represent_pagination(Foo.all.page(1))
+
+      expect(output.class).to be(Foo::ActiveRecord_Relation)
+      expect(output.total_pages).to be(1)
+      expect(output.total_count).to be(2)
+    end
+
+    it 'returns a paginated collection if given an ActiveRecord_Relation' do
+      output = @endpoint.represent_pagination(Foo.all)
+
+      expect(output.total_count).to be(2)
+      expect(output.total_pages).to be(1)
+    end
+
+    it 'overrides the page and per_page defaults if supplied as params' do
+      allow(@endpoint).to receive_message_chain(:params, :page).and_return(2)
+      allow(@endpoint).to receive_message_chain(:params, :per_page).and_return(1)
+
+      output = @endpoint.represent_pagination(Foo.all)
+
+      expect(output.current_page).to be(2)
+      expect(output.total_count).to be(2)
+      expect(output.total_pages).to be(2)
+    end
+  end
+
+  context '#paginate' do
+    it 'raises an exception if no representer is given' do
+      object = Foo.new
+      expect{ @endpoint.paginate(object) }.to raise_error
+    end
+
+    it 'returns the object nested in the data key when given a single object' do
+      object = Foo.new
+      output = @endpoint.paginate(object, with: FooRepresenter)
+
+      expect(output.has_key?(:data)).to be true
+      expect(output[:data]['object_type']).to eq('foo')
+    end
+
+    it 'returns a collection of objects nested in the data key' do
+      objects = [Foo.new, Foo.new, Foo.new]
+      output = @endpoint.paginate(objects, with: FooRepresenter)
+
+      expect(output.has_key?(:data)).to be true
+      expect(output[:data].class).to be(Array)
+      expect(output[:data].first['object_type']).to eq('foo')
+    end
+
+    it 'returns a collection with pagination attributes if the collection is paginated' do
+      objects = Kaminari.paginate_array([Foo.new, Foo.new, Foo.new]).page(1)
+      output = @endpoint.paginate(objects, with: FooRepresenter)
+
+      expect(output.has_key?(:data)).to be true
+      expect(output.has_key?(:pagination)).to be true
+      expect(output[:pagination][:page]).to eq(1)
+      expect(output[:pagination][:per_page]).to eq(25)
+      expect(output[:pagination][:total_pages]).to eq(1)
+      expect(output[:pagination][:total_count]).to eq(3)
+    end
+  end
+end

data/spec/pagination_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+require 'active_record'
+require 'hashie'
+require 'napa_pagination/pagination'
+
+describe NapaPagination::Pagination do
+  context '#to_h' do
+    it 'returns all pagination attributes that the object responds to' do
+      object = Hashie::Mash.new(
+        current_page: 2,
+        limit_value: 25,
+        total_pages: 10,
+        total_count: 248
+      )
+
+      data = NapaPagination::Pagination.new(object)
+      expect(data.to_h[:page]).to be(2)
+      expect(data.to_h[:per_page]).to be(25)
+      expect(data.to_h[:total_pages]).to be(10)
+      expect(data.to_h[:total_count]).to be(248)
+    end
+
+    it 'skips an attribute if the object does not respond to it' do
+      object = Hashie::Mash.new(
+        current_page: 2,
+        limit_value: 25
+      )
+
+      data = NapaPagination::Pagination.new(object)
+      expect(data.to_h[:page]).to be(2)
+      expect(data.to_h[:per_page]).to be(25)
+      expect(data.to_h[:total_pages]).to be_nil
+      expect(data.to_h[:total_count]).to be_nil
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'napa_pagination'
+require 'pry'
+
+RSpec.configure do |config|
+  config.before(:all) do
+    ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+
+    ActiveRecord::Schema.define(version: 1) do
+      create_table :foos do |t|
+        t.string :word
+      end
+    end
+
+    class Foo < ActiveRecord::Base
+    end
+  end
+end

metadata

@@ -0,0 +1,201 @@
+--- !ruby/object:Gem::Specification
+name: napa_pagination
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Darby Frey
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-03 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: napa
+  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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  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'
+- !ruby/object:Gem::Dependency
+  name: actionview
+  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: A simple pagination representer for Napa
+email:
+- darby@bellycard.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/napa_pagination.rb
+- lib/napa_pagination/grape_helpers.rb
+- lib/napa_pagination/pagination.rb
+- lib/napa_pagination/version.rb
+- napa_pagination.gemspec
+- spec/grape_helpers_spec.rb
+- spec/pagination_spec.rb
+- spec/spec_helper.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.2.2
+signing_key: 
+specification_version: 4
+summary: A simple pagination representer for Napa
+test_files:
+- spec/grape_helpers_spec.rb
+- spec/pagination_spec.rb
+- spec/spec_helper.rb