pushkin-library 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb822d5b68c0e5d26f9c37f0b091508d6bb5b056
-  data.tar.gz: f20025303caaf0a5efc2c2b57a4280c8b9f5e544
+  metadata.gz: d63bca932152d5300789620e58aed1cb32a6f29d
+  data.tar.gz: 6489241bb5b0632c53c315b9e6b007924c6b1593
 SHA512:
-  metadata.gz: 3ff5c5fa8eaee6d5e1f55314830a835ec3a005387f75140fabba0ee7723f1938f3f49d6374c7d1cfd6e01c166c62732835a87df223400d41ca362d0a0095bc13
-  data.tar.gz: 9916574f41a35ac1bb47b5bfce669f3dfa0fe93eafe5e57a98cd276f37ea73fd9919e5238525c7e732a9f8f44bfcaa612c1575e2aafdf347c2413986b3e97582
+  metadata.gz: 54261e0229655d0e8956d7c527cb571e8cef7fdbbdb4c465bfa519aa6dcd36154377ba5ca670c5f56b7c44a3f02a1eb5afe864c35ac770d7dfe9db0d6a5e6c75
+  data.tar.gz: 61d1a58a89713a33bb07da65d8b4622d82d3967ce265696af6fe0e5a86562ceb36f46daed3508c54563ece57e6871fcad2f592fe1d9670339acc18e4b37aacc7

data/README.md

@@ -1,149 +1 @@
-# Pushkin
-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 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-library'
-```
-
-And then execute:
-```bash
-$ bundle install
-```
-
-Execute in command line:
-```bash
-$ bin/rails generate pushkin:setup
-```
-
-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
-$ 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();
-```
-
-**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/controllers/pushkin/api/v1/concerns/api_helper.rb

@@ -4,18 +4,6 @@ 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)

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

@@ -7,7 +7,6 @@ module Pushkin::Api::V1::Concerns::TokensHelper
 
     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"

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

@@ -13,8 +13,7 @@ module Pushkin
       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?
+        @server_key = Pushkin.config.fcm_server_key
       end
 
       def call

data/lib/pushkin.rb

@@ -1,7 +1,16 @@
 require "pushkin/engine"
+require "pushkin/configuration"
 
 module Pushkin
 
+  def self.config
+    Pushkin::Configuration.instance
+  end
+
+  def self.configure(&block)
+    block.call(Pushkin.config)
+  end
+
   def self.simple_notification_to_users(*args)
     Pushkin::NotificationFabric.new.simple_notification_to_users(*args)
   end

data/lib/pushkin/configuration.rb

@@ -0,0 +1,13 @@
+module Pushkin
+  class Configuration
+
+    include Singleton
+
+    attr_accessor :fcm_server_key
+
+    def fcm_server_key
+      @fcm_server_key ||= ENV["FCM_SERVER_KEY"]
+    end
+
+  end
+end

data/lib/pushkin/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pushkin-library
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - Bazov Peter
@@ -98,6 +98,7 @@ files:
 - lib/generators/pushkin/templates/tokens_controller.rb
 - lib/pushkin-library.rb
 - lib/pushkin.rb
+- lib/pushkin/configuration.rb
 - lib/pushkin/engine.rb
 - lib/pushkin/version.rb
 - lib/tasks/pushkin_tasks.rake