api_monkey 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 14630a35b125ccf8d2107cb54a0d4be4f16d8031
-  data.tar.gz: e7fd94d3f82f6c99b4eba34f769422f1cba993e4
+  metadata.gz: ea6c7219d0438e4edfc69a15a33fd27180841b19
+  data.tar.gz: c43568afe1cb1d6681fbe6993cb905582d2082e5
 SHA512:
-  metadata.gz: db3fdc5d3e2a09e81a6fcafd0bfdbfa70e9fa884a728b3709c0a3ef96320c63e26f6e29edace93dd46b9a432eddfcf790d44adbb6d48c2e27f5256b1ce5271be
-  data.tar.gz: 018ded42e99d237e7ff8cc40b239c7849f3dd28eae26cf88d84ab43caf051b161de50e58bdeaa1c32d7cc477554fd647938167462b2105214b315afd228541ab
+  metadata.gz: 602f83bd78cb22bbfc54c9bf45b46a6b3d0545714c5732a7f9081f43625ff46e1b7597255e8f4cd3d99d27548b96f648886e2cfe69a02ef498f9b7ffb771076b
+  data.tar.gz: cdeb5c1fa6720b152b0f2f9c9dbb440109c32a6b95c696b4c3b63e19c8774461ffd8245f77f050cd0b0970c8f721de3105b0e6e0585c0337de0131eda595d189

data/README.md

@@ -27,24 +27,101 @@ end
 
 ### Filter Params
 Filter params provide a clean and easy way to add request-based
-filtering of your active record models:
+filtering of your active record models.  To use filter params, ApiMonkey
+expects the parameters send to rails to resolve like this:
+
+```ruby
+# http://my.domain/products?filter[price]=200
+
+{
+  filter: {
+    price: 200
+  }
+}
+```
+This would filter our Product query to only those with `price = 200`
+
+More complex filters can be applied using an operator shorthand that
+allows for equality and comparison operators.  The list of possible
+operators are:
+
+|SQL Operator|Operator Shorthand|
+|---|---|
+|=|eq|
+|>|gt|
+|<|lt|
+|<=|leq|
+|>=|geq|
+
+To use these, just change the concrete value for `price` in the above
+hash to it's own hash using the operators as keys:
+
+```ruby
+# http://my.domain/products?filter[price[gt]]=200
+
+{
+  filter: {
+    price: {
+      'gt' => 200
+    }
+  }
+}
+```
+
+Or:
+
+```ruby
+# http://my.domain/products?filter[price[gt]]=200&filter[price[leq]]=350
+
+{
+  filter: {
+    price: {
+      'gt' => 200,
+      'leq' => 350
+    }
+  }
+}
+```
+
+To use ApiMonkey in an exisitng Rails app, you have to include the ApiMonkey module in your model like this:
+
+```ruby
+class Product < ActiveRecord::Base
+  include ApiMonkey
+end
+```
+
+This will create all the necessary filtering methods that will be used
+in your controller.  Next we want to add the filter to our controller. Use a methodology similar to
+strong parameters.  We recommend using a controller method like this:
 
 ```ruby
 # app/controllers/products_controller.rb
 
 class ProductsController < ApplicationController
   def index
-    @products = Product.filter(filter_params)
+    @products = if params[:filter]
+                  Product.filter(filter_params)
+                else
+                  Product.all
   end
 
   protected
 
   def filter_params
-    params.slice(:active, :price, :code)
+    params.require(:filter).permit(Product.filter_params)
   end
 end
 ```
 
+`Model.filter_params` is a simple hash so it supports methods like
+`include` and `except` to help control the fields that can be filtered
+against.
+`filter` is designed so that passing either `nil` or `{}` to it will
+produce an empty set (`where(nil)`). Therefore, you should ensure that
+filter exists as a key in `params`. Passing `nil` to one of the
+`filter_xxx` will result in a `where(xxx: nil)`.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/api_monkey.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["michaelkelly322@gmail.com"]
 
   spec.summary       = "Makes building data-driven APIs in Rails a breeze"
-  spec.description   = "Makes building data-driven APIs in Rails a breeze by providing an easy to use DSL for declaring API resources"
+  spec.description   = "Makes building data-driven APIs in Rails a breeze by providing an easy to use DSL for working with API resources"
   spec.homepage      = "https://github.com/michaelkelly322/api_monkey"
   spec.license       = "MIT"
 
@@ -22,4 +22,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+
+  spec.add_runtime_dependency 'activesupport'
 end

data/lib/api_monkey.rb

@@ -1,3 +1,5 @@
+require 'active_support/concern'
+
 require "api_monkey/version"
 require "api_monkey/filterable"
 require "api_monkey/filter_scopes"

data/lib/api_monkey/filter_scopes.rb

@@ -2,9 +2,44 @@ module ApiMonkey::FilterScopes
   extend ActiveSupport::Concern
 
   included do
+    OPERANDS = {
+      'eq' => '=',
+      'gt' => '>',
+      'lt' => '<',
+      'geq' => '>=',
+      'leq' => '<=',
+    }.freeze
+
+    # Define filter methods
     column_names.map do |field_name|
       define_singleton_method "filter_#{field_name}" do |param|
-        where("#{field_name} = ?", param)
+        if param.is_a? Hash
+          where(*process_hash_params(field_name, param))
+        else
+          where(*filter_args(field_name, param, 'eq'))
+        end
+      end
+    end
+
+    def self.filter_args(field, value, op)
+      ["#{field} #{OPERANDS[op]} ?", value]
+    end
+
+    def self.process_hash_params(field, param)
+      predicates, values = [],[]
+      param.keys.each do |k|
+        predicates << filter_args(field, param[k], k)[0]
+        values << filter_args(field, param[k], k)[1]
+      end
+
+      [predicates.join(' AND '), *values]
+    end
+
+    def self.filter_params
+      {}.tap do |h|
+        column_names.each do |field_name|
+          h[field_name.to_sym] = OPERANDS.keys.map &:to_sym
+        end
       end
     end
   end

data/lib/api_monkey/filterable.rb

@@ -4,6 +4,7 @@ module ApiMonkey::Filterable
   included do
     define_singleton_method :filter do |filtering_params|
       results = self.where(nil)
+      return results unless filtering_params
       filtering_params.each do |key, value|
         results = results.public_send("filter_#{key}", value) if value.present?
       end

data/lib/api_monkey/version.rb

@@ -1,3 +1,3 @@
 module ApiMonkey
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: api_monkey
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Michael Kelly
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-23 00:00:00.000000000 Z
+date: 2016-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,8 +52,22 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
 description: Makes building data-driven APIs in Rails a breeze by providing an easy
-  to use DSL for declaring API resources
+  to use DSL for working with API resources
 email:
 - michaelkelly322@gmail.com
 executables: []
@@ -96,8 +110,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Makes building data-driven APIs in Rails a breeze
 test_files: []
+has_rdoc: