inova_fcm 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7a5c3f2db558546de2db1fbc8e5bd1ec590c503888c793de28fa9c5011381b28
-  data.tar.gz: ccb4df677e12bf71a44215580e7c255536797a043fd17133ea3744061b372424
+  metadata.gz: cf8a7122099b2f411a962d6a135e8660bea0d6a538be7109c31d9c174eac2abb
+  data.tar.gz: e1252852c68bc45035b142d56d6017ed59b4dcc7edcf18ac87af63475236f9d0
 SHA512:
-  metadata.gz: 9a32fce4e8763f73aedc990aebd72859dbd90e4acdaa2d62e53cf41d9d1b2fa9db2a23d3c5329072bcdd8a42512d76847c898495920a5a2dbc1548c5717e8329
-  data.tar.gz: b7f361981e123ef2575077670747b11c8bcc25fff5c3173b4efda7b4f0cc819c234e2d7f1844970f87ae9846781c14a100c3ce7e526b98bfa0cceaa1a1ef1fb7
+  metadata.gz: e82e3d3fd06ae6e492459e60dc78ef3652e9c96cc06d74e3a25821d413f711f662b98353dd36862571e66be1b86710e610673a1a326857a2eedfcb1d49524385
+  data.tar.gz: fc23602b6cb7d1144688a7d7bf533bbb80fe7ecaf8f7e225f987fd94b6be6aa7782b3726931a78874aa454c5ea6b015ee18e2082b42abc4f1d41b4f1551e42ae

data/CHANGELOG.md

@@ -1,5 +1,20 @@
-## [Unreleased]
+# Changelog
 
-## [0.1.0] - 2023-12-06
+All notable changes to this project will be documented in this file.
 
-- Initial release
+## [0.2.0] - 2023-12-28
+
+### Added
+
+- Handled the imposed Firebase limit for topic subscription by managing registration and unregistration in batches of 1000.
+
+### Changed
+
+- No breaking changes.
+- Minor enhancements for better maintainability.
+
+## [0.1.0] - Initial Release - 2023-12-06
+
+### Added
+
+- Initial version of the gem.

data/README.md

@@ -7,13 +7,13 @@ InovaFCM is a Ruby gem designed to simplify interactions with Firebase Cloud Mes
 To use this gem in your project, add it to your application's Gemfile:
 
 ```ruby
-gem 'inova_fcm', '~> 0.1.0'
+gem 'inova_fcm', '~> 0.2.0'
 ```
 
 Alternatively, you can install the gem directly using:
 
 ```bash
-gem install inova_fcm -v '~> 0.1.0'
+gem install inova_fcm -v '~> 0.2.0'
 ```
 
 ## Requirments
@@ -27,7 +27,7 @@ gem install inova_fcm -v '~> 0.1.0'
 rails generate inova_fcm:install
 ```
 
-This will create a configuration file at config/initializers/inova_aws_s3.rb. Open the file and set your AWS credentials:
+This will create a configuration file at config/initializers/inova_fcm.rb. Open the file and set your Firebase credentials:
 
 ```ruby
 InovaFCM.configure do |config|
@@ -38,7 +38,17 @@ InovaFCM.configure do |config|
 end
 ```
 
-Replace the placeholder values with your actual AWS credentials.
+Replace the placeholder values with your actual Firebase credentials.
+
+To send a notification to a device, you can use the following method:
+
+```ruby
+InovaFCM::Service.new(registration_ids: ["registration_id"],
+  notification: {title: "tite", body: "body"},
+  data: {id: 1}).send_notification
+```
+
+Where registration_ids is an array of device registration ids, notification is a hash containing the notification's title and body, and data is a hash of data to be sent with the notification.
 
 ## Contributing
 
@@ -50,4 +60,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the InovaAwsS3 project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ahmedmos3ad/inova_fcm/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the InovaFCM project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/ahmedmos3ad/inova_fcm/blob/master/CODE_OF_CONDUCT.md).

data/lib/inova_fcm/service.rb

@@ -3,6 +3,8 @@ module InovaFCM
     require "fcm"
     require "json"
 
+    MAX_TOPIC_REGISTRATION_BATCH_SIZE = 1000
+
     attr_reader :registration_ids, :notification, :data, :topic
 
     def initialize(registration_ids: [], notification: {}, data: {}, topic: SecureRandom.uuid + Time.now.to_i.to_s)
@@ -58,11 +60,15 @@ module InovaFCM
     end
 
     def register_tokens_to_topic
-      @fcm.batch_topic_subscription(@topic, @registration_ids)
+      @registration_ids.each_slice(MAX_TOPIC_REGISTRATION_BATCH_SIZE) do |registration_ids_batch|
+        @fcm.batch_topic_subscription(@topic, registration_ids_batch)
+      end
     end
 
     def unregister_tokens_from_topic
-      @fcm.batch_topic_unsubscription(@topic, @registration_ids)
+      @registration_ids.each_slice(MAX_TOPIC_REGISTRATION_BATCH_SIZE) do |registration_ids_batch|
+        @fcm.batch_topic_unsubscription(@topic, registration_ids_batch)
+      end
     end
 
     def validate_attributes!

data/lib/inova_fcm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module InovaFCM
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: inova_fcm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ahmed Mos`ad
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails