browserid-rails 0.4.0 → 0.5.0

data/README.md

@@ -34,8 +34,8 @@ Configuration settings are properties of `config.browserid`.
 
 * `user_model` - The name of the ActiveModel class for application users.
   The default is `"User"`.
-* `email_field` - The name of the attribute on the user model which contains
-  the user's email. The default is `"email"`.
+* `email_field` - The attribute of the user model which contains the user's
+  email. The default is `:email`.
 * `session_variable` - The location the authenticated email is stored in the
   client's session. The default is `:browserid_email`.
 * `verifier` - The type of verifier to use to authenticate client BrowserID
@@ -52,6 +52,13 @@ Configuration settings are properties of `config.browserid`.
   a minor security risk. In production, this should be configured to a fixed
   value.
 
+Additionally, there are two sub-structures `login` and `logout` for configuring
+the associated paths and default link text. They have the following properties:
+
+* `text` - The default text to give login and logout links.
+* `path` - The target to give links and the path to `POST` authentication
+           requests to. Defaults to `"/login"` and `"/logout"` respectively.
+
 ### Controller Integration
 
 The `BrowserID::Rails::Base` module makes several controller methods available
@@ -119,15 +126,13 @@ of ways to control its behavior:
 
 Once that's accomplished, the app is ready to use BrowserID for authentication.
 To add login and logout links to the site, use the `login_link` and
-`logout_link` helpers. These accept optional link text and targets as parameters:
+`logout_link` helpers. These accept an optional link text as a parameter:
 
-    <%= login_link "Login with Persona" %>
+    <%= logout_link %>
 
-    <%= login_link "Login", auth_path %>
+    <%= login_link "Login with Persona" %>
 
-If the path is not provided, the link helpers will use `login_path` and
-`logout_path` if they are available, otherwise the link targets will be `#`.
-The coffeescript assets add on-click handlers to the links which trigger the
+The coffeescript asset adds on-click handlers to the links which trigger the
 Persona code to request new assertions or destroy existing ones.
 
 TODO: include Persona branding assets

data/app/assets/javascripts/browserid.js.coffee

@@ -25,26 +25,26 @@
   # default, it reloads the current page.
   onLogin: (data, status, xhr) ->
     if @debug
-      alert("Login result: #{status} #{data}")
+      alert("Login: #{status}\n#{data}")
     else
       window.location.reload()
 
   # Public: This method is called when a user fails to authenticate.
   onLoginError: (xhr, status, err) ->
-    alert("Login #{err} - #{xhr.responseText}")
+    alert("Login: #{status} #{err}\n#{xhr.responseText}")
 
   # Public: This method is called when a user clears their authentication. By
   # default, it reloads the current page.
   onLogout: (data, status, xhr) ->
     if @debug
-      alert("Logout result: #{status} #{data}")
+      alert("Logout: #{status}\n#{data}")
     else
       window.location.reload()
 
   # Public: This method is called when a user fails to clear their
   # authentication.
   onLogoutError: (xhr, status, err) ->
-    alert("Logout #{err} - #{xhr.responseText}")
+    alert("Logout: #{status} #{err}\n#{xhr.responseText}")
 
 
   ### INITIALIZATION ###

data/lib/browserid-rails.rb

@@ -8,22 +8,37 @@ module BrowserID
     # the library methods. The presence of this engine also causes assets to
     # be included when the gem is added as a dependency.
     class Engine < ::Rails::Engine
+      # Initialize the engine configuration.
       config.before_configuration do
-        BrowserIDConfig = Struct.new :user_model, :email_field, :session_variable, :verifier, :audience
+        BrowserIDConfig = Struct.new :user_model, :email_field, :session_variable, :verifier, :audience, :login, :logout
+        BrowserIDLinkConfig = Struct.new :text, :path
 
-        config.browserid = BrowserIDConfig.new
-        config.browserid.user_model = 'User'
-        config.browserid.email_field = 'email'
-        config.browserid.session_variable = :browserid_email
-        config.browserid.verifier = :persona
-        # config.browserid.audience should only be set in production
+        config.browserid = BrowserIDConfig.new.tap do |cfg|
+          cfg.user_model = 'User'
+          cfg.email_field = :email
+          cfg.session_variable = :browserid_email
+          cfg.verifier = :persona
+          # audience should only be set in production
+
+          cfg.login = BrowserIDLinkConfig.new.tap do |link|
+            link.text = "Login"
+            link.path = '/login'
+          end
+
+          cfg.logout = BrowserIDLinkConfig.new.tap do |link|
+            link.text = "Logout"
+            link.path = '/logout'
+          end
+        end
       end
 
-      initializer "browserid-rails.extend" do |app|
+      # Mix in the controller and view helper methods.
+      config.before_initialize do
         ActionController::Base.send :include, BrowserID::Rails::Base
         ActionView::Base.send :include, BrowserID::Rails::Helpers
       end
 
+      # Create the assertion verifier.
       config.after_initialize do
         cfg = config.browserid
 

data/lib/browserid/rails/base.rb

@@ -13,7 +13,7 @@ module BrowserID
       #
       # base - The Class this module is being included in.
       def self.included(base)
-        base.send :helper_method, :browserid_email, :current_user, :authenticated?
+        base.send :helper_method, :browserid_config, :browserid_email, :current_user, :authenticated?
       end
 
       # Internal: Gets the application configuration for this gem.
@@ -25,6 +25,44 @@ module BrowserID
 
 
 
+      ##### HELPER METHODS #####
+
+      # Public: Gets the email address of the currently-authenticated user.
+      #
+      # Returns the authenticated email address String.
+      def browserid_email
+        session[browserid_config.session_variable]
+      end
+
+      # Public: Retrieves the user for the authenticated email address. This
+      # method uses the `browserid.user_model` and `browserid.email_field`
+      # config settings, which default to `User` and `email`.
+      #
+      # Returns the current authenticated user, or nil if no user exists.
+      def current_user
+        if browserid_email.nil?
+          nil
+        elsif @current_user
+          @current_user
+        else
+          config = browserid_config
+          user_model = config.user_model.constantize
+          find_method = "find_by_#{config.email_field}".intern
+
+          @current_user = user_model.send find_method, browserid_email
+        end
+      end
+
+      # Public: Determines whether the current client is authenticated as a
+      # registered User.
+      #
+      # Returns true if the client is authenticated and registered.
+      def authenticated?
+        !current_user.nil?
+      end
+
+
+
       ##### AUTHENTICATION METHODS #####
 
       # Public: Sets the given email address as the currently-authenticated user.
@@ -84,47 +122,10 @@ module BrowserID
           head :ok
         end
       rescue StandardError => e
+        # TODO: distinguish between process failures and invalid assertions
         logger.warn "Failed to verify BrowserID assertion: #{e.message}"
         render status: :forbidden, text: e.message
       end
-
-
-
-      ##### HELPER METHODS #####
-
-      # Public: Gets the email address of the currently-authenticated user.
-      #
-      # Returns the authenticated email address String.
-      def browserid_email
-        session[browserid_config.session_variable]
-      end
-
-      # Public: Retrieves the user for the authenticated email address. This
-      # method uses the `browserid.user_model` and `browserid.email_field`
-      # config settings, which default to `User` and `email`.
-      #
-      # Returns the current authenticated user, or nil if no user exists.
-      def current_user
-        if browserid_email.nil?
-          nil
-        elsif @current_user
-          @current_user
-        else
-          config = browserid_config
-          user_model = config.user_model.constantize
-          find_method = "find_by_#{config.email_field}".intern
-
-          @current_user = user_model.send find_method, browserid_email
-        end
-      end
-
-      # Public: Determines whether the current client is authenticated as a
-      # registered User.
-      #
-      # Returns true if the client is authenticated and registered.
-      def authenticated?
-        !current_user.nil?
-      end
     end
   end
 end

data/lib/browserid/rails/helpers.rb

@@ -7,9 +7,11 @@ module BrowserID
       #
       # options - Hash used to adjust the browserid asset setup (default: {}).
       #           :login_path  - String giving the path to POST assertions to
-      #                          for verification.
+      #                          for verification. Defaults to the configured
+      #                          `browserid.login.path`.
       #           :logout_path - String giving the path to POST logout
-      #                          notifications to.
+      #                          notifications to. Defaults to the configured
+      #                          `browserid.logout.path`.
       #           :debug       - Boolean determining whether the browserid
       #                          javascript will refresh the page or show an
       #                          alert dialog.
@@ -32,29 +34,32 @@ module BrowserID
       #   <% end %>
       #
       def setup_browserid(options={}, &block)
+        defaults = { login_path: browserid_config.login.path, logout_path: browserid_config.logout.path }
         content_for :browserid_setup, capture(&block) if block_given?
-        render 'layouts/browserid', options: options
+        render 'layouts/browserid', options: defaults.merge(options)
       end
 
       # Public: Renders a login link which will request a new authentication
-      # assertion from the BrowserID javascript code.
+      # assertion from the BrowserID javascript code. The default link text is
+      # configurable with `config.browserid.login.text`. The link target is
+      # similarly configurable with `config.browserid.login.path`.
       #
-      # text - String to use as link text (default: 'Login').
-      # path - String path to link to. If not provided, the `login_path` helper
-      #        will be used if it exists. Otherwise, the link will be to '#'.
-      def login_link(text="Login", path=nil)
-        target = path || respond_to?(:login_path) && login_path || '#'
+      # text - Optional String to use as link text (default: configured value).
+      def login_link(text=nil)
+        text ||= browserid_config.login.text
+        target = browserid_config.login.path || '#'
         link_to text, target, class: :browserid_login
       end
 
       # Public: Renders a logout link which will clear the current BrowserID
-      # authentication status.
+      # authentication status. The default link text is configurable with
+      # `config.browserid.logout.text`. The link target is similarly
+      # configurable with `config.browserid.logout.path`.
       #
-      # text - String to use as link text (default: 'Logout').
-      # path - String path to link to. If not provided, the `logout_path` helper
-      #        will be used if it exists. Otherwise, the link will be to '#'.
-      def logout_link(text="Logout", path=nil)
-        target = path || respond_to?(:logout_path) && logout_path || '#'
+      # text - Optional String to use as link text (default: configured value).
+      def logout_link(text=nil)
+        text ||= browserid_config.logout.text
+        target = browserid_config.logout.path || '#'
         link_to text, target, class: :browserid_logout
       end
     end

data/lib/browserid/rails/version.rb

@@ -1,5 +1,5 @@
 module BrowserID
   module Rails
-    VERSION = "0.4.0"
+    VERSION = "0.5.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: browserid-rails
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,71 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: tzinfo
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - greg@mvxcvi.com
@@ -57,7 +121,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -488449078399574217
+      hash: 3271099203233204299
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -66,7 +130,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -488449078399574217
+      hash: 3271099203233204299
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24