active_model_otp 1.0.0 → 1.1.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjdjOTMxYzkxNjI1MGM0ODdiZmNkZmFiYTZiMjBlZjc4ZTQzMjg2Mw==
-  data.tar.gz: !binary |-
-    ZTQ4OGJlNTQzOTViZWEzNDU1MWU1YmQ3Y2Q5Njc3ZDQ0ZjdmMDVkYQ==
+SHA1:
+  metadata.gz: 9d9aedb666900aee840275449fcdb4c2fb912c27
+  data.tar.gz: de9ef98a499709f05a3a836cd50242c74f8b1fdf
 SHA512:
-  metadata.gz: !binary |-
-    YWIyZDViZGE0YWRhYjc2M2YyZjRkYWVhMDI3NjA4YjgxMzRhY2E1MjNkOWM4
-    MmE5YjZlOTlhYmVkMDhkZjNjZjMzOTYzNzkzNTQ0ODZjMGEzOTRjZTc1OGNj
-    NDYwNDRiNmEzNmNjZWJhYTQxNzdhNzE2MzBjYzVhNjFhMzAzMWQ=
-  data.tar.gz: !binary |-
-    YjdkNDlkYmRjNWM1MTRlZDQzZTMwNzFkZGE4OGMwMzU5NmQ1YWExMDY4YTA2
-    NTMwOTgwYWE5NjdkM2M1MzdiMDc3MGZhMWM0YWUzMDA2NDFlNDFmNWM3ZTlk
-    Y2ViODliODQ4YzQxYmY1Y2UyNWNiYjIzY2QwMDQzZDllNWFhYjQ=
+  metadata.gz: bc0e46abcdae3948c4ea3bf51d92848ecc887d83efb611f7828b830d45f4d2372e0aa45d1c229e627de6e5d404c1ebb626d4c130ed6a3f14980cae6de33da122
+  data.tar.gz: 302bcfde4c0b3d33355cf44ed9b8896a1f83c615c3fafdc9c741ae171955ab78197e5de9b31ac0a4cc7d60fd801c2718c08949f7fc724e8b821e852d10a67179

data/.travis.yml

@@ -1,11 +1,10 @@
 rvm:
   - 1.9.3
   - 2.0.0
+  - 2.1
 matrix:
   include:
     - rvm: jruby
       env: JRUBY_OPTS="--1.9 --server -Xcext.enabled=true"
-    - rvm: jruby-head
-      env: JRUBY_OPTS="--1.9 --server -Xcext.enabled=true"
 notifications:
   email: false

data/CHANGELOG.md

@@ -1,3 +1,4 @@
+#unreleased
 #v1.0.0
 - Avoid overriding predefined otp_column value when initializing resource (Ilan Stern) https://github.com/heapsource/active_model_otp/pull/10
 - Pad OTP codes with less than 6 digits (Johan Brissmyr) https://github.com/heapsource/active_model_otp/pull/7

data/README.md

@@ -42,6 +42,14 @@ Note: If you're adding this to an existing user model you'll need to generate *o
 User.all.each { |user| user.update_attribute(:otp_secret_key, ROTP::Base32.random_base32) }
 ```
 
+For use a custom column for store the secret key field you can us the column_name option
+
+```ruby
+class User < ActiveRecord::Base
+  has_one_time_password column_name: :my_otp_secret_column
+end
+```
+
 
 ##Usage
 
@@ -133,7 +141,7 @@ puts "Current code #{user.otp_code}"
 - [Generate QR code with rqrcode gem](https://github.com/heapsource/active_model_otp/wiki/Generate-QR-code-with-rqrcode-gem)
 - Generating QR Code with Google Charts API
 - [Sendind code via email with Twilio](https://github.com/heapsource/active_model_otp/wiki/Send-code-via-Twilio-SMS)
-- Using with Mongoid
+- [Using with Mongoid](https://github.com/heapsource/active_model_otp/wiki/Using-with-Mongoid)
 
 ## Contributing
 

data/active_model_otp.gemspec

@@ -23,5 +23,5 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest", "~> 5.4.2"
 end

data/lib/active_model/one_time_password.rb

@@ -3,14 +3,18 @@ module ActiveModel
     extend ActiveSupport::Concern
 
     module ClassMethods
+
       def has_one_time_password(options = {})
 
         cattr_accessor :otp_column_name
+        class_attribute :otp_digits
+
         self.otp_column_name = (options[:column_name] || "otp_secret_key").to_s
+        self.otp_digits = options[:length] || 6
 
         include InstanceMethodsOnActivation
 
-        before_create { self.otp_column ||= ROTP::Base32.random_base32 }
+        before_create { self.otp_regenerate_secret if !self.otp_column}
 
         if respond_to?(:attributes_protected_by_default)
           def self.attributes_protected_by_default #:nodoc:
@@ -21,8 +25,12 @@ module ActiveModel
     end
 
     module InstanceMethodsOnActivation
+      def otp_regenerate_secret
+        self.otp_column = ROTP::Base32.random_base32
+      end
+
       def authenticate_otp(code, options = {})
-        totp = ROTP::TOTP.new(self.otp_column)
+        totp = ROTP::TOTP.new(self.otp_column, {digits: self.otp_digits})
         if drift = options[:drift]
           totp.verify_with_drift(code, drift)
         else
@@ -38,7 +46,7 @@ module ActiveModel
           time = options
           padding = true
         end
-        ROTP::TOTP.new(self.otp_column).at(time, padding)
+        ROTP::TOTP.new(self.otp_column, {digits: self.otp_digits}).at(time, padding)
       end
 
       def provisioning_uri(account = nil)
@@ -53,7 +61,6 @@ module ActiveModel
       def otp_column=(attr)
         self.send("#{self.class.otp_column_name}=", attr)
       end
-
     end
   end
 end

data/lib/active_model/otp/version.rb

@@ -1,5 +1,5 @@
 module ActiveModel
   module Otp
-    VERSION = "1.0.0"
+    VERSION = "1.1.0"
   end
 end

data/test/models/user.rb

@@ -7,5 +7,4 @@ class User
   attr_accessor :otp_secret_key, :email
 
   has_one_time_password
-
 end

data/test/models/visitor.rb

@@ -6,7 +6,6 @@ class Visitor
   define_model_callbacks :create
   attr_accessor :otp_token, :email
 
-  has_one_time_password :column_name  => :otp_token
-
+  has_one_time_password column_name: :otp_token, length: 4
 end
 

data/test/one_time_password_test.rb

@@ -5,6 +5,7 @@ class OtpTest < MiniTest::Unit::TestCase
     @user = User.new
     @user.email = 'roberto@heapsource.com'
     @user.run_callbacks :create
+
     @visitor = Visitor.new
     @visitor.email = 'roberto@heapsource.com'
     @visitor.run_callbacks :create
@@ -12,6 +13,7 @@ class OtpTest < MiniTest::Unit::TestCase
 
   def test_authenticate_with_otp
     code = @user.otp_code
+
     assert @user.authenticate_otp(code)
 
     code = @visitor.otp_code
@@ -28,13 +30,25 @@ class OtpTest < MiniTest::Unit::TestCase
 
   def test_otp_code
     assert_match(/^\d{6}$/, @user.otp_code.to_s)
-    assert_match(/^\d{6}$/, @visitor.otp_code.to_s)
+    assert_match(/^\d{4}$/, @visitor.otp_code.to_s)
+  end
+
+  def test_otp_code_with_specific_length
+    assert_match(/^\d{4}$/, @visitor.otp_code(time: 2160, padding: true).to_s)
+    assert_operator(@visitor.otp_code(time: 2160, padding: false).to_s.length, :<= , 4)
+  end
+
+  def test_otp_code_without_specific_length
+   assert_match(/^\d{6}$/, @user.otp_code(time: 2160, padding: true).to_s)
+   assert_operator(@user.otp_code(time: 2160, padding: false).to_s.length, :<= , 6)
   end
 
   def test_otp_code_padding
     @user.otp_column = 'kw5jhligwqaiw7jc'
     assert_match(/^\d{6}$/, @user.otp_code(time: 2160, padding: true).to_s)
-    assert_match(/^\d{3}$/, @user.otp_code(time: 2160, padding: false).to_s)
+    # Modified this spec as it is not guranteed that without padding we will always
+    # get a 3 digit number
+    assert_operator(@user.otp_code(time: 2160, padding: false).to_s.length, :<= , 6)
   end
 
   def test_provisioning_uri_with_provided_account
@@ -46,4 +60,10 @@ class OtpTest < MiniTest::Unit::TestCase
     assert_match %r{otpauth://totp/roberto@heapsource\.com\?secret=\w{16}}, @user.provisioning_uri
     assert_match %r{otpauth://totp/roberto@heapsource\.com\?secret=\w{16}}, @visitor.provisioning_uri
   end
+
+  def test_regenerate_otp
+    secret = @user.otp_column
+    @user.otp_regenerate_secret
+    assert secret != @user.otp_column
+  end
 end

data/test/test_helper.rb

@@ -6,7 +6,7 @@ $LOAD_PATH.unshift libdir unless $LOAD_PATH.include?(libdir)
 
 require "rubygems"
 require "active_model_otp"
-require "minitest/unit"
 require "minitest/autorun"
+require "minitest/unit"
 
 Dir["models/*.rb"].each {|file| require file }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_model_otp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Guillermo Iguaran
@@ -10,78 +10,78 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-01 00:00:00.000000000 Z
+date: 2014-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   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: rotp
   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: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !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'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 5.4.2
 description: Adds methods to set and authenticate against one time passwords. Inspired
   in AM::SecurePassword"
 email:
@@ -92,8 +92,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .travis.yml
+- ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -117,12 +117,12 @@ 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: []