jsonapi-resources-coercion 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0945755a685519dc0642fd5224f162a2fd332ec
+  data.tar.gz: 92973acbbb6e6845731b096a69e1c5eb48788edf
+SHA512:
+  metadata.gz: 49fb0a68d6e98449b2137310ad4d60ef5127b38730a72a6db739d38ac8287ddfb2fa60b51d10ae079a811e77c7a6fcd842346d7cb18487d9aca8f763222bce47
+  data.tar.gz: 89f8d56afd3e7d22f2f8b0f96328c713add1685d0db430a2e1ca62e2fa99ad79bea1df1674f8495ac0061746370e2888202d64f982b683d99193428c7db6fa16

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.idea
+.ruby-version

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.1.2
+  - 2.2.2
+  - 2.3.0
+gemfile:
+  - gemfiles/jr0.6.gemfile
+  - gemfiles/jr0.7.gemfile
+  - gemfiles/jr0.8.gemfile
+  - Gemfile
+before_install: gem install bundler -v 1.13.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at gigorok@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-resources-coercion.gemspec
+gemspec
+
+gem 'jsonapi-resources'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Igor Gonchar
+
+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,72 @@
+# JSONAPI::Resources::Coercion
+
+[![Build Status](https://travis-ci.org/gigorok/jsonapi-resources-coercion.svg?branch=master)](https://travis-ci.org/gigorok/jsonapi-resources-coercion)
+
+The gem adds type coercion to filters in [jsonapi-resources](https://github.com/cerebris/jsonapi-resources).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jsonapi-resources-coercion'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jsonapi-resources-coercion
+
+## Usage
+
+To use filter's type coercions you should specify the `type` option with one of predefined types.
+Supports next predefined types: integer, string, boolean, float, decimal, date_time, time, date.
+
+```ruby
+class BookResource < JSONAPI::Resource
+  filter :title, type: :string
+  filter :qty, type: :integer
+  filter :available, type: :boolean
+  filter :weight, type: :float
+  filter :price, type: :decimal
+  filter :published_at, type: :date_time
+end
+```
+
+You can define your own type coercion. Just define singleton class method.
+Example:
+```ruby
+class ReaderResource < JSONAPI::Resource
+  filter :book, type: :book, apply: ->(records, books, _options) do
+                               # books will be an array of instance of Book
+                               records.where(book_ids: books.map(&:id))
+                             end
+  
+  def self.coerce_as_book!(val)
+    Book.find_by!(title: val)
+  rescue ActiveRecord::RecordNotFound
+    raise CoercionError
+  end
+end
+```
+
+If a filter cannot be coerced then bad request will be performed. 
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gigorok/jsonapi-resources-coercion. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require 'rails/all'
+require 'jsonapi-resources'
+require "jsonapi/resources/coercion"
+
+require "irb"
+IRB.start

data/bin/setup

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

data/gemfiles/jr0.6.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-resources-coercion.gemspec
+gemspec path: '../'
+
+gem 'jsonapi-resources', '~> 0.6.0'

data/gemfiles/jr0.7.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-resources-coercion.gemspec
+gemspec path: '../'
+
+gem 'jsonapi-resources', '~> 0.7.0'

data/gemfiles/jr0.8.gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in jsonapi-resources-coercion.gemspec
+gemspec path: '../'
+
+gem 'jsonapi-resources', '~> 0.8.0'

data/jsonapi-resources-coercion.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi/resources/coercion/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jsonapi-resources-coercion'
+  spec.version       = JSONAPI::Resources::Coercion::VERSION
+  spec.authors       = ['Igor Gonchar']
+  spec.email         = ['igor.g@didww.com']
+
+  spec.summary       = 'Easily filters type coercion in jsonapi-resources.'
+  spec.homepage      = 'https://github.com/gigorok/jsonapi-resources-coercion'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activerecord', '~> 4.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.13'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+end

data/lib/jsonapi/resources/coercion.rb

@@ -0,0 +1,116 @@
+require "jsonapi/resources/coercion/version"
+
+module JSONAPI
+  module Resources
+    module Coercion
+
+      class CoercionError < RuntimeError
+      end
+
+      def self.prepended(base)
+        class << base
+          prepend(ClassMethods)
+        end
+      end
+
+      module ClassMethods
+
+        DEFAULT_PRECISION = 14
+
+        def verify_filter(filter, raw, context = nil)
+          verified_filter = super
+          filter_type = _allowed_filters.fetch(filter, Hash.new)[:type]
+          filter_name = verified_filter[0]
+          if filter_type
+            wrapped_filters = if verified_filter[1].empty? # nil or empty array
+                                [nil]
+                              else
+                                Array.wrap(verified_filter[1])
+                              end
+            coerced_values = wrapped_filters.map do |val|
+              begin
+                if val.blank? # nil or empty string
+                  # if _allowed_filters.fetch(filter, Hash.new).fetch(:allow_nil, true)
+                  #   nil
+                  # else
+                  #   raise CoercionError
+                  # end
+                  nil
+                else
+                  coerce(val, filter_type)
+                end
+              rescue CoercionError => _e
+                raise JSONAPI::Exceptions::InvalidFilterValue.new(filter_name, val)
+              end
+            end
+            [filter_name, coerced_values]
+          else
+            verified_filter
+          end
+        end
+
+        def coerce_as_integer!(val)
+          Integer(val)
+        rescue ArgumentError
+          raise CoercionError
+        end
+
+        def coerce_as_string!(val)
+          String(val)
+        rescue ArgumentError
+          raise CoercionError
+        end
+
+        def coerce_as_float!(val)
+          Float(val)
+        rescue ArgumentError
+          raise CoercionError
+        end
+
+        def coerce_as_boolean!(val)
+          (/^(false|f|no|n|0)$/i === val.to_s ? false : (/^(true|t|yes|y|1)$/i === val.to_s ? true : (raise CoercionError)))
+        end
+
+        def coerce_as_big_decimal!(val)
+          raise CoercionError unless val.to_s.strip =~ /[0-9.]+/
+          BigDecimal.new(val.to_s.strip, DEFAULT_PRECISION)
+        end
+
+        alias_method :coerce_as_decimal!, :coerce_as_big_decimal!
+
+        def coerce_as_date!(val)
+          Date.parse(val)
+        rescue ArgumentError
+          raise CoercionError
+        end
+
+        def coerce_as_date_time!(val)
+          DateTime.parse(val)
+        rescue ArgumentError
+          raise CoercionError
+        end
+
+        alias_method :coerce_as_datetime!, :coerce_as_date_time!
+
+        def coerce_as_time!(val)
+          Time.parse(val)
+        rescue ArgumentError
+          raise CoercionError
+        end
+
+        private
+
+        def coerce(val, type)
+          coerce_method = "coerce_as_#{type}!"
+          if self.respond_to?(coerce_method.to_sym)
+            send(coerce_method, val)
+          else
+            raise CoercionError
+          end
+        end
+      end
+    end
+  end
+end
+
+JSONAPI::Resource.prepend JSONAPI::Resources::Coercion

data/lib/jsonapi/resources/coercion/version.rb

@@ -0,0 +1,7 @@
+module JSONAPI
+  module Resources
+    module Coercion
+      VERSION = "0.1.0"
+    end
+  end
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi-resources-coercion
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Igor Gonchar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- igor.g@didww.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
+- gemfiles/jr0.6.gemfile
+- gemfiles/jr0.7.gemfile
+- gemfiles/jr0.8.gemfile
+- jsonapi-resources-coercion.gemspec
+- lib/jsonapi/resources/coercion.rb
+- lib/jsonapi/resources/coercion/version.rb
+homepage: https://github.com/gigorok/jsonapi-resources-coercion
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Easily filters type coercion in jsonapi-resources.
+test_files: []