pushkin-library 0.1.3

data/app/helpers/pushkin/application_helper.rb

@@ -0,0 +1,4 @@
+module Pushkin
+  module ApplicationHelper
+  end
+end

data/app/jobs/pushkin/application_job.rb

@@ -0,0 +1,4 @@
+module Pushkin
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/jobs/pushkin/send_job.rb

@@ -0,0 +1,11 @@
+module Pushkin
+  class SendJob < ApplicationJob
+
+    queue_as :pushkin
+
+    def perform(notification_id)
+      SendPushService.new(notification_id).call
+    end
+
+  end
+end

data/app/mailers/pushkin/application_mailer.rb

@@ -0,0 +1,6 @@
+module Pushkin
+  class ApplicationMailer < ActionMailer::Base
+    default from: 'from@example.com'
+    layout 'mailer'
+  end
+end

data/app/models/pushkin/application_record.rb

@@ -0,0 +1,5 @@
+module Pushkin
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/models/pushkin/concerns/pushkin_user.rb

@@ -0,0 +1,10 @@
+# Базовый контроллер для всех остальных контроллеров Пушкина
+module Pushkin::Concerns::PushkinUser
+
+  extend ActiveSupport::Concern
+
+  included do
+    has_many :pushkin_tokens, class_name: "Pushkin::Token"
+  end
+
+end

data/app/models/pushkin/notification.rb

@@ -0,0 +1,42 @@
+# Уведомление для отправки
+module Pushkin
+  class Notification < ApplicationRecord
+
+    # Предоставляет токены устройств, на которые нужно отправить уведомление.
+    # polymorphic сделан для того, чтобы можно было реализовывать различные логики
+    # получения токенов для конкретного уведомления, например:
+    # - В момент планирования уведомления сохранить в базу пользователей, которым нужно отправить уведомления.
+    #   В момент отправки для этих пользователей будут получены актуальные устройства.
+    #   Данная реализация находится в Pushkin::TokensProvider
+    # - В момент планирования уведомления сохранить в базу токены, на которые будет отправлено уведомление.
+    # - В момент планирования сохранить ссылку на какую-нибо сущность, из которой в момент отправки
+    #   будет получен актуальный список токенов пользователей.
+    belongs_to :tokens_provider, polymorphic: true, dependent: :destroy
+
+    # Предоставляет данные, которые будут отправлены в пуш уведомлении.
+    # polymorphic нужен для того, чтобы реализовывать различные способы получения данных
+    # для различных уведомлений, например:
+    # - В момент планирования уведомления сохранить всю информацию в базу в статическом виде.
+    #   Такая релизация находится в Pushkin::Payload
+    # - В момент планированя уведомления сохранить какую-либо сущность, которая в момент отправки
+    #   уведомления предоставит нужную актуальную информацию на лету.
+    belongs_to :payload, polymorphic: true, dependent: :destroy, inverse_of: :notification
+
+    # Статистика по отправленным сообщениям. Один объект - одна групповая отправка.
+    has_many :push_sending_results, dependent: :destroy
+    has_many :token_results, through: :push_sending_results
+
+    # Тип уведомления для разделения уведомлений по назначениям.
+    # Обязательный, чтобы потом не запутаться и легко фильтроваться.
+    validates :notification_type, presence: true
+
+    # Отправляет уведомление прямо сейчас
+    def send_now
+      # Заполняем как дату, в которую нужно отправить, так и дату, в которую началась отправка.
+      # Это позволит периодической операции по отправке уведомлений не отвлекаться на такое уведомление.
+      now = DateTime.now
+      self.update_attributes(start_at: now, started_at: now)
+      SendJob.perform_later(self.id)
+    end
+  end
+end

data/app/models/pushkin/payload.rb

@@ -0,0 +1,21 @@
+# Статическая информация, отправляемая в пуш уведомлении
+module Pushkin
+  class Payload < ApplicationRecord
+
+    # Связь с уведомлением, к которому относится данная информация
+    has_one :notification, as: :payload, inverse_of: :payload
+
+    validates :title, presence: true
+
+    def data
+      value = read_attribute(:data)
+      value = value.present? ? JSON.parse(value, symbolize_names: true) : {}
+      value
+    end
+
+    def data=(value)
+      write_attribute(:data, value.present? ? value.to_json : value)
+    end
+
+  end
+end

data/app/models/pushkin/push_sending_result.rb

@@ -0,0 +1,13 @@
+# Результат отправки на платформу
+module Pushkin
+  class PushSendingResult < ApplicationRecord
+
+    belongs_to :notification, optional: true
+
+    has_many :token_results, dependent: :destroy
+
+    # Соответствует платформам в токенах
+    enum platform: [:android, :ios, :web]
+
+  end
+end

data/app/models/pushkin/token.rb

@@ -0,0 +1,19 @@
+# Токены для отправки пуш уведомлений в приложения
+module Pushkin
+  class Token < ApplicationRecord
+
+    belongs_to :user, optional: true
+
+    validates :token, presence: true, uniqueness: { scope: :platform }
+    validates :platform, presence: true
+    validates_inclusion_of :is_active, in: [true, false]
+
+    enum platform: [:android, :ios, :web]
+
+    scope :active, -> { self.where(is_active: true) }
+
+    # По умолчанию нужно работать только с активными устройствами.
+    default_scope { self.active }
+
+  end
+end

data/app/models/pushkin/token_result.rb

@@ -0,0 +1,39 @@
+module Pushkin
+  class TokenResult < ApplicationRecord
+
+    STATUS_SUCCESS = "success"
+    STATUS_INVALID = "invalid"
+    STATUS_ERROR = "error"
+
+    belongs_to :push_sending_result, optional: true
+    belongs_to :token
+
+    scope :invalid, -> { self.where(status: STATUS_INVALID) }
+
+    def set_success
+      self.status = STATUS_SUCCESS
+    end
+
+    def set_invalid
+      self.status = STATUS_INVALID
+    end
+
+    def set_error(error)
+      self.status = STATUS_ERROR
+      self.error = error
+    end
+
+    def success?
+      self.status == STATUS_SUCCESS
+    end
+
+    def invalid?
+      self.status == STATUS_INVALID
+    end
+
+    def error?
+      self.status == STATUS_ERROR
+    end
+
+  end
+end

data/app/models/pushkin/tokens_provider.rb

@@ -0,0 +1,22 @@
+# Возвращает токены устройств для пользователей, которые к нему прикреплены
+module Pushkin
+  class TokensProvider < ApplicationRecord
+
+    # Ссылка на уведомление
+    has_one :notification, as: :tokens_provider
+
+    # Ссылки на пользователей
+    has_many :tokens_provider_users, foreign_key: :tokens_provider_id,
+                                     dependent: :destroy
+
+    # Пользователи, которым нужно отправить пуш-уведомление
+    has_many :users, through: :tokens_provider_users
+
+    # Возвращает список токенов для отправки пуш уведомления.
+    # Токен - объект PushToken.
+    def get_tokens
+      self.users.includes(:pushkin_tokens).map { |user| user.pushkin_tokens }.flatten
+    end
+
+  end
+end

data/app/models/pushkin/tokens_provider_user.rb

@@ -0,0 +1,12 @@
+# Связка Провайдер-Пользователь для отправки пуш уведомлений
+module Pushkin
+  class TokensProviderUser < ApplicationRecord
+
+    # Ссылка на пользователя
+    belongs_to :user
+
+    # Ссылка на провайдер (Связывает уведомление и пользователей, которым нужно отправить уведомление)
+    belongs_to :tokens_provider, optional: true
+
+  end
+end

data/app/services/pushkin/fcm/send_android_push_service.rb

@@ -0,0 +1,22 @@
+module Pushkin
+  module Fcm
+    class SendAndroidPushService < SendFcmPushService
+
+      def get_notification_hash
+        notification_hash = super
+        notification_hash[:icon] = self.payload.android_icon if self.payload.android_icon.present?
+        notification_hash[:click_action] = self.payload.android_click_action if self.payload.android_click_action.present?
+        notification_hash
+      end
+
+      def get_platform
+        :android
+      end
+
+      def is_data_message
+        self.payload.is_android_data_message
+      end
+
+    end
+  end
+end

data/app/services/pushkin/fcm/send_fcm_push_service.rb

@@ -0,0 +1,120 @@
+# Отправляет пуш уведомления через firebase.
+# Это базовый класс для наследников, специфических для платформ
+module Pushkin
+  module Fcm
+    class SendFcmPushService
+
+      FCM_API_DOMAIN = "https://fcm.googleapis.com"
+      FCM_API_URL = "/fcm/send"
+
+      attr_accessor :tokens, :payload
+      attr_accessor :server_key
+
+      def initialize(tokens, payload)
+        @tokens = tokens
+        @payload = payload
+        @server_key = ENV["FCM_SERVER_KEY"]
+        raise Exception.new("No FCM_SERVER_KEY in ENV") if @server_key.blank?
+      end
+
+      def call
+        # Сохранение в БД информации по отправке
+        @push_sending_result = PushSendingResult.create(started_at: DateTime.now, platform: self.get_platform)
+
+        # Выполнение HTTP запроса по отправке уведомлений
+        conn = Faraday.new(:url => FCM_API_DOMAIN)
+        response = conn.post do |req|
+          req.url FCM_API_URL
+          req.headers['Content-Type'] = 'application/json'
+          req.headers['Authorization'] = "key=#{self.server_key}"
+          req.body = self.get_request_body.to_json
+        end
+
+        # Сохранение результатов отправки в БД
+        self.process_response(response)
+        @push_sending_result
+      end
+
+      def process_response(response)
+        @push_sending_result.finished_at = DateTime.now
+
+        if response.status == 200
+          @push_sending_result.success = true
+
+          # Обработка ответа с сохранением в БД
+          response_body = JSON.parse(response.body, symbolize_names: true)
+          response_body[:results].each_with_index.map do |result, index|
+            token_result = self.parse_token_result(result, self.tokens[index])
+            token_result.push_sending_result_id = @push_sending_result.id
+            token_result.save
+          end
+        else
+          @push_sending_result.success = false
+          @push_sending_result.error = response.body
+        end
+
+        @push_sending_result.save
+      end
+
+      def parse_token_result(result, token)
+        error = result[:error]
+        token_result = TokenResult.new(token_id: token.id)
+
+        if error.blank?
+          token_result.set_success
+        elsif error == "NotRegistered" || error == "InvalidRegistration"
+          token_result.set_invalid
+        else
+          token_result.set_error(error)
+        end
+
+        token_result.save
+        token_result
+      end
+
+      def get_request_body
+        body = {
+          registration_ids: self.tokens.map { |token_object| token_object.token },
+          content_available: self.is_data_message
+        }
+
+        notification_hash = self.get_notification_hash
+        data_hash = self.get_data_hash
+
+        if self.is_data_message
+          data_hash = data_hash.merge(notification_hash)
+          notification_hash = nil
+        end
+
+        body[:notification] = notification_hash if notification_hash.present?
+        body[:data] = data_hash if data_hash.present?
+
+        body
+      end
+
+      def get_notification_hash
+        return {
+          title: self.payload.title,
+          body: self.payload.body,
+          tag: self.payload.notification.id.to_s
+        }
+      end
+
+      def get_data_hash
+        (self.payload.data || {}).merge({
+          notification_type: self.payload.notification.notification_type,
+          notification_id: self.payload.notification.id
+        })
+      end
+
+      def get_platform
+        raise Exception.new("You must implement 'get_platform' method in child class")
+      end
+
+      def is_data_message
+        raise Exception.new("You must implement 'is_data_message' method in child class")
+      end
+
+    end
+  end
+end

data/app/services/pushkin/fcm/send_ios_push_service.rb

@@ -0,0 +1,22 @@
+module Pushkin
+  module Fcm
+    class SendIosPushService < SendFcmPushService
+
+      def get_notification_hash
+        notification_hash = super
+        notification_hash[:icon] = self.payload.ios_icon if self.payload.ios_icon.present?
+        notification_hash[:click_action] = self.payload.ios_click_action if self.payload.ios_click_action.present?
+        notification_hash
+      end
+
+      def get_platform
+        :ios
+      end
+
+      def is_data_message
+        self.payload.is_ios_data_message
+      end
+
+    end
+  end
+end

data/app/services/pushkin/fcm/send_web_push_service.rb

@@ -0,0 +1,22 @@
+module Pushkin
+  module Fcm
+    class SendWebPushService < SendFcmPushService
+
+      def get_notification_hash
+        notification_hash = super
+        notification_hash[:icon] = self.payload.web_icon if self.payload.web_icon.present?
+        notification_hash[:click_action] = self.payload.web_click_action if self.payload.web_click_action.present?
+        notification_hash
+      end
+
+      def get_platform
+        :web
+      end
+
+      def is_data_message
+        self.payload.is_web_data_message
+      end
+
+    end
+  end
+end

data/app/services/pushkin/send_push_service.rb

@@ -0,0 +1,39 @@
+# Отправляет уведомление на все платформы,
+# сохраняет статистику по отправке в БД,
+# и обновляет инорфмацию об активности токенов
+module Pushkin
+  class SendPushService
+
+    def initialize(notification_id)
+      @notification = Notification.find(notification_id)
+    end
+
+    def call
+      # Получим все токены, на которые нужно отправлять уведомления.
+      all_tokens = @notification.tokens_provider.get_tokens.to_a
+
+      # Создаем список помощников, которые отфильтруют уведомления по платформам.
+      # Они так же предоставляют соответствующие сервисы для отправки уведомлений.
+      token_filters = [Pushkin::TokenFilters::IosTokenFilter.new,
+                       Pushkin::TokenFilters::AndroidTokenFilter.new,
+                       Pushkin::TokenFilters::WebTokenFilter.new]
+
+      # Отправка на конкретные платформы
+      push_sending_results = token_filters.map do |token_filter|
+        tokens = token_filter.filter_tokens(all_tokens)
+        token_filter.get_sending_service(tokens, @notification.payload).call if tokens.present?
+      end
+
+       # Актуализация информации об активности токенов
+      push_sending_results.compact.each do |push_sending_result|
+        push_sending_result.update_attributes(notification_id: @notification.id)
+        push_sending_result.token_results.joins(:token).invalid.each do |token_result|
+          token_result.token.update_attributes(is_active: false)
+        end
+      end
+
+      @notification.update_attributes(finished_at: DateTime.now)
+    end
+
+  end
+end