msg91-one-api 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f0656316ef6460108f2300edc7d4e83a910fcbf2c6e81713c944e843a5af4468
-  data.tar.gz: d44ef739237fdae9986f3c6c1cf6f41949a79facc431787e829486c786c94ce9
+  metadata.gz: 335a0947f6cfa51683cfce4f6ee0310a916a26d2fd815e57259e1e112c17e80b
+  data.tar.gz: 342bdda69d3ba0328873bd3249c7fe1c15ae25655fa63cb6b632760d88a3f2e4
 SHA512:
-  metadata.gz: 38addea15bd22287953bb6765bf3143b8c5e03fed06d812d5a476156caeb6a60e948951640aa0ecc29f2e890f4dae3a0af5e0461e9bd8e8e779656d26dfb79e7
-  data.tar.gz: 1a2cfe527567e55d09ef8f2ab8891816274257a15801c11df0feb57e94e279f0f674c7e3a88a82aeac72643dbeceb434e1ee37d53b5deb3570d64e89f2e69dfd
+  metadata.gz: '049c0750cba709bf919c8775edb3c7a53130ee5b008faa76e5d55cbe83e3e057eb02942425bc0172652440f4770c9fa5e7d4d3667314c2a87e8ca4467daf68e6'
+  data.tar.gz: 96636cab49f461fa0e2f5de91151b7b12b02445ced7289fa11a0ccafe2e11d3bdcf304d0818358b76f4c1d1db3afa0eaac177831d60c876c2fa5cf24f68ab404

data/lib/msg91/services/campaign_service.rb

@@ -0,0 +1,149 @@
+require 'net/http' # Importing the net/http library for making HTTP requests
+require 'uri' # Importing the uri library for parsing URIs
+require 'json' # Importing the json library for JSON manipulation
+
+module Msg91
+  module Services
+    class CampaignService
+      BASE_URL = 'https://control.msg91.com/api/v5/campaign/api/' # Base URL for Msg91 API
+
+      def initialize(auth_key)
+        @auth_key = auth_key # Initializing the Msg91 authentication key
+      end
+
+      # Method to run a campaign
+      def run_campaign(campaign_slug, input_data)
+        begin
+          verify_input_data(input_data) # Validate input data for the campaign
+          mapping_data = verify_and_get_campaign_mappings(campaign_slug) # Retrieve campaign mappings
+          send_campaign = { data: create_send_to_body(input_data, mapping_data) } # Prepare campaign payload
+          response = send_campaign_request(campaign_slug, send_campaign) # Send the campaign
+        rescue => e
+          raise "Exception: #{e.message}" # Handle exceptions
+        end
+
+        {
+          "message" => "Campaign Run Successfully",
+          "request_id" => response['request_id']
+        }
+      end
+
+      private
+
+      # Method to verify input data for the campaign
+      def verify_input_data(input_data)
+        raise "Must require a record to Run Campaign" if input_data.empty? # Raise error if input data is empty
+        raise "Record data limit exceeded: total limit 1000" if input_data['data'].size > 1000 # Raise error if input data exceeds limit
+
+        count = 0
+        input_data['data'].each do |data|
+          count += 1 if !data['to'].nil? && !data['to'].empty? # Count 'to' emails
+          count += 1 if !data['cc'].nil? && !data['cc'].empty? # Count 'cc' emails
+          count += 1 if !data['bcc'].nil? && !data['bcc'].empty? # Count 'bcc' emails
+        end
+        raise "Records data limit exceeded: total limit 1000 (including cc, bcc, and to). Current count: #{count}" if count > 1000 # Raise error if count exceeds 1000
+      end
+
+      # Method to verify and get campaign mappings
+      def verify_and_get_campaign_mappings(campaign_slug)
+        mapping_data = {}
+        operation = "campaigns/#{campaign_slug}/fields?source=launchCampaign" # API operation to fetch campaign mappings
+        campaign_mappings = make_api_call(operation) # Make API call to fetch mappings
+
+        raise "Invalid Campaign or no Node in Campaign" if campaign_mappings['mapping'].nil? # Raise error if no mappings found
+
+        mapping_data['mappings'] = campaign_mappings['mapping'].map { |mapping| mapping['name'] } # Extract mappings
+        mapping_data['variables'] = campaign_mappings['variables'] unless campaign_mappings['variables'].nil? # Extract variables
+
+        mapping_data # Return mapping data
+      end
+
+      # Method to create payload for sending the campaign
+      def create_send_to_body(input_data, mapping_data)
+        send_campaign = { 'sendTo' => [] } # Initialize payload
+        mappings = mapping_data['mappings'] # Get mappings
+        variables = mapping_data['variables'] # Get variables
+
+        # Iterate over input data
+        input_data['data'].each do |data|
+          temp = {} # Temporary hash for each data record
+
+          # Iterate over mappings
+          mappings.each do |map|
+            if data.key?(map)
+              case map
+              when 'to'
+                temp[map] = [{ 'email' => data[map] }] if valid_email?(data[map]) # Validate and set 'to' email
+              when 'mobiles'
+                temp['to'] ||= [{}]
+                temp['to'][0]['mobiles'] = data[map] if valid_mobile?(data[map]) # Validate and set 'mobiles'
+              when 'cc', 'bcc'
+                temp[map] = [{ 'email' => data[map] }] if valid_email?(data[map]) # Validate and set 'cc' or 'bcc'
+              when 'from_name'
+                temp[map] = data[map] # Set 'from_name'
+              when 'from_email'
+                temp[map] = data[map] if valid_email?(data[map]) # Set 'from_email'
+              end
+            end
+          end
+
+          if data.key?('to') && data.key?('name') && !data['name'].empty?
+            temp['to'][0]['name'] = data['name'] # Set 'name' if present
+          end
+
+          temp['variables'] = {} # Initialize variables
+          unless data['variables'].nil? # Check if variables present in data
+            variables.each do |var|
+              temp['variables'][var] = data['variables'][var] if data['variables'].key?(var) # Set variables
+            end
+          end
+
+          send_campaign['sendTo'] << temp # Add temporary data hash to send_to array
+        end
+
+        send_campaign['reply_to'] = input_data['reply_to'] if input_data.key?('reply_to') # Set 'reply_to'
+        send_campaign['attachments'] = input_data['attachments'] if input_data.key?('attachments') # Set 'attachments'
+        send_campaign # Return campaign payload
+      end
+
+      # Method to send the campaign
+      def send_campaign_request(campaign_slug, data)
+        operation = "campaigns/#{campaign_slug}/run" # API operation to run the campaign
+        make_api_call(operation, data, 'POST') # Make API call to run the campaign
+      end
+
+      # Method to make API call
+      def make_api_call(operation, input_data = {}, method = 'GET')
+        uri = URI(BASE_URL + operation) # Construct API URL
+        http = Net::HTTP.new(uri.host, uri.port) # Initialize HTTP connection
+        http.use_ssl = true # Use SSL for secure connection
+
+        request = case method
+                  when 'POST'
+                    req = Net::HTTP::Post.new(uri.path, { 'authkey' => @auth_key, 'Content-Type' => 'application/json' }) # Create POST request
+                    req.body = input_data.to_json # Set request body
+                    req # Return request
+                  else
+                    Net::HTTP::Get.new(uri.path, { 'authkey' => @auth_key }) # Create GET request
+                  end
+
+        response = http.request(request) # Make HTTP request
+        raise "API call failed: #{response.body}" unless response.is_a?(Net::HTTPSuccess) # Raise error if API call failed
+
+        JSON.parse(response.body)['data'] # Parse and return response data
+      end
+
+      # Method to validate email format
+      def valid_email?(email)
+        /\A[\w+\-.]+@[a-z\d\-.]+\.[a-z]+\z/i.match?(email) # Validate email format
+      end
+
+      # Method to validate mobile number format
+      def valid_mobile?(mobile)
+        /^\+?[0-9]{7,14}$/.match?(mobile) # Validate mobile number format
+      end
+    end
+  end
+end
+
+# Author: Prashant Patidar

data/lib/msg91.rb

@@ -1,3 +1,4 @@
 # lib/msg91.rb
 
 require_relative 'msg91/services/otp_service'
+require_relative 'msg91/services/campaign_service'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: msg91-one-api
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Harsh Jaiswal
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-29 00:00:00.000000000 Z
+date: 2024-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-http
@@ -47,6 +47,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/msg91.rb
+- lib/msg91/services/campaign_service.rb
 - lib/msg91/services/otp_service.rb
 homepage: https://github.com/Walkover-Web-Solution/msg91-ruby-plugins
 licenses: