{"id":20779612,"url":"https://github.com/smartlogic/augur","last_synced_at":"2025-04-30T19:45:11.359Z","repository":{"id":57479079,"uuid":"400256128","full_name":"smartlogic/augur","owner":"smartlogic","description":"Augur deals with sending SMS.","archived":false,"fork":false,"pushed_at":"2021-08-27T15:18:31.000Z","size":21,"stargazers_count":32,"open_issues_count":0,"forks_count":0,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-04-20T13:11:40.639Z","etag":null,"topics":["elixir"],"latest_commit_sha":null,"homepage":"","language":"Elixir","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smartlogic.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-08-26T17:43:20.000Z","updated_at":"2024-04-07T08:58:02.000Z","dependencies_parsed_at":"2022-09-17T04:21:53.068Z","dependency_job_id":null,"html_url":"https://github.com/smartlogic/augur","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Faugur","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Faugur/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Faugur/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smartlogic%2Faugur/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smartlogic","download_url":"https://codeload.github.com/smartlogic/augur/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251773158,"owners_count":21641572,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["elixir"],"created_at":"2024-11-17T13:28:57.270Z","updated_at":"2025-04-30T19:45:11.323Z","avatar_url":"https://github.com/smartlogic.png","language":"Elixir","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Augur\n\n\u003c!-- MDOC !--\u003e\n\nAugur deals with sending SMS.\n\n## Installation\n\nAdd Augur to your deps:\n\n```elixir\ndef deps do\n  [\n    {:augur, \"~\u003e 0.1.0\"}\n  ]\nend\n```\n\nInitialize `Augur` in your supervision tree with the service config\nthat you wish to boot with.\n\nFor example, if you're using [Vapor](https://github.com/keathley/vapor) you\ncan do something similar to:\n\n```elixir\ndef start(_type, _args) do\n  children = [\n    # ...\n    {Augur, augur_config()},\n    # ...\n  ]\n\n  # ...\nend\n\ndef augur_config() do\n  config = MyApp.Config.sms()\n\n  case config.provider do\n    \"development\" -\u003e\n      %Augur.Development{}\n\n    \"twilio\" -\u003e\n      %Augur.Twilio{\n        account_sid: config.twilio_account_sid,\n        auth_token: config.twilio_auth_token\n      }\n  end\nend\n```\n\n## Using Augur\n\nUsing Augur is simple. Load the current configuration from `Augur.Config` and then send a text.\n\nAn example [Oban Worker](https://github.com/sorentwo/oban) is provided below. You should strongly consider\nsending texts only in an out of band worker and not in a web request.\n\n```elixir\ndefmodule MyApp.SMSWorker do\n  use Oban, queue: :sms\n\n  def perform(%Oban.Job{args: text_message}) do\n    config = Augur.Config.get()\n\n    from = text_message[\"from\"]\n    to = text_message[\"to\"]\n    message = text_message[\"message\"]\n\n    case Augur.Service.send_text(config, from, to, message) do\n      :ok -\u003e\n        :ok\n\n      {:error, exception} -\u003e\n        raise exception\n    end\n  end\nend\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartlogic%2Faugur","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmartlogic%2Faugur","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmartlogic%2Faugur/lists"}