move payment_guard show_plans callback to payment_controller render_plans callback

Author: ericdude4

lib/shopifex/payment_guard.ex

@@ -49,19 +49,9 @@ defmodule Shopifex.PaymentGuard do
   """
   @callback get_plan(plan_id :: String.t() | pos_integer()) :: plan()
 
-  @doc """
-  Display the available payment plans for the user to select.
-  """
-  @callback show_plans(
-              conn :: Plug.Conn.t(),
-              guard_identifier :: String.t(),
-              redirect_after :: String.t()
-            ) :: Plug.Conn.t()
-
   @optional_callbacks grant_for_guard: 2,
                       use_grant: 2,
                       get_plan: 1,
-                      show_plans: 3,
                       create_grant: 3
 
   defmacro __using__(_opts) do
@@ -116,17 +106,6 @@ defmodule Shopifex.PaymentGuard do
            ),
            do: Changeset.change(grant_changeset, %{remaining_usages: remaining_usages - 1})
 
-      @impl Shopifex.PaymentGuard
-      def show_plans(conn, guard_identifier, redirect_after) do
-        conn
-        |> put_view(ShopifexWeb.PaymentView)
-        |> put_layout({ShopifexWeb.LayoutView, "app.html"})
-        |> render("show-plans.html",
-          guard: guard_identifier,
-          redirect_after: redirect_after
-        )
-      end
-
       @impl Shopifex.PaymentGuard
       def create_grant(shop, plan, charge_id) do
         Shopifex.Shops.create_grant(%{
@@ -138,7 +117,7 @@ defmodule Shopifex.PaymentGuard do
         })
       end
 
-      defoverridable grant_for_guard: 2, use_grant: 2, show_plans: 3, get_plan: 1, create_grant: 3
+      defoverridable grant_for_guard: 2, use_grant: 2, get_plan: 1, create_grant: 3
     end
   end
 end

lib/shopifex/plug/payment_guard.ex

@@ -21,13 +21,18 @@ defmodule Shopifex.Plug.PaymentGuard do
   """
   require Logger
 
+  @router_helpers Module.concat([Application.compile_env!(:shopifex, :web_module), Router, Helpers])
+
   def init(options) do
     # initialize options
     options
   end
 
   @doc """
-  This makes sure the shop in the session contains a payment which unlocks the guard
+  This makes sure the shop in the session contains a payment which unlocks the guard.
+
+  If no payment is present which unlocks the guard, the conn will be redirected to your
+  application's PaymentController.show_plans route.
   """
   def call(conn, guard_identifier) do
     payment_guard = Application.fetch_env!(:shopifex, :payment_guard)
@@ -39,7 +44,10 @@ defmodule Shopifex.Plug.PaymentGuard do
         Logger.info("Payment guard blocked request")
         redirect_after = URI.encode_www_form("#{conn.request_path}?#{conn.query_string}")
 
-        payment_guard.show_plans(conn, guard_identifier, redirect_after)
+        show_plans_url = @router_helpers.payment_path(conn, :show_plans, %{guard_identifier: guard_identifier, redirect_after: redirect_after})
+
+        conn
+        |> Phoenix.Controller.redirect(to: show_plans_url)
         |> Plug.Conn.halt()
 
       grant_for_guard ->

lib/shopifex_web/controllers/payment_controller.ex

@@ -17,6 +17,16 @@ defmodule ShopifexWeb.PaymentController do
   ```
   """
 
+
+  @doc """
+  Display the available payment plans for the user to select.
+  """
+  @callback render_plans(
+              conn :: Plug.Conn.t(),
+              guard_identifier :: String.t(),
+              redirect_after :: String.t()
+            ) :: Plug.Conn.t()
+
   @doc """
   An optional callback called after a payment is completed. By default, this function
   redirects the user to the app index within their Shopify admin panel.
@@ -38,7 +48,8 @@ defmodule ShopifexWeb.PaymentController do
               String.t()
             ) ::
               Plug.Conn.t()
-  @optional_callbacks after_payment: 5
+
+  @optional_callbacks render_plans: 3, after_payment: 5
 
   defmacro __using__(_opts) do
     quote do
@@ -51,7 +62,7 @@ defmodule ShopifexWeb.PaymentController do
         path_prefix = Application.get_env(:shopifex, :path_prefix, "")
         default_redirect_after = path_prefix <> "/?token=" <> Guardian.Plug.current_token(conn)
 
-        payment_guard.show_plans(
+        render_plans(
           conn,
           Map.get(params, "guard_identifier"),
           Map.get(params, "redirect_after", default_redirect_after)
@@ -198,13 +209,24 @@ defmodule ShopifexWeb.PaymentController do
         end
       end
 
+      @impl ShopifexWeb.PaymentController
+      def render_plans(conn, guard_identifier, redirect_after) do
+        conn
+        |> put_view(ShopifexWeb.PaymentView)
+        |> put_layout({ShopifexWeb.LayoutView, "app.html"})
+        |> render("show-plans.html",
+          guard: guard_identifier,
+          redirect_after: redirect_after
+        )
+      end
+
       @impl ShopifexWeb.PaymentController
       def after_payment(conn, shop, _plan, _grant, redirect_after) do
         api_key = Application.get_env(:shopifex, :api_key)
         redirect(conn, external: "https://#{shop.url}/admin/apps/#{api_key}#{redirect_after}")
       end
 
-      defoverridable after_payment: 5
+      defoverridable render_plans: 3, after_payment: 5
     end
   end
 end

mix.exs

@@ -4,7 +4,7 @@ defmodule Shopifex.MixProject do
   def project do
     [
       app: :shopifex,
-      version: "1.1.1",
+      version: "2.0.0",
       elixir: "~> 1.10",
       start_permanent: Mix.env() == :prod,
       compilers: [:phoenix, :gettext] ++ Mix.compilers(),

test/plug/payment_guard_test.exs

@@ -8,12 +8,12 @@ defmodule Shopifex.Plug.PaymentGuardTest do
 
   setup [:shop_in_session]
 
-  test "payment guard blocks pay-walled function and renders payment page", %{
+  test "payment guard blocks pay-walled function and redirects to payment page", %{
     conn: conn
   } do
     conn = Shopifex.Plug.PaymentGuard.call(conn, "block")
 
-    assert html_response(conn, 200) =~ "Components.WrappedShowPlans"
+    assert html_response(conn, 302) =~ "<html><body>You are being <a href=\"/payment/show-plans?guard_identifier=block"
   end
 
   test "payment guard grants access pay-walled function and places guard payment in session", %{