ex_aws_redshift

defmodule ExAws.RedShift do
  @moduledoc """
  Operations on AWS RedShift.
  """

  import ExAws.Utils, only: [camelize_key: 1]

  @type node_type :: [:"ds1.xlarge" | :"ds1.8xlarge" | :"ds2.xlarge" | :"ds2.8xlarge" |
                      :"dc1.large" | :"dc1.8xlarge"]
  @type cluster_type :: [:"multi-node" | :"single-node"]

  @type create_cluster_opts :: [
    {:cluster_identifier, binary}
    | {:master_username, binary}
    | {:master_user_password, binary}
    | {:node_type, node_type}
    | {:allow_version_upgrade, boolean}
    | {:automated_snapshot_retention_period, 0..35}
    | {:availability_zone, binary}
    | {:cluster_parameter_group_name, binary}
    | {:cluster_security_groups, [binary]}
    | {:cluster_subnet_group_name, binary}
    | {:cluster_type, cluster_type}
    | {:cluster_version, binary}
    | {:db_name, binary}
    | {:elastic_ip, binary}
    | {:encrypted, boolean}
    | {:enhanced_vpc_routing, :boolean}
    | {:hsm_client_certificate_identifier, binary}
    | {:hsm_configuration_identifier, binary}
    | {:iam_roles, [binary]}
  ]
  @create_cluster_opts [:cluster_identifier, :master_username, :master_user_password,
    :node_type, :allow_version_upgrade, :automated_snapshot_retention_period, :availability_zone,
    :cluster_parameter_group_name, :"cluster_security_groups/_cluster_security_group_name",
    :cluster_subnet_group_name, :cluster_type, :cluster_version, :db_name, :elastic_ip,
    :encrypted, :hsm_client_certificate_identifier, :hsm_configuration_identifier,
    :"iam_roles/_iam_role_arn"]
  @doc """
  Create a new cluster with the given cluster id.

  Required keys are cluster_identifier, master_username, master_user_password,
  and node_type.

  Amazon docs: http://docs.aws.amazon.com/redshift/latest/APIReference/API_CreateCluster.html

  ## Examples

      iex> ExAws.RedShift.create_cluster("A2", [master_username: "Nier", master_user_password: "Automata", node_type: "dc1_large"])
      %ExAws.Operation.Query{action: "CreateCluster",
        params: %{"Action" => "CreateCluster", "ClusterIdentifier" => "A2", "MasterUsername" => "Nier", "MasterUserPassword" => "Automata", "NodeType" => "dc1_large"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}

      iex> ExAws.RedShift.create_cluster("A2", [cluster_identifier: "21O", master_username: "Nier", master_user_password: "Automata", node_type: "dc1_large"])
      %ExAws.Operation.Query{action: "CreateCluster",
        params: %{"Action" => "CreateCluster", "ClusterIdentifier" => "A2", "MasterUsername" => "Nier", "MasterUserPassword" => "Automata", "NodeType" => "dc1_large"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}

      iex> ExAws.RedShift.create_cluster([cluster_identifier: "2B", master_username: "Nier", master_user_password: "Automata", node_type: "dc1_large"])
      %ExAws.Operation.Query{action: "CreateCluster",
        params: %{"Action" => "CreateCluster", "ClusterIdentifier" => "2B", "MasterUsername" => "Nier", "MasterUserPassword" => "Automata", "NodeType" => "dc1_large"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}
  """
  @spec create_cluster(create_cluster_opts) :: ExAws.Operation.Query.t
  @spec create_cluster(String.t, create_cluster_opts) :: ExAws.Operation.Query.t
  def create_cluster(opts) when is_list(opts) do
    opts
    |> Enum.map(fn({k, v}) ->
      k = k
      |> case do
        :iam_roles -> :"iam_roles/_iam_role_arn"
        :cluster_security_groups -> :"cluster_security_groups/_cluster_security_group_name"
        _ -> k
      end

      {k, v}
    end)
    |> build_params(@create_cluster_opts)
    |> build_request("CreateCluster")
  end
  def create_cluster(id, opts) when is_bitstring(id) do
    opts
    |> set(:cluster_identifier, id)
    |> create_cluster()
  end


  @type delete_cluster_opts :: [
    {:cluster_identifier, binary}
    | {:final_cluster_snapshot_identifier, binary}
    | {:skip_final_cluster_snapshot, boolean}
  ]
  @delete_cluster_opts [:cluster_identifier, :final_cluster_snapshot_identifier, :skip_final_cluster_snapshot]
  @doc """
  Delete a RedShift cluster with the a given identifier.

  Required key is cluster_identifier.

  Amazon docs: http://docs.aws.amazon.com/redshift/latest/APIReference/API_DeleteCluster.html

  ## Examples

      iex> ExAws.RedShift.delete_cluster("2B", [])
      %ExAws.Operation.Query{action: "DeleteCluster",
        params: %{"Action" => "DeleteCluster", "ClusterIdentifier" => "2B"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}
  """
  @spec delete_cluster(Keyword.t) :: ExAws.Operation.Query.t
  @spec delete_cluster(String.t, delete_cluster_opts) :: ExAws.Operation.Query.t
  def delete_cluster(opts) when is_list(opts) do
    opts
    |> build_params(@delete_cluster_opts)
    |> build_request("DeleteCluster")
  end
  def delete_cluster(id, opts \\ []) when is_bitstring(id) do
    opts
    |> set(:cluster_identifier, id)
    |> delete_cluster()
  end


  @type describe_clusters_opts :: [
    {:cluster_identifier, binary}
    | {:marker, binary}
    | {:max_records, 20..100}
    | {:tag_keys, binary}
    | {:tag_values, binary}
  ]
  @describe_clusters_opts [:cluster_identifier, :marker, :max_records, :"tag_keys/_tag_key",
    :"tag_values/_tag_value"]
  @doc """
  Describe the properties of the given cluster ID. If no cluster ID is given,
  a list of properties for all clusters is returned.

  Amazon docs: http://docs.aws.amazon.com/redshift/latest/APIReference/API_DescribeClusters.html

  ## Examples

      iex> ExAws.RedShift.describe_clusters([cluster_identifier: "2B"])
      %ExAws.Operation.Query{action: "DescribeClusters",
        params: %{"Action" => "DescribeClusters", "ClusterIdentifier" => "2B"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}

      iex> ExAws.RedShift.describe_clusters([cluster_identifier: "2B", some_wrong_key: "Eve"])
      %ExAws.Operation.Query{action: "DescribeClusters",
        params: %{"Action" => "DescribeClusters", "ClusterIdentifier" => "2B"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}

      iex> ExAws.RedShift.describe_clusters("A2", [])
      %ExAws.Operation.Query{action: "DescribeClusters",
        params: %{"Action" => "DescribeClusters", "ClusterIdentifier" => "A2"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}

      iex> ExAws.RedShift.describe_clusters("9S", [cluster_identifier: "21O"])
      %ExAws.Operation.Query{action: "DescribeClusters",
        params: %{"Action" => "DescribeClusters", "ClusterIdentifier" => "9S"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}
  """
  @spec describe_clusters(describe_clusters_opts) :: ExAws.Operation.Query.t
  @spec describe_clusters(String.t, describe_clusters_opts) :: ExAws.Operation.Query.t
  def describe_clusters(opts \\ []) when is_list(opts) do
    opts
    |> Enum.map(fn({k, v}) ->
      k = k
      |> case do
        :tag_keys -> :"tag_keys/_tag_key"
        :tag_values -> :"tag_values/_tag_value"
        _ -> k
      end
      {k, v}
    end)
    |> build_params(@describe_clusters_opts)
    |> build_request("DescribeClusters")
  end
  def describe_clusters(id, opts) when is_bitstring(id) do
    opts
    |> set(:cluster_identifier, id)
    |> describe_clusters()
  end


  @type modify_cluster_opts :: [
    {:cluster_identifier, binary}
    | {:additional_info, binary}
    | {:allow_version_upgrade, boolean}
    | {:automated_snapshot_retention_period, 0..35}
    | {:cluster_parameter_group_name, binary}
    | {:cluster_security_groups, [binary]}
    | {:cluster_type, cluster_type}
    | {:cluster_version, binary}
    | {:elastic_ip, binary}
    | {:enhanced_vpc_routing, boolean}
    | {:hsm_client_certificate_identifier, binary}
    | {:hsm_onfiguration_identifier, binary}
    | {:master_user_password, binary}
    | {:new_cluster_identifier, binary}
    | {:node_type, node_type}
    | {:number_of_nodes, integer}
    | {:preferred_maintenance_window, binary}
    | {:publicly_accessible, boolean}
    | {:vpc_security_groups, [binary]}
  ]
  @modify_cluster_opts [:cluster_identifier, :additional_info, :allow_version_upgrade,
    :automated_snapshot_retention_period, :cluster_parameter_group_name, :"cluster_security_groups/_cluster_security_group_name",
    :cluster_type, :cluster_version, :elastic_ip, :enhanced_vpc_routing, :hsm_client_certificate_identifier,
    :hsm_onfiguration_identifier, :master_user_password, :new_cluster_identifier,
    :node_type, :number_of_nodes, :preferred_maintenance_window, :publicly_accessible,
    :"vpc_security_group_ids/_vpc_security_group_id"]
  @doc """
  Modify a cluster with a given ClusterIdentifier.

  Required key is cluster_identifier.

  Amazon docs: http://docs.aws.amazon.com/redshift/latest/APIReference/API_ModifyCluster.html

  ## Examples

      iex> ExAws.RedShift.modify_cluster("Adam", [])
      %ExAws.Operation.Query{action: "ModifyCluster",
        params: %{"Action" => "ModifyCluster", "ClusterIdentifier" => "Adam"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}

      iex> ExAws.RedShift.modify_cluster("Adam", [new_cluster_identifier: "Eve"])
      %ExAws.Operation.Query{action: "ModifyCluster",
        params: %{"Action" => "ModifyCluster", "ClusterIdentifier" => "Adam", "NewClusterIdentifier" => "Eve"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}

      iex> ExAws.RedShift.modify_cluster("Adam", [cluster_identifier: "Eve", cluster_security_groups: ["test", "tast"]])
      %ExAws.Operation.Query{action: "ModifyCluster",
        params: %{"Action" => "ModifyCluster", "ClusterIdentifier" => "Adam", "ClusterSecurityGroups.ClusterSecurityGroupName.1" => "test", "ClusterSecurityGroups.ClusterSecurityGroupName.2" => "tast"},
        parser: &ExAws.Utils.identity/2, path: "/", service: :redshift}
  """
  @spec modify_cluster(Keyword.t) :: ExAws.Operation.Query.t
  @spec modify_cluster(String.t, Keyword.t) :: ExAws.Operation.Query.t
  def modify_cluster(opts) when is_list(opts) do
    opts
    |> Enum.map(fn({k, v}) ->
      k = k
      |> case do
        :cluster_security_groups -> :"cluster_security_groups/_cluster_security_group_name"
        :vpc_security_groups -> :"vpc_security_group_ids/_vpc_security_group_id"
        _ -> k
      end
      {k, v}
    end)
    |> build_params(@modify_cluster_opts)
    |> build_request("ModifyCluster")
  end
  def modify_cluster(id, opts \\ []) when is_bitstring(id) do
    opts
    |> set(:cluster_identifier, id)
    |> modify_cluster()
  end


  @doc """
  A function for expanding a list of values for enumerable keys.

  Some AWS keys support multiple values like roles, security groups, or tags.
  The key usually follows the format `Names.Name.<index>`, for example,
  `IamRoles.IamRoleArn.1` as seen in the examples below. The function takes
  the key and a list of values, then append numerical index to the key using
  the given separator and pair it with each value.

  ## Examples

      iex> ExAws.RedShift.expand_params({"iam_roles/_iam_role_arn", ["Operator", "Scanner"]})
      [{"iam_roles/_iam_role_arn/1", "Operator"}, {"iam_roles/_iam_role_arn/2", "Scanner"}]

      iex> ExAws.RedShift.expand_params({"IamRoles.IamRoleArn", ["Operator", "Scanner"]}, ".")
      [{"IamRoles.IamRoleArn.1", "Operator"}, {"IamRoles.IamRoleArn.2", "Scanner"}]

      iex> ExAws.RedShift.expand_params({"iam_roles/_iam_role_arn", []})
      []
  """
  @spec expand_params(Tuple.t, String.t) :: List.t
  def expand_params(item, separator \\ "/")
  def expand_params({k, v}, separator) when is_list(v) do
    {params, _} = v
    |> Enum.reduce({[], 1}, fn(item, {acc, index}) ->
      {[{"#{k}#{separator}#{index}", item} | acc], index + 1}
    end)
    params
    |> Enum.reverse
  end
  def expand_params(item, _), do: [item]

  # This function is used for setting the key value pair into the option list.
  # It inherits the functionality of `Keyword.update/4` meaning if there's any
  # duplicate keys, it removes all instances of the key and replace it with
  # only what's given to the function.
  @spec set(Keyword.t, Atom.t, Any.t) :: Keyword.t
  defp set(opts, key, value) do
    opts
    |> Keyword.update(key, value, fn(_) -> value end)
  end

  # This function is used creating a param list that's compliance with
  # `ExAws.Operation.Query`'s struct.
  # It cleans a keyword list, keeping only keys appropriate for the request,
  # then convert everything to a map with string key instead of atom.
  @spec build_params(Keyword.t, Keyword.t) :: Map.t
  defp build_params(opts, keys) do
    opts
    |> Enum.filter(fn({k, _}) ->
      Enum.member?(keys, k)
    end)
    |> Enum.reduce([], fn({k, v}, acc) ->
      params = {k, v}
      |> expand_params

      Enum.concat(acc, params)
    end)
    |> Enum.reduce(%{}, fn({k, v}, acc) ->
      param = k |> to_string() |> camelize_key()
      acc |> Map.put(param, v)
    end)
  end

  # This function is used for building a request object that ExAws could use
  # to make the API call to AWS.
  @spec build_request(Map.t, String.t) :: %ExAws.Operation.Query{}
  defp build_request(params, action) do
    %ExAws.Operation.Query{
      service: :redshift,
      action: action,
      params: params |> Map.put("Action", action)
    }
  end
end