From dcd0050be5fc05d0460c5cc6508808ba8ab1cc7e Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 1 Nov 2016 12:42:12 +0000 Subject: adding exact return to in memory show user route --- lib/http_client/in_memory.ex | 37 +++++++++++++++++++++++++++++++++++-- 1 file changed, 35 insertions(+), 2 deletions(-) (limited to 'lib') diff --git a/lib/http_client/in_memory.ex b/lib/http_client/in_memory.ex index a448afd..46a53f5 100644 --- a/lib/http_client/in_memory.ex +++ b/lib/http_client/in_memory.ex @@ -26,9 +26,42 @@ defmodule Zendex.HttpClient.InMemory do fake_response("users") end - def get!("#{@base_url}/api/v2/users/87.json", + def get!("#{@base_url}/api/v2/users/295204.json", [{"Authorization", _authentication}]) do - fake_response(%{"user": %{"id": 87, "name": "Quim Stroud"}}) + 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", -- cgit v1.2.1 From 96cf6093809b049dd55efd6c10593b95ec2e5d03 Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 1 Nov 2016 13:19:48 +0000 Subject: adding doctest and example to show user function --- lib/zendex/user.ex | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) (limited to 'lib') diff --git a/lib/zendex/user.ex b/lib/zendex/user.ex index 31c3a06..4cae662 100644 --- a/lib/zendex/user.ex +++ b/lib/zendex/user.ex @@ -20,6 +20,29 @@ defmodule Zendex.User do @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 -- cgit v1.2.1 From bfee6d82bd6b5a259482d6398b913e68d680792a Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 1 Nov 2016 13:51:12 +0000 Subject: adding functionality to delete a user --- lib/http_client/in_memory.ex | 38 ++++++++++++++++++++++++++++++++++++++ lib/zendex/user.ex | 10 ++++++++++ 2 files changed, 48 insertions(+) (limited to 'lib') diff --git a/lib/http_client/in_memory.ex b/lib/http_client/in_memory.ex index 46a53f5..b74450e 100644 --- a/lib/http_client/in_memory.ex +++ b/lib/http_client/in_memory.ex @@ -82,5 +82,43 @@ defmodule Zendex.HttpClient.InMemory 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 4cae662..6873fb3 100644 --- a/lib/zendex/user.ex +++ b/lib/zendex/user.ex @@ -75,4 +75,14 @@ defmodule Zendex.User do |> CommonHelpers.decode_response end + @doc """ + Delete a user. + """ + @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)) + |> CommonHelpers.decode_response + end + end -- cgit v1.2.1 From dc3eabba821ff4f80ca417123629ca9ceb92eb51 Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 1 Nov 2016 14:01:08 +0000 Subject: adding doctest for deleting a user. --- lib/zendex/user.ex | 92 ++++++++++++++++++++++++++++++++++++++++++++---------- 1 file changed, 76 insertions(+), 16 deletions(-) (limited to 'lib') diff --git a/lib/zendex/user.ex b/lib/zendex/user.ex index 6873fb3..88487f3 100644 --- a/lib/zendex/user.ex +++ b/lib/zendex/user.ex @@ -26,22 +26,40 @@ defmodule Zendex.User do 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"}} + %{"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 @@ -77,6 +95,48 @@ 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 -- cgit v1.2.1 From bf62e2d177726a5921b485988c89764dd34eae3f Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 1 Nov 2016 14:19:53 +0000 Subject: adding ability to get related info on a user --- lib/http_client/in_memory.ex | 14 ++++++++++++++ lib/zendex/user.ex | 7 +++++++ 2 files changed, 21 insertions(+) (limited to 'lib') diff --git a/lib/http_client/in_memory.ex b/lib/http_client/in_memory.ex index b74450e..4c43211 100644 --- a/lib/http_client/in_memory.ex +++ b/lib/http_client/in_memory.ex @@ -70,6 +70,20 @@ defmodule Zendex.HttpClient.InMemory do %{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/tickets.json", "{\"ticket\":{}}", [{"Authorization", _authentication}, {"Content-Type", "application/json"}]) do diff --git a/lib/zendex/user.ex b/lib/zendex/user.ex index 88487f3..3983432 100644 --- a/lib/zendex/user.ex +++ b/lib/zendex/user.ex @@ -81,6 +81,13 @@ defmodule Zendex.User do |> CommonHelpers.decode_response end + @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)) + |> CommonHelpers.decode_response + end + @doc """ Create a new user. """ -- cgit v1.2.1 From 01b8203e4d97d08a6462c29bac8fccd11ee8fb97 Mon Sep 17 00:00:00 2001 From: Steven Blowers Date: Tue, 1 Nov 2016 14:29:44 +0000 Subject: adding doctest for user related info --- lib/zendex/user.ex | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'lib') diff --git a/lib/zendex/user.ex b/lib/zendex/user.ex index 3983432..9112b7f 100644 --- a/lib/zendex/user.ex +++ b/lib/zendex/user.ex @@ -81,6 +81,26 @@ defmodule Zendex.User do |> 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" -- cgit v1.2.1