Module: Sinatra::StrongParams

Defined in:
lib/sinatra/strong-params.rb,
lib/sinatra/strong-params/version.rb

Constant Summary collapse

VERSION = 
'0.1.0'

Class Method Summary collapse

Class Method Details

.registered(app) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/sinatra/strong-params.rb', line 10

def self.registered(app)
  #
  # A way to whitelist parameters.
  #
  #   get '/', allows: [:id, :action] do
  #     erb :index
  #   end
  #
  # Modifies the parameters available in the request scope.
  # Stashes unmodified params in @_params
  #
  app.set(:allows) do |*passable|
    condition do
      unless @params.empty?
        @_params = @_params || @params # for safety
        globals  = settings.globally_allowed_parameters
        needed   = @_needed || []
        passable = (globals | passable | needed).map(&:to_sym) # make sure it's a symbol

        # Keep only the allowed parameters.
        @params = @params.delete_if do |param, _value|
          !passable.include?(param.to_sym)
        end
      end
    end
  end

  #
  # A way to require parameters
  #
  #   get '/', needs: [:id, :action] do
  #     erb :index
  #   end
  #
  # Does not modify the parameters available to the request scope.
  # Raises a RequiredParamMissing error if a needed param is missing
  #
  app.set(:needs) do |*needed|
    condition do
      needed     = needed.map(&:to_sym) # make sure it's a symbol
      @_needed   = needed
      sym_params = @params.dup

      # symbolize the keys so we know what we're looking at
      sym_params.keys.each do |key|
        sym_params[(key.to_sym rescue key) || key] = sym_params.delete(key)
      end

      missing_params = needed.select { |key| sym_params[key].nil? || sym_params[key].empty? }
      if missing_params.any?
        fail RequiredParamMissing, "#{settings.missing_parameter_message} #{missing_params.join(', ')}"
      end
    end
  end

  # These will always pass through the 'allows' method
  # and will be mapped to symbols. I often use [:redirect_to, :_csrf] here
  # because I always want them to pass through for later processing
  app.set :globally_allowed_parameters, []

  # The default message when RequiredParamMissing is raised.
  app.set :missing_parameter_message, 'One or more required parameters were missing:'

  # Change the default behavior for missing parameters by overriding this route.
  # For example...
  #
  #   error RequiredParamMissing do
  #     flash[:error] = env['sinatra.error'].message
  #     redirect back
  #   end
  #
  app.error RequiredParamMissing do
    [400, env['sinatra.error'].message]
  end
end