strong_password_field 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68384e3f32d4684b5bf4d10172c5e8225ec45d229933269b8e9bf16e8579b9d2
+  data.tar.gz: a547b1cbaee57b341bd614453d16d5989f9caecee6f177f167e59e49481ad998
+SHA512:
+  metadata.gz: 0dd7fadd29ad02aec724d3cf4ce15e5f932acaa232daa1561ff5f66d95c7c8f8f333ddb7ff61da530a101efc1796cf3daccf9c2035dd9182ce57a030ea2cf213
+  data.tar.gz: ac8eed6aec68d50cebaefd5333c26206a0001649f59acb6befdb6f1178843c37e85d8039fc4e1be37bd870cfa6995d01ac680586c91837501e9de820efee14e6

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 gaotongfei
+
+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,55 @@
+# StrongPasswordField
+Rails engine for password strength checking
+
+## Usage
+
+```ruby
+class User < ApplicationRecord
+  include StrongPasswordField
+
+  has_strong_password :password
+end
+```
+
+```html
+<%= form_for @user do |f| %>
+  <%= f.strong_password_field :password %>
+  <div class="password-strength-meter">
+  </div>
+<% end %>
+```
+
+```javascript
+//= require strong_password_field
+//= require zxcvbn
+
+document.addEventListener('DOMContentLoaded', function() {
+  var strongPasswordField = new StrongPasswordField({
+    strengthMeterSelector: '.password-strength-meter'
+  });
+  strongPasswordField.validate();
+});
+```
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'strong_password_field'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install strong_password_field
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'StrongPasswordField'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/strong_password_field.rb

@@ -0,0 +1,36 @@
+require 'strong_password_field/railtie'
+require 'strong_password_field/form_helpers'
+require 'strong_password_field/strategies/zxcvbn_strategy'
+
+module StrongPasswordField
+  def self.included(base)
+    base.send :include, InstanceMethods
+    base.extend ClassMethods
+
+    base.class_attribute :spf_password_field
+    base.class_attribute :strategy
+    base.class_attribute :minimal_strength
+    # available security levels are: [:worst, :bad, :weak, :good, :strong]
+    base.class_attribute :spf_options
+
+    base.validate :strong_password_validate
+  end
+
+  module ClassMethods
+    def has_strong_password(field=:password, **options)
+      self.spf_password_field = field
+      self.spf_options = options
+    end
+
+  end
+
+  module InstanceMethods
+    def strong_password_validate(strategy_adapter = Strategies::ZxcvbnStrategy.new)
+      validate(strategy_adapter, self)
+    end
+
+    def validate(strategy_adapter, model_object)
+      strategy_adapter.validate(model_object)
+    end
+  end
+end

data/lib/strong_password_field/form_helpers.rb

@@ -0,0 +1,14 @@
+module StrongPasswordField
+  module FormHelper
+    def strong_password_field(object_name, method, options = {})
+      options.merge!(data: { strong_password: true })
+      password_field(object_name, method, options)
+    end
+  end
+
+  module FormBuilder
+    def strong_password_field(method, options = {})
+      @template.strong_password_field(@object_name, method, options)
+    end
+  end
+end

data/lib/strong_password_field/railtie.rb

@@ -0,0 +1,12 @@
+module StrongPasswordField
+  class Railtie < ::Rails::Railtie
+
+    initializer 'strong_password_field.form_helpers' do
+      ActionView::Helpers::FormHelper.send(:include, StrongPasswordField::FormHelper)
+      ActionView::Helpers::FormBuilder.send(:include, StrongPasswordField::FormBuilder)
+    end
+
+    config.assets.paths << File.expand_path("../../../vendor/assets/javascripts", __FILE__)
+    config.assets.paths << File.expand_path("../../../vendor/assets/stylesheets", __FILE__)
+  end
+end

data/lib/strong_password_field/strategies/zxcvbn_strategy.rb

@@ -0,0 +1,51 @@
+require 'zxcvbn'
+
+module StrongPasswordField
+  module Strategies
+    class ZxcvbnStrategy
+      def initialize
+        @strength_lookup = {
+            0 => :worst,
+            1 => :bad,
+            2 => :weak,
+            3 => :good,
+            4 => :strong
+        }
+
+        @tester ||= Zxcvbn::Tester.new
+      end
+
+      def validate(model_object)
+        @options = model_object.spf_options
+        @password = model_object.send(model_object.spf_password_field)
+
+        result = @tester.test(@password)
+        @score = result.score
+        add_errors(model_object) if @score < security_score
+      end
+
+      private
+
+      def security_level
+        @security_level ||= @options.fetch(:security_level, :good)
+        unless valid_security_level.include?(@security_level)
+          raise StandardError, "security_level: #{@security_level} is not valid,
+                                use one of #{valid_security_level.join(', ')}"
+        end
+        @security_level
+      end
+
+      def security_score
+        @security_score ||= @strength_lookup.key(security_level)
+      end
+
+      def valid_security_level
+        %i[worst bad weak good strong]
+      end
+
+      def add_errors(model_object)
+        model_object.errors.add(:weak_password_error, 'password is not strong enough')
+      end
+    end
+  end
+end

data/lib/strong_password_field/version.rb

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

data/lib/tasks/strong_password_field_tasks.rake

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

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: strong_password_field
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- gaotongfei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-10-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.2.1
+- !ruby/object:Gem::Dependency
+  name: zxcvbn-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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: pry-byebug
+  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: Rails engine for password strength checking
+email:
+- gaotongfei1995@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/strong_password_field.rb
+- lib/strong_password_field/form_helpers.rb
+- lib/strong_password_field/railtie.rb
+- lib/strong_password_field/strategies/zxcvbn_strategy.rb
+- lib/strong_password_field/version.rb
+- lib/tasks/strong_password_field_tasks.rake
+homepage: https://github.com/gaotongfei/strong_password_field
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Rails engine for password strength checking
+test_files: []