scrapy_cloud_ex

defmodule ScrapyCloudEx.Endpoints.Storage.Activity do
  @moduledoc """
  Wraps the [Activity](https://doc.scrapinghub.com/api/activity.html) endpoint.

  Scrapinghub keeps track of certain project events such as when spiders
  are run or new spiders are deployed. This activity log can be accessed
  in the dashboard by clicking on Activity in the left sidebar, or
  programmatically through the API in this module.
  """

  import ScrapyCloudEx.Endpoints.Guards

  alias ScrapyCloudEx.Endpoints.Helpers
  alias ScrapyCloudEx.Endpoints.Storage.QueryParams
  alias ScrapyCloudEx.HttpAdapter.RequestConfig

  @typedoc """
  An event.

  Map with the following keys:

  * `"event"` - type of event (`t:String.t/0`).
  * `"user"` - user having triggered the event (`t:String.t/0`).

  Other key-values may be present as relevant to the `"event"` type.
  """
  @type event_object :: %{required(String.t()) => String.t()}

  @base_url "https://storage.scrapinghub.com/activity"

  @default_format :json

  @param_aliases [
    {:p_count, :pcount}
  ]

  @doc """
  Retrieves messages for the specified project.

  Results are returned in reverse order.

  The following parameters are supported in the `params` argument:

    * `:pagination` - the `:count` [pagination parameter](ScrapyCloudEx.Endpoints.Storage.html#module-pagination)
      is supported.

  The `opts` value is documented [here](ScrapyCloudEx.Endpoints.html#module-options).

  See docs [here](https://doc.scrapinghub.com/api/activity.html#activity-project-id) (GET method).

  ## Example

  ```
  ScrapyCloudEx.Endpoints.Storage.Activity.list("API_KEY", "123", count: 10)
  ```
  """
  @spec list(String.t(), String.t() | integer, Keyword.t(), Keyword.t()) ::
          ScrapyCloudEx.result([event_object()])
  def list(api_key, project_id, params \\ [], opts \\ [])
      when is_api_key(api_key)
      when is_binary(project_id) and project_id != ""
      when is_list(params)
      when is_list(opts) do
    count = Keyword.get(params, :count)

    params =
      params
      |> set_default_format()
      |> Keyword.delete(:count)

    with %QueryParams{error: nil} = query_params <- QueryParams.from_keywords(params) do
      base_url = [@base_url, project_id] |> Enum.join("/")
      query_string = QueryParams.to_query(query_params)

      query_string =
        if count do
          query_string <> "&count=#{count}"
        else
          query_string
        end

      RequestConfig.new()
      |> RequestConfig.put(:api_key, api_key)
      |> RequestConfig.put(:url, "#{base_url}?#{query_string}")
      |> RequestConfig.put(:headers, Keyword.get(opts, :headers, []))
      |> RequestConfig.put(:opts, opts)
      |> Helpers.make_request()
    else
      %QueryParams{error: error} ->
        {:error, error}

      error ->
        {:error, error}
    end
  end

  @doc """
  Retrieves messages for multiple projects.

  Results are returned in reverse order.

  The following parameters are supported in the `params` argument:

    * `:format` - the format to be used for returning results. Must be one of
      `:json`, `:csv`, `:jl`, `:xml`. Defaults to `:json`. See more about formats
      in `ScrapyCloudEx.Endpoints.Storage`.

    * `:pagination` - [pagination parameters](ScrapyCloudEx.Endpoints.Storage.html#module-pagination).

    * `:meta` - [meta parameters](ScrapyCloudEx.Endpoints.Storage.html#module-meta-parameters)
        to add to each result. Supported values: `:_project`, `:_ts`.

    * `:p` - project id. May be given multiple times.

    * `:pcount` - maximum number of results to return per project.

  The `opts` value is documented [here](ScrapyCloudEx.Endpoints.html#module-options).

  See docs [here](https://doc.scrapinghub.com/api/activity.html#activity-projects).

  ## Example

  ```
  params = [p: "123", p: "456", pcount: 15, pagination: [count: 100], meta: [:_ts, :_project]]
  ScrapyCloudEx.Endpoints.Storage.Activity.projects("API_KEY", params)
  ```
  """
  @spec projects(String.t(), Keyword.t(), Keyword.t()) :: ScrapyCloudEx.result([event_object()])
  def projects(api_key, params \\ [], opts \\ [])
      when is_api_key(api_key)
      when is_list(params)
      when is_list(opts) do
    params =
      params
      |> set_default_format()
      |> Helpers.canonicalize_params(@param_aliases)

    p_vals = params |> Keyword.get_values(:p) |> Enum.map(&{:p, &1})
    p_count = Keyword.get(params, :pcount)
    params = Keyword.drop(params, [:p, :pcount])

    with %QueryParams{error: nil} = query_params <- QueryParams.from_keywords(params) do
      base_url = [@base_url, "projects"] |> Enum.join("/")
      p_query = URI.encode_query(p_vals)
      p_count_query = if p_count, do: "pcount=#{p_count}", else: ""

      query_string = Enum.join([QueryParams.to_query(query_params), p_query, p_count_query], "&")

      RequestConfig.new()
      |> RequestConfig.put(:api_key, api_key)
      |> RequestConfig.put(:url, "#{base_url}?#{query_string}")
      |> RequestConfig.put(:headers, Keyword.get(opts, :headers, []))
      |> RequestConfig.put(:opts, opts)
      |> Helpers.make_request()
    else
      %QueryParams{error: error} ->
        {:error, error}

      error ->
        {:error, error}
    end
  end

  @spec set_default_format(Keyword.t()) :: Keyword.t()
  defp set_default_format(params) do
    case Keyword.get(params, :format) do
      nil -> Keyword.put(params, :format, @default_format)
      _ -> params
    end
  end
end