modulofcm 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 756a3db83bff049923812f16b3c306b65acccd9878d8e23888d4fc6972d6b860
-  data.tar.gz: 90274c6c4c7bda319d1e7c804f1fbfd14083501c6712724587ac68b4a1ec83b7
+  metadata.gz: aec5f5c510d0c910403e80a2950b6281eafa1c00785683795b0a4d386407f2e6
+  data.tar.gz: 93f82faf62804139c3f839c7c0fe531c9ccda102038e6ce4007e9dfcddb1b529
 SHA512:
-  metadata.gz: 62460e72622514d6607bace864a8f9befe393b3b892366cee5797e075a49d37679917f6a3762a3be9f9c7033b16a7fb9930868cff1ec956621b2892674028d48
-  data.tar.gz: 3115a67425c392403e781d828390fee9ced2ec5b11a0b2edb48f49cc6fa7a2447767cee1e08e83557663631d4c6a4832b0d4d0dd7fbe5b49e78217b05381270f
+  metadata.gz: 34fe6c17bd43d09f8bd9407a525f260ae48e020e4e6d0238fac6815505d71b5249b81c04a4117df71d335ebca8afea08723f83113cbf3e76747abab296d68e2b
+  data.tar.gz: 90efe6b85984cb2d8b0eca03695322a9e56b0ccc3d144911d757e636bca9fdb5537821c8c411250f9c7add832315de9d4b5eed7b45d26bb1f7550a9267605c32

data/CHANGELOG.md

@@ -1,6 +1,12 @@
 ## [Unreleased]
 
+## [1.0.0] - 2024-05-22
+
+- Implement API v1
+- Fix Modulofcm::Configurator#validate_client for APIv1 clients
+- Fix typo for Modulofcm::Response#success?
+
 ## [0.1.0] - 2024-04-24
 
 - Initial release
-- Send Legacy push notifications.
+- Send Legacy push notifications.

data/README.md

@@ -20,9 +20,14 @@ Modulofcm.configure do |config|
     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 = ''
+  config.client(:api_v1_client) do |client|
+    client.firebase_project_id = 'Firebase Project id'
+    client.google_application_credentials = '{"type": "service_account", "project_id": "...", ...}'
+  end
+
+  config.client(:another_api_v1_client) do |client|
+    client.firebase_project_id = 'Firebase Project id'
+    client.google_application_credentials_path = 'config/google_application_credentials.json'
   end
 end
 
@@ -30,7 +35,11 @@ end
 data = {
   id: 232_342,
   key: 'asd9adfiu6bn',
-  mission_id: 234_323
+  mission_id: 234_323,
+  data: {
+    user_id: 15_123,
+    company_id: 23_341
+  }
 }
 
 # All keyword arguments are optional and references a field in Firebase documentation:
@@ -54,8 +63,9 @@ data = {
 #  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)
+Modulofcm.client(:legacy_client).push('Registration token', data: data, title: 'My title', body: 'The body', sound: 'notif.caf', content_available: true)
+Modulofcm.client(:api_v1_client).push('Registration token', data: data, title: 'My title', body: 'The body', sound: 'notif.caf', content_available: true)
+Modulofcm.client(:another_api_v1_client).push('Registration token', data: data, title: 'My title', body: 'The body', sound: 'notif.caf', content_available: true)
 ```
 
 ## Development

data/lib/modulofcm/client.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'file_i_o'
 require_relative 'response'
 
 # rubocop:disable Metrics/ParameterLists
@@ -7,14 +8,15 @@ module Modulofcm
 
   class Client
 
-    attr_reader :name, :api_key, :api_token, :google_application_credentials_path, :firebase_project_id, :mode
+    attr_reader :name, :api_key, :google_application_credentials, :firebase_project_id, :mode
 
-    def initialize(name:, api_key: nil, api_token: nil, google_application_credentials_path: nil,
+    def initialize(name:, api_key: nil,
+                   google_application_credentials_path: nil, google_application_credentials: 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
+      @google_application_credentials = google_application_credentials
       @firebase_project_id = firebase_project_id
       @mode = :api_v1
     end
@@ -49,12 +51,13 @@ module Modulofcm
       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)
+        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|
+    %w[
+        api_key firebase_project_id google_application_credentials_path google_application_credentials
+      ].each do |attribute|
       define_method("#{attribute}=") do |value|
         instance_variable_set(:"@#{attribute}", value)
 
@@ -62,10 +65,24 @@ module Modulofcm
       end
     end
 
+    def google_application_credentials_path
+      if @google_application_credentials_path.present? || @google_application_credentials.blank?
+        return @google_application_credentials_path
+      end
+
+      @google_application_credentials_path = if @google_application_credentials.is_a?(String)
+                                               FileIO.new(@google_application_credentials, 'creds.json')
+                                             elsif @google_application_credentials.respond_to?(:to_json)
+                                               FileIO.new(@google_application_credentials.to_json, 'creds.json')
+                                             else
+                                               @google_application_credentials
+                                             end
+    end
+
     private
 
     def update_mode
-      api_v1_fields_all_present = [api_token, google_application_credentials_path, firebase_project_id].all?(&:present?)
+      api_v1_fields_all_present = [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
@@ -78,7 +95,7 @@ module Modulofcm
                 when :legacy
                   FCM.new(api_key)
                 else
-                  FCM.new(api_token, google_application_credentials_path, firebase_project_id)
+                  FCM.new('', google_application_credentials_path, firebase_project_id)
                 end
     end
 
@@ -98,6 +115,16 @@ module Modulofcm
       handle_data(payload, data)
       handle_notification(payload, body, sound, title)
 
+      # According to Firebase documentation, all values must be strings. So all hashes/arrays are JSON-ified and other
+      # fields (including numbers) are converted to strings.
+      payload[:data].transform_values! do |value|
+        if value.is_a?(Hash) || value.is_a?(Array)
+          value.to_json
+        else
+          value.to_s
+        end
+      end
+
       make_v1_response(@client.send_v1(payload))
     end
 
@@ -110,9 +137,11 @@ module Modulofcm
       else
         {
           android: {},
-          apns:    {
-            aps: {
-              'content-available' => content_available ? 1 : 0
+          apns: {
+            payload: {
+              aps: {
+                'content-available' => content_available ? 1 : 0
+              }
             }
           }
         }
@@ -143,7 +172,7 @@ module Modulofcm
       when :legacy
         payload[:notification][:sound] = value
       else
-        payload[:apns][:aps][:sound] = value
+        payload[:apns][:payload][:aps][:sound] = value
         payload[:android][:sound] = value
       end
     end
@@ -155,7 +184,7 @@ module Modulofcm
     def make_v1_response(response)
       response_body = JSON.parse(response[:body])
 
-      Response.new(success: response_body['message'].present?,
+      Response.new(success: response[:response] == 'success',
                    status: response[:status_code], body: response_body)
     end
 

data/lib/modulofcm/configurator.rb

@@ -38,14 +38,14 @@ module Modulofcm
 
       @errors << 'Required field: name' if client.name.blank?
 
-      if [client.google_application_credentials_path, client.api_token, client.firebase_project_id].all?(:present?)
+      if [client.google_application_credentials_path, 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'
+      @errors << 'Either an API key for Legacy API (deprecated) either the Google application credentials and the Firebase project id are required'
       # rubocop:enable Layout/LineLength
 
       [false, @errors]

data/lib/modulofcm/file_i_o.rb

@@ -0,0 +1,18 @@
+class FileIO < StringIO
+
+  attr_reader :original_filename
+  attr_reader :identifier
+
+  def initialize(stream, filename)
+    super(stream.to_s)
+    @original_filename = filename
+    @filename = filename
+  end
+
+  def read(...)
+    rewind
+
+    super(...)
+  end
+
+end

data/lib/modulofcm/response.rb

@@ -12,7 +12,7 @@ module Modulofcm
       @body = body
     end
 
-    def succcess? = success
+    def success? = success
 
   end
 

data/lib/modulofcm/version.rb

@@ -2,6 +2,6 @@
 
 module Modulofcm
 
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: modulofcm
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Matthieu Ciappara
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-05-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -61,6 +61,7 @@ files:
 - lib/modulofcm/client.rb
 - lib/modulofcm/configurator.rb
 - lib/modulofcm/errors.rb
+- lib/modulofcm/file_i_o.rb
 - lib/modulofcm/response.rb
 - lib/modulofcm/version.rb
 - modulofcm.gemspec
@@ -73,7 +74,7 @@ metadata:
   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:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -88,8 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.3.7
+signing_key: 
 specification_version: 4
 summary: Firebase Cloud Messaging client library
 test_files: []