From e3c0e6e5771ee406f5a47620addf12b2bb830f86 Mon Sep 17 00:00:00 2001 From: multi prise Date: Sat, 26 Dec 2020 23:15:50 +0000 Subject: wrote interface for account_data corrected typo reformat --- lib/polyjuice/client/account.ex | 62 +++++++++++++++++++ lib/polyjuice/client/endpoint/get_account_data.ex | 55 +++++++++++++++++ lib/polyjuice/client/endpoint/put_account_data.ex | 69 ++++++++++++++++++++++ test/polyjuice/client/account_test.exs | 51 ++++++++++++++++ .../client/endpoint/get_account_data_test.exs | 53 +++++++++++++++++ .../client/endpoint/put_account_data_test.exs | 55 +++++++++++++++++ 6 files changed, 345 insertions(+) create mode 100644 lib/polyjuice/client/account.ex create mode 100644 lib/polyjuice/client/endpoint/get_account_data.ex create mode 100644 lib/polyjuice/client/endpoint/put_account_data.ex create mode 100644 test/polyjuice/client/account_test.exs create mode 100644 test/polyjuice/client/endpoint/get_account_data_test.exs create mode 100644 test/polyjuice/client/endpoint/put_account_data_test.exs diff --git a/lib/polyjuice/client/account.ex b/lib/polyjuice/client/account.ex new file mode 100644 index 0000000..0ad18c0 --- /dev/null +++ b/lib/polyjuice/client/account.ex @@ -0,0 +1,62 @@ +# Copyright 2020 Multi Prise +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +defmodule Polyjuice.Client.Account do + @moduledoc """ + Account related functions. + """ + + @doc """ + Get the data on an account + `event_type` : type of event queried + `user_id`: User concerned by the event + """ + @spec get_data( + client_api :: Polyjuice.Client.API.t(), + user_id :: String.t(), + event_type :: String.t() + ) :: {:ok, map()} | any + def get_data(client_api, user_id, event_type) do + Polyjuice.Client.API.call( + client_api, + %Polyjuice.Client.Endpoint.GetAccountData{ + user_id: user_id, + type: event_type + } + ) + end + + @doc """ + Put the data on an account + `event_type` : type of event requiring modifications + `changes`: New changes + `user_id`: User concerned by the event + """ + @spec put_data( + client_api :: Polyjuice.Client.API.t(), + user_id :: String.t(), + event_type :: String.t(), + changes :: Map.t() + ) :: {:ok} | any + def put_data(client_api, user_id, event_type, changes) do + Polyjuice.Client.API.call( + client_api, + %Polyjuice.Client.Endpoint.PutAccountData{ + user_id: user_id, + type: event_type, + account_data: changes + } + ) + end +end diff --git a/lib/polyjuice/client/endpoint/get_account_data.ex b/lib/polyjuice/client/endpoint/get_account_data.ex new file mode 100644 index 0000000..ffb2110 --- /dev/null +++ b/lib/polyjuice/client/endpoint/get_account_data.ex @@ -0,0 +1,55 @@ +# Copyright 2020 Multi Prise +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +defmodule Polyjuice.Client.Endpoint.GetAccountData do + @moduledoc """ + Set some account_data for the client. + https://matrix.org/docs/spec/client_server/r0.6.1#get-matrix-client-r0-user-userid-account-data-type + """ + + @type t :: %__MODULE__{ + user_id: String.t(), + type: String.t() + } + + @enforce_keys [:user_id, :type] + + defstruct [ + :user_id, + :type + ] + + defimpl Polyjuice.Client.Endpoint.Proto do + def http_spec(%Polyjuice.Client.Endpoint.GetAccountData{ + user_id: user_id, + type: type + }) do + e = &URI.encode_www_form/1 + + Polyjuice.Client.Endpoint.HttpSpec.get( + :r0, + "user/#{e.(user_id)}/account_data/#{e.(type)}", + auth_required: true, + headers: [ + {"Accept", "application/json"}, + {"Content-Type", "application/json"} + ] + ) + end + + def transform_http_result(req, status_code, resp_headers, body) do + Polyjuice.Client.Endpoint.parse_response(req, status_code, resp_headers, body) + end + end +end diff --git a/lib/polyjuice/client/endpoint/put_account_data.ex b/lib/polyjuice/client/endpoint/put_account_data.ex new file mode 100644 index 0000000..f29caad --- /dev/null +++ b/lib/polyjuice/client/endpoint/put_account_data.ex @@ -0,0 +1,69 @@ +# Copyright 2020 Multi Prise +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +defmodule Polyjuice.Client.Endpoint.PutAccountData do + @moduledoc """ + Set some account_data for the client. + https://matrix.org/docs/spec/client_server/r0.6.1#put-matrix-client-r0-user-userid-account-data-type + """ + + @type t :: %__MODULE__{ + user_id: String.t(), + type: String.t(), + account_data: Map.t() + } + + @enforce_keys [:user_id, :type] + + defstruct [ + :user_id, + :type, + :account_data + ] + + defimpl Polyjuice.Client.Endpoint.Proto do + def http_spec(%Polyjuice.Client.Endpoint.PutAccountData{ + user_id: user_id, + type: type, + account_data: account_data + }) do + e = &URI.encode_www_form/1 + + body = + account_data + |> Jason.encode!() + + Polyjuice.Client.Endpoint.HttpSpec.put( + :r0, + "user/#{e.(user_id)}/account_data/#{e.(type)}", + headers: [ + {"Accept", "application/json"}, + {"Content-Type", "application/json"} + ], + body: body, + auth_required: true + ) + end + + def transform_http_result(req, status_code, resp_headers, body) do + Polyjuice.Client.Endpoint.parse_response(req, status_code, resp_headers, body) + end + end + + defimpl Polyjuice.Client.Endpoint.BodyParser do + def parse(_req, _body) do + :ok + end + end +end diff --git a/test/polyjuice/client/account_test.exs b/test/polyjuice/client/account_test.exs new file mode 100644 index 0000000..6f11d25 --- /dev/null +++ b/test/polyjuice/client/account_test.exs @@ -0,0 +1,51 @@ +# Copyright 2020 Multi Prise +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +defmodule Polyjuice.Client.AccountTest do + use ExUnit.Case + doctest Polyjuice.Client.Account + + test "get account data" do + with client = %DummyClient{ + response: { + %Polyjuice.Client.Endpoint.GetAccountData{ + user_id: "toto@kazarma.local", + type: "name" + }, + {:ok, %{name: "toto"}} + } + } do + {:ok, %{name: name}} = + Polyjuice.Client.Account.get_data(client, "toto@kazarma.local", "name") + + assert name == "toto" + end + end + + test "put account data" do + with client = %DummyClient{ + response: { + %Polyjuice.Client.Endpoint.PutAccountData{ + user_id: "toto@kazarma.local", + type: "name", + account_data: %{name: "marc"} + }, + {:ok, %{}} + } + } do + {:ok, %{}} = + Polyjuice.Client.Account.put_data(client, "toto@kazarma.local", "name", %{name: "marc"}) + end + end +end diff --git a/test/polyjuice/client/endpoint/get_account_data_test.exs b/test/polyjuice/client/endpoint/get_account_data_test.exs new file mode 100644 index 0000000..c20ad8d --- /dev/null +++ b/test/polyjuice/client/endpoint/get_account_data_test.exs @@ -0,0 +1,53 @@ +# Copyright 2020 Multi Prise +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +defmodule Polyjuice.Client.Endpoint.GetAccountDataTest do + use ExUnit.Case + + test "GET /_matrix/client/r0/user/{userId}/account_data/{type}" do + with endpoint = %Polyjuice.Client.Endpoint.GetAccountData{ + type: "name", + user_id: "alice.Aexample.com" + } do + http_spec = Polyjuice.Client.Endpoint.Proto.http_spec(endpoint) + + assert http_spec == %Polyjuice.Client.Endpoint.HttpSpec{ + auth_required: true, + body: "", + headers: [ + {"Accept", "application/json"}, + {"Content-Type", "application/json"} + ], + method: :get, + path: "_matrix/client/r0/user/alice.Aexample.com/account_data/name" + } + + assert Polyjuice.Client.Endpoint.Proto.transform_http_result( + endpoint, + 200, + [{"Content-Type", "application/json"}], + "[{\"name\": \"alice\"}]" + ) == {:ok, [%{"name" => "alice"}]} + + assert Polyjuice.Client.Endpoint.Proto.transform_http_result( + endpoint, + 500, + [], + "Aaah!" + ) == + {:error, 500, + %{"body" => "Aaah!", "errcode" => "CA_UHOREG_POLYJUICE_BAD_RESPONSE"}} + end + end +end diff --git a/test/polyjuice/client/endpoint/put_account_data_test.exs b/test/polyjuice/client/endpoint/put_account_data_test.exs new file mode 100644 index 0000000..f58ed86 --- /dev/null +++ b/test/polyjuice/client/endpoint/put_account_data_test.exs @@ -0,0 +1,55 @@ +# Copyright 2020 Multi Prise +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +defmodule Polyjuice.Client.Endpoint.PutAccountDataTest do + use ExUnit.Case + + test "PUT /_matrix/client/r0/user/{userId}/account_data/{type}" do + endpoint = %Polyjuice.Client.Endpoint.PutAccountData{ + type: "name", + user_id: "alice:toto.com", + account_data: %{ + custom_account_data_key: "custom_config_value" + } + } + + http_spec = Polyjuice.Client.Endpoint.Proto.http_spec(endpoint) + + assert http_spec == %Polyjuice.Client.Endpoint.HttpSpec{ + auth_required: true, + body: "{\"custom_account_data_key\":\"custom_config_value\"}", + headers: [ + {"Accept", "application/json"}, + {"Content-Type", "application/json"} + ], + method: :put, + path: "_matrix/client/r0/user/alice%3Atoto.com/account_data/name" + } + + assert Polyjuice.Client.Endpoint.Proto.transform_http_result( + endpoint, + 200, + [{"Content-Type", "application/json"}], + "{}" + ) == :ok + + assert Polyjuice.Client.Endpoint.Proto.transform_http_result( + endpoint, + 500, + [], + "Aaah!" + ) == + {:error, 500, %{"body" => "Aaah!", "errcode" => "CA_UHOREG_POLYJUICE_BAD_RESPONSE"}} + end +end -- cgit v1.2.3