1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
|
# Copyright 2019 Hubert Chathi <hubert@uhoreg.ca>
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
defmodule Polyjuice.Client.Endpoint do
@moduledoc false
defmodule HttpSpec do
@typedoc """
The description of how to handle the endpoint.
- `method` is the HTTP verb
- `headers` is a list of the HTTP headers
- `url` is the URL to call
- `body` is the HTTP body (if any)
- `transform` is a function to transform the result (status code, headers, content) to a return value
- `auth_required` indicates whether the end point requires authentication
"""
@type t :: %__MODULE__{
method: atom,
headers: [{String.t(), String.t()}],
url: String.t(),
body: String.t(),
auth_required: true | false
}
@enforce_keys [:method, :headers, :url]
defstruct [
:method,
:headers,
:url,
body: "",
auth_required: true
]
end
defprotocol Proto do
@moduledoc """
Matrix client endpoint.
"""
@doc """
Generate the spec for calling the endpoint via HTTP.
"""
@spec http_spec(
endpoint_args :: __MODULE__.t(),
base_url :: String.t()
) :: Polyjuice.Client.Endpoint.HttpSpec.t()
def http_spec(endpoint_args, base_url)
@doc """
Transform the HTTP result into a return value.
"""
@spec transform_http_result(
endpoint_args :: __MODULE__.t(),
status_code :: integer(),
headers :: [{String.t(), String.t()}, ...],
body :: String.t()
) :: any
def transform_http_result(endpoint_args, status_code, headers, body)
end
end
|
