params_converter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ea344296fffc48efd4fac249271e62acf4fe99b5
+  data.tar.gz: a1515e29ca6da4e20e37318eb5041303ce063fac
+SHA512:
+  metadata.gz: de44d9ad188fd5bac727bbeecab198124bcfe43c21b10876829d110a097694e59815bdd0add0d4c776b3915f8205b0a8c94927c807ec9dc25634f716d2bd510c
+  data.tar.gz: 0c5c5017a1cb92a6cd0377904fca6590bd390bf9b2c742842a622503662d28b7284dd349d35eab3da76314bbd1ce83f508e05037f4ef80b218c2f47fe8e5f747

data/.cimon.yml

@@ -0,0 +1,39 @@
+services:
+  ruby21:
+    from: ruby:2.1.8
+    cache:
+      - /bundle
+    build:
+      - gem install bundler
+  ruby22:
+    from: ruby:2.2.4
+    cache:
+      - /bundle
+    build:
+      - gem install bundler
+  ruby23:
+    from: ruby:2.3.0
+    cache:
+      - /bundle
+    build:
+      - gem install bundler
+
+default: &default
+  prepare:
+    - bundle install --path /bundle
+  folder: /app
+  cmd: bin/rake
+  env:
+    - COVERAGE=true
+
+test21:
+  <<: *default
+  service: ruby21
+
+test22:
+  <<: *default
+  service: ruby22
+
+test23:
+  <<: *default
+  service: ruby23

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, 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, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alexey@osipenko.in.ua. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,35 @@
+PATH
+  remote: .
+  specs:
+    params_converter (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rake (10.5.0)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.11)
+  params_converter!
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,73 @@
+# ParamsConverter
+
+Advanced version of `assert_valid_keys` method. This gem allow to check keys which must be present and can be present. Also it symbolize keys. There are no dependencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'params_converter'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install params_converter
+
+## Usage
+
+This is function without side effects and it's not modify existing hash, but returns new one. The signature of `convert!` method the following:
+
+```ruby
+ParamsConverter.convert!(hash, required_keys, allowed_keys)
+```
+
+There are a few examples:
+
+```ruby
+ParamsConverter.convert!({ a: 1, b: 2, 'c' => 3, d: 4 }, [:a, 'b'], ['c', :d])
+# { a: 1, b: 2, c: 3, d: 4 }
+
+ParamsConverter.convert!({ a: 1, b: 2 }, [:c], [:b])
+# raises ParamsConverter::MissingRequiredError
+
+ParamsConverter.convert!({ a: 1, b: 2 }, [:a], [:d])
+# raises ParamsConverter::MissingRequiredError
+```
+
+`nil` instead of second or third parameter is valid value. It means that it allows any required/allowed keys:
+
+```ruby
+ParamsConverter.convert!({ a: 1, 'b' => 2 }, nil, nil)
+# { a: 1, b: 2 }
+```
+
+Empty array instead of required keys means that any key is invalid. Empty array instead of allowed keys means that there are no keys should be present except required keys:
+
+```ruby
+ParamsConverter.convert!({ a: 1, 'b' => 2, c: 3 }, [:a, :b, :c], [])
+# { a: 1, b: 2, c: 3 }
+
+ParamsConverter.convert!({ a: 1, 'b' => 2, c: 3, d: 4 }, [:a, :b, :c], [])
+# raises ParamsConverter::NotAllowedError
+
+ParamsConverter.convert!({ a: 1, 'b' => 2, c: 3, d: 4 }, [], nil)
+# raises ParamsConverter::NotAllowedError
+
+```
+
+It should support all versions of ruby, but only ruby 2.1+ is guaranteed.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/[USERNAME]/params_converter. 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.

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "params_converter"
+
+# 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/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

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/lib/params_converter.rb

@@ -0,0 +1,46 @@
+require "params_converter/version"
+
+module ParamsConverter
+
+  class ParamsConverterError < ::StandardError
+    def initialize(msg = nil)
+      msg = msg.is_a?(Array) ? msg.join(',') : msg.to_s
+      super("#{message_prefix} #{msg}")
+    end
+  end
+
+  class NotAllowedError < ParamsConverterError
+    def message_prefix
+      "Not allowed keys"
+    end
+  end
+
+  class MissingRequiredError < ParamsConverterError
+    def message_prefix
+      "Missing keys"
+    end
+  end
+
+  def convert!(params, re=nil, pe=nil)
+    raise ArgumentError unless re.nil? or re.is_a?(Array)
+    raise ArgumentError unless pe.nil? or pe.is_a?(Array)
+    raise ArgumentError unless params.is_a?(Hash)
+
+    params = Hash[params.map { |k,v| [k.to_s.to_sym, v] }]
+
+    unless re.nil?
+      re = re.map(&:to_s).map(&:to_sym).uniq
+      missing_keys = re.reject { |r| !!params.fetch(r, false) }
+      raise MissingRequiredError.new(missing_keys) if missing_keys.count > 0
+    end
+
+    pe = params.keys if pe.nil?
+    pe = ((re || []) | pe).map(&:to_s).map(&:to_sym).uniq
+    not_allowed_keys = params.keys - pe
+    raise NotAllowedError.new(not_allowed_keys) if not_allowed_keys.count > 0
+
+    params
+  end
+  module_function :convert!
+
+end

data/lib/params_converter/version.rb

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

data/params_converter.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'params_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "params_converter"
+  spec.version       = ParamsConverter::VERSION
+  spec.authors       = ["Alexey Osipenko"]
+  spec.email         = ["alexey@osipenko.in.ua"]
+
+  spec.summary       = %q{Rich version of assert_valid_keys method}
+  spec.description   = %q{Rich version of assert_valid_keys method}
+  spec.homepage      = "https://github.com/cimon-io/params_converter"
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: params_converter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alexey Osipenko
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-03-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rich version of assert_valid_keys method
+email:
+- alexey@osipenko.in.ua
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".cimon.yml"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- lib/params_converter.rb
+- lib/params_converter/version.rb
+- params_converter.gemspec
+homepage: https://github.com/cimon-io/params_converter
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Rich version of assert_valid_keys method
+test_files: []
+has_rdoc: