jera_push 2.0.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f808be96eee74520b6a4907d7147a1cc4881cacb9a01a2d12a08ad81a2003d8f
-  data.tar.gz: 301f267535f6edc5f5f614f829c11e5fcbeb49e6541ac9a23e6ec5c230c4778b
+  metadata.gz: f7236749dd21e8caed1678a8e44c9e00b6e034e1198b9049bf5bc36ba5cee605
+  data.tar.gz: 36f20664f005ad3459f6651ad32ac1094bd1fa9556d198a332005c92363f6138
 SHA512:
-  metadata.gz: d5494f51637a7f208dd28e7bbad74937b9ce9ccbea88c7f75264a9e1eda79bd3b69197daf5be9f12f5259f0a5582b5a28eb62efbccda64071004aee63602ebe2
-  data.tar.gz: 82a894de332a1d3d6af5c95c388a74cf0f937c087d79a2df507322afbb5ea0ed96116ab93f86e4737229d4229595041eca99093ee5283b683f03bd760b40873c
+  metadata.gz: 03e288ec7ce98901ab70ac41a64df9f607117af92f954357cc383191abe4a970da61764367b324d97fad57c95805fc32a4fc0833ed8980a54bf550acd7418e7c
+  data.tar.gz: f33ffb817dc6f3f3491415703559cbeff5a3efc3e3f1aebab38f49b818605befe837d3a52538ec0f5c9ea64c4b8b3e8b7a11f0cb2dcb063bae049441045f14c9

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

@@ -43,7 +43,13 @@ module JeraPush
     def resend_push
       message = JeraPush::Message.find(params[:id])
       message.devices.find_each do |device|
-        JeraPush::Services::SendPushService.new(device: 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
@@ -65,4 +71,4 @@ module JeraPush
     end
 
   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/lib/generators/active_record/templates/create_jera_push_messages_devices.rb

@@ -4,7 +4,7 @@ class CreateJeraPushMessagesDevices < ActiveRecord::Migration<%= migration_versi
       t.integer :device_id, index: true
       t.integer :message_id, index: true
       t.string :status
-      t.string :error_message
+      t.text :error_message
       t.string :firebase_id
 
       t.timestamps

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

@@ -1,10 +1,10 @@
 #this is the intilizer
 #here you will set up the jera push configuration
 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"
+  # You need to create a Account Service on google cloud, with editor permission or administrator. Flow this doc: https://cloud.google.com/iam/docs/service-accounts-create?hl=pt-br
+  config.project_id = "YOUR_PROJECT_ID" # inside of the account service json
   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                 #

data/lib/jera_push/firebase/client.rb

@@ -3,64 +3,26 @@ module JeraPush::Firebase
     FIREBASE_API_VERSION = 'v1'.freeze
     FIREBASE_INSTANCE_ID_URL = 'https://iid.googleapis.com/iid'.freeze
     SCOPE = 'https://www.googleapis.com/auth/firebase.messaging'.freeze
-    
+
     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
-      
-    def send_to_device(message:)
-      @client.send_message("projects/#{::JeraPush.project_name}", message, options: { retries: 3, multiplier: 1, max_interval: 2 })
-    end
-
-    def add_device_to_topic(topic:, device:)
-      send(url: "#{FIREBASE_INSTANCE_ID_URL}/v1/#{device.token}/rel/topics/#{topic}")
-    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
-      )
+      @client.authorization = fetch_access_token
     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
-      )
+    def send_to_device(push:)
+      @client.send_message("projects/#{::JeraPush.project_id}", push.to_json, options: { retries: 3, multiplier: 1, max_interval: 2 })
     end
 
     private
 
-    def send(url:, body: {})
-      response = HTTParty.post(url, { body: body, headers: default_headers })
-      JSON.parse(response)
-    end
-
     def fetch_access_token
       @authorizer.fetch_access_token! if @authorizer.needs_access_token?
-  
-      @authorizer
-    end  
 
-    def default_headers
-      {
-        "Authorization" => "key=#{::JeraPush.firebase_api_key}",
-        "Content-Type" => "application/json"
-      }
+      @authorizer
     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/notification.rb

@@ -0,0 +1,25 @@
+module JeraPush
+  class Notification
+    attr_accessor :title
+    attr_accessor :body
+    attr_accessor :image
+
+    def initialize(
+      title: '',
+      body: '',
+      image: ''
+    )
+      self.title = title
+      self.body = body
+      self.image = image
+    end
+
+    def to_json
+      {
+        title: title,
+        body: body,
+        image: image
+      }
+    end
+  end
+end

data/lib/jera_push/models/push_body.rb

@@ -0,0 +1,90 @@
+module JeraPush
+  class PushBody
+    attr_accessor :device
+    attr_accessor :devices
+    attr_accessor :notification
+    attr_accessor :data
+    attr_accessor :android
+    attr_accessor :ios
+    attr_accessor :analytics_label
+    attr_accessor :validate_only
+
+    def initialize(
+      data: {},
+      device: nil,
+      devices: [],
+      validate_only: false,
+      analytics_label: '',
+      ios_config: AppleConfig.new,
+      title: '',
+      body: '',
+      image: '',
+      notification: nil,
+      android_config: AndroidConfig.new
+    )
+      self.data = data
+      self.device = device
+      self.devices = devices
+      self.validate_only = validate_only
+      self.analytics_label = analytics_label.gsub(/\s/, '_').gsub(/[^a-zA-Z0-9.~%_]/, '').slice(0, 50).downcase
+      self.ios = ios_config
+      self.notification = notification.nil? ? Notification.new(title: title, body: body, image: image) : notification
+      self.android = android_config
+    end
+
+    def to_json
+      base_body
+    end
+
+    private
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#resource:-message
+    def base_body
+      {
+        message: build_message_body,
+        validate_only: validate_only
+      }
+    end
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#resource:-message
+    def build_message_body
+      {
+        token: device.token,
+        notification: notification_body,
+        data: data_body,
+        apns: apns_body,
+        android: android_body,
+        fcm_options: fcm_body
+      }
+    end
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#Notification
+    def notification_body
+      notification.to_json
+    end
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#resource:-message
+    def data_body
+      data.merge(notification.to_json)
+    end
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#ApnsConfig
+    def apns_body
+      ios.analytics_label = analytics_label
+      ios.to_json
+    end
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#AndroidConfig
+    def android_body
+      android.analytics_label = analytics_label
+      android.to_json
+    end
+
+    # REF: https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br#FcmOptions
+    def fcm_body
+      {
+        analytics_label: analytics_label
+      }
+    end
+  end
+end

data/lib/jera_push/services/send_message.rb

@@ -18,11 +18,13 @@ module JeraPush
           # JeraPush::Message.send_broadcast(content: message_content)
         when :specific
           target_devices = JeraPush::Device.where(id: @devices.uniq.map(&:to_i))
-          result = JeraPush::Services::SendToDevicesService.new(devices: target_devices, 
-            title: message_content[:title], 
-            body: message_content[:body], 
-            data: message_content
-          ).call
+          push = JeraPush::PushBody.new(
+            title: message_content[:title],
+            body: message_content[:body],
+            data: message_content,
+            devices: target_devices
+          )
+          result = JeraPush::Services::SendToDevicesService.new(push: push).call
           result
         end
       end
@@ -42,4 +44,4 @@ module JeraPush
 
     end
   end
-end
+end

data/lib/jera_push/services/send_push_service.rb

@@ -1,12 +1,10 @@
 module JeraPush::Services
   class SendPushService < JeraPush::Services::BaseService
-    def initialize(device:, message:, message_device:, android_config: {}, ios_config: {})
+    def initialize(push:, message:, message_device:)
       super
-      @device = device
+      @push = push
       @message = message
       @message_device = message_device
-      @android_config = android_config
-      @ios_config = ios_config
     end
 
     def call
@@ -20,80 +18,25 @@ module JeraPush::Services
     private
 
     def send_push
-      @response = @firebase.send_to_device(message: message_params(@device))
-      @message_device.update(status: :success)
-      @message.update(success_count: @message.success_count + 1)
+      @response = @firebase.send_to_device(push: @push)
+      save_success
     rescue Google::Apis::AuthorizationError => e
       message = JSON.parse(e.body)
-      @message_device.update(status: :error, error_message: message.to_json)
-      @message.update(failure_count: @message.failure_count + 1)
+      save_error(message)
     rescue Google::Apis::ClientError => e
       response = JSON.parse(e.body, symbolize_names: true)
       error_code = response[:error][:details][0][:errorCode]
-      @message_device.update(status: :error, error_message: response.to_json)
-      @message.update(failure_count: @message.failure_count + 1)
-    end
-
-    # Documentação com o atributos que podem ser usados em { message: }
-    # https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages?hl=pt-br
-    def message_params(device)
-      case device.platform.to_sym
-      when :android
-        android_params(device.token)
-      when :ios
-        ios_params(device.token)
-      else
-        {}
-      end
-    end
-
-    def android_params(token)
-      {
-        message: {
-          token: token,
-          notification: notification,
-          data: @message.data,
-          android: android_configs
-        },
-        validate_only: false
-      }
-    end
-  
-    def ios_params(token)
-      {
-        message: {
-          token: token,
-          notification: notification,
-          data: @message.data,
-          apns: apns_params
-        },
-        validate_only: false
-      }
-    end
-
-    def notification
-      { title: @message.title, body: @message.body }
-    end
-
-    def apns_params
-      @ios_config.empty? ? default_apns_params : @ios_config
+      save_error(response)
     end
 
-    def android_configs
-      @android_config.merge({ priority: 'high'})
+    def save_success
+      @message_device.update(status: :success)
+      @message.update(success_count: @message.success_count + 1)
     end
 
-    def default_apns_params
-      {
-        headers: {
-          'apns-priority': '5'
-        },
-        payload: {
-          aps: {
-            'content-available': 1
-          }
-        }
-      }
+    def save_error(error)
+      @message_device.update(status: :error, error_message: error.to_json)
+      @message.update(failure_count: @message.failure_count + 1)
     end
   end
 end

data/lib/jera_push/services/send_to_device_service.rb

@@ -1,13 +1,9 @@
 module JeraPush::Services
   class SendToDeviceService < JeraPush::Services::BaseService
-    def initialize(device:, title:, body:, data:, android: {}, ios: {})
+    def initialize(push:)
       super
-      @device = device
-      @title = title
-      @body = body
-      @data = data
-      @android_config = android
-      @ios_config = ios
+      @push = push
+      @device = @push.device
     end
 
     def call
@@ -29,7 +25,7 @@ module JeraPush::Services
     end
 
     def create_message
-      @message = JeraPush::Message.create(title: @title, body: @body, data: data_params)
+      @message = JeraPush::Message.create(title: @push.notification.title, body: @push.notification.body, data: @push.data)
     end
 
     def add_devices_to_message
@@ -37,16 +33,10 @@ module JeraPush::Services
     end
 
     def send_push
-      JeraPush::Services::SendPushService.new(device: @device, 
-        message: @message, 
-        message_device: @message_device,
-        ios_config: @ios_config,
-        android_config: @android_config
+      JeraPush::Services::SendPushService.new(push: @push,
+        message: @message,
+        message_device: @message_device
       ).call
     end
-  
-    def data_params
-      @data.merge({ title: @title, body: @body })
-    end
   end
 end

data/lib/jera_push/services/send_to_devices_service.rb

@@ -1,13 +1,9 @@
 module JeraPush::Services
   class SendToDevicesService < JeraPush::Services::BaseService
-    def initialize(devices:, title:, body:, data:, android: {}, ios: {})
+    def initialize(push:)
       super
-      @devices = devices
-      @title = title
-      @body = body
-      @data = data
-      @android_config = android
-      @ios_config = ios
+      @push = push
+      @device = @push.devices
     end
 
     def call
@@ -28,27 +24,22 @@ module JeraPush::Services
     end
 
     def create_message
-      @message = JeraPush::Message.create(title: @title, body: @body, data: data_params)
+      @message = JeraPush::Message.create(title: @push.notification.title, body: @push.notification.body, data: @push.data)
     end
 
     def send_push_to_devices
       @devices.each do |device|
         message_device = @message.message_devices.create(device: device)
+        @push.device = device
         send_push(device, message_device)
       end
     end
 
-    def send_push(device, message_device)
-      JeraPush::Services::SendPushService.new(device: device, 
-        message: @message, 
-        message_device: message_device,
-        ios_config: @ios_config,
-        android_config: @android_config
+    def send_push
+      JeraPush::Services::SendPushService.new(push: @push,
+        message: @message,
+        message_device: @message_device
       ).call
     end
-
-    def data_params
-      @data.merge({ title: @title, body: @body })
-    end
   end
 end

data/lib/jera_push/version.rb

@@ -1,3 +1,3 @@
 module JeraPush
-  VERSION = "2.0.0"
+  VERSION = "2.1.2"
 end

data/lib/jera_push.rb

@@ -22,12 +22,13 @@ module JeraPush
   autoload :Message, 'jera_push/models/message.rb'
   autoload :MessageDevice, 'jera_push/models/message_device.rb'
   autoload :DeviceFilter, 'jera_push/models/device_filter.rb'
+  autoload :PushBody, 'jera_push/models/push_body.rb'
+  autoload :AppleConfig, 'jera_push/models/apple_config.rb'
+  autoload :AndroidConfig, 'jera_push/models/android_config.rb'
+  autoload :Notification, 'jera_push/models/notification.rb'
 
-  mattr_accessor :firebase_api_key
-  @@firebase_api_key = nil
-
-  mattr_accessor :project_name
-  @@project_name = nil
+  mattr_accessor :project_id
+  @@project_id = nil
 
   mattr_accessor :project_id
   @@project_id = nil
@@ -37,7 +38,7 @@ module JeraPush
 
   mattr_accessor :resources_name
   @@resources_name = nil
-  
+
   mattr_accessor :credentials_path
   @@credentials_path = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jera_push
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.2
 platform: ruby
 authors:
 - Jera
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-16 00:00:00.000000000 Z
+date: 2024-07-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -289,10 +289,14 @@ files:
 - lib/jera_push/engine.rb
 - lib/jera_push/firebase/api_result.rb
 - lib/jera_push/firebase/client.rb
+- lib/jera_push/models/android_config.rb
+- lib/jera_push/models/apple_config.rb
 - lib/jera_push/models/device.rb
 - lib/jera_push/models/device_filter.rb
 - lib/jera_push/models/message.rb
 - lib/jera_push/models/message_device.rb
+- lib/jera_push/models/notification.rb
+- lib/jera_push/models/push_body.rb
 - lib/jera_push/services/base_service.rb
 - lib/jera_push/services/send_message.rb
 - lib/jera_push/services/send_push_service.rb