tough 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0e9d013a769e0b9e80913839f560cc152157957a
+  data.tar.gz: 21ac87f307e202fdd1b5100a506b590d97ffa1fc
+SHA512:
+  metadata.gz: 4c8064c3723fcee6dacd02edab76f4a05779ff641267fd87dc2ea81375328ba576877a79a90cd005f43537137b98788e9254669c1357c0d32a3b701b83ce60e1
+  data.tar.gz: e886ced8d982a22e228f59d8026cfa8ba3d0f0ece40250f715e268d136192292d8a2db4a7a740b59f0fbd46e913a1edb378141cb72ad06f3b153343aa1e48c9d

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+sudo: false
+script: bundle exec rake && CODECLIMATE_REPO_TOKEN=8ba46fd5d9f5e9ce184d6a47895ec5a270d426dd1d95713a7a08e516e9769e3b bundle exec codeclimate-test-reporter
+notifications:
+  email: false
+rvm:
+  - '2.3.3'
+addons:
+  code_climate:
+    repo_token: 8ba46fd5d9f5e9ce184d6a47895ec5a270d426dd1d95713a7a08e516e9769e3b

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 cdeliens@gmail.com. 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,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in tough.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 cdeliens
+
+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,60 @@
+[![Build Status](https://travis-ci.org/cdeliens/tough.svg?branch=master)](https://travis-ci.org/cdeliens/tough)
+[![Code Climate](https://codeclimate.com/github/cdeliens/tough/badges/gpa.svg)](https://codeclimate.com/github/cdeliens/tough)
+[![Test Coverage](https://codeclimate.com/github/cdeliens/tough/badges/coverage.svg)](https://codeclimate.com/github/cdeliens/tough/coverage)
+[![Issue Count](https://codeclimate.com/github/cdeliens/tough/badges/issue_count.svg)](https://codeclimate.com/github/cdeliens/tough)
+
+# Tough
+
+Be sure to have TOUGH Passwords in your Rails application with this gem. Based on ZXCVBN library to validate passwords strength, also some normal validators for special characters, capital letters and lowercase letters, minimum characters length.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tough'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tough
+
+## Usage
+## config/initializers/tough.rb
+```ruby
+ Tough.configuration do |config|
+  config.zxcvbn_minimum_score_to_pass = 3
+  config.zxcvbn_error_message = "is too easy to guess"
+  config.special_characters_error_message = "must contain special characters"
+  config.minimum_characters = 8
+  config.minimum_characters_error_message = "must be a minimum of #{Tough.minimum_characters} characters long"
+  config.capitals_lowercase_error_message = "must have lowercase and uppercase letters"
+ end
+```
+## user.rb
+```ruby
+ class User < ActiveRecord::Base
+   validates_by_zxcvbn_metric :password
+   validates_capitals_and_lowercase_for :password
+   validates_minimum_characters_for :password
+   validates_special_characters_for :password
+ end
+```
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tough. 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](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test_suite.rb"]
+  t.warning = false
+end
+
+task :default => :test

data/bin/console

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

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/helpers/configuration.rb

@@ -0,0 +1,26 @@
+module Configuration
+
+  def configuration
+    yield self
+  end
+
+  def define_setting(name, default = nil)
+    class_variable_set("@@#{name}", default)
+
+    define_class_method "#{name}=" do |value|
+      class_variable_set("@@#{name}", value)
+    end
+
+    define_class_method name do
+      class_variable_get("@@#{name}")
+    end
+  end
+
+  private
+
+  def define_class_method(name, &block)
+   (class << self; self; end).instance_eval do
+     define_method name, &block
+   end
+  end
+end

data/lib/tough.rb

@@ -0,0 +1,37 @@
+require "tough/version"
+require 'helpers/configuration'
+
+
+module Tough
+  extend Configuration
+
+  require "zxcvbn"
+  require "tough/validators/capitals_and_lowercase_validator"
+  require "tough/validators/minimum_characters_validator"
+  require "tough/validators/special_characters_validator"
+  require "tough/validators/zxcvbn_password_validator"
+
+  define_setting :zxcvbn_minimum_score_to_pass, 3
+  define_setting :zxcvbn_error_message, "is too easy to guess"
+  define_setting :special_characters_error_message, "must contain special characters"
+  define_setting :minimum_characters, 8
+  define_setting :minimum_characters_error_message, "must be a minimum of #{Tough.minimum_characters} characters long"
+  define_setting :capitals_lowercase_error_message, "must have lowercase and uppercase letters"
+end
+
+# config/initializers/tough.rb
+# Tough.configuration do |config|
+#  config.zxcvbn_minimum_score_to_pass = 3
+#  config.zxcvbn_error_message = "is too easy to guess"
+#  config.special_characters_error_message = "must contain special characters"
+#  config.minimum_characters = 8
+#  config.minimum_characters_error_message = "must be a minimum of #{Tough.minimum_characters} characters long"
+#  config.capitals_lowercase_error_message = "must have lowercase and uppercase letters"
+# end
+
+# class User < ActiveRecord::Base
+#   validates_by_zxcvbn_metric :password
+#   validates_capitals_and_lowercase_for :password
+#   validates_minimum_characters_for :password
+#   validates_special_characters_for :password
+# end

data/lib/tough/validators/capitals_and_lowercase_validator.rb

@@ -0,0 +1,27 @@
+module ActiveModel
+  module Validations
+    class CapitalsAndLowercaseValidator < EachValidator
+      def validate_each(record, attribute, value)
+        unless value.match(/[a-z]/).present? && value.match(/[A-Z]/).present?
+          record.errors[attribute] << Tough.capitals_lowercase_error_message
+        end
+      end
+    end
+    module ClassMethods
+      # Validates whether or not the specified URL is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_url_format_of :site
+      #
+      #     # Validates against a list of valid TLD.
+      #     validates_url_format_of :site, tld: true
+      #   end
+      #
+      def validates_capitals_and_lowercase(*attr_names)
+        validates_with CapitalsAndLowercaseValidator, _merge_attributes(attr_names)
+      end
+
+      alias_method :validates_capitals_and_lowercase_for, :validates_capitals_and_lowercase
+    end
+  end
+end

data/lib/tough/validators/minimum_characters_validator.rb

@@ -0,0 +1,27 @@
+module ActiveModel
+  module Validations
+    class MinimumCharactersValidator < EachValidator
+      def validate_each(record, attribute, value)
+        unless value.length >= Tough.minimum_characters
+          record.errors[attribute] << Tough.minimum_characters_error_message
+        end
+      end
+    end
+    module ClassMethods
+      # Validates whether or not the specified URL is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_url_format_of :site
+      #
+      #     # Validates against a list of valid TLD.
+      #     validates_url_format_of :site, tld: true
+      #   end
+      #
+      def validates_minimum_characters(*attr_names)
+        validates_with MinimumCharactersValidator, _merge_attributes(attr_names)
+      end
+
+      alias_method :validates_minimum_characters_for, :validates_minimum_characters
+    end
+  end
+end

data/lib/tough/validators/special_characters_validator.rb

@@ -0,0 +1,27 @@
+module ActiveModel
+  module Validations
+    class SpecialCharactersValidator < EachValidator
+      def validate_each(record, attribute, value)
+        unless value.match(/\W/).present?
+          record.errors[attribute] << Tough.special_characters_error_message
+        end
+      end
+    end
+    module ClassMethods
+      # Validates whether or not the specified URL is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_url_format_of :site
+      #
+      #     # Validates against a list of valid TLD.
+      #     validates_url_format_of :site, tld: true
+      #   end
+      #
+      def validates_special_characters(*attr_names)
+        validates_with SpecialCharactersValidator, _merge_attributes(attr_names)
+      end
+
+      alias_method :validates_special_characters_for, :validates_special_characters
+    end
+  end
+end

data/lib/tough/validators/zxcvbn_password_validator.rb

@@ -0,0 +1,32 @@
+module ActiveModel
+  module Validations
+    class ZxcvbnPasswordValidator < EachValidator
+      def validate_each(record, attribute, value)
+        #0 too guessable: risky password. (guesses < 10^3)
+        #1 very guessable: protection from throttled online attacks. (guesses < 10^6)
+        #2 somewhat guessable: protection from unthrottled online attacks. (guesses < 10^8)
+        #3 safely unguessable: moderate protection from offline slow-hash scenario. (guesses < 10^10)
+        #4 very unguessable: strong protection from offline slow-hash scenario. (guesses >= 10^10)
+        unless Zxcvbn.test(value).score >= Tough.zxcvbn_minimum_score_to_pass
+          record.errors[attribute] << Tough.zxcvbn_error_message 
+        end
+      end
+    end
+    module ClassMethods
+      # Validates whether or not the specified URL is valid.
+      #
+      #   class User < ActiveRecord::Base
+      #     validates_url_format_of :site
+      #
+      #     # Validates against a list of valid TLD.
+      #     validates_url_format_of :site, tld: true
+      #   end
+      #
+      def validates_by_zxcvbn_metric(*attr_names)
+        validates_with ZxcvbnPasswordValidator, _merge_attributes(attr_names)
+      end
+
+      alias_method :validates_with_zxcvbn, :validates_by_zxcvbn_metric
+    end
+  end
+end

data/lib/tough/version.rb

@@ -0,0 +1,3 @@
+module Tough
+  VERSION = "0.3.0"
+end

data/tough.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tough/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "tough"
+  spec.version       = Tough::VERSION
+  spec.authors       = ["cdeliens"]
+  spec.email         = ["deliens@me.com"]
+
+  spec.summary       = %q{Password Validators including Dropbox ZXCVBN algorithim}
+  spec.description   = %q{Password Validators including Dropbox ZXCVBN algorithim}
+  spec.homepage      = "https://github.com/cdeliens/tough"
+  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.
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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.13"
+  spec.add_development_dependency "activerecord", ">= 3.0"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "pry-meta"
+  spec.add_runtime_dependency "zxcvbn-ruby", "~> 0.1.1"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: tough
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- cdeliens
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !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: 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: minitest-utils
+  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-meta
+  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: zxcvbn-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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: Password Validators including Dropbox ZXCVBN algorithim
+email:
+- deliens@me.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/helpers/configuration.rb
+- lib/tough.rb
+- lib/tough/validators/capitals_and_lowercase_validator.rb
+- lib/tough/validators/minimum_characters_validator.rb
+- lib/tough/validators/special_characters_validator.rb
+- lib/tough/validators/zxcvbn_password_validator.rb
+- lib/tough/version.rb
+- tough.gemspec
+homepage: https://github.com/cdeliens/tough
+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.5.2
+signing_key: 
+specification_version: 4
+summary: Password Validators including Dropbox ZXCVBN algorithim
+test_files: []