sinatra-strong-params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a0c3d5236e9fcbd2d878573d2e04dbdef15b7df3
+  data.tar.gz: 300ef2e3e4cf32ab6d55f0fbbfe839dc647110ca
+SHA512:
+  metadata.gz: 0f99cc84b7b4145cffeafbc6510add4ada732befcb7d466c5155942b3af48afdd163b6fcc4ee0a44ccef0dd70d1bbc523326c03d16b094891ff341ca1c21ed85
+  data.tar.gz: 676ee9e458fff1d5b253c7102f9d8e2822d7dbdb4d661ef53a2aa61ee1004a5d11ef970977f34f4412349deb894215f86bb4f7e20865e9598117ce7d7c8092f9

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Evan Lecklider
+
+MIT License
+
+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,72 @@
+# Sinatra::StrongParams
+
+A really naive parameter filtering implementation for Sinatra.
+
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sinatra-strong-params', :require => 'sinatra/strong-params'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sinatra-strong-params
+
+
+
+## Usage
+
+This gem adds two filters to Sinatra routes: `allows` and `needs`.
+
+
+
+### Allows
+
+A way to whitelist parameters in the request scope.
+
+```ruby
+get '/', allows: [:id, :action] do
+  erb :index
+end
+```
+
+`allows` modifies the parameters available in the request scope, so
+beware, though it stashes unmodified params in @_params.
+
+
+
+### Needs
+
+A way to require parameters in the request scope.
+
+```ruby
+get '/', needs: [:id, :action] do
+  erb :index
+end
+```
+
+`needs` does not modify the parameters available to the request scope
+and raises a RequiredParamMissing error if a needed param is missing.
+
+Catching a missing parameter:
+
+```ruby
+error RequiredParamMissing do
+  [400, env['sinatra.error'].message]
+end
+```
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/sinatra-strong-params/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/sinatra/strong-params.rb

@@ -0,0 +1,78 @@
+require 'sinatra/base'
+require 'sinatra/strong-params/version'
+
+class RequiredParamMissing < ArgumentError; end
+
+module Sinatra
+  module StrongParams
+    def self.registered(app)
+      #
+      # A way to whitelist parameters.
+      #
+      #   get '/', allows: [:id, :action] do
+      #     erb :index
+      #   end
+      #
+      # Modifies the parameters available in the request scope.
+      # Stashes unmodified params in @_params
+      #
+      app.set(:allows) do |*passable|
+        condition do
+          unless @params.blank?
+            @_params = @_params || @params # for safety
+            globals  = settings.globally_allowed_parameters
+            passable = (globals | passable).map(&:to_sym) # make sure it's a symbol
+
+            # trim the params down
+            @params = @params.select do |param, value|
+              passable.include?(param.to_sym)
+            end
+          end
+        end
+      end
+
+      #
+      # A way to require parameters
+      #
+      #   get '/', needs: [:id, :action] do
+      #     erb :index
+      #   end
+      #
+      # Does not modify the parameters available to the request scope.
+      # Raises a RequiredParamMissing error if a needed param is missing
+      #
+      app.set(:needs) do |*needed|
+        condition do
+          if @params.nil? || @params.empty? && !needed.empty?
+            raise RequiredParamMissing, 'One or more required parameters were missing.'
+          else
+            @_params   = @_params || @params # for safety
+            needed     = needed.map(&:to_sym) # make sure it's a symbol
+            sym_params = @params.dup
+
+            # symbolize the keys so we know what we're looking at
+            sym_params.keys.each do |key|
+              sym_params[(key.to_sym rescue key) || key] = sym_params.delete(key)
+            end
+
+            if needed.any? { |key| sym_params[key].nil? || sym_params[key].empty? }
+              raise RequiredParamMissing, 'One or more required parameters were missing.'
+            end
+          end
+        end
+      end
+
+      # these will always pass through the 'allows' method
+      # and will be mapped to symbols. I often use ['redirect_to', '_csrf'] here
+      # because I always want them to pass through for later processing
+      app.set :globally_allowed_parameters, []
+
+      # default error response
+      app.error RequiredParamMissing do
+        [400, env['sinatra.error'].message]
+      end
+    end
+  end
+
+  register StrongParams
+end

data/lib/sinatra/strong-params/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module StrongParams
+    VERSION = "0.0.1"
+  end
+end

data/sinatra-strong-params.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+$:.unshift File.expand_path("../lib", __FILE__)
+require 'sinatra/strong-params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sinatra-strong-params"
+  spec.version       = Sinatra::StrongParams::VERSION
+  spec.authors       = ["Evan Lecklider"]
+  spec.email         = ["evan@lecklider.com"]
+  spec.summary       = %q{Some super basic strong parameter filters for Sinatra.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'sinatra', '>= 1.4.0'
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-strong-params
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Evan Lecklider
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 1.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: Some super basic strong parameter filters for Sinatra.
+email:
+- evan@lecklider.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra/strong-params.rb
+- lib/sinatra/strong-params/version.rb
+- sinatra-strong-params.gemspec
+homepage: ''
+licenses:
+- MIT
+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.3.0
+signing_key: 
+specification_version: 4
+summary: Some super basic strong parameter filters for Sinatra.
+test_files: []