Sha256: 2682a1479f142af3b1d20ce931b6390bb97b6c01e510f8291cc0cff76029b17e

Contents?: true

Size: 1.29 KB

Versions: 9

Compression:

Stored size: 1.29 KB

Contents

module Praxis
  class ActionDefinition
    class HeadersDSLCompiler < Attributor::DSLCompiler

      # it allows to define expectations on incoming headers. For example:
      # header :X_SpecialCookie                        => implies the header is required
      # header :X_Something, /matching_this/           => implies that if the name header exists, it should match the regexp
      # header :X_A_Header, "Specific String"          => implies that the value matches the string exactly
      # In any of the cases, other supported options might be passed
      # header :X_Something, /matching_this/ ,
      #                     required: true             => to make it required
      #                     description: "lorem ipsum" => to describe it (like any other attribute)

      def header(name, val=nil, **options)
        if val.kind_of?(Class)
          return key name, val, **options  
        end

        case val
        when Regexp
          options[:regexp] = val
        when String
          options[:values] = [val]
        when nil
          # Defining the existence without any other options can only mean that it is required (otherwise it is a useless definition)
          options[:required] = true if options.empty?
        end
        key name , String, **options
      end
    end
  end
end

Version data entries

9 entries across 9 versions & 1 rubygems

Version Path
praxis-2.0.pre.18 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.17 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.16 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.15 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.14 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.13 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.12 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.11 lib/praxis/action_definition/headers_dsl_compiler.rb
praxis-2.0.pre.10 lib/praxis/action_definition/headers_dsl_compiler.rb