password_required 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0d345fbf7213d55b231133b6228475d4bfa7c88e
+  data.tar.gz: ed2e5b82afef68715535586a238c7a5d72fa664a
+SHA512:
+  metadata.gz: 9f69827443b45de22bc5ac19c01eeac6e856d5847e629719356567d13e37a4fefc44b2806d327cc3089deb8f8ee6d403db65b990ff0322bfa582ac464fe65631
+  data.tar.gz: 06e99222096126065ed1391589dbcc933563a3e4203b794a656912884451264168337577be8878c4fa8dbcb68a13ea99084690989efc99c8d0dcc62ac9b79f9b

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Benjamin Falk
+
+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,75 @@
+## PasswordRequired
+
+[![GitHub version](https://badge.fury.io/gh/benfalk%2Fpassword_required.svg)](http://badge.fury.io/gh/benfalk%2Fpassword_required)
+[![Build Status](https://travis-ci.org/benfalk/password_required.svg?branch=master)](https://travis-ci.org/benfalk/password_required)
+[![Code Climate](https://codeclimate.com/github/benfalk/password_required/badges/gpa.svg)](https://codeclimate.com/github/benfalk/password_required)
+[![Coverage Status](https://img.shields.io/coveralls/benfalk/password_required.svg)](https://coveralls.io/r/benfalk/password_required)
+[![Dependency Status](https://gemnasium.com/benfalk/password_required.svg)](https://gemnasium.com/benfalk/password_required)
+[![Inline docs](http://inch-ci.org/github/benfalk/password_required.svg?branch=master)](http://inch-ci.org/github/benfalk/password_required)
+
+### About
+
+Used to password protect sensitive actions.  This was inspired by the need to
+follow the same pattern Github uses when adding a new key to your account.  The
+goal of PasswordRequired is to make this pattern easy and flexible without
+requiring additional rails libraries.
+
+### Usage Example
+
+```ruby
+# In your gemfile
+gem 'password_required'
+```
+
+```ruby
+# In your controller
+class WidgetsController < ApplicationController
+  include PasswordRequired::ControllerConcern
+
+  password_required for: [:create, :update, :destroy],
+                    with: ->(password) { password == 'roflcopters' },
+                    if: :request_ip_untrusted?
+
+  # ...
+end
+```
+
+### password_required options
+
+* `for:` (Required) An array of methods you want to protect
+
+* `with:` (Optional) lambda that receives the password given OR a symbol of a
+method to call.  If either returns a truthy result the action will be allowed.
+You may optionally define a method `password_correct?` that will be used for
+all password protected actions.
+
+* `if:` (Optional) lambda or method name that determines if a request needs to
+be password protected.  Always true by default.  Useful if there are some times
+you do not need to prompt for a password.  You optionally define a method
+`password_required?` on the controller that will be called for all password
+protected actions.
+
+### Current Limitations and Issues
+
+* Only POST type actions are supported DELETE, POST, PUT
+* Only designed and tested with rails 4.1
+
+### FAQ
+
+Q: "What if I don't like the idea of magical callbacks?"
+
+A: No problem, you'll need to define the following methods in your controller
+
+* `password_correct?` (hint) `password_given` is the password from the request
+* `password_required?` (optional) always true by default
+
+In the controller actions you want to password protect: `guard_with_password!`
+
+```ruby
+def destroy
+  guard_with_password!
+  # ...
+end
+```
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,22 @@
+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    = 'PasswordRequired'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path('../spec/dummy/Rakefile', __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+task default: ['app:db:migrate', 'app:spec', 'app:cucumber', 'app:rubocop']

data/app/assets/javascripts/password_required/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/password_required/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/password_required/application_controller.rb

@@ -0,0 +1,4 @@
+module PasswordRequired
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/password_required/application_helper.rb

@@ -0,0 +1,4 @@
+module PasswordRequired
+  module ApplicationHelper
+  end
+end

data/app/views/layouts/password_required/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>PasswordRequired</title>
+  <%= stylesheet_link_tag    "password_required/application", media: "all" %>
+  <%= javascript_include_tag "password_required/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/app/views/password_request/new.html.erb

@@ -0,0 +1,11 @@
+<%= form_for @password_request, url: @password_request.target_url do |f| %>
+  <%= @password_request.hidden_form_inputs %>
+  <p>You're password is required to continue.</p>
+  <div>
+    <%= f.label :password %>
+    <%= f.password_field :password %>
+  </div>
+  <div>
+    <%= f.submit 'continue' %>
+  </div>
+<% end %>

data/config/cucumber.yml

@@ -0,0 +1,8 @@
+<%
+rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
+rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+%>
+default: <%= std_opts %> features
+wip: --tags @wip:3 --wip features
+rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/config/routes.rb

@@ -0,0 +1,2 @@
+PasswordRequired::Engine.routes.draw do
+end

data/lib/password_required/controller_concern/arguments_composer.rb

@@ -0,0 +1,35 @@
+module PasswordRequired
+  module ControllerConcern
+    class ArgumentsComposer
+      VALID_KEYS = [:for, :with]
+
+      def initialize(opts = {})
+        @options = opts.slice(*VALID_KEYS)
+        @options[:for] = Array(@options[:for])
+      end
+
+      def call(klass)
+        @options.each_pair do |key, value|
+          send("handle_#{key}_key", klass, value, @options[:for])
+        end
+      end
+
+      private
+
+      def handle_with_key(klass, value, actions)
+        actions.each do |action|
+          klass.password_check_methods[action] =
+            if value.is_a? Proc
+              value
+            elsif value.is_a? Symbol
+              ->(_) { send(value) }
+            end
+        end
+      end
+
+      def handle_for_key(klass, value, _)
+        klass.send :before_action, :guard_with_password!, only: value
+      end
+    end
+  end
+end

data/lib/password_required/controller_concern.rb

@@ -0,0 +1,66 @@
+require 'password_required/password_request'
+require 'password_required/controller_concern/arguments_composer'
+
+module PasswordRequired
+  module ControllerConcern
+    extend ActiveSupport::Concern
+
+    class PasswordMissing < Exception; end
+    class PasswordWrong < Exception; end
+    class UserCanceled < Exception; end
+
+    included do
+      def self.password_required(opts = {})
+        fail ArgumentError, ':for key is required' unless opts[:for].present?
+        ArgumentsComposer.new(opts).call(self)
+      end
+
+      rescue_from PasswordMissing, PasswordWrong, with: :present_password_request
+
+      cattr_accessor :password_check_methods, instance_writer: false do
+        ActiveSupport::HashWithIndifferentAccess.new(->(_) { false })
+      end
+
+      cattr_accessor :password_guard_conditions, instance_writer: false do
+        ActiveSupport::HashWithIndifferentAccess.new(->() { true })
+      end
+    end
+
+    def password_supplied?
+      password_given.present?
+    end
+
+    def password_correct?
+      instance_exec(password_given, &password_check_method)
+    end
+
+    def password_required?
+      instance_exec(&password_guard_condition)
+    end
+
+    def password_guard_condition
+      password_guard_conditions[action_name]
+    end
+
+    def password_check_method
+      password_check_methods[action_name]
+    end
+
+    def password_given
+      params[:password_request][:password]
+    rescue
+      ''
+    end
+
+    def guard_with_password!
+      return unless password_required?
+      fail PasswordMissing unless password_supplied?
+      fail PasswordWrong unless password_correct?
+    end
+
+    def present_password_request
+      @password_request ||= PasswordRequest.new(request)
+      render 'password_request/new'
+    end
+  end
+end

data/lib/password_required/engine.rb

@@ -0,0 +1,5 @@
+module PasswordRequired
+  class Engine < ::Rails::Engine
+    isolate_namespace PasswordRequired
+  end
+end

data/lib/password_required/password_request/hidden_inputs.rb

@@ -0,0 +1,40 @@
+module PasswordRequired
+  class PasswordRequest
+    class HiddenInputs
+      include ActionView::Helpers::FormTagHelper
+
+      attr_reader :namespaces
+
+      def initialize(params, namespaces: [])
+        @params = params
+        @namespaces = namespaces
+      end
+
+      def to_s
+        @params.reduce('') do |input_html, key_value_pair|
+          input_html + input_from(*key_value_pair)
+        end
+      end
+
+      private
+
+      def input_from(key, value)
+        if value.is_a? Hash
+          self.class.new(value, namespaces: namespaces | [key]).to_s
+        else
+          devise_input namespaced(key), value
+        end
+      end
+
+      def devise_input(key, value)
+        key += '[]' if value.is_a? Array
+        Array(value).map { |i| hidden_field_tag key, i }.join('')
+      end
+
+      def namespaced(key)
+        first, *rest = *(namespaces | [key])
+        "#{first}#{rest.reduce('') { |a, e| a + "[#{e}]" }}"
+      end
+    end
+  end
+end

data/lib/password_required/password_request.rb

@@ -0,0 +1,30 @@
+require 'password_required/password_request/hidden_inputs'
+
+module PasswordRequired
+  class PasswordRequest
+    include ActiveModel::Model
+
+    IGNORED_PARAMETER_KEYS = [:action, :controller]
+
+    delegate :env, :parameters, to: :@request
+
+    attr_accessor :password
+
+    def initialize(request)
+      @request = request
+      super({})
+    end
+
+    def target_url
+      env['ORIGINAL_FULLPATH']
+    end
+
+    def additional_params
+      parameters.except(*IGNORED_PARAMETER_KEYS)
+    end
+
+    def hidden_form_inputs
+      HiddenInputs.new(additional_params).to_s.html_safe
+    end
+  end
+end

data/lib/password_required/version.rb

@@ -0,0 +1,3 @@
+module PasswordRequired
+  VERSION = '0.1.0'
+end

data/lib/password_required.rb

@@ -0,0 +1,5 @@
+require 'password_required/engine'
+require 'password_required/controller_concern'
+
+module PasswordRequired
+end

data/lib/tasks/cucumber.rake

@@ -0,0 +1,65 @@
+# IMPORTANT: This file is generated by cucumber-rails - edit at your own peril.
+# It is recommended to regenerate this file in the future when you upgrade to a
+# newer version of cucumber-rails. Consider adding your own code to a new file
+# instead of editing this one. Cucumber will automatically load all features/**/*.rb
+# files.
+
+
+unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
+
+vendored_cucumber_bin = Dir["#{Rails.root}/vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
+$LOAD_PATH.unshift(File.dirname(vendored_cucumber_bin) + '/../lib') unless vendored_cucumber_bin.nil?
+
+begin
+  require 'cucumber/rake/task'
+
+  namespace :cucumber do
+    Cucumber::Rake::Task.new({:ok => 'test:prepare'}, 'Run features that should pass') do |t|
+      t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'default'
+    end
+
+    Cucumber::Rake::Task.new({:wip => 'test:prepare'}, 'Run features that are being worked on') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'wip'
+    end
+
+    Cucumber::Rake::Task.new({:rerun => 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+      t.binary = vendored_cucumber_bin
+      t.fork = true # You may get faster startup if you set this to false
+      t.profile = 'rerun'
+    end
+
+    desc 'Run all features'
+    task :all => [:ok, :wip]
+
+    task :statsetup do
+      require 'rails/code_statistics'
+      ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
+      ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
+    end
+  end
+  desc 'Alias for cucumber:ok'
+  task :cucumber => 'cucumber:ok'
+
+  task :default => :cucumber
+
+  task :features => :cucumber do
+    STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
+  end
+
+  # In case we don't have the generic Rails test:prepare hook, append a no-op task that we can depend upon.
+  task 'test:prepare' do
+  end
+
+  task :stats => 'cucumber:statsetup'
+rescue LoadError
+  desc 'cucumber rake task not available (cucumber not installed)'
+  task :cucumber do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+end

data/lib/tasks/password_required_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :password_required do
+#   # Task goes here
+# end

data/lib/tasks/rubocop.rake

@@ -0,0 +1,4 @@
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: password_required
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Benjamin Falk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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'
+description: Requires password for rails controller actions
+email:
+- benjamin.falk@yahoo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/password_required/application.js
+- app/assets/stylesheets/password_required/application.css
+- app/controllers/password_required/application_controller.rb
+- app/helpers/password_required/application_helper.rb
+- app/views/layouts/password_required/application.html.erb
+- app/views/password_request/new.html.erb
+- config/cucumber.yml
+- config/routes.rb
+- lib/password_required.rb
+- lib/password_required/controller_concern.rb
+- lib/password_required/controller_concern/arguments_composer.rb
+- lib/password_required/engine.rb
+- lib/password_required/password_request.rb
+- lib/password_required/password_request/hidden_inputs.rb
+- lib/password_required/version.rb
+- lib/tasks/cucumber.rake
+- lib/tasks/password_required_tasks.rake
+- lib/tasks/rubocop.rake
+homepage: https://github.com/benfalk/password_required
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Password Protection
+test_files: []