google-authenticator-rails 0.0.8 → 0.0.9

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    Y2MxMDMxMGNmZjZiYzgwNDc5NjAwNTFlMTYzOWJkZWE4NWMxNTM1OA==
+    NTVhNmM1YzE3YmNmNGQyZjVlNTQzNzYwZTJjMWJlZDUwOWVlNTE4Ng==
   data.tar.gz: !binary |-
-    NjRkNGQzMGJjMjgzNmU1ZjEyM2NhNmU1ZjRjYmNmZmU0NWQwZTUxZQ==
+    Y2RlNzVmNWJhODkxZDFiNmVhNjgxZjljYWQ5MjJlNDE3M2JiOWFmZA==
 SHA512:
   metadata.gz: !binary |-
-    NDkyN2M5YmYwYmNkNmI0NjEwMWQ0ZTY5NzNlNGY4Yjk0ZmMyMjE2ODk1Yjgw
-    OGFmZDQzY2M2ODcxYTA3NTllYjQyYmY1YzkxMThhYTI4MDlkODliZDc2ZmE0
-    YWRiMjAxZWI5N2E0ODRlNzVmMDc5MDI3YTBhZTg2ZThlZmU1ZTY=
+    Yzg4NzU1Y2Q4Njc5YWQwYTgyODgxNDg3MzBiOGU1NDUyNjEwZDQ5MGYyNGMz
+    N2M5MjIxMDg5YWFkMTViYjNlZWQ4NWFmYTcwNTlkYjQ3ZGIwY2M2YjI4ZTdh
+    ZjAyNDc5Zjk3NDNjMzQyZjY5OGZkNGRmOGFkM2Q0NzA2NzJjN2E=
   data.tar.gz: !binary |-
-    OTlkYmY5YmViYjgzZmNlNzZjYjgyYjU3ZDk2ZjkwZTU1Y2MwNmI2ZWJiNDIy
-    NDAzOTUyYjU5NDMzYTUzMDc2YzZkMWU5MDIwYzBkZTg0YTYyZWE1MWFhNzQx
-    YTFiNjUxZTU1MzA4NzM3ODcyNDE0NTUyNTNhNjFhYzliNzc5M2M=
+    YzM5NGU0NjUwYjU1NjZhNmE4ZWU1YWM3OGQ2M2U4NGMxNTU4MjhkZDM2YTJm
+    NzBjY2M5ZjIwZjY5YTJjODhiNmMyZDRjZjczN2JiODdlOTM1NDI0MGIyY2Fi
+    NjBlNGMyZDE0Y2FkODFjYjNiOWU1ZTM2NGFhZjhhZmIwNWI1ZDg=

data/.travis.yml

@@ -1,7 +1,6 @@
 language: ruby
 rvm:
   - 1.8.7
-  - 1.9.2
   - 1.9.3
   - 2.0.0
   - 2.1.0

data/README.md

@@ -4,7 +4,7 @@
 [![Build Status](https://secure.travis-ci.org/jaredonline/google-authenticator.png)](http://travis-ci.org/jaredonline/google-authenticator)
 [![Code Climate](https://codeclimate.com/github/jaredonline/google-authenticator.png)](https://codeclimate.com/github/jaredonline/google-authenticator)
 
-Rails (ActiveRecord) integration with the Google Authenticator apps for Android and the iPhone.  Uses the Authlogic style for cookie management.
+Rails (ActiveRecord) integration with the Google Authenticator apps for [Android](https://play.google.com/store/apps/details?id=com.google.android.apps.authenticator2) and the [iPhone](https://itunes.apple.com/us/app/google-authenticator/id388497605?mt=8).  Uses the Authlogic style for cookie management.
 
 ## Installation
 
@@ -32,20 +32,19 @@ end
 @user = User.new
 @user.set_google_secret           # => true
 @user.google_qr_uri               # => http://path.to.google/qr?with=params
-@user.google_authentic?(123456) # => true
+@user.google_authentic?(123456)   # => true
 ```
 
-Google Labels
-When setting up an account with the GoogleAuthenticator you need to provide
-a label for that account (to distinguish it from other accounts).
+## Google Labels
 
-GoogleAuthenticatorRails allows you to customize how the record will create
-that label.  There are three options:
-  - The default just uses the column "email" on the model
-  - You can specify a custom column with the :column_name option
+When setting up an account with `GoogleAuthenticatorRails` you need to provide a label for that account (to distinguish it from other accounts).
+
+`GoogleAuthenticatorRails` allows you to customize how the record will create that label.  There are three options:
+  - The default just uses the column `email` on the model
+  - You can specify a custom column with the `:column_name` option
   - You can specify a custom method via a symbol or a proc
 
-Examples:
+Example:
 
 ```ruby
 class User
@@ -78,6 +77,14 @@ end
 @user.google_label                    # => "TED@EXAMPLE.COM"
 ```
 
+Here's what the labels look like in Google Authenticator for iPhone:
+
+![iPhone Label Screenshot](http://jaredonline.github.io/google-authenticator/images/gar-label.png)
+
+## Google Secret
+The "google secret" is where `GoogleAuthenticatorRails` stores the
+secret token used to generate the MFA code.
+
 You can also specify a column for storing the google secret.  The default is `google_secret`.
 
 Example
@@ -92,6 +99,8 @@ end
 @user.mfa_secret 		 # => "56ahi483"
 ```
 
+## Lookup Token
+
 You can also specify which column the appropriate `MfaSession` subclass should use to look up the record:
 
 Example
@@ -104,24 +113,112 @@ end
 
 The above will cause the `UserMfaSession` class to call `User.where(:salt => cookie_salt)` or `User.scoped(:conditions => { :salt => cookie_salt })` to find the appropriate record.
 
+### A note about record lookup
+
+`GoogleAuthenticatorRails` makes one very large assumption when attempting to lookup a record. If your `MfaSession` subclass is named `UserMfaSession` it assumes you're trying to lookup a `User` record. Currently, there is no way to configure this, so if you're trying to lookup a `VeryLongModelNameForUser` you'll need to name your `MfaSession` subclass `VeryLongModelNameForUserMfaSession`.
+
+For example:
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  acts_as_google_authentic
+end
+
+# app/models/user_mfa_session.rb
+class UserMfaSession < GoogleAuthenticatorRails::Session::Base
+end
+```
+
+### A note about cookie creation and `Session::Persistence::TokenNotFound`
+
+`GoogleAuthenticatorRails` looks up the record based on the cookie created when you call `MfaSession#create`. The `#create` method looks into the record class (in our example, `User`) and looks at the configured `:lookup_token` option. It uses that option to save two pieces of information into the cookie, the `id` of the record and the token, which defaults to `persistence_token`. `persistence_token` is what Authlogic uses, which this gem was originally designed to work with.
+
+This can cause a lot of headaches if the model isn't configured correctly, and will cause a `GoogleAuthenticatorRails::Session::Persistence::TokenNotFound` error.
+
+This error appears for one of three reasons:
+
+1. `user` is `nil`
+2. `user` doesn't respond to `:persistence_token`
+3. `user.persistence_token` is blank
+
+For example:
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  acts_as_google_authentic
+end
+
+# Model has attributes:
+# id:   integer
+# name: string
+# salt: string
+
+# app/models/user_mfa_session.rb
+class UserMfaSession < GoogleAuthenticatorRails::Session::Base
+end
+
+# app/controllers/mfa_session_controller.rb
+def class MfaSessionController < ApplicationController
+  def create
+    UserMfaSession.create(user) # => Error: GoogleAuthenticatorRails::Session::Persistence::TokenNotFound
+  end
+end
+```
+
+The above example will fail because the `User` class doesn't have a `persistence_token` method. The fix for this is to configure `actions_as_google_authentic` to use the right column:
+
+```ruby
+# app/models/user.rb
+class User < ActiveRecord::Base
+  acts_as_google_authentic :lookup_token => :salt
+end
+
+# Model has attributes:
+# id:   integer
+# name: string
+# salt: string
+
+# app/models/user_mfa_session.rb
+class UserMfaSession < GoogleAuthenticatorRails::Session::Base
+end
+
+# app/controllers/mfa_session_controller.rb
+def class MfaSessionController < ApplicationController
+  def create
+    UserMfaSession.create(user)
+  end
+end
+```
+
+This call to `#create` will succeed (as long as `user.salt` is not `nil`).
+
+
+## Issuer
+
 You can also specify a name for the 'issuer' (the name of the website) where the user is using this token:
 
 Example
 
 ```ruby
 class User
-  acts_as_google_authenticated :issuer => 'your_site.com'
+  acts_as_google_authenticated :issuer => 'example.com'
 end
 ```
 
-By this way your user will have the name of your site at the authenticator card besides the current token.
+This way your user will have the name of your site at the authenticator card besides the current token.
+
+Here's what the issuers look like in Google Authenticator for iPhone:
+
+![iPhone Label Screenshot](http://jaredonline.github.io/google-authenticator/images/gar-issuer.png)
 
 ## Sample Rails Setup
 
-This is a very rough outline of how GoogleAuthenticatorRails is meant to manage the sessions and cookies for a Rails app.
+This is a very rough outline of how `GoogleAuthenticatorRails` is meant to manage the sessions and cookies for a Rails app.
 
 ```ruby
-Gemfile
+# Gemfile
 
 gem 'rails'
 gem 'google-authenticator-rails'
@@ -137,7 +234,7 @@ end
 ```
 
 ```ruby
-app/models/users.rb
+# app/models/users.rb
 
 class User < ActiveRecord::Base
   acts_as_google_authenticated
@@ -147,7 +244,7 @@ end
 If you want to authenticate based on a model called `User`, then you should name your session object `UserMfaSession`.
 
 ```ruby
-app/models/user_mfa_session.rb
+# app/models/user_mfa_session.rb
 
 class UserMfaSession <  GoogleAuthenticatorRails::Session::Base
   # no real code needed here
@@ -155,7 +252,7 @@ end
 ```
 
 ```ruby
-app/controllers/user_mfa_session_controller.rb
+# app/controllers/user_mfa_session_controller.rb
 
 class UserMfaSessionController < ApplicationController
   
@@ -178,7 +275,7 @@ end
 ```
 
 ```ruby
-app/controllers/application_controller.rb
+# app/controllers/application_controller.rb
 
 class ApplicationController < ActionController::Base
   before_filter :check_mfa
@@ -192,9 +289,12 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+## Other configuration
+
 By default, the cookie related to the MfaSession expires in 24 hours, but this can be changed:
+
 ```ruby
-config/initializers/google_authenticator_rails.rb
+# config/initializers/google_authenticator_rails.rb
 
 GoogleAuthenticatorRails.time_until_expiration = 1.month
 ```
@@ -211,3 +311,4 @@ GoogleAuthenticatorRails.time_until_expiration = 1.month
 ## License
 
 MIT.
+

data/gemfiles/rails2.3.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    google-authenticator-rails (0.0.7)
+    google-authenticator-rails (0.0.9)
       actionpack
       activerecord (< 4.0.0)
       google-qr

data/gemfiles/rails3.0.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    google-authenticator-rails (0.0.7)
+    google-authenticator-rails (0.0.9)
       actionpack
       activerecord (< 4.0.0)
       google-qr

data/gemfiles/rails3.1.gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    google-authenticator-rails (0.0.7)
+    google-authenticator-rails (0.0.9)
       actionpack
       activerecord (< 4.0.0)
       google-qr

data/gemfiles/rails3.2..gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: ../
   specs:
-    google-authenticator-rails (0.0.7)
+    google-authenticator-rails (0.0.9)
       actionpack
       activerecord (< 4.0.0)
       google-qr

data/lib/google-authenticator-rails/active_record/acts_as_google_authenticated.rb

@@ -77,7 +77,8 @@ module GoogleAuthenticatorRails # :nodoc:
         #                           to "google_secret"
         #   [:lookup_token] the column to use to find the record from the DB, defaults
         #                   to "persistence_token"
-        #   [:issuer] the name of the issuer to appear at the app (is optional)
+        #   [:issuer] the name of the issuer to appear in the app (optional), defaults
+        #             to ""
         def acts_as_google_authenticated(options = {})
           @google_label_column  = options[:column_name]           || :email
           @google_label_method  = options[:method]                || :default_google_label_method

data/lib/google-authenticator-rails/active_record/helpers.rb

@@ -6,22 +6,10 @@ module GoogleAuthenticatorRails # :nodoc:
         save
       end
 
-      # TODO: Remove this method in version 0.0.4
-      def set_google_secret!
-        put "DEPRECATION WARNING: #set_google_secret! is no longer being used, use #set_google_secret instead. #set_google_secret! will be removed in 0.0.4. Called from #{Kernel.caller[0]}"
-        set_google_secret
-      end
-
       def google_authentic?(code)
         GoogleAuthenticatorRails.valid?(code, google_secret_value)
       end
 
-      # TODO: Remove this method in version 0.0.4
-      def google_authenticate(code)
-        put "DEPRECATION WARNING: #google_authenticate is no longer being used, use #google_authentic? instead. #google_authenticate will be removed in 0.0.4. Called from #{Kernel.caller[0]}"
-        google_authentic?(code)
-      end
-
       def google_qr_uri
         GoogleQR.new(:data => ROTP::TOTP.new(google_secret_value, :issuer => google_issuer).provisioning_uri(google_label), :size => "200x200").to_s
       end

data/lib/google-authenticator-rails/version.rb

@@ -1,7 +1,7 @@
 module Google
   module Authenticator
     module Rails
-      VERSION = "0.0.8"
+      VERSION = "0.0.9"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-authenticator-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Jared McFarland
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-10 00:00:00.000000000 Z
+date: 2014-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rotp