Twilio Magic Values

Provide elixir apps with simple, pragmatic access to magic testing values for the Twilio API. The module and function names help give you code that is easier to read and is less prone to typos. Automated tests in this project also ensure that you will know if the magic numbers ever change.

Installation

  • Require twilio_magic_values in your mix.exs deps.
def deps do
  [
    {:twilio_magic_values, "~> 1.0", only: :test}
  ]
end
  • This project is only needed for the test environment.
  • Don’t forget to run mix deps.get.

Usage

  • You do NOT need to include this in mix.exs applications or extra_applications.
  • Use the provided functions to replace hard coded magic phone numbers in your test code.

Examples:

  • Instead of testing sending a message to +15005550004, use: TwilioMagicValues.Messaging.blacklisted_recipient/1.
  • Instead of testing a call from +15005550001, use: TwilioMagicValues.Calling.invalid_caller_id/1.
  • Instead of testing a purchase for +15005550000, use: TwilioMagicValues.NumberPurchasing.unavailable_phone_number/1.

Pseudocode examples

alias TwilioMagicValues.Calling

make_test_call(from: Calling.valid_caller_id(),
               to: Calling.invalid_recipient(),
               ...)
alias TwilioMagicValues.NumberPurchasing

buy_test_number(exactly: NumberPurchasing.valid_phone_number())
alias TwilioMagicValues.Messaging

send_test_message(from: Messaging.valid_sender(),
                  to: Messaging.cant_receive_sms(),
                  ...)

Resources

Other useful Twilio projects in Elixir

Contributing

  • Issues and pull requests are welcome on GitHub.
  • Twilio doesn’t currently provide magic numbers for other parts of their APIs. If there is something they add new, or a magic number they offer which is otherwise missing from this project, please open an issue or pull request.
  • See CONTRIBUTING.md

License

GPL v3; See LICENSE file.

Author and Major Contributors

Written by Scott Swezey.

Made possible by the fantastic documentation and blog posts provided by Twilio.