jera_push 1.2.4 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6f63d90cf49a65d29029d1c6597afb8e813537a7b60ed9b045a885eb1799f81
-  data.tar.gz: 57af32466be12fbc0828920abc1f556b9351452f491e4981cf54a93a1dda060e
+  metadata.gz: aed822e33bf25c1e59e030e3d32d4aa45de406535a3993339ae12e43cd27b90c
+  data.tar.gz: d11416aeea95d06bbaa598a0d3c3c2c61c7912c0361f4e2888c378de9cf7add9
 SHA512:
-  metadata.gz: 7bfd9f73d69b6650e536549022c378eb34404ff494ff71d718974af27236f3b0cfe56107c130b6149485398675b86b47cc02815e3a0cb487691c86ca0d99b2b9
-  data.tar.gz: 7c6c7e81a5efb2eff4de42167b54d55953d8ac8522e0a74628146b911c6a5cb2de2dbe38df5e13b03d182a7b2df8ada0874c55f89cb8389259f8b8180bc8119a
+  metadata.gz: 793828acf069f18159e6ec301327b0cbe21e4e8600c1485931e26b0229e299d7c287e8b275aa0e7e5ca254fab8e5317f5d618f703eea78cc01d8572ebb482e91
+  data.tar.gz: 8bd496cc69b14561a847e5ae7ce1b198a9d21a98642abec25c11e46863be75b1e8ae5af357c04ec24728d0050178f3f346eeeb7ae553624271cbb7ae5d736393

data/Rakefile

@@ -1,10 +1,16 @@
+require 'rake'
+
 begin
   require 'bundler/setup'
+
+  Bundler::GemHelper.install_tasks
 rescue LoadError
-  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+  puts 'although not required, bundler is recommended for running the tests'
 end
 
-require 'rdoc/task'
+task default: :spec
+
+require 'rspec/core/rake_task'
 
 RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
@@ -14,21 +20,9 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
+require 'rubocop/rake_task'
 
-
-
-
-
-Bundler::GemHelper.install_tasks
-
-require 'rake/testtask'
-
-Rake::TestTask.new(:test) do |t|
-  t.libs << 'lib'
-  t.libs << 'test'
-  t.pattern = 'test/**/*_test.rb'
-  t.verbose = false
+RuboCop::RakeTask.new do |task|
+  task.requires << 'rubocop-performance'
+  task.requires << 'rubocop-rspec'
 end
-
-
-task default: :test

data/app/controllers/jera_push/admin/messages_controller.rb

@@ -28,7 +28,7 @@ module JeraPush
     end
 
     def create
-      push_message = JeraPush::Service::SendMessage.new(message_params).call
+      push_message = JeraPush::Services::SendMessage.new(params).call
 
       if push_message
         flash[:notice] = t('jera_push.admin.messages.new.toast.success')
@@ -40,20 +40,35 @@ module JeraPush
       end
     end
 
+    def resend_push
+      message = JeraPush::Message.find(params[:id])
+      message.devices.find_each do |device|
+        push = JeraPush::PushBody.new(
+          title: message.title,
+          body: message.body,
+          data: message.data,
+          device: device
+        )
+        JeraPush::Services::SendPushService.new(push: push,
+          message: message,
+          message_device: message.message_devices.where(device: device).last
+        ).call
+      end
+      flash[:notice] = t('jera_push.admin.messages.new.toast.success')
+      redirect_to jera_push_admin_message_path(message)
+    end
+
     private
 
-      def apply_filter
-        @filter = JeraPush::DeviceFilter.new device_filter_params
-        @devices = @filter.search.limit(params[:limit]).order(created_at: :desc)
-        @message_devices = JeraPush::MessageDevice.includes(:device).where('message_id = :id and device_id in (:device_ids)', id: params[:id], device_ids: @devices.pluck(:id))
-      end
+    def apply_filter
+      @filter = JeraPush::DeviceFilter.new device_filter_params
+      @devices = @filter.search.limit(params[:limit]).order(created_at: :desc)
+      @message_devices = JeraPush::MessageDevice.includes(:device).where(message_id: params[:id], device_id: @devices.pluck(:id))
+    end
 
-      def message_params
-        params.permit(:type, devices: [], message: [:key, :value])
-      end
+    def device_filter_params
+      params.permit(:value, :field, platform: []).merge({ message_id: params[:id] })
+    end
 
-      def device_filter_params
-        params.permit(:value, :field, :resource_name, platform: []).merge({ message_id: params[:id] })
-      end
   end
 end

data/app/controllers/jera_push/jera_push_controller.rb

@@ -1,7 +1,5 @@
 module JeraPush
   class JeraPushController < ::ApplicationController
-    protect_from_forgery unless: -> { request.format.json? }
-
     protected
 
     def render_invalid_params

data/app/presenters/jera_push/message_presenter.rb

@@ -1,25 +1,29 @@
 class JeraPush::MessagePresenter < BasePresenter
 
-	def list_content
-		JSON.pretty_generate({
-			title: item.content["title"],
-			body: item.content["body"]
-		})
-	end
+  def list_content
+    JSON.pretty_generate({
+      title: item.title,
+      body: item.body
+    })
+  end
 
-	def display_content
-		JSON.pretty_generate(item.content)
-	end
+  def display_content
+    JSON.pretty_generate({
+      title: item.title,
+      body: item.body,
+      data: item.data
+    })
+  end
 
-	def display_created_at
-		item.created_at.strftime('%d/%m/%Y %H:%M')
-	end
+  def display_created_at
+    item.created_at.strftime('%d/%m/%Y %H:%M')
+  end
 
-	def show_link
-		helpers.link_to(
-			helpers.t('jera_push.admin.buttons.details'),
-			Rails.application.routes.url_helpers.jera_push_admin_message_path(item), class: 'waves-effect waves-light btn'
-		)
-	end
+  def show_link
+    helpers.link_to(
+      helpers.t('jera_push.admin.buttons.details'),
+      Rails.application.routes.url_helpers.jera_push_admin_message_path(item), class: 'waves-effect waves-light btn'
+    )
+  end
 
 end

data/app/views/jera_push/admin/messages/show.html.erb

@@ -2,7 +2,10 @@
 
   <div class="details">
     <h3><%= t('jera_push.active_record.model.message.one') %></h3>
-
+    <%= form_tag resend_push_jera_push_admin_message_path(@message), method: :get, class: 'col s12', remote: true do |f| %>
+      <%= submit_tag t('jera_push.admin.messages.resend'), class: 'btn' %>
+    <% end %>
+    <br>
     <span class="field">
       <%= t('jera_push.active_record.messages.attributes.id') %>
     </span>
@@ -13,7 +16,7 @@
     </span>
     <blockquote class="json-message"><%= @message.display_content %></blockquote>
 
-    <% unless @message.kind.broadcast? %>
+    <% unless @message.kind.everyone? %>
       <span class="field">
         <%= t('jera_push.active_record.messages.attributes.status') %>
       </span>
@@ -25,8 +28,8 @@
     <% end %>
   </div>
 
-  <% if @message.kind.broadcast? %>
-    <h3><%= JeraPush::Message.kind.broadcast.text %></h3>
+  <% if @message.kind.everyone? %>
+    <h3><%= JeraPush::Message.kind.everyone.text %></h3>
 
     <div class="message-info">
       <%= render partial: 'jera_push/admin/messages/broadcast_message', message: @message %>

data/config/locale/jera_push.pt-BR.yml

@@ -29,6 +29,7 @@ pt-BR:
     admin:
       attributes:
         id: Identificador
+        token: Token
         name: Nome
         email: Email
       navbar:
@@ -62,6 +63,7 @@ pt-BR:
       messages:
         failures: "Falhas: %{value}"
         success: "Sucessos: %{value}"
+        resend: Reenviar a push
         show:
           broadcast:
             platform: Plataforma
@@ -76,3 +78,8 @@ pt-BR:
           new_attribute: Novo Atributo
           specific: Específico
           broadcast: Broadcast
+    services:
+      errors:
+        not_found:
+          device: Dispositivo não pode ficar em branco
+

data/config/routes.rb

@@ -10,6 +10,7 @@ Rails.application.routes.draw do
         end
         member do
           get :message_devices_filter, format: :js
+          get :resend_push, format: :js
         end
       end
       resources :devices, only: [:index]

data/lib/generators/active_record/templates/create_jera_push_devices.rb

@@ -5,8 +5,9 @@ class CreateJeraPushDevices < ActiveRecord::Migration<%= migration_version %>
       t.string :platform, index: true
       t.references :pushable, polymorphic: true, index: true
 
-      t.timestamps null: false
+      t.timestamps
     end
+
     add_index :jera_push_devices, [:token, :platform], unique: true
   end
 end

data/lib/generators/active_record/templates/create_jera_push_messages.rb

@@ -1,17 +1,20 @@
 class CreateJeraPushMessages < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :jera_push_messages do |t|
-      t.text :content
+      t.string :title
+      t.text :body
+      t.json :data
+      t.string :multicast_id
       t.text :broadcast_result
       t.string :status
       t.string :kind
       t.string :topic
       t.string :firebase_id
-      t.string :error_message
+      t.json :error_message
       t.integer :failure_count, default: 0
       t.integer :success_count, default: 0
 
-      t.timestamps null: false
+      t.timestamps
     end
   end
 end

data/lib/generators/active_record/templates/create_jera_push_messages_devices.rb

@@ -1,13 +1,13 @@
 class CreateJeraPushMessagesDevices < ActiveRecord::Migration<%= migration_version %>
   def change
     create_table :jera_push_messages_devices do |t|
-      t.integer :device_id, index: true, foreign_key: true
-      t.integer :message_id, index: true, foreign_key: true
+      t.integer :device_id, index: true
+      t.integer :message_id, index: true
       t.string :status
       t.string :error_message
       t.string :firebase_id
 
-      t.timestamps null: false
+      t.timestamps
     end
 
     add_index :jera_push_messages_devices, [:device_id, :message_id], unique: true, name: :jera_push_index_messages_id_devices_id

data/lib/generators/jera_push/templates/jera_push.rb

@@ -4,7 +4,8 @@ JeraPush.setup do |config|
   config.firebase_api_key = "YOUR_API_KEY"
   # Change this for every new model
   config.resources_name = ["<%= file_name.classify %>"]
-
+  config.project_name = "YOUR_PROJECT_NAME"
+  config.credentials_path = "YOUR_CREDENTIALS_PATH" #https://firebase.google.com/docs/cloud-messaging/migrate-v1?hl=pt-br#provide-credentials-manually
   ######################################################
   # Resource attribute showed in views                 #
   # IMPORTANT: All models need to have this attributes #

data/lib/jera_push/firebase/client.rb

@@ -1,69 +1,66 @@
-module JeraPush
-  module Firebase
-    class Client
+module JeraPush::Firebase
+  class Client
+    FIREBASE_API_VERSION = 'v1'.freeze
+    FIREBASE_INSTANCE_ID_URL = 'https://iid.googleapis.com/iid'.freeze
+    SCOPE = 'https://www.googleapis.com/auth/firebase.messaging'.freeze
 
-      cattr_accessor :client
+    def initialize
+      @client = Google::Apis::FcmV1::FirebaseCloudMessagingService.new
+      @authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
+        json_key_io: File.open(::JeraPush::credentials_path),
+        scope: SCOPE
+      )
+      @client.authorization = fetch_access_token
+    end
 
-      FIREBASE_URL = "https://fcm.googleapis.com/fcm/send"
-      FIREBASE_INSTANCE_ID_URL = "https://iid.googleapis.com/iid"
+    def send_to_device(push:)
+      @client.send_message("projects/#{::JeraPush.project_name}", push.to_json, options: { retries: 3, multiplier: 1, max_interval: 2 })
+    end
 
-      def default_headers
-        return {
-          "Authorization" => "key=#{::JeraPush.firebase_api_key}",
-          "Content-Type" => "application/json"
-        }
-      end
+    def add_device_to_topic(topic:, device:)
+      send(url: "#{FIREBASE_INSTANCE_ID_URL}/v1/#{device.token}/rel/topics/#{topic}")
+    end
 
-      def self.instance
-        @@client ||= JeraPush::Firebase::Client.new
-      end
+    def remove_device_from_topic(topic:, devices: [])
+      send(
+        url: "#{FIREBASE_INSTANCE_ID_URL}/v1:batchRemove",
+        body: {
+          to: "/topics/#{topic}",
+          registration_tokens: devices.pluck(:token)
+        }.to_json
+      )
+    end
 
-      def send_message(message:, devices: [])
-        registration_ids = devices.map(&:token)
-        body = { registration_ids: registration_ids, priority: 'high' }
-        response = HTTParty.post(FIREBASE_URL, { body: body.merge!(message).to_json, headers: default_headers })
-        puts response
-        ApiResult.new(response, registration_ids: registration_ids)
-      end
+    def send_message_to_topic(message:, topic:)
+      send(
+        url: FIREBASE_URL,
+        body: {
+          title: message.title,
+          body: message.body,
+          to: "/topics/#{topic}",
+          priority: 'high'
+        }.to_json
+      )
+    end
 
-      def send_message_to_topic(message:, topic:)
-        body = { to: "/topics/#{topic}", priority: 'high' }
-        response = HTTParty.post(FIREBASE_URL, { body: body.merge!(message).to_json, headers: default_headers })
-        puts response
-        ApiResult.new(response, topic: topic)
-      end
+    private
 
-      def device_details(device:)
-        url = "#{FIREBASE_INSTANCE_ID_URL}/info/#{device.token}/"
-        response = HTTParty.post(url, { body: Hash.new.to_json, headers: default_headers })
-        ApiResult.new(response)
-      end
+    def send(url:, body: {})
+      response = HTTParty.post(url, { body: body, headers: default_headers })
+      JSON.parse(response)
+    end
 
-      def add_device_to_topic(topic:, device:)
-        url = "#{FIREBASE_INSTANCE_ID_URL}/v1/#{device.token}/rel/topics/#{topic}"
-        response = HTTParty.post(url, { body: Hash.new.to_json, headers: default_headers })
-        ApiResult.new(response)
-      end
+    def fetch_access_token
+      @authorizer.fetch_access_token! if @authorizer.needs_access_token?
 
-      def add_devices_to_topic(topic:, devices: [])
-        url = "#{FIREBASE_INSTANCE_ID_URL}/v1:batchAdd"
-        body = {
-          "to": "/topics/#{topic}",
-          "registration_tokens": devices.map(&:token),
-        }
-        response = HTTParty.post(url, { body: body.to_json, headers: default_headers })
-        ApiResult.new(response)
-      end
+      @authorizer
+    end
 
-      def remove_device_from_topic(topic:, devices: [])
-        url = "#{FIREBASE_INSTANCE_ID_URL}/v1:batchRemove"
-        body = {
-          "to": "/topics/#{topic}",
-          "registration_tokens": devices.map(&:token),
-        }
-        response = HTTParty.post(url, { body: body.to_json, headers: default_headers })
-        ApiResult.new(response)
-      end
+    def default_headers
+      {
+        "Authorization" => "key=#{::JeraPush.firebase_api_key}",
+        "Content-Type" => "application/json"
+      }
     end
   end
 end

data/lib/jera_push/models/android_config.rb

@@ -0,0 +1,33 @@
+module JeraPush
+  class AndroidConfig
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#AndroidMessagePriority
+    attr_accessor :priority
+    attr_accessor :analytics_label
+
+
+    def initialize(
+      priority: 'high',
+      analytics_label: nil
+    )
+      self.priority = priority
+      self.analytics_label = analytics_label
+    end
+
+    def to_json
+      android_body
+    end
+
+    private
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#AndroidConfig
+    def android_body
+      {
+        priority: priority,
+        # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#FcmOptions
+        fcm_options: {
+          analytics_label: analytics_label
+        }
+      }
+    end
+  end
+end

data/lib/jera_push/models/apple_config.rb

@@ -0,0 +1,61 @@
+module JeraPush
+  # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#ApnsConfig 
+  class AppleConfig
+    # Specify 5 to send the notification based on power considerations on the user’s device.
+    # Specify 10 to send the notification immediately.
+    attr_accessor :apns_priority
+    attr_accessor :headers
+    # REF: https://developer.apple.com/documentation/usernotifications/generating-a-remote-notification
+    # REF: https://developer.apple.com/documentation/usernotifications/pushing-background-updates-to-your-app
+    attr_accessor :content_available
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#ApnsFcmOptions
+    attr_accessor :analytics_label
+    attr_accessor :analytics_image
+
+    def initialize(
+      apns_priority: '5',
+      headers: {},
+      content_available: 1,
+      analytics_label: nil,
+      analytics_image: nil
+    )
+      self.apns_priority = apns_priority
+      self.headers = headers
+      self.content_available = content_available
+      self.analytics_label = analytics_label
+    end
+
+    def to_json
+      apns_body
+    end
+
+    private
+
+    def apns_body
+      {
+        headers: headers_body,
+        payload: payload_body,
+        fcm_options: fcm_body
+      }
+    end
+
+    def headers_body
+      headers.merge!({ 'apns-priority': apns_priority} )
+    end
+
+    def payload_body
+      {
+        aps: { 
+          'content-available': content_available
+        }
+      }
+    end
+
+    def fcm_body
+      {
+        analytics_label: analytics_label,
+        image: analytics_image
+      }
+    end
+  end
+end

data/lib/jera_push/models/device.rb

@@ -3,21 +3,16 @@ require 'enumerize'
 class JeraPush::Device < ActiveRecord::Base
   extend Enumerize
 
-  DEFAULT_TOPIC = 'general'
-
   self.table_name = "jera_push_devices"
 
-  has_many :message_devices, table_name: "jera_push_message_devices"
-  has_many :messages, through: :message_devices, table_name: "jera_push_messages"
-
   belongs_to :pushable, polymorphic: true
 
+  has_many :message_devices, class_name: "JeraPush::MessageDevice"
+  has_many :messages, through: :message_devices, class_name: "JeraPush::Message"
+
   validates :token, :platform, presence: true
   validates :token, uniqueness: { scope: :platform }
 
-  after_create :register_to_current_topic
-  before_destroy :unregister_from_current_topic
-
   enumerize :platform, in: [:android, :ios, :chrome], predicate: true
 
   scope :ios,  -> { where(platform: :ios) }
@@ -25,27 +20,4 @@ class JeraPush::Device < ActiveRecord::Base
   scope :chrome, -> { where(platform: :chrome) }
   scope :with_joins, -> (resource_type) { joins("INNER JOIN #{resource_type.downcase.pluralize} ON  jera_push_devices.pushable_id = #{resource_type.downcase.pluralize}.id AND jera_push_devices.pushable_type  = '#{resource_type}'") }
 
-  def send_message(message)
-    JeraPush::Message.send_to self, content: message
-  end
-
-  def subscribe(topic)
-    client = JeraPush::Firebase::Client.instance
-    client.add_device_to_topic(topic: topic, device: self)
-  end
-
-  def unsubscribe(topic)
-    client = JeraPush::Firebase::Client.instance
-    client.remove_device_from_topic(topic: topic, devices: [self])
-  end
-
-  private
-
-    def register_to_current_topic
-      subscribe(JeraPush.send("topic_#{self.platform}"))
-    end
-
-    def unregister_from_current_topic
-      unsubscribe(JeraPush.send("topic_#{self.platform}"))
-    end
 end