rotp 1.0.0 → 1.1.0

data/lib/rotp/totp.rb

@@ -3,28 +3,43 @@ module ROTP
 
     attr_reader :interval
 
+    # @option options [Integer] interval (30) the time interval in seconds for OTP
+    #     This defaults to 30 which is standard.
     def initialize(s, options = {})
       @interval = options[:interval] || 30
       super
     end
 
+    # Accepts either a Unix timestamp integer or a Time object.
+    # Time objects will be adjusted to UTC automatically
+    # @param [Time/Integer] time the time to generate an OTP for
     def at(time)
       unless time.class == Time
         time = Time.at(time.to_i)
       end
-      generate_otp(timehash(time))
+      generate_otp(timecode(time))
     end
 
+    # Generate the current time OTP
+    # @return [Integer] the OTP as an integer
     def now
-      generate_otp(timehash(Time.now))
+      generate_otp(timecode(Time.now))
+    end
+
+    # Returns the provisioning URI for the OTP
+    # This can then be encoded in a QR Code and used
+    # to provision the Google Authenticator app
+    # @param [String] name of the account
+    # @return [String] provisioning uri
+    def provisioning_uri(name)
+      "otpauth://totp/#{URI.encode(name)}?secret=#{secret}"
     end
 
     private
 
-    def timehash(time)
+    def timecode(time)
       i = time.utc.to_i * 1000
-      i = i / (interval * 1000)
-      i
+      i / (interval * 1000)
     end
 
   end

data/lib/rotp/version.rb

@@ -1,3 +1,3 @@
-module Rotp
-  VERSION = "1.0.0"
+module ROTP
+  VERSION = "1.1.0"
 end

data/rotp.gemspec

@@ -4,11 +4,11 @@ require "rotp/version"
 
 Gem::Specification.new do |s|
   s.name        = "rotp"
-  s.version     = Rotp::VERSION
+  s.version     = ROTP::VERSION
   s.platform    = Gem::Platform::RUBY
   s.authors     = ["Mark Percival"]
   s.email       = ["mark@markpercival.us"]
-  s.homepage    = ""
+  s.homepage    = "http://github.com/mdp/rotp"
   s.summary     = %q{A Ruby library for generating and verifying one time passwords}
   s.description = %q{Works for both HOTP and TOTP, and include QR Code provisioning}
 

data/spec/base_spec.rb

@@ -1,5 +1,15 @@
 require 'spec_helper'
 
+describe "generating a random base32 secret" do
+  it "should be 16 characters by default" do
+    ROTP.random_base32.length.should == 16
+    ROTP.random_base32.should match /[a-z2-7].+/
+  end
+  it "should be allow a specific length" do
+    ROTP.random_base32(32).length.should == 32
+  end
+end
+
 describe "HOTP example values from the rfc" do
   it "should match the RFC" do
     # 12345678901234567890 in Bas32
@@ -16,6 +26,10 @@ describe "HOTP example values from the rfc" do
     hotp.at(8).should ==(399871)
     hotp.at(9).should ==(520489)
   end
+  it "should output its provisioning URI" do
+    hotp = ROTP::HOTP.new("wrn3pqx5uqxqvnqr")
+    hotp.provisioning_uri('mark@percival').should == "otpauth://hotp/mark@percival?secret=wrn3pqx5uqxqvnqr&counter=0"
+  end
 end
 
 describe "TOTP example values from the rfc" do
@@ -32,4 +46,9 @@ describe "TOTP example values from the rfc" do
       totp.now.should ==(102705)
     end
   end
+
+  it "should output its provisioning URI" do
+    totp = ROTP::TOTP.new("wrn3pqx5uqxqvnqr")
+    totp.provisioning_uri('mark@percival').should == "otpauth://totp/mark@percival?secret=wrn3pqx5uqxqvnqr"
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rotp
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 19
   prerelease: 
   segments: 
   - 1
+  - 1
   - 0
-  - 0
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors: 
 - Mark Percival
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-12 00:00:00 -08:00
+date: 2011-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,8 +45,28 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - Gemfile
+- README.markdown
 - Rakefile
+- doc/ROTP/HOTP.html
+- doc/ROTP/OTP.html
+- doc/ROTP/TOTP.html
+- doc/Rotp.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file.README.html
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - lib/rotp.rb
 - lib/rotp/hotp.rb
 - lib/rotp/otp.rb
@@ -56,7 +76,7 @@ files:
 - spec/base_spec.rb
 - spec/spec_helper.rb
 has_rdoc: true
-homepage: ""
+homepage: http://github.com/mdp/rotp
 licenses: []
 
 post_install_message: