Skip to content

Latest commit

 

History

History
136 lines (128 loc) · 3.9 KB

README.md

File metadata and controls

136 lines (128 loc) · 3.9 KB
Raw

Shot

shot is a small HTTP client library for Erlang

Hex.pm Version Coverage Status Build Status

Goals

Shot aims to provide a simple way for REST calls

Documentation

For examples will be used shot and test services for requests:

Build & Run

$ git clone https://github.com/vkatsuba/shot.git
$ cd shot
$ wget https://s3.amazonaws.com/rebar3/rebar3
$ chmod u+x ./rebar3
$ ./rebar3 shell

Dialyzer

$ ./rebar3 dialyzer

Run Common Tests

# See result in _build/test/logs after tests pass
$ ./rebar3 do xref, ct

Clean Project

$ ./rebar3 clean

Add shot to project: Rebar3

  • Edit file rebar.config:
{deps, [
    {shot, "1.1.0"},
]}.

PUT

% PUT without headers
shot:put("http://httpbin.org/put").
% PUT with headers
Data = #{
    u => "https://httpbin.org/anything",              % URL string, eg: "http://test.com"
    h => #{"Authorization" => "Bearer dXNlcjpwYXNz"}  % Headers
}.
shot:put(Data).

GET

% GET without headers
shot:get("http://httpbin.org/get").
% GET with headers
Data = #{
    u => "https://httpbin.org/bearer",                % URL string, eg: "http://test.com"
    h => #{"Authorization" => "Bearer dXNlcjpwYXNz"}  % Headers
}.
shot:get(Data).

POST

% POST without headers
shot:post("http://httpbin.org/post").
% POST with headers
Data = #{
    u => "https://httpbin.org/anything",                        % URL string, eg: "http://test.com"
    b => "{\"foo\":[\"bing\",2.3,true]}",                       % Body data
    ct => "application/json",                                   % Content-Type, eg: "text/html"
    h => #{"Authorization" => "Basic dmthdHN1YmE6JDFxMnczZTQk"} % Headers
}.
shot:post(Data).

DELETE

% DELETE without headers
shot:delete("http://httpbin.org/delete").
% DELETE with headers
Data = #{
    u => "https://httpbin.org/anything",              % URL string, eg: "http://test.com"
    h => #{"Authorization" => "Bearer dXNlcjpwYXNz"}  % Headers
}.
shot:delete(Data).

multipart/form-data

  • Create file file test.dat with any data
  • Go to the http://ptsv2.com
  • Click to the button New Random Toilet
  • Find on page field Post URL and copy Post URL
  • Prepare and create request:
ReqMap = #{
    m => post,                       % Method, can be POST, PUT atom only, eg: post, put
    u => "http://ptsv2.com/ID/post", % URL string, eg: "http://test.com"
    p => "/path/to/test.dat",        % Full path to file, eg: "/path/to/file.dat"
    o => [],                         % Options, eg: [{ssl,[[{ciphers,[{rsa,aes_128_cbc,sha}]}]]}]
    cd => "test-data",               % Content-Disposition, eg: "dat-model"
    ct => ""                         % Content-Type, eg: "application/json"
}.

shot:multipart(ReqMap).
% Response
{ok,{{"HTTP/1.1",200,"OK"},
     [{"date","Tue, 05 Mar 2019 20:38:51 GMT"},
      {"server","Google Frontend"},
      {"content-length","54"},
      {"content-type","text/html; charset=utf-8"},
      {"x-cloud-trace-context",
       "801e26cb1bec64bbf24fd1e9259893e9"}],
     "Thank you for this dump. I hope you have a lovely day!"}}
  • Back to Toilet page, refresh page and see block Dumps

To be continued ...

Support

v.katsuba.dev@gmail.com