sinatra-my-params 0.0.1 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 03d95a0948071a629809d0733d17cf36ff552f451594de835cdda64670b9d32c
-  data.tar.gz: 4d80191893aeb6a86f6bbe269fa2be607f2a0c2807e0a125fd1e9d3090ab293d
+  metadata.gz: 747bacbce6ab90027f92e29c45475964414cda4f62ad362339f1fd515323fcf3
+  data.tar.gz: 2c0d6582d40e18230e5d97e29ddff20484d86163366bc23e7aa24e67c255d9a6
 SHA512:
-  metadata.gz: bd1456d10b45d4238ac698aff9247e869e6a0a7ec01ac7e6d544b3d5f0f3449f1a3cd511167e358e98cab476383fba69c5cfbe0ef92093448ed2b61102b76dd4
-  data.tar.gz: 8c576e0f4ae287df3a148a913ce62cc155269be7bb9b54db57138edb29b325f770e1248b1ad6dcb4ecce2fa43068e49812814b597493405bbf44c6dac85c109d
+  metadata.gz: b2b7b1e994250fce4fbabe3cf9571b62dc6432c7965d81897b54889a1be64198fb0dff9ba1ab83e91462985ee7644a5a3b00188b600b1d7fa4431d72e0ee99d6
+  data.tar.gz: e502b5deafbeb12839eb772b3be83720160ac8f1c99950fa527dcdef9da2e04df7aa55ffee1a32c6e037fa9931e3ec3f28e2e3470e545781e9855245b5db3d5d

data/Rakefile

@@ -1,8 +1,13 @@
-require 'rake/testtask'
+require "rake/testtask"
+require "rspec/core/rake_task"
 
 Rake::TestTask.new do |t|
-  t.libs << 'test'
+  t.libs << "test"
 end
 
-desc "Run tests"
-task :default => :test
+begin
+  RSpec::Core::RakeTask.new(:spec)
+
+  task :default => :spec
+rescue LoadError
+end

data/bin/permit_params

@@ -1,3 +1,3 @@
 #!/usr/bin/env ruby
 
-require 'permit_params'
+require "permit_params"

data/lib/permit_params.rb

@@ -1,13 +1,27 @@
 module PermitParams
-  def permitted_params(params, permitted)
-    params.select do |k,v| 
-      permitted.keys.map(&:to_s).include?(k.to_s) && !v.nil? && coerce(v, permitted[k.to_sym])
+  class InvalidParameterError < StandardError
+    attr_accessor :param, :options
+  end
+
+  def permitted_params(params, permitted = {}, strong_validation = false)
+    return params if permitted.empty?
+  
+    coerced_params = Hash.new({})
+
+    params.each do |key, value|
+      if permitted.keys.map(&:to_s).include?(key.to_s) && !value.nil?
+        coerced = coerce(value, permitted[key.to_sym], strong_validation)
+        coerced_params[key] = coerced if !coerced.nil?
+      end
     end
+    coerced_params
   end
 
   private
 
-  def coerce(param, type, strong = false, options = {})
+  Boolean = :boolean
+
+  def coerce(param, type, strong_validation = false, options = {})
     begin
       return nil if param.nil?
       return param if (param.is_a?(type) rescue false)
@@ -17,19 +31,27 @@ module PermitParams
       return Date.parse(param) if type == Date
       return Time.parse(param) if type == Time
       return DateTime.parse(param) if type == DateTime
-      return Array(param.split(options[:delimiter] || ",")) if type == Array
-      return Hash[param.split(options[:delimiter] || ",").map{|c| c.split(options[:separator] || ":")}] if type == Hash
-      if [TrueClass, FalseClass, Boolean].include? type
-        coerced = /^(false|f|no|n|0)$/i === param.to_s ? false : /^(true|t|yes|y|1)$/i === param.to_s ? true : nil
-        raise ArgumentError if coerced.nil?
-        return coerced
-      end
+      return coerce_array(param) if type == Array
+      return coerce_hash(param) if type == Hash
+      return coerce_boolean(param) if [TrueClass, FalseClass, Boolean].include? type
       return nil
     rescue ArgumentError
-      if strong
-        raise InvalidParameterError, "'#{param}' is not a valid #{type}"
-      end
+      raise InvalidParameterError, "'#{param}' is not a valid #{type}" if strong_validation
     end
   end
+
+  def coerce_array(param)
+    Array(param.split(options[:delimiter] || ","))
+  end
+
+  def coerce_hash(param)
+    Hash[param.split(options[:delimiter] || ",").map{|c| c.split(options[:separator] || ":")}]
+  end
+
+  def coerce_boolean(param)
+    coerced = /^(false|f|no|n|0)$/i === param.to_s ? false : /^(true|t|yes|y|1)$/i === param.to_s ? true : nil
+    raise ArgumentError if coerced.nil?
+    coerced
+  end
 end
 

data/spec/permit_params_spec.rb

@@ -0,0 +1,105 @@
+require "test/unit"
+require "permit_params"
+require "rspec"
+require "rack/test"
+
+include PermitParams
+
+describe "exceptions" do
+  it "should raise error when at least one param is invalid" do
+    input = { param_1: "a" }
+    expect{
+      permitted_params(input, { param_1: Integer }, true)
+    }.to raise_error(InvalidParameterError, "'a' is not a valid Integer") 
+  end
+
+  it "should return a string when a pemitted is string" do
+    input = { param_1: "a string" }
+    expect(input).to eq permitted_params(input, { param_1: String })
+  end
+
+  it "should return a float when a pemitted is float" do
+    input = { param_1: 10.0 }
+    expect(input).to eq permitted_params(input, { param_1: Float })
+  end
+
+  it "should return a date when a pemitted is date" do
+    input = { param_1: Date.new }
+    expect(input).to eq permitted_params(input, { param_1: Date })
+  end
+
+  it "should return a time when a pemitted is time" do
+    input = { param_1: Time.new }
+    expect(input).to eq permitted_params(input, { param_1: Time })
+  end
+
+  it "should return an integer when a pemitted is integer" do
+    input = { param_1: 1 }
+    expect(input).to eq permitted_params(input, { param_1: Integer })
+  end
+
+  it "should return an integer when a pemitted can be cast into integer" do
+    input = { param_1: "1" }
+    output = { param_1: 1 }
+    expect(output).to eq permitted_params(input, { param_1: Integer })
+  end
+
+  it "should return a false(boolean) when a pemitted is boolean" do
+    input = { param_1: "false" }
+    output = { param_1: false }
+    expect(output).to eq permitted_params(input, { param_1: Boolean })
+  end
+
+  it "should return a true(boolean) when a pemitted is boolean" do
+    input = { param_1: "true" }
+    output = { param_1: true }
+    expect(output).to eq permitted_params(input, { param_1: Boolean })
+  end
+
+  it "should return an array when a pemitted is array" do
+    input = { param_1: [1,2] }
+    expect(input).to eq permitted_params(input, { param_1: Array })
+  end
+
+  it "should return a hash when a pemitted is hash" do
+    input = { param_1: { a: 1 } }
+    expect(input).to eq permitted_params(input, { param_1: Hash })
+  end
+
+  it "should return a hash when a pemitted is hash" do
+    input = { param_1: { :a => 1 } }
+    expect(input).to eq permitted_params(input, { param_1: Hash })
+  end
+
+  it "should return a hash when a pemitted is hash" do
+    input = { param_1: { "a": 1 } }
+    expect(input).to eq permitted_params(input, { param_1: Hash })
+  end
+
+  it "should return a several types for several inputs" do
+    input = { number: 1, string: "string", bol: "true", array: [1,2], hsh: {a: 3}  }
+    output = { number: 1, string: "string", bol: true, array: [1,2], hsh: {a: 3}  }
+    expect(output).to eq permitted_params(
+      input, 
+      { 
+        number: Integer,
+        string: String,
+        bol: Boolean,
+        array: Array,
+        hsh: Hash
+      }
+    )
+  end
+
+  it "should remove a string when a pemitted is integer" do
+    input = { param_1: "a string" }
+    output = {}
+    expect(output).to eq permitted_params(input, { param_1: Integer })
+  end
+
+  it "should allow all params when no restriction is given" do
+    input = { param_1: "a string" }
+    expect(input).to eq permitted_params(input)
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-my-params
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.5
 platform: ruby
 authors:
 - Marco Aviles
@@ -11,7 +11,7 @@ cert_chain: []
 date: 2021-09-19 00:00:00.000000000 Z
 dependencies: []
 description: A simple sinatra params sanitizer
-email: nick@quaran.to
+email: gdmarav374@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -19,8 +19,8 @@ files:
 - Rakefile
 - bin/permit_params
 - lib/permit_params.rb
-- test/test_permit_params.rb
-homepage: http://rubygems.org/gems/sinatra-my-params
+- spec/permit_params_spec.rb
+homepage: https://github.com/mhero/sinatra-my-params
 licenses: []
 metadata: {}
 post_install_message:
@@ -43,4 +43,4 @@ signing_key:
 specification_version: 3
 summary: permit_params!
 test_files:
-- test/test_permit_params.rb
+- spec/permit_params_spec.rb

data/test/test_permit_params.rb

@@ -1,12 +0,0 @@
-require 'test/unit'
-require 'permit_params'
-
-class PermitParamsTest < Test::Unit::TestCase
-  include PermitParams
-
-  def test_pemit_string
-    input = { param_1: "hola" }
-    output = { param_1: "hola" }
-    assert_equal output, permitted_params( input, { param_1: String } )
-  end
-end