https://github.com/poteto/terraform
A simple plug for incrementally transforming an API into Phoenix. Check out the blog post:
https://github.com/poteto/terraform
elixir phoenix plug reverse-proxy
Last synced: 8 months ago
JSON representation
A simple plug for incrementally transforming an API into Phoenix. Check out the blog post:
- Host: GitHub
- URL: https://github.com/poteto/terraform
- Owner: poteto
- License: mit
- Created: 2016-08-08T00:20:50.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-02-25T18:19:19.000Z (almost 5 years ago)
- Last Synced: 2025-04-03T09:08:26.035Z (10 months ago)
- Topics: elixir, phoenix, plug, reverse-proxy
- Language: Elixir
- Homepage: https://www.no.lol/2016-08-12-rise-from-the-ashes-incremental-apis-with-phoenix/
- Size: 19.5 KB
- Stars: 418
- Watchers: 10
- Forks: 13
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# terraform [](https://hex.pm/packages/terraform) [](https://travis-ci.com/poteto/terraform) 
Terraform is a simple `Plug` designed to work with Phoenix. Terraform allows you to incrementally transform a HTTP API into one powered by Phoenix - one endpoint at a time.
View the [demo Phoenix app](https://github.com/poteto/reverse_proxy).
## Phoenix Compatibility
This package is explicitly tested against the following Phoenix versions:
| Phoenix version | Compatibility |
| ------------- | ------------- |
| ~> 1.2.0 | ✅ |
| ~> 1.3.0 | ✅ |
| ~> 1.4.0 | ✅ |
| ~> 1.5.0 | ✅ |
## Installation
Add `terraform` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[{:terraform, "~> 1.0.1"}]
end
```
## Usage
First, add it to `web/router.ex`:
```elixir
defmodule MyApp.Router do
use Terraform, terraformer: MyApp.Terraformers.Foo
# ...
end
```
Then, define a new `Terraformer`, which uses `Plug.Router`. Any request that goes to a route that isn't defined on your Phoenix app will hit this plug, and you can then handle it using a familiar DSL. Refer to [hexdocs](https://hexdocs.pm/plug/Plug.Router.html) for documentation about `Plug.Router`.
Here's a basic example:
```elixir
defmodule MyApp.Terraformers.Foo do
alias MyApp.Clients.Foo # example client made with HTTPoison
use Plug.Router
plug :match
plug :dispatch
# match specific path
get "/v1/hello-world", do: send_resp(conn, 200, "Hello world")
# match all `get`s
get _ do
%{method: "GET", request_path: request_path, params: params, req_headers: req_headers} = conn
res = Foo.get!(request_path, req_headers, [params: Map.to_list(params)])
send_response({:ok, conn, res})
end
def send_response({:ok, conn, %{headers: headers, status_code: status_code, body: body}}) do
conn = %{conn | resp_headers: headers}
send_resp(conn, status_code, body)
end
end
```
### Reading the request body
`Plug` has an elegant solution to this problem using [`Plug.Conn.read_body`](https://hexdocs.pm/plug/Plug.Conn.html#read_body/2). Refer to this [comment](https://github.com/phoenixframework/phoenix/issues/459#issuecomment-440820663) for details.