api_me 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6be2bfc501d6e34780bb7d71cc7f9504110bbe5
-  data.tar.gz: 0cdf554cf51fc1c08cc960b9aa03d9869a631ecc
+  metadata.gz: 02a356aba53a5aadcbbccb6dd04d7e4e5cc3cb51
+  data.tar.gz: c544bba077a0144161f4bf585e6d77a39cfb9d79
 SHA512:
-  metadata.gz: af00b5703f9677aa28ae0e7ae5422440931e246d90ef0f3b2ea0166d4e85b53e2c259e22568e77fa5c65bac992b2d118bb0742a616dd916f30ab08bb8c9ce5d2
-  data.tar.gz: d46be75bc55cf3ab8fa89f8c33af26c9a139098b680153a62b750a05f15130fe61802cde9955ca8731f0a046d77b548050090ecd5c58936deea169ae0cc432b0
+  metadata.gz: 03ff2f340a021a3d81363cda80165971cb42dccd0375ea80142f42ab08ac6fff4b265cd733b76c9e816f8295c5a4eec3540c844d4c29ececf598368a91fe5f48
+  data.tar.gz: 9eda9a733e53c50b7dcde5df28d7771eec648bd55ce21f35fd0167432e3e9a44f19ec7eb4ed238cb5df9f73c37dba6baf3c747fdccf40d00c83bcb53cd99faab

data/.ruby-version

@@ -1 +1 @@
-2.1.4
+2.1.5

data/.travis.yml

@@ -1,6 +1,4 @@
 language: ruby
 script: bundle exec rspec spec
 rvm:
-  - 1.9.3
-  - 2.0.0
   - 2.1.0

data/Gemfile

@@ -3,6 +3,7 @@ source 'https://rubygems.org'
 gemspec
 
 group :test do
+  gem 'pry'
   gem 'activerecord'
   gem 'activesupport'
   gem 'actionpack' # action_controller, action_view

data/api_me.gemspec

@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'pundit',                   '~> 1.0'
   s.add_runtime_dependency 'active_model_serializers', '~> 0.8.0'
   s.add_runtime_dependency 'search_object',            '~> 1.0'
+  s.add_runtime_dependency 'kaminari',                 '~> 0.16.3'
 
   s.add_development_dependency 'combustion',  '~> 0.5.1'
   s.add_development_dependency 'rspec-rails', '~> 3'

data/lib/api_me.rb

@@ -1,9 +1,11 @@
 require 'active_support/concern'
 require 'pundit'
 require 'search_object'
+require 'kaminari'
 
 require 'api_me/version'
 require 'api_me/base_filter'
+require 'api_me/pagination'
 
 module ApiMe
   extend ActiveSupport::Concern
@@ -65,12 +67,13 @@ module ApiMe
   def index
     ids_filter_hash = params[:ids] ? { ids: params[:ids] } : {}
     @scoped_objects = policy_scope(resource_scope)
-    @filter_objects = filter_klass.new(
+    @filter_object = filter_klass.new(
         scope: @scoped_objects,
         filters: (filter_params || {}).merge(ids_filter_hash)
     )
+    @pagination_object = ApiMe::Pagination.new(scope: @filter_object.results, page_params: params[:page])
 
-    render json: @filter_objects.results, each_serializer: serializer_klass
+    render json: @pagination_object.results, each_serializer: serializer_klass, meta: { page: @pagination_object.page_meta }
   end
 
   def show

data/lib/api_me/pagination.rb

@@ -0,0 +1,55 @@
+module ApiMe
+  class Pagination
+    attr_accessor :page_size, :page_offset, :scope
+
+    def initialize(scope:, page_params:)
+      self.scope = scope
+
+      if page_params
+        self.page_size = page_params[:size]
+        self.page_offset = page_params[:offset]
+      end
+    end
+
+    def results
+      paging? ? page.per.scope : scope
+    end
+
+    def page_meta
+      return Hash.new unless paging?
+
+      {
+        size: page_size.nil? ? default_page_size : page_size,
+        offset: page_offset,
+        record_count: scope.size,
+        total_records: scope.total_count,
+        total_pages: scope.total_pages
+      }
+    end
+
+    protected
+
+    def page
+      self.scope = scope.page(self.page_offset ? page_offset : 1)
+      self
+    end
+
+    def per
+      if page_size
+        self.scope = scope.per(page_size)
+      end
+
+      self
+    end
+
+    private
+
+    def default_page_size
+      Kaminari.config.default_per_page
+    end
+
+    def paging?
+      page_size || page_offset
+    end
+  end
+end

data/lib/api_me/version.rb

@@ -1,3 +1,3 @@
 module ApiMe
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/spec/acceptance/api/v1/posts_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe 'Users API' do
+describe 'Posts API' do
   it 'sends the list of posts using the default filter' do
     posts = [
       Post.create(name: 'test'),
@@ -15,6 +15,111 @@ describe 'Users API' do
     expect(json['posts'].length).to eq(posts.count)
   end
 
+  it 'is paging with page offset using default page size and restricting size' do
+    40.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts?page%5Boffset%5D=1'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(25)
+
+  end
+
+  it 'is page offset of 2 working for size of 40 default page size of 25' do
+    40.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts?page%5Boffset%5D=2'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(15)
+
+  end
+
+  it 'is page offset of -1 working for size of 40 default page size of 25' do
+    #min page offset is 1, anything less gets converted to 1 and results in page size records
+    40.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts?page%5Boffset%5D=-1'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(25)
+
+  end
+
+  it 'is page offset of 3 working for size of 40 default page size of 25' do
+    #overflow on page offset will result in 0 records
+    40.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts?page%5Boffset%5D=3'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(0)
+
+  end
+
+  it 'is page size of 10 working for default offset of 1' do
+    #overflow on page offset will result in 0 records
+    40.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts?page%5Bsize%5D=10'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(10)
+
+  end
+
+  it 'is page size working when the value is negative' do
+    #overflow on page offset will result in 0 records
+    40.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts?page%5Bsize%5D=-10'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(25)
+
+  end
+
+  it 'is page size working when the value is higher than the total record count' do
+    #overflow on page offset will result in 0 records
+    40.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts?page%5Bsize%5D=100'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(40)
+  end
+
+  it 'is the result all records when no page paramas are sent' do
+    #overflow on page offset will result in 0 records
+    100.times do
+      Post.create(name: 'page item')
+    end
+
+    get '/api/v1/posts'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(100)
+
+  end
+
+  it 'restricts page_size when max_per_page config is less' do
+    100.times do
+      Post.create(name: 'page item')
+    end
+
+    Kaminari.config.max_per_page = 10
+
+    get '/api/v1/posts?page%5Bsize%5D=100'
+    json = JSON.parse(last_response.body)
+    expect(json['posts'].length).to eq(10)
+  end
+
   it 'sends posts filtered by ids' do
     all_posts = [
       Post.create(name: 'test'),

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_me
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Sam Clopton
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-13 00:00:00.000000000 Z
+date: 2016-02-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -81,6 +81,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: kaminari
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.16.3
 - !ruby/object:Gem::Dependency
   name: combustion
   requirement: !ruby/object:Gem::Requirement
@@ -171,6 +185,7 @@ files:
 - config.ru
 - lib/api_me.rb
 - lib/api_me/base_filter.rb
+- lib/api_me/pagination.rb
 - lib/api_me/version.rb
 - lib/generators/api_me/controller/USAGE
 - lib/generators/api_me/controller/controller_generator.rb