defmodule Contentful.Delivery.Spaces do
  @moduledoc """
  Spaces provides function related to the reading of spaces
  through the Contentful Delivery API
  """

  alias Contentful.{Delivery, Space, SysData}

  @doc """
  will attempt to retrieve one space by it's space id

  ## Examples for retrieving by Space ID

      # space you have access to, token will be read from config/config.exs
      iex> {:ok, space} = Contentful.Delivery.Spaces.fetch_one("space_id")
      {:ok, %Contentful.Space{name: "a space name", sys: %{id: "space_id"}}}

      # space that does not exist
      iex> {:error, :not_found, original_message: _message}
        = Contentful.Delivery.Spaces.fetch_one("non_existing_space", "<your_api_key>")

      # no access
      iex> {:error, :unauthorized, original_message: _message}
        = Contentful.Delivery.Spaces.fetch_one("non_existing_space", "<your_api_key>")

  In case you configured the space in `config/config.exs`:

  ## Examples for plain call

      # in config/config.exs
      config :contentful, delivery: [
        api_key: "<YOUR CDA_TOKEN>"
        space_id: "myspace"
      ]

      {:ok, %Space{sys: %{ id: "myspace "}}} = Contentful.Delivery.Spaces.fetch_one()
  """
  @spec fetch_one(String.t(), String.t()) ::
          {:ok, Space.t()}
          | {:error, atom(), original_message: String.t()}
          | {:error, :rate_limit_exceeded, wait_for: integer()}
          | {:error, :unknown}
  def fetch_one(
        id \\ Delivery.config(:space_id),
        api_key \\ Delivery.config(:access_token)
      ) do
    id
    |> build_request(api_key)
    |> Delivery.send_request()
    |> Delivery.parse_response(&build_space/1)
  end

  defp build_request(space_id, api_key) do
    url = space_id |> Delivery.url()
    {url, api_key |> Delivery.request_headers()}
  end

  defp build_space(%{
         "locales" => _locales,
         "name" => name,
         "sys" => %{"id" => id, "type" => "Space"}
       }) do
    {:ok, %Space{name: name, sys: %SysData{id: id}}}
  end
end