gleam-lang / http Goto Github PK

View Code? Open in Web Editor NEW

176.0 8.0 22.0 182 KB

🕸️ Types and functions for HTTP clients and servers!

Home Page: https://hexdocs.pm/gleam_http/

License: Apache License 2.0

Erlang 4.36% JavaScript 1.05% Gleam 94.59%

gleam http types

http's Introduction

Gleam HTTP

Types and functions for HTTP clients and servers!

HTTP Service Example

import gleam/http/elli
import gleam/http/response.{type Response}
import gleam/http/request.{type Request}
import gleam/bytes_builder.{type BytesBuilder}

// Define a HTTP service
//
pub fn my_service(_request: Request(t)) -> Response(BytesBuilder) {
  let body = bytes_builder.from_string("Hello, world!")

  response.new(200)
  |> response.prepend_header("made-with", "Gleam")
  |> response.set_body(body)
}

// Start it on port 3000 using the Elli web server
//
pub fn main() {
  elli.become(my_service, on_port: 3000)
}

Server adapters

In the example above the Elli Erlang web server is used to run the Gleam HTTP service. Here's a full list of the server adapters available, sorted alphabetically.

Adapter	About
Mist	Mist is a high performance pure Gleam HTTP 1.1 server
cgi	cgi is a adapter for the Common Gateway Interface.
gleam_cowboy	Cowboy is an Erlang HTTP2 & HTTP1.1 web server
gleam_elli	Elli is an Erlang HTTP1.1 web server
gleam_plug	Plug is an Elixir web application interface

Client adapters

Client adapters are used to send HTTP requests to services over the network. Here's a full list of the client adapters available, sorted alphabetically.

Adapter	About
gleam_fetch	fetch is a HTTP client included with JavaScript
gleam_hackney	Hackney is a simple HTTP client for Erlang
gleam_httpc	httpc is a HTTP client included with Erlang

http's People

Contributors

Stargazers

Watchers

http's Issues

Patch release including the bug fix for Max-Age

Reminder to push a release to hex.pm

Can't be used with stdlib 0.10.1

I'm not sure how to resolve this in rebar land.
Is it possible to specify this library works with stdlib 0.10.1 and 0.10.0

`path_segments` should not include query or fragment with the final segment

/one/two?three=four#five

Should return

["one", "two"]

Missing tests

Many of the functions in this library do not have unit tests. Let's add them!

request.set_header shouldn't lowercase header values

request.set_header/3 lowercases the header value before adding it to the request record. This can easily break some common use cases such as using bearer token authentication.

Maybe the intent was to lowercase the header key, instead of the value, like prepend_header does?

get_req_origin should return Error(Nil) Instead of an option

https://hexdocs.pm/gleam_http/gleam/http/#get_req_origin

https://discord.com/channels/768594524158427167/768594524158427170/800044149650751510

Conflicting `None` definitions

The http module imports None from option.
And also defines SameSitePolicy.None.
When trying to run the tests I get:

error: Type mismatch
    â��â�� /home/sebastian/Source/sporto/http/src/gleam/http.gleam:151:15
    â��
151 â��     userinfo: None,
    â��               ^^^^

Expected type:

    Option(String)

Found type:

    SameSitePolicy

This might be a bit beyond the scope of this library but I always end up creating the following function. The purpose is to find the origin of a request, falling back to the referer header if origin is not present.

browsers may not send the Origin header, as in the following cases:

img tags will not send Origin headers unless the crossorigin attribute is set>
Chrome and Safari will not send Origin headers with same-origin GET requests
Firefox will not send the Origin header with any same-origin requests (bug)
Firefox will not send the Origin header with cross-origin form POSTs (bug)

However, in all of these cases, the browser does send a Referer header. We can make use of the Referer header, which browser-initiated requests may not spoof, in place of the missing Origin header

I would call it http.get_req_origin

Documentation example imports gleam/elli

gleam/elli is referenced, but there is no link to where you get this module.
I don't know how close this project is to being on hex, but even a link to the github project would be helpful

Multipart form parser

https://www.rfc-editor.org/rfc/rfc2045

elixir-plug/plug@c52b2f3

Scope of this library, stdlib integration

Stdlib inclusion

@lpil mentioned that I should use this library so that I was using a standard HTTP method type.
Probably the only way I would find this type was if it was in standard lib. It's so small I am very likely to just re-implement. Also if there is something that it is expected everyone should use then is that not an argument for inclusion in stdlib?

What shouldn't this library do?

This question I think should be fairly similar regardless of if it will be included in stdlib or not, an http library on the gleam-lang repo will become the defacto standard

I am currently working on a Request and Response Type in midas, and the set of associated utilities e.g http.get_header, http.set_header etc. Would you be interested in a PR to add these to this project?

request.new function that takes a URL string as an argument

request.new("https://example.com")

Panics if the URL string is invalid.

default response body should be bit builder.

For the same logic as this change #14

Add a `get_resp_cookie`

Missing the ability to fetch cookie information from a response.
Should ignore unknown attributes as specified in spec