Module: BrowserID::Rails::Helpers

Defined in:
lib/browserid/rails/helpers.rb

Overview

Public: Rails view helpers for use with BrowserID code.

Instance Method Summary collapse

Instance Method Details

Public: Renders a login link which will request a new authentication 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 - Optional String to use as link text (default: configured value).



48
49
50
51
52
 
# File 'lib/browserid/rails/helpers.rb', line 48

def (text=nil)
  text ||= browserid_config..text
  target = browserid_config..path || '#'
  link_to text, target, class: :browserid_login
end

#logout_link(text = nil) ⇒ Object

Public: Renders a logout link which will clear the current BrowserID 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 - Optional String to use as link text (default: configured value).



60
61
62
63
64
 
# File 'lib/browserid/rails/helpers.rb', line 60

def logout_link(text=nil)
  text ||= browserid_config.logout.text
  target = browserid_config.logout.path || '#'
  link_to text, target, class: :browserid_logout
end

#setup_browserid(options = {}, &block) ⇒ Object

Public: Renders a layout partial which initializes the BrowserID system. This should be called in the head of the application layout.

options - Hash used to adjust the browserid asset setup (default: {}).

:login_path  - String giving the path to POST assertions to
               for verification. Defaults to the configured
               `browserid.login.path`.
:logout_path - String giving the path to POST logout
               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.

block - An optional block which can be used to provide additional

content to be rendered inside the browserid setup script tag.

Examples

<!-- Perform basic BrowserID setup in the head section -->
<%= setup_browserid %>

<!-- Setup BrowserID with alert debugging -->
<%= setup_browserid debug: true %>

<!-- Setup BrowserID with a custom handler -->
<%= setup_browserid do %>
  browserid.onLogin = function (data, status, xhr) {
    // ...
  }
<% end %>



36
37
38
39
40
 
# File 'lib/browserid/rails/helpers.rb', line 36

def setup_browserid(options={}, &block)
  defaults = { login_path: browserid_config..path, logout_path: browserid_config.logout.path }
  content_for :browserid_setup, capture(&block) if block_given?
  render 'layouts/browserid', options: defaults.merge(options)
end