ex_azure_storage

defmodule AzureStorage.Table do
  @moduledoc """
  Azure Table Service

  ref. https://docs.microsoft.com/en-us/rest/api/storageservices/table-service-rest-api

  ```
  alias AzureStorage.Table.EntityDescriptor
  import AzureStorage.Table.EntityGenerator

  {:ok, context} = AzureStorage.create_table_service("account_name", "account_key")

  # build entity
  entity = %EntityDescriptor{}
    |> partition_key("partition_key_1000")
    |> row_key("row_key_1000")
    |> string("Name", "Linux")
    |> int64("Val1", 42)
    |> double("Val2", 42.2)

  # insert entity
  context |> insert_entity("table1", entity)

  # retrieve entity from server
  {
    :ok,
    %EntityDescriptor{} = existing_entity
  } = context |> retrieve_entity("partition_key_value", "row_key_value")

  # update entity
  entity = existing_entity |> string("Name", "Ubuntu")
  {:ok, %{ETag => etag}} = context |> update_entity("table1", entity)
  ```
  """
  alias AzureStorage.Table.{EntityDescriptor, Query, Entity, Schema}
  alias AzureStorage.Request.Context
  import AzureStorage.Table.QueryBuilder
  import AzureStorage.Table.EntityGenerator
  import AzureStorage.Request
  import AzureStorage.Parser

  @doc """
  Create a new table in storage account
  """
  @spec create_table(Context.t(), String.t()) :: {:ok, String.t()} | {:error, String.t()}
  def create_table(%Context{service: "table"} = context, table) do
    path = "Tables"
    body = "{\"TableName\":\"#{table}\"}"
    headers = %{:"Content-Type" => "application/json"}

    context
    |> build(method: :post, path: path, body: body, headers: headers)
    |> request()
    |> parse_body_response()
  end

  @doc """
  Delete table from storage account
  """
  @spec delete_table(Context.t(), String.t()) :: {:ok, String.t()} | {:error, String.t()}
  def delete_table(%Context{service: "table"} = context, table) do
    path = "Tables('#{table}')"
    headers = %{:"Content-Type" => "application/json"}

    context
    |> build(method: :delete, path: path, headers: headers)
    |> request()
    |> parse_body_response()
  end

  @doc """
  Retrieve an entity by PartitionKey and RowKey

  Supported options\n#{NimbleOptions.docs(Schema.retrieve_entity_options())}

  ```
  context |> AzureStorage.Table.retrieve_entity("table1", "partition_key", "row_key", as: :json)
  # {:ok, %{...}}

  context |> AzureStorage.Table.retrieve_entity("table1", "partition_key", "row_key", as: :entity)
  # {:ok, %EntityDescriptor{}}
  ```
  """
  @spec retrieve_entity(Context.t(), String.t(), String.t(), String.t()) ::
          {:ok, map()} | {:error, String.t()}
  def retrieve_entity(
        %Context{service: "table"} = context,
        table_name,
        partition_key,
        row_key,
        options \\ []
      ) do
    {:ok, opts} = NimbleOptions.validate(options, Schema.retrieve_entity_options())

    query =
      "#{table_name}(PartitionKey='#{partition_key}',RowKey='#{row_key}')"
      |> String.replace("'", "%27")

    result =
      context
      |> build(method: :get, path: query)
      |> request()
      |> parse_body_response()

    case opts[:as] do
      :json ->
        result

      _ ->
        case result do
          {:ok, entity} ->
            {:ok, map_to_entity_descriptor(entity)}

          {:error, reason} ->
            {:error, reason}
        end
    end
  end

  @doc """
  Query entities from a table storage

  Supported options\n#{NimbleOptions.docs(Schema.query_entities_options())}
  """
  @spec query_entities(Context.t(), Query.t(), keyword()) ::
          {:ok, list(), String.t()} | {:error, String.t()}
  def query_entities(%Context{service: "table"} = context, %Query{} = query, options \\ []) do
    {:ok, opts} = NimbleOptions.validate(options, Schema.query_entities_options())
    odata_query = query |> compile()

    path =
      case opts[:continuation_token] do
        nil -> odata_query
        _ -> "#{odata_query}&#{opts[:continuation_token]}"
      end

    context
    |> build(method: :get, path: path)
    |> request()
    |> parse_query_entities_response(opts[:as])
  end

  @doc """
  Deletes an existing entity in a table.
  """
  @spec delete_entity(Context.t(), String.t(), String.t(), String.t(), binary()) ::
          {:ok, String.t()} | {:error, String.t()}
  def delete_entity(
        %Context{service: "table"} = context,
        table_name,
        partition_key,
        row_key,
        etag \\ "*"
      ) do
    query =
      "#{table_name}(PartitionKey='#{partition_key}',RowKey='#{row_key}')"
      |> URI.encode()
      |> String.replace("'", "%27")

    headers = %{
      "If-Match" => etag
    }

    context
    |> build(method: :delete, path: query, headers: headers)
    |> request()
    |> parse_body_response
  end

  @doc """
  The Insert Entity operation inserts a new entity into a table.

  ref. https://docs.microsoft.com/en-us/rest/api/storageservices/insert-entity

  ```
  alias AzureStorage.Table.EntityDescriptor
  import AzureStorage.Table.EntityGenerator

  entity = %EntityDescriptor{}
    |> partition_key("partition_key_1")
    |> row_key("row_key_1")
    |> string("Message", "Hello World")

  context |> AzureStorage.Table.insert_entity("table1", entity)
  # {:ok, %{"ETag" => ...}}
  ```
  """
  @spec insert_entity(Context.t(), String.t(), EntityDescriptor.t()) ::
          {:ok, map()} | {:error, String.t()}
  def insert_entity(
        %Context{service: "table"} = context,
        table_name,
        %EntityDescriptor{} = entity_descriptor
      ) do
    query = "#{table_name}"
    body = entity_descriptor |> Jason.encode!()

    context
    |> build(method: :post, path: query, body: body, headers: get_standard_headers())
    |> request()
    |> parse_entity_change_response()
  end

  @doc """
  The Update Entity operation updates an existing entity in a table.

  The Update Entity operation replaces the entire entity and can be used to remove properties.
  """
  def update_entity(
        %Context{service: "table"} = context,
        table_name,
        %EntityDescriptor{} = entity_descriptor
      ) do
    headers = get_patch_headers(entity_descriptor)

    context
    |> patch_entity(:put, table_name, entity_descriptor, headers)
  end

  @doc """
  The Merge Entity operation updates an existing entity by updating the entity's properties.

  This operation does not replace the existing entity, as the Update Entity operation does.
  """
  def merge_entity(
        %Context{service: "table"} = context,
        table_name,
        %EntityDescriptor{} = entity_descriptor
      ) do
    headers = get_patch_headers(entity_descriptor)

    context
    |> patch_entity(:merge, table_name, entity_descriptor, headers)
  end

  @doc """
  The Insert Or Replace Entity operation replaces an existing entity or inserts a new entity if it does not exist in the table. 

  Because this operation can insert or update an entity, it is also known as an upsert operation.
  """
  def insert_or_replace_entity(
        %Context{service: "table"} = context,
        table_name,
        %EntityDescriptor{} = entity_descriptor
      ) do
    context
    |> patch_entity(:put, table_name, entity_descriptor, get_standard_headers())
  end

  @doc """
  The Insert Or Merge Entity operation updates an existing entity or inserts a new entity if it does not exist in the table.

  Because this operation can insert or update an entity, it is also known as an upsert operation.
  """
  def insert_or_merge_entity(
        %Context{service: "table"} = context,
        table_name,
        %EntityDescriptor{} = entity_descriptor
      ) do
    context
    |> patch_entity(:merge, table_name, entity_descriptor, get_standard_headers())
  end

  # ------------ helpers
  defp get_standard_headers(),
    do: %{
      "Prefer" => "return-no-content",
      :"Content-Type" => "application/json"
    }

  defp get_patch_headers(%EntityDescriptor{ETag: etag}) do
    # conditional update
    if_match =
      case etag do
        nil -> "*"
        _ -> etag
      end

    %{
      "Prefer" => "return-no-content",
      :"Content-Type" => "application/json",
      "If-Match" => if_match
    }
  end

  defp patch_entity(
         %Context{service: "table"} = context,
         method,
         table_name,
         %EntityDescriptor{} = entity_descriptor,
         headers
       )
       when method in [:put, :merge] do
    keys = entity_descriptor |> get_entity_keys()
    query = "#{table_name}(#{keys})"
    body = entity_descriptor |> Jason.encode!()

    context
    |> build(method: method, path: query, body: body, headers: headers)
    |> request()
    |> parse_entity_change_response()
  end

  defp parse_query_entities_response(
         {:ok, %{"odata.metadata" => _metadata, "value" => entities}, headers},
         :json
       ) do
    continuation_token = headers |> parse_continuation_token
    {:ok, entities, continuation_token}
  end

  defp parse_query_entities_response(
         {:ok, %{"odata.metadata" => _metadata, "value" => entities}, headers},
         :entity
       ) do
    continuation_token = headers |> parse_continuation_token
    {:ok, Enum.map(entities, &map_to_entity_descriptor/1), continuation_token}
  end

  defp parse_entity_change_response({:ok, _, headers}) do
    headers
    |> Enum.find(fn
      {"ETag", _} -> true
      _ -> false
    end)
    |> case do
      nil -> {:ok, nil}
      {"ETag", etag} -> {:ok, %{"ETag" => etag}}
    end
  end

  defp parse_entity_change_response({:error, reason}), do: {:error, reason}

  defp get_entity_keys(%EntityDescriptor{} = entity_descriptor) do
    entity_descriptor
    |> Map.take([:PartitionKey, :RowKey])
    |> Map.to_list()
    |> Enum.map(fn {key, %Entity{_: value}} -> "#{key}=%27#{value}%27" end)
    |> Enum.join(",")
  end
end