napa_pagination 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 07d5307088369425a0b17541a94234c47451b619
-  data.tar.gz: 7c2069fcf395bbc9c4261abca4bc633b8a32af6c
+  metadata.gz: deb862f59da8ed1c1df3e7d7d8c8823b00109da8
+  data.tar.gz: f9698f0a91dad8b045dd850e1f8c4e8e07adb5dd
 SHA512:
-  metadata.gz: 6f03cb1064bf82e50b2460f23abeecd936e1c06fe344f38d13f9be5e6583d5e9941efc646e0ac1f9545b6a2180cf52fd400ea3d17364737266d8a3b35ad74199
-  data.tar.gz: df5563f6d04fa1849087082d4966bbae1408a7adf87721005b202de0870408218a554e1e756be24f6c64066c9152fe136f4a2f6213ec7879f1ddbb4010ca1780
+  metadata.gz: ae48eadddde8de0784b530f1c3fe2bb445d912b87413065592a26335fc47e9808c39fc1b5ccf0332ff158361a2e2d10842166f83711b309598303d4aa4fa0a6d
+  data.tar.gz: 94735c539549b6402268d27784d41f0793a36fad2f29592167f1fc789f996eab63e4f4acb0432fae868650beb88f36378e3bd145fe79aa4b74a7bb061777de31

data/README.md

@@ -1,6 +1,6 @@
 # NapaPagination
 
-A simple pagination representer for Napa
+A simple pagination representer & results orderer for Napa
 
 ## Installation
 
@@ -16,6 +16,9 @@ Or install it yourself as:
 
     $ gem install napa_pagination
 
+
+# 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](https://github.com/bellycard/napa/blob/master/docs/quickstart.md).
 
@@ -45,7 +48,7 @@ class PeopleApi < Grape::API
     optional :per_page, type: Integer, desc: 'Results per page', default: 100
   end
   get do
-    people = Person.filter(declared(params, include_missing: false))
+    people = Person.filter(declared(params.except(:per_page), include_missing: false))
     # represent people, with: PersonRepresenter
     paginate people, with: PersonRepresenter
   end
@@ -54,6 +57,60 @@ class PeopleApi < Grape::API
 end
 ```
 
+# Results Ordering
+
+Once the gem is installed, and you've replaced `represent` with the `paginate you'll just need to add one api paremeters `:sort_by`
+
+```ruby
+class PeopleApi < Grape::API
+  desc 'Get a list of people'
+  params do
+    optional :ids, 
+             type: String, 
+             desc: 'comma separated person ids'
+    optional :sort_by, 
+             type: Symbol,
+             desc: 'the key to sort the results by',
+             values: [:id, :name, :age]
+  end
+  get do
+
+    people = Person.filter(declared(params.except(:sort_by), include_missing: false))
+    represent people, with: PersonRepresenter
+  end
+
+  ...
+end
+```
+ ```ruby
+class PeopleApi < Grape::API
+  desc 'Get a list of people'
+  params do
+    optional :ids, 
+             type: String, 
+             desc: 'comma separated person ids'
+    optional :sort_by, 
+             type: Symbol,
+             desc: 'the key to sort the results by',
+             values: [:id, :name, :age]
+    optional :sort_order,
+             type: Symbol,
+             desc: 'the order to sort the results by',
+             values: [:asc, :desc]
+  end
+  get do
+    people = Person.filter(declared(params.except(:sort_by, :sort_order), include_missing: false))
+    order_by_params!(people)
+
+    represent people, with: PersonRepresenter
+  end
+
+  ...
+end
+```
+
+You can also change the order in which the sort happens by providing a `sort_order` parameter. By default this will be ascending. 
+
 ## Contributing
 
 1. Fork it ( http://github.com/<my-github-username>/napa_pagination/fork )

data/lib/napa_pagination.rb

@@ -1,6 +1,7 @@
 require 'grape'
 require 'napa'
 require 'kaminari/grape'
+require 'active_record'
 
 require 'napa_pagination/version'
 require 'napa_pagination/pagination'

data/lib/napa_pagination/grape_helpers.rb

@@ -10,7 +10,7 @@ module NapaPagination
           r[:pagination] = data.to_h
         end
       else
-        return { data: with.new(data).to_hash(args)}
+        return { data: with.new(data).to_hash(args) }
       end
     end
 
@@ -21,6 +21,8 @@ module NapaPagination
       page      = params.try(:page) || 1
       per_page  = params.try(:per_page) || 25
 
+      order_by_params!(data) if data.is_a?(ActiveRecord::Relation) && data.size > 0 
+
       if data.is_a?(Array)
         Kaminari.paginate_array(data).page(page).per(per_page)
       else
@@ -28,6 +30,14 @@ module NapaPagination
       end
     end
 
+    def order_by_params!(data)
+      if data.column_names.map(&:to_sym).include?(params[:sort_by])
+        sort_order = params.try(:sort_order) || :asc
+        data.order!(params[:sort_by] => sort_order)
+      end
+      data
+    end
+
     # extend all endpoints to include this
     Grape::Endpoint.send :include, self
   end

data/lib/napa_pagination/version.rb

@@ -1,3 +1,3 @@
 module NapaPagination
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/napa_pagination.gemspec

@@ -21,10 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'grape'
   spec.add_dependency 'napa'
   spec.add_dependency 'kaminari'
-
+  spec.add_dependency 'activerecord'
+  
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'rspec', "~> 3.0"
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'sqlite3'

data/spec/grape_helpers_spec.rb

@@ -7,17 +7,20 @@ class FooRepresenter < Napa::Representer; end
 describe NapaPagination::GrapeHelpers do
   before do
     @endpoint = Grape::Endpoint.new(nil, {path: '/test', method: :get})
+    allow(@endpoint).to receive(:params).and_return({ })
   end
-
+  
+  after do
+    Foo.destroy_all
+  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)
@@ -88,4 +91,36 @@ describe NapaPagination::GrapeHelpers do
       expect(output[:pagination][:total_count]).to eq(3)
     end
   end
+
+  context '#sort_by_params' do
+    before do
+      @added_first = Foo.create(word: 'b')
+      @asc_first = Foo.create(word: 'a')
+      @asc_last = Foo.create(word: 'c')
+    end
+
+
+    it 'orders the array in ascending order' do
+      allow(@endpoint).to receive(:params).and_return(Hashie::Mash.new({ sort_by: :word, sort_order: :asc }))
+
+      output = @endpoint.paginate(Foo.all, with: FooRepresenter)
+      expect(output[:data].first['word']).to eql(@asc_first.word)
+      expect(output[:data][1]['word']).to eql(@added_first.word)
+      expect(output[:data].last['word']).to eql(@asc_last.word)
+    end
+
+    it 'does nothing if there are not sort params' do
+
+      output = @endpoint.paginate(Foo.all, with: FooRepresenter)
+      expect(output[:data].first['word']).to eql(@added_first.word)
+    end
+
+    it 'orders the array in descending order' do
+      allow(@endpoint).to receive(:params).and_return(Hashie::Mash.new({ sort_by: :word, sort_order: :desc }))
+
+      output = @endpoint.paginate(Foo.all, with: FooRepresenter)
+      expect(output[:data].first['word']).to eql(@asc_last.word)
+      expect(output[:data].last['word']).to eql(@asc_first.word)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -13,5 +13,9 @@ RSpec.configure do |config|
 
     class Foo < ActiveRecord::Base
     end
+
+    class FooRepresenter < Napa::Representer
+      property :word, type: String
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: napa_pagination
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Darby Frey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grape
@@ -52,6 +52,20 @@ dependencies:
     - - '>='
       - !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: :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
@@ -84,16 +98,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -205,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.0.7
 signing_key: 
 specification_version: 4
 summary: A simple pagination representer for Napa