iknow_params 2.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 72ed5066cf3acd50bc02597d9731adb68cc5f13c1c672a74ed0e73d38e30721a
+  data.tar.gz: d818d2b61fa52eaafe28522c50cf4d2ff39c1c97048a58e8f3d9ae1c4e4d5212
+SHA512:
+  metadata.gz: 0540c5cdb77e348a212628f197003885ece7296ca4a2bcab9d98c29c8d7719ed893178fa6ff7126dba2150881419c7c5282579856f9b7cd19ab64b0baff46d80
+  data.tar.gz: 4ff81fb705909a6a793b5ac1f436ff4a4cfc97acb00aab9767725e73c7cec1bbf0f91fe1be31d462fe4cd9124617cee9b10f135f007310cfc062bb65ef94aed3

data/.circleci/config.yml

@@ -0,0 +1,103 @@
+version: 2.1
+
+executors:
+  ruby:
+    parameters:
+      ruby-version:
+        type: string
+        default: "2.6"
+      gemfile:
+        type: string
+        default: "Gemfile"
+    docker:
+      - image: circleci/ruby:<< parameters.ruby-version >>
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+          RAILS_ENV: test
+          BUNDLE_GEMFILE: << parameters.gemfile >>
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+      gemfile:
+        type: string
+    executor:
+      name: ruby
+      ruby-version: << parameters.ruby-version >>
+      gemfile: << parameters.gemfile >>
+    parallelism: 1
+    steps:
+      - checkout
+
+      - run:
+          # Remove the non-appraisal gemfile for safety: we never want to use it.
+          name: Prepare bundler
+          command: bundle -v
+
+      - run:
+          name: Compute a gemfile lock
+          command: bundle lock && cp "${BUNDLE_GEMFILE}.lock" /tmp/gem-lock
+
+      - restore_cache:
+          keys:
+            - iknow_params-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+            - iknow_params-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      - save_cache:
+          key: iknow_params-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
+
+      - store_test_results:
+          path: test_results
+
+  publish:
+    executor: ruby
+    steps:
+       - checkout
+       - run:
+           name: Setup Rubygems
+           command: |
+             mkdir ~/.gem &&
+             echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials &&
+             chmod 0600 ~/.gem/credentials
+       - run:
+           name: Publish to Rubygems
+           command: |
+             gem build iknow_params.gemspec
+             gem push iknow_params-*.gem
+
+workflows:
+  version: 2.1
+  build:
+    jobs:
+      - test:
+          name: 'ruby 2.5 ActiveSupport 5.2'
+          ruby-version: "2.5"
+          gemfile: gemfiles/activesupport_5_2.gemfile
+      - test:
+          name: 'ruby 2.6 ActiveSupport 5.2'
+          ruby-version: "2.6"
+          gemfile: gemfiles/activesupport_5_2.gemfile
+      - test:
+          name: 'ruby 2.6 ActiveSupport 6.0-beta'
+          ruby-version: "2.6"
+          gemfile: gemfiles/activesupport_6_0_beta.gemfile
+      - publish:
+          filters:
+            branches:
+              only: master
+            tags:
+              ignore: /.*/

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.byebug_history
+gemfiles/*.gemfile.lock

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,8 @@
+dist: trusty
+language: ruby
+rvm:
+  - 2.4
+gemfile:
+  - gemfiles/activesupport_5_2.gemfile
+notifications:
+  email: false

data/Appraisals

@@ -0,0 +1,7 @@
+appraise "activesupport-5-2" do
+  gem "activesupport", "~> 5.2.0"
+end
+
+appraise 'activesupport-6-0-beta' do
+  gem 'activesupport', '~> 6.0.0.beta'
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 DMM.com
+
+MIT License
+
+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,31 @@
+# IknowParams
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'iknow_params'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install iknow_params
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/iknow_params/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,8 @@
+require "bundler/gem_tasks"
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+  task :default => :spec
+rescue LoadError
+  puts "rspec unavailable"
+end

data/gemfiles/activesupport_5_2.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec_junit_formatter"
+gem "activesupport", "~> 5.2.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_6_0_beta.gemfile

@@ -0,0 +1,8 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec_junit_formatter"
+gem "activesupport", "~> 6.0.0.beta"
+
+gemspec path: "../"

data/iknow_params.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'iknow_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "iknow_params"
+  spec.version       = IknowParams::VERSION
+  spec.authors       = ["dev@iknow.jp"]
+  spec.email         = [""]
+  spec.summary       = %q{Rails parameter parser for iKnow.}
+  spec.description   = %q{}
+  spec.homepage      = "http://github.com/iknow/iknow_params"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "actionpack", "> 5.0"
+  spec.add_development_dependency "rails", "> 5.0"
+
+  spec.add_development_dependency "byebug"
+  spec.add_development_dependency "appraisal"
+
+  spec.add_dependency "activesupport", "> 5.0"
+  spec.add_dependency "tzinfo"
+  spec.add_dependency "json-schema", "~> 2.8.0"
+end

data/lib/iknow_params.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module IknowParams
+  require "iknow_params/version"
+  require "iknow_params/parser"
+  require "iknow_params/serializer"
+end

data/lib/iknow_params/parser.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/inflector"
+require "active_support/core_ext/object/blank"
+
+# IknowParams::Parser provides a mix-in for ActiveRecord controllers to parse input parameters.
+module IknowParams::Parser
+  require "iknow_params/parser/hash_parser"
+
+  extend ActiveSupport::Concern
+
+  class ParseError < RuntimeError
+    attr_accessor :param, :value
+
+    def initialize(message, param, value)
+      super(message)
+      self.param = param
+      self.value = value
+    end
+  end
+
+  PARAM_REQUIRED = Object.new
+  BLANK = Object.new
+
+  class << self
+    def parse_hash(hash, &block)
+      HashParser.new(hash).parse(&block)
+    end
+
+    def parse_value(value, **args)
+      HashParser.new({ sentinel: value }).parse_param(:sentinel, **args)
+    end
+
+    def parse_values(values, **args)
+      HashParser.new({ sentinel: values }).parse_array_param(:sentinel, **args)
+    end
+  end
+
+  # Parse the specified parameter, optionally deserializing with the provided
+  # IKnowParams::Serializer. If the parameter is missing and no default is
+  # provided, raises a ParseError.
+  #
+  # If `BLANK` is provided as a default, return a placeholder object that can be
+  # later stripped out with `remove_blanks`
+  #
+  # If `dump` is true, use the serializer to re-serialize any successfully
+  # parsed argument back to a canonical string. This can be useful to validate
+  # and normalize the input to another service without parsing it. A serializer
+  # must be passed to use this option.
+  def parse_param(param, with: nil, default: PARAM_REQUIRED, dump: false)
+    serializer =
+      case with
+      when String, Symbol
+        IknowParams::Serializer.for!(with)
+      else
+        with
+      end
+
+    parse =
+      if !params.has_key?(param)
+        raise ParseError.new("Required parameter '#{param}' missing", param, nil) if default == PARAM_REQUIRED
+        default
+      else
+        val = params[param]
+        if serializer.present?
+          begin
+            serializer.load(val)
+          rescue IknowParams::Serializer::LoadError => ex
+            raise ParseError.new("Invalid parameter '#{param}': '#{val.inspect}' - #{ex.message}", param, val)
+          end
+        else
+          val
+        end
+      end
+
+    if dump && parse != BLANK
+      begin
+        parse = serializer.dump(parse)
+      rescue NoMethodError => ex
+        raise ParseError.new("Serializer '#{serializer}' can't dump param '#{param}' #{val.inspect} - #{ex.message}", param, val)
+      end
+    end
+
+    parse
+  end
+
+  # Parse an array-typed param using the provided serializer for each member element.
+  def parse_array_param(param, with: nil, default: PARAM_REQUIRED, dump: false)
+    serializer =
+      case with
+      when String, Symbol
+        IknowParams::Serializer.for!(with)
+      else
+        with
+      end
+
+    vals = params[param]
+
+    parses =
+      if vals.nil?
+        raise ParseError.new("Required parameter '#{param}' missing", param, nil) if default == PARAM_REQUIRED
+        default
+      elsif !vals.is_a?(Array)
+        raise ParseError.new("Invalid type for parameter '#{param}': '#{vals.class.name}'", param, vals)
+      elsif serializer.present?
+        vals.map do |val|
+          begin
+            serializer.load(val)
+          rescue IknowParams::Serializer::LoadError => ex
+            raise ParseError.new("Invalid member in array parameter '#{param}': '#{val.inspect}' - #{ex.message}", param, val)
+          end
+        end
+      else
+        vals
+      end
+
+    if dump && parses != BLANK
+      parses.map! { |v| serializer.dump(v) }
+    end
+
+    parses
+  end
+
+  # Convenience method to make it simpler to build a hash structure with
+  # optional members from parsed data. This method recursively traverses the
+  # provided structure and removes any instances of the sentinel value
+  # Parser::BLANK.
+  def remove_blanks(arg)
+    case arg
+    when Hash
+      arg.each do |k, v|
+        if v == BLANK
+          arg.delete(k)
+        else
+          remove_blanks(v)
+        end
+      end
+    when Array
+      arg.delete(BLANK)
+      arg.each { |e| remove_blanks(e) }
+    end
+  end
+
+  # Allow serializers to register themselves
+  def self.register_serializer(name, serializer)
+    define_method(:"parse_#{name.underscore}_param") do |param, default: PARAM_REQUIRED|
+      parse_param(param, with: serializer, default: default)
+    end
+    define_method(:"parse_#{name.underscore}_array_param") do |param, default: PARAM_REQUIRED|
+      parse_array_param(param, with: serializer, default: default)
+    end
+  end
+end