fcm 0.0.2 → 1.0.8

data/lib/fcm.rb

@@ -1,190 +1,263 @@
-require 'httparty'
-require 'cgi'
-require 'json'
+require "faraday"
+require "cgi"
+require "json"
+require "googleauth"
 
 class FCM
-  include HTTParty
-  base_uri 'https://fcm.googleapis.com/fcm'
-  default_timeout 30
-  format :json
+  BASE_URI = "https://fcm.googleapis.com"
+  BASE_URI_V1 = "https://fcm.googleapis.com/v1/projects/"
+  DEFAULT_TIMEOUT = 30
+  FORMAT = :json
 
   # constants
-  GROUP_NOTIFICATION_BASE_URI = 'https://android.googleapis.com/gcm'
+  GROUP_NOTIFICATION_BASE_URI = "https://android.googleapis.com"
+  INSTANCE_ID_API = "https://iid.googleapis.com"
+  TOPIC_REGEX = /[a-zA-Z0-9\-_.~%]+/
 
-  attr_accessor :timeout, :api_key
+  attr_accessor :timeout, :api_key, :json_key_path, :project_base_uri
 
-  def initialize(api_key, client_options = {})
+  def initialize(api_key, json_key_path = "", project_name = "", client_options = {})
     @api_key = api_key
     @client_options = client_options
+    @json_key_path = json_key_path
+    @project_base_uri = BASE_URI_V1 + project_name.to_s
   end
 
+  # See https://firebase.google.com/docs/cloud-messaging/send-message
   # {
-  #   "collapse_key": "score_update",
-  #   "time_to_live": 108,
-  #   "delay_while_idle": true,
-  #   "registration_ids": ["4", "8", "15", "16", "23", "42"],
-  #   "data" : {
-  #     "score": "5x1",
-  #     "time": "15:10"
+  #   "token": "4sdsx",
+  #   "notification": {
+  #     "title": "Breaking News",
+  #     "body": "New news story available."
+  #   },
+  #   "data": {
+  #     "story_id": "story_12345"
+  #   },
+  #   "android": {
+  #     "notification": {
+  #       "click_action": "TOP_STORY_ACTIVITY",
+  #       "body": "Check out the Top Story"
+  #     }
+  #   },
+  #   "apns": {
+  #     "payload": {
+  #       "aps": {
+  #         "category" : "NEW_MESSAGE_CATEGORY"
+  #       }
+  #     }
   #   }
   # }
+  # fcm = FCM.new(api_key, json_key_path, project_name)
+  # fcm.send(
+  #    { "token": "4sdsx",, "to" : "notification": {}.. }
+  # )
+  def send_notification_v1(message)
+    return if @project_base_uri.empty?
+
+    post_body = { 'message': message }
+
+    response = Faraday.post("#{@project_base_uri}/messages:send") do |req|
+      req.headers["Content-Type"] = "application/json"
+      req.headers["Authorization"] = "Bearer #{jwt_token}"
+      req.body = post_body.to_json
+    end
+    build_response(response)
+  end
+
+  alias send_v1 send_notification_v1
+
+  # See https://developers.google.com/cloud-messaging/http for more details.
+  # { "notification": {
+  #  "title": "Portugal vs. Denmark",
+  #  "text": "5 to 1"
+  # },
+  # "to" : "bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1..."
+  # }
   # fcm = FCM.new("API_KEY")
-  # fcm.send(registration_ids: ["4sdsx", "8sdsd"], {data: {score: "5x1"}})
+  # fcm.send(
+  #    ["4sdsx", "8sdsd"], # registration_ids
+  #    { "notification": { "title": "Portugal vs. Denmark", "text": "5 to 1" }, "to" : "bk3RNwTe3HdFQ3P1..." }
+  # )
   def send_notification(registration_ids, options = {})
     post_body = build_post_body(registration_ids, options)
 
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Authorization' => "key=#{@api_key}",
-        'Content-Type' => 'application/json'
-      }
-    }
-    response = self.class.post('/send', params.merge(@client_options))
-    build_response(response, registration_ids)
+    for_uri(BASE_URI) do |connection|
+      response = connection.post("/fcm/send", post_body.to_json)
+      build_response(response, registration_ids)
+    end
   end
+
   alias send send_notification
 
   def create_notification_key(key_name, project_id, registration_ids = [])
-    post_body = build_post_body(registration_ids, operation: 'create',
-                                notification_key_name: key_name)
-
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Content-Type' => 'application/json',
-        'project_id' => project_id,
-        'Authorization' => "key=#{@api_key}"
-      }
-    }
+    post_body = build_post_body(registration_ids, operation: "create",
+                                                  notification_key_name: key_name)
 
-    response = nil
+    extra_headers = {
+      "project_id" => project_id,
+    }
 
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.post('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.post("/gcm/notification", post_body.to_json)
+      build_response(response)
     end
-
-    build_response(response)
   end
+
   alias create create_notification_key
 
   def add_registration_ids(key_name, project_id, notification_key, registration_ids)
-    post_body = build_post_body(registration_ids, operation: 'add',
-                                notification_key_name: key_name,
-                                notification_key: notification_key)
-
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Content-Type' => 'application/json',
-        'project_id' => project_id,
-        'Authorization' => "key=#{@api_key}"
-      }
-    }
+    post_body = build_post_body(registration_ids, operation: "add",
+                                                  notification_key_name: key_name,
+                                                  notification_key: notification_key)
 
-    response = nil
+    extra_headers = {
+      "project_id" => project_id,
+    }
 
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.post('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.post("/gcm/notification", post_body.to_json)
+      build_response(response)
     end
-    build_response(response)
   end
+
   alias add add_registration_ids
 
   def remove_registration_ids(key_name, project_id, notification_key, registration_ids)
-    post_body = build_post_body(registration_ids, operation: 'remove',
-                                notification_key_name: key_name,
-                                notification_key: notification_key)
-
-    params = {
-      body: post_body.to_json,
-      headers: {
-        'Content-Type' => 'application/json',
-        'project_id' => project_id,
-        'Authorization' => "key=#{@api_key}"
-      }
-    }
+    post_body = build_post_body(registration_ids, operation: "remove",
+                                                  notification_key_name: key_name,
+                                                  notification_key: notification_key)
 
-    response = nil
+    extra_headers = {
+      "project_id" => project_id,
+    }
 
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.post('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.post("/gcm/notification", post_body.to_json)
+      build_response(response)
     end
-    build_response(response)
   end
+
   alias remove remove_registration_ids
 
   def recover_notification_key(key_name, project_id)
-    params = {
-      query: {
-        notification_key_name: key_name
-      },
-      headers: {
-        'Content-Type' => 'application/json',
-        'project_id' => project_id,
-        'Authorization' => "key=#{@api_key}"
-      }
-    }
+    params = { notification_key_name: key_name }
 
-    response = nil
+    extra_headers = {
+      "project_id" => project_id,
+    }
 
-    for_uri(GROUP_NOTIFICATION_BASE_URI) do
-      response = self.class.post('/notification', params.merge(@client_options))
+    for_uri(GROUP_NOTIFICATION_BASE_URI, extra_headers) do |connection|
+      response = connection.get("/gcm/notification", params)
+      build_response(response)
     end
-    build_response(response)
   end
 
   def send_with_notification_key(notification_key, options = {})
     body = { to: notification_key }.merge(options)
+    execute_notification(body)
+  end
 
-    params = {
-      body: body.to_json,
-      headers: {
-        'Authorization' => "key=#{@api_key}",
-        'Content-Type' => 'application/json'
-      }
-    }
+  def topic_subscription(topic, registration_id)
+    for_uri(INSTANCE_ID_API) do |connection|
+      response = connection.post("/iid/v1/#{registration_id}/rel/topics/#{topic}")
+      build_response(response)
+    end
+  end
 
-    response = self.class.post('/send', params.merge(@client_options))
-    build_response(response)
+  def batch_topic_subscription(topic, registration_ids)
+    manage_topics_relationship(topic, registration_ids, "Add")
+  end
+
+  def batch_topic_unsubscription(topic, registration_ids)
+    manage_topics_relationship(topic, registration_ids, "Remove")
+  end
+
+  def manage_topics_relationship(topic, registration_ids, action)
+    body = { to: "/topics/#{topic}", registration_tokens: registration_ids }
+
+    for_uri(INSTANCE_ID_API) do |connection|
+      response = connection.post("/iid/v1:batch#{action}", body.to_json)
+      build_response(response)
+    end
   end
 
   def send_to_topic(topic, options = {})
-    if topic =~ /[a-zA-Z0-9\-_.~%]+/
-      send_with_notification_key('/topics/' + topic, options)
+    if topic.gsub(TOPIC_REGEX, "").length == 0
+      send_with_notification_key("/topics/" + topic, options)
+    end
+  end
+
+  def get_instance_id_info(iid_token, options = {})
+    params = options
+
+    for_uri(INSTANCE_ID_API) do |connection|
+      response = connection.get("/iid/info/" + iid_token, params)
+      build_response(response)
+    end
+  end
+
+  def subscribe_instance_id_to_topic(iid_token, topic_name)
+    batch_subscribe_instance_ids_to_topic([iid_token], topic_name)
+  end
+
+  def unsubscribe_instance_id_from_topic(iid_token, topic_name)
+    batch_unsubscribe_instance_ids_from_topic([iid_token], topic_name)
+  end
+
+  def batch_subscribe_instance_ids_to_topic(instance_ids, topic_name)
+    manage_topics_relationship(topic_name, instance_ids, "Add")
+  end
+
+  def batch_unsubscribe_instance_ids_from_topic(instance_ids, topic_name)
+    manage_topics_relationship(topic_name, instance_ids, "Remove")
+  end
+
+  def send_to_topic_condition(condition, options = {})
+    if validate_condition?(condition)
+      body = { condition: condition }.merge(options)
+      execute_notification(body)
     end
   end
 
   private
 
-  def for_uri(uri)
-    current_uri = self.class.base_uri
-    self.class.base_uri uri
-    yield
-    self.class.base_uri current_uri
+  def for_uri(uri, extra_headers = {})
+    connection = ::Faraday.new(
+      url: uri,
+      request: { timeout: DEFAULT_TIMEOUT }
+    ) do |faraday|
+      faraday.adapter Faraday.default_adapter
+      faraday.headers["Content-Type"] = "application/json"
+      faraday.headers["Authorization"] = "key=#{api_key}"
+      extra_headers.each do |key, value|
+        faraday.headers[key] = value
+      end
+    end
+    yield connection
   end
 
   def build_post_body(registration_ids, options = {})
-    { registration_ids: registration_ids }.merge(options)
+    ids = registration_ids.is_a?(String) ? [registration_ids] : registration_ids
+    { registration_ids: ids }.merge(options)
   end
 
   def build_response(response, registration_ids = [])
     body = response.body || {}
-    response_hash = { body: body, headers: response.headers, status_code: response.code }
-    case response.code
+    response_hash = { body: body, headers: response.headers, status_code: response.status }
+    case response.status
     when 200
-      response_hash[:response] = 'success'
+      response_hash[:response] = "success"
       body = JSON.parse(body) unless body.empty?
       response_hash[:canonical_ids] = build_canonical_ids(body, registration_ids) unless registration_ids.empty?
       response_hash[:not_registered_ids] = build_not_registered_ids(body, registration_ids) unless registration_ids.empty?
     when 400
-      response_hash[:response] = 'Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields.'
+      response_hash[:response] = "Only applies for JSON requests. Indicates that the request could not be parsed as JSON, or it contained invalid fields."
     when 401
-      response_hash[:response] = 'There was an error authenticating the sender account.'
+      response_hash[:response] = "There was an error authenticating the sender account."
     when 503
-      response_hash[:response] = 'Server is temporarily unavailable.'
+      response_hash[:response] = "Server is temporarily unavailable."
     when 500..599
-      response_hash[:response] = 'There was an internal error in the FCM server while trying to process the request.'
+      response_hash[:response] = "There was an internal error in the FCM server while trying to process the request."
     end
     response_hash
   end
@@ -192,9 +265,9 @@ class FCM
   def build_canonical_ids(body, registration_ids)
     canonical_ids = []
     unless body.empty?
-      if body['canonical_ids'] > 0
-        body['results'].each_with_index do |result, index|
-          canonical_ids << { old: registration_ids[index], new: result['registration_id'] } if has_canonical_id?(result)
+      if body["canonical_ids"] > 0
+        body["results"].each_with_index do |result, index|
+          canonical_ids << { old: registration_ids[index], new: result["registration_id"] } if has_canonical_id?(result)
         end
       end
     end
@@ -204,8 +277,8 @@ class FCM
   def build_not_registered_ids(body, registration_id)
     not_registered_ids = []
     unless body.empty?
-      if body['failure'] > 0
-        body['results'].each_with_index do |result, index|
+      if body["failure"] > 0
+        body["results"].each_with_index do |result, index|
           not_registered_ids << registration_id[index] if is_not_registered?(result)
         end
       end
@@ -213,11 +286,53 @@ class FCM
     not_registered_ids
   end
 
+  def execute_notification(body)
+    for_uri(BASE_URI) do |connection|
+      response = connection.post("/fcm/send", body.to_json)
+      build_response(response)
+    end
+  end
+
   def has_canonical_id?(result)
-    !result['registration_id'].nil?
+    !result["registration_id"].nil?
   end
 
   def is_not_registered?(result)
-    result['error'] == 'NotRegistered'
+    result["error"] == "NotRegistered"
+  end
+
+  def validate_condition?(condition)
+    validate_condition_format?(condition) && validate_condition_topics?(condition)
+  end
+
+  def validate_condition_format?(condition)
+    bad_characters = condition.gsub(
+      /(topics|in|\s|\(|\)|(&&)|[!]|(\|\|)|'([a-zA-Z0-9\-_.~%]+)')/,
+      ""
+    )
+    bad_characters.length == 0
+  end
+
+  def validate_condition_topics?(condition)
+    topics = condition.scan(/(?:^|\S|\s)'([^']*?)'(?:$|\S|\s)/).flatten
+    topics.all? { |topic| topic.gsub(TOPIC_REGEX, "").length == 0 }
+  end
+
+  def jwt_token
+    scope = "https://www.googleapis.com/auth/firebase.messaging"
+    @authorizer ||= Google::Auth::ServiceAccountCredentials.make_creds(
+      json_key_io: json_key,
+      scope: scope,
+    )
+    token = @authorizer.fetch_access_token!
+    token["access_token"]
+  end
+
+  def json_key
+    @json_key ||= if @json_key_path.respond_to?(:read)
+                    @json_key_path
+                  else
+                    File.open(@json_key_path)
+                  end
   end
 end