firebase-admin-sdk 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 943bc48f322900cf959c1a0ec6342f3fbfb8f40af3ef971bf19e63d65b5a0fd4
-  data.tar.gz: fbf64b91cc0a3d98425db69fddf5382086df4652fded37178e87c312ec8d2669
+  metadata.gz: 123d6d32ec877dc2478f43d37762c2fad6dee697d21bc746dbd63d16c7688ab0
+  data.tar.gz: 9a4decd758386fb6c87ad73607d949842f7a7f2e659b6d6fe659f62d0bdd0d40
 SHA512:
-  metadata.gz: 05d47f8bdc6b33ba5d3902e42ddc54f4438c3c13f3b5d048237244e3f71ad1006f86798804cb5ad8e5c8e24a5a10996c2033dddea118972ecf6556209e646fbd
-  data.tar.gz: 067d29dc598a88f7825c1b00487bdcb0969c5153962505a935458c9c8c27ff972a8684b99eb7b960b250777335fc31d6a6d4586c26f523f6b50899540401a774
+  metadata.gz: c806d219be3867c552aff868f296854ac0a348fa9d9c04063c874e201810dda370a63b7fb425d38fe2bbfe8af13043bcef8cef632a2f888eca547bfa48815dbc
+  data.tar.gz: 7c187c93c943c8dbc352cf153f82d45fb27b1cd1febde4773c7e5cc3cdbb5492848c051afd96f139c2af4e7b6fad3bce11cd86e5fa280155d8d434286d36d841

data/README.md

@@ -1,12 +1,8 @@
-# Firebase Admin Ruby SDK
+# Firebase::Admin::Sdk
 
-The Firebase Admin Ruby SDK enables access to Firebase services from privileged environments (such as servers or cloud)
-in Ruby.
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/firebase/admin/sdk`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-For more information, visit the
-[Firebase Admin SDK setup guide](https://firebase.google.com/docs/admin/setup/).
-
-This gem is currently in alpha and not recommended for production use (yet).
+TODO: Delete this and the text above, and describe your gem
 
 ## Installation
 
@@ -26,27 +22,22 @@ Or install it yourself as:
 
 ## Usage
 
-### Application Default Credentials
+TODO: Write usage instructions here
 
-```ruby
-gem 'firebase-admin-sdk'
+## Development
 
-app = Firebase::Admin::App.new
-```
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
-### Using a service account
-
-```ruby
-gem 'firebase-admin-sdk'
-
-creds = Firebase::Admin::Credentials.from_file('service_account.json')
-app = Firebase::Admin::App.new(credentials: creds)
-```
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/cheddar-me/firebase-admin-sdk.
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/firebase-admin-sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/firebase-admin-sdk/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Firebase::Admin::Sdk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/firebase-admin-sdk/blob/master/CODE_OF_CONDUCT.md).

data/firebase-admin-sdk.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "googleauth", "~> 0.16.2"
   spec.add_runtime_dependency "faraday", "< 2"
   spec.add_runtime_dependency "faraday_middleware", "~> 1.0"
+  spec.add_runtime_dependency "hashie", "~> 4.1"
   spec.add_runtime_dependency "jwt", ">= 1.5", "< 3.0"
 
   spec.add_development_dependency "rake", "~> 13.0"

data/lib/firebase-admin-sdk.rb

@@ -5,6 +5,7 @@ require_relative "firebase/admin/error"
 require_relative "firebase/admin/config"
 require_relative "firebase/admin/gce"
 require_relative "firebase/admin/credentials"
+require_relative "firebase/admin/app"
 require_relative "firebase/admin/internal/http_client"
 require_relative "firebase/admin/auth/error"
 require_relative "firebase/admin/auth/utils"
@@ -14,4 +15,23 @@ require_relative "firebase/admin/auth/user_info"
 require_relative "firebase/admin/auth/user_record"
 require_relative "firebase/admin/auth/user_manager"
 require_relative "firebase/admin/auth/client"
-require_relative "firebase/admin/app"
+require_relative "firebase/admin/messaging/error"
+require_relative "firebase/admin/messaging/android_config"
+require_relative "firebase/admin/messaging/android_fcm_options"
+require_relative "firebase/admin/messaging/android_notification"
+require_relative "firebase/admin/messaging/apns_config"
+require_relative "firebase/admin/messaging/apns_fcm_options"
+require_relative "firebase/admin/messaging/apns_payload"
+require_relative "firebase/admin/messaging/aps"
+require_relative "firebase/admin/messaging/aps_alert"
+require_relative "firebase/admin/messaging/critical_sound"
+require_relative "firebase/admin/messaging/fcm_options"
+require_relative "firebase/admin/messaging/light_settings"
+require_relative "firebase/admin/messaging/notification"
+require_relative "firebase/admin/messaging/message"
+require_relative "firebase/admin/messaging/utils"
+require_relative "firebase/admin/messaging/message_encoder"
+require_relative "firebase/admin/messaging/multicast_message"
+require_relative "firebase/admin/messaging/error_info"
+require_relative "firebase/admin/messaging/topic_management_response"
+require_relative "firebase/admin/messaging/client"

data/lib/firebase/admin/app.rb

@@ -23,12 +23,6 @@ module Firebase
         @service_account_id = @config.service_account_id
         @project_id = @config.project_id || @credentials.project_id
       end
-
-      # Gets the auth client for this App.
-      # @return [Firebase::Admin::Auth::Client]
-      def auth
-        @auth_client ||= Auth::Client.new(self)
-      end
     end
   end
 end

data/lib/firebase/admin/auth/client.rb

@@ -112,5 +112,13 @@ module Firebase
         end
       end
     end
+
+    class App
+      # Gets the auth client for this App.
+      # @return [Firebase::Admin::Auth::Client]
+      def auth
+        @auth_client ||= Auth::Client.new(self)
+      end
+    end
   end
 end

data/lib/firebase/admin/auth/token_verifier.rb

@@ -78,7 +78,7 @@ module Firebase
         def decode_unsigned(token)
           raise InvalidTokenError, "token must not be nil" unless token
           raise InvalidTokenError, "token must be a string" unless token.is_a?(String)
-          raise InvalidTokenError, "The auth emulator only accepts unsigned ID tokens." if token.split(".").length == 3
+          raise InvalidTokenError, "The auth emulator only accepts unsigned ID tokens." unless token.split(".").length == 2
           options = decode_options.merge({algorithm: "none"})
           JWT.decode(token, nil, false, options)
         end

data/lib/firebase/admin/auth/user_info.rb

@@ -17,27 +17,27 @@ module Firebase
 
         # Gets the ID of this user.
         def uid
-          @data["rawId"]
+          @data.fetch(:rawId)
         end
 
         # Gets the display name of this user.
         def display_name
-          @data["displayName"]
+          @data.fetch(:displayName)
         end
 
         # Gets the email address associated with this user.
         def email
-          @data["email"]
+          @data.fetch(:email)
         end
 
         # Gets the phone number associated with this user.
         def phone_number
-          @data["phoneNumber"]
+          @data.fetch(:phoneNumber)
         end
 
         # Gets the photo url of this user.
         def photo_url
-          @data["photoUrl"]
+          @data.fetch(:photoUrl)
         end
 
         # Gets the id of the identity provider.
@@ -45,7 +45,7 @@ module Firebase
         # This can be a short domain name (e.g. google.com), or the identity of an OpenID
         # identity provider.
         def provider_id
-          @data["providerId"]
+          @data.fetch(:providerId)
         end
 
         # Converts the object into a hash.

data/lib/firebase/admin/auth/user_manager.rb

@@ -43,7 +43,7 @@ module Firebase
             disabled: to_boolean(disabled)
           }.compact
           res = @client.post(with_path("accounts"), payload).body
-          uid = res&.fetch("localId")
+          uid = res&.fetch(:localId)
           raise CreateUserError, "failed to create user #{res}" if uid.nil?
           get_user_by(uid: uid)
         end
@@ -67,7 +67,7 @@ module Firebase
             raise ArgumentError, "Unsupported query: #{query}"
           end
           res = @client.post(with_path("accounts:lookup"), payload).body
-          users = res["users"] if res
+          users = res[:users] if res
           UserRecord.new(users[0]) if users.is_a?(Array) && users.length > 0
         end
 

data/lib/firebase/admin/auth/user_record.rb

@@ -7,7 +7,7 @@ module Firebase
       class UserRecord < UserInfo
         # Gets the ID of this user.
         def uid
-          @data["localId"]
+          @data.fetch(:localId)
         end
 
         # Gets the id of the identity provider.
@@ -18,11 +18,11 @@ module Firebase
         end
 
         def email_verified?
-          !!@data["emailVerified"]
+          !!@data.fetch(:emailVerified)
         end
 
         def disabled?
-          !!@data["disabled"]
+          !!@data.fetch(:disabled)
         end
 
         # Gets the time, in milliseconds since the epoch, before which tokens are invalid.
@@ -49,13 +49,13 @@ module Firebase
         #
         # @return [Array of UserInfo]
         def provider_data
-          providers = @data["providerUserInfo"] || []
+          providers = @data.fetch(:providerUserInfo) || []
           providers.to_a.map { |p| UserInfo.new(p) }
         end
 
         # Gets any custom claims set on this user account.
         def custom_claims
-          claims = @data["customAttributes"]
+          claims = @data.fetch(:customAttributes)
           parsed = JSON.parse(claims) unless claims.nil?
           parsed if parsed.is_a?(Hash) && !parsed.empty?
         end

data/lib/firebase/admin/config.rb

@@ -42,8 +42,10 @@ module Firebase
         # @return [Firebase::Admin::Config]
         def from_json(json)
           data = JSON.parse(json)
-          new(project_id: data["projectId"],
-              service_account_id: data["serviceAccountId"])
+          new(
+            project_id: data["projectId"],
+            service_account_id: data["serviceAccountId"]
+          )
         end
       end
 

data/lib/firebase/admin/internal/http_client.rb

@@ -58,6 +58,7 @@ module Firebase
             c.use CredentialsMiddleware, credentials: @credentials unless @credentials.nil?
             c.use Faraday::Request::UrlEncoded
             c.use FaradayMiddleware::EncodeJson
+            c.use FaradayMiddleware::Mashify
             c.use Faraday::Response::ParseJson
             c.use Faraday::Response::RaiseError
             c.adapter(Faraday.default_adapter)

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

@@ -0,0 +1,77 @@
+module Firebase
+  module Admin
+    module Messaging
+      # Android-specific options that can be included in a {Message}.
+      class AndroidConfig
+        # @return [String, nil]
+        #   Collapse key string for the message.
+        #   This is an identifier for a group of messages that can be collapsed, so that only the last message is sent
+        #   when delivery can be resumed. A maximum of 4 different collapse keys may be active at a given time.
+        attr_accessor :collapse_key
+
+        # @return [String, nil]
+        #   Priority of the message. Must be either `high` or `normal`.
+        attr_accessor :priority
+
+        # @return [Numeric, nil]
+        #   Time-to-live duration of the message in seconds.
+        attr_accessor :ttl
+
+        # @return [String, nil]
+        #   Package name of the application where the registration tokens must match in order to receive the message.
+        attr_accessor :restricted_package_name
+
+        # @return [Hash{String,Symbol => String}, nil]
+        #   A hash of data fields to be included in the message. All keys and values must be strings.
+        #   When provided, overrides any data fields set on the top-level message.
+        attr_accessor :data
+
+        # @return [AndroidNotification, nil]
+        #   Android notification to be included in the message.
+        attr_accessor :notification
+
+        # @return [AndroidFCMOptions, nil]
+        #   Options for features provided by the FCM SDK for Android.
+        attr_accessor :fcm_options
+
+        # Initializes an {AndroidConfig}.
+        #
+        # @param [String, nil] collapse_key
+        #   Collapse key string for the message (optional).
+        # @param [String, nil] priority
+        #   Priority of the message (optional).
+        #   Must be either `high` or `normal`.
+        # @param [Numeric, nil] ttl
+        #   The time-to-live duration of the message (optional).
+        #   Time-to-live duration of the message in seconds.
+        # @param [String, nil] restricted_package_name
+        #   The package name of the application where the registration tokens must match in order to receive
+        #   the message (optional).
+        # @param [Hash{String,Symbol => String}, nil] data
+        #   A hash of data fields to be included in the message (optional).
+        #   All keys and values must be strings.
+        # @param [AndroidNotification, nil] notification
+        #   An {AndroidNotification} to be included in the message (optional).
+        # @param [AndroidFCMOptions, nil] fcm_options
+        #   An {AndroidFCMOptions} to be included in the message (optional).
+        def initialize(
+          collapse_key: nil,
+          priority: nil,
+          ttl: nil,
+          restricted_package_name: nil,
+          data: nil,
+          notification: nil,
+          fcm_options: nil
+        )
+          self.collapse_key = collapse_key
+          self.priority = priority
+          self.ttl = ttl
+          self.restricted_package_name = restricted_package_name
+          self.data = data
+          self.notification = notification
+          self.fcm_options = fcm_options
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Firebase
+  module Admin
+    module Messaging
+      # Represents options for features provided by the FCM SDK for Android.
+      class AndroidFCMOptions
+        # @return [String, nil] Label associated with the message's analytics data.
+        attr_accessor :analytics_label
+
+        # Initializes an {AndroidFCMOptions}.
+        #
+        # @param [String, nil] analytics_label
+        #   The label associated with the message's analytics data (optional).
+        def initialize(analytics_label: nil)
+          self.analytics_label = analytics_label
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,221 @@
+module Firebase
+  module Admin
+    module Messaging
+      # Android-specific notification options that can be included in an {AndroidConfig}.
+      class AndroidNotification
+        # @return [String, nil]
+        #   Title of the Android notification. When provided, overrides the title set via {Notification}.
+        attr_accessor :title
+
+        # @return [String, nil]
+        #   Body of the Android notification. When provided, overrides the body set via {Notification}.
+        attr_accessor :body
+
+        # @return [String, nil]
+        #   Icon resource for the Android notification.
+        attr_accessor :icon
+
+        # @return [String, nil]
+        #   Notification icon color in `#rrggbb` format.
+        attr_accessor :color
+
+        # @return [String, nil]
+        #   File name of the sound to be played when the device receives the notification.
+        attr_accessor :sound
+
+        # @return [String, nil]
+        #   Notification tag. This is an identifier used to replace existing notifications in the notification drawer.
+        #   If not specified, each request creates a new notification.
+        attr_accessor :tag
+
+        # @return [String, nil]
+        #   URL of an image to be displayed in the notification.
+        attr_accessor :image
+
+        # @return [String, nil]
+        #   Action associated with a user click on the notification. If specified, an activity with a matching
+        #   Intent Filter is launched when a user clicks on the notification.
+        attr_accessor :click_action
+
+        # @return [String, nil]
+        #   Key of the body string in the app's string resource to use to localize the body text.
+        attr_accessor :body_loc_key
+
+        # @return [Array<String>, nil]
+        #   An array of resource keys that will be used in place of the format specifiers in {body_loc_key}.
+        attr_accessor :body_loc_args
+
+        # @return [String, nil]
+        #   Key of the title string in the app's string resource to use to localize the title text.
+        attr_accessor :title_loc_key
+
+        # @return [Array<String>, nil]
+        #   An array of resource keys that will be used in place of the format specifiers in {title_loc_key}.
+        attr_accessor :title_loc_args
+
+        # @return [String, nil]
+        #   The Android notification channel id (new in Android O). The app must create a channel with this channel id
+        #   before any notification with this channel id can be received. If you don't send this channel id in the
+        #   request, or if the channel id provided has not yet been created by the app, FCM uses the channel id
+        #   specified in the app manifest.
+        attr_accessor :channel_id
+
+        # @return [String, nil]
+        #   Sets the "ticker" text, which is sent to accessibility services. Prior to API level 21 (Lollipop), sets the
+        #   text that is displayed in the status bar when the notification first arrives.
+        attr_accessor :ticker
+
+        # @return [Boolean, nil]
+        #   When set to `false` or unset, the notification is automatically dismissed when the user clicks it in the
+        #   panel. When set to `true`, the notification persists even when the user clicks it.
+        attr_accessor :sticky
+
+        # @return [Time, nil]
+        #   For notifications that inform users about events with an absolute time reference, sets the time that the
+        #   event in the notification occurred. Notifications in the panel are sorted by this time.
+        attr_accessor :event_time
+
+        # @return [Boolean, nil]
+        #   Sets whether or not this notification is relevant only to the current device. Some notifications can be
+        #   bridged to other devices for remote display, such as a Wear OS watch. This hint can be set to recommend
+        #   this notification not be bridged.
+        attr_accessor :local_only
+
+        # @return [String, nil]
+        #   Sets the relative priority for this notification. Low-priority notifications may be hidden from the user in
+        #   certain situations. Note this priority differs from `AndroidMessagePriority`. This priority is processed by
+        #   the client after the message has been delivered. Whereas `AndroidMessagePriority` is an FCM concept that
+        #   controls when the message is delivered.
+        attr_accessor :priority
+
+        # @return [Array<Numeric>, nil]
+        #   Sets the vibration pattern to use. Pass in an array of numeric durations to turn the vibrator on or off. The
+        #   first value indicates the duration to wait before turning the vibrator on. The next value indicates the
+        #   duration to keep the vibrator on. Subsequent values alternate between duration to turn the vibrator off and
+        #   to turn the vibrator on. If `vibrate_timings` is set and `default_vibrate_timings` is set to `true`, the
+        #   default value is used instead of the user-specified `vibrate_timings`.
+        attr_accessor :vibrate_timings
+
+        # @return [Boolean, nil]
+        #   If set to `true`, use the Android framework's default vibrate pattern for the notification. Default values
+        #   are specified in `config.xml`. If `default_vibrate_timings` is set to `true` and `vibrate_timings` is also
+        #   set, the default value is used instead of the user-specified `vibrate_timings`.
+        # @see https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml
+        attr_accessor :default_vibrate_timings
+
+        # @return [Boolean, nil]
+        #   If set to `true`, use the Android framework's default sound for the notification. Default values are
+        #   specified in `config.xml`.
+        # @see https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml
+        attr_accessor :default_sound
+
+        # @return [LightSettings, nil]
+        #   Settings to control the notification's LED blinking rate and color if LED is available on the device.
+        #   The total blinking time is controlled by the OS.
+        attr_accessor :light_settings
+
+        # @return [Boolean, nil]
+        #   If set to `true`, use the Android framework's default LED light settings for the notification. Default
+        #   values are specified in `config.xml`. If `default_light_settings` is set to `true` and `light_settings` is
+        #   also set, the user-specified `light_settings` is used instead of the default value.
+        # @see https://android.googlesource.com/platform/frameworks/base/+/master/core/res/res/values/config.xml
+        attr_accessor :default_light_settings
+
+        # @return [String, nil]
+        #   Sets the visibility of the notification. Must be either `private`, `public`, or `secret`. If unspecified,
+        #   defaults to `private`.
+        attr_accessor :visibility
+
+        # @return [Integer, nil]
+        #   Sets the number of items this notification represents. May be displayed as a badge count for Launchers that
+        #   support badging. For example, this might be useful if you're using just one notification to represent
+        #   multiple new messages but you want the count here to represent the number of total new messages. If zero
+        #   or unspecified, systems that support badging use the default, which is to increment a number displayed on
+        #   the long-press menu each time a new notification arrives.
+        # @see https://developer.android.com/training/notify-user/badges
+        attr_accessor :notification_count
+
+        # Initializes an AndroidNotification
+        #
+        # @param [String, nil] title
+        # @param [String, nil] body
+        # @param [String, nil] icon
+        # @param [String, nil] color
+        # @param [String, nil] sound
+        # @param [String, nil] tag
+        # @param [String, nil] image
+        # @param [String, nil] click_action
+        # @param [String, nil] body_loc_key
+        # @param [Array<String>, nil] body_loc_args
+        # @param [String, nil] title_loc_key
+        # @param [Array<String>, nil] title_loc_args
+        # @param [String, nil] channel_id
+        # @param [String, nil] ticker
+        # @param [Boolean, nil] sticky
+        # @param [Time, nil] event_time
+        # @param [Boolean, nil] local_only
+        # @param [String, nil] priority
+        # @param [Array<Numeric>, nil] vibrate_timings
+        # @param [Boolean, nil] default_vibrate_timings
+        # @param [Boolean, nil] default_sound
+        # @param [LightSettings, nil] light_settings
+        # @param [Boolean, nil] default_light_settings
+        # @param [String, nil] visibility
+        # @param [Integer, nil] notification_count
+        def initialize(
+          title: nil,
+          body: nil,
+          icon: nil,
+          color: nil,
+          sound: nil,
+          tag: nil,
+          image: nil,
+          click_action: nil,
+          body_loc_key: nil,
+          body_loc_args: nil,
+          title_loc_key: nil,
+          title_loc_args: nil,
+          channel_id: nil,
+          ticker: nil,
+          sticky: nil,
+          event_time: nil,
+          local_only: nil,
+          priority: nil,
+          vibrate_timings: nil,
+          default_vibrate_timings: nil,
+          default_sound: nil,
+          light_settings: nil,
+          default_light_settings: nil,
+          visibility: nil,
+          notification_count: nil
+        )
+          self.title = title
+          self.body = body
+          self.icon = icon
+          self.color = color
+          self.sound = sound
+          self.tag = tag
+          self.image = image
+          self.click_action = click_action
+          self.body_loc_key = body_loc_key
+          self.body_loc_args = body_loc_args
+          self.title_loc_key = title_loc_key
+          self.title_loc_args = title_loc_args
+          self.channel_id = channel_id
+          self.ticker = ticker
+          self.sticky = sticky
+          self.event_time = event_time
+          self.local_only = local_only
+          self.priority = priority
+          self.vibrate_timings = vibrate_timings
+          self.default_vibrate_timings = default_vibrate_timings
+          self.default_sound = default_sound
+          self.light_settings = light_settings
+          self.default_light_settings = default_light_settings
+          self.visibility = visibility
+          self.notification_count = notification_count
+        end
+      end
+    end
+  end
+end