feat: Link Objects and Additional Controller Actions (#264)

* link object & additional View actions * add link object to test --------- Co-authored-by: amoffat <[email protected]>
beam-community · Jun 25, 2024 · def58a9 · def58a9
1 parent 3d3ca63
commit def58a9
Show file tree

Hide file tree

Showing 2 changed files with 49 additions and 1 deletion.
diff --git a/lib/jsonapi/view.ex b/lib/jsonapi/view.ex
@@ -133,7 +133,8 @@ defmodule JSONAPI.View do
   @type t :: module()
   @type data :: any()
   @type field :: atom()
-  @type links :: %{atom() => String.t()}
+  @type link_object :: %{required(:href) => String.t(), optional(:meta) => meta()}
+  @type links :: %{atom() => String.t() | link_object()}
   @type meta :: %{atom() => String.t()}
   @type options :: keyword()
   @type resource_id :: String.t()
@@ -270,6 +271,15 @@ defmodule JSONAPI.View do
       def show(model, conn, _params, meta \\ nil, options \\ []),
         do: Serializer.serialize(__MODULE__, model, conn, meta, options)
 
+      def update(model, conn, _params, meta \\ nil, options \\ []),
+        do: Serializer.serialize(__MODULE__, model, conn, meta, options)
+
+      def delete(model, conn, _params, meta \\ nil, options \\ []),
+        do: Serializer.serialize(__MODULE__, model, conn, meta, options)
+
+      def create(model, conn, _params, meta \\ nil, options \\ []),
+        do: Serializer.serialize(__MODULE__, model, conn, meta, options)
+
       if Code.ensure_loaded?(Phoenix) do
         def render("show.json", %{data: data, conn: conn, meta: meta, options: options}),
           do: Serializer.serialize(__MODULE__, data, conn, meta, options)
@@ -288,6 +298,33 @@ defmodule JSONAPI.View do
 
         def render("index.json", %{data: data, conn: conn}),
           do: Serializer.serialize(__MODULE__, data, conn)
+
+        def render("create.json", %{data: data, conn: conn, meta: meta, options: options}),
+          do: Serializer.serialize(__MODULE__, data, conn, meta, options)
+
+        def render("create.json", %{data: data, conn: conn, meta: meta}),
+          do: Serializer.serialize(__MODULE__, data, conn, meta)
+
+        def render("create.json", %{data: data, conn: conn}),
+          do: Serializer.serialize(__MODULE__, data, conn)
+
+        def render("update.json", %{data: data, conn: conn, meta: meta, options: options}),
+          do: Serializer.serialize(__MODULE__, data, conn, meta, options)
+
+        def render("update.json", %{data: data, conn: conn, meta: meta}),
+          do: Serializer.serialize(__MODULE__, data, conn, meta)
+
+        def render("update.json", %{data: data, conn: conn}),
+          do: Serializer.serialize(__MODULE__, data, conn)
+
+        def render("delete.json", %{data: data, conn: conn, meta: meta, options: options}),
+          do: Serializer.serialize(__MODULE__, data, conn, meta, options)
+
+        def render("delete.json", %{data: data, conn: conn, meta: meta}),
+          do: Serializer.serialize(__MODULE__, data, conn, meta)
+
+        def render("delete.json", %{data: data, conn: conn}),
+          do: Serializer.serialize(__MODULE__, data, conn)
       else
         raise ArgumentError,
               "Attempted to call function that depends on Phoenix. " <>

diff --git a/test/jsonapi_test.exs b/test/jsonapi_test.exs
@@ -35,6 +35,17 @@ defmodule JSONAPITest do
     def fields, do: [:username]
     def type, do: "user"
 
+    def links(user, _conn) do
+      %{
+        profile: %{
+          href: "#{path()}/#{user.username}",
+          meta: %{
+            method: "get"
+          }
+        }
+      }
+    end
+
     def relationships do
       [company: JSONAPITest.CompanyView]
     end