modulofcm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 756a3db83bff049923812f16b3c306b65acccd9878d8e23888d4fc6972d6b860
+  data.tar.gz: 90274c6c4c7bda319d1e7c804f1fbfd14083501c6712724587ac68b4a1ec83b7
+SHA512:
+  metadata.gz: 62460e72622514d6607bace864a8f9befe393b3b892366cee5797e075a49d37679917f6a3762a3be9f9c7033b16a7fb9930868cff1ec956621b2892674028d48
+  data.tar.gz: 3115a67425c392403e781d828390fee9ced2ec5b11a0b2edb48f49cc6fa7a2447767cee1e08e83557663631d4c6a4832b0d4d0dd7fbe5b49e78217b05381270f

data/.rubocop.yml

@@ -0,0 +1,252 @@
+# The behavior of RuboCop can be controlled via the .rubocop.yml
+# configuration file. It makes it possible to enable/disable
+# certain cops (checks) and to alter their behavior if they accept
+# any parameters. The file can be placed either in your home
+# directory or in some project directory.
+#
+# RuboCop will start looking for the configuration file in the directory
+# where the inspected file is and continue its way up to the root directory.
+#
+# See https://docs.rubocop.org/rubocop/configuration
+
+inherit_mode:
+  merge:
+    - Exclude
+    - Include
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+  # No suggestions since the gem is the sole truth for rubocop configuration.
+  SuggestExtensions: false
+
+  # Enable new cops by default
+  NewCops: enable
+
+  # Excluding most directories with generated files and directories with configuration files.
+  Exclude:
+    - 'bin'
+    - '**/Gemfile'
+    - '**/Guardfile'
+    - '**/Rakefile'
+    - 'test/**/*'
+    - 'node_modules/**/*'
+    - 'spec/**/*'
+
+# Checks if String literals are using single quotes when no interpolation is required
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+  ConsistentQuotesInMultiline: false
+
+# Checks if the quotes used for quoted symbols are single quotes when no interpolation is required
+Style/QuotedSymbols:
+  Enabled: true
+  EnforcedStyle: same_as_string_literals
+
+# This cop checks for uses of literal strings converted to a symbol where a literal symbol could be used instead.
+Lint/SymbolConversion:
+  Enabled: true
+  EnforcedStyle: strict
+
+# Useless cop. It checks for unnecessary safe navigations.
+# Example:
+# obj&.a && obj.b
+# Triggers rubocop error: it requires to add safe navigation for "obj.b" call => "obj&.b".
+# but it is not necessary. obj&.a will return nil if obj is nil, and it will stop
+# execution of the operation because `&&` right part executes only when left part is truthy.
+Lint/SafeNavigationConsistency:
+  Enabled: false
+
+# Checks for places where keyword arguments can be used instead of boolean arguments when defining methods.
+# Disabled because moving from default arguments to keywords is not that easy.
+Style/OptionalBooleanParameter:
+  Enabled: false
+
+# Checks for use of the lambda.(args) syntax.
+# Disabled while the Ruby team has not voted on this.
+Style/LambdaCall:
+  Enabled: false
+  EnforcedStyle: braces
+
+# Checks for presence or absence of braces around hash literal as a last array item depending on configuration.
+# Disabled because it would break a lot of permitted_params definitions
+Style/HashAsLastArrayItem:
+  Enabled: false
+
+# Checks for grouping of accessors in class and module bodies.
+# Useless.
+Style/AccessorGrouping:
+  Enabled: false
+
+# Makes our lives happier: we don't need to disable it in each case/when method
+# with more than 5 "when"s.
+Metrics/CyclomaticComplexity:
+  Max: 10
+
+# Commonly used screens these days easily fit more than 80 characters.
+Layout/LineLength:
+  Max: 120
+
+# Too short methods lead to extraction of single-use methods, which can make
+# the code easier to read (by naming things), but can also clutter the class
+Metrics/MethodLength:
+  Max: 25
+
+# The guiding principle of classes is SRP, SRP can't be accurately measured by LoC
+Metrics/ClassLength:
+  Max: 1500
+
+# No space makes the method definition shorter and differentiates
+# from a regular assignment.
+Layout/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: no_space
+
+# We do not need to support Ruby 1.9, so this is good to use.
+Style/SymbolArray:
+  Enabled: true
+
+# Most readable form.
+Layout/HashAlignment:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table
+
+# Mixing the styles looks just silly.
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+# has_key? and has_value? are far more readable than key? and value?
+Style/PreferredHashMethods:
+  Enabled: false
+
+# String#% is by far the least verbose and only object oriented variant.
+Style/FormatString:
+  EnforcedStyle: percent
+
+# Annotated or template are too verbose and rarely needed.
+Style/FormatStringToken:
+  EnforcedStyle: unannotated
+
+Style/CollectionMethods:
+  Enabled: true
+  PreferredMethods:
+    # inject seems more common in the community.
+    reduce: "inject"
+
+# Either allow this style or don't. Marking it as safe with parenthesis
+# is silly. Let's try to live without them for now.
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+# A specialized exception class will take one or more arguments and construct the message from it.
+# So both variants make sense.
+Style/RaiseArgs:
+  Enabled: false
+
+# Indenting the chained dots beneath each other is not supported by this cop,
+# see https://github.com/bbatsov/rubocop/issues/1633
+Layout/MultilineOperationIndentation:
+  Enabled: false
+
+# Fail is an alias of raise. Avoid aliases, it's more cognitive load for no gain.
+# The argument that fail should be used to abort the program is wrong too,
+# there's Kernel#abort for that.
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+# Suppressing exceptions can be perfectly fine, and be it to avoid to
+# explicitly type nil into the rescue since that's what you want to return,
+# or suppressing LoadError for optional dependencies
+Lint/SuppressedException:
+  Enabled: false
+
+# { ... } for multi-line blocks is okay, follow Weirichs rule instead:
+# https://web.archive.org/web/20140221124509/http://onestepback.org/index.cgi/Tech/Ruby/BraceVsDoEnd.rdoc
+Style/BlockDelimiters:
+  Enabled: false
+
+# do / end blocks should be used for side effects,
+# methods that run a block for side effects and have
+# a useful return value are rare, assign the return
+# value to a local variable for those cases.
+Style/MethodCalledOnDoEndBlock:
+  Enabled: true
+
+# Enforcing the names of variables? To single letter ones? Just no.
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# Shadowing outer local variables with block parameters is often useful
+# to not reinvent a new name for the same thing, it highlights the relation
+# between the outer variable and the parameter. The cases where it's actually
+# confusing are rare, and usually bad for other reasons already, for example
+# because the method is too long.
+Lint/ShadowingOuterLocalVariable:
+  Enabled: false
+
+# Check with yard instead.
+Style/Documentation:
+  Enabled: false
+
+# This is just silly. Calling the argument `other` in all cases makes no sense.
+Naming/BinaryOperatorParameterName:
+  Enabled: false
+
+# Disable frozen string
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+# Disable No ASCII char in comments
+Style/AsciiComments:
+  Enabled: false
+
+# Disable ordered Gems By ascii
+Bundler/OrderedGems:
+  Enabled: false
+
+# Change ABC max value
+Metrics/AbcSize:
+  Max: 35
+
+# Disable empty method in one line
+Style/EmptyMethod:
+  EnforcedStyle: expanded
+
+# Disable max height block
+Metrics/BlockLength:
+  Enabled: true
+  Exclude:
+    - 'app/admin/**/*'
+    - 'lib/tasks/**/*'
+
+# Checks if empty lines around the bodies of classes match the configuration.
+Layout/EmptyLinesAroundClassBody:
+  EnforcedStyle: empty_lines
+# Checks if empty lines around the bodies of modules match the configuration.
+Layout/EmptyLinesAroundModuleBody:
+  EnforcedStyle: empty_lines
+
+# Enforces the consistent usage of %-literal delimiters.
+Style/PercentLiteralDelimiters:
+  PreferredDelimiters:
+    default: '()'
+    '%i': '[]'
+    '%I': '[]'
+    '%r': '{}'
+    '%w': '[]'
+    '%W': '[]'
+
+# Unnecessary cop. In what universe "A || B && C" or "A && B || C && D" is ambiguous? looks
+# like a cop for those who can't in boolean.
+Lint/AmbiguousOperatorPrecedence:
+  Enabled: false
+
+# Checks for simple usages of parallel assignment.
+Style/ParallelAssignment:
+  Enabled: false
+
+# Checks the style of children definitions at classes and modules.
+Style/ClassAndModuleChildren:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-04-24
+
+- Initial release
+- Send Legacy push notifications.

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at rails@modulotech.fr. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Modulotech
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# Modulofcm
+
+Firebase Cloud Messaging client library
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add modulofcm
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install modulofcm
+
+## Usage
+
+```ruby
+Modulofcm.configure do |config|
+  config.client(:legacy_client) do |client|
+    client.api_key = 'My Legacy HTTP API key - will cease to function after June 2024.'
+  end
+
+  config.client(:new_client) do |client|
+    client.api_token = 'my_token'
+    client.google_application_credentials_path = ''
+  end
+end
+
+# Any data you want to add to your notification
+data = {
+  id: 232_342,
+  key: 'asd9adfiu6bn',
+  mission_id: 234_323
+}
+
+# All keyword arguments are optional and references a field in Firebase documentation:
+# Legacy API: https://firebase.google.com/docs/cloud-messaging/http-server-ref
+# APIv1 : https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages
+#  title: The notification's title.
+#    Legacy: `notification.title`
+#    APIv1: `message.notification.title`
+#  body: The notification's body text.
+#    Legacy: `notification.body`
+#    APIv1: `message.notification.body`,
+#  sound: The sound to play when the device receives the notification.
+#    Legacy: `notification.sound`
+#    APIv1:
+#      android: `message.android.sound`
+#      ios: `message.apns.aps.sound` 
+#  content_available: Allow to awaken the iOS app.
+#    Legacy: `content_available` - ignored on non-iOS devices.
+#    APIv1:
+#      ios: `message.apns.aps.content-available`
+#  data: Arbitrary key/value payload, which must be UTF-8 encoded. The key should not be a reserved word ("from", "message_type", or any word starting with "google" or "gcm").
+#    Legacy: `data`
+#    APIv1: `message.data`
+Modulofcm.client(:legacy_client).push('Legacy device registration token', data: data, title: 'My title', body: 'The body', sound: 'notif.caf', content_available: true)
+Modulofcm.client(:new_client).push('FCM new token', data: data, title: 'My title', body: 'The body', sound: 'notif.caf', content_available: true)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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/modulotech/modulofcm. 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/modulotech/modulofcm/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 Modulofcm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/modulotech/modulofcm/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/modulofcm/client.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+require_relative 'response'
+
+# rubocop:disable Metrics/ParameterLists
+module Modulofcm
+
+  class Client
+
+    attr_reader :name, :api_key, :api_token, :google_application_credentials_path, :firebase_project_id, :mode
+
+    def initialize(name:, api_key: nil, api_token: nil, google_application_credentials_path: nil,
+                   firebase_project_id: nil)
+      @name = name.to_sym
+      @api_key = api_key
+      @api_token = api_token
+      @google_application_credentials_path = google_application_credentials_path
+      @firebase_project_id = firebase_project_id
+      @mode = :api_v1
+    end
+
+    # All keyword arguments are optional and references a field in Firebase documentation:
+    # Legacy API: https://firebase.google.com/docs/cloud-messaging/http-server-ref
+    # APIv1 : https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages
+    #  title: The notification's title.
+    #    Legacy: `notification.title`
+    #    APIv1: `message.notification.title`
+    #  body: The notification's body text.
+    #    Legacy: `notification.body`
+    #    APIv1: `message.notification.body`,
+    #  sound: The sound to play when the device receives the notification.
+    #    Legacy: `notification.sound`
+    #    APIv1:
+    #      android: `message.android.sound`
+    #      ios: `message.apns.aps.sound`
+    #  content_available: Allow to awaken the iOS app.
+    #    Legacy: `content_available` - ignored on non-iOS devices.
+    #    APIv1:
+    #      ios: `message.apns.aps.content-available`
+    #  data: Arbitrary key/value payload, which must be UTF-8 encoded. The key should not be a reserved word
+    #    ("from", "message_type", or any word starting with "google" or "gcm").
+    #    Legacy: `data`
+    #    APIv1: `message.data`
+    def push(token, data: nil, title: nil, body: nil, sound: nil, content_available: true)
+      raise NoTokenError if token.blank?
+      raise EmptyNotificationError if data.blank? && title.blank? && body.blank?
+
+      case @mode
+      when :legacy
+        push_legacy(token, data: data, title: title, body: body, sound: sound, content_available: content_available)
+      else
+        raise NotImplementedError, 'Only Legacy notifications are supported'
+        # push_v1(token, data: data, title: title, body: body, sound: sound, content_available: content_available)
+      end
+    end
+
+    %w[api_key api_token firebase_project_id google_application_credentials_path].each do |attribute|
+      define_method("#{attribute}=") do |value|
+        instance_variable_set(:"@#{attribute}", value)
+
+        update_mode
+      end
+    end
+
+    private
+
+    def update_mode
+      api_v1_fields_all_present = [api_token, google_application_credentials_path, firebase_project_id].all?(&:present?)
+      api_key_blank = api_key.blank?
+
+      @mode = if api_v1_fields_all_present || api_key_blank
+                :api_v1
+              else
+                :legacy
+              end
+
+      @client = case @mode
+                when :legacy
+                  FCM.new(api_key)
+                else
+                  FCM.new(api_token, google_application_credentials_path, firebase_project_id)
+                end
+    end
+
+    def push_legacy(token, data: nil, title: nil, body: nil, sound: nil, content_available: true)
+      payload = default_payload(content_available)
+
+      handle_data(payload, data)
+      handle_notification(payload, body, sound, title)
+
+      make_legacy_response(@client.send(token, payload))
+    end
+
+    def push_v1(token, data: nil, title: nil, body: nil, sound: nil, content_available: true)
+      payload = default_payload(content_available)
+      payload[:token] = token
+
+      handle_data(payload, data)
+      handle_notification(payload, body, sound, title)
+
+      make_v1_response(@client.send_v1(payload))
+    end
+
+    def default_payload(content_available)
+      case @mode
+      when :legacy
+        {
+          content_available: !content_available.nil?
+        }
+      else
+        {
+          android: {},
+          apns:    {
+            aps: {
+              'content-available' => content_available ? 1 : 0
+            }
+          }
+        }
+      end
+    end
+
+    def handle_notification(payload, body, sound, title)
+      payload[:notification] = {} if [title, body, sound].any?(&:present?)
+
+      { title: title, body: body, sound: sound }.each do |key, value|
+        next if value.blank?
+
+        send("handle_notification_#{key}", payload, value)
+        payload[:data].merge!(key => value) if payload[:data].present?
+      end
+    end
+
+    def handle_notification_title(payload, value)
+      payload[:notification][:title] = value
+    end
+
+    def handle_notification_body(payload, value)
+      payload[:notification][:body] = value
+    end
+
+    def handle_notification_sound(payload, value)
+      case @mode
+      when :legacy
+        payload[:notification][:sound] = value
+      else
+        payload[:apns][:aps][:sound] = value
+        payload[:android][:sound] = value
+      end
+    end
+
+    def handle_data(payload, data)
+      payload[:data] = data if data.present?
+    end
+
+    def make_v1_response(response)
+      response_body = JSON.parse(response[:body])
+
+      Response.new(success: response_body['message'].present?,
+                   status: response[:status_code], body: response_body)
+    end
+
+    def make_legacy_response(response)
+      response_body = JSON.parse(response[:body])
+
+      Response.new(success: response_body['success'].positive? && response_body['failure'].zero?,
+                   status: response[:status_code], body: response_body)
+    end
+
+  end
+
+end
+# rubocop:enable Metrics/ParameterLists

data/lib/modulofcm/configurator.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Modulofcm
+
+  class Configurator
+
+    attr_reader :clients
+
+    def initialize
+      @clients = {}
+    end
+
+    def self.configure
+      raise ArgumentError, 'A block is needed for Modulofcm.configure' unless block_given?
+
+      builder = new
+      yield builder
+
+      Modulofcm.clients = builder.clients
+    end
+
+    def client(name)
+      raise ArgumentError, 'A block is needed for Modulofcm::Configurator.client' unless block_given?
+
+      client = Client.new(name: name)
+      yield client
+
+      validated_client, errors = validate_client(client)
+      raise InvalidClient, errors.join('; ') unless validated_client
+
+      @clients[name] = client
+    end
+
+    private
+
+    def validate_client(client)
+      @errors = []
+
+      @errors << 'Required field: name' if client.name.blank?
+
+      if [client.google_application_credentials_path, client.api_token, client.firebase_project_id].all?(:present?)
+        return [@errors.empty?, @errors]
+      end
+
+      return [@errors.empty?, @errors] if client.api_key.present?
+
+      # rubocop:disable Layout/LineLength
+      @errors << 'Either an API key for Legacy API (deprecated) either the API token, the Google application credentials path and the Firebase project id are required'
+      # rubocop:enable Layout/LineLength
+
+      [false, @errors]
+    end
+
+  end
+
+end

data/lib/modulofcm/errors.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Modulofcm
+
+  class Error < StandardError; end
+
+  class InvalidClient < Error
+
+    def initialize(msg=nil)
+      super(msg.presence || 'Invalid client configuration')
+    end
+
+  end
+
+  class NoTokenError < Error
+
+    def initialize
+      super('Token required to send a notification')
+    end
+
+  end
+
+  class EmptyNotificationError < Error
+
+    def initialize
+      super('A data payload, a title or a body is required to send a notification')
+    end
+
+  end
+
+end

data/lib/modulofcm/response.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Modulofcm
+
+  class Response
+
+    attr_reader :success, :status, :body
+
+    def initialize(success:, status:, body:)
+      @success = success
+      @status = status
+      @body = body
+    end
+
+    def succcess? = success
+
+  end
+
+end

data/lib/modulofcm/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Modulofcm
+
+  VERSION = '0.1.0'
+
+end

data/lib/modulofcm.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'active_support/all'
+require 'fcm'
+
+require_relative 'modulofcm/version'
+require_relative 'modulofcm/errors'
+require_relative 'modulofcm/client'
+require_relative 'modulofcm/configurator'
+
+module Modulofcm
+
+  class << self
+
+    def configure(&block)
+      Configurator.configure(&block)
+    end
+
+    def client(name)
+      clients[name.to_sym]
+    end
+
+    attr_accessor :clients
+
+  end
+
+end

data/modulofcm.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative 'lib/modulofcm/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'modulofcm'
+  spec.version = Modulofcm::VERSION
+  spec.authors = ['Matthieu Ciappara']
+  spec.email = ['ciappa_m@modulotech.fr']
+
+  spec.summary = 'Firebase Cloud Messaging client library'
+  spec.description = 'Firebase Cloud Messaging client library'
+  spec.homepage = 'https://github.com/moduloTech/modulofcm'
+  spec.license = 'MIT'
+  spec.required_ruby_version = '>= 3.0.0'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+  spec.metadata['changelog_uri'] = 'https://github.com/moduloTech/modulofcm/blob/master/CHANGELOG.md'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.require_paths = ['lib']
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.add_dependency 'activesupport', '< 8.0'
+  spec.add_dependency 'fcm', '~> 1.0', '>= 1.0.8'
+end

data/sig/modulofcm.rbs

@@ -0,0 +1,4 @@
+module Modulofcm
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: modulofcm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthieu Ciappara
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: fcm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.8
+description: Firebase Cloud Messaging client library
+email:
+- ciappa_m@modulotech.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/modulofcm.rb
+- lib/modulofcm/client.rb
+- lib/modulofcm/configurator.rb
+- lib/modulofcm/errors.rb
+- lib/modulofcm/response.rb
+- lib/modulofcm/version.rb
+- modulofcm.gemspec
+- sig/modulofcm.rbs
+homepage: https://github.com/moduloTech/modulofcm
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/moduloTech/modulofcm
+  source_code_uri: https://github.com/moduloTech/modulofcm
+  changelog_uri: https://github.com/moduloTech/modulofcm/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.3
+signing_key:
+specification_version: 4
+summary: Firebase Cloud Messaging client library
+test_files: []