expo_push_tokens model and creation api #1

Author: jkraemer

Gemfile

@@ -0,0 +1 @@
+gem "exponent-server-sdk"

app/controllers/expo_push_tokens_controller.rb

@@ -0,0 +1,17 @@
+class ExpoPushTokensController < ApplicationController
+  before_action :require_login
+  accept_api_auth :create
+
+  def create
+    @token = ExpoPushToken.new user: User.current, token: params[:token]
+    if @token.save
+      respond_to do |format|
+        format.api { head :created }
+      end
+    else
+      respond_to do |format|
+        format.api  { render_validation_errors(@token) }
+      end
+    end
+  end
+end

app/models/expo_push_token.rb

@@ -0,0 +1,7 @@
+class ExpoPushToken < ActiveRecord::Base
+  belongs_to :user
+
+  validates_presence_of :token
+  validates_presence_of :user
+end
+

config/routes.rb

@@ -0,0 +1 @@
+resources :expo_push_tokens, only: %i(create)

db/migrate/20190526075144_create_expo_push_tokens.rb

@@ -0,0 +1,8 @@
+class CreateExpoPushTokens < ActiveRecord::Migration[5.2]
+  def change
+    create_table :expo_push_tokens do |t|
+      t.references :user, foreign_key: true
+      t.string :token, null: false
+    end
+  end
+end

init.rb

@@ -0,0 +1,33 @@
+require 'redmine'
+
+Rails.configuration.to_prepare do
+  RedmineExpoPush.setup
+end
+
+Redmine::Plugin.register :redmine_expo_push do
+  name 'Redmine Expo Push Notifications Plugin'
+  author 'Jens Krämer, Georepublic'
+  author_url 'https://hub.georepublic.net/gtt/redmine_expo_push'
+  description 'Notify mobile app users through push notifications'
+  version '1.0.0'
+
+  requires_redmine version_or_higher: '3.4.0'
+
+  #settings default: {
+  #}, partial: 'redmine_text_blocks/settings'
+
+#   project_module :text_blocks do
+# 
+#     permission :view_text_blocks, {}, require: :member, read: true
+#     permission :manage_text_blocks, {
+#       text_blocks: %i( new edit update create destroy ),
+#       projects: %i( manage_text_blocks )
+#     }, require: :member
+#   end
+
+#  menu :admin_menu, :text_blocks,
+#    { controller: 'text_blocks', action: 'index' },
+#    caption: :label_text_block_plural, :html => {:class => 'icon'}
+
+end
+

lib/redmine_expo_push.rb

@@ -0,0 +1,6 @@
+module RedmineExpoPush
+  def self.setup
+    # RedmineExpoPush::Patches::MailerPatch.apply
+    RedmineExpoPush::Patches::UserPatch.apply
+  end
+end

lib/redmine_expo_push/notification.rb

@@ -0,0 +1,33 @@
+module RedmineExpoPush
+  class Notification
+    def initialize(title: nil, body: nil, data: {})
+      @title = title
+      @body = body
+      @data = data
+      @recipients = []
+    end
+
+    def add_recipient(user)
+      @recipients << user
+    end
+
+    # https://docs.expo.io/versions/latest/guides/push-notifications/
+    # https://github.com/expo/expo-server-sdk-ruby
+    # https://docs.expo.io/versions/latest/guides/push-notifications/#message-format
+    def deliver
+      messages = @recipients.map do |user|
+        ExpoPushToken.where(user: user).map do |token|
+          {
+            to: token,
+            title: @title,
+            body: @body,
+            data: @data
+          }
+        end
+      end
+      messages.flatten!
+
+      Exponent::Push::Client.new(gzip: true).publish messages
+    end
+  end
+end

lib/redmine_expo_push/patches/mailer_patch.rb

@@ -0,0 +1,47 @@
+module RedmineExpoPush
+  module Patches
+    # this is a draft, just in case we want to add general push notification
+    # support for all redmine notifications
+    module MailerPatch
+
+      def self.apply
+        Mailer.class_eval do
+          class << self
+            prepend ClassMethods
+          end
+        end
+      end
+
+      module ClassMethods
+
+        def deliver_mail(mail, &block)
+          if perform_deliveries
+            notification = nil
+            %i(to cc bcc).each do |field|
+              receivers = Array(mail.send(field)).flatten.compact
+              skip_receivers = []
+              receivers.each do |addr|
+                user = User.having_mail(addr).first
+                if user.present?
+                  cfg = RedmineExpoPush::UserConfig.new(user)
+                  if cfg.send_push_notifications?
+                    notification ||= Notification.new(mail)
+                    notification.add_recipient user
+                    skip_receivers << addr if cfg.skip_emails?
+                  end
+                end
+              end
+              mail.send "#{field}=", (receivers - skip_receivers)
+            end
+            notification.deliver if notification
+          end
+
+          super
+        end
+
+      end
+
+    end
+  end
+end
+

lib/redmine_expo_push/patches/user_patch.rb

@@ -0,0 +1,16 @@
+module RedmineExpoPush
+  module Patches
+    module UserPatch
+      def self.apply
+        User.prepend self unless User < self
+      end
+
+      def remove_references_before_destroy
+        super
+        if self.id
+          ExpoPushToken.where(user_id: id).delete_all
+        end
+      end
+    end
+  end
+end