Giter VIP home page Giter VIP logo

channel_handler's Introduction

ChannelHandler

Helpers to organize and route messages in complex Phoenix channels.

Installation

Add the following to your mix.exs dependencies:

{:channel_handler, "~> 0.6"}

Usage

After defining a channel with vanilla Phoenix's channel:

channel "post:*", MyAppWeb.PostChannel

Define your channel handler, and add use ChannelHandler.Router in addition to the use MyAppWeb, :channel:

defmodule MyAppWeb.PostChannel do
  use MyAppWeb, :channel
  use ChannelHandler.Router
end

Now you can start defining matchers and event handlers:

defmodule MyAppWeb.PostChannel do
  use MyAppWeb, :channel
  use ChannelHandler.Router

  join fn _topic, _payload, socket ->
    {:ok, socket}
  end

  plug MyAppWeb.ChannelPlugs.EnsureAuthenticated

  event "comments:create", MyAppWeb.PostCommentsHandler, :create

  delegate "comments:", MyAppWeb.PostCommentsHandler

  handle "post:create", fn payload, _bindings, socket ->
    case MyApp.Posts.create(payload) do
      {:ok, post} ->
        {:reply, {:ok, post}, socket}

      {:error, reason} ->
        {:reply, {:error, reason}, socket}
    end
  end

  scope "secret:" do
    plug &check_permission/4, :do_secret_stuff

    # You can use splat patterns to match anything with *
    event "foo:*", SuperSecretHandler, :foo

    # Not specifying a prefix matches everything
    delegate SuperSecretHandler
  end

  def check_permission(socket, _payload, _bindings, permission) do
    if MyApp.Authorization.can?(socket.assigns.current_user, permission) do
      # using :cont resumes the event handling
      {:cont, socket, payload, bindings}
    else
      # returning :reply or :noreply halts the event handling
      {:reply, {:error, "Unauthorized"}, socket}
    end
  end
end

defmodule MyAppWeb.PostCommentsHandler do
  use ChannelHandler.Handler

  # Add a plug only for the create action
  plug MyAppWeb.ChannelPlugs.CheckPermission, :comment_posts when action in [:create]
  
  def handle_in(event, payload, bindings, socket) do
    # Do something with the delegated event
  end

  def create(payload, bindings, socket) do
    # Create a comment
  end
end

For more explanations about the API functions and what's possible, check the docs for ChannelHandler.Dsl.

Copyright and License

Copyright (c) 2023 [email protected]

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

channel_handler's People

Contributors

axelson avatar doorgan avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.