resourcey 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a9aa954231608cbfdc8b87e05cb5f94e31d80514
-  data.tar.gz: 381b79282c48ffc3bf6312178cebea47b0991a6b
+  metadata.gz: 5348dbbfc10aec535cb095b78c129e9c8156c307
+  data.tar.gz: e7bd3e77e11450f4ea48bf33df1159fccce6360c
 SHA512:
-  metadata.gz: 67480d655294ea8c964c355a12f921d42c754d88701c4a63167db43165337191cc3f42b2cdf96725f9c034a632c7c4ea204a8817d842a70ba4a4c5f9d6cd7408
-  data.tar.gz: e64c924852dfb40710766cea3959dc373abb3ca4bad35bd4e50a3fd99410ecdc40096b338189921471e30a63497c113621cd92a06f1d9567b265a08335d13cad
+  metadata.gz: 2ebf6b3b8b417a0b155a6f228cc7f20a321bbe405286c8bd4fc6a241bb49fecca8fc2589c2c59e0084d30e5b1489b4f3257151aebf3aa2fc62936ae1366d3163
+  data.tar.gz: cc7c5945c9020292441d3886e53d35575f53a379b63a335e944505e05d748b82805543b7a041df698a2eb046f44ea14576cdb16035ef3757d71b5b7bb3b4a2a2

data/README.md

@@ -3,6 +3,17 @@
 
 A lightweight rails gem for building resource-based APIs.
 
+### Table of contents
+- [Installation](#installation)
+- [Usage](#usage)
+  - [Controller](#controller)
+  - [Serialization](#serialization)
+  - [How to fetch](#fetch-the-data)
+  - [Pagination](#pagination)
+  - [Filtering](#filtering)
+- [Configuration](#configuration)
+- [Contributing](#contributing)
+
 ## Installation
 Add Resourcey to your `Gemfile`:
 ```ruby
@@ -20,6 +31,7 @@ gem install resourcey
 ```
 
 ## Usage
+
 ### Controller
 For a resource called `user`, just create `UsersController`:
 ```ruby
@@ -29,8 +41,7 @@ end
 
 For further reading, [click here](/docs/CONTROLLER.md).
 
-### Serializer
-
+### Serialization
 Now you need a serializer, let's assume that `User` has an email and an ID, go with this:
 ```ruby
 class UserSerializer < Resourcey::Serializer
@@ -72,6 +83,19 @@ This will fetch page 3, with 10 resources per single page. That's all! Paginatio
 
 For further reading, [click here](/docs/PAGINATION.md).
 
+### Filtering
+You can filter your resources using filter objects defined per single resource model. See below for an example:
+
+```ruby
+class UserFilter < Resourcey::Filter
+  filter :older_than do |value, scope|
+    scope.where('users.age > ?', value)
+  end
+end
+```
+
+For further reading, [click here](/docs/FILTERING.md).
+
 ## Configuration
 Create configuration file in your `config/initializers` folder, and configure as usual:
 ```ruby
@@ -83,7 +107,7 @@ 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
+## Contributing
 If you want to take part in developing resourcey, fork this repository, commit your code, and create pull request.
 
 ### Requirements

data/lib/resourcey/controller.rb

@@ -1,8 +1,8 @@
-require 'resourcey/controller_pagination'
-require 'resourcey/controller_model'
+require 'resourcey/controller_modules'
 
 module Resourcey
   class Controller < ActionController::Base
+    include Resourcey::ControllerFiltering
     include Resourcey::ControllerPagination
     include Resourcey::ControllerModel
 

data/lib/resourcey/controller_filtering.rb

@@ -0,0 +1,16 @@
+module Resourcey
+  module ControllerFiltering
+    def filtered_resources
+      return resources if filter_class.nil?
+
+      filter_instance = filter_class.new(params)
+      filter_instance.apply(resources)
+    end
+
+    private
+
+    def filter_class
+      "#{resource_model}Filter".safe_constantize
+    end
+  end
+end

data/lib/resourcey/controller_modules.rb

@@ -0,0 +1,3 @@
+require 'resourcey/controller_filtering'
+require 'resourcey/controller_pagination'
+require 'resourcey/controller_model'

data/lib/resourcey/controller_pagination.rb

@@ -11,10 +11,10 @@ module Resourcey
     private
 
     def paginated_resources
-      return resources unless self.pagination_enabled
+      return filtered_resources unless self.pagination_enabled
 
       paginator = current_paginator_class.new(params)
-      paginator.paginate(resources)
+      paginator.paginate(filtered_resources)
     end
 
     def current_paginator_class

data/lib/resourcey/errors.rb

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

data/lib/resourcey/filter.rb

@@ -0,0 +1,33 @@
+module Resourcey
+  class Filter
+    class_attribute :allowed_params
+    class_attribute :filters
+
+    def initialize(params)
+      @permitted_params = params.permit(self.allowed_params)
+    end
+
+    def apply(scope)
+      @permitted_params.each do |filter_name, permitted_param|
+        filter = self.filters.find { |filter| filter.name == filter_name }
+        scope = filter.apply(permitted_param, scope)
+      end
+
+      scope
+    end
+
+    class << self
+      def filter(filter_name, opts = {}, &block)
+        self.allowed_params ||= []
+        self.allowed_params << filter_name
+
+        self.filters ||= []
+        self.filters << build_filter(filter_name, opts, &block)
+      end
+
+      def build_filter(filter_name, opts, &block)
+        FilterProcessor.new(filter_name, opts, &block)
+      end
+    end
+  end
+end

data/lib/resourcey/filter_processor.rb

@@ -0,0 +1,35 @@
+module Resourcey
+  class FilterProcessor
+    ALLOWED_OPTIONS = %i[multivalue].freeze
+
+    attr_reader :name
+
+    def initialize(name, opts = {}, &block)
+      @name = name.to_s
+      @opts = opts
+      @block = block
+
+      validate_options!
+    end
+
+    def apply(permitted_param, scope)
+      filter_value = parse_filter_value(permitted_param)
+      block.call(filter_value, scope)
+    end
+
+    private
+
+    attr_reader :opts, :block
+
+    def parse_filter_value(permitted_param)
+      return permitted_param unless opts[:multivalue]
+      permitted_param.split(',')
+    end
+
+    def validate_options!
+      invalid_option = opts.keys.find { |option| ALLOWED_OPTIONS.exclude? option }
+      return true if invalid_option.nil?
+      raise Errors::OptionNotAllowed.new(invalid_option)
+    end
+  end
+end

data/lib/resourcey.rb

@@ -5,3 +5,5 @@ require 'resourcey/config'
 require 'resourcey/controller'
 require 'resourcey/serializer'
 require 'resourcey/paginator'
+require 'resourcey/filter'
+require 'resourcey/filter_processor'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: resourcey
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - polakowski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-23 00:00:00.000000000 Z
+date: 2018-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,9 +90,13 @@ files:
 - lib/resourcey.rb
 - lib/resourcey/config.rb
 - lib/resourcey/controller.rb
+- lib/resourcey/controller_filtering.rb
 - lib/resourcey/controller_model.rb
+- lib/resourcey/controller_modules.rb
 - lib/resourcey/controller_pagination.rb
 - lib/resourcey/errors.rb
+- lib/resourcey/filter.rb
+- lib/resourcey/filter_processor.rb
 - lib/resourcey/paginator.rb
 - lib/resourcey/serializer.rb
 homepage: https://github.com/polakowski/resourcey