firebase-admin-sdk 0.1.0 → 0.1.1

data/lib/firebase/admin/messaging/multicast_message.rb

@@ -0,0 +1,67 @@
+module Firebase
+  module Admin
+    module Messaging
+      # A multicast message that can be sent via Firebase Cloud Messaging.
+      #
+      # Contains payload information as well as recipient information. In particular, the message must contain exactly
+      # one of token, topic or condition fields.
+      class MulticastMessage
+        # @return [Hash<String, String>, nil]
+        #   A hash of data fields (optional). All keys and values must be strings.
+        attr_accessor :data
+
+        # @return [Notification, nil]
+        #   A {Notification} (optional).
+        attr_accessor :notification
+
+        # @return [AndroidConfig, nil]
+        #   An {AndroidConfig} (optional).
+        attr_accessor :android
+
+        # @return [APNSConfig, nil]
+        #   An {APNSConfig} (optional).
+        attr_accessor :apns
+
+        # @return [FCMOptions, nil]
+        #   An {FCMOptions} (optional).
+        attr_accessor :fcm_options
+
+        # @return [Array<String>, nil]
+        #   Registration token of the device to which the message should be sent (optional).
+        attr_accessor :tokens
+
+        # Initializes a {Message}.
+        #
+        # @param [Hash<String, String>, nil] data
+        #   A hash of data fields (optional). All keys and values must be strings.
+        # @param [Notification, nil] notification
+        #   A {Notification} (optional).
+        # @param [AndroidConfig, nil] android
+        #   An {AndroidConfig} (optional).
+        # @param [APNSConfig, nil] apns
+        #   An {APNSConfig} (optional).
+        # @param [FCMOptions, nil] fcm_options
+        #   An {FCMOptions} (optional).
+        # @param [Array<String>, nil] tokens
+        #   A registration token of the device to send the message to (optional).
+        def initialize(
+          data: nil,
+          notification: nil,
+          android: nil,
+          apns: nil,
+          fcm_options: nil,
+          tokens: nil
+        )
+          self.data = data
+          self.notification = notification
+          self.android = android
+          self.apns = apns
+          self.fcm_options = fcm_options
+          self.tokens = tokens
+          self.topic = topic
+          self.condition = condition
+        end
+      end
+    end
+  end
+end

data/lib/firebase/admin/messaging/notification.rb

@@ -0,0 +1,34 @@
+module Firebase
+  module Admin
+    module Messaging
+      # A notification that can be included in a message.
+      class Notification
+        # @return [String, nil]
+        #   Title of the notification.
+        attr_accessor :title
+
+        # @return [String, nil]
+        #   Body of the notification.
+        attr_accessor :body
+
+        # @return [String, nil]
+        #   Image url of the notification.
+        attr_accessor :image
+
+        # Initializes a {Notification}.
+        #
+        # @param [String, nil] title
+        #   Title of the notification (optional).
+        # @param [String, nil] body
+        #   Body of the notification (optional).
+        # @param [String, nil]
+        #   Image url of the notification (optional).
+        def initialize(title: nil, body: nil, image: nil)
+          self.title = title
+          self.body = body
+          self.image = image
+        end
+      end
+    end
+  end
+end

data/lib/firebase/admin/messaging/topic_management_response.rb

@@ -0,0 +1,41 @@
+module Firebase
+  module Admin
+    module Messaging
+      # A response received from a topic management operation.
+      class TopicManagementResponse
+        # @return [Integer] The number of tokens successfully subscribed or unsubscribed.
+        attr_reader :success_count
+
+        # @return [Integer] The number of tokens that could not be subscribed or unsubscribed due to errors.
+        attr_reader :failure_count
+
+        # @return [Array<ErrorInfo>] An array of {ErrorInfo} objects (possibly empty).
+        attr_reader :errors
+
+        # Initializes a {TopicManagementResponse}.
+        #
+        # @param [Faraday::Response] response
+        #   The response received from the api.
+        def initialize(response)
+          unless response.body.is_a?(Hash) && response.body["results"].is_a?(Array)
+            raise Error.new("Unexpected topic management response", response)
+          end
+
+          @success_count = 0
+          @failure_count = 0
+          @errors = []
+
+          results = response.body["results"]
+          results.each_with_index do |result, i|
+            if (reason = result["error"])
+              @failure_count += 1
+              @errors << ErrorInfo.new(index: i, reason: reason)
+            else
+              @success_count += 1
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/firebase/admin/messaging/utils.rb

@@ -0,0 +1,78 @@
+module Firebase
+  module Admin
+    module Messaging
+      module Utils
+        def check_string(label, value, non_empty: false)
+          return nil unless value
+          raise ArgumentError, "#{label} must be a string." unless value.is_a?(String) || non_empty
+          raise ArgumentError, "#{label} must be a non-empty string." unless value.is_a?(String) || !non_empty
+          raise ArgumentError, "#{label} must be a non-empty string." if value.empty? && non_empty
+          value
+        end
+
+        def check_numeric(label, value)
+          return nil unless value
+          raise ArgumentError, "#{label} must be a number." unless value.is_a?(Numeric)
+          value
+        end
+
+        def check_string_hash(label, value)
+          return nil if value.nil?
+          raise ArgumentError, "#{label} must be a hash." unless value.is_a?(Hash)
+          return nil if value.empty?
+          raise ArgumentError, "#{label} must not contain non-string values" unless value.values.all?(String)
+          unless value.keys.all? { |k| k.is_a?(String) || k.is_a?(Symbol) }
+            raise ArgumentError, "#{label} must not contain non-string or non-symbol values"
+          end
+          value
+        end
+
+        def check_string_array(label, value)
+          return nil if value.nil?
+          raise ArgumentError, "#{label} must be an array of strings." unless value.is_a?(Array)
+          return nil if value.empty?
+          raise ArgumentError, "#{label} must not contain non-string values" unless value.all?(String)
+          value
+        end
+
+        def check_numeric_array(label, value)
+          return nil if value.nil?
+          raise ArgumentError, "#{label} must be an array of numbers." unless value.is_a?(Array)
+          return nil if value.empty?
+          raise ArgumentError, "#{label} must not contain non-numeric values" unless value.all?(Numeric)
+          value
+        end
+
+        def check_analytics_label(label, value)
+          return nil unless value
+          value = check_string(label, value)
+          raise ArgumentError, "#{label} is malformed" unless /\A[a-zA-Z0-9\-_.~%]{1,50}\Z/.match?(value)
+          value
+        end
+
+        def check_time(label, value)
+          return nil unless value
+          raise ArgumentError, "#{label} must be a time." unless value.is_a?(Time)
+          value
+        end
+
+        # @return [String, nil]
+        def check_color(label, value, allow_alpha: false, required: false)
+          return nil unless value || required
+          raise ArgumentError, "#{label} is required" unless value
+          raise ArgumentError, "#{label} must be a string" unless value.is_a?(String)
+          unless /\A#[0-9a-fA-F]{6}\Z/.match?(value) || (/\A#[0-9a-fA-F]{8}\Z/.match?(value) && allow_alpha)
+            raise ArgumentError, "#{label} must be in the form #RRGGBB" unless allow_alpha
+            raise ArgumentError, "#{label} must be in the form #RRGGBB or #RRGGBBAA"
+          end
+          value
+        end
+
+        def to_seconds_string(seconds)
+          has_nanos = (seconds - seconds.floor) > 0
+          format(has_nanos ? "%0.9fs" : "%ds", seconds)
+        end
+      end
+    end
+  end
+end

data/lib/firebase/admin/version.rb

@@ -2,6 +2,6 @@
 
 module Firebase
   module Admin
-    VERSION = "0.1.0"
+    VERSION = "0.1.1"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: firebase-admin-sdk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tariq Zaid
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-03 00:00:00.000000000 Z
+date: 2021-07-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: googleauth
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: jwt
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +217,26 @@ files:
 - lib/firebase/admin/error.rb
 - lib/firebase/admin/gce.rb
 - lib/firebase/admin/internal/http_client.rb
+- lib/firebase/admin/messaging/android_config.rb
+- lib/firebase/admin/messaging/android_fcm_options.rb
+- lib/firebase/admin/messaging/android_notification.rb
+- lib/firebase/admin/messaging/apns_config.rb
+- lib/firebase/admin/messaging/apns_fcm_options.rb
+- lib/firebase/admin/messaging/apns_payload.rb
+- lib/firebase/admin/messaging/aps.rb
+- lib/firebase/admin/messaging/aps_alert.rb
+- lib/firebase/admin/messaging/client.rb
+- lib/firebase/admin/messaging/critical_sound.rb
+- lib/firebase/admin/messaging/error.rb
+- lib/firebase/admin/messaging/error_info.rb
+- lib/firebase/admin/messaging/fcm_options.rb
+- lib/firebase/admin/messaging/light_settings.rb
+- lib/firebase/admin/messaging/message.rb
+- lib/firebase/admin/messaging/message_encoder.rb
+- lib/firebase/admin/messaging/multicast_message.rb
+- lib/firebase/admin/messaging/notification.rb
+- lib/firebase/admin/messaging/topic_management_response.rb
+- lib/firebase/admin/messaging/utils.rb
 - lib/firebase/admin/version.rb
 homepage: https://github.com/cheddar-me/firebase-admin-sdk-ruby
 licenses: