river's Introduction

River

NOTE: River is a work in progress and should be considered extremely beta.

River is a general-purpose HTTP client with eventual hopes of full HTTP/2 support (along with support for HTTP/1.1). It is built from the ground up with three major goals:

be fully compliant with RFC 7540
be simple and straightforward to use, in the vein of HTTPoison
be awesome, in the same way that Go's http library (which has built-in, transparent support for HTTP/2) is awesome.

Installation

Add River to your list of dependencies in mix.exs:

def deps do
  [{:river, "~> 0.0.6"}]
end

Ensure River is started before your application:

def application do
  [applications: [:river]]
end

Caveats

Currently, River only knows how to make HTTP/2 requests to https:// endpoints. Soon, I'll add the ability to make a request via the Upgrade header so that requests to http:// endpoints will work as well.
River doesn't currently speak HTTP/1.x. Once I finish up basic HTTP/2 support, HTTP1.x is next on the roadmap. The goal when using River in your project is that you should not need to know whether the underlying connection is using HTTP/2 or HTTP/1.x.
River is as beta as it gets, and under active development with no promises of anything being backwards compatible 😬 (until we hit v1.0, of course)

Goals

Basic HTTP/2 support
HTTP/1 --> HTTP/2 upgrading
Full HTTP/2 support
Full HTTP/1.x support

Basic Usage

Simple GET

River.get("https://http2.golang.org/")
=> {:ok,
 %River.Response{__status: :ok,
  body: "<html>\n<body>\n<h1>Go...",
  closed: true, code: 200, content_type: "text/html; charset=utf-8",
  headers: headers: [{":status", "200"},
                     {"content-type", "text/html; charset=utf-8"},
                     {"content-length", "1708"},
                     {"date", "Fri, 30 Sep 2016 04:26:34 GMT"}]}}

Simple PUT

River.put("https://example.com/", "hello world")
=> {:ok, %River.Response{...}}

Request with timeout

# timeout unit is milliseconds
River.get("https://http2.golang.org/", timeout: 10)
=> {:error, :timeout}

river's People

Contributors

Stargazers

Watchers

river's Issues

proxy

If I understand correctly, the proxy is not supported at the moment? Is it planned to support a proxy?

Currently, the flow control windows (incremented via WINDOW_UPDATE frames) are very naively managed, and we don't properly handle the separate connection and stream flow control windows. We should be much better about that.

Dynamic supervisor not found.

Howdy.

First up excited that someone has started working on this project. I am having a go at implementing a HTTP/2.0 server and want to use river for testing. unfortunetly I get this error.

== Compilation error on file lib/river/stream_supervisor.ex ==
** (CompileError) lib/river/stream_supervisor.ex:3: module Experimental.DynamicSupervisor is not loaded and could not be found
    (elixir) expanding macro: Kernel.use/1
    lib/river/stream_supervisor.ex:3: River.StreamSupervisor (module)
    (elixir) lib/kernel/parallel_compiler.ex:117: anonymous fn/4 in Kernel.ParallelCompiler.spawn_compilers/1

Am using elixir 1.4.5

Recommend Projects

peburrows / river Goto Github PK