Sha256: fc76995c3853edb80912994e5f7893eaeaf59b1aa47ed1252fc20ab77f34e8e8

Contents?: true

Size: 1.63 KB

Versions: 18

Compression:

Stored size: 1.63 KB

Contents

require 'sinatra/base'

module Sinatra
  # = Sinatra::RequiredParams
  #
  # Ensure required query parameters
  #
  # == Usage
  #
  # Set required query parameter keys in the argument.
  # It'll halt with 400 if required keys don't exist.
  #
  #   get '/simple_keys' do
  #     required_params :p1, :p2
  #   end
  #
  # Complicated pattern is also fine.
  #
  #   get '/complicated_keys' do
  #     required_params :p1, :p2 => [:p3, :p4]
  #   end
  #
  # === Classic Application
  #
  # In a classic application simply require the helpers, and start using them:
  #
  #     require "sinatra"
  #     require "sinatra/required_params"
  #
  #     # The rest of your classic application code goes here...
  #
  # === Modular Application
  #
  # In a modular application you need to require the helpers, and then tell
  # the application to use them:
  #
  #     require "sinatra/base"
  #     require "sinatra/required_params"
  #
  #     class MyApp < Sinatra::Base
  #       helpers Sinatra::RequiredParams
  #
  #       # The rest of your modular application code goes here...
  #     end
  #
  module RequiredParams
    def required_params(*keys)
      _required_params(params, *keys)
    end

    private

    def _required_params(p, *keys)
      keys.each do |key|
        if key.is_a?(Hash)
          _required_params(p, *key.keys)
          key.each do |k, v|
            _required_params(p[k.to_s], v)
          end
        elsif key.is_a?(Array)
          _required_params(p, *key)
        else
          halt 400 unless p && p.respond_to?(:has_key?) && p.has_key?(key.to_s)
        end
      end
      true
    end
  end

  helpers RequiredParams
end

Version data entries

18 entries across 15 versions & 2 rubygems

Version Path
sinatra-contrib-2.2.4 lib/sinatra/required_params.rb
sinatra-contrib-2.2.3 lib/sinatra/required_params.rb
sinatra-contrib-2.2.2 lib/sinatra/required_params.rb
sinatra-contrib-2.2.1 lib/sinatra/required_params.rb
devcycle-ruby-server-sdk-1.1.0 examples/sinatra/vendor/bundle/ruby/2.6.0/gems/sinatra-contrib-2.1.0/lib/sinatra/required_params.rb
devcycle-ruby-server-sdk-1.1.0 examples/sinatra/vendor/bundle/ruby/2.6.0/gems/sinatra-contrib-2.2.0/lib/sinatra/required_params.rb
devcycle-ruby-server-sdk-1.1.0 examples/sinatra/vendor/bundle/ruby/3.0.0/gems/sinatra-contrib-2.1.0/lib/sinatra/required_params.rb
devcycle-ruby-server-sdk-1.1.0 examples/sinatra/vendor/bundle/ruby/3.1.0/gems/sinatra-contrib-2.1.0/lib/sinatra/required_params.rb
sinatra-contrib-2.2.0 lib/sinatra/required_params.rb
sinatra-contrib-2.1.0 lib/sinatra/required_params.rb
sinatra-contrib-2.0.8.1 lib/sinatra/required_params.rb
sinatra-contrib-2.0.8 lib/sinatra/required_params.rb
sinatra-contrib-2.0.7 lib/sinatra/required_params.rb
sinatra-contrib-2.0.6 lib/sinatra/required_params.rb
sinatra-contrib-2.0.5 lib/sinatra/required_params.rb
sinatra-contrib-2.0.4 lib/sinatra/required_params.rb
sinatra-contrib-2.0.3 lib/sinatra/required_params.rb
sinatra-contrib-2.0.2 lib/sinatra/required_params.rb