module Crest

Overview

This module's static methods are the entry point for using the Crest client.

Supported HTTP methods: .get, .put, .post, .patch .delete, .options, .head

Examples:

Crest.get(
  "http://httpbin.org/get",
  headers: {"Content-Type" => "image/jpg"},
  params: {"lang" => "en"}
)

Crest.post(
  "http://httpbin.org/post",
  headers: {"Access-Token" => ["secret1", "secret2"]},
  form: {"fizz" => "buz"},
  logging: true,
)

Crest.get("http://httpbin.org/stream/5") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Defined in:

Constant Summary

EXCEPTIONS_MAP = {} of Int32 => Crest::RequestFailed.class

HTTP_METHODS = ["get", "delete", "post", "put", "patch", "options", "head"] of ::String

STATUSES = ({} of Int32 => String).tap do |statuses| HTTP::Status.each do |status| if description = status.description statuses[status.code] = description end end end

Hash of HTTP status code => standard-library description.

USER_AGENT = "Crest/#{Crest::VERSION} (Crystal/#{Crystal::VERSION})"

VERSION = {{ (`shards version /home/runner/work/crest/crest/src`).chomp.stringify }}

Class Method Summary

• .delete(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

  Execute a DELETE request and and yields the Crest::Response to the block.

• .delete(url : String, form = {} of String => String, **args) : Crest::Response

  Execute a DELETE request and returns a Crest::Response.

• .get(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

  Execute a GET request and and yields the Crest::Response to the block.

• .get(url : String, form = {} of String => String, **args) : Crest::Response

  Execute a GET request and returns a Crest::Response.

• .head(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

  Execute a HEAD request and and yields the Crest::Response to the block.

• .head(url : String, form = {} of String => String, **args) : Crest::Response

  Execute a HEAD request and returns a Crest::Response.

• .options(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

  Execute a OPTIONS request and and yields the Crest::Response to the block.

• .options(url : String, form = {} of String => String, **args) : Crest::Response

  Execute a OPTIONS request and returns a Crest::Response.

• .patch(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

  Execute a PATCH request and and yields the Crest::Response to the block.

• .patch(url : String, form = {} of String => String, **args) : Crest::Response

  Execute a PATCH request and returns a Crest::Response.

• .post(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

  Execute a POST request and and yields the Crest::Response to the block.

• .post(url : String, form = {} of String => String, **args) : Crest::Response

  Execute a POST request and returns a Crest::Response.

• .put(url : String, form = {} of String => String, **args, &block : Crest::Response -> ) : Nil

  Execute a PUT request and and yields the Crest::Response to the block.

• .put(url : String, form = {} of String => String, **args) : Crest::Response

  Execute a PUT request and returns a Crest::Response.

Class Method Detail

Crest.delete("http://httpbin.org/delete") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Crest.delete("http://httpbin.org/delete")

Crest.get("http://httpbin.org/get") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Crest.get("http://httpbin.org/get")

Crest.head("http://httpbin.org/head") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Crest.head("http://httpbin.org/head")

Crest.options("http://httpbin.org/options") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Crest.options("http://httpbin.org/options")

Crest.patch("http://httpbin.org/patch") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Crest.patch("http://httpbin.org/patch")

Crest.post("http://httpbin.org/post") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Crest.post("http://httpbin.org/post")

Crest.put("http://httpbin.org/put") do |response|
  while line = response.body_io.gets
    puts line
  end
end

Crest.put("http://httpbin.org/put")