paginater 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d8e835d5abb7ce6c5b68117582cf65b3bfa37f2b
+  data.tar.gz: 4c8d9e3b6ec7e9ab5699ac21a46b52ab04e62720
+SHA512:
+  metadata.gz: 910c1b0d34981fdd2695e7a737cd80303a83e5538b5e5693a147a7f0fdd3c0b70c95af0dafd4ac66404c3bed7505a5cd913cb8cb96e2b6ef8df871b8f72f3afe
+  data.tar.gz: 1cc68b151e62de11e77077a999f9d58b078153240689c943403c513604c2ef3fbaff12d8375e8df3c21e1003b5224d206c8d25809bae626980e0e07b954bb1ab

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,3 @@
+--color
+--format=documentation
+

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    paginater (0.0.5)
+      activerecord
+      bundler
+      cookiejar
+      grape
+      kaminari
+      rack-test
+      rake
+      rspec
+      rspec-rails
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    backports (2.6.7)
+    builder (3.0.4)
+    cookiejar (0.3.0)
+    daemons (1.1.9)
+    descendants_tracker (0.0.1)
+    diff-lcs (1.2.1)
+    erubis (2.7.0)
+    eventmachine (1.0.3)
+    grape (0.3.2)
+      activesupport
+      builder
+      hashie (>= 1.2.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack
+      rack-accept
+      rack-mount
+      virtus
+    hashie (2.0.2)
+    hike (1.2.1)
+    i18n (0.6.4)
+    journey (1.0.4)
+    json (1.7.7)
+    kaminari (0.14.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    rack (1.4.5)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.12)
+      actionpack (= 3.2.12)
+      activesupport (= 3.2.12)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rspec-rails (2.13.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thin (1.5.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.17.0)
+    tilt (1.3.5)
+    tzinfo (0.3.37)
+    virtus (0.5.4)
+      backports (~> 2.6.1)
+      descendants_tracker (~> 0.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  paginater!
+  thin

data/Gemfile.lock.broken

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    paginater (0.0.5)
+      activerecord
+      bundler
+      cookiejar
+      grape
+      kaminari
+      rack-test
+      rake
+      rspec
+      rspec-rails
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activerecord (1.6.0)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    backports (2.6.7)
+    builder (3.2.0)
+    cookiejar (0.3.0)
+    daemons (1.1.9)
+    descendants_tracker (0.0.1)
+    diff-lcs (1.1.3)
+    eventmachine (1.0.3)
+    grape (0.3.2)
+      activesupport
+      builder
+      hashie (>= 1.2.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack
+      rack-accept
+      rack-mount
+      virtus
+    hashie (2.0.2)
+    i18n (0.6.4)
+    kaminari (0.11.0)
+      kaminari
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    rack (1.5.2)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.3)
+    rspec (2.1.0)
+      rspec-core (~> 2.1.0)
+      rspec-expectations (~> 2.1.0)
+      rspec-mocks (~> 2.1.0)
+    rspec-core (2.1.0)
+    rspec-expectations (2.1.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.1.0)
+    rspec-rails (2.1.0)
+      rspec (~> 2.1.0)
+    sqlite3 (1.3.7)
+    thin (1.5.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    virtus (0.5.4)
+      backports (~> 2.6.1)
+      descendants_tracker (~> 0.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  paginater!
+  thin

data/Gemfile.lock.good

@@ -0,0 +1,127 @@
+PATH
+  remote: .
+  specs:
+    paginater (0.0.5)
+      activerecord
+      bundler
+      cookiejar
+      grape
+      kaminari
+      rack-test
+      rake
+      rspec
+      rspec-rails
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
+    activemodel (3.2.12)
+      activesupport (= 3.2.12)
+      builder (~> 3.0.0)
+    activerecord (3.2.12)
+      activemodel (= 3.2.12)
+      activesupport (= 3.2.12)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    arel (3.0.2)
+    backports (2.6.7)
+    builder (3.0.4)
+    cookiejar (0.3.0)
+    daemons (1.1.9)
+    descendants_tracker (0.0.1)
+    diff-lcs (1.2.1)
+    erubis (2.7.0)
+    eventmachine (1.0.3)
+    grape (0.3.2)
+      activesupport
+      builder
+      hashie (>= 1.2.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack
+      rack-accept
+      rack-mount
+      virtus
+    hashie (2.0.2)
+    hike (1.2.1)
+    i18n (0.6.4)
+    journey (1.0.4)
+    json (1.7.7)
+    kaminari (0.14.1)
+      actionpack (>= 3.0.0)
+      activesupport (>= 3.0.0)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    rack (1.4.5)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rack-ssl (1.3.3)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    railties (3.2.12)
+      actionpack (= 3.2.12)
+      activesupport (= 3.2.12)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
+    rake (10.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
+    rspec-rails (2.13.0)
+      actionpack (>= 3.0)
+      activesupport (>= 3.0)
+      railties (>= 3.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    sqlite3 (1.3.7)
+    thin (1.5.0)
+      daemons (>= 1.0.9)
+      eventmachine (>= 0.12.6)
+      rack (>= 1.0.0)
+    thor (0.17.0)
+    tilt (1.3.5)
+    tzinfo (0.3.37)
+    virtus (0.5.4)
+      backports (~> 2.6.1)
+      descendants_tracker (~> 0.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  paginater!
+  thin

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 zeroed
+
+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,268 @@
+# Paginater
+
+A wannabe pagination gem for [Grape](https://github.com/intridea/grape)
+
+_YAPG: Yet another pagination gem..._
+
+Paginater is a simple (still work in progress) gem that want to be a little utility when your API is dealing with a collection of objects.
+
+You can use Paginater in your Grape app to have a simple feature of pagination that understand `page` and `size` parameters in a GET route.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'paginater'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install paginater
+
+## Usage
+
+Paginater (actually) supports 3 pagination systems:
+
+- `:simple`
+- `:kaminari`
+- `:wrapper`
+
+The `:simple` option uses only the core library functions of Ruby; the `:kaminari` option delegates the pagination to the powerful gem [Kaminari](https://github.com/amatsuda/kaminari) and the `:wrapper` gives you the possibility to wrap your content in a convenient object (this feature is work in progress).
+Paginater also provides with each response, headers useful for pagination.
+
+Enable Paginater makes the API url aware of the `page` parameter (required) and the `size` parameter (optional).
+
+Tell your API to use Paginater:
+
+```ruby
+class API < Grape:API
+  format :json
+  formatter :json, Grape::Formatter::Paginater
+
+  # ...
+
+  get '/stuff', :paginater => :simple do
+    # ... your stuff
+  end
+  
+end
+```
+
+And get the content paginated with:
+
+`/stuff?page=1` and  `/stuff?page=1&size=4`
+
+Use Kaminari gem:
+
+```ruby
+class API < Grape:API
+  format :json
+  formatter :json, Grape::Formatter::Paginater
+
+  # ...
+  
+  get '/users', :paginater => :kaminari do
+    User.where("age > 18")
+  end
+  
+end
+```
+
+Using `:kaminari` gives more flexibilty and don't raise any error when an exceeding page is required.
+
+With a `:size` greater than the `total_count` will be returned and diplayed all the items in the resource.
+
+Paginater also provide in the headers (see the examples) links useful for pagination.
+Another feature in progress is the possibility to wrap your content in a convenient object; maybe in the future will be possible to associate with this object a specific template...
+Set this option (if you dare) with: `:paginater => :wrapper`
+
+```ruby
+class API < Grape:API
+  format :json
+  formatter :json, Grape::Formatter::Paginater
+
+  # ...
+
+  get '/stuff', :paginater => :wrapper do
+    # ... your stuff
+  end
+  
+end
+```
+
+Browse the `spec` directory and `spec/paginater/paginater_spec.rb` or `spec/paginater/paginater_with_kaminari_spec.rb` files for more examples.
+
+The last feature in progress is something useful stored in cookies. Actually you can find a value: `#page/#pages/#count` calculated with size=1.
+
+## A Running Test
+
+In the `test` directory there is a very simple running test (configured with the `:kaminari` option).
+
+```
+$ cd test
+/test$ bundle exec rackup
+[2013-03-09 16:05:25] INFO  WEBrick 1.3.1
+[2013-03-09 16:05:25] INFO  ruby 2.0.0 (2013-02-24) [i686-linux]
+[2013-03-09 16:05:25] INFO  WEBrick::HTTPServer#start: pid=3776 port=9292
+   ...
+```
+
+This expose two resources: `/foo` and `/news` (the last require an internet connection).
+Then try:
+
+```
+http://localhost:9292/foo?page=1
+  ["Alpha"]
+
+http://localhost:9292/foo?page=4&size=6
+  ["Sierra","Tango","Uniform","Victor","Whiskey","X-Ray"]
+
+http://localhost:9292/foo?page=2&size=4
+  ["Echo","Foxtrot","Golf","Hotel"]
+
+http://localhost:9292/foo
+  {"error":"missing param"}
+
+http://localhost:9292/foo?page=42
+  [] #=> with :kaminari
+  #=> {"error":"invalid page 42"} # with :simple
+
+http://localhost:9292/foo?page=2&size=42
+  [] #=> with :kaminari
+  #=> {"error":"page 2 out"} # with :simple
+
+http://localhost:9292/foo?page=1&size=111
+  ["Alpha","Bravo","Charlie", <...> ,"X-Ray","Yankee","Zulu"]
+
+http://localhost:9292/foo?page=1&size=0
+  #=> no error because default size is 1
+  #=> {"error":"divided by 0"}   # with :kaminari
+  #=> {"error":"invalid size 0"} # with :simple
+
+http://localhost:9292/foo?page=0
+  {"error":"first page must be 1"}
+
+```
+
+## headers
+
+In the response header there are links useful for pagination... maybe more to come...
+
+- first page: `{:url=>\"/foo?page=1\", :rel=>\"first\"};{:url=>\"/foo?page=2\", :rel=>\"next\"}\n`
+- last page: `{:url=>\"/foo?page=1\", :rel=>\"first\"};;{:url=>\"/foo?page=9\", :rel=>\"prev\"}`
+- just a page: `{:url=>\"/foo?page=1&size=3\", :rel=>\"first\"};{:url=>\"/foo?page=4&size=3\", :rel=>\"next\"};{:url=>\"/foo?page=2&size=3\", :rel=>\"prev\"}`
+
+The first page:
+
+```
+$ curl -I http://localhost:9292/foo?page=1&size=4
+$ HTTP/1.1 200 OK 
+Content-Type: application/json
+Link: {:url=>"/foo?page=1", :rel=>"first"};{:url=>"/foo?page=2", :rel=>"next"}
+Content-Length: 9
+Server: WEBrick/1.3.1 (Ruby/2.0.0/2013-02-24)
+Date: Sat, 09 Mar 2013 15:21:10 GMT
+Connection: Keep-Alive
+
+```
+
+```
+$ curl -I http://localhost:9292/news?page=1&size=1
+$ HTTP/1.1 200 OK 
+Content-Type: application/json
+Link: {:url=>"/news?page=1", :rel=>"first"};{:url=>"/news?page=2", :rel=>"next"}
+Content-Length: 130
+Server: WEBrick/1.3.1 (Ruby/2.0.0/2013-02-24)
+Date: Sat, 09 Mar 2013 16:56:15 GMT
+Connection: Keep-Alive
+
+```
+
+Just a page:
+
+```
+$ curl -I http://localhost:9292/foo?page=2&size=4
+$ HTTP/1.1 200 OK 
+Content-Type: application/json
+Set-Cookie: 2/26/26
+Link: {:url=>"/foo?page=1", :rel=>"first"};{:url=>"/foo?page=3", :rel=>"next"};{:url=>"/foo?page=1", :rel=>"prev"}
+Content-Length: 9
+Server: WEBrick/1.3.1 (Ruby/2.0.0/2013-02-24)
+Date: Sat, 09 Mar 2013 15:22:12 GMT
+Connection: Keep-Alive
+
+```
+
+The last page:
+
+```
+$ curl -I http://localhost:9292/foo?page=26
+$ HTTP/1.1 200 OK 
+Content-Type: application/json
+Set-Cookie: 26/26/26
+Link: {:url=>"/foo?page=1", :rel=>"first"};;{:url=>"/foo?page=25", :rel=>"prev"} 
+Content-Length: 8
+Server: WEBrick/1.3.1 (Ruby/2.0.0/2013-02-24)
+Date: Sat, 09 Mar 2013 15:23:03 GMT
+Connection: Keep-Alive
+
+```
+
+```
+$ curl -I http://localhost:9292/news?page=10
+$ HTTP/1.1 200 OK 
+Content-Type: application/json
+Set-Cookie: 10/10/10
+Link: {:url=>"/news?page=1", :rel=>"first"};{:url=>"/news?page=9", :rel=>"prev"}
+Content-Length: 127
+Server: WEBrick/1.3.1 (Ruby/2.0.0/2013-02-24)
+Date: Sat, 09 Mar 2013 16:56:47 GMT
+Connection: Keep-Alive
+
+```
+
+With `:simple`
+
+```
+$ curl -I http://localhost:9292/news?page=11
+HTTP/1.1 500 Internal Server Error
+Content-Type: application/json
+Content-Length: 27
+Connection: keep-alive
+Server: thin 1.5.0 codename Knife
+```
+
+With `:kaminari`
+
+```
+#=> []
+HTTP/1.1 200 OK 
+```
+
+## Note
+
+Unrelated but inspired by this beautiful code:
+
+- [grape](https://github.com/intridea/grape)
+- [grape-entity](https://github.com/agileanimal/grape-entity)
+- [grape-rabl](https://github.com/LTe/grape-rabl)
+
+## Discuss
+
+There is a thread on the [grape-mailinglist](https://groups.google.com/forum/?fromgroups=#!forum/ruby-grape):
+
+- https://groups.google.com/forum/?fromgroups=#!topic/ruby-grape/vH2DP1qsN9I
+
+## 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
+
+_
+