moderate_params 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 92178039a3f6e508d9841e763ca4e9bf4b0172b1b425e716aa58c55387e6614b
+  data.tar.gz: 0b704bf08773b0e0fca4d4c198229356c0af76d5829e003fb351bdc53908e1c6
+SHA512:
+  metadata.gz: 86b9f12fd878e234c434100c33e61952e7a556d78d42a88662684ec8274d40284d09e049c4c5ce0a350c8603c0a375d92863fe85fc6564151d1052a423b0206a
+  data.tar.gz: ef96d8c4350b43d9e935afac6a62727ed4a24f4c3db84b5d05dd8ea9d5e55b49ee3b95b311d3b806ee64244632f1f3db5deb4273bc047f8de6944feada368830

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+### 0.1.0 - 2019-03-25
+
+* Init Project
+* moderate_params.log
+* Extend ActionController::Parameters functionality

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at mike@hint.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in moderate_params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Mike Calhoun
+
+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,129 @@
+# `moderate_params`
+
+In the migration from [protected_attributes](https://github.com/rails/protected_attributes) to [strong_parameters](https://api.rubyonrails.org/classes/ActionController/StrongParameters.html), it can be difficult to determine what data is originating from within the app and what is coming from the internet. `moderate_params` is a tool that provides safety nets and logging of data sources in the controller by extending `ActionController::Parameters` functionality.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'moderate_params'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moderate_params
+
+## Usage
+
+Given a form at `/people/new` that submits data to the `PeopleController#create` action like so:
+
+```ruby
+{ person: { name: 'Kyle', age: '26', height: '180' } }
+```
+
+With a model that looks like:
+
+```ruby
+class Person < ActiveRecord::Base
+  attr_accessible :name, :age, :height
+
+  . . .
+
+end
+```
+
+And a controller looks like this:
+
+```ruby
+class PeopleController < ActionController::Base
+  def create
+    Person.create(params[:person])
+  end
+
+  . . .
+
+end
+```
+
+We can add `moderate_params` by following the `strong_parameters` implementation method with a couple slight changes.
+
+Add a private params method for the controller calling `moderate` (with `controller_name` and `action_name` as the first two args) instead of `permit`:
+
+```ruby
+class PeopleController < ActionController::Base
+  def create
+    Person.create(person_params) # Was Person.create(params[:person])
+  end
+
+  . . .
+
+  private
+
+    def person_params
+      params.require(:person).moderate(controller_name, action_name, :name)
+    end
+end
+```
+
+This will cause the `person_params` to flow the same way they did before (getting passed to the model without interruption),
+but the params that are not included in the argument of `moderate` will be logged to `/log/moderate_params.log`
+
+Meaning that, after submitting the aforementioned data, our `moderate_params.log` will look like so:
+
+    people#create Top Level is missing: age
+    people#create Top Level is missing: height
+
+We can fix this by adding `age` and `height` to `person_params` like so:
+
+```ruby
+class PeopleController < ActionController::Base
+  def create
+    Person.create(person_params)
+  end
+
+  . . .
+
+  private
+
+    def person_params
+      params.require(:person).moderate(controller_name, action_name, :name, :age, :height)
+    end
+end
+```
+
+We can then hit submit data from the form at `/people/new` and see that no new lines are added to the `moderate_params.log` file.
+
+This means that we can remove `moderate_params` and move to using `permit` as a part of `strong_parameters`:
+
+```ruby
+class PeopleController < ActionController::Base
+  def create
+    Person.create(person_params)
+  end
+
+  . . .
+
+  private
+
+    def person_params
+      params.require(:person).permit(:name, :age, :height)
+    end
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/hintmedia/moderate_params. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the moderate_params project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/hintmedia/moderate_params/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

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

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/moderate_params.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "moderate_params/version"
+require "moderate_params/logger"
+require "moderate_params/strong_params_monkey_patch"
+
+module ModerateParams
+end

data/lib/moderate_params/logger.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+$moderate_params_logger = Logger.new("#{Rails.root}/log/moderate_params.log")
+
+ActiveSupport::Notifications.subscribe('moderate_params') do |name, start, finish, id, payload|
+  $moderate_params_logger.info "#{payload[:controller]}##{payload[:action]} #{payload[:message]}"
+end

data/lib/moderate_params/moderate_strong_params.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ActionController
+  class Parameters
+    def moderate(controller_name, action, *filters)
+      params = self.class.new
+
+      filters.each do |filter|
+        case filter
+        when Symbol, String
+          permitted_scalar_filter(params, filter)
+        when Hash
+          cust_hash_filter(params, filter, controller_name, action)
+        end
+      end
+
+      unpermitted_parameters!(params)
+      custom_logging(params, controller_name, action)
+      permit!
+    end
+
+    private
+
+      def custom_logging(params, controller_name, action)
+        unpermitted_keys(params).each do |k|
+          ActiveSupport::Notifications.instrument('moderate_params') do |payload|
+             payload[:controller] = controller_name
+             payload[:action] = action
+             payload[:message] = "#{@context || 'Top Level'} is missing: #{k}"
+          end
+        end
+      end
+
+      def non_scalar?(value)
+        value.is_a?(Array) || value.is_a?(Parameters)
+      end
+
+      EMPTY_HASH = {}
+       def cust_hash_filter(params, filter, controller_name, action)
+        filter = filter.with_indifferent_access
+
+        # Slicing filters out non-declared keys.
+        slice(*filter.keys).each do |key, value|
+          next unless value
+          next unless has_key? key
+
+          if filter[key] == EMPTY_ARRAY
+            # Declaration { comment_ids: [] }.
+            array_of_permitted_scalars?(self[key]) do |val|
+              params[key] = val
+            end
+          elsif filter[key] == EMPTY_HASH
+            # Declaration { preferences: {} }.
+            if value.is_a?(Parameters)
+              params[key] = permit_any_in_parameters(value)
+            end
+          elsif non_scalar?(value)
+            # Declaration { user: :name } or { user: [:name, :age, { address: ... }] }.
+            params[key] = each_element(value) do |element|
+              element.instance_variable_set '@context', "Parent #{key}"
+              element.moderate(controller_name, action, *Array.wrap(filter[key]))
+            end
+          end
+        end
+      end
+  end
+end

data/lib/moderate_params/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ModerateParams
+  VERSION = "0.1.0"
+end

data/moderate_params.gemspec

@@ -0,0 +1,40 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "moderate_params/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "moderate_params"
+  spec.version       = ModerateParams::VERSION
+  spec.authors       = ["Kyle Boe, Mike Calhoun"]
+  spec.email         = ["kyle@hint.io, mike@hint.io"]
+
+  spec.summary       = %q{Strong Parameters migration tool}
+  spec.description   = %q{A tool for migrating Rails applications to Strong Parameters.}
+  spec.homepage      = "https://github.com/hintmedia/moderate_params"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/hintmedia/moderate_params"
+    spec.metadata["changelog_uri"] = "https://github.com/hintmedia/moderate_params/blob/master/CHANGELOG.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: moderate_params
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kyle Boe, Mike Calhoun
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A tool for migrating Rails applications to Strong Parameters.
+email:
+- kyle@hint.io, mike@hint.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/moderate_params.rb
+- lib/moderate_params/logger.rb
+- lib/moderate_params/moderate_strong_params.rb
+- lib/moderate_params/version.rb
+- moderate_params.gemspec
+homepage: https://github.com/hintmedia/moderate_params
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/hintmedia/moderate_params
+  source_code_uri: https://github.com/hintmedia/moderate_params
+  changelog_uri: https://github.com/hintmedia/moderate_params/blob/master/CHANGELOG.md
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Strong Parameters migration tool
+test_files: []