Update shared link API

pull/941/head
Uku Taht 6 years ago
parent 956e92f161
commit 70f0657327

@ -3,6 +3,7 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
use Plausible.Repo
use Plug.ErrorHandler
alias Plausible.Sites
alias PlausibleWeb.Api.Helpers, as: H
def create_site(conn, params) do
user_id = conn.assigns[:current_user_id]
@ -18,8 +19,16 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
end
end
def find_or_create_shared_link(conn, %{"link_name" => link_name} = params) do
with {:ok, site_id} <- Map.fetch(params, "site_id"),
defp expect_param_key(params, key) do
case Map.fetch(params, key) do
:error -> {:missing, key}
res -> res
end
end
def find_or_create_shared_link(conn, params) do
with {:ok, site_id} <- expect_param_key(params, "site_id"),
{:ok, link_name} <- expect_param_key(params, "name"),
site when not is_nil(site) <- Sites.get_for_user(conn.assigns[:current_user_id], site_id) do
shared_link = Repo.get_by(Plausible.Site.SharedLink, site_id: site.id, name: link_name)
@ -38,19 +47,16 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
end
else
nil ->
conn
|> put_status(404)
|> json(%{error: "Site could not be found"})
H.not_found(conn, "Site could not be found")
:error ->
conn
|> put_status(400)
|> json(%{error: "Query parameter `site_id` is required to create a shared link"})
{:missing, "site_id"} ->
H.bad_request(conn, "Parameter `site_id` is required to create a shared link")
{:missing, "name"} ->
H.bad_request(conn, "Parameter `name` is required to create a shared link")
e ->
conn
|> put_status(400)
|> json(%{error: "Something went wrong: #{inspect(e)}"})
H.bad_request(400, "Something went wrong: #{inspect(e)}")
end
end

@ -0,0 +1,24 @@
defmodule PlausibleWeb.Api.Helpers do
import Plug.Conn
def unauthorized(conn, msg) do
conn
|> put_status(401)
|> Phoenix.Controller.json(%{error: msg})
|> halt()
end
def bad_request(conn, msg) do
conn
|> put_status(400)
|> Phoenix.Controller.json(%{error: msg})
|> halt()
end
def not_found(conn, msg) do
conn
|> put_status(404)
|> Phoenix.Controller.json(%{error: msg})
|> halt()
end
end

@ -2,6 +2,7 @@ defmodule PlausibleWeb.AuthorizeSitesApiPlug do
import Plug.Conn
use Plausible.Repo
alias Plausible.Auth.ApiKey
alias PlausibleWeb.Api.Helpers, as: H
def init(options) do
options
@ -13,13 +14,13 @@ defmodule PlausibleWeb.AuthorizeSitesApiPlug do
assign(conn, :current_user_id, api_key.user_id)
else
{:error, :missing_api_key} ->
unauthorized(
H.unauthorized(
conn,
"Missing API key. Please use a valid Plausible API key as a Bearer Token."
)
{:error, :invalid_api_key} ->
unauthorized(
H.unauthorized(
conn,
"Invalid API key. Please make sure you're using a valid API key with access to the resource you've requested."
)
@ -52,11 +53,4 @@ defmodule PlausibleWeb.AuthorizeSitesApiPlug do
_ -> {:error, :missing_api_key}
end
end
defp unauthorized(conn, msg) do
conn
|> put_status(401)
|> Phoenix.Controller.json(%{error: msg})
|> halt()
end
end

@ -2,6 +2,7 @@ defmodule PlausibleWeb.AuthorizeStatsApiPlug do
import Plug.Conn
use Plausible.Repo
alias Plausible.Auth.ApiKey
alias PlausibleWeb.Api.Helpers, as: H
def init(options) do
options
@ -13,19 +14,19 @@ defmodule PlausibleWeb.AuthorizeStatsApiPlug do
assign(conn, :site, site)
else
{:error, :missing_api_key} ->
unauthorized(
H.unauthorized(
conn,
"Missing API key. Please use a valid Plausible API key as a Bearer Token."
)
{:error, :missing_site_id} ->
bad_request(
H.bad_request(
conn,
"Missing site ID. Please provide the required site_id parameter with your request."
)
{:error, :invalid_api_key} ->
unauthorized(
H.unauthorized(
conn,
"Invalid API key or site ID. Please make sure you're using a valid API key with access to the site you've requested."
)
@ -56,18 +57,4 @@ defmodule PlausibleWeb.AuthorizeStatsApiPlug do
_ -> {:error, :missing_api_key}
end
end
defp bad_request(conn, msg) do
conn
|> put_status(400)
|> Phoenix.Controller.json(%{error: msg})
|> halt()
end
defp unauthorized(conn, msg) do
conn
|> put_status(401)
|> Phoenix.Controller.json(%{error: msg})
|> halt()
end
end

@ -84,7 +84,7 @@ defmodule PlausibleWeb.Router do
pipe_through [:public_api, PlausibleWeb.AuthorizeSitesApiPlug]
post "/", ExternalSitesController, :create_site
put "/shared-links/:link_name", ExternalSitesController, :find_or_create_shared_link
put "/shared-links", ExternalSitesController, :find_or_create_shared_link
end
scope "/api", PlausibleWeb do

@ -58,11 +58,14 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
end
end
describe "PUT /api/v1/sites/shared-links/:link_name" do
describe "PUT /api/v1/sites/shared-links" do
setup :create_site
test "can add a shared link to a site", %{conn: conn, site: site} do
conn = put(conn, "/api/v1/sites/shared-links/Wordpress?site_id=#{site.domain}")
conn = put(conn, "/api/v1/sites/shared-links", %{
site_id: site.domain,
name: "Wordpress"
})
res = json_response(conn, 200)
assert res["name"] == "Wordpress"
@ -70,24 +73,35 @@ defmodule PlausibleWeb.Api.ExternalSitesControllerTest do
end
test "is idempotent find or create op", %{conn: conn, site: site} do
conn = put(conn, "/api/v1/sites/shared-links/Wordpress?site_id=#{site.domain}")
conn = put(conn, "/api/v1/sites/shared-links", %{
site_id: site.domain,
name: "Wordpress"
})
%{"url" => url} = json_response(conn, 200)
conn = put(conn, "/api/v1/sites/shared-links/Wordpress?site_id=#{site.domain}")
conn = put(conn, "/api/v1/sites/shared-links", %{
site_id: site.domain,
name: "Wordpress"
})
assert %{"url" => ^url} = json_response(conn, 200)
end
test "returns 400 when site id missing", %{conn: conn} do
conn = put(conn, "/api/v1/sites/shared-links/Wordpress")
conn = put(conn, "/api/v1/sites/shared-links", %{
name: "Wordpress"
})
res = json_response(conn, 400)
assert res["error"] == "Query parameter `site_id` is required to create a shared link"
assert res["error"] == "Parameter `site_id` is required to create a shared link"
end
test "returns 404 when site id is non existent", %{conn: conn} do
conn = put(conn, "/api/v1/sites/shared-links/Wordpress?site_id=bad")
conn = put(conn, "/api/v1/sites/shared-links", %{
name: "Wordpress",
site_id: "bad"
})
res = json_response(conn, 404)
assert res["error"] == "Site could not be found"

Loading…
Cancel
Save