params_deserializers 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2829c56aa834160422e33c79e254b7803552c48f
-  data.tar.gz: 3a25a942e11b6511a2794707f201267bcfa98b69
+  metadata.gz: 439197e5a7619e734f93320fc7dfe45e98e914dd
+  data.tar.gz: d1d989f1fc9aad81b4fefda1eb9369c83e13af16
 SHA512:
-  metadata.gz: 16ee347201fa6f0c6d7a4827d0cdccf71d45e571168fa598fa877299f6baab25a766ee6a3c7625b2b3828eeafce6daa986ba6d5bb2963d31148a8a8721359557
-  data.tar.gz: b898af99a150774fc67ea2841c21ad8cecdf30fd4a51444dda181566d1002ade385b9f135d72be0b496c16781c3080f0dc8626b3457eb337f6b2ac8be71ce76a
+  metadata.gz: 69288262461ece3dcdbe8e6018b8c6dda8cade6750c42df8e04c8324faed1056670367ffc9b1e25e3341b5ba4cfc048308089ca05f7bfa45b9567bb9e66021fa
+  data.tar.gz: 2926ce18788b7c61c20d0a2cec61eed27c3e4705875e17ae09191f2029e1c7f52876a4ba0bee8ce424381aec4bd635e210593b006cc0ec17ba47bf77b27a8b15

data/README.md

@@ -45,6 +45,29 @@ class UserParamsDeserializer < ParamsDeserializer
 end
 ```
 
+## Strict Mode
+
+Call the class method `strict` to specify that only explicitly defined keys be allowed. An invalid key will raise a `ParamsDeserializer::InvalidKeyError`.
+If you want to use strict mode, but still allow a specific key that will not be automatically transformed in the output, you can use the class method `ignore`.
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  strict true
+  attribute :firstName
+  ignore :lastName
+end
+
+
+# Incoming hash: { :firstName => "Grace" }
+# Deserialized params: { :first_name => "Grace" }
+
+# Incoming hash: { :firstName => "Grace", :lastName => "Hopper" ]
+# Deserialized params: { :first_name => "Grace" }
+
+# Incoming hash: { :firstName => "Grace", :lastName => "Hopper", :birthday => "12/9/1906" }
+# Result: ParamsDeserializer::InvalidKeyError: Invalid keys in params: :birthday.
+```
+
 ## Renaming params
 
 You can pass an options hash to `attribute`. If you include the `:rename_to` key in the options hash, your deserialized params will contain the renamed key instead of the original:
@@ -56,8 +79,8 @@ class UserParamsDeserializer < ParamsDeserializer
   attribute :birthday
 end
 
-# Incoming hash: { :firstName => "Grace", :lastName => "Hopper, :birthday => "12/9/1906" }
-# Deserialized params: { :first_name => "Grace", :last_name => "Hopper, :birthday => "12/9/1906" }
+# Incoming hash: { :firstName => "Grace", :lastName => "Hopper", :birthday => "12/9/1906" }
+# Deserialized params: { :first_name => "Grace", :last_name => "Hopper", :birthday => "12/9/1906" }
 ```
 
 ## Changing params case
@@ -70,8 +93,8 @@ class UserParamsDeserializer < ParamsDeserializer
   format_keys :snake_case # (or :camel_case or :lower_camel)
 end
 
-# Incoming hash: { :firstName => "Grace", :lastName => "Hopper, :birthday => "12/9/1906" }
-# Deserialized params: { :first_name => "Grace", :last_name => "Hopper, :birthday => "12/9/1906" }
+# Incoming hash: { :firstName => "Grace", :lastName => "Hopper", :birthday => "12/9/1906" }
+# Deserialized params: { :first_name => "Grace", :last_name => "Hopper", :birthday => "12/9/1906" }
 ```
 
 ## Dealing with a root key
@@ -267,7 +290,7 @@ Now, when an API user hits `UsersController#create` with the following JSON payl
 
 ## License
 
-Copyright (c) 2015, Groupon, Inc.  
+Copyright (c) 2015, Groupon, Inc.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

data/lib/params_deserializers/attribute.rb

@@ -29,11 +29,13 @@
 
 class ParamsDeserializer
   class Attribute
-    attr_reader :name, :present_if
+    attr_reader :ignored, :original_name, :name, :present_if
 
-    def initialize(original_name, name = original_name, present_if = nil)
-      @original_name, @name, @present_if = original_name, name, present_if
-      @present_if ||= -> { params_root.has_key?(original_name) }
+    def initialize(original_name, options = {})
+      @original_name = original_name
+      @name = options[:rename_to] || @original_name
+      @ignored = options[:ignored]
+      @present_if = options[:present_if] || -> { params_root.has_key?(original_name) }
     end
   end
 end

data/lib/params_deserializers/attribute_collection.rb

@@ -39,5 +39,9 @@ class ParamsDeserializer
 
       super
     end
+
+    def unignored
+      reject(&:ignored)
+    end
   end
 end

data/lib/params_deserializers/params_deserializer.rb

@@ -32,15 +32,17 @@ require 'active_support/core_ext/string/inflections'
 
 class ParamsDeserializer
   class MissingRootKeyError < StandardError; end
+  class InvalidKeyError < StandardError; end
 
   def initialize(params)
     @params = params
     verify_root_key_exists
+    verify_valid_keys
   end
 
   def deserialize
     deserialized_params = {}
-    self.class.attrs.each do |attr|
+    self.class.attrs.unignored.each do |attr|
       next unless instance_exec(&attr.present_if)
       deserialized_params[attr.name] = self.send(attr.name)
     end
@@ -86,10 +88,23 @@ class ParamsDeserializer
     end
   end
 
+  def verify_valid_keys
+    invalid_params = params_root.keys - self.class.attrs.map(&:original_name)
+    if self.class.strict_mode && !invalid_params.blank?
+      raise InvalidKeyError, "Invalid keys in params: #{invalid_params.map(&:inspect).join(",")}."
+    end
+  end
+
   class << self
     attr_reader :root_key
     attr_accessor :key_format
+    attr_accessor :strict_mode
     alias_method :format_keys, :key_format=
+    alias_method :strict, :strict_mode=
+
+    def deserialize(params)
+      new(params).deserialize
+    end
 
     def attrs
       @attrs ||= AttributeCollection.new
@@ -101,6 +116,10 @@ class ParamsDeserializer
       end
     end
 
+    def ignore(attr)
+      attrs << Attribute.new(attr, ignored: true)
+    end
+
     def attributes(*args)
       args.each do |attr|
         attribute(attr)
@@ -130,7 +149,7 @@ class ParamsDeserializer
 
     def define_getter_method(attr, options = {}, &block)
       options[:rename_to] ||= attr
-      attrs << Attribute.new(attr, options[:rename_to], options[:present_if])
+      attrs << Attribute.new(attr, options)
       define_method(options[:rename_to], &block) unless method_defined?(options[:rename_to])
     end
   end

data/lib/params_deserializers/version.rb

@@ -28,5 +28,5 @@
 # POSSIBILITY OF SUCH DAMAGE.
 
 module ParamsDeserializers
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: params_deserializers
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Jesse Pinho
@@ -10,82 +10,82 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-08 00:00:00.000000000 Z
+date: 2016-01-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.16
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.16
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
   name: guard-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'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   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'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   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: Modeled after active_model_serializers, this gem allows you to create
@@ -114,17 +114,17 @@ 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.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Deserializers for Rails params