resourcey 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8717fa2e66160b64e006f2e8815042efb56863f2
-  data.tar.gz: f2728bdf17ab672ca8a0722e80072d27b577daf5
+  metadata.gz: 576cd7bfe264dae2d656ed025680ac039d4bc3ad
+  data.tar.gz: 2d6f3380904ec055a351bdf6fce757df49e2e8bf
 SHA512:
-  metadata.gz: 9bf8d7fbf5f97202170dc7bfb474152f77ebc9d54bf61b3299116419cd783fbe621ac2291d233c15887100669fa756a073f146559a7ecb578459011b00e87015
-  data.tar.gz: 8f885c1ee23b45c714c9cdfd01f3675f83611ad551f733ba4b5410a7c5e1ba430e13d7deb427342e9dd2b8d4ba95cb6b7c5bbd66935349277e7a9ffc5227eab1
+  metadata.gz: 196654c51925608372e63e718cb5196c21290fa28cd78bf326ec2b4227b28397eb232bf113d1ee87b32762db4336c7e55607c8fc741476bb55b07ce235f8fa22
+  data.tar.gz: 6bd006a5e70cc6a98b0e682c80a4263d16a8a84d195cdc0467c5abab2bd7bb8f916d6c7f6ff6d9fa846d71c1892f57a8f50782c8c690e9ef621586a68fb2761d

data/README.md

@@ -19,7 +19,7 @@ gem install resourcey
 
 ## Usage
 ### Controller
-For a resource called `user`, just create `UsersController` in a correct namespace (e.g. 'api/v1')
+For a resource called `user`, just create `UsersController`:
 ```ruby
 class Api::V1::UsersController < Resourcey::Controller
 end
@@ -52,6 +52,35 @@ Now just visit `/api/v1/users`, and see how your resources are rendered.
 ]
 ```
 
+### Pagination
+To paginate resources, simply invoke `paginate` method in controller, like this:
+```ruby
+class ResourcesController < Resourcey::Controller
+  paginate
+end
+```
+
+This will use default `:paged` paginator. Now you need to pass `page` and `per_page` parameters in `pagination` parameter value, like this:
+
+```
+http://api.example.com/resources?page=3&per_page=10
+```
+
+This will fetch page 3, with 10 resources per single page. That's all! Pagination can be configured globally (see "Configuration" below). Also you can configure every controller's pagination.
+
+For further reading, [click here](/docs/PAGINATION.md).
+
+## Configuration
+Create configuration file in your `config/initializers` folder, and configure as usual:
+```ruby
+Resourcey.configure do |config|
+  config.some_config_variable = :some_value
+end
+```
+
+### Available config variables
+- `default_paginator` - name of paginator that will be used in every controller, if not configured on controller-level (default: `:paged`)
+
 ## Gem development
 If you want to take part in developing resourcey, fork this repository, commit your code, and create pull request.
 

data/lib/resourcey/config.rb

@@ -1,9 +1,9 @@
 module Resourcey
   class Config
-    attr_accessor :foo
+    attr_accessor :default_paginator
 
     def initialize
-      self.foo = 'foo'
+      self.default_paginator = :paged
     end
   end
 

data/lib/resourcey/controller.rb

@@ -1,7 +1,11 @@
+require 'resourcey/controller_pagination'
+
 module Resourcey
   class Controller < ActionController::Base
+    include Resourcey::ControllerPagination
+
     def index
-      render json: serialized_collection(resources)
+      render json: serialized_collection(paginated_resources)
     end
 
     def show
@@ -53,12 +57,12 @@ module Resourcey
 
     def resource_model
       name = resource_model_name
-      name.safe_constantize || raise(Errors::ClassNotFound.new(name, :model))
+      name.safe_constantize || raise(Errors::ClassNotFound.new(name))
     end
 
     def serializer
       name = "#{resource_model_name}Serializer"
-      name.safe_constantize || raise(Errors::ClassNotFound.new(name, :serializer))
+      name.safe_constantize || raise(Errors::ClassNotFound.new(name))
     end
 
     def resources

data/lib/resourcey/controller_pagination.rb

@@ -0,0 +1,46 @@
+module Resourcey
+  module ControllerPagination
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :pagination_enabled
+      class_attribute :controller_paginator_name
+      class_attribute :controller_paginator_options
+    end
+
+    private
+
+    def paginated_resources
+      return resources unless self.pagination_enabled
+
+      paginator = current_paginator_class.new(params)
+      paginator.paginate(resources)
+    end
+
+    def current_paginator_class
+      Resourcey::Paginator.class_for(current_paginator_name)
+    end
+
+    def current_paginator_name
+      self.controller_paginator_name || Config.default_paginator
+    end
+
+    module ClassMethods
+      def paginate_with(name, opts = {})
+        enable_pagination!
+        self.controller_paginator_name = name
+        self.controller_paginator_options = opts
+      end
+
+      def paginate(opts = {})
+        paginate_with(Resourcey.config.default_paginator, opts)
+      end
+
+      private
+
+      def enable_pagination!
+        self.pagination_enabled = true
+      end
+    end
+  end
+end

data/lib/resourcey/errors.rb

@@ -1,6 +1,7 @@
 module Resourcey
   module Errors
     class BaseError < StandardError; end
+    class BaseError < StandardError; end
 
     class NotImplemented < BaseError; end
     class ClassNotFound < BaseError; end

data/lib/resourcey/paginator.rb

@@ -0,0 +1,70 @@
+module Resourcey
+  class Paginator
+    class_attribute :allowed_params
+
+    def initialize(params)
+      parsed_params = parse_params(params)
+      setup(parsed_params)
+    end
+
+    def parse_params(params)
+      params.permit(self.allowed_params)
+    end
+
+    def paginate(*args)
+      raise Errors::NotImplemented.new(:paginate)
+    end
+
+    def setup(*args)
+      raise Errors::NotImplemented.new(:setup)
+    end
+
+    private
+
+    class << self
+      def class_for(name)
+        paginator_name = "#{name.to_s.camelize}Paginator"
+        paginator_name.safe_constantize || raise(Errors::ClassNotFound.new(paginator_name))
+      end
+
+      def permit_params(*args)
+        self.allowed_params = args
+      end
+    end
+  end
+end
+
+class PagedPaginator < Resourcey::Paginator
+  permit_params :page, :per_page
+
+  def setup(opts)
+    @page = opts[:page].to_i
+    @per_page = opts[:per_page].to_i
+  end
+
+  def paginate(scope)
+    offset = (page - 1) * per_page
+    scope.offset(offset).limit(per_page)
+  end
+
+  private
+
+  attr_reader :page, :per_page
+end
+
+class OffsetPaginator < Resourcey::Paginator
+  permit_params :offset, :limit
+
+  def setup(opts)
+    @offset = opts[:offset]
+    @limit = opts[:limit]
+  end
+
+  def paginate(scope)
+    scope.offset(offset).limit(limit)
+  end
+
+  private
+
+  attr_reader :offset, :limit
+end

data/lib/resourcey.rb

@@ -4,3 +4,4 @@ require 'resourcey/errors'
 require 'resourcey/config'
 require 'resourcey/controller'
 require 'resourcey/serializer'
+require 'resourcey/paginator'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resourcey
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - polakowski
@@ -90,7 +90,9 @@ files:
 - lib/resourcey.rb
 - lib/resourcey/config.rb
 - lib/resourcey/controller.rb
+- lib/resourcey/controller_pagination.rb
 - lib/resourcey/errors.rb
+- lib/resourcey/paginator.rb
 - lib/resourcey/serializer.rb
 homepage: https://github.com/polakowski/resourcey
 licenses: