defmodule ExCnab240 do
@moduledoc """
Cnab keeps the contexts that define your domain
and business logic.
Contexts are also responsible for managing your data, regardless
if it comes from the database, an external API or others.
"""
defmacro __using__(_opts) do
quote do
@before_compile unquote(__MODULE__)
import CnabParser
def decode(filepath, attrs \\ %{}) do
ExCnab240.decode(filepath, attrs)
end
def decode!(filepath, attrs \\ %{}) do
ExCnab240.decode!(filepath, attrs)
end
def encode(params, attrs \\ %{}) do
ExCnab240.encode(params, attrs)
end
def encode!(params, attrs \\ %{}) do
ExCnab240.encode(params, attrs)
end
def find_details_type(params, attrs \\ %{}) do
ExCnab240.find_details_type(params, attrs)
end
def find_details_type!(params, attrs \\ %{}) do
ExCnab240.find_details_type(params, attrs)
end
end
end
@doc """
Decode a single file.
This will decode the cnab file applying the correct format to each CNAB 240 template
### Example
import ExCnab240
decode("JVH1234.rem", %{})
{:ok, %{
header: %{
# Content
},
details: %{
# Content
},
footer: %{
# Content
},
additional_info: %{
# Content
}
}}
"""
@callback decode(filepath :: String.t()) :: {:ok, Map.t()} | {:error, String.t()}
@callback decode(filepath :: String.t(), attrs :: keyword | map) ::
{:ok, Map.t()} | {:error, String.t()}
def decode(filepath, attrs \\ %{}) do
ExCnab.Cnab240.Services.Decode.run(filepath, attrs)
end
@callback decode!(filepath :: String.t()) :: Map.t() | {:error, String.t()}
@callback decode!(filepath :: String.t(), attrs :: keyword | map) ::
Map.t() | {:error, String.t()}
def decode!(filepath, attrs \\ %{}) do
ExCnab.Cnab240.Services.Decode.run!(filepath, attrs)
end
@doc """
Encode a single file.
This will encode your params to a one CNAB file applying the correct format to each CNAB 240 template
### Example
import ExCnab240
encode(%{cnab: cnab}, %{filename: "JVH1010101.ret"})
{:ok, %{contnet: "xxx...", filename: "JVH1010101.ret"}}
encode(%{cnab: cnab}, %{})
{:ok, %{contnet: "xxx...", filename: "default.ret"}}
encode!(%{cnab: cnab}, %{filename: "JVH1010101.ret"})
%{contnet: "xxx...", filename: "JVH1010101.ret"}
encode!(%{cnab: cnab}, %{})
%{contnet: "xxx...", filename: "default.ret"}
"""
@callback encode(params :: Map.t()) ::
{:ok, %{filename: String.t(), content: String.t()}} | {:error, String.t()}
@callback encode(params :: Map.t(), attrs :: keyword | map) ::
{:ok, %{filename: String.t(), content: String.t()}} | {:error, String.t()}
def encode(params, attrs \\ %{}) do
ExCnab.Cnab240.Services.Encode.run(params, attrs)
end
@callback encode!(params :: Map.t()) :: %{filename: String.t(), content: String.t()}
@callback encode!(params :: Map.t(), attrs :: keyword | map) ::
%{filename: String.t(), content: String.t()}
def encode!(params, attrs \\ %{}) do
ExCnab.Cnab240.Services.Encode.run!(params, attrs)
end
@doc """
Find all details types from a CNAB 240 file
The funtion will recieve a map with the cnab 240 file decoded and will return a list with all details types
### Example
import ExCnab240
find_details_type(cnab_file)
{:ok, ["A", "B"]}
find_details_type!(cnab_file)
["A", "B"]
"""
@callback find_details_type(params :: Map.t()) :: any
@callback find_details_type(params :: Map.t()) ::
{:ok, %{filename: String.t(), content: String.t()}}
def find_details_type(params) do
ExCnab.Cnab240.Services.FindDetailsTypes.run(params)
end
@callback find_details_type(params :: Map.t()) :: any
@callback find_details_type(params :: Map.t()) ::
%{filename: String.t(), content: String.t()}
def find_details_type!(params) do
ExCnab.Cnab240.Services.FindDetailsTypes.run!(params)
end
end