pushkin-library 0.1.3 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f94c98f27e6c326b25532cd82f02081f6abe841e
-  data.tar.gz: 41617fbbbcf2204c5f4a82fa30703ae6cfae6739
+  metadata.gz: cb822d5b68c0e5d26f9c37f0b091508d6bb5b056
+  data.tar.gz: f20025303caaf0a5efc2c2b57a4280c8b9f5e544
 SHA512:
-  metadata.gz: 426e924b8f4827bc186f1b02b2dc1449758b8fec44781579543498233f829dd30f14604be93581cee980695cf5bd1e79a1cdf6062ec2f6edeeccb9eaf8e85c6e
-  data.tar.gz: 4c4a43ade098878b8723c13accd318d375bb5a8342b3434b8ac6e49f6c00cae1589ef6ad3f2d3e7157f723abe1a789f79026aa7b4a4ae689104b0984724cef66
+  metadata.gz: 3ff5c5fa8eaee6d5e1f55314830a835ec3a005387f75140fabba0ee7723f1938f3f49d6374c7d1cfd6e01c166c62732835a87df223400d41ca362d0a0095bc13
+  data.tar.gz: 9916574f41a35ac1bb47b5bfce669f3dfa0fe93eafe5e57a98cd276f37ea73fd9919e5238525c7e732a9f8f44bfcaa612c1575e2aafdf347c2413986b3e97582

data/README.md

@@ -1,28 +1,149 @@
 # Pushkin
-Short description and motivation.
+Pushkin sends push notifications to Android, iOS and Web clients through the unified simple interface using FCM.
+You can also show Web Push Notifications using Pushkin implementation.
 
 ## Usage
-How to use my plugin.
 
-## Installation
+### How to create notifications
+
+```ruby
+notification = Pushkin.simple_notification_to_users({
+  notification_type: "poem",
+  users: User.all,
+  title: "Ruslan and Ludmila",
+  body: "The story of the abduction of Ludmila, the daughter of Prince Vladimir of Kiev, by an evil wizard and the attempt by the brave knight Ruslan to find and rescue her"
+})
+```
+
+It creates a push notification with static content to the specified users. Actual user tokens will be queried from the database at the time of sending.
+
+Run this code to send notification immediately using ActiveJob:
+```ruby
+notification.send_now
+```
+
+You can also send notifications synchronously:
+```ruby
+notification.send_now(async: false)
+```
+
+### Creation parameters
+
+| Parameter          | Usage                    | Description                                                        |
+| ------------------ | ------------------------ | ------------------------------------------------------------------ |
+| :notification_type | Required, String         | Custom string to distinguish notifications from each other         |
+| :users             | Required, Array/Relation | List of users to send push notifications                           |
+| :title             | Required, String         | Notification title                                                 |
+| :body              | Optional, String         | Notification text                                                  |
+| :click_action      | Optional, Hash           | Click actions of each platform                                     |
+| :icon              | Optional, Hash           | Notification icon for web and android platforms                    |
+| :is_data_message   | Optional, Hash           | Specifies if you want to send data message instead of notification |
+| :data              | Optional, Hash           | Any notification data that will be sent in the notification        |
+
+In any case, :data hash will include following parameters:
+
+| Parameter               | Usage                | description                                  |
+| ----------------------- | -------------------- | -------------------------------------------- |
+| :notification_type      | Required, String     | Value of :notification_type parameter        |
+| :notification_id        | Required, Integer    | Unique identifier of created notification    |
+
+**:click_action hash keys**
+
+| Parameter | Usage                | description                          |
+| --------- | -------------------- | ------------------------------------ |
+| :web      | Optional, String     | URL to open in the browser           |
+| :ios      | Optional, String     | Category in the APNs payload         |
+| :android  | Optional, String     | Intent filter to launch the Activity |
+
+**:icon hash keys**
+
+| key      | value type           | description                      |
+| -------- | -------------------- | -------------------------------- |
+| :web     | Optional, String     | Public absolute URL of icon      |
+| :android | Optional, String     | Drawable resource name           |
+
+**:is_data_message hash keys**
+
+| key      | value type           | description                      |
+| -------- | -------------------- | -------------------------------- |
+| :web     | Optional, Boolean    | True, if you want to send data message to web client     |
+| :ios     | Optional, Boolean    | True, if you want to send data message to ios client     |
+| :android | Optional, Boolean    | True, if you want to send data message to android client | 
+
+In case of data messages all notification attributes like title and body will be sent in data instead of notification.
+
+## Gem Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'pushkin'
+gem 'pushkin-library'
 ```
 
 And then execute:
 ```bash
-$ bundle
+$ bundle install
+```
+
+Execute in command line:
+```bash
+$ bin/rails generate pushkin:setup
 ```
 
-Or install it yourself as:
+It will generate:
+* migration *CreatePushkinTables* to create tables for notifications sending.
+* controller *Pushkin::Api::V1::TokensController* for managing device tokens.
+* routes for tokens controller.
+
+And then run migration:
 ```bash
-$ gem install pushkin
+$ rake db:migrate
+```
+
+Add the following to your environment variables:
+```bash
+PUSHKIN_API_KEY=ANY_API_KEY_FOR_REQUEST_AUTHORIZATION
+FCM_SERVER_KEY=YOUR_FCM_SERVER_KEY_FROM_FCM_CONSOLE
+```
+
+If you want to attach device tokens to users, you need to implement authentication logic in *Pushkin::Api::V1::TokensController* and add this line to *User* model:
+```ruby
+include Pushkin::Concerns::PushkinUser
+```
+
+## Web Push Notifications Setup
+
+Add JavaScript FCM Client App to your Rails App ([instructions](https://firebase.google.com/docs/cloud-messaging/js/client)) without permission request, token access and notifications showing. You just need to create FCM project in FCM console, link FCM libraries and put manifest file to public directory.
+
+Add this lines to your layout file:
+```erb
+<script src="https://www.gstatic.com/firebasejs/5.4.1/firebase-app.js"></script>
+<script src="https://www.gstatic.com/firebasejs/5.4.1/firebase-messaging.js"></script>
+<link rel="manifest" href="/manifest.json">
+<%= javascript_include_tag "pushkin/application" %>
+```
+
+Init FCM messaging object in javascript code and save it to Pushkin:
+```javascript
+firebase.initializeApp(yourFirebaseSettings);
+var messaging = firebase.messaging();
+messaging.usePublicVapidKey(YOUR_PUBLIC_VAPID_KEY);
+PUSHKIN.messaging = messaging;
+```
+
+Implement token sending:
+```javascript
+Pushkin.prototype.sendFirebaseTokenToServer = function (currentToken) {
+  // Send currentToken to server using Pushkin API
+}
+```
+
+Init notifications showing, access to token and permission request:
+```javascript
+PUSHKIN.initNotifications();
+PUSHKIN.requestPermission();
 ```
 
-## Contributing
-Contribution directions go here.
+**Attention!** If you want to show push notifications while browser is closed, you still needs to implement this logic in *firebase-messaging-sw.js* yourself.
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/app/models/pushkin/notification.rb

@@ -31,12 +31,12 @@ module Pushkin
     validates :notification_type, presence: true
 
     # Отправляет уведомление прямо сейчас
-    def send_now
+    def send_now(async: true)
       # Заполняем как дату, в которую нужно отправить, так и дату, в которую началась отправка.
       # Это позволит периодической операции по отправке уведомлений не отвлекаться на такое уведомление.
       now = DateTime.now
       self.update_attributes(start_at: now, started_at: now)
-      SendJob.perform_later(self.id)
+      async ? SendJob.perform_later(self.id) : SendPushService.new(self.id).call
     end
   end
 end

data/lib/pushkin.rb

@@ -2,28 +2,8 @@ require "pushkin/engine"
 
 module Pushkin
 
-  def self.android_provider
-    @@android_provider ||= :fcm
-  end
-
-  def self.ios_provider
-    @@ios_provider ||= :fcm
-  end
-
-  def self.web_provider
-    @@web_provider ||= :fcm
-  end
-
-  def self.android_provider=(value)
-    @@android_provider = value
-  end
-
-  def self.ios_provider=(value)
-    @@ios_provider = value
-  end
-
-  def self.web_provider=(value)
-    @@web_provider = value
+  def self.simple_notification_to_users(*args)
+    Pushkin::NotificationFabric.new.simple_notification_to_users(*args)
   end
 
 end

data/lib/pushkin/version.rb

@@ -1,3 +1,3 @@
 module Pushkin
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pushkin-library
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors:
 - Bazov Peter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-24 00:00:00.000000000 Z
+date: 2018-09-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails