Refactor goals API

pull/1542/head
Uku Taht 5 years ago
parent dcf31502c2
commit 97cdc4814e

@ -2,7 +2,7 @@ defmodule Plausible.Goal do
use Ecto.Schema
import Ecto.Changeset
@derive {Jason.Encoder, only: [:domain, :event_name, :page_path]}
@derive {Jason.Encoder, only: [:id, :domain, :event_name, :page_path]}
schema "goals" do
field :domain, :string
field :event_name, :string

@ -8,6 +8,28 @@ defmodule Plausible.Goals do
Goal.changeset(%Goal{}, params) |> Repo.insert()
end
def find_or_create(site, %{"goal_type" => "event", "event_name" => event_name}) do
goal = Repo.get_by(Plausible.Goal, domain: site.domain, event_name: event_name)
case goal do
nil -> create(site, %{"event_name" => event_name})
goal -> {:ok, goal}
end
end
def find_or_create(_, %{"goal_type" => "event"}), do: {:missing, "event_name"}
def find_or_create(site, %{"goal_type" => "page", "page_path" => page_path}) do
goal = Repo.get_by(Plausible.Goal, domain: site.domain, page_path: page_path)
case goal do
nil -> create(site, %{"page_path" => page_path})
goal -> {:ok, goal}
end
end
def find_or_create(_, %{"goal_type" => "page"}), do: {:missing, "page_path"}
def for_site(domain) do
Repo.all(
from g in Goal,

@ -83,91 +83,17 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
def find_or_create_goal(conn, params) do
with {:ok, site_id} <- expect_param_key(params, "site_id"),
{:ok, goal_type} <- expect_param_key(params, "goal_type"),
{:ok, _} <- expect_param_key(params, "goal_type"),
site when not is_nil(site) <-
Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner, :admin]) do
case goal_type do
"event" ->
with {:ok, event_name} <- expect_param_key(params, "event_name") do
goal = Repo.get_by(Plausible.Goal, domain: site_id, event_name: event_name)
goal =
case goal do
nil -> Goals.create(site, %{"event_name" => event_name})
goal -> {:ok, goal}
end
case goal do
{:ok, goal} ->
json(conn, %{
domain: site_id,
goal_id: goal.id,
goal_type: goal_type,
event_name: goal.event_name
})
nil ->
H.not_found(conn, "Goal could not be found")
end
else
nil ->
H.not_found(conn, "Goal could not be found")
{:missing, "event_name"} ->
H.bad_request(conn, "Parameter `event_name` is required to create a goal")
e ->
H.bad_request(conn, "Something went wrong: #{inspect(e)}")
end
"page" ->
with {:ok, page_path} <- expect_param_key(params, "page_path") do
goal = Repo.get_by(Plausible.Goal, domain: site_id, page_path: page_path)
goal =
case goal do
nil -> Goals.create(site, %{"page_path" => page_path})
goal -> {:ok, goal}
end
case goal do
{:ok, goal} ->
json(conn, %{
domain: site_id,
goal_id: goal.id,
goal_type: goal_type,
page_path: goal.page_path
})
nil ->
H.not_found(conn, "Goal could not be found")
end
else
nil ->
H.not_found(conn, "Goal could not be found")
{:missing, "page_path"} ->
H.bad_request(conn, "Parameter `page_path` is required to create a goal")
e ->
H.bad_request(conn, "Something went wrong: #{inspect(e)}")
end
_ ->
H.not_found(conn, "Invalid goal type")
end
Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner, :admin]),
{:ok, goal} <- Goals.find_or_create(site, params) do
json(conn, goal)
else
nil ->
H.not_found(conn, "Site could not be found")
{:missing, "site_id"} ->
H.bad_request(conn, "Parameter `site_id` is required to create a goal")
{:missing, "goal_type"} ->
H.bad_request(conn, "Parameter `goal_type` is required to create a goal")
{:missing, "goal_value"} ->
H.bad_request(conn, "Parameter `goal_value` is required to create a goal")
{:missing, param} ->
H.bad_request(conn, "Parameter `#{param}` is required to create a goal")
e ->
H.bad_request(conn, "Something went wrong: #{inspect(e)}")
@ -178,7 +104,7 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
with {:ok, site_id} <- expect_param_key(params, "site_id"),
{:ok, goal_id} <- expect_param_key(params, "goal_id"),
site when not is_nil(site) <-
Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner]) do
Sites.get_for_user(conn.assigns[:current_user].id, site_id, [:owner, :admin]) do
goal = Repo.get_by(Plausible.Goal, id: goal_id)
if goal do

@ -227,7 +227,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
event_name: "Signup"
})
%{"goal_id" => goal_id} = json_response(conn, 200)
%{"id" => goal_id} = json_response(conn, 200)
conn =
put(conn, "/api/v1/sites/goals", %{
@ -236,7 +236,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
event_name: "Signup"
})
assert %{"goal_id" => ^goal_id} = json_response(conn, 200)
assert %{"id" => ^goal_id} = json_response(conn, 200)
end
test "returns 400 when site id missing", %{conn: conn} do
@ -330,7 +330,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
event_name: "Signup"
})
%{"goal_id" => goal_id} = json_response(conn, 200)
%{"id" => goal_id} = json_response(conn, 200)
conn =
delete(conn, "/api/v1/sites/goals/#{goal_id}", %{
@ -354,7 +354,7 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
user: user
} do
site = insert(:site, members: [])
insert(:site_membership, user: user, site: site, role: :admin)
insert(:site_membership, user: user, site: site, role: :viewer)
conn =
delete(conn, "/api/v1/sites/goals/1", %{

Loading…
Cancel
Save