param_check 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 229dac1713acddecb143dbe935c1ed71b64e81a2
+  data.tar.gz: cb1df9cbe44a477b03e54ee31ebb1893911fa7d7
+SHA512:
+  metadata.gz: f77219d9cceb435d165ec969900d6f95d9ffc9d079031b8ab400f2d25b9841377aac23a0793fae2504ba9a920c756d144b40b83d940c4f7d7d6ad02db26db275
+  data.tar.gz: 2fcd88053f1fa18b55e4d0901409b7c16b0a4c0e3347ae1024a33703fb8e8272f197dd2af3e8f072501d5c43adbbade2ee0f1ae735068751c7607148922d381c

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/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 doddsey65@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,2 @@
+source 'https://rubygems.org'
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 cjmarkham
+
+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,102 @@
+# ParamCheck
+
+[![CircleCI](https://circleci.com/gh/cjmarkham/param_check.svg?style=svg&circle-token=ff228fe4c2537fd6baf7b4370d813aee2fc5cb88)](https://circleci.com/gh/cjmarkham/param_check)
+[![codecov](https://codecov.io/gh/cjmarkham/param_check/branch/master/graph/badge.svg?token=VPkZR1Im62)](https://codecov.io/gh/cjmarkham/param_check)
+
+
+Easily validate params for API methods.
+Are you sick of writing `respond_with(error) unless params[:foo].present?`? With ParamCheck, you can abstract
+all of the validation.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'param_check'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### Validating presence
+By default, a parameter is not required unless you specify the `required: true` option
+
+```ruby
+def index
+  param! :foo, required: true
+end
+```
+
+```ruby
+def index
+  param! :foo, required: true do |foo| # params[foo]
+    foo.param! :bar, required: true # params[foo][bar]
+  end
+end
+```
+
+### Validating type
+```ruby
+def index
+  param! :foo, type: String
+end
+```
+
+```ruby
+def index
+  param! :foo, type: ActionController::Parameters do |foo|
+    foo.param! :bar, type: Integer
+    foo.param! :baz, type: String
+  end
+end
+
+# Passes
+params[:foo] = {
+  bar: 1,
+  baz: 'Two',
+}
+
+# Fails
+params[:foo] = {
+  bar: 'One',
+  baz: 2,
+}
+params[:foo] = 'bar'
+```
+
+By default, ParamCheck throws a `ParameterError` exception. You can rescue from this exception in order to
+respond with JSON for example:
+
+```ruby
+# in API::ApplicationController
+rescue_from ParameterError do |e|
+  render json: { error: e.message }
+end
+```
+
+## Options
+| Option   | Type    | Default | Values                                         | Description                                |
+| -------- | ------- | ------- | ---------------------------------------------- | ------------------------------------------ |
+| required | Boolean | false   | true/false                                     | Is the parameter required?                 |
+| type     | Class   | nil     | Fixnum/Integer/String/ActionController::Params | Specifies the type the parameter should be |
+
+
+## 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/cjmarkham/param_check. 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,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "param_check"
+
+# 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,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/codecov.yml

@@ -0,0 +1,15 @@
+coverage:
+  ignore:
+  - bin/.*
+  - config/.*
+  status:
+    patch:
+      default:
+        target: 100
+    changes:
+      default:
+        branches:
+        - master
+    project:
+      default:
+        target: auto

data/config/locales/en.yml

@@ -0,0 +1,4 @@
+en:
+  param_check:
+    missing_required_parameter: "Missing required parameter: %{parameter}"
+    invalid_parameter: "Parameter %{parameter} is invalid. Expected %{expected} got %{got}"

data/lib/param_check/engine.rb

@@ -0,0 +1,6 @@
+require 'rails'
+
+module ParamCheck
+  class Engine < ::Rails::Engine
+  end
+end

data/lib/param_check/version.rb

@@ -0,0 +1,3 @@
+module ParamCheck
+  VERSION = "0.1.0"
+end

data/lib/param_check.rb

@@ -0,0 +1,70 @@
+require "param_check/version"
+require 'param_check/engine'
+
+module ParamCheck
+  extend self
+
+  class ParameterError < StandardError; end
+
+  class MockController
+    include ParamCheck
+    attr_accessor :params
+  end
+
+  def param! name, options, &block
+    validate! name, params.try(:[], name), options
+
+    if block_given?
+      recurse params[name], &block
+    end
+  end
+
+  private
+
+  def recurse params, index = nil
+    controller = MockController.new
+    controller.params = params
+
+    yield controller, index
+  end
+
+  def validate! name, param, options
+    if options[:required]
+      validate_presence name, param
+    end
+
+    validate_type name, param, options[:type]
+  end
+
+  def validate_presence name, param
+    if param.nil?
+      raise ParameterError, I18n.t(
+        'param_check.missing_required_parameter',
+        parameter: name,
+      )
+    end
+  end
+
+  def validate_type name, param, type
+    return if param.nil?
+
+    if type.in?([Integer, Fixnum])
+      is_numeric = Float(param) rescue nil
+      if ! is_numeric
+        raise ParameterError, I18n.t(
+          'param_check.invalid_parameter',
+          parameter: name,
+          expected: type,
+          got: param.class.name
+        )
+      end
+    elsif ! param.is_a? type
+      raise ParameterError, I18n.t(
+        'param_check.invalid_parameter',
+        parameter: name,
+        expected: type,
+        got: param.class.name
+      )
+    end
+  end
+end

data/param_check.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'param_check/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "param_check"
+  spec.version       = ParamCheck::VERSION
+  spec.authors       = ["cjmarkham"]
+  spec.email         = ["doddsey65@gmail.com"]
+
+  spec.summary       = %q{Validate parameters for Rails API methods}
+  spec.description   = %q{Validate parameters presence and type for Rails API methods}
+  spec.homepage      = "https://cjmarkham.co.uk"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "rails", "~> 5.0.0.1"
+  spec.add_development_dependency "bundler", "~> 1.13"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: param_check
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- cjmarkham
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0.1
+- !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: Validate parameters presence and type for Rails API methods
+email:
+- doddsey65@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- codecov.yml
+- config/locales/en.yml
+- lib/param_check.rb
+- lib/param_check/engine.rb
+- lib/param_check/version.rb
+- param_check.gemspec
+homepage: https://cjmarkham.co.uk
+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.1
+signing_key: 
+specification_version: 4
+summary: Validate parameters for Rails API methods
+test_files: []