# Twilio Magic Values

Provide elixir apps with simple, pragmatic access to [magic testing values](https://www.twilio.com/docs/iam/test-credentials) for the [Twilio](https://www.twilio.com) 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.

```elixir
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

```elixir
alias TwilioMagicValues.Calling

make_test_call(from: Calling.valid_caller_id(),
               to: Calling.invalid_recipient(),
               ...)
```

```elixir
alias TwilioMagicValues.NumberPurchasing

buy_test_number(exactly: NumberPurchasing.valid_phone_number())
```

```elixir
alias TwilioMagicValues.Messaging

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

## Resources

- Docs are available at: [https://hexdocs.pm/twilio_magic_values](https://hexdocs.pm/twilio_magic_values).
- The Twilio docs for test credentials and magic phone numbers: [https://www.twilio.com/docs/iam/test-credentials](https://www.twilio.com/docs/iam/test-credentials)
- A Twilio authored blog post concerning test credentials and magic phone numbers: [https://www.twilio.com/blog/2018/04/twilio-test-credentials-magic-numbers.html](https://www.twilio.com/blog/2018/04/twilio-test-credentials-magic-numbers.html)

### Other useful Twilio projects in Elixir

- [https://github.com/danielberkompas/ex_twilio](https://github.com/danielberkompas/ex_twilio)
- [https://github.com/danielberkompas/telephonist](https://github.com/danielberkompas/telephonist)
- [https://github.com/danielberkompas/ex_twiml](https://github.com/danielberkompas/ex_twiml)
- Suggestions for this section are welcome. Please open an issue on GitHub.

## Contributing

- Issues and pull requests are welcome on [GitHub](https://github.com/scottswezey/twilio_magic_values).
- 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](https://github.com/scottswezey).

Made possible by the [fantastic documentation](https://www.twilio.com/docs/iam/test-credentials) and [blog posts](https://www.twilio.com/blog/2018/04/twilio-test-credentials-magic-numbers.html) provided by [Twilio](https://www.twilio.com).