Packages
ash_json_api
0.1.4
1.7.1
1.7.0
1.6.6
1.6.5
1.6.4
1.6.3
1.6.2
1.6.1
1.6.0-rc.2
1.6.0-rc.1
1.6.0-rc.0
1.5.1
1.5.0
1.4.45
1.4.44
1.4.43
1.4.42
1.4.41
1.4.40
1.4.39
1.4.38
1.4.37
1.4.36
1.4.35
1.4.34
1.4.33
1.4.32
1.4.31
1.4.30
1.4.29
1.4.28
1.4.27
1.4.26
1.4.25
1.4.24
1.4.23
1.4.22
1.4.21
1.4.20
1.4.19
1.4.18
1.4.17
1.4.16
1.4.15
1.4.13
1.4.12
1.4.11
1.4.10
1.4.9
1.4.8
1.4.7
1.4.6
1.4.5
1.4.4
1.4.3
1.4.2
1.4.1
1.4.0
1.3.8
1.3.7
1.3.6
1.3.5
1.3.4
retired
1.3.3
1.3.2
1.3.1
1.3.0
1.2.2
1.2.1
1.2.0
1.1.2
1.1.1
1.1.0
1.0.0
1.0.0-rc.6
1.0.0-rc.5
1.0.0-rc.4
1.0.0-rc.3
1.0.0-rc.2
1.0.0-rc.1
1.0.0-rc.0
0.34.2
0.34.1
0.34.0
0.33.1
0.33.0
0.32.1
0.32.0
0.31.3
0.31.2
retired
0.31.1
0.31.0
0.30.1
0.30.0-rc.4
0.30.0-rc.3
0.30.0-rc.2
0.30.0-rc.1
0.30.0-rc.0
0.29.1
0.29.0
0.28.6
0.28.5
0.28.4
0.28.3
0.28.2
0.28.1
0.28.0
0.27.6
0.27.5
0.27.1
0.27.0
0.25.0
0.24.4
0.24.2
0.24.1
0.24.0
0.23.0
0.22.0
0.21.0
0.20.0
0.19.0
0.18.0
0.17.0
0.16.0
0.15.0
0.14.0
0.13.0
0.12.0
0.11.1
0.10.0
0.9.0
0.8.0
0.6.0
0.5.0
0.4.0
0.3.0
0.2.4
0.2.3
0.2.1
0.2.0
0.1.5
0.1.4
0.1.3
0.1.2
0.1.1
0.1.0
The JSON:API extension for the Ash Framework.
Current section
Files
Jump to
Current section
Files
lib/ash_json_api/json_api_resource/routes.ex
defmodule AshJsonApi.JsonApiResource.Routes do
@moduledoc "DSL builders for configuring the routes of a json api resource"
defmacro routes(path, do: body) do
quote do
import AshJsonApi.JsonApiResource.Routes
@json_api_path unquote(path)
unquote(body)
import AshJsonApi.JsonApiResource.Routes, only: []
end
end
defmacro get(action, opts \\ []) do
quote bind_quoted: [action: action, opts: opts] do
route = opts[:route] || "/:id"
unless Enum.find(Path.split(route), fn part -> part == ":id" end) do
raise "Route for get action *must* contain an `:id` path parameter"
end
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :get,
controller: AshJsonApi.Controllers.Get,
action: action,
action_type: :read,
type: :get,
primary?: opts[:primary?] || false
)
end
end
defmacro index(action, opts \\ []) do
quote bind_quoted: [action: action, opts: opts] do
route = opts[:route] || "/"
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :get,
controller: AshJsonApi.Controllers.Index,
action: action,
action_type: :read,
type: :index,
paginate?: Keyword.get(opts, :paginate?, true),
primary?: opts[:primary?] || false
)
end
end
defmacro post(action, opts \\ []) do
quote bind_quoted: [action: action, opts: opts] do
route = opts[:route] || "/"
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :post,
controller: AshJsonApi.Controllers.Post,
action: action,
type: :post,
action_type: :create,
primary?: opts[:primary?] || false
)
end
end
defmacro patch(action, opts \\ []) do
quote bind_quoted: [action: action, opts: opts] do
route = opts[:route] || "/:id"
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :patch,
controller: AshJsonApi.Controllers.Update,
action: action,
type: :patch,
action_type: :update,
primary?: opts[:primary?] || false
)
end
end
defmacro delete(action, opts \\ []) do
quote bind_quoted: [action: action, opts: opts] do
route = opts[:route] || "/:id"
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :delete,
type: :delete,
controller: AshJsonApi.Controllers.Delete,
action: action,
action_type: :delete,
primary?: opts[:primary?] || false
)
end
end
defmacro relationship_read_routes(relationship, opts \\ []) do
quote bind_quoted: [relationship: relationship, opts: opts] do
except = opts[:except] || []
unless :relationship in except do
relationship(relationship, opts)
end
unless :related in except do
related(relationship, opts)
end
end
end
defmacro relationship_change_routes(relationship, opts \\ []) do
quote bind_quoted: [relationship: relationship, opts: opts] do
except = opts[:except] || []
unless :post in except do
post_to_relationship(relationship, opts)
end
unless :patch in except do
patch_relationship(relationship, opts)
end
unless :delete in except do
delete_from_relationship(relationship, opts)
end
end
end
defmacro related(relationship, opts \\ []) do
quote bind_quoted: [relationship: relationship, opts: opts] do
route = opts[:route] || ":id/#{relationship}"
unless Enum.find(Path.split(route), fn part -> part == ":id" end) do
raise "Route for get action *must* contain an `:id` path parameter"
end
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :get,
controller: AshJsonApi.Controllers.GetRelated,
primary?: opts[:primary?] || true,
action: opts[:action] || :default,
relationship: relationship
)
end
end
defmacro relationship(relationship, opts \\ []) do
quote bind_quoted: [relationship: relationship, opts: opts] do
route = opts[:route] || ":id/relationships/#{relationship}"
unless Enum.find(Path.split(route), fn part -> part == ":id" end) do
raise "Route for get action *must* contain an `:id` path parameter"
end
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :get,
controller: AshJsonApi.Controllers.GetRelationship,
primary?: opts[:primary?] || true,
action: opts[:action] || :default,
relationship: relationship
)
end
end
defmacro post_to_relationship(relationship, opts \\ []) do
quote bind_quoted: [relationship: relationship, opts: opts] do
route = opts[:route] || ":id/relationships/#{relationship}"
unless Enum.find(Path.split(route), fn part -> part == ":id" end) do
raise "Route for post to relationship action *must* contain an `:id` path parameter"
end
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :post,
controller: AshJsonApi.Controllers.PostToRelationship,
primary?: opts[:primary?] || true,
action: opts[:action] || :default,
type: :post_to_relationship,
relationship: relationship
)
end
end
defmacro patch_relationship(relationship, opts \\ []) do
quote bind_quoted: [relationship: relationship, opts: opts] do
route = opts[:route] || ":id/relationships/#{relationship}"
unless Enum.find(Path.split(route), fn part -> part == ":id" end) do
raise "Route for patch relationship action *must* contain an `:id` path parameter"
end
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :patch,
controller: AshJsonApi.Controllers.PatchRelationship,
primary?: opts[:primary?] || true,
action: opts[:action] || :default,
type: :patch_relationship,
relationship: relationship
)
end
end
defmacro delete_from_relationship(relationship, opts \\ []) do
quote bind_quoted: [relationship: relationship, opts: opts] do
route = opts[:route] || ":id/relationships/#{relationship}"
unless Enum.find(Path.split(route), fn part -> part == ":id" end) do
raise "Route for patch relationship action *must* contain an `:id` path parameter"
end
@json_api_routes AshJsonApi.JsonApiResource.Route.new(
route:
AshJsonApi.JsonApiResource.Routes.prefix(
route,
@json_api_path,
Keyword.get(opts, :prefix?, true)
),
method: :delete,
controller: AshJsonApi.Controllers.DeleteFromRelationship,
primary?: opts[:primary?] || true,
action: opts[:action] || :default,
type: :delete_from_relationship,
relationship: relationship
)
end
end
def prefix(route, path, true) do
path =
case path do
"/" <> _rest_path -> path
path -> "/" <> path
end
full_route = "/" <> path <> "/" <> String.trim_leading(route, "/")
String.trim_trailing(full_route, "/")
end
def prefix(route, _name, _) do
route
end
end