# 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(),
            transform: (integer, [{String.t(), String.t()}, ...], String.t() -> any),
            auth_required: true | false
          }
    @enforce_keys [:method, :headers, :url, :transform]
    defstruct [
      :method,
      :headers,
      :url,
      :body,
      :transform,
      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)
  end
end