communify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88e94e418d817416c98acd0a9f61a075b9cdf22aefcbb6fddf68b38ae7e3fa75
+  data.tar.gz: 7377a77794d509b110ffebd0985b311bc4618afdf686ec522558465f9cd50454
+SHA512:
+  metadata.gz: 8487ee00369708cc1f4a323567b76d7e132dba70481c9e2c4ee23c6e09d12fb2edcaac5f0d310e66e3e0d25dab4f096d1bffd20462e1a801f95784da8772d886
+  data.tar.gz: 8b30467377a80ed47782ee9598f3f990e91f74a3c952dffa4d50ffef551503d99330aec98a5c2c09a1a0ed4596a592b53463f9a045936de0ebe96a5eebe45313

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.17.3

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers 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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at 66819332+kishorerr@users.noreply.github.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in communify.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    communify (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
+    connection_pool (2.2.5)
+    diff-lcs (1.5.0)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
+      ruby2_keywords (>= 0.0.4)
+    faraday-net_http (2.0.3)
+    fcm (1.0.8)
+      faraday (>= 1.0.0, < 3.0)
+      googleauth (~> 1)
+    googleauth (1.2.0)
+      faraday (>= 0.17.3, < 3.a)
+      jwt (>= 1.4, < 3.0)
+      memoist (~> 0.16)
+      multi_json (~> 1.11)
+      os (>= 0.9, < 2.0)
+      signet (>= 0.16, < 2.a)
+    jwt (2.4.1)
+    memoist (0.16.2)
+    multi_json (1.15.0)
+    nokogiri (1.13.7-x86_64-linux)
+      racc (~> 1.4)
+    os (1.1.4)
+    public_suffix (5.0.0)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-protection (2.2.1)
+      rack
+    rake (10.5.0)
+    redis (4.7.1)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    ruby2_keywords (0.0.5)
+    sidekiq (6.0.7)
+      connection_pool (>= 2.2.2)
+      rack (~> 2.0)
+      rack-protection (>= 2.0.0)
+      redis (>= 4.1.0)
+    signet (0.17.0)
+      addressable (~> 2.8)
+      faraday (>= 0.17.5, < 3.a)
+      jwt (>= 1.5, < 3.0)
+      multi_json (~> 1.10)
+    twilio-ruby (5.69.0)
+      faraday (>= 0.9, < 3.0)
+      jwt (>= 1.5, <= 2.5)
+      nokogiri (>= 1.6, < 2.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  bundler (~> 2.3)
+  communify!
+  fcm (~> 1.0.8)
+  rake (~> 10.0)
+  redis (~> 4.7.0)
+  rspec (~> 3.0)
+  sidekiq (~> 6.0.0)
+  twilio-ruby (~> 5.69.0)
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Kishore RR
+
+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,162 @@
+# Communify
+
+The Communify gem lets your ruby backend send SMS through twilio and push notifications through Firebase cloud messaging while maintaining the log of the same. Also it logs all the emails that are sent through ActionMailer.
+
+## Why communify?
+
+Companies can communicate or notify their customers with information about the app, its features, its updates, and other details with their customers using email, push notifications and through SMS. 
+
+This stays to be a common mode of communication irrespective of the purpose of the app. So in order to ease the coding part and bring in all the 3 modes of communication together, we have come up with a Rails gem that helps developers include SMS, push notification and email logging with minimal lines of code.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'communify'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install communify
+
+Installing communify in your code also includes `twilio-ruby` with version equal to or higher to 5.69.0 and `fcm` with version equal to or higher than 1.0.8 i.e Communify abstracts the working of these gems
+
+## Requirements
+
+For successful functioning of this gem include sidekiq, redis and dotenv-rails gems in your application's gemfile
+
+And keep your sidekiq running, to run locally use 
+
+    $ bundle exec sidekiq
+
+## Usage
+
+For maintainig logs, run the following command in your command line
+
+    $ rails g communify:install
+
+This command generates a migration file and a model named CommunifyLog
+
+And then execute:
+
+    $ rails db:migrate
+
+This creates a table with fields
+- title -> title of a push notification goes here
+
+- content -> message/notification text to be sent goes here
+
+- recipient -> recipient mobile number incase of sms or registration id (generated when an app is installed) incase of push notification goes here
+
+- priority -> is an enum with options urgent(0 minutes), high(5 minutes), medium(30 minutes), low(60 minutes). When a message is with priority - urgent, the sidekiq job is triggered immediately, in case of high priority - the sidekiq job is triggered in 5 minutes etc., default value: urgent
+
+- content_type -> this field stores if the log is for sms(0) / push notification(1)
+
+- status ->  stores the status of the message/notification sent if it is successful sent or failured if so then with what error
+
+- third_party_id -> id generated when a message or notification is successfully sent
+
+- attempt_count -> is generated automatically and tells the number of attempts taken to send the text. The text is attempted to send utmost 3 times
+
+
+### For SMS
+
+To store Twilio keys in your app, run the following command in your command line
+
+    $ rails g communify:sms
+
+This command generates communify_sms.rb file in config/initializers folder of your app
+ 
+Uncomment the lines and set the account_sid, auth_token and sender_no with the keys provided in your twilio account.
+
+Then add the following lines in your controller method to send sms
+
+>Communify::Controllers::Sms.send_message(content, recipient, priority) # returns the resource_id if successful
+
+Note: 
+Content -> text to be sent through SMS
+
+Recipient -> recipient number with country code 
+         Example: “+91-1234567890”
+
+Priority -> “urgent” / “high” / “medium” / “low”
+
+Sample Log:
+
+<CommunifyLog id: 1, title: "", content: "OTP from abc app: 123456", recipient: "+1-123456789", attempt_count: 1, status: "Message Delivered at 2022-12-12T15:20:45+00:00", third_party_id: "SMaf7c76052f9c5180c03abc5c73d67d9", created_at: "2022-12-12 15:20:45", updated_at: "2022-12-12 15:20:45", priority: "urgent", content_type: "sms"> 
+
+### For Push notification
+
+To store device information, run the following command in your command line
+
+    $ rails g communify:push_notification
+
+This command generates a migration file and a model in your project folder
+
+And then execute:
+
+    $ rails db:migrate
+
+This creates a table named Devices with fields
+
+- device_id -> registration id goes here
+
+- device_name -> name of the devices goes here (android/ios/web)
+
+- person_id, person_type -> user id and class name goes here
+
+Get registration_id/device_id  (An ID generated by the FCM SDK for each client app instance) from the frontend and link it with a user and store it in Device table using
+
+>Device.create(device_id: "registration_id goes here", device_name: "Name of the device", person: user)
+
+To send and maintain logs of the notification
+
+First store the FCM SERVER KEY in your .env file with variable name FCM_SERVER_KEY
+
+Then to send notification add this line of code in your controller
+
+>Communify::Controllers::PushNotification.send_push_notification(title, content, recipient, notification_type, other_details, priority)
+
+Note: 
+
+Title -> Title of the notification goes here
+
+Content -> Text to be sent through SMS
+
+Recipient -> Array of registration ids 
+Example: [“reg_id1”,”reg_id2”]
+
+Notification Type -> Type of notification i.e keyword that helps Frontend to know where to redirect the user when the notification is clicked
+
+Other details -> Can be a string or a json converted to a string such that these details are sent to frontend/mobile through the 
+notification but are not visible to the user
+
+Priority -> “urgent” / “high” / “medium” / “low”
+
+- user refers to the user record
+
+- registration_id and device_id refers to the same and is used interchangebly
+
+Sample log:
+
+<CommunifyLog id: 1, title: "Notification title", content: "Notification content", recipient: "[\"e2x7BuarRx2tHqv7p80LBJ:APA91bEsh1_ouyuwLvtt06UCX...", attempt_count: 1, status: "Notification Delivered at 2022-11-08T07:17:57+00:0...", third_party_id: "0:1667891877225583%d8a4a6c1d8a4a6c1", created_at: "2022-11-04 14:28:27", updated_at: "2022-11-04 14:28:27", priority: "urgent", content_type: "push_notification">
+
+### For Maintaining Email logs
+
+To allow storing logs of all emails that are sent, execute the following command,
+
+    $ rails g communify:email
+
+This creates a mail_observer.rb file in config/initializers directory. Observers give you access to the email message after it has been sent.
+
+So this helps maintaing the logs in CommunifyLog table where the content, receiver email address and sent timings are stored.
+
+Sample log:
+
+<CommunifyLog id: 1, title: "", content: "Subject: Verify your email address, Body: <...", recipient: "ccc@gmail.com", attempt_count: 1, status: "Mail delivered at 2022-12-12T14:47:44+00:00", third_party_id: "63973f107deb7_d32c53f9f6e105da41323d@ip-172-31-10-...", created_at: "2022-12-12 14:47:45", updated_at: "2022-12-12 14:47:45", priority: "urgent", content_type: "email">
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "communify"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/communify.gemspec

@@ -0,0 +1,47 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "communify/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "communify"
+  spec.version       = Communify::VERSION
+  spec.authors       = ["Kishore RR, Shree Varshini"]
+  spec.email         = ["66819332+kishorerr@users.noreply.github.com, rpshreevarshini@gmail.com"]
+
+  spec.summary       = "Communication Mediator Gem"
+  spec.description   = "Communication mediator"
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against " \
+  #     "public gem pushes."
+  # end
+
+  # 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(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 2.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "redis", "~>4.7.0"
+  spec.add_development_dependency "sidekiq", "~>6.0.0"
+  spec.add_dependency "twilio-ruby", "~> 5.69.0"
+  spec.add_dependency "fcm", "~>1.0.8"
+end

data/lib/communify/controllers/email_controller.rb

@@ -0,0 +1,25 @@
+module Communify
+    module Controllers
+        class Email
+            def self.create_log(mail)
+                content = "Subject: #{mail.subject}, Body: #{mail.body}"
+                recipient = self.comma_separated(mail.to) + self.comma_separated(mail.cc) + self.comma_separated(mail.bcc)
+                resource = CommunifyLog.new(content: content, recipient: recipient, status: "Mail delivered at #{mail.date}", third_party_id: mail.message_id, content_type: 2, attempt_count: 1)
+                if resource.save
+                    return resource.id
+                else    
+                    raise "Error => Resource has not been saved!!"
+                end
+            end
+
+            private
+            def self.comma_separated(arr)
+                if !arr.nil? && !arr.empty?
+                    arr.join(",")
+                else
+                    ""
+                end
+            end 
+        end
+    end
+end

data/lib/communify/controllers/push_notification_controller.rb

@@ -0,0 +1,20 @@
+require 'communify/workers/push_notification_worker'
+require 'sidekiq/api'
+module Communify
+    module Controllers
+        class PushNotification
+            def self.send_push_notification(title, content, recipient, notification_type, other_details, priority = 0)
+                resource = CommunifyLog.new(title: title, content: content, recipient: recipient.to_s, content_type: 1, priority: priority)
+                if resource.save
+                    resource.update_column(:status, "Notification Queued at #{DateTime.now}")
+                    time = resource.read_attribute_before_type_cast(:priority)
+                    attempt = 1
+                    result = Communify::Workers::PushNotificationWorker.perform_in(time.minutes.from_now, resource.id, notification_type, other_details, time, attempt)
+                    return resource.id
+                else    
+                    raise "Error => Resource has not been saved!!"
+                end
+            end
+        end
+    end
+end

data/lib/communify/controllers/sms_controller.rb

@@ -0,0 +1,20 @@
+require 'communify/workers/sms_worker'
+require 'sidekiq/api'
+module Communify
+    module Controllers
+        class Sms 
+            def self.send_message(content, recipient, priority = 0)
+                resource = CommunifyLog.new(content: content, recipient: recipient, priority: priority, content_type: 0)
+                if resource.save
+                    resource.update_column(:status, "Message Queued at #{DateTime.now}")
+                    time = resource.read_attribute_before_type_cast(:priority)
+                    attempt = 1
+                    result = Communify::Workers::SmsWorker.perform_in(time.minutes.from_now, resource.id, time, attempt)
+                    return resource.id
+                else    
+                    raise "Error => Resource has not been saved!!"
+                end
+            end
+        end
+    end
+end

data/lib/communify/generators/email/email_generator.rb

@@ -0,0 +1,14 @@
+require 'rails/generators'
+
+module Communify
+  module Generators
+    class EmailGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        template "mail_observer.erb", "config/initializers/mail_observer.rb"
+      end
+    
+    end
+  end
+end

data/lib/communify/generators/email/templates/mail_observer.erb

@@ -0,0 +1,9 @@
+class MailObserver
+    def self.delivered_email(message)
+        Communify::Controllers::Email.create_log(message)
+    end
+end
+  
+ActionMailer::Base.register_observer(MailObserver)
+
+

data/lib/communify/generators/install/install_generator.rb

@@ -0,0 +1,34 @@
+require 'rails/generators'
+
+
+module Communify
+  module Generators
+
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Communify log"
+
+      def copy_migration
+        template "communify_log_migration.erb", "db/migrate/#{DateTime.now.to_formatted_s(:number)}_create_communify_logs.rb", migration_version: migration_version
+      end
+
+      def copy_communify_log_model
+        template "communify_log_model.erb", "app/models/communify_log.rb"
+      end
+
+      private
+    
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+    
+      def migration_version
+        if rails5_and_up?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+      
+    end
+  end
+end

data/lib/communify/generators/install/templates/communify_log_migration.erb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class CreateCommunifyLogs < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :communify_logs do |t|
+      t.string :title, null: false, default: ""
+      t.string :content, null: false, default: ""
+      t.string :recipient, null: false, default: ""
+      t.integer :attempt_count, null: false,default: 1
+      t.string :status
+      t.string :third_party_id, null: false,default: ""
+
+      t.timestamps null: false
+    end
+    add_column :communify_logs, :priority, :integer, default: 0
+    add_column :communify_logs, :content_type, :integer
+  end
+end

data/lib/communify/generators/install/templates/communify_log_model.erb

@@ -0,0 +1,6 @@
+class CommunifyLog < ActiveRecord::Base
+    #default values have been set for priority in minutes
+    enum priority: {urgent: 0, high: 5, medium: 30 , low: 60}
+    enum content_type: {sms: 0, push_notification: 1, email: 2} 
+
+end

data/lib/communify/generators/push_notification/push_notification_generator.rb

@@ -0,0 +1,31 @@
+require 'rails/generators'
+module Communify
+  module Generators
+    class PushNotificationGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      desc "Creates a Device table"
+
+      def copy_migration
+        template "device_migration.erb", "db/migrate/#{DateTime.now.to_formatted_s(:number)}_create_devices.rb", migration_version: migration_version
+      end
+
+      def copy_communify_log_model
+        template "device_model.erb", "app/models/device.rb"
+      end
+
+      private
+    
+      def rails5_and_up?
+        Rails::VERSION::MAJOR >= 5
+      end
+    
+      def migration_version
+        if rails5_and_up?
+          "[#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}]"
+        end
+      end
+      
+    end
+  end
+end

data/lib/communify/generators/push_notification/templates/device_migration.erb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class CreateDevices < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :devices do |t|
+      t.string :device_id, null: false
+      t.string :device_name, null: false
+      t.references :person, polymorphic: true, index: true
+
+      t.timestamps
+    end
+  end
+end

data/lib/communify/generators/push_notification/templates/device_model.erb

@@ -0,0 +1,3 @@
+class Device < ApplicationRecord
+    belongs_to :person, polymorphic: true
+end

data/lib/communify/generators/sms/sms_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module Communify
+  module Generators
+
+    class SmsGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        template "communify_sms.erb", "config/initializers/communify_sms.rb"
+      end
+    
+    end
+  end
+end

data/lib/communify/generators/sms/templates/communify_sms.erb

@@ -0,0 +1,11 @@
+require 'communify'
+Communify.config do |c|
+
+  # These are mandatory options that you must set for sms communication:
+
+  # Credentials for Twilio
+  # c.account_sid = 'Your Twilio Account SID goes here'
+  # c.auth_token = 'Your Twilio Auth Token goes here'
+  # c.sender_no = 'Your Sender Number goes here'
+
+end

data/lib/communify/version.rb

@@ -0,0 +1,3 @@
+module Communify
+  VERSION = "0.1.0"
+end

data/lib/communify/workers/push_notification_worker.rb

@@ -0,0 +1,51 @@
+require 'fcm'
+require 'sidekiq'
+require 'communify'
+require 'communify/controllers/push_notification_controller'
+module Communify
+    module Workers 
+        class PushNotificationWorker
+            include Sidekiq::Worker
+            sidekiq_options dead: false, retry: false
+
+            def perform(resource_id, notification_type, other_details, time, attempt)
+                fcm_client = FCM.new(ENV['FCM_SERVER_KEY'])
+                @current_resource = CommunifyLog.find(resource_id)
+                begin
+                    options = { 
+                        priority: 'high', 
+                        data: { 
+                            message: @current_resource.content,
+                            notification_type: notification_type,
+                            other_details: other_details
+                        },
+                        notification: { 
+                            title: @current_resource.title,
+                            body: @current_resource.content,
+                            sound: 'default'
+                        }                  
+                    }
+                    response = fcm_client.send(JSON.parse(@current_resource.recipient), options)
+                    raise if response[:status_code] != 200 || JSON.parse(response[:body])["success"] == 0
+                rescue
+                    @current_resource.update_column(:attempt_count, attempt)
+                    attempt = attempt +1
+                    if response[:status_code] != 200
+                        @current_resource.update_column(:status, "Notification failed at #{DateTime.now} due to error => #{response[:response]}") 
+                    else
+                        @current_resource.update_column(:status, "Notification failed at #{DateTime.now} due to error => #{JSON.parse(response[:body])["results"]}")
+                    end
+                    if attempt < 4
+                        sleep(time.minutes)
+                        retry
+                    end
+                else
+                    message_id = JSON.parse(response[:body])["results"]
+                    @current_resource.update_column(:third_party_id, message_id.to_s) 
+                    @current_resource.update_column(:attempt_count, attempt)
+                    @current_resource.update_column(:status, "Notification Delivered at #{DateTime.now}") 
+                end
+            end
+        end
+    end
+end

data/lib/communify/workers/sms_worker.rb

@@ -0,0 +1,40 @@
+require 'twilio-ruby'
+require 'sidekiq'
+require 'communify'
+require 'communify/controllers/sms_controller'
+module Communify
+    module Workers 
+        class SmsWorker
+            include Sidekiq::Worker
+            sidekiq_options dead: false, retry: false
+
+            def perform(resource_id, time, attempt)
+                account_sid = Communify.account_sid
+                auth_token = Communify.auth_token
+                @client = Twilio::REST::Client.new account_sid, auth_token
+                @current_resource = CommunifyLog.find(resource_id)
+                begin
+                    twilio_message = @client.messages.create(from: Communify.sender_no,to: @current_resource.recipient, body: @current_resource.content) # status_callback
+                rescue Exception => e
+                    @current_resource.update_column(:attempt_count, attempt)
+                    attempt = attempt +1
+                    @current_resource.update_column(:status, "Message failed at #{DateTime.now} due to error => #{e}")
+                    if attempt < 4
+                        sleep(time.minutes)
+                        retry
+                    end
+                #end
+                else
+                    @current_resource.update_column(:third_party_id, twilio_message.sid)
+                    @current_resource.update_column(:attempt_count, attempt)
+                    @current_resource.update_column(:status, "Message Delivered at #{DateTime.now}") #comment out
+                end
+            end
+        end
+    end
+end
+
+# In communify.erb file get status_callback link
+#: generate a controller action 
+# and then update message status after checking smssid with sid 
+#refer communify -test

data/lib/communify.rb

@@ -0,0 +1,25 @@
+require "communify/version"
+require 'communify/generators/install/install_generator'
+require 'communify/generators/sms/sms_generator'
+require 'communify/generators/push_notification/push_notification_generator'
+require 'communify/generators/email/email_generator'
+require 'communify/controllers/sms_controller'
+require 'communify/controllers/push_notification_controller'
+require 'communify/controllers/email_controller'
+require 'communify/workers/sms_worker'
+require 'communify/workers/push_notification_worker'
+
+module Communify
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :account_sid, :auth_token, :sender_no
+
+    def config
+      yield self
+    end
+
+  end
+end
+
+

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: communify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kishore RR, Shree Varshini
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.0
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.0
+- !ruby/object:Gem::Dependency
+  name: twilio-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.69.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.69.0
+- !ruby/object:Gem::Dependency
+  name: fcm
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !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.8
+description: Communication mediator
+email:
+- 66819332+kishorerr@users.noreply.github.com, rpshreevarshini@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- communify.gemspec
+- lib/communify.rb
+- lib/communify/controllers/email_controller.rb
+- lib/communify/controllers/push_notification_controller.rb
+- lib/communify/controllers/sms_controller.rb
+- lib/communify/generators/email/email_generator.rb
+- lib/communify/generators/email/templates/mail_observer.erb
+- lib/communify/generators/install/install_generator.rb
+- lib/communify/generators/install/templates/communify_log_migration.erb
+- lib/communify/generators/install/templates/communify_log_model.erb
+- lib/communify/generators/push_notification/push_notification_generator.rb
+- lib/communify/generators/push_notification/templates/device_migration.erb
+- lib/communify/generators/push_notification/templates/device_model.erb
+- lib/communify/generators/sms/sms_generator.rb
+- lib/communify/generators/sms/templates/communify_sms.erb
+- lib/communify/version.rb
+- lib/communify/workers/push_notification_worker.rb
+- lib/communify/workers/sms_worker.rb
+homepage:
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.33
+signing_key:
+specification_version: 4
+summary: Communication Mediator Gem
+test_files: []