From e08eb7c1f4f9b2ac56433a465a4b07bbfc7e8530 Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 22 Nov 2016 13:37:00 +0000 Subject: trying out using meck on tickets module --- lib/http_client/in_memory.ex | 11 ----------- lib/zendex/ticket.ex | 5 ++--- mix.exs | 1 + mix.lock | 1 + test/zendex/ticket_test.exs | 24 +++++++++++++++++++++++- 5 files changed, 27 insertions(+), 15 deletions(-) diff --git a/lib/http_client/in_memory.ex b/lib/http_client/in_memory.ex index a448afd..eabe99f 100644 --- a/lib/http_client/in_memory.ex +++ b/lib/http_client/in_memory.ex @@ -6,11 +6,6 @@ defmodule Zendex.HttpClient.InMemory do @base_url "http://test.zendesk.com" - def get!(@base_url <> "/api/v2/tickets.json", - [{"Authorization", _authentication}]) do - fake_response("ticket") - end - def get!(@base_url <> "/api/v2/search.json?query=requester%3AJimbob+type%3Aticket", [{"Authorization", _authentication}]) do fake_response(["Jimbob Ticket 1", "Jimbob Ticket 2"]) @@ -37,12 +32,6 @@ defmodule Zendex.HttpClient.InMemory do %{id: 67, name: "Sarpedon Baumgartner"}]}) end - def post!(@base_url <> "/api/v2/tickets.json", - "{\"ticket\":{}}", - [{"Authorization", _authentication}, {"Content-Type", "application/json"}]) do - fake_response("Ticket created successfully!") - end - def post!(@base_url <> "/api/v2/users.json", "{\"user\":{\"name\":\"Roger\",\"email\":\"roger@dodger.com\"}}", [{"Authorization", _authentication}, {"Content-Type", "application/json"}]) do diff --git a/lib/zendex/ticket.ex b/lib/zendex/ticket.ex index 9232d6e..2aaf7ae 100644 --- a/lib/zendex/ticket.ex +++ b/lib/zendex/ticket.ex @@ -7,7 +7,6 @@ defmodule Zendex.Ticket do alias Zendex.CommonHelpers @url "/api/v2/tickets.json" - @http_client Application.get_env(:zendex, :http_client) @doc """ List all tickets. @@ -15,7 +14,7 @@ defmodule Zendex.Ticket do @spec list(Zendex.Connection.t) :: map def list(connection) do "#{connection.base_url}#{@url}" - |> @http_client.get!(CommonHelpers.get_headers(connection.authentication)) + |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication)) |> CommonHelpers.decode_response end @@ -25,7 +24,7 @@ defmodule Zendex.Ticket do @spec create(Zendex.Connection.t, map) :: map def create(connection, ticket) do "#{connection.base_url}#{@url}" - |> @http_client.post!(Poison.encode!(ticket), + |> HTTPoison.post!(Poison.encode!(ticket), CommonHelpers.get_headers(connection.authentication, %{content_type: :json})) |> CommonHelpers.decode_response diff --git a/mix.exs b/mix.exs index 41d57fd..b1b6160 100644 --- a/mix.exs +++ b/mix.exs @@ -24,6 +24,7 @@ defmodule Zendex.Mixfile do defp deps do [{:httpoison, "~> 0.9"}, {:poison, "~> 2.2"}, + {:meck, "~> 0.8.4", only: :test}, {:ex_doc, ">= 0.0.0", only: :dev}, {:credo, "~> 0.4", only: :dev}, {:dialyxir, "~> 0.3", only: :dev}, diff --git a/mix.lock b/mix.lock index 97e7b95..f4f1bb6 100644 --- a/mix.lock +++ b/mix.lock @@ -10,6 +10,7 @@ "httpoison": {:hex, :httpoison, "0.9.2", "a211a8e87403a043c41218e64df250d321f236ac57f786c6a0ccf3e9e817c819", [:mix], [{:hackney, "~> 1.6.0", [hex: :hackney, optional: false]}]}, "idna": {:hex, :idna, "1.2.0", "ac62ee99da068f43c50dc69acf700e03a62a348360126260e87f2b54eced86b2", [], []}, "jsx": {:hex, :jsx, "2.8.0", "749bec6d205c694ae1786d62cea6cc45a390437e24835fd16d12d74f07097727", [:mix, :rebar], []}, + "meck": {:hex, :meck, "0.8.4", "59ca1cd971372aa223138efcf9b29475bde299e1953046a0c727184790ab1520", [:make, :rebar], []}, "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [], []}, "mimerl": {:hex, :mimerl, "1.0.2", "993f9b0e084083405ed8252b99460c4f0563e41729ab42d9074fd5e52439be88", [], []}, "poison": {:hex, :poison, "2.2.0", "4763b69a8a77bd77d26f477d196428b741261a761257ff1cf92753a0d4d24a63", [], []}, diff --git a/test/zendex/ticket_test.exs b/test/zendex/ticket_test.exs index 6bc4436..4bbe388 100644 --- a/test/zendex/ticket_test.exs +++ b/test/zendex/ticket_test.exs @@ -5,11 +5,33 @@ defmodule Zendex.TicketTest do [conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")] end + setup_all do + :meck.new(HTTPoison) + + on_exit fn -> + :meck.unload + end + + :ok + end + test "getting tickets", context do - assert "ticket" == Zendex.Ticket.list(context[:conn]) + :meck.expect(HTTPoison, + :get!, + fn("http://test.zendesk.com/api/v2/tickets.json", [{"Authorization", "Basic VXNlcjpQYXNzdw=="}]) -> + %HTTPoison.Response{body: Poison.encode!("ticket")} + end) + + assert "ticket" == Zendex.Ticket.list(context[:conn]) end test "creating a ticket", context do + :meck.expect(HTTPoison, + :post!, + fn(_, _, _) -> + %HTTPoison.Response{body: Poison.encode!("Ticket created successfully!")} + end) + assert "Ticket created successfully!" == Zendex.Ticket.create(context[:conn], %{"ticket": %{}}) end -- cgit v1.2.1 From c680de5bf01c0dd313701de5be5be633ed7f41c4 Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 22 Nov 2016 14:57:39 +0000 Subject: improvements to using meck in tests --- test/zendex/ticket_test.exs | 42 +++++++++++++++++++++--------------------- 1 file changed, 21 insertions(+), 21 deletions(-) diff --git a/test/zendex/ticket_test.exs b/test/zendex/ticket_test.exs index 4bbe388..c4250d1 100644 --- a/test/zendex/ticket_test.exs +++ b/test/zendex/ticket_test.exs @@ -1,38 +1,38 @@ defmodule Zendex.TicketTest do - use ExUnit.Case, async: true + use ExUnit.Case, async: false setup do - [conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")] + %{conn: Zendex.Connection.setup("http://test.zendesk.com", + "User", + "Password123!")} end setup_all do :meck.new(HTTPoison) - - on_exit fn -> - :meck.unload - end - + on_exit fn -> :meck.unload end :ok end - test "getting tickets", context do - :meck.expect(HTTPoison, - :get!, - fn("http://test.zendesk.com/api/v2/tickets.json", [{"Authorization", "Basic VXNlcjpQYXNzdw=="}]) -> - %HTTPoison.Response{body: Poison.encode!("ticket")} - end) + test "getting tickets", %{conn: conn} do + stub = fn("http://test.zendesk.com/api/v2/tickets.json", + [{"Authorization", "Basic VXNlcjpQYXNzd29yZDEyMyE="}]) -> + %HTTPoison.Response{body: Poison.encode!("ticket")} + end + :meck.expect(HTTPoison, :get!, stub) - assert "ticket" == Zendex.Ticket.list(context[:conn]) + assert "ticket" == Zendex.Ticket.list(conn) end - test "creating a ticket", context do - :meck.expect(HTTPoison, - :post!, - fn(_, _, _) -> - %HTTPoison.Response{body: Poison.encode!("Ticket created successfully!")} - end) + test "creating a ticket", %{conn: conn} do + stub = fn("http://test.zendesk.com/api/v2/tickets.json", + "{\"ticket\":{\"title\":\"HELP!\"}}", + [{"Authorization", "Basic VXNlcjpQYXNzd29yZDEyMyE="}, + {"Content-Type", "application/json"}]) -> + %HTTPoison.Response{body: Poison.encode!("Ticket created successfully!")} + end + :meck.expect(HTTPoison, :post!, stub) assert "Ticket created successfully!" == - Zendex.Ticket.create(context[:conn], %{"ticket": %{}}) + Zendex.Ticket.create(conn, %{"ticket": %{"title": "HELP!"}}) end end -- cgit v1.2.1 From 04feaeb7d6c469b3000accb921ecea8d4d2d8d9d Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 22 Nov 2016 19:12:13 +0000 Subject: search test now using meck --- lib/zendex/search.ex | 3 +-- test/zendex/search_test.exs | 15 +++++++++++++++ 2 files changed, 16 insertions(+), 2 deletions(-) diff --git a/lib/zendex/search.ex b/lib/zendex/search.ex index ec9ea28..f920666 100644 --- a/lib/zendex/search.ex +++ b/lib/zendex/search.ex @@ -6,7 +6,6 @@ defmodule Zendex.Search do alias Zendex.CommonHelpers @url "/api/v2/search.json?query=" - @http_client Application.get_env(:zendex, :http_client) @doc """ Search Zendesk. @@ -18,7 +17,7 @@ defmodule Zendex.Search do sort_string = create_sort_string(sort_by, sort_order) "#{connection.base_url}#{@url}#{search_string}#{sort_string}" - |> @http_client.get!(CommonHelpers.get_headers(connection.authentication)) + |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication)) |> CommonHelpers.decode_response end diff --git a/test/zendex/search_test.exs b/test/zendex/search_test.exs index a7102b6..6a292d1 100644 --- a/test/zendex/search_test.exs +++ b/test/zendex/search_test.exs @@ -5,7 +5,18 @@ defmodule Zendex.SearchTest do [conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")] end + setup_all do + :meck.new(HTTPoison) + on_exit fn -> :meck.unload end + :ok + end + test "doing a search", context do + stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AJimbob+type%3Aticket", _) -> + %HTTPoison.Response{body: Poison.encode!(["Jimbob Ticket 1", "Jimbob Ticket 2"])} + end + :meck.expect(HTTPoison, :get!, stub) + expected = ["Jimbob Ticket 1", "Jimbob Ticket 2"] actual = Zendex.Search.query(context[:conn], @@ -15,6 +26,10 @@ defmodule Zendex.SearchTest do end test "doing a search with sorting", context do + stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AReginald+type%3Aticket&sort_by=created_at&sort_order=desc", _) -> + %HTTPoison.Response{body: Poison.encode!(["Reginald Ticket 1", "Reginald Ticket 2"])} + end + :meck.expect(HTTPoison, :get!, stub) expected = ["Reginald Ticket 1", "Reginald Ticket 2"] actual = Zendex.Search.query(context[:conn], -- cgit v1.2.1 From 7f7ab146f85c4eb4f9645b0d70109fd278e9561d Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 22 Nov 2016 19:13:16 +0000 Subject: removing unused in memory functions --- lib/http_client/in_memory.ex | 10 ---------- 1 file changed, 10 deletions(-) diff --git a/lib/http_client/in_memory.ex b/lib/http_client/in_memory.ex index 934115f..25f1def 100644 --- a/lib/http_client/in_memory.ex +++ b/lib/http_client/in_memory.ex @@ -6,16 +6,6 @@ defmodule Zendex.HttpClient.InMemory do @base_url "http://test.zendesk.com" - def get!(@base_url <> "/api/v2/search.json?query=requester%3AJimbob+type%3Aticket", - [{"Authorization", _authentication}]) do - fake_response(["Jimbob Ticket 1", "Jimbob Ticket 2"]) - end - - def get!(@base_url <> "/api/v2/search.json?query=requester%3AReginald+type%3Aticket&sort_by=created_at&sort_order=desc", - [{"Authorization", _authentication}]) do - fake_response(["Reginald Ticket 1", "Reginald Ticket 2"]) - end - def get!(@base_url <> "/api/v2/users.json", [{"Authorization", _authentication}]) do fake_response("users") -- cgit v1.2.1 From b8e4872ab277e8e889d852a2bc6aa19ec7972b9d Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 22 Nov 2016 19:15:38 +0000 Subject: using pattern matching with context --- test/zendex/search_test.exs | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/test/zendex/search_test.exs b/test/zendex/search_test.exs index 6a292d1..d1e2851 100644 --- a/test/zendex/search_test.exs +++ b/test/zendex/search_test.exs @@ -2,7 +2,7 @@ defmodule Zendex.SearchTest do use ExUnit.Case, async: true setup do - [conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")] + %{conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")} end setup_all do @@ -11,7 +11,7 @@ defmodule Zendex.SearchTest do :ok end - test "doing a search", context do + test "doing a search", %{conn: conn} do stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AJimbob+type%3Aticket", _) -> %HTTPoison.Response{body: Poison.encode!(["Jimbob Ticket 1", "Jimbob Ticket 2"])} end @@ -19,20 +19,19 @@ defmodule Zendex.SearchTest do expected = ["Jimbob Ticket 1", "Jimbob Ticket 2"] - actual = Zendex.Search.query(context[:conn], - %{type: "ticket", requester: "Jimbob"}) + actual = Zendex.Search.query(conn, %{type: "ticket", requester: "Jimbob"}) assert actual == expected end - test "doing a search with sorting", context do + test "doing a search with sorting", %{conn: conn} do stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AReginald+type%3Aticket&sort_by=created_at&sort_order=desc", _) -> %HTTPoison.Response{body: Poison.encode!(["Reginald Ticket 1", "Reginald Ticket 2"])} end :meck.expect(HTTPoison, :get!, stub) expected = ["Reginald Ticket 1", "Reginald Ticket 2"] - actual = Zendex.Search.query(context[:conn], + actual = Zendex.Search.query(conn, %{type: "ticket", requester: "Reginald"}, "created_at", "desc") -- cgit v1.2.1 From 1bfac92a35eb752c4ed6cc4a510d11786d1a01c8 Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 22 Nov 2016 19:39:45 +0000 Subject: finishing off using meck. had to delete doctests, as they don't work with meck --- config/config.exs | 2 - config/test.exs | 2 - lib/http_client/in_memory.ex | 117 ------------------------------------------- lib/zendex/user.ex | 113 +++-------------------------------------- test/zendex/search_test.exs | 2 +- test/zendex/user_test.exs | 49 ++++++++++++++++-- 6 files changed, 53 insertions(+), 232 deletions(-) delete mode 100644 lib/http_client/in_memory.ex diff --git a/config/config.exs b/config/config.exs index dd0aa56..c9c59bb 100644 --- a/config/config.exs +++ b/config/config.exs @@ -1,5 +1,3 @@ use Mix.Config -config :zendex, :http_client, HTTPoison - import_config "#{Mix.env}.exs" diff --git a/config/test.exs b/config/test.exs index b2a3ed8..d2d855e 100644 --- a/config/test.exs +++ b/config/test.exs @@ -1,3 +1 @@ use Mix.Config - -config :zendex, :http_client, Zendex.HttpClient.InMemory diff --git a/lib/http_client/in_memory.ex b/lib/http_client/in_memory.ex deleted file mode 100644 index 25f1def..0000000 --- a/lib/http_client/in_memory.ex +++ /dev/null @@ -1,117 +0,0 @@ -defmodule Zendex.HttpClient.InMemory do - @moduledoc """ - Allows testing of the Zendex project by mocking out calls to an actual Zendesk - API. - """ - - @base_url "http://test.zendesk.com" - - def get!(@base_url <> "/api/v2/users.json", - [{"Authorization", _authentication}]) do - fake_response("users") - end - - def get!("#{@base_url}/api/v2/users/295204.json", - [{"Authorization", _authentication}]) do - fake_response(%{"user" => %{"ticket_restriction" => nil, - "chat_only" => false, - "shared_phone_number" => nil, - "notes" => "", - "phone" => nil, - "organization_id" => 11129520411, - "last_login_at" => "2016-10-28T21:08:23Z", - "moderator" => true, - "shared" => false, - "id" => 295204, - "role" => "admin", - "external_id" => nil, - "shared_agent" => false, - "photo" => nil, - "verified" => true, - "active" => true, - "locale_id" => 1, - "suspended" => false, - "created_at" => "2015-05-28T09:12:45Z", - "name" => "Nikolao Aikema", - "restricted_agent" => false, - "locale" => "en-US", - "details" => "", - "alias" => nil, - "url" => "https://test.zendesk.com/api/v2/users/295204.json", - "custom_role_id" => nil, - "email" => "nikolao.aikema@test.com", - "signature" => nil, - "two_factor_auth_enabled" => nil, - "time_zone" => "London", - "only_private_comments" => false, - "user_fields" => %{"customer_complaint" => nil}, - "tags" => [], - "updated_at" => "2016-10-28T21:08:23Z"}}) - end - - def get!("#{@base_url}/api/v2/users/show_many.json?ids=6,67", - [{"Authorization", _authentication}]) do - fake_response(%{users: [%{id: 6, name: "Kiki Segal"}, - %{id: 67, name: "Sarpedon Baumgartner"}]}) - end - - def get!("#{@base_url}/api/v2/users/649267/related.json", - [{"Authorization", _authentication}]) do - fake_response(%{"user_related" => %{"assigned_tickets" => 12, - "ccd_tickets" => 5, - "entry_subscriptions" => 1, - "forum_subscriptions" => 3, - "organization_subscriptions" => 1, - "requested_tickets" => 7, - "subscriptions" => 6, - "topic_comments" => 116, - "topics" => 5, - "votes" => 2001}}) - end - - def post!(@base_url <> "/api/v2/users.json", - "{\"user\":{\"name\":\"Roger\",\"email\":\"roger@dodger.com\"}}", - [{"Authorization", _authentication}, {"Content-Type", "application/json"}]) do - fake_response(%{user: %{id: 1234, name: "Roger", email: "roger@dodger.com"}}) - end - - def delete!("#{@base_url}/api/v2/users/49043.json", - [{"Authorization", _authentication}]) do - fake_response(%{"user" => %{"ticket_restriction" => nil, - "chat_only" => false, - "shared_phone_number" => nil, - "notes" => "", - "phone" => nil, - "organization_id" => 149043, - "last_login_at" => "2016-10-28T21:08:23Z", - "moderator" => true, - "shared" => false, - "id" => 49043, - "role" => "admin", - "external_id" => nil, - "shared_agent" => false, - "photo" => nil, - "verified" => true, - "active" => false, - "locale_id" => 1, - "suspended" => false, - "created_at" => "2015-05-28T09:12:45Z", - "name" => "Rian Hawkins", - "restricted_agent" => false, - "locale" => "en-US", - "details" => "", - "alias" => nil, - "url" => "https://test.zendesk.com/api/v2/users/49043.json", - "custom_role_id" => nil, - "email" => "rian.hawkins@test.com", - "signature" => nil, - "two_factor_auth_enabled" => nil, - "time_zone" => "London", - "only_private_comments" => false, - "user_fields" => %{"customer_complaint" => nil}, - "tags" => [], - "updated_at" => "2016-10-28T21:08:23Z"}}) - end - - defp fake_response(body), do: %{body: Poison.encode!(body)} -end diff --git a/lib/zendex/user.ex b/lib/zendex/user.ex index 9112b7f..719d2ab 100644 --- a/lib/zendex/user.ex +++ b/lib/zendex/user.ex @@ -6,7 +6,6 @@ defmodule Zendex.User do alias Zendex.CommonHelpers @url "/api/v2/users" - @http_client Application.get_env(:zendex, :http_client) @doc """ List all users. @@ -14,58 +13,17 @@ defmodule Zendex.User do @spec list(Zendex.Connection.t) :: map def list(connection) do "#{connection.base_url}#{@url}.json" - |> @http_client.get!(CommonHelpers.get_headers(connection.authentication)) + |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication)) |> CommonHelpers.decode_response end @doc """ Show a specific user, given their id. - - ## Examples - - iex> conn = Zendex.Connection.setup("http://test.zendesk.com", "ZendeskUser", "Password1") - %{authentication: "WmVuZGVza1VzZXI6UGFzc3dvcmQx", base_url: "http://test.zendesk.com"} - iex> Zendex.User.show(conn, 295204) - %{"user" => %{"ticket_restriction" => nil, - "chat_only" => false, - "shared_phone_number" => nil, - "notes" => "", - "phone" => nil, - "organization_id" => 11129520411, - "last_login_at" => "2016-10-28T21:08:23Z", - "moderator" => true, - "shared" => false, - "id" => 295204, - "role" => "admin", - "external_id" => nil, - "shared_agent" => false, - "photo" => nil, - "verified" => true, - "active" => true, - "locale_id" => 1, - "suspended" => false, - "created_at" => "2015-05-28T09:12:45Z", - "name" => "Nikolao Aikema", - "restricted_agent" => false, - "locale" => "en-US", - "details" => "", - "alias" => nil, - "url" => "https://test.zendesk.com/api/v2/users/295204.json", - "custom_role_id" => nil, - "email" => "nikolao.aikema@test.com", - "signature" => nil, - "two_factor_auth_enabled" => nil, - "time_zone" => "London", - "only_private_comments" => false, - "user_fields" => %{"customer_complaint" => nil}, - "tags" => [], - "updated_at" => "2016-10-28T21:08:23Z"}} - """ @spec show(Zendex.Connection.t, integer) :: map def show(connection, id) do "#{connection.base_url}#{@url}/#{id}.json" - |> @http_client.get!(CommonHelpers.get_headers(connection.authentication)) + |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication)) |> CommonHelpers.decode_response end @@ -77,34 +35,17 @@ defmodule Zendex.User do ids = Enum.join(ids, ",") "#{connection.base_url}#{@url}/show_many.json?ids=#{ids}" - |> @http_client.get!(CommonHelpers.get_headers(connection.authentication)) + |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication)) |> CommonHelpers.decode_response end @doc """ Show information relating to the user, example: number of assigned tickets. - - ## Examples - - iex> conn = Zendex.Connection.setup("http://test.zendesk.com", "ZendeskUser", "Password1") - %{authentication: "WmVuZGVza1VzZXI6UGFzc3dvcmQx", base_url: "http://test.zendesk.com"} - iex> Zendex.User.related_information(conn, 649267) - %{"user_related" => %{"assigned_tickets" => 12, - "ccd_tickets" => 5, - "entry_subscriptions" => 1, - "forum_subscriptions" => 3, - "organization_subscriptions" => 1, - "requested_tickets" => 7, - "subscriptions" => 6, - "topic_comments" => 116, - "topics" => 5, - "votes" => 2001}} - """ @spec related_information(Zendex.Connection.t, integer) :: map def related_information(connection, id) do "#{connection.base_url}#{@url}/#{id}/related.json" - |> @http_client.get!(CommonHelpers.get_headers(connection.authentication)) + |> HTTPoison.get!(CommonHelpers.get_headers(connection.authentication)) |> CommonHelpers.decode_response end @@ -114,7 +55,7 @@ defmodule Zendex.User do @spec create(Zendex.Connection.t, map) :: map def create(connection, user) do "#{connection.base_url}#{@url}.json" - |> @http_client.post!(Poison.encode!(user), + |> HTTPoison.post!(Poison.encode!(user), CommonHelpers.get_headers(connection.authentication, %{content_type: :json})) |> CommonHelpers.decode_response @@ -122,53 +63,11 @@ defmodule Zendex.User do @doc """ Delete a user. - - ## Examples - - iex> conn = Zendex.Connection.setup("http://test.zendesk.com", "ZendeskUser", "Password1") - %{authentication: "WmVuZGVza1VzZXI6UGFzc3dvcmQx", base_url: "http://test.zendesk.com"} - iex> Zendex.User.delete(conn, 49043) - %{"user" => %{"ticket_restriction" => nil, - "chat_only" => false, - "shared_phone_number" => nil, - "notes" => "", - "phone" => nil, - "organization_id" => 149043, - "last_login_at" => "2016-10-28T21:08:23Z", - "moderator" => true, - "shared" => false, - "id" => 49043, - "role" => "admin", - "external_id" => nil, - "shared_agent" => false, - "photo" => nil, - "verified" => true, - "active" => false, - "locale_id" => 1, - "suspended" => false, - "created_at" => "2015-05-28T09:12:45Z", - "name" => "Rian Hawkins", - "restricted_agent" => false, - "locale" => "en-US", - "details" => "", - "alias" => nil, - "url" => "https://test.zendesk.com/api/v2/users/49043.json", - "custom_role_id" => nil, - "email" => "rian.hawkins@test.com", - "signature" => nil, - "two_factor_auth_enabled" => nil, - "time_zone" => "London", - "only_private_comments" => false, - "user_fields" => %{"customer_complaint" => nil}, - "tags" => [], - "updated_at" => "2016-10-28T21:08:23Z"}} - - """ @spec show(Zendex.Connection.t, integer) :: map def delete(connection, id) do "#{connection.base_url}#{@url}/#{id}.json" - |> @http_client.delete!(CommonHelpers.get_headers(connection.authentication)) + |> HTTPoison.delete!(CommonHelpers.get_headers(connection.authentication)) |> CommonHelpers.decode_response end diff --git a/test/zendex/search_test.exs b/test/zendex/search_test.exs index d1e2851..a5b6405 100644 --- a/test/zendex/search_test.exs +++ b/test/zendex/search_test.exs @@ -1,5 +1,5 @@ defmodule Zendex.SearchTest do - use ExUnit.Case, async: true + use ExUnit.Case, async: false setup do %{conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")} diff --git a/test/zendex/user_test.exs b/test/zendex/user_test.exs index f61ef13..5d07c73 100644 --- a/test/zendex/user_test.exs +++ b/test/zendex/user_test.exs @@ -1,14 +1,26 @@ defmodule Zendex.UserTest do - use ExUnit.Case, async: true + use ExUnit.Case, async: false - doctest Zendex.User + @base_url "http://test.zendesk.com" setup do - [conn: Zendex.Connection.setup("http://test.zendesk.com", "User1", "pass")] + [conn: Zendex.Connection.setup(@base_url, "User1", "pass")] + end + + setup_all do + :meck.new(HTTPoison) + on_exit fn -> :meck.unload end + :ok end test "list users", context do expected = "users" + + stub = fn("#{@base_url}/api/v2/users.json", _) -> + %HTTPoison.Response{body: Poison.encode!(expected)} + end + :meck.expect(HTTPoison, :get!, stub) + actual = Zendex.User.list(context[:conn]) assert expected == actual @@ -49,6 +61,12 @@ defmodule Zendex.UserTest do "user_fields" => %{"customer_complaint" => nil}, "tags" => [], "updated_at" => "2016-10-28T21:08:23Z"}} + + stub = fn("#{@base_url}/api/v2/users/295204.json", _) -> + %HTTPoison.Response{body: Poison.encode!(expected)} + end + :meck.expect(HTTPoison, :get!, stub) + actual = Zendex.User.show(context[:conn], 295204) assert expected == actual @@ -57,6 +75,12 @@ defmodule Zendex.UserTest do test "showing many users", context do expected = %{"users" => [%{"id" => 6, "name" => "Kiki Segal"}, %{"id" => 67, "name" => "Sarpedon Baumgartner"}]} + + stub = fn("#{@base_url}/api/v2/users/show_many.json?ids=6,67", _) -> + %HTTPoison.Response{body: Poison.encode!(expected)} + end + :meck.expect(HTTPoison, :get!, stub) + actual = Zendex.User.show_many(context[:conn], [6,67]) assert expected == actual @@ -73,6 +97,12 @@ defmodule Zendex.UserTest do "topic_comments" => 116, "topics" => 5, "votes" => 2001}} + + stub = fn("#{@base_url}/api/v2/users/649267/related.json", _) -> + %HTTPoison.Response{body: Poison.encode!(expected)} + end + :meck.expect(HTTPoison, :get!, stub) + actual = Zendex.User.related_information(context[:conn], 649267) assert expected == actual @@ -80,6 +110,13 @@ defmodule Zendex.UserTest do test "creating a user", context do expected = %{"user" => %{"id" => 1234, "name" => "Roger", "email" => "roger@dodger.com"}} + + stub = fn("#{@base_url}/api/v2/users.json", _, _) -> + %HTTPoison.Response{body: Poison.encode!(expected)} + end + :meck.expect(HTTPoison, :post!, stub) + + actual = Zendex.User.create(context[:conn], %{user: %{name: "Roger", email: "roger@dodger.com"}}) assert expected == actual @@ -120,6 +157,12 @@ defmodule Zendex.UserTest do "user_fields" => %{"customer_complaint" => nil}, "tags" => [], "updated_at" => "2016-10-28T21:08:23Z"}} + + stub = fn("#{@base_url}/api/v2/users/49043.json", _) -> + %HTTPoison.Response{body: Poison.encode!(expected)} + end + :meck.expect(HTTPoison, :delete!, stub) + actual = Zendex.User.delete(context[:conn], 49043) assert expected == actual -- cgit v1.2.1 From 5473dacfe2da5ca3dbe38360b49be7f1611d092b Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 22 Nov 2016 19:48:02 +0000 Subject: minor improvements to test --- test/zendex/search_test.exs | 15 ++++++++------- test/zendex/ticket_test.exs | 22 +++++++++++----------- test/zendex/user_test.exs | 26 +++++++++++++------------- 3 files changed, 32 insertions(+), 31 deletions(-) diff --git a/test/zendex/search_test.exs b/test/zendex/search_test.exs index a5b6405..bb1f358 100644 --- a/test/zendex/search_test.exs +++ b/test/zendex/search_test.exs @@ -12,24 +12,25 @@ defmodule Zendex.SearchTest do end test "doing a search", %{conn: conn} do - stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AJimbob+type%3Aticket", _) -> - %HTTPoison.Response{body: Poison.encode!(["Jimbob Ticket 1", "Jimbob Ticket 2"])} + expected = ["Jimbob Ticket 1", "Jimbob Ticket 2"] + + stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AJimbob+type%3Aticket", _headers) -> + %HTTPoison.Response{body: Poison.encode!(expected)} end :meck.expect(HTTPoison, :get!, stub) - expected = ["Jimbob Ticket 1", "Jimbob Ticket 2"] - actual = Zendex.Search.query(conn, %{type: "ticket", requester: "Jimbob"}) assert actual == expected end test "doing a search with sorting", %{conn: conn} do - stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AReginald+type%3Aticket&sort_by=created_at&sort_order=desc", _) -> - %HTTPoison.Response{body: Poison.encode!(["Reginald Ticket 1", "Reginald Ticket 2"])} + expected = ["Reginald Ticket 1", "Reginald Ticket 2"] + + stub = fn("http://test.zendesk.com/api/v2/search.json?query=requester%3AReginald+type%3Aticket&sort_by=created_at&sort_order=desc", _headers) -> + %HTTPoison.Response{body: Poison.encode!(expected)} end :meck.expect(HTTPoison, :get!, stub) - expected = ["Reginald Ticket 1", "Reginald Ticket 2"] actual = Zendex.Search.query(conn, %{type: "ticket", requester: "Reginald"}, diff --git a/test/zendex/ticket_test.exs b/test/zendex/ticket_test.exs index c4250d1..2b5a3ce 100644 --- a/test/zendex/ticket_test.exs +++ b/test/zendex/ticket_test.exs @@ -2,9 +2,7 @@ defmodule Zendex.TicketTest do use ExUnit.Case, async: false setup do - %{conn: Zendex.Connection.setup("http://test.zendesk.com", - "User", - "Password123!")} + %{conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")} end setup_all do @@ -14,25 +12,27 @@ defmodule Zendex.TicketTest do end test "getting tickets", %{conn: conn} do - stub = fn("http://test.zendesk.com/api/v2/tickets.json", - [{"Authorization", "Basic VXNlcjpQYXNzd29yZDEyMyE="}]) -> - %HTTPoison.Response{body: Poison.encode!("ticket")} + expected = "ticket" + + stub = fn("http://test.zendesk.com/api/v2/tickets.json", _headers) -> + %HTTPoison.Response{body: Poison.encode!(expected)} end :meck.expect(HTTPoison, :get!, stub) - assert "ticket" == Zendex.Ticket.list(conn) + assert expected == Zendex.Ticket.list(conn) end test "creating a ticket", %{conn: conn} do + expected = "Ticket created successfully!" + stub = fn("http://test.zendesk.com/api/v2/tickets.json", "{\"ticket\":{\"title\":\"HELP!\"}}", - [{"Authorization", "Basic VXNlcjpQYXNzd29yZDEyMyE="}, - {"Content-Type", "application/json"}]) -> - %HTTPoison.Response{body: Poison.encode!("Ticket created successfully!")} + _headers) -> + %HTTPoison.Response{body: Poison.encode!(expected)} end :meck.expect(HTTPoison, :post!, stub) - assert "Ticket created successfully!" == + assert expected == Zendex.Ticket.create(conn, %{"ticket": %{"title": "HELP!"}}) end end diff --git a/test/zendex/user_test.exs b/test/zendex/user_test.exs index 5d07c73..a1cee50 100644 --- a/test/zendex/user_test.exs +++ b/test/zendex/user_test.exs @@ -4,7 +4,7 @@ defmodule Zendex.UserTest do @base_url "http://test.zendesk.com" setup do - [conn: Zendex.Connection.setup(@base_url, "User1", "pass")] + %{conn: Zendex.Connection.setup("http://test.zendesk.com", "User", "Passw")} end setup_all do @@ -13,7 +13,7 @@ defmodule Zendex.UserTest do :ok end - test "list users", context do + test "list users", %{conn: conn} do expected = "users" stub = fn("#{@base_url}/api/v2/users.json", _) -> @@ -21,12 +21,12 @@ defmodule Zendex.UserTest do end :meck.expect(HTTPoison, :get!, stub) - actual = Zendex.User.list(context[:conn]) + actual = Zendex.User.list(conn) assert expected == actual end - test "showing a user", context do + test "showing a user", %{conn: conn} do expected = %{"user" => %{"ticket_restriction" => nil, "chat_only" => false, "shared_phone_number" => nil, @@ -67,12 +67,12 @@ defmodule Zendex.UserTest do end :meck.expect(HTTPoison, :get!, stub) - actual = Zendex.User.show(context[:conn], 295204) + actual = Zendex.User.show(conn, 295204) assert expected == actual end - test "showing many users", context do + test "showing many users", %{conn: conn} do expected = %{"users" => [%{"id" => 6, "name" => "Kiki Segal"}, %{"id" => 67, "name" => "Sarpedon Baumgartner"}]} @@ -81,12 +81,12 @@ defmodule Zendex.UserTest do end :meck.expect(HTTPoison, :get!, stub) - actual = Zendex.User.show_many(context[:conn], [6,67]) + actual = Zendex.User.show_many(conn, [6,67]) assert expected == actual end - test "getting related info on a user", context do + test "getting related info on a user", %{conn: conn} do expected = %{"user_related" => %{"assigned_tickets" => 12, "ccd_tickets" => 5, "entry_subscriptions" => 1, @@ -103,12 +103,12 @@ defmodule Zendex.UserTest do end :meck.expect(HTTPoison, :get!, stub) - actual = Zendex.User.related_information(context[:conn], 649267) + actual = Zendex.User.related_information(conn, 649267) assert expected == actual end - test "creating a user", context do + test "creating a user", %{conn: conn} do expected = %{"user" => %{"id" => 1234, "name" => "Roger", "email" => "roger@dodger.com"}} stub = fn("#{@base_url}/api/v2/users.json", _, _) -> @@ -117,12 +117,12 @@ defmodule Zendex.UserTest do :meck.expect(HTTPoison, :post!, stub) - actual = Zendex.User.create(context[:conn], %{user: %{name: "Roger", email: "roger@dodger.com"}}) + actual = Zendex.User.create(conn, %{user: %{name: "Roger", email: "roger@dodger.com"}}) assert expected == actual end - test "deleting a user", context do + test "deleting a user", %{conn: conn} do expected = %{"user" => %{"ticket_restriction" => nil, "chat_only" => false, "shared_phone_number" => nil, @@ -163,7 +163,7 @@ defmodule Zendex.UserTest do end :meck.expect(HTTPoison, :delete!, stub) - actual = Zendex.User.delete(context[:conn], 49043) + actual = Zendex.User.delete(conn, 49043) assert expected == actual end -- cgit v1.2.1