contentful

defmodule Contentful.Delivery.Assets do
  @moduledoc """
  Deals with the loading of assets from a given `Contentful.Space`

  https://www.contentful.com/developers/docs/references/content-delivery-api/#/reference/assets
  """

  alias Contentful.{Asset, Collection, CollectionStream, Delivery, Space}

  @behaviour Collection
  @behaviour CollectionStream
  @doc """
  fetches one asset from a given space

  ## Examples
      space = "my_space_id"
      {:ok, %Asset{ sys: %{ id: "<asset_id>"}} = asset}
        =  Assets.fetch_one("<asset_id>", space)

      # using the configured space from config/config.exs
      {:ok, %Asset{ sys: %{ id: "<asset_id>"}} = asset}
        =  Assets.fetch_one("<asset_id>")

  """
  @impl Collection
  @spec fetch_one(
          String.t(),
          Space.t() | String.t(),
          String.t() | nil,
          String.t() | nil
        ) ::
          {:ok, Asset.t()}
          | {:error, atom(), original_message: String.t()}
          | {:error, :rate_limit_exceeded, wait_for: integer()}
          | {:error, :unknown}
  def fetch_one(
        asset,
        space \\ Delivery.config(:space_id),
        env \\ Delivery.config(:environment),
        api_key \\ Delivery.config(:access_token)
      )

  def fetch_one(asset_id, %Space{sys: %{id: space_id}}, env, api_key) do
    space_id
    |> build_single_request(asset_id, env, api_key)
    |> Delivery.send_request()
    |> Delivery.parse_response(&build_asset/1)
  end

  def fetch_one(asset_id, space_id, env, api_key) do
    fetch_one(asset_id, %Space{sys: %{id: space_id}}, env, api_key)
  end

  @doc """
  Fetches all assets for a given `Contentful.Space`.

  Will take basic collection filters into account, specifically `:limit` and `:skip` to traverse and
  limit the collection of assets.

  ## Examples
      space = "my_space_id"
      {:ok, [%Asset{} | _]} = Assets.fetch_all([], space)

      {:ok, [
        %Asset{ sys: %{ id: "foobar_0"}},
        %Asset{ sys: %{ id: "foobar_1"}},
      ], total: 3} = Assets.fetch_all([limit: 2], space)


      # using the configured space
      {:ok, [
        %Asset{ sys: %{ id: "foobar_1"}},
        %Asset{ sys: %{ id: "foobar_2"}}
      ], total: 3} = Assets.fetch_all(skip: 1)

      {:ok, [
        %Asset{ sys: %{ id: "foobar_0"}}
      ], total: 3} = Assets.fetch_all(limit: 1)

      {:ok, [
        %Asset{ sys: %{ id: "foobar_2"}}
      ], total: 3} = Assets.fetch_all(limit: 1, skip: 2)
  """
  @impl Collection
  @spec fetch_all(
          list(keyword()),
          Space.t() | String.t(),
          String.t() | nil,
          String.t() | nil
        ) ::
          {:ok, list(Asset.t())}
          | {:error, atom(), original_message: String.t()}
          | {:error, :rate_limit_exceeded, wait_for: integer()}
          | {:error, :unknown}

  def fetch_all(
        options \\ [],
        space \\ Delivery.config(:space_id),
        env \\ Delivery.config(:environment),
        api_key \\ Delivery.config(:access_token)
      )

  def fetch_all(options, %Space{sys: %{id: id}}, env, api_key) do
    id
    |> build_multi_request(options, env, api_key)
    |> Delivery.send_request()
    |> Delivery.parse_response(&build_assets/1)
  end

  def fetch_all(options, space_id, env, api_key) when is_binary(space_id) do
    fetch_all(options, %Space{sys: %{id: space_id}}, env, api_key)
  end

  @doc """
  Constructs a stream around __all__ assets of a `Contentful.Space` __that are published__.

  Will return a stream of assets that can be composed with the standard libraries functions.
  This function calls the API endpoint for entries on demand, e.g. until the upper limit
  (the total of all assets) is reached.

  __Warning__: With very large asset collections, this can quickly run into the request limit of the API!

  ## Examples

      # using the configured space:
      ["first_asset_id", "second_asset_id"] =
          Assets.stream(limit: 1)
          |> Stream.map(fn %{ sys: %{ id: id }} -> id end)
          |> Enum.take(2)

      space = "my_space_id"
      # API calls calculated by the stream (in this case two calls)
      ["first_asset_id", "second_asset_id"] =
          Assets.stream([limit: 1], space)
          |> Stream.map(fn %{ sys: %{ id: id }} -> id end)
          |> Enum.take(2)

      environment = "staging"
      api_token = "foobar?foob4r"
      ["first_asset_id"] =
          Assets.stream([limit: 1], space, environment, api_token)
          |> Stream.map(fn %{ sys: %{ id: id }} -> id end)
          |> Enum.take(2)

      # Use the :limit parameter to set the page size
      ["first_asset_id", "second_asset_id", "third_asset_id", "fourth_asset_id"] =
          |> Assets.stream([limit: 4], space)
          |> Stream.map(fn %{ sys: %{ id: id }} -> id end)
          |> Enum.take(4)
  """
  @impl CollectionStream
  def stream(
        options \\ [],
        space \\ Delivery.config(:space_id),
        env \\ Delivery.config(:environment),
        api_key \\ Delivery.config(:access_token)
      ) do
    space |> CollectionStream.stream_all(&fetch_all/4, options, env, api_key)
  end

  @spec build_single_request(String.t(), Asset.t(), String.t() | nil, String.t() | nil) ::
          tuple()
  defp build_single_request(space, asset, env, api_key) do
    url = [
      Delivery.url(space, env),
      "/assets/#{asset}"
    ]

    {url, api_key |> Delivery.request_headers()}
  end

  @spec build_multi_request(
          String.t(),
          [limit: pos_integer(), skip: non_neg_integer()],
          String.t() | nil,
          String.t() | nil
        ) ::
          tuple()
  defp build_multi_request(space, options, env, api_key) do
    url = [
      Delivery.url(space, env),
      "/assets",
      Delivery.collection_query_params(options)
    ]

    {url, api_key |> Delivery.request_headers()}
  end

  defp build_asset(%{"fields" => fields, "sys" => sys}) do
    {:ok, Asset.from_api_fields(fields, sys)}
  end

  defp build_assets(%{"items" => items, "total" => total}) do
    assets =
      items
      |> Enum.map(&build_asset/1)
      |> Enum.map(fn {:ok, asset} -> asset end)

    {:ok, assets, total: total}
  end
end