HttpProxy

Simple multi HTTP Proxy using Plug. Base implementation is inspired by https://github.com/josevalim/proxy.

MY GOAL

Record/Play proxied requests
- http_proxy support multi port and multi urls on one execution command mix proxy.
Support VCR

Quick use as http proxy

set application and deps

mix.exs

def application do
  [applications: [:logger, :http_proxy]] # logger is option. :http_request is not need if you run http_proxy with HttpProxy.start/0 or stop/0.
end

...

defp deps do
  [
    {:http_proxy, "~> 0.5.2"}
  ]
end

set configure

config/config.exs

use Mix.Config

config :http_proxy,
  proxies: [
             %{port: 8080,  # proxy all request even play or record
               to:   "http://google.com"},
             %{port: 8081,
               to:   "http://yahoo.com"}
            ]

To manage logger, you should define logger settings like the following.

config :logger, :console,
  level: :info

solve deps and run server

$ mix deps.get
$ mix run --no-halt # start proxy server

If you would like to start production mode, you should run with MIX_ENV=prod like the following command.

$ MIX_ENV=prod mix run --no-halt

launch browser

Launch browser and open http://localhost:8080 or http://localhost:8081.

Configuration

When :record and :play are false, then the http_proxy works just multi port proxy.
When :record is true, then the http_proxy works to record request which is proxied.
When :play is true, then the http_proxy works to play request between this the http_proxy and clients.
- You should set JSON files under mappings in play_path.

use Mix.Config

config :http_proxy,
  proxies: [
             %{port: 8080,  # proxy all request even play or record
               to:   "http://google.com"},
             %{port: 8081,
               to:   "http://yahoo.com"}
            ]
  timeout: 20_000, # ms
  record: false, # true: record requests. false: don&#39;t record.
  play: false,   # true: play stored requests. false: don&#39;t play.
  export_path: "test/example",
  play_path: "test/data"

Example

Record request as the following

{
  "request": {
    "headers": [],
    "method": "GET",
    "options": {
      "aspect": "query_params"
    },
    "remote": "127.0.0.1",
    "request_body": "",
    "url": "http://localhost:8080/hoge/inu?email=neko&pass=123"
  },
  "response": {
    "body_file": "path/to/body_file.json",
    "cookies": {},
    "headers": {
      "Cache-Control": "public, max-age=2592000",
      "Content-Length": "251",
      "Content-Type": "text/html; charset=UTF-8",
      "Date": "Sat, 21 Nov 2015 00:37:38 GMT",
      "Expires": "Mon, 21 Dec 2015 00:37:38 GMT",
      "Location": "http://www.google.com/hoge/inu?email=neko&pass=123",
      "Server": "sffe",
      "X-Content-Type-Options": "nosniff",
      "X-XSS-Protection": "1; mode=block"
    },
    "status_code": 301
  }
}

Response body will save in "path/to/body_file.json".

Play request with the following JSON data

Example is https://github.com/KazuCocoa/http_proxy/tree/master/test/data/mappings
You can set path or path_pattern as attribute under request.
- If path, the http_proxy check requests are matched completely.
- If path_pattern, the http_proxy check requests are matched with Regex.

`path` case

{
  "request": {
    "path": "/request/path",
    "port": 8080,
    "method": "GET"
  },
  "response": {
    "body": "<html>hello world</html>",
    "cookies": {},
    "headers": {
      "Content-Type": "text/html; charset=UTF-8",
      "Server": "GFE/2.0"
    },
    "status_code": 200
  }
}

`path_pattern` case

Pattern match with Regex.match?(Regex.compile!("\A/request.*neko\z"), request_path)

{
  "request": {
    "path_pattern": "\A/request.*neko\z",
    "port": 8080,
    "method": "GET"
  },
  "response": {
    "body": "<html>hello world2</html>",
    "cookies": {},
    "headers": {
      "Content-Type": "text/html; charset=UTF-8",
      "Server": "GFE/2.0"
    },
    "status_code": 200
  }
}

TODO

record request
- should able to encode cookies: Use JSX to decode into jsons.
- format to like vrc
play request
- implement simple case
- expand them
- verify template json format
refactor
- file structures
- append test cases
- Add @spec
- prepare document
support Regex request path.
start/stop http_proxy manually
use vcr <= a bit...
- integrate https://github.com/parroty/exvcr

LICENSE

MIT. Please read LICENSE.