params_deserializers 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2829c56aa834160422e33c79e254b7803552c48f
+  data.tar.gz: 3a25a942e11b6511a2794707f201267bcfa98b69
+SHA512:
+  metadata.gz: 16ee347201fa6f0c6d7a4827d0cdccf71d45e571168fa598fa877299f6baab25a766ee6a3c7625b2b3828eeafce6daa986ba6d5bb2963d31148a8a8721359557
+  data.tar.gz: b898af99a150774fc67ea2841c21ad8cecdf30fd4a51444dda181566d1002ade385b9f135d72be0b496c16781c3080f0dc8626b3457eb337f6b2ac8be71ce76a

data/README.md

@@ -0,0 +1,281 @@
+# Params Deserializers
+
+## Purpose
+
+Modeled after [`active_model_serializers`](https://github.com/rails-api/active_model_serializers), this gem allows you to create deserializer classes to modify incoming parameters in your Rails app.
+
+Rails controllers often receive incoming parameters (via JSON payloads, for instance) that are not in the format Rails expects for things like saving models. With Params Deserializers, you can easily transform these incoming parameters into the format you want ([example](#an-example)).
+
+## Getting started
+
+Create a subclass of `ParamsDeserializer`:
+
+```ruby
+# app/deserializers/user_params_deserializer.rb
+
+class UserParamsDeserializer < ParamsDeserializer
+end
+```
+
+To deserialize a hash with your deserializer, instantiate your deserializer with the hash, and call `deserialize` on it:
+
+```ruby
+new_hash = UserParamsDeserializer.new(old_hash).deserialize
+```
+
+## Listing params
+
+Call the class method `attributes` to list incoming params:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  attributes :first_name, :last_name, :birthday
+end
+```
+
+This class indicates that it expects `first_name`, `last_name`, and `birthday` keys on an incoming hash. Any other keys in the hash will be discarded.
+
+Keys can also be listed individually using `attribute`:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  attribute :first_name
+  attribute :last_name
+  attribute :birthday
+end
+```
+
+## 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:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  attribute :firstName, rename_to: :first_name
+  attribute :lastName, rename_to: :last_name
+  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" }
+```
+
+## Changing params case
+
+You can apply snake_case, CamelCase, or lowerCamel cases to all your keys automatically using `format_keys`:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  attributes :firstName, :lastName, :birthday
+  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" }
+```
+
+## Dealing with a root key
+
+If you expect a root key containing an object with all the other keys, call the `root` class method on your deserializer. Otherwise, it will look for the attributes you've listed at the top level:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  root: :user
+  attributes :first_name, :last_name
+end
+
+# Incoming hash: { :user => { :first_name => "Grace", :last_name => "Hopper" } }
+# Deserialized params: { :user => { :first_name => "Grace", :last_name => "Hopper" } }
+```
+
+To discard the root key in your deserialized params, pass `{ discard: true }` as the second argument to `root`:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  root: :user, discard: true
+  attributes :first_name, :last_name
+end
+
+# Incoming hash: { :user => { :first_name => "Grace", :last_name => "Hopper" } }
+# Deserialized params: { :first_name => "Grace", :last_name => "Hopper" }
+```
+
+## Deciding whether a key should be present
+
+By default, any key listed via `attribute` or `attributes` will be included in the deserialized params if the key is present in `params`. However, the `attribute` class method takes an options hash. If the hash includes a `:present_if` key with a lambda value, it will execute that lambda to determine whether that key should be present in the deserialized params:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  attribute :first_name
+  attribute :last_name, present_if: -> { params[:last_name].length > 5 }
+end
+
+# Incoming hash: { :first_name => "Grace", :last_name => "Hop" }
+# Deserialized params: { :first_name => "Grace" }
+```
+
+The lambda has access to the `params` hash, and can use it to determine whether the key should be present. In the example above, `last_name` is only included when its length is greater than 5.
+
+## Overriding a key's value
+
+If you define a method of the same name as a parameter, that method will be called to provide the parameter's value:
+
+```ruby
+class UserParamsDeserializer < ParamsDeserializer
+  attribute :birthday
+
+  def birthday
+    month, day, year = params[:birthday].split("/")
+    Time.new(year.to_i, month.to_i, day.to_i)
+  end
+end
+
+# Incoming hash: { :birthday => "12/9/1906" }
+# Deserialized params: { :birthday => 1906-12-09 00:00:00 -0000 }
+```
+
+Note that the method name should equal to the *renamed* parameter name, if the parameter has been renamed. For example, if you had passed `{ rename_to: :birth_date }` to `attribute` in the example above, the method you define would have to be `birth_date` instead of `birthday`.
+
+## Integrating your deserializer with your controller
+
+You can deserialize incoming parameters in two ways:
+
+### Via `deserialize_params_with`
+
+If you `include ParamsDeserializers` in your controller, your controller will have access to a class method called `deserialize_params_with`. By default, `deserialize_params_with` will create an instance variable called `deserialized_params`. Think of this as the `params` instance variable, but transformed according to your deserializer.
+
+```ruby
+# /app/controllers/users_controller.rb
+
+class UsersController < ApplicationController
+  include ParamsDeserializers
+  deserialize_params_with UserParamsDeserializer
+
+  def create
+    @user = User.create(deserialized_params)
+    render json: @user
+  end
+end
+```
+
+If you'd like a different instance variable name, such as `better_params`, pass an options hash to `deserialize_params_with` that contains an `:as` key:
+
+```ruby
+  deserialize_params_with UserParamsDeserializer, as: :better_params
+```
+
+`better_params` will now be available to your controller action.
+
+`deserialize_params_with` passes on any remaining keys in the options hash to `before_filter`, which means you can restrict deserialization to only certain controller actions:
+
+```ruby
+  deserialize_params_with UserParamsDeserializer, as: :better_params, only: [:create, :update]
+```
+
+### Via instantiation of your deserializer
+
+You can also simply instantiate your deserializer with `params` in your controller action, and then call `deserialize` on it to get the deserialized params:
+
+```ruby
+# /app/controllers/users_controller.rb
+
+class UsersController < ApplicationController
+  def create
+    deserialized_params = UserParamsDeserializer.new(params).deserialize
+    @user = User.create(deserialized_params)
+    render json: @user
+  end
+end
+```
+
+## An example
+
+Create a subclass of `ParamsDeserializer`:
+
+```ruby
+# app/deserializers/user_params_deserializer.rb
+
+class UserParamsDeserializer < ParamsDeserializer
+  root :user, discard: true
+
+  format_keys :snake_case
+
+  attributes :birthday,
+             :firstName,
+             :lastName
+
+  attribute :heightInInches,
+            rename_to: :height_in_feet,
+            present_if: -> { params[:height_in_inches].is_a? Integer }
+
+  def birthday
+    month, day, year = params[:birthday].split("/")
+    Time.new(year.to_i, month.to_i, day.to_i)
+  end
+
+  def height_in_feet
+    params[:heightInInches] / 12.0
+  end
+end
+```
+
+Then, include it in your `UsersController`:
+
+```ruby
+# app/controllers/users_controller.rb
+
+class UsersController < ApplicationController
+  include ParamsDeserializers
+  deserialize_params_with UserParamsDeserializer, as: :new_params, only: :create
+
+  def create
+    @user = User.create(new_params)
+    render json: @user
+  end
+end
+```
+
+Now, when an API user hits `UsersController#create` with the following JSON payload:
+
+```json
+{
+  "user": {
+    "firstName": "Grace",
+    "lastName": "Hopper",
+    "birthday": "12/9/1906",
+    "heightInInches": 66
+  }
+}
+```
+
+...`UsersController#create` will have access to an instance variable called `new_params` with the following contents:
+
+```ruby
+{
+  :first_name => "Grace",
+  :last_name => "Hopper",
+  :birthday => 1906-12-09 00:00:00 -0000,
+  :height_in_feet => 5.5
+}
+```
+
+## Development
+
+- Clone this repo.
+- `bundle install`
+- `bundle exec rspec` (or `bundle exec guard` to watch for changes)
+
+## License
+
+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:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Rakefile

@@ -0,0 +1,52 @@
+# 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'ParamsDeserializers'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+

data/lib/params_deserializers/attribute.rb

@@ -0,0 +1,39 @@
+# 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+class ParamsDeserializer
+  class Attribute
+    attr_reader :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) }
+    end
+  end
+end

data/lib/params_deserializers/attribute_collection.rb

@@ -0,0 +1,43 @@
+# 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+class ParamsDeserializer
+  class AttributeCollection < Array
+    class NameCollisionError < StandardError; end
+
+    def <<(new_attr)
+      if any? { |attr| attr.name == new_attr.name }
+        raise NameCollisionError,
+              "Attribute \"#{new_attr.name}\" was defined multiple times."
+      end
+
+      super
+    end
+  end
+end

data/lib/params_deserializers/deserialize_params_with.rb

@@ -0,0 +1,45 @@
+# 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'active_support/concern'
+
+module ParamsDeserializers
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def deserialize_params_with(deserializer, options = {})
+      deserialized_params_name = options.delete(:as).try(:to_sym) || :deserialized_params
+      attr_reader deserialized_params_name
+
+      before_filter(options) do
+        instance_variable_set("@#{deserialized_params_name}", deserializer.new(params).deserialize)
+      end
+    end
+  end
+end

data/lib/params_deserializers/params_deserializer.rb

@@ -0,0 +1,137 @@
+# 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/string/inflections'
+
+class ParamsDeserializer
+  class MissingRootKeyError < StandardError; end
+
+  def initialize(params)
+    @params = params
+    verify_root_key_exists
+  end
+
+  def deserialize
+    deserialized_params = {}
+    self.class.attrs.each do |attr|
+      next unless instance_exec(&attr.present_if)
+      deserialized_params[attr.name] = self.send(attr.name)
+    end
+    format_keys(deserialized_params).with_indifferent_access
+  end
+
+  private
+
+  attr_reader :params
+
+  def format_key(key)
+    case self.class.key_format
+    when :snake_case then key.to_s.underscore.to_sym
+    when :camel_case then key.to_s.camelize.to_sym
+    when :lower_camel then key.to_s.camelize(:lower).to_sym
+    else key
+    end
+  end
+
+  def format_keys(hash)
+    hash = Hash[hash.map { |k, v| [format_key(k), v] }] if self.class.key_format
+    optionally_include_root_key(hash)
+  end
+
+  def optionally_include_root_key(hash)
+    return hash unless self.class.include_root_key?
+    { format_key(self.class.root_key) => hash }
+  end
+
+  def params_root
+    return @params_root if @params_root
+
+    if self.class.root_key
+      @params_root = params[self.class.root_key]
+    else
+      @params_root = params
+    end
+  end
+
+  def verify_root_key_exists
+    if self.class.root_key && !params.has_key?(self.class.root_key)
+      raise MissingRootKeyError, "Root key #{self.class.root_key} is missing from params."
+    end
+  end
+
+  class << self
+    attr_reader :root_key
+    attr_accessor :key_format
+    alias_method :format_keys, :key_format=
+
+    def attrs
+      @attrs ||= AttributeCollection.new
+    end
+
+    def attribute(attr, options = {})
+      define_getter_method(attr, options) do
+        params_root[attr]
+      end
+    end
+
+    def attributes(*args)
+      args.each do |attr|
+        attribute(attr)
+      end
+    end
+
+    def has_many(attr, options = {})
+      define_getter_method(attr, options) do
+        return params_root[attr] unless options[:deserializer]
+
+        params_root[attr].map do |relation|
+          options[:deserializer].new(relation).deserialize
+        end if params_root[attr].is_a?(Array)
+      end
+    end
+
+    def root(key, options = {})
+      @root_key = key
+      @discard_root_key = options[:discard]
+    end
+
+    def include_root_key?
+      @root_key && !@discard_root_key
+    end
+
+    private
+
+    def define_getter_method(attr, options = {}, &block)
+      options[:rename_to] ||= attr
+      attrs << Attribute.new(attr, options[:rename_to], options[:present_if])
+      define_method(options[:rename_to], &block) unless method_defined?(options[:rename_to])
+    end
+  end
+end

data/lib/params_deserializers/version.rb

@@ -0,0 +1,32 @@
+# 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+module ParamsDeserializers
+  VERSION = "1.0.1"
+end

data/lib/params_deserializers.rb

@@ -0,0 +1,33 @@
+# 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:
+#
+# 1. Redistributions of source code must retain the above copyright notice,
+# this list of conditions and the following disclaimer.
+#
+# 2. Redistributions in binary form must reproduce the above copyright notice,
+# this list of conditions and the following disclaimer in the documentation
+# and/or other materials provided with the distribution.
+#
+# 3. Neither the name of the copyright holder nor the names of its contributors
+# may be used to endorse or promote products derived from this software without
+# specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+# ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
+# LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
+# CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
+# SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+# INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
+# CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
+# ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
+# POSSIBILITY OF SUCH DAMAGE.
+
+require_relative './params_deserializers/attribute'
+require_relative './params_deserializers/attribute_collection'
+require_relative './params_deserializers/params_deserializer'
+require_relative './params_deserializers/deserialize_params_with'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: params_deserializers
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Jesse Pinho
+- Trek Glowacki
+- Jim Challenger
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-08 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
+  deserializer classes for incoming Rails parameters.
+email:
+- jesse@jessepinho.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- lib/params_deserializers.rb
+- lib/params_deserializers/attribute.rb
+- lib/params_deserializers/attribute_collection.rb
+- lib/params_deserializers/deserialize_params_with.rb
+- lib/params_deserializers/params_deserializer.rb
+- lib/params_deserializers/version.rb
+homepage: https://github.com/groupon/params_deserializers
+licenses:
+- BSD-3-Clause
+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.8
+signing_key: 
+specification_version: 4
+summary: Deserializers for Rails params
+test_files: []