Packages

sms_up

0.1.0
1.4.2 1.4.1 1.4.0 1.3.8 1.3.7 1.3.6 1.3.5 1.3.4 1.3.3 1.3.2 1.3.1 1.3.0 1.2.1 1.2.0 1.1.1 1.1.0 1.0.8 1.0.7 1.0.6 1.0.5 1.0.4 1.0.3 1.0.2 1.0.1 1.0.0 0.5.0 0.3.1 0.3.0 0.2.0 0.1.0 0.0.1

Lib to use SmsUP api to send sms. It also provides a pin validation system to verify phone numbers or provide second factor system.

HexDocs

Current section

Files

Jump to
Readme
31 Versions
2 Dependencies
Dependants
Files
Activity
sms_up lib sms_up.ex
Raw

lib/sms_up.ex 

defmodule SmsUp do

  @moduledoc """

  Documentation for `SmsUp`.

  """



  @doc """

  Generate a pin code for the given id and store it in a mnesia database.

  Returns the generated pin code.



  ## Examples



      iex> SmsUp.store("user@email.ch")

      {:ok, "123456"}

  """

  @spec store(any) :: {:error, binary} | {:ok, binary}

  defdelegate store(id), to: SmsUp.Pin.Store



  @doc """

  Validate a pin code along with the user id and tells if the provided pin is correct or not.

  Returns a tupple containing true or false regarding the result.



  ## Examples

      iex> SmsUp.validate("user@email.ch", "Good Pin")

      {:ok, true}



      iex> SmsUp.validate("user@email.ch", "Wrong Pin")

      {:ok, false}

  """

  @spec validate(any, binary) :: {:ok, boolean}

  defdelegate validate(id, pin), to: SmsUp.Pin.Store

end