step_flow

1.9.0-rc1

1.9.0-rc2 1.9.0-rc1 1.9.0-rc0 1.8.2 1.8.1 1.8.1-rc8 1.8.1-rc7 1.8.1-rc6 1.8.1-rc5 1.8.1-rc4 1.8.1-rc3 1.8.1-rc2 1.8.1-rc1 1.8.1-rc0 1.8.0 1.8.0-rc3 1.8.0-rc2 1.8.0-rc1 1.8.0-rc0 1.7.3 1.7.3-rc4 1.7.3-rc3 1.7.3-rc2 1.7.3-rc1 1.7.3-rc0 1.7.2 1.7.2-rc4 1.7.2-rc3 1.7.2-rc2 1.7.2-rc1 1.7.2-rc0 1.7.1 1.7.0 1.7.0-rc1 1.7.0-rc0 1.6.1 1.6.1-rc1 1.6.1-rc0 1.6.0 1.6.0-rc9 1.6.0-rc8 1.6.0-rc7 1.6.0-rc6 1.6.0-rc5 1.6.0-rc4 1.6.0-rc3 1.6.0-rc20 1.6.0-rc2 1.6.0-rc19 1.6.0-rc18 1.6.0-rc17 1.6.0-rc16 1.6.0-rc15 1.6.0-rc14 1.6.0-rc13 1.6.0-rc12 1.6.0-rc11 1.6.0-rc10 1.6.0-rc1 1.5.0 1.5.0-rc1 1.4.2-rc2 1.4.2-rc1 1.4.1 1.4.1-rc1 1.4.0 1.4.0-rc4 1.4.0-rc3 1.4.0-rc2 1.4.0-rc1 1.3.1 1.3.0 1.3.0-rc 1.2.0 1.1.0 1.0.0 1.0.0-rc9 1.0.0-rc8 1.0.0-rc7 1.0.0-rc6 1.0.0-rc5 1.0.0-rc1 0.2.13 0.2.12 0.2.11 0.2.10 0.2.9 0.2.8 0.2.7 0.2.6 0.2.5 0.2.4 0.2.3 0.2.2 0.2.1 0.2.0 0.1.8 0.1.7 0.1.6 0.1.5 0.1.4 0.1.3 0.1.2 0.1.1 0.1.0 0.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 0.0.10 0.0.9 0.0.8 0.0.7 0.0.6 0.0.4 0.0.3 0.0.2 0.0.1

Step flow manager for Elixir applications

HexDocs

Current section

Files

Jump to

Readme 128 Versions 25 Dependencies Dependants Files Activity

step_flow lib step_flow web_controllers notification_template.ex

Raw

lib/step_flow/web_controllers/notification_template.ex

defmodule StepFlow.WebController.NotificationTemplate do
  @moduledoc false
  use StepFlow, :controller
  use OpenApiSpex.ControllerSpecs

  alias StepFlow.NotificationHooks.NotificationTemplate
  alias StepFlow.NotificationHooks.NotificationTemplates
  alias StepFlow.WebController.Helpers
  alias StepFlow.WebController.OpenApiSchemas

  action_fallback(StepFlow.WebController.Fallback)

  tags ["Notification Templates"]
  security [%{"authorization" => %OpenApiSpex.SecurityScheme{type: "http", scheme: "bearer"}}]

  operation :index,
    summary: "List notification templates",
    description: "List notification templates",
    type: :object,
    responses: [
      ok:
        {"Notification Templates", "application/json",
         OpenApiSchemas.Notifications.NotificationTemplates},
      forbidden: "Forbidden"
    ]

  def index(%Plug.Conn{assigns: %{current_user: user}} = conn, params) do
    if Helpers.has_right?(
         "notification_template::*",
         user,
         "view"
       ) do
      notification_templates = NotificationTemplates.list_notification_templates(params)

      conn
      |> put_view(StepFlow.NotificationTemplateView)
      |> render("index.json", notification_templates: notification_templates)
    else
      conn
      |> put_status(:forbidden)
      |> put_view(StepFlow.NotificationTemplateView)
      |> render("error.json",
        errors: %{reason: "Cannot list Notification Templates with this user."}
      )
    end
  end

  operation :create,
    summary: "Create notification template",
    description: "Create a notification template",
    type: :object,
    request_body:
      {"Notification Template", "application/json",
       OpenApiSchemas.Notifications.NotificationTemplate},
    responses: [
      ok:
        {"Notification Template", "application/json",
         OpenApiSchemas.Notifications.NotificationTemplate},
      forbidden: "Forbidden",
      not_found: "Not Found"
    ]

  def create(%Plug.Conn{assigns: %{current_user: user}} = conn, notification_template_params) do
    if Helpers.has_right?(
         "notification_template::" <>
           StepFlow.Map.get_by_key_or_atom(notification_template_params, :template_name),
         user,
         "create"
       ) do
      case NotificationTemplates.create_notification_template(notification_template_params) do
        {:ok, %NotificationTemplate{} = notification_template} ->
          conn
          |> put_status(:created)
          |> put_view(StepFlow.NotificationTemplateView)
          |> render("show.json", notification_template: notification_template)

        {:error, _changeset} ->
          conn
          |> put_status(:unprocessable_entity)
          |> put_view(StepFlow.NotificationTemplateView)
          |> render("error.json",
            errors: %{
              reason: "Cannot create a Notification Template with this template name."
            }
          )
      end
    else
      conn
      |> put_status(:forbidden)
      |> put_view(StepFlow.NotificationTemplateView)
      |> render("error.json",
        errors: %{reason: "Cannot create a Notification Template with this user."}
      )
    end
  end

  operation :show,
    summary: "Get notification template",
    description: "Get a notification template by template name",
    type: :object,
    parameters: [
      template_name: [
        in: :path,
        description: "Template name",
        type: :string,
        example: "my_name"
      ]
    ],
    responses: [
      ok:
        {"Notification Template", "application/json",
         OpenApiSchemas.Notifications.NotificationTemplate},
      forbidden: "Forbidden",
      not_found: "Not Found"
    ]

  def show(%Plug.Conn{assigns: %{current_user: user}} = conn, %{"id" => template_name}) do
    if Helpers.has_right?(
         "notification_template::" <> template_name,
         user,
         "view"
       ) do
      case NotificationTemplates.get_notification_template_by_name(template_name) do
        nil ->
          conn
          |> put_status(:not_found)
          |> put_view(StepFlow.NotificationTemplateView)
          |> render("error.json",
            errors: %{
              reason: "There is no notification template with this name: " <> template_name
            }
          )

        notification_template ->
          conn
          |> put_view(StepFlow.NotificationTemplateView)
          |> render("show.json", notification_template: notification_template)
      end
    else
      conn
      |> put_status(:forbidden)
      |> put_view(StepFlow.NotificationTemplateView)
      |> render("error.json",
        errors: %{reason: "Cannot view this Notification Template with this user."}
      )
    end
  end

  operation :update,
    summary: "Edit notification template",
    description: "Edit notification template by template name",
    type: :object,
    request_body:
      {"Notification Body", "application/json", OpenApiSchemas.Notifications.NotificationEndpoint},
    responses: [
      ok: {"Notification", "application/json", OpenApiSchemas.Notifications.NotificationEndpoint},
      forbidden: "Forbidden"
    ]

  def update(%Plug.Conn{assigns: %{current_user: user}} = conn, %{
        "id" => template_name,
        "notification_template" => params
      }) do
    notification_template = NotificationTemplates.get_notification_template_by_name(template_name)

    if Helpers.has_right?(
         "notification_template::" <>
           StepFlow.Map.get_by_key_or_atom(notification_template, :template_name),
         user,
         "update"
       ) do
      case NotificationTemplates.update_notification_template(notification_template, params) do
        {:ok, %NotificationTemplate{} = notification_template} ->
          conn
          |> put_status(200)
          |> put_view(StepFlow.NotificationTemplateView)
          |> render("show.json", notification_template: notification_template)

        {:error, _} ->
          conn
          |> put_status(:unprocessable_entity)
          |> put_view(StepFlow.NotificationTemplateView)
          |> render("error.json",
            errors: %{reason: "Cannot change a Notification Template."}
          )
      end
    else
      conn
      |> put_status(:forbidden)
      |> put_view(StepFlow.NotificationTemplateView)
      |> render("error.json",
        errors: %{reason: "Cannot create a Notification Template with this user."}
      )
    end
  end

  operation :delete,
    summary: "Delete notification template",
    description: "Delete a notification template by template name",
    type: :object,
    parameters: [
      template_name: [
        in: :path,
        description: "Template name",
        type: :string,
        example: "my_name"
      ]
    ],
    responses: [
      no_content: "No Content",
      forbidden: "Forbidden",
      not_found: "Not Found"
    ]

  def delete(%Plug.Conn{assigns: %{current_user: user}} = conn, %{"id" => template_name}) do
    NotificationTemplates.get_notification_template_by_name(template_name)
    |> delete_with_notification_template(conn, user, template_name)
  end

  defp delete_with_notification_template(nil, conn, _user, template_name) do
    conn
    |> put_status(:not_found)
    |> put_view(StepFlow.NotificationTemplateView)
    |> render("error.json",
      errors: %{
        reason:
          "Cannot delete, there is no notification template with this name: " <>
            template_name
      }
    )
  end

  defp delete_with_notification_template(notification_template, conn, user, _template_name) do
    if Helpers.has_right?("notification_template::*", user, "delete") do
      case NotificationTemplates.delete_notification_template(notification_template) do
        {:ok, %NotificationTemplate{}} ->
          send_resp(conn, :no_content, "")
      end
    else
      conn
      |> put_status(:forbidden)
      |> put_view(StepFlow.NotificationTemplateView)
      |> render("error.json",
        errors: %{reason: "Cannot delete a Notification Template with this user."}
      )
    end
  end
end

Operator	Description	Example
name:	Match package name. Supports * wildcards and repo/package form	name:phx* or name:hexpm/phoenix
description:	Full-text search of package descriptions	description:auth
depends:	Packages depending on a given package. Supports repo:package form	depends:ecto or depends:hexpm:ecto
build_tool:	Filter by build tool	build_tool:mix
updated_after:	Packages updated after an ISO8601 datetime	updated_after:2025-01-01T00:00:00Z
extra:	Match custom metadata (key,value). Nested keys are separated by commas	extra:license,MIT