struct HTTP::Params

Overview

Represents a collection of http parameters and their respective values.

Defined in:

http/params.cr

Class Method Summary

Instance Method Summary

Instance methods inherited from struct Struct

==(other : self) : Bool ==, hash : Int32 hash, inspect(io : IO) : Nil inspect, to_s(io) to_s

Instance methods inherited from struct Value

==(other) ==

Instance methods inherited from class Object

!=(other) !=, !~(other) !~, ==(other) ==, ===(other)
===(other : YAML::Any)
===(other : JSON::Any) ===, =~(other) =~, class class, clone clone, crystal_type_id crystal_type_id, dup dup, hash hash, inspect
inspect(io : IO) inspect, itself itself, not_nil! not_nil!, tap(&block) tap, to_json to_json, to_pretty_json(io : IO)
to_pretty_json to_pretty_json, to_s
to_s(io : IO) to_s, to_yaml(io : IO)
to_yaml to_yaml, try(&block) try

Class methods inherited from class Object

==(other : Class) ==, ===(other) ===, cast(other) : self cast, from_json(string_or_io) : self from_json, from_yaml(string : String) : self from_yaml, hash hash, inspect(io) inspect, name : String name, to_s(io) to_s, |(other : U.class) |

Class Method Detail

def self.build(&block) : String #

Builds an url-encoded HTTP form/query.

The yielded object has an #add method that accepts two arguments, a key (String) and a value (String or Nil). Keys and values are escaped using URI#escape.

params = HTTP::Params.build do |form|
  form.add "color", "black"
  form.add "name", "crystal"
  form.add "year", "2012 - today"
end
params # => "color=black&name=crystal&year=2012%20-%20today"

[View source]
def self.parse(query : String, &block) #

Parses an HTTP query and yields each key-value pair

HTTP::Params.parse(query) do |key, value|
  # ...
end

[View source]
def self.parse(query : String) : self #

Parses an HTTP query string into a HTTP::Params

HTTP::Params.parse("foo=bar&foo=baz&qux=zoo")
#=> #<HTTP::Params @raw_params = {"foo" => ["bar", "baz"], "qux" => ["zoo"]}>

[View source]
def self.new(raw_params : Hash(String, Array(String))) #

[View source]

Instance Method Detail

def ==(other) #

[View source]
def ==(other : self) #

[View source]
def [](name) #

Returns first value for specified param name.

params["email"]              # => "john@example.org"
params["non_existent_param"] # KeyError

[View source]
def []=(name, value) #

Sets first value for specified param name.

params["item"] = "pencil"

[View source]
def []?(name) #

Returns first value or nil for specified param name.

params["email"]?              # => "john@example.org"
params["non_existent_param"]? # nil

[View source]
def add(name, value) #

Appends new value for specified param name. Creates param when there was no such param.

params.add("item", "keychain")
params.fetch_all("item") # => ["pencil", "book", "workbook", "keychain"]

[View source]
def delete(name) #

Deletes first value for provided param name. If there are no values left, deletes param itself. Returns deleted value.

params.delete("item")    # => "keychain"
params.fetch_all("item") # => ["keynote"]

params.delete("item") # => "keynote"
params["item"]        # KeyError

params.delete("non_existent_param") # KeyError

[View source]
def delete_all(name) #

Deletes all values for provided param name. Returns array of deleted values.

params.delete_all("comments") # => ["hello, world!", ":+1:"]
params.has_key?("comments")   # => false

[View source]
def each(&block) #

Allows to iterate over all name-value pairs.

params.each do |name, value|
  puts "#{name} => #{value}"
end

# Outputs:
# email => john@example.org
# item => keychain
# item => keynote

[View source]
def fetch(name, &block) #

Returns first value for specified param name. Fallbacks to return value of provided block when there is no such param.

params.fetch("email") { raise InvalidUser("email is missing") }    # InvalidUser "email is missing"
params.fetch("non_existent_param") { "default computed value" }    # => "default computed value"

[View source]
def fetch(name, default) #

Returns first value for specified param name. Fallbacks to provided default value when there is no such param.

params.fetch("email", "none@example.org")           # => "john@example.org"
params.fetch("non_existent_param", "default value") # => "default value"

[View source]
def fetch(name) #

Returns first value for specified param name.

params.fetch("email")              # => "john@example.org"
params.fetch("non_existent_param") # KeyError

[View source]
def fetch_all(name) #

Returns all values for specified param name.

params.fetch_all("item") # => ["pencil", "book", "workbook"]

[View source]
def has_key?(*args) #

Returns true if param with provided name exists.

params.has_key?("email")   # => true
params.has_key?("garbage") # => false

[View source]
def set_all(name, values) #

Sets all values for specified param name at once.

params.set_all("item", ["keychain", "keynote"])
params.fetch_all("item") # => ["keychain", "keynote"]

[View source]
def to_s(io) #

Serializes to string representation as http url encoded form

params.to_s # => "item=keychain&item=keynote&email=john@example.org"

[View source]