module SslRequirement

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Public Class Methods

included(controller) click to toggle source

# File lib/ssl_requirement.rb, line 22
def self.included(controller)
  controller.extend(ClassMethods)
  controller.before_filter(:ensure_proper_protocol)
end

Protected Instance Methods

ssl_allowed?() click to toggle source

# File lib/ssl_requirement.rb, line 45
def ssl_allowed?
  ssl_actions_include_current_action(:ssl_allowed_actions)
end

ssl_host() click to toggle source

# File lib/ssl_requirement.rb, line 49
def ssl_host
  request.host
end

ssl_required?() click to toggle source

Returns true if the current action is supposed to run as SSL

# File lib/ssl_requirement.rb, line 41
def ssl_required?
  ssl_actions_include_current_action(:ssl_required_actions)
end

Private Instance Methods

ensure_proper_protocol() click to toggle source

# File lib/ssl_requirement.rb, line 68
def ensure_proper_protocol
  must_turn_on = (not request.ssl? and ssl_required?)
  must_turn_off = (request.ssl? and not ssl_allowed? and not ssl_required?)

  return if not must_turn_on and not must_turn_off

  protocol = (must_turn_on ? 'https' : 'http')
  path = request.respond_to?(:fullpath) ? request.fullpath : request.request_uri
  redirect_to "#{protocol}://#{ssl_host}#{path}"
  flash.keep
  return false
end

ssl_actions_include_current_action(name) click to toggle source

# File lib/ssl_requirement.rb, line 55
def ssl_actions_include_current_action (name)
  actions = self.class.read_inheritable_attribute(name)
  return unless actions
  actions = [:all] if actions.empty?
  return true if actions.include? :all

  if actions.first.is_a? Hash and actions.first[:except]
    not actions.first[:except].map(&:to_sym).include?(params[:action].to_sym)
  else
    actions.map(&:to_sym).include?(params[:action].to_sym)
  end
end