aba v0.1.0 ABA

ABA is an Elixir library for performing validation and lookups on ABA routing numbers. It stores all routing numbers and bank information in an ETS table. Therefore, you should initialize the application in a supervision tree.

Installation

Add aba to your list of dependencies in mix.exs:

def deps do
  [
    {:aba, "~> 0.1.0"}
  ]
end

Usage

To perform routing number validation without an ETS table lookup:

iex> ABA.routing_number_valid?("111900659")
true

Otherwise, performing lookups can be done with:

iex> ABA.get_bank("111900659")
{:ok, %ABA.Bank{routing_number: "111900659", name: "WELLS FARGO BANK",
                       address: "255 2ND AVE SOUTH", city: "MINNEAPOLIS",
                       state: "MN", zip: "55479"}}

Link to this section Summary

Functions

get_bank(routing_number)

Looks up bank info via the routing number passed

routing_number_valid?(routing_number)

Validates the routing number. Can be passed any Elixir term

start(type, args)

Called when an application is started

Link to this section Functions

get_bank(routing_number)

get_bank(any()) :: {:ok, Bank} | {:error, :not_found | :invalid}

Looks up bank info via the routing number passed.

Examples

iex> ABA.get_bank("111900659")
{:ok, %ABA.Bank{routing_number: "111900659", name: "WELLS FARGO BANK",
                       address: "255 2ND AVE SOUTH", city: "MINNEAPOLIS",
                       state: "MN", zip: "55479"}}

iex> ABA.get_bank("111XXX659")
{:error, :invalid}

routing_number_valid?(routing_number)

Validates the routing number. Can be passed any Elixir term.

Examples

iex> ABA.routing_number_valid?("111900659")
true

iex> ABA.routing_number_valid?("111900658")
false

start(type, args)

start(any(), any()) :: {:ok, pid()} | {:error, any()}

Called when an application is started.

This function is called when an application is started using Application.start/2 (and functions on top of that, such as Application.ensure_started/2). This function should start the top-level process of the application (which should be the top supervisor of the application’s supervision tree if the application follows the OTP design principles around supervision).

start_type defines how the application is started:

:normal - used if the startup is a normal startup or if the application is distributed and is started on the current node because of a failover from another node and the application specification key :start_phases is :undefined.
{:takeover, node} - used if the application is distributed and is started on the current node because of a failover on the node node.
{:failover, node} - used if the application is distributed and is started on the current node because of a failover on node node, and the application specification key :start_phases is not :undefined.

start_args are the arguments passed to the application in the :mod specification key (e.g., mod: {MyApp, [:my_args]}).

This function should either return {:ok, pid} or {:ok, pid, state} if startup is successful. pid should be the PID of the top supervisor. state can be an arbitrary term, and if omitted will default to []; if the application is later stopped, state is passed to the stop/1 callback (see the documentation for the c:stop/1 callback for more information).

use Application provides no default implementation for the start/2 callback.

Callback implementation for Application.start/2.