diff options
| -rw-r--r-- | lib/zendex/connection.ex | 9 | ||||
| -rw-r--r-- | test/zendex/connection_test.exs | 2 |
2 files changed, 11 insertions, 0 deletions
diff --git a/lib/zendex/connection.ex b/lib/zendex/connection.ex index 248c253..5399f29 100644 --- a/lib/zendex/connection.ex +++ b/lib/zendex/connection.ex @@ -7,6 +7,15 @@ defmodule Zendex.Connection do @typedoc "The connection paramters" @type t :: %{base_url: String.t, authentication: binary} + @doc """ + Setup connection details with your Zendesk. + + ## Examples + + iex> Zendex.Connection.setup("http://example.zendesk.com", "ZendeskUser", "Password1") + %{authentication: "WmVuZGVza1VzZXI6UGFzc3dvcmQx", base_url: "http://example.zendesk.com"} + + """ @spec setup(String.t, String.t, String.t) :: t def setup(base_url, username, password) do authentication = Base.encode64("#{username}:#{password}") diff --git a/test/zendex/connection_test.exs b/test/zendex/connection_test.exs index 6608b44..bf2d238 100644 --- a/test/zendex/connection_test.exs +++ b/test/zendex/connection_test.exs @@ -1,6 +1,8 @@ defmodule Zendex.ConnectionTest do use ExUnit.Case, async: true + doctest Zendex.Connection + test "setup encodes username and password correctly" do expected = %{authentication: "WHhYQXdlc29tZVVzZXJuYW1lWHhYOnBhc3N3b3JkMTIz", base_url: ""} |