ExOss.Utils (ExOss v0.1.0)

Copy Markdown View Source

Internal utility functions for URL construction, deadline computation, and JSON codec resolution.

JSON Codec

The JSON codec is resolved at compile time via application config:

config :ex_oss, :json_codec, Jason

Defaults to the JSON module if not configured.

Summary

Functions

camelize(string)

Converts a snake_case atom or string to lowerCamelCase.

deadline_unix(begin_time \\ DateTime.utc_now(), expires_in)

Computes a Unix deadline timestamp from a starting time plus an offset in seconds.

json_codec()

Returns the configured JSON codec module.

public_url(client, bucket, res_key)

Builds a public (unsigned) URL from client, bucket, and resource key.

Functions

camelize(string)

@spec camelize(atom() | String.t()) :: String.t()

Converts a snake_case atom or string to lowerCamelCase.

Examples

iex> ExOss.Utils.camelize(:force_save_key)
"forceSaveKey"

iex> ExOss.Utils.camelize("persistent_ops")
"persistentOps"

deadline_unix(begin_time \\ DateTime.utc_now(), expires_in)

@spec deadline_unix(DateTime.t(), non_neg_integer()) :: integer()

Computes a Unix deadline timestamp from a starting time plus an offset in seconds.

Examples

iex> ExOss.Utils.deadline_unix(~U[2024-01-01 00:00:00Z], 3600)
1704067600

json_codec()

@spec json_codec() :: module()

Returns the configured JSON codec module.

public_url(client, bucket, res_key)

@spec public_url(ExOss.Client.Client.t(), binary(), binary()) :: binary()

Builds a public (unsigned) URL from client, bucket, and resource key.

Handles both virtual-hosted style and path style addressing:

Examples

iex> client = %ExOss.Client.Client{endpoint: "https://bucket.s3.us-east-1.amazonaws.com", bucket_addressing: :virtual}
iex> ExOss.Utils.public_url(client, "bucket", "folder/file.txt")
"https://bucket.s3.us-east-1.amazonaws.com/folder/file.txt"

iex> client = %ExOss.Client.Client{endpoint: "https://minio.example.com:9000", bucket_addressing: :path}
iex> ExOss.Utils.public_url(client, "bucket", "folder/file.txt")
"https://minio.example.com:9000/bucket/folder/file.txt"