snm-fcm 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 991a04d8b3f660e9f74fbdf29a31b7478e0ed39b04a2a510d1353550d6fb16b2
-  data.tar.gz: c370801fce9fd3413877015b9484a1cfbd1ece69eaeb2d852639dc188c87219b
+  metadata.gz: d59ac9bf55d1e9380c20cf2ff2c94f170bd160fc1fd32d2437bbaa4f559b715a
+  data.tar.gz: 988218b976e0e35a148aba9cb17aadbf6bd19d5a8e0e45092b3d3c090256fce0
 SHA512:
-  metadata.gz: 52832fe027409c109c83d99dc32eac6bddd0d95f14a8e0cac644026bd9b52a616f5dad840a845456a8d0aeda52e443c6239daaa119e106871870d6d4d2cf6282
-  data.tar.gz: e7d828acb36fe5b75b88428141714c1c1540a2746bdbb976aa5222d2e2ddcfd43c337dc9aaad133b4ed678ace3c9aac867f3e48fab5a46d958dd072032a38368
+  metadata.gz: 94f041e6ab5cf3ea1a0a88a0ed53e828576e3b5ee7b349074df60bbe8fbafb9db9feaaf02feff0a4b5d76d42de1db5560fc6d929fdd7c293404b3f56de8c01d7
+  data.tar.gz: 85bcbe3e2aeed13eafc76fc09c9efbd653d0ca8d5fb16e005a2c5f931b87ebdd8173d2d0ec058b94c439dbeeba7b855c7babf141fbc6151d03381f084a14e094

data/README.md

@@ -1,34 +1,82 @@
 # Snm::Fcm
 
-TODO: Delete this and the text below, and describe your gem
+Ruby Library to send notification on android via Firebase Cloud Messaging API (V1)
 
-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/snm/fcm`. To experiment with that code, run `bin/console` for an interactive prompt.
+This library is based on Firebase Cloud Messaging API (V1) to send notification on android devices.
 
-## Installation
+## Requirements
+Version 0.1.6 requires at least Ruby 3.0.0, This library dependents on googleauth, redis, json and http gem.
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+## Installation
 
 Install the gem and add to the application's Gemfile by executing:
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem 'snm-fcm', '~> 0.1.5'
 
 If bundler is not being used to manage dependencies, install the gem by executing:
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+    $ gem install snm-fcm
 
 ## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-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.
-
-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).
+### Setup
+Create an initializer file for ex rails-project/config/initializers/snm_fcm.rb
+```
+Snm::Fcm::Notification.configure do |config|
+  config.credentails_file_path = 'path/to/my-fcm-e65a9915e042.json'
+  config.redis_endpoint = 'redis://localhost:6379/1'
+end
+Snm::Fcm::Notification.setup
+```
+### Send notification
+```
+msg_data = {
+  'message'=> {
+    'token'=> 'android-device-fcm-token',
+    'notification'=>
+    {
+      'title'=> 'Lorem ipsum',
+      'body'=> 'Lorem ipsum dolor sit amet, consectetur adipiscing elit',
+      'image'=> 'https://www.snmmaurya.com/images/me.jpg'
+    },
+    'data'=> {
+      'key1'=> 'value1',
+      'key2'=> 'value2'
+      }
+    }
+}
+respoonse = Snm::Fcm::Notification.deliver(msg_data)
+
+# Success response:
+
+{"name"=>"projects/my-fcm/messages/0:1715935676674045%f570bc3bf570bc3b"}
+
+```
+## How to get my-fcm-e65a9915e042.json
+
+1. Got go https://console.firebase.google.com/
+
+### For Android (FE)
+
+2. Create your project for ex 'my-fcm' and download google-services.json to set up your android project.
+
+### For Ruby
+3. Go to the project click on settings icon next to Project Overview top left cornor.
+
+    3.1 in the general tab you will find 'project id' copy this id and put somewhere in your system.
+    
+    3.2 Click on Cloud Messging tab -
+    
+    3.3 In side Firebase Cloud Messaging API (V1) panel.
+    
+    3.4 Click on Manage Service Accounts On the next page a service already be there click on the name of that serive name for ex 'firebase-adminsdk-4apop@my-fcm.iam.gserviceaccount.com'
+    
+    3.5 Click on advanced settings - choose 'keys' tab.
+    
+    3.6 Now create a new key type json download it (automatically downloaded) put this file somewhere in your system. this file is your my-fcm-e65a9915e042.json
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/snm-fcm. 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]/snm-fcm/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/snmmaurya/snm-fcm. 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/snmmaurya/snm-fcm/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -36,4 +84,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Snm::Fcm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/snm-fcm/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Snm::Fcm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/snmmaurya/snm-fcm/blob/main/CODE_OF_CONDUCT.md).

data/lib/snm/fcm/version.rb

@@ -2,6 +2,6 @@
 
 module Snm
   module Fcm
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/lib/snm/fcm.rb

@@ -4,13 +4,14 @@ require_relative "fcm/version"
 require 'googleauth'
 require 'http'
 require 'json'
+require 'redis'
 
 module Snm
   module Fcm
     class Error < StandardError; end
 
     class Configuration
-      attr_accessor :credentails_file_path, :project_id
+      attr_accessor :credentails_file_path, :project_id, :redis_endpoint, :snm_fcm_redis
     end
 
     class Notification
@@ -18,7 +19,7 @@ module Snm
         @configuration ||= Configuration.new
       end
 
-      def self.setup(&block)
+      def self.configure(&block)
         yield(configuration)
       end
 
@@ -30,18 +31,24 @@ module Snm
       end
 
       def self.get_access_token
-        scope = 'https://www.googleapis.com/auth/cloud-platform'
-        authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
-          json_key_io: File.open(Notification.configuration.credentails_file_path),
-          scope: scope
-        )
-        authorizer.fetch_access_token!['access_token']
+        access_token = Notification.configuration.snm_fcm_redis.get('access_token')
+        if access_token.nil?
+          scope = 'https://www.googleapis.com/auth/cloud-platform'
+          authorizer = Google::Auth::ServiceAccountCredentials.make_creds(
+            json_key_io: File.open(Notification.configuration.credentails_file_path),
+            scope: scope
+          )
+          access_token = authorizer.fetch_access_token!['access_token']
+          Notification.configuration.snm_fcm_redis.setex('access_token', 3599, access_token)
+        end
+        access_token
       end
 
-      def self.set_project
+      def self.setup
         file = File.read(Notification.configuration.credentails_file_path)
         data_hash = JSON.parse(file)
         Notification.configuration.project_id = data_hash["project_id"]
+        Notification.configuration.snm_fcm_redis = Redis.new(url: Notification.configuration.redis_endpoint)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: snm-fcm
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - snmmaurya
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-05-16 00:00:00.000000000 Z
+date: 2024-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -58,6 +58,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.7.2
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 description: Ruby Library to send notification on android via Firebase Cloud Messaging
   API (V1)
 email: