pushkin-library 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f94c98f27e6c326b25532cd82f02081f6abe841e
+  data.tar.gz: 41617fbbbcf2204c5f4a82fa30703ae6cfae6739
+SHA512:
+  metadata.gz: 426e924b8f4827bc186f1b02b2dc1449758b8fec44781579543498233f829dd30f14604be93581cee980695cf5bd1e79a1cdf6062ec2f6edeeccb9eaf8e85c6e
+  data.tar.gz: 4c4a43ade098878b8723c13accd318d375bb5a8342b3434b8ac6e49f6c00cae1589ef6ad3f2d3e7157f723abe1a789f79026aa7b4a4ae689104b0984724cef66

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2018 Bazov Peter
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Pushkin
+Short description and motivation.
+
+## Usage
+How to use my plugin.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pushkin'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install pushkin
+```
+
+## Contributing
+Contribution directions go here.
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,36 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Pushkin'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/pushkin_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/pushkin .js
+//= link_directory ../stylesheets/pushkin .css

data/app/assets/javascripts/pushkin/application.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require ./main
+//= require_tree .

data/app/assets/javascripts/pushkin/firebase/push_notifications.js

@@ -0,0 +1,100 @@
+Pushkin.prototype.initNotifications = function() {
+  this.trackTokenRefreshing();
+  this.initNotificationsShow();
+}
+
+Pushkin.prototype.trackTokenRefreshing = function() {
+  var _this = this;
+
+  _this.messaging.onTokenRefresh(function() {
+    _this.messaging.getToken().then(function(refreshedToken) {
+      console.log('Token refreshed.');
+      _this.setTokenSentToServer(false);
+      _this.sendTokenToServerIfNeeds(refreshedToken);
+    }).catch(function(err) {
+      console.log('Unable to retrieve refreshed token ', err);
+      _this.showToken('Unable to retrieve refreshed token ', err);
+    });
+  });
+}
+
+Pushkin.prototype.requestPermission = function() {
+  var _this = this;
+  console.log('Requesting permission...');
+  _this.messaging.requestPermission().then(function() {
+    console.log('Notification permission granted.');
+    _this.getToken();
+  }).catch(function(err) {
+    console.log('Unable to get permission to notify.', err);
+  });
+}
+
+Pushkin.prototype.getToken = function() {
+  var _this = this;
+  _this.messaging.getToken().then(function(currentToken) {
+    if (currentToken) {
+      _this.sendTokenToServerIfNeeds(currentToken);
+    } else {
+      console.log('No Instance ID token available. Request permission to generate one.');
+      _this.setTokenSentToServer(false);
+    }
+  }).catch(function(err) {
+    console.log('An error occurred while retrieving token. ', err);
+    _this.setTokenSentToServer(false);
+  });
+}
+
+Pushkin.prototype.sendTokenToServerIfNeeds = function(currentToken) {
+  var _this = this;
+  if (!_this.isTokenSentToServer()) {
+    console.log('Sending token to server...');
+    _this.sendFirebaseTokenToServer(currentToken);
+  } else {
+    console.log('Token already sent to server so won\'t send it again unless it changes');
+  }
+}
+
+Pushkin.prototype.isTokenSentToServer = function() {
+  return window.localStorage.getItem('sentToServer') === '1';
+}
+
+Pushkin.prototype.setTokenSentToServer = function(sent) {
+  window.localStorage.setItem('sentToServer', sent ? '1' : '0');
+}
+
+Pushkin.prototype.initNotificationsShow = function() {
+  var _this = this;
+  _this.messaging.onMessage(function(payload) {
+    console.log('Message received. ', payload);
+    _this.showFirebaseMessage(payload);
+  });
+}
+
+Pushkin.prototype.showFirebaseMessage = function(payload) {
+  var _this = this;
+  var notificationInfo = payload.notification;
+
+  if(notificationInfo === undefined) {
+    return undefined;
+  }
+
+  var notificationTitle = notificationInfo.title;
+  var notificationOptions = {
+    body: notificationInfo.body,
+    icon: notificationInfo.icon,
+    tag: notificationInfo.tag
+  };
+
+  var notification = new Notification(notificationTitle, notificationOptions);
+  notification.onclick = function(event) {
+    event.preventDefault();
+
+    var clickAction = notificationInfo.click_action;
+    if(clickAction !== undefined && window.location.pathname !== clickAction) {
+      window.location = clickAction;
+    }
+
+    window.focus();
+    notification.close();
+  }
+}

data/app/assets/javascripts/pushkin/main.js

@@ -0,0 +1,5 @@
+Pushkin = function() {
+
+}
+
+PUSHKIN = new Pushkin();

data/app/assets/stylesheets/pushkin/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/pushkin/api/v1/concerns/api_helper.rb

@@ -0,0 +1,43 @@
+# Базовый контроллер для всех остальных контроллеров Пушкина
+module Pushkin::Api::V1::Concerns::ApiHelper
+
+  extend ActiveSupport::Concern
+
+  included do
+    WRONG_API_KEY = "Wrong API key"
+
+    # Проверяет переданный ключ API и возвращает ошибку в случае несовпадения.
+    # Для минимальной защиты от несанкционированного доступа.
+    def check_api_key!
+      api_key = ENV["PUSHKIN_API_KEY"]
+      raise Exception.new("No PUSHKIN_API_KEY in ENV") if api_key.blank?
+
+      if api_key != params[:push_api_key]
+        render :status => 403, :json => { :success => false, :info => WRONG_API_KEY }
+      end
+    end
+
+    def render_bad_request(info, errors = nil)
+      render_error(400, info, errors)
+      return nil
+    end
+
+    def render_unprocessable_entity(info, errors = nil)
+      render_error(422, info, errors)
+      return nil
+    end
+
+    def render_error(status, info, errors)
+      render :status => status, :json => { :success => false, :info => info, errors: errors }
+      return nil
+    end
+
+    def render_success(info = nil, data = nil)
+      response = { :success => true, info: info }
+      response[:data] = data unless data.nil?
+      render :json => response
+      return nil
+    end
+  end
+
+end

data/app/controllers/pushkin/api/v1/concerns/tokens_helper.rb

@@ -0,0 +1,94 @@
+# Контроллер по управлению PUSH токенами
+module Pushkin::Api::V1::Concerns::TokensHelper
+
+  extend ActiveSupport::Concern
+
+  included do
+
+    include Pushkin::Api::V1::Concerns::ApiHelper
+
+    before_action :check_api_key!
+    before_action :init_creation_params!, only: [:create]
+
+    EMPTY_TOKEN_ERROR = "param 'token' is empty"
+    EMPTY_PLATFORM_ERROR = "params 'platform' is empty"
+    TOKEN_NOT_CREATED_ERROR = "token not created"
+    USER_NOT_SAVED_ERROR = "user not saved"
+    OLD_TOKEN_ERROR = "old token not disactivated"
+    TOKEN_NOT_ACTIVATED = "token not activated"
+
+    # Создает токен, если он не существует.
+    # Прикрепляет токен к пользователю, если пользователь авторизован.
+    # Помечает старый токен неактивным, если передана соответствующая информация.
+    def create
+      @token = Pushkin::Token.unscoped.where(token_attributes).first
+
+      # Сохранение токена в БД, если его еще не существует
+      if @token.nil?
+        @token = Pushkin::Token.create(token_attributes)
+        return render_token_not_created if @token.errors.present?
+      end
+
+      # Привязка/Отвязка пользователя с токеном.
+      if @token.user_id != @user_id
+        @token.update_attributes(user_id: @user_id)
+        return render_user_not_saved if @token.errors.present?
+      end
+
+      # Если вдруг каким-то обрабом токен помечен как неактивный, это нужно исправить
+      unless @token.is_active
+        @token.update_attributes(is_active: true)
+        return render_token_not_activated if @token.errors.present?
+      end
+
+      # Если передана информация о старом токене, его нужно деактивировать.
+      if @old_token_string.present?
+        if @old_token = Pushkin::Token.unscoped.where(token_attributes(@old_token_string)).first
+          @old_token.update_attributes(is_active: false)
+          return render_old_token_error if @old_token.errors.present?
+        end
+      end
+
+      render_success("Done")
+    end
+
+    def init_creation_params!
+      @token_string = token_params[:token]
+      @platform = token_params[:platform]
+      @old_token_string = token_params[:old_token]
+      @user_id = current_pushkin_user ? current_pushkin_user.id : nil
+
+      return render_bad_request(EMPTY_TOKEN_ERROR) if @token_string.blank?
+      return render_bad_request(EMPTY_PLATFORM_ERROR) if @platform.blank?
+    end
+
+    def token_params
+      @token_params ||= params.require(:push_token_info).permit(:token, :platform, :old_token)
+    end
+
+    def token_attributes(token_string = @token_string)
+      { token: token_string, platform: @platform }
+    end
+
+    def render_token_not_created
+      render_unprocessable_entity(TOKEN_NOT_CREATED_ERROR, @token.errors.messages)
+    end
+
+    def render_user_not_saved
+      render_unprocessable_entity(USER_NOT_SAVED_ERROR, @token.errors.messages)
+    end
+
+    def render_token_not_activated
+      render_unprocessable_entity(TOKEN_NOT_ACTIVATED, @token.errors.messages)
+    end
+
+    def render_old_token_error
+      render_unprocessable_entity(OLD_TOKEN_ERROR, @old_token.errors.messages)
+    end
+
+    def current_pushkin_user
+      nil
+    end
+  end
+
+end

data/app/controllers/pushkin/application_controller.rb

@@ -0,0 +1,5 @@
+module Pushkin
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/fabrics/pushkin/notification_fabric.rb

@@ -0,0 +1,83 @@
+# Создает уведомления в БД по переданным данным
+module Pushkin
+  class NotificationFabric
+
+    # Создает уведомление со статическими данными.
+    # Актуальный список устройств, на которые нужно отправить уведомления,
+    # будут получены из пользователей в момент отправки.
+    def simple_notification_to_users(users: [], title: [], body: [],
+                                     is_data_message: false, click_action: nil, icon: nil,
+                                     data: {}, notification_type: nil)
+      return nil if users.blank?
+
+      payload_attrs = { title: title, body: body, data: data }
+      payload_attrs = payload_attrs.merge(self.is_data_message_attrs(is_data_message))
+      payload_attrs = payload_attrs.merge(self.click_action_attrs(click_action))
+      payload_attrs = payload_attrs.merge(self.icon_attrs(icon))
+      payload = Payload.create(payload_attrs)
+
+      tokens_provider = TokensProvider.create(users: users)
+
+      Notification.create(notification_type: notification_type,
+                          payload: payload,
+                          tokens_provider: tokens_provider)
+    end
+
+    def is_data_message_attrs(is_data_message = false)
+      if is_data_message.is_a? Hash
+        is_android_data_message = is_data_message[:android]
+        is_ios_data_message = is_data_message[:ios]
+        is_web_data_message = is_data_message[:web]
+
+        is_android_data_message = false if is_android_data_message.nil?
+        is_ios_data_message = false if is_ios_data_message.nil?
+        is_web_data_message = false if is_web_data_message.nil?
+
+        return {
+          is_android_data_message: is_android_data_message,
+          is_ios_data_message: is_ios_data_message,
+          is_web_data_message: is_web_data_message
+        }
+      else
+        return {
+          is_android_data_message: is_data_message,
+          is_ios_data_message: is_data_message,
+          is_web_data_message: is_data_message
+        }
+      end
+    end
+
+    def click_action_attrs(click_action = nil)
+      if click_action.is_a? Hash
+        return {
+          android_click_action: click_action[:android],
+          ios_click_action: click_action[:ios],
+          web_click_action: click_action[:web]
+        }
+      else
+        return {
+          android_click_action: click_action,
+          ios_click_action: click_action,
+          web_click_action: click_action
+        }
+      end
+    end
+
+    def icon_attrs(icon = nil)
+      if icon.is_a? Hash
+        return {
+          android_icon: icon[:android],
+          ios_icon: icon[:ios],
+          web_icon: icon[:web]
+        }
+      else
+        return {
+          android_icon: icon,
+          ios_icon: icon,
+          web_icon: icon
+        }
+      end
+    end
+
+  end
+end