passwd 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a92e0fc9b057332f70b4adde83c0d52d39c837ad
-  data.tar.gz: fd0514c01725a3312fcc8b64591aa881a2584371
+  metadata.gz: 5f91e14eb692efe0d90d138bcc541788aec69c12
+  data.tar.gz: 67a298fe7246b5470272e55b11427262f44a245d
 SHA512:
-  metadata.gz: 040c613b3fe930cd550cacc68a47977ab7e6a56a02870135e897a4dacc76699aadf1ae8479b2efac63401c742e56719b560b0f2d613b6b3ce39aee1484e29a61
-  data.tar.gz: 3e475498013103b4d9bf6f5a0c35b9395ed92eb7d32df93ebbe151c4f605220dd336fc2098eb1574114723217d55444cc5a2756dedd71d3e1eeffe7ad1cb5da1
+  metadata.gz: 24d8d2da30dcd3cb480d114e0f637f594319095d21c7383071bb745217c374d14f0a7625f95c829d0389a1f62f20206f0028914a6f96d39e153636e24825cf9d
+  data.tar.gz: d11e78fc3350d5003e0fe96cde72fe13694ad4149997f41e6c73b0bd4105a9393114df219838e6977c32b91cfe98d6d7eb3ecff7fc70b30576146744b005da4d

data/README.md

@@ -49,8 +49,8 @@ Default config is stored in the class instance variable.
 Changing the default configs are as follows:
 
 ```ruby
-Passwd.config => Get config object.
-Passwd.config(length: 10) => Change to the default length.
+Passwd.config # => Get config object.
+Passwd.config(length: 10) # => Change to the default length.
 
 Passwd.configure do |c|
   c.length = 10
@@ -67,6 +67,29 @@ Options that can be specified:
 * :letters_upper => Define an array of upper case. default is ("A".."Z").to_a
 * :letters_number => Define an array of numbers. default is ("0".."9").to_a
 
+### Policy check
+
+Default policy is 8 more characters and require lower case and require number.
+
+```ruby
+Passwd.policy_check("secret") # => true or false
+```
+
+### Policy settings
+
+```ruby
+Passwd.policy_configure do |c|
+  c.min_length = 10
+end
+```
+
+Options that can be specified:
+
+* :min_length => Number of minimum characters. default is 8.
+* :require_lower => Require lower case if set true. default is true.
+* :require_upper => Require upper case if set true. default is false.
+* :require_number => Require number if set true. default is true.
+
 ### Password object
 
 Default password is randomly generated.
@@ -96,9 +119,12 @@ password == password.text # => true
 password == "invalid!!" # => false
 ```
 
-## For ActiveRecord User model
+## For ActiveRecord
+
+### User model
 
-model:
+Include `Passwd::ActiveRecord` module and define id/salt/password column from `define_column` method.  
+`id` column is required uniqueness.
 
 ```ruby
 class User < ActiveRecord::Base
@@ -110,7 +136,13 @@ class User < ActiveRecord::Base
 end
 ```
 
-Authentication:
+Available following method by defining id/salt/password column.
+
+### Authentication
+
+`authenticate` method is available in both instance and class.  
+Return the user object if the authentication successful.  
+Return the nil if authentication fails or doesn't exists user.
 
 ```ruby
 user = User.authenticate("foo@example.com", "secret") # => return user object or nil.
@@ -122,6 +154,8 @@ else
 end
 ```
 
+instance method is not required `id`.
+
 ```ruby
 user = User.find(params[:id])
 if user.authenticate("secret") # => return true or false
@@ -131,20 +165,24 @@ else
 end
 ```
 
-Change passowrd:
+### Change passowrd
+
+`set_password` method will be set random password.  
+Return value is plain text password.  
+To specify the password as an argument if you want to specify a password.  
+`salt` also set if salt is nil.
 
 ```ruby
 user = User.find(params[:id])
-# set random password. (salt also set if salt is nil)
-# return set password text.
-# set specified password if specified argument.
-#   user.set_password("secret")
 password_text = user.set_password
 
 if user.save
   NoticeMailer.change_mail(user, password_text).deliver
 end
 ```
+`update_password` method will be set new password if the authentication successful.  
+Return the nil if authentication fails.  
+But `update_password` method doesn't call `save` method.
 
 ```ruby
 user.find(params[:id])

data/lib/passwd/base.rb

@@ -1,10 +1,13 @@
 # coding: utf-8
 
+require "singleton"
 require "passwd/configuration/config"
 require "passwd/configuration/tmp_config"
+require "passwd/configuration/policy"
 
 module Passwd
   @config = Config.instance
+  @policy = Policy.instance
 
   module Base
     def create(options={})
@@ -38,9 +41,25 @@ module Passwd
     end
     alias :config :configure
 
+    def policy_configure(&block)
+      if block_given?
+        @policy.configure &block
+      else
+        @policy
+      end
+    end
+
+    def policy_check(password)
+      @policy.valid?(password, @config)
+    end
+
     def reset_config
       @config.reset
     end
+
+    def reset_policy
+      @policy.reset
+    end
   end
 
   extend Base

data/lib/passwd/configuration/config.rb

@@ -1,7 +1,5 @@
 # coding: utf-8
 
-require "singleton"
-
 require "passwd/configuration/abstract_config"
 
 module Passwd

data/lib/passwd/configuration/policy.rb

@@ -0,0 +1,46 @@
+# coding: utf-8
+
+module Passwd
+  class Policy
+    include Singleton
+
+    VALID_OPTIONS_KEYS = [
+      :min_length,
+      :require_lower,
+      :require_upper,
+      :require_number
+    ].freeze
+
+    attr_accessor *VALID_OPTIONS_KEYS
+
+    def initialize
+      reset
+    end
+
+    def configure
+      yield self
+    end
+
+    def valid?(password, config)
+      return false if self.min_length > password.size
+      return false if self.require_lower && !include_char?(config.letters_lower, password)
+      return false if self.require_upper && !include_char?(config.letters_upper, password)
+      return false if self.require_number && !include_char?(config.letters_number, password)
+      true
+    end
+
+    def include_char?(letters, strings)
+      strings.each_char do |c|
+        return true if letters.include? c
+      end
+      false
+    end
+
+    def reset
+      self.min_length = 8
+      self.require_lower = true
+      self.require_upper = false
+      self.require_number = true
+    end
+  end
+end

data/lib/passwd/version.rb

@@ -1,5 +1,5 @@
 # coding: utf-8
 
 module Passwd
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/spec/passwd/base_spec.rb

@@ -103,6 +103,57 @@ describe Passwd do
       end
     end
 
+    describe "#policy_configure" do
+      it "return policy object" do
+        expect(Passwd.policy_configure.is_a? Passwd::Policy).to be_true
+      end
+
+      it "set policy value from block" do
+        Passwd.policy_configure do |c|
+          c.min_length = 10
+        end
+        expect(Passwd.policy_configure.min_length).not_to eq(8)
+        expect(Passwd.policy_configure.min_length).to eq(10)
+      end
+    end
+
+    describe "#policy_check" do
+      it "Policy#valid? should be called" do
+        Passwd::Policy.instance.should_receive(:valid?).with("secret1234" ,Passwd::Config.instance)
+        expect(Passwd.policy_check("secret1234")).not_to raise_error
+      end
+    end
+
+    describe "#reset_policy" do
+      let(:policy) {Passwd::Policy.instance}
+      
+      before {
+        policy.configure do |c|
+          c.min_length = 20
+          c.require_lower = false
+          c.require_upper = true
+          c.require_number = false
+        end
+        Passwd.reset_policy
+      }
+
+      it "min_length should be a default" do
+        expect(policy.min_length).to eq(8)
+      end
+
+      it "require_lower should be a default" do
+        expect(policy.require_lower).to be_true
+      end
+
+      it "upper should be a default" do
+        expect(policy.require_upper).to be_false
+      end
+
+      it "number should be a default" do
+        expect(policy.require_number).to be_true
+      end
+    end
+
     describe "#reset_config" do
       let(:config) {Passwd::Config.instance}
       

data/spec/passwd/configuration/policy_spec.rb

@@ -0,0 +1,133 @@
+# coding: utf-8
+
+require "spec_helper"
+
+describe Passwd::Policy do
+  let(:policy) {Passwd::Policy.instance}
+
+  describe "defined accessors" do
+    it "defined min_length" do
+      expect(policy.respond_to? :min_length).to be_true
+    end
+
+    it "defined require_lower" do
+      expect(policy.respond_to? :require_lower).to be_true
+    end
+
+    it "defined require_upper" do
+      expect(policy.respond_to? :require_upper).to be_true
+    end
+
+    it "defined require_number" do
+      expect(policy.respond_to? :require_number).to be_true
+    end
+  end
+
+  describe "#initialize" do
+    it "min_length should be a default" do
+      expect(policy.min_length).to eq(8)
+    end
+
+    it "require_lower should be a default" do
+      expect(policy.require_lower).to be_true
+    end
+
+    it "require_upper should be a default" do
+      expect(policy.require_upper).to be_false
+    end
+
+    it "require_number should be a default" do
+      expect(policy.require_number).to be_true
+    end
+  end
+
+  describe "#configure" do
+    before {
+      policy.configure do |c|
+        c.min_length = 20
+        c.require_lower = false
+        c.require_upper = true
+        c.require_number = false
+      end
+    }
+
+    it "set min_length from block" do
+      expect(policy.min_length).to eq(20)
+    end
+
+    it "set require_lower from block" do
+      expect(policy.require_lower).to be_false
+    end
+
+    it "set require_upper from block" do
+      expect(policy.require_upper).to be_true
+    end
+
+    it "set require_number from block" do
+      expect(policy.require_number).to be_false
+    end
+  end
+
+  describe "#valid?" do
+    let(:config) {Passwd::Config.instance}
+
+    it "valid password should be valid" do
+      expect(policy.valid?("secret1234", config)).to be_true
+    end
+
+    it "short password should not valid" do
+      expect(policy.valid?("short1", config)).to be_false
+    end
+
+    it "password should not valid if not contain lower case" do
+      expect(policy.valid?("NOTLOWER12", config)).to be_false
+    end
+
+    it "password should not valid if not contain upper case" do
+      policy.configure {|c| c.require_upper = true}
+      expect(policy.valid?("notupper12", config)).to be_false
+    end
+
+    it "password should not valid if not contain number" do
+      expect(policy.valid?("notnumber", config)).to be_false
+    end
+  end
+
+  describe "#include_char?" do
+    it "should be return true if contains" do
+      expect(policy.include_char?(("a".."z").to_a, "contains")).to be_true
+    end
+
+    it "should be return false if not contains" do
+      expect(policy.include_char?(("a".."z").to_a, "NOTCONTAINS")).to be_false
+    end
+  end
+
+  describe "#reset" do
+    before {
+      policy.configure do |c|
+        c.min_length = 20
+        c.require_lower = false
+        c.require_upper = true
+        c.require_number = false
+      end
+      policy.reset
+    }
+
+    it "min_length should be a default" do
+      expect(policy.min_length).to eq(8)
+    end
+
+    it "require_lower should be a default" do
+      expect(policy.require_lower).to be_true
+    end
+
+    it "require_upper should be a default" do
+      expect(policy.require_upper).to be_false
+    end
+
+    it "require_number should be a default" do
+      expect(policy.require_number).to be_true
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -14,5 +14,6 @@ RSpec.configure do |config|
   config.order = "random"
   config.after do
     Passwd::Config.instance.reset
+    Passwd::Policy.instance.reset
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: passwd
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - i2bskn
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-07-10 00:00:00.000000000 Z
+date: 2013-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -71,6 +71,7 @@ files:
 - lib/passwd/base.rb
 - lib/passwd/configuration/abstract_config.rb
 - lib/passwd/configuration/config.rb
+- lib/passwd/configuration/policy.rb
 - lib/passwd/configuration/tmp_config.rb
 - lib/passwd/password.rb
 - lib/passwd/version.rb
@@ -78,6 +79,7 @@ files:
 - spec/passwd/active_record_spec.rb
 - spec/passwd/base_spec.rb
 - spec/passwd/configuration/config_spec.rb
+- spec/passwd/configuration/policy_spec.rb
 - spec/passwd/configuration/tmp_config_spec.rb
 - spec/passwd/password_spec.rb
 - spec/spec_helper.rb
@@ -109,6 +111,7 @@ test_files:
 - spec/passwd/active_record_spec.rb
 - spec/passwd/base_spec.rb
 - spec/passwd/configuration/config_spec.rb
+- spec/passwd/configuration/policy_spec.rb
 - spec/passwd/configuration/tmp_config_spec.rb
 - spec/passwd/password_spec.rb
 - spec/spec_helper.rb