defmodule Aliyun.Oss.Bucket.Tags do
@moduledoc """
Bucket operations - Tags.
"""
import Aliyun.Oss.Bucket, only: [get_bucket: 4, put_bucket: 5, delete_bucket: 3]
alias Aliyun.Oss.Config
alias Aliyun.Oss.Client.{Response, Error}
@type error() ::
%Error{body: String.t(), status_code: integer(), parsed_details: map()} | atom()
@doc """
GetBucketTags - gets the tags configured for a bucket.
## Examples
iex> Aliyun.Oss.Bucket.Tagging.get("some-bucket")
{:ok, %Aliyun.Oss.Client.Response{
data: %{"Tagging" => %{"TagSet" => [%{"Key" => "key", "Value" => "value"}]}},
headers: [
{"Server", "AliyunOSS"},
{"Date", "Fri, 01 Mar 2019 06:26:07 GMT"},
...
]
}
}
"""
@spec get(Config.t(), String.t()) :: {:error, error()} | {:ok, Response.t()}
def get(config, bucket) do
get_bucket(config, bucket, %{}, %{"tagging" => nil})
end
@doc """
PutBucketTags - adds tags to a bucket or modifies the tags of a bucket.
## Examples
iex> Aliyun.Oss.Bucket.Tags.put("some-bucket", [{"key1", "value1"}, {:key2, "value2}])
{:ok, %Aliyun.Oss.Client.Response{
data: "",
headers: [
{"Server", "AliyunOSS"},
{"Date", "Wed, 05 Dec 2018 02:34:57 GMT"},
...
]
}
}
"""
@body_tmpl """
<?xml version="1.0" encoding="UTF-8"?>
<Tagging>
<TagSet>
<%= for {key, value} <- tags do %>
<Tag>
<Key><%= key %></Key>
<Value><%= value %></Value>
</Tag>
<% end %>
</TagSet>
</Tagging>
"""
@spec put(Config.t(), String.t(), [{String.t(), String.t()}, ...]) ::
{:error, error()} | {:ok, Response.t()}
def put(config, bucket, tags) do
xml_body = EEx.eval_string(@body_tmpl, tags: tags)
put_bucket(config, bucket, %{}, %{"tagging" => nil}, xml_body)
end
@doc """
DeleteBucketTags - deletes tags configured for a bucket.
## Examples
iex> Aliyun.Oss.Bucket.Tags.delete("some-bucket")
{:ok,
%Aliyun.Oss.Client.Response{
data: "",
headers: [
{"Server", "AliyunOSS"},
{"Date", "Fri, 11 Jan 2019 05:19:45 GMT"},
...
]
}}
iex> Aliyun.Oss.Bucket.Tags.delete("unknown-bucket")
{:error,
%Aliyun.Oss.Client.Error{
parsed_details: %{
"BucketName" => "unknown-bucket",
"Code" => "NoSuchBucket",
"HostId" => "unknown-bucket.oss-cn-shenzhen.aliyuncs.com",
"Message" => "The specified bucket does not exist.",
"RequestId" => "5C38283EC84D1C4471F2F48A"
},
body: "<?xml version=\"1.0\" encoding=\"UTF-8\"?>...</xml>",
status_code: 404
}}
"""
@spec delete(Config.t(), String.t()) ::
{:error, error()} | {:ok, Aliyun.Oss.Client.Response.t()}
def delete(config, bucket) do
delete_bucket(config, bucket, %{"tagging" => nil})
end
end