module AuthlogicOpenid::ActsAsAuthentic::Methods

Public Class Methods

included(klass) click to toggle source

Set up some simple validations

# File lib/authlogic_openid/acts_as_authentic.rb, line 42
def self.included(klass)
  return if !klass.column_names.include?("openid_identifier")
  
  klass.class_eval do
    validates_uniqueness_of :openid_identifier, :scope => validations_scope, :if => :using_openid?
    validate :validate_openid
    validates_length_of_password_field_options validates_length_of_password_field_options.merge(:if => :validate_password_with_openid?)
    validates_confirmation_of_password_field_options validates_confirmation_of_password_field_options.merge(:if => :validate_password_with_openid?)
    validates_length_of_password_confirmation_field_options validates_length_of_password_confirmation_field_options.merge(:if => :validate_password_with_openid?)
  end
end

Public Instance Methods

openid_identifier=(value) click to toggle source

Set the openid_identifier field and also resets the persistence_token if this value changes.

# File lib/authlogic_openid/acts_as_authentic.rb, line 55
def openid_identifier=(value)
  write_attribute(:openid_identifier, value.blank? ? nil : OpenIdAuthentication.normalize_identifier(value))
  reset_persistence_token if openid_identifier_changed?
rescue OpenIdAuthentication::InvalidOpenId => e
  @openid_error = e.message
end
save(perform_validation = true) { |result| ... } click to toggle source

This is where all of the magic happens. This is where we hook in and add all of the OpenID sweetness.

I had to take this approach because when authenticating with OpenID nonces and what not are stored in database tables. That being said, the whole save process for ActiveRecord is wrapped in a transaction. Trying to authenticate with OpenID in a transaction is not good because that transaction be get rolled back, thus reversing all of the OpenID inserts and making OpenID authentication fail every time. So We need to step outside of the transaction and do our OpenID madness.

Another advantage of taking this approach is that we can set fields from their OpenID profile before we save the record, if their OpenID provider supports it.

# File lib/authlogic_openid/acts_as_authentic.rb, line 72
def save(perform_validation = true, &block)
  return false if perform_validation && block_given? && authenticate_with_openid? && !authenticate_with_openid
  result = super
  yield(result) if block_given?
  result
end

Private Instance Methods

attributes_to_save() click to toggle source

This method works in conjunction with map_saved_attributes.

Let’s say a user fills out a registration form, provides an OpenID and submits the form. They are then redirected to their OpenID provider. All is good and they are redirected back. All of those fields they spent time filling out are forgetten and they have to retype them all. To avoid this, AuthlogicOpenid saves all of these attributes in the session and then attempts to restore them. See the source for what attributes it saves. If you need to block more attributes, or save more just override this method and do whatever you want.

# File lib/authlogic_openid/acts_as_authentic.rb, line 127
def attributes_to_save # :doc:
  attrs_to_save = attributes.clone.delete_if do |k, v|
    [:id, :password, crypted_password_field, password_salt_field, :persistence_token, :perishable_token, :single_access_token, :login_count, 
      :failed_login_count, :last_request_at, :current_login_at, :last_login_at, :current_login_ip, :last_login_ip, :created_at,
      :updated_at, :lock_version].include?(k.to_sym)
  end
  attrs_to_save.merge!(:password => password, :password_confirmation => password_confirmation)
end
map_openid_registration(registration) click to toggle source

Override this method to map the OpenID registration fields with fields in your model. See the required_fields and optional_fields configuration options to enable this feature.

Basically you will get a hash of values passed as a single argument. Then just map them as you see fit. Check out the source of this method for an example.

# File lib/authlogic_openid/acts_as_authentic.rb, line 114
def map_openid_registration(registration) # :doc:
  self.name ||= registration[:fullname] if respond_to?(:name) && !registration[:fullname].blank?
  self.first_name ||= registration[:fullname].split(" ").first if respond_to?(:first_name) && !registration[:fullname].blank?
  self.last_name ||= registration[:fullname].split(" ").last if respond_to?(:last_name) && !registration[:last_name].blank?
end
map_saved_attributes(attrs) click to toggle source

This method works in conjunction with attributes_to_save. See that method for a description of the why these methods exist.

If the default behavior of this method is not sufficient for you because you have attr_protected or attr_accessible then override this method and set them individually. Maybe something like this would be good:

attrs.each do |key, value|
  send("#{key}=", value)
end

# File lib/authlogic_openid/acts_as_authentic.rb, line 144
def map_saved_attributes(attrs) # :doc:
  self.attributes = attrs
end