rotp 3.0.1 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8a81c9c19f20358ab16d62429767d58a02713f0a
-  data.tar.gz: 33806577d34a4da96b99424a5feb9a16f229657f
+  metadata.gz: c450bbb03ba621504bffd4d10d86beb9aa0df214
+  data.tar.gz: 13a046cf63204bea4517283ae0a2473becc67ceb
 SHA512:
-  metadata.gz: 61867eea08079d4478b0394209a6a076c1a1c518ac0365735ec71bacc3aa8b716f88bb591af19f8c5566122764ca581f3ce7dd041b53299a170edb7275621caf
-  data.tar.gz: c980bbb7d215597f050cf7318493fdf43dba6027771f9c233330b08b4e1909352d10456078c4738f8a321245e6e7a02d63cf38cd0b3a95c409a19cde7a96569c
+  metadata.gz: d76a02cc91e2de40619a99a925c3452546c31914fc0172918c40a68f405975b6ee293f437d91d49004b1e4074607f9f7abf8b266345ced389e9e313d6f0ab030
+  data.tar.gz: 08e82ddf0a585ee225a9d98b04cf0a22c7a386504f8f3db3936c07dc6231ecafa3f8f920fd9048b4606cb14080a194f7a4c333311735696d9016a88975d0c5b1

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 ### Changelog
 
+#### 3.1.0
+
+- Add Add digits paramater to provisioning URI. #54 from @sbc100
+
 #### 3.0.1
 
 - Use SecureRandom. See mdp/rotp/pull/52

data/lib/rotp/hotp.rb

@@ -38,7 +38,12 @@ module ROTP
     # @param [Integer] initial_count starting counter value, defaults to 0
     # @return [String] provisioning uri
     def provisioning_uri(name, initial_count=0)
-      encode_params("otpauth://hotp/#{URI.encode(name)}", :secret=>secret, :counter=>initial_count)
+      params = {
+        secret: secret,
+        counter: initial_count,
+        digits: digits == DEFAULT_DIGITS ? nil : digits
+      }
+      encode_params("otpauth://hotp/#{URI.encode(name)}", params)
     end
 
   end

data/lib/rotp/otp.rb

@@ -1,6 +1,7 @@
 module ROTP
   class OTP
     attr_reader :secret, :digits, :digest
+    DEFAULT_DIGITS = 6
 
     # @param [String] secret in the form of base32
     # @option options digits [Integer] (6)
@@ -11,7 +12,7 @@ module ROTP
     #     Google Authenticate only supports 'sha1' currently
     # @returns [OTP] OTP instantiation
     def initialize(s, options = {})
-      @digits = options[:digits] || 6
+      @digits = options[:digits] || DEFAULT_DIGITS
       @digest = options[:digest] || "sha1"
       @secret = s
     end

data/lib/rotp/totp.rb

@@ -58,8 +58,13 @@ module ROTP
       # For compatibility the issuer appears both before that account name and also in the
       # query string.
       issuer_string = issuer.nil? ? "" : "#{URI.encode(issuer)}:"
-      encode_params("otpauth://totp/#{issuer_string}#{URI.encode(name)}",
-                    :secret => secret, :period => (interval==30 ? nil : interval), :issuer => issuer)
+      params = {
+        secret: secret,
+        period: interval == 30 ? nil : interval,
+        issuer: issuer,
+        digits: digits == DEFAULT_DIGITS ? nil : digits,
+      }
+      encode_params("otpauth://totp/#{issuer_string}#{URI.encode(name)}", params)
     end
 
     private

data/lib/rotp/version.rb

@@ -1,3 +1,3 @@
 module ROTP
-  VERSION = "3.0.1"
+  VERSION = "3.1.0"
 end

data/spec/lib/rotp/hotp_spec.rb

@@ -82,6 +82,20 @@ RSpec.describe ROTP::HOTP do
     it 'includes the secret as parameter' do
       expect(params['secret'].first).to eq 'a' * 32
     end
+
+    context 'with default digits' do
+      it 'does not include digits parameter with default digits' do
+        expect(params['digits'].first).to be_nil
+      end
+    end
+
+    context 'with non-default digits' do
+      let(:hotp) { ROTP::HOTP.new('a' * 32, digits: 8) }
+
+      it 'includes digits parameter' do
+        expect(params['digits'].first).to eq '8'
+      end
+    end
   end
 
   describe '#verify_with_retries' do

data/spec/lib/rotp/totp_spec.rb

@@ -97,6 +97,20 @@ RSpec.describe ROTP::TOTP do
       end
     end
 
+    context 'with default digits' do
+      it 'does does not include digits parameter' do
+        expect(params['digits'].first).to be_nil
+      end
+    end
+
+    context 'with non-default digits' do
+      let(:totp)  { ROTP::TOTP.new 'JBSWY3DPEHPK3PXP', digits: 8 }
+
+      it 'does does not include digits parameter' do
+        expect(params['digits'].first).to eq '8'
+      end
+    end
+
     context 'with issuer' do
       let(:totp)  { ROTP::TOTP.new 'JBSWY3DPEHPK3PXP', issuer: 'FooCo' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rotp
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - Mark Percival
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-21 00:00:00.000000000 Z
+date: 2016-06-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: guard-rspec