opensource
/
iban-ex
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Removed esbuild and bumped to 0.1.1

This commit is contained in:
Danil Negrienko 2024-03-07 18:41:45 -05:00
parent 390036bafb
commit 6b5f3676c8
2 changed files with 25 additions and 25 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
README.md
View File

@ -12,7 +12,7 @@ In just a few letters and numbers, the IBAN captures all of the country, bank, a
### Successfull case to parse IBAN
Parse string with valid formatted IBAN from supported country
#### Parse string with valid formatted IBAN from supported country
```elixir
{:ok, iban} = "FI2112345600000785" |> IbanEx.Parser.parse()
@ -20,8 +20,9 @@ IO.inspect(iban)
IbanEx.Iban.pretty(iban)
```
#### Response
#### Success case responses
```elixir
%IbanEx.Iban{
country_code: "FI",
check_digits: "21",
@ -32,10 +33,11 @@ IbanEx.Iban.pretty(iban)
}
"FI 21 123456 0000078 5"
```
### Errors cases of IBAN parsing
Parse strings with invalid formatted IBANs from unsupported and supported countries
#### Parse strings with invalid formatted IBANs from unsupported and supported countries
```elixir
{:error, unsupported_country_code} = "AZ21NABZ00000000137010001944" |> IbanEx.Parser.parse()
@ -48,22 +50,22 @@ IO.inspect(IbanEx.Error.message(invalid_length_code), label: invalid_length_code
IO.inspect(IbanEx.Error.message(invalid_checksum), label: invalid_checksum)
```
#### Response
#### Error cases response
```elixir
unsupported_country_code: "Unsupported country code"
invalid_length: "IBAN violates the required length"
invalid_checksum: "IBAN's checksum is invalid"
```
## Installation
If [available in Hex](https://hex.pm/docs/publish), the package can be installed
by adding `iban_ex` to your list of dependencies in `mix.exs`:
The package can be installed by adding `iban_ex` to your list of dependencies in `mix.exs`:
```elixir
def deps do
[
{:iban_ex, "~> 0.1.0"}
{:iban_ex, "~> 0.1.1"}
]
end
```
@ -71,4 +73,3 @@ end
Documentation can be generated with [ExDoc](https://github.com/elixir-lang/ex_doc)
and published on [HexDocs](https://hexdocs.pm). Once published, the docs can
be found at <https://hexdocs.pm/iban_ex>.

3
mix.exs
View File

@ -2,7 +2,7 @@ defmodule IbanEx.MixProject do
use Mix.Project
@source_url "https://g.tulz.dev/opensource/iban-ex"
@version "0.1.0"
@version "0.1.1"
def project do
[
@ -68,7 +68,6 @@ defmodule IbanEx.MixProject do
{:ex_doc, ">= 0.0.0", only: ~w(dev test)a, runtime: false},
{:sobelow, ">= 0.0.0", only: ~w(dev test)a, runtime: false},
{:mix_audit, ">= 0.0.0", only: ~w(dev test)a, runtime: false},
{:esbuild, "~> 0.7.0", runtime: Mix.env() == :dev},
{:observer_cli, "~> 1.7.4", only: :dev, runtime: false},
{:elixir_sense, github: "elixir-lsp/elixir_sense", only: ~w(dev)a}