mongoid_hash_query 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 38cb5283bf7399e66d57f5040f3575d3982ddc98
+  data.tar.gz: 3a3a92fd0fe6a84c51362a0da71f25446c10cb27
+SHA512:
+  metadata.gz: c7c6c5b45715c6352d487a5f4b7baa2bf7a3c194136e7951bf77c650646681001977cf295927246d8fa7c3758615cf6db45944020a1f99332520084e2c2d9cbe
+  data.tar.gz: 9e8a7e0d5881d1e0f11f4159723b21ccfad4c2eaade7c89fd5807da2432a58849e865d8789f515469e4e96c875ae95be74339b589f629c3e7359681382d3bc03

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http:contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid_hash_query.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Filippos Vasilakis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,151 @@
+# MongoidHashQuery
+
+## Introduction
+__Important: text with ~~strikethrough~~ are future features not yet implemented__
+
+That's the little brother of [ActiveHashRelation](https://github.com/kollegorna/active_hash_relation) gem.
+
+Simple gem that allows you to manipulate Mongoid queries using Hash/JSON. For instance:
+```ruby
+apply_filters(resource, {name: 'RPK', start_date: {leq: "2014-10-19"}, act_status: "ongoing"})
+```
+It's perfect for filtering a collection of resources on APIs.
+
+It should be noted that `apply_filters` calls `MongoidHashQuery::FilterApplier` class
+underneath with the same params.
+
+_\*A user could retrieve resources based
+on unknown attributes (attributes not returned from the API) by brute forcing
+which might or might not be a security issue. If you don't like that check
+[whitelisting](https://github.com/kollegorna/mongoid_hash_query#whitelisting)._
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'mongoid_hash_query'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mongoid_hash_query
+    
+## How to use
+The gem exposes only one method: `apply_filters(resource, hash_params, include_associations: false, model: nil)`. `resource` is expected to be an Mongoid::Criteria.
+That way, you can add your custom filters before calling `apply_filters`.
+
+In order to use it you have to include MongoidHashQuery module in your class. For instance in a Rails API controller you would do:
+
+```ruby
+class Api::V1::ResourceController < Api::V1::BaseController
+  include MongoidHashQuery
+
+  def index
+    resources = apply_filters(Resource.all, params)
+
+    authorized_resources = policy_scope(resource)
+
+    render json: resources
+  end
+end
+```
+
+## The API
+### Fields
+For each param, `apply_filters` method will search in the model (derived from the first param, or explicitly defined as the last param) all the record's field names ~~and associations~~. ~~(filtering based on scopes are not working at the moment but will be supported soon).~~ For each column, if there is such a param, it will apply the filter based on the column type. The following column types are supported:
+
+#### Id
+Mongo's documents have an `id`, names `_id` of type BSON::ObjectId. You can just pass in `id` instead of `_id`:
+* `{id: 5}`
+* ~~`{id: [1,3,4,5,6,7]}`~~
+
+#### Integer, Float, BigDecimal, Date, Time or Datetime
+You can apply an equality filter:
+* `{example_column: 500}`
+or using a hash as a value you get more options:
+* `{example_field: {le: 500}}`
+* `{example_field: {leq: 500}}`
+* `{example_field: {ge: 500}}`
+* `{example_field: {geq: 500}}`
+
+Of course you can provide a compination of those like:
+* `{example_column: {geq: 500, le: 1000}}`
+
+The same api is for Float, BigDecimal, Date, Time or Datetime.
+
+#### Boolean
+I am not sure how Mongoid converts input to boolean but according to [that spec](https://github.com/mongoid/mongoid/blob/master/spec/mongoid/extensions/boolean_spec.rb) a value to be true must be one of the following: `[true, 1, '1', 't', 'T', 'true', 'TRUE']`. Anything else is false. 
+* `{example_field: true}`
+* `{example_field: 0}`
+
+#### String
+You can apply an equality filter:
+* `{example_field: test}`
+
+Soon you will be able to send in regex..
+
+### Hash
+You can apply an equality filter on hashes like that:
+* `{example_field: {foo: 'bar', bar: 'foo'}}`
+
+
+### Limit
+A limit param defines the number of returned resources. For instance:
+* `{limit: 10}`
+
+However I would strongly advice you to use a pagination gem like Kaminari, and use `page` and `per_page` params.
+
+
+### Sorting
+You can apply sorting using the `property` and `order` attributes. For instance:
+* `{created_at: 'desc'}`
+
+If there is no column named after the property value, sorting is skipped.
+
+
+### Associations (later)
+~~If the association is a `belongs_to` or `has_one`, then the hash key name must be in singular. If the association is `has_many` the attribute must be in plural reflecting the association type. When you have, in your hash, filters for an association, the sub-hash is passed in the association's model. For instance, let's say a user has many microposts and the following filter is applied (could be through an HTTP GET request on controller's index method):~~
+* `{email: test@user.com, microposts: {created_at { leq: 12-9-2014} }`
+
+
+### Scopes
+If you want to filter based on a scope in a model, the scope names should go under `scopes` sub-hash. For instance the following:
+* `{ scopes: { planned: true } }`
+
+will run the `.planned` scope on the resource.
+
+
+### Whitelisting
+If you don't want to allow a column/association/scope just remove it from the params hash.
+
+#### Filter Classes (later)
+~~Sometimes, especially on larger projects, you have specific classes that handle
+the input params outside the controllers. You can configure the gem to look for
+those classes and call `apply_filters` which will apply the necessary filters when
+iterating over associations.~~
+
+~~In an initializer:~~
+```ruby
+#config/initializers/mongoid_hash_query.rb
+MongoidHashQuery.configure do |config|
+  config.has_filter_classes = true
+  config.filter_class_prefix = 'Api::V1::'
+  config.filter_class_suffix = 'Filter'
+end
+```
+~~With the above settings, when the association name is `resource`,
+`Api::V1::ResourceFilter.new(resource, params[resource]).apply_filters` will be
+called to apply the filters in resource association.~~
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/kollegorna/mongoid_hash_query/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "mongoid_hash_query"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/mongoid_hash_query.rb

@@ -0,0 +1,36 @@
+require 'mongoid_hash_query/version'
+require 'mongoid_hash_query/field_filters'
+require 'mongoid_hash_query/limit_filters'
+require 'mongoid_hash_query/sort_filters'
+require 'mongoid_hash_query/scope_filters'
+require 'mongoid_hash_query/filter_applier'
+
+module MongoidHashQuery
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration
+    yield(configuration)
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new do
+      self.has_filter_classes = false
+    end
+  end
+
+  def apply_filters(resource, params, include_associations: false, model: nil)
+    FilterApplier.new(
+      resource,
+      params,
+      include_associations: include_associations,
+      model: model
+    ).apply_filters
+  end
+
+  class Configuration
+    attr_accessor :has_filter_classes, :filter_class_prefix, :filter_class_suffix
+  end
+end

data/lib/mongoid_hash_query/field_filters.rb

@@ -0,0 +1,78 @@
+module MongoidHashQuery::FieldFilters
+  def filter_primary(resource, field, param)
+    resource = resource.where(id: param)
+  end
+
+  def filter_array(resource, field, param)
+    return resource
+  end
+
+  def filter_big_decimal(resource, field, param)
+    return filter_integer(resource, field, param)
+  end
+
+  def filter_boolean(resource, field, param)
+    return resource.where(field => param)
+  end
+
+  def filter_date(resource, field, param)
+    return filter_time(resource, field, param)
+  end
+
+  def filter_date_time(resource, field, param)
+    return filter_time(resource, field, param)
+  end
+
+  def filter_float(resource, field, param)
+    return filter_integer(resource, field, param)
+  end
+
+  def filter_hash(resource, field, param)
+    param.each do |k, v|
+      resource = resource.where("#{field}.#{k}" => v)
+    end
+
+    return resource
+  end
+
+  def filter_integer(resource, field, param)
+    if !param.is_a? Hash
+      return resource.where(column => param)
+    else
+      return apply_leq_geq_le_ge_filters(resource, field, param)
+    end
+  end
+
+  def filter_string(resource, field, param)
+    return resource.where(field => param)
+  end
+
+  def filter_symbol(resource, field, param)
+    return resource.where(field => param)
+  end
+
+  def filter_time(resource, field, param)
+    if !param.is_a? Hash
+      return resource.where(field => param)
+    else
+      return apply_leq_geq_le_ge_filters(resource, field, param)
+    end
+  end
+
+  private
+    def apply_leq_geq_le_ge_filters(resource, field, param)
+      if param[:lte]
+        resource = resource.where(field.to_sym.lte => param[:lte])
+      elsif param[:lt]
+        resource = resource.where(field.to_sym.lt => param[:lt])
+      end
+
+      if param[:gte]
+        resource = resource.where(field.to_sym.gte => param[:gte])
+      elsif param[:gt]
+        resource = resource.where(field.to_sym.gt => param[:gt])
+      end
+
+      return resource
+    end
+end

data/lib/mongoid_hash_query/filter_applier.rb

@@ -0,0 +1,76 @@
+module MongoidHashQuery
+  class FilterApplier
+    include FieldFilters
+    #include AssociationFilters
+    include ScopeFilters
+    include SortFilters
+    include LimitFilters
+
+    attr_reader :configuration
+
+    def initialize(resource, params, include_associations: true, model: nil)
+      @configuration = Module.nesting.last.configuration
+      @resource = resource
+      @params = HashWithIndifferentAccess.new(params)
+      @include_associations = include_associations
+      @model = model
+    end
+
+    def apply_filters
+      unless @model
+        @model = model_class_name(@resource)
+      end
+      #table_name = @model.table_name
+      @model.fields.each do |k, v|
+        next if @params[v.name.to_s].nil?
+
+        if k.eql?('_id')
+          @resource = filter_primary(@resource, v.name, @params[id])
+          next
+        end
+
+        case v.options[:type].to_s
+        when Array.to_s
+          @resource = filter_array(@resource, v.name, @params[v.name])
+        when BigDecimal.to_s
+          @resource = filter_big_decimal(@resource, v.name, @params[v.name])
+        when Boolean.to_s
+          @resource = filter_boolean(@resource, v.name, @params[v.name])
+        when Date.to_s
+          @resource = filter_date(@resource, v.name, @params[v.name])
+        when DateTime.to_s
+          @resource = filter_date_time(@resource, v.name, @params[v.name])
+        when Float.to_s
+          @resource = filter_float(@resource, v.name, @params[v.name])
+        when Hash.to_s
+          @resource = filter_hash(@resource, v.name, @params[v.name])
+        when Integer.to_s
+          @resource = filter_integer(@resource, v.name, @params[v.name])
+        when String.to_s
+          @resource = filter_string(@resource, v.name, @params[v.name])
+        when Symbol.to_s
+          @resource = filter_symbol(@resource, v.name, @params[v.name])
+        when Time.to_s
+          @resource = filter_time(@resource, v.name, @params[v.name])
+        end
+      end
+
+      @resource = filter_scopes(@resource, @params[:scopes]) if @params.include?(:scopes)
+      @resource = apply_limit(@resource, @params[:limit]) if @params.include?(:limit)
+      @resource = apply_sort(@resource, @params[:sort]) if @params.include?(:sort)
+
+=begin
+      @resource = filter_associations(@resource, @params) if @include_associations
+=end
+
+      return @resource
+    end
+
+    def filter_class(resource_name)
+    end
+
+    def model_class_name(resource)
+      resource.klass
+    end
+  end
+end

data/lib/mongoid_hash_query/limit_filters.rb

@@ -0,0 +1,6 @@
+module MongoidHashQuery::LimitFilters
+  def apply_limit(resource, limit)
+    return resource.limit(limit)
+  end
+end
+

data/lib/mongoid_hash_query/scope_filters.rb

@@ -0,0 +1,12 @@
+module MongoidHashQuery::ScopeFilters
+  def filter_scopes(resource, params)
+    resource.scopes.each do |k, v|
+      if params.include?(k)
+        resource = resource.send(k)
+      end
+    end
+
+    return resource
+  end
+end
+

data/lib/mongoid_hash_query/sort_filters.rb

@@ -0,0 +1,13 @@
+module MongoidHashQuery::SortFilters
+  def apply_sort(resource, params)
+    if !params.is_a? Hash
+      return resource
+    else
+      params.each do |k, v|
+        resource = resource.order_by([k, v || :asc])
+      end
+
+      return resource
+    end
+  end
+end

data/lib/mongoid_hash_query/version.rb

@@ -0,0 +1,3 @@
+module MongoidHashQuery
+  VERSION = "0.2.0"
+end

data/mongoid_hash_query.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mongoid_hash_query/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "mongoid_hash_query"
+  spec.version       = MongoidHashQuery::VERSION
+  spec.authors       = ["Filippos Vasilakis"]
+  spec.email         = ["vasilakisfil@gmail.com"]
+
+  spec.summary       = %q{Simple gem that allows you to run any Mongoid query using a hash API. Perfect for RESTful APIs}
+  spec.description   = %q{Simple gem that allows you to run any Mongoid query using a hash API. Perfect for RESTful APIs}
+  spec.homepage      = "https://github.com/kollegorna/mongoid_hash_query"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mongoid_hash_query
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Filippos Vasilakis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Simple gem that allows you to run any Mongoid query using a hash API.
+  Perfect for RESTful APIs
+email:
+- vasilakisfil@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mongoid_hash_query.rb
+- lib/mongoid_hash_query/field_filters.rb
+- lib/mongoid_hash_query/filter_applier.rb
+- lib/mongoid_hash_query/limit_filters.rb
+- lib/mongoid_hash_query/scope_filters.rb
+- lib/mongoid_hash_query/sort_filters.rb
+- lib/mongoid_hash_query/version.rb
+- mongoid_hash_query.gemspec
+homepage: https://github.com/kollegorna/mongoid_hash_query
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: Simple gem that allows you to run any Mongoid query using a hash API. Perfect
+  for RESTful APIs
+test_files: []