unifonic_sms 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 807e20ed74f946b8da4862674c01fbc4188f5053
+  data.tar.gz: 04623444a12689343843d03f5007507c961a2fb7
+SHA512:
+  metadata.gz: b3d769b5a51d5200a4a4efdcffd1bda457ab659a58f3a4f8319fe234b39f4510c08cb796de45ff52fe2d22d9a20bd674404659e6e71d85f6ae0fd8c41d327ebf
+  data.tar.gz: f90597cae15310bb2827963ad42f37347b82170aba1939d2ce118a61fb28593b1c71bdb757eb318ec8b830c1c5311c5d06defd927da39f1d57c1309955a8c654

data/lib/unifonic_sms.rb

@@ -0,0 +1,525 @@
+require 'net/http'
+require "unifonic_sms/version"
+require 'unifonic_sms/error_code'
+require 'unifonic_sms/normalizer'
+require 'unifonic_sms/configuration'
+
+module UnifonicSms  
+  class << self
+
+    attr_accessor :configuration
+
+    # Get the Configurations or Reset.
+    # 
+    # @return [QiwaSms::Configuration] Configuration.
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Reset Configuration to nil.
+    def reset
+      @configuration = Configuration.new
+    end
+
+    # Holds the configurtion block.
+    def configure
+      yield(configuration)
+    end    
+
+    # Get the api key from the configurations.
+    # 
+    # @return [String] Api Key.
+    def api_key
+      configuration.api_key
+    end    
+
+    # Get the phone number of the sender from the configurations.
+    # 
+    # @return [String] Phone Number.
+    def sender_phone
+      configuration.sender_phone
+    end
+
+    # Get the base url for api call.
+    # 
+    # @param method_url [String] the api method url.
+    # @return [String] Url for Api Call. 
+    def base_path (method_url)
+      "/rest/#{method_url}"
+    end
+
+    # Get Account's Current Balance.
+    #
+    # @return [String] balance of the Account.
+    # @return [String] shared balance with sub accounts.
+    # @return [String] currency code used with cost.
+    # @return [String] Code status of the response if 0 its a success else its an error.
+    def balance
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Account/GetBalance")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["data"].nil? 
+        return { balance: response_body["data"]["Balance"],
+                 currency_code: response_body["data"]["CurrencyCode"],
+                 shared_balance: response_body["data"]["SharedBalance"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end         
+    end 
+
+    # Send SMS message.
+    #
+    # @param [String] phone The Recipient phone number.
+    # @param [String] message Body of the message to be sent.
+    # @param [String, nil] time_schedualed Schedualed time to send the message. 
+    #
+    # @return [String] Message ID.
+    # @return [String] Status of message possible values are "Queued" , "Sent", "Failed" and "Rejected".
+    # @return [String] Number of unit in a message.
+    # @return [String] Price of a message total units.
+    # @return [String] The currency code used eith cost.
+    # @return [String] Current balance of your account.
+    # @return [String] The mobile number the message was sent to.
+    # @return [String] Date a message was created in, in the following format "yyyy-mm-dd hh:mm:ss".
+    # @return [String] Code status of the response if 0 its a success else its an error.
+    def send_message (phone, message, time_schedualed = nil)
+      # Adjust Parameters
+      recipient = Normalizer.normalize_number(phone)
+      message = Normalizer.normalize_message(message)
+
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/Send")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}&Recipient=#{recipient}&Body=#{message}"
+      body += "&SenderID=#{sender_phone}" unless sender_phone.nil?
+      body += '&Priority=High'
+      body += '&TimeScheduled=#{time_schedualed}' unless time_schedualed.nil?
+      
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["data"].nil? 
+        return { message_id: response_body["data"]["MessageID"], 
+                 status: response_body["data"]["Status"], 
+                 number_of_units: response_body["data"]["NumberOfUnits"],
+                 cost: response_body["data"]["Cost"],
+                 currency_code: response_body["data"]["CurrencyCode"],
+                 balance: response_body["data"]["Balance"],
+                 recipient: response_body["data"]["Recipient"],
+                 time_created: response_body["data"]["TimeCreated"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end
+
+    # Send Bulk SMS messages
+    # Max is 1,000 recipents per request.
+    #
+    # @param [String] phones The Recipients phone numbers seperated by comma.
+    # @param [String] message Body of the message to be sent.
+    # @param [String, nil] time_schedualed Schedualed time to send the message. 
+    #
+    # @return [Array<Hash>] Messages.
+    # @return [String] Status of message possible values are "Queued" , "Sent", "Failed" and "Rejected".
+    # @return [String] Number of unit in a message.
+    # @return [String] Price of a message total units.
+    # @return [String] The currency code used eith cost.
+    # @return [String] Current balance of your account.
+    # @return [String] The mobile numbers the message was sent to.
+    # @return [String] Date a message was created in, in the following format "yyyy-mm-dd hh:mm:ss".
+    # @return [String] Code status of the response if 0 its a success else its an error. 
+    def send_bulk (phones, message, time_schedualed = nil)
+      # Adjust Parameters
+      recipients = []
+      phone_numbers = phones.split(",")
+      phone_numbers.each do |phone|
+        recipients.push(Normalizer.normalize_number(phone))
+      end
+      message = Normalizer.normalize_message(message)
+
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/SendBulk")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}&Recipient="
+
+      # Add Recipents to body attributes
+      recipients.each_with_index do |phone, index|
+        body += phone
+        if index != (recipients.count - 1)
+          body += ","
+        end
+      end
+
+      body += "&Body=#{message}"
+      body += "&SenderID=#{sender_phone}" unless sender_phone.nil?
+      body += '&TimeScheduled=#{time_schedualed}' unless time_schedualed.nil?
+      
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["data"].nil? 
+        return { messages: response_body["data"]["Messages"], 
+                  status: response_body["data"]["Status"], 
+                  number_of_units: response_body["data"]["NumberOfUnits"],
+                  cost: response_body["data"]["Cost"],
+                  currency_code: response_body["data"]["CurrencyCode"],
+                  balance: response_body["data"]["Balance"],
+                  recipient: response_body["data"]["Recipient"],
+                  time_created: response_body["data"]["TimeCreated"],
+                  code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end 
+
+    # Get Message Status.
+    #
+    # @param [String] message_id The ID of the message.
+    #
+    # @return [String] Status of message possible values are "Queued" , "Sent", "Failed" and "Rejected".
+    # @return [String] DLR Message delivery status returned by networks, the possible values are "Delivered" or "Undeliverable", and are available for advanced plans.
+    # @return [String] Code status of the response if 0 its a success else its an error. 
+    def message_status (message_id)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/GetMessageIDStatus")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}&MessageID=#{message_id}"
+      
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["Status"].nil? 
+        return { status: response_body["Status"], code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end 
+
+    # To get a summarized report for sent messages within a specific timer interval
+    #
+    # @param [String, nil] date_from The start date for the report time interval, date format should be yyyy-mm-dd.
+    # @param [String, nil] date_to The end date for the report time interval, date format should be yyyy-mm-dd.
+    # @param [String, nil] status Filter messages report according to a specific message status, "Sent", "Queued", "Rejected" or "Failed".
+    # @param [String, nil] dlr Message delivery status returned by networks, the possible values are "Delivered" or "Undeliverable", and are available for advanced plans.
+    # @param [String, nil] country Filter messages report according to a specific destination country.
+    #    
+    # @return [String] Number of messages.
+    # @return [String] Number of unit in a message.
+    # @return [String] Price of a message total units.
+    # @return [String] The currency code used eith cost.
+    # @return [String] Code status of the response if 0 its a success else its an error. 
+    def messages_report (date_from = nil, date_to = nil, status = nil, dlr = nil, country = nil)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/GetMessagesReport")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+      body += "&SenderID=#{sender_phone}" unless sender_phone.nil?
+      body += "&DateFrom=#{date_from}" unless date_from.nil?
+      body += "&DateTo=#{date_to}" unless date_to.nil?
+      body += "&Status=#{status}" unless status.nil?
+      body += "&DLR=#{dlr}" unless dlr.nil?
+      body += "&Country=#{country}" unless country.nil?
+
+      
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["TotalTextMessages"].nil? 
+        return { total_text_messages: response_body["TotalTextMessages"],
+                 number_of_units: response_body["NumberOfUnits"], 
+                 cost: response_body["Cost"],
+                 currency_code: response_body["CurrencyCode"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end 
+
+    # Get latest 10,000 messages details if no message id was provided.
+    #
+    # @param [String, nil] message_id The ID of the message.
+    # @param [String, nil] date_from The start date for the report time interval, date format should be yyyy-mm-dd.
+    # @param [String, nil] date_to The end date for the report time interval, date format should be yyyy-mm-dd.
+    # @param [String, nil] status Filter messages report according to a specific message status, "Sent", "Queued", "Rejected" or "Failed".
+    # @param [String, nil] dlr Message delivery status returned by networks, the possible values are "Delivered" or "Undeliverable", and are available for advanced plans.
+    # @param [String, nil] country Filter messages report according to a specific destination country.
+    # @param [String, nil] limit Number of messages to return in the report, where the limit maximum is 10,000 and messages are sorted by sending date.
+    #    
+    # @return [String] Number of messages.
+    # @return [String] Page number.
+    # @return [Array<Hash>] Messages.
+    # @return [String] Code status of the response if 0 its a success else its an error. 
+    def messages_details (message_id = nil, date_from = nil, date_to = nil, status = nil, dlr = nil, country = nil, limit = nil)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/GetMessagesDetails")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+      body += "&MessageID=#{message_id}" unless message_id.nil?
+      body += "&SenderID=#{sender_phone}" unless sender_phone.nil?
+      body += "&DateFrom=#{date_from}" unless date_from.nil?
+      body += "&DateTo=#{date_to}" unless date_to.nil?
+      body += "&Status=#{status}" unless status.nil?
+      body += "&DLR=#{dlr}" unless dlr.nil?
+      body += "&Country=#{country}" unless country.nil?
+      body += "&Limit=#{limit}" unless limit.nil?
+
+      
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["data"].nil? 
+        return { total_text_messages: response_body["data"]["TotalTextMessages"],
+                 page: response_body["data"]["Page"], 
+                 messages: response_body["data"]["messages"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end   
+
+    # Get a summarized report for scheduled sent messages.
+    #
+    # @param [String, nil] message_id The ID of the message.
+    #    
+    # @return [String] Message ID.
+    # @return [String] Message Body.
+    # @return [String] Sender ID.
+    # @return [String] Recipient.
+    # @return [String] Time Schedualed.
+    # @return [String] Status.
+    # @return [String] Code status of the response if 0 its a success else its an error. 
+    def schedualed_messages (message_id = nil)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/GetScheduled")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+      body += "&MessageID=#{message_id}" unless message_id.nil?
+
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 
+        return { message_id: response_body["MessageID"],
+                 message_body: response_body["MessageBody"], 
+                 sender_id: response_body["SenderID"],
+                 recipient: response_body["Recipient"],
+                 time_schedualed: response_body["TimeScheduled"],
+                 status: response_body["Status"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end 
+
+    # Get a summarized report for scheduled sent messages.
+    #
+    # @param [String] message_id The ID of the message.
+    #    
+    # @return [String] Success if stopped will return "true" else will return empty "".
+    # @return [String] Code status of the response if 0 its a success else its an error. 
+    def stop_schedualed_messages (message_id)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/StopScheduled")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+      body += "&MessageID=#{message_id}"
+
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200
+        return { success: response_body["Success"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end     
+
+    # The Keyword method enables you to manage your numbers, 
+    # create auto replies to incoming messages or set a webhook directly from your API,
+    # Check Keywords Management to view and edit your keywords.
+    #
+    # @see http://software.unifonic.com/en/inbox/keywords?channel=SMS
+    #
+    # @param [String] number to manage.
+    # @param [String] keyword to use.
+    # @param [String] rule for the keyword.
+    # @param [String, nil] message Set an auto reply to send back to the user (Ex: You have been successfully registered ).
+    # @param [String, nil] webhook_url Defines the source that you want to make the callback to for example “www.google.com”.
+    # @param [String, nil] message_parameter Set the parameters that the source takes for example https://www.google.jo/search?q=hello&oq=hello then your parameters that you have to set are q and oq.
+    # @param [String, nil] recipient_parameter Set the parameters that the source takes for example https://www.google.jo/search?q=hello&oq=hello then your parameters that you have to set are q and oq.
+    # @param [String, nil] request_type Defines the http callback methods , it can be either [Post: Requests data from a specified resource] or [Get: Submits data to be processed to a specified resource].
+    # @param [String, nil] resource_number your inbound number for example 70001.
+    #    
+    # @return [String] Success True, to indicate successfully create of a new keyword.
+    # @return [String] Code status of the response if 0 its a success else its an error. 
+    def keyword (number, keyword, rule, message = nil, webhook_url = nil, message_parameter = nil, recipient_parameter = nil, request_type = nil, resource_number = nil)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/Keyword")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+      body += "&Number=#{number}"
+      body += "&Keyword=#{keyword}"
+      body += "&Rule=#{rule}"
+      body += "&SenderID=#{sender_phone}" unless sender_phone.nil?
+      body += "&Message=#{message}" unless message.nil?
+      body += "&WebhookURL=#{webhook_url}" unless webhook_url.nil?
+      body += "&MessageParameter=#{message_parameter}" unless message_parameter.nil?
+      body += "&RecipientParameter=#{recipient_parameter}" unless recipient_parameter.nil?
+      body += "&RequestType =#{request_type}" unless request_type.nil?
+      body += "&ResourceNumber  =#{resource_number}" unless resource_number.nil?
+
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 
+        return { success: response_body["Success"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end 
+
+    # The Keyword method enables you to manage your numbers, 
+    # create auto replies to incoming messages or set a webhook directly from your API,
+    # Check Keywords Management to view and edit your keywords.
+    #
+    # @see http://software.unifonic.com/en/inbox/keywords?channel=SMS
+    #
+    # @param [String] number to manage.
+    # @param [String, nil] keyword to use.
+    # @param [String, nil] date_from The start date for the report time interval, date format should be yyyy-mm-dd.
+    # @param [String, nil] date_to The end date for the report time interval, date format should be yyyy-mm-dd.    
+    #    
+    # @return [String] Number of messages.
+    # @return [String] message from Recipient number.
+    # @return [Array<Hash>] received message.
+    # @return [String] Code status of the response if 0 its a success else its an error.
+    def inbox (number, keyword = nil, date_from = nil, date_to = nil)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/Inbox")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+      body += "&Number=#{number}"
+      body += "&Keyword=#{keyword}" unless keyword.nil?
+      body += "&FromDate=#{date_from}" unless date_from.nil?
+      body += "&ToDate=#{date_to}" unless date_to.nil?
+
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["data"].nil? 
+        return { number_of_messages: response_body["data"]["NumberOfMessages"],
+                 message_from: response_body["data"]["MessageFrom"],
+                 message: response_body["data"]["Message"],
+                 date_recieved: response_body["data"]["DateReceived"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end   
+
+    # The Keyword method enables you to manage your numbers, 
+    # create auto replies to incoming messages or set a webhook directly from your API,
+    # Check Keywords Management to view and edit your keywords.
+    #
+    # @see http://software.unifonic.com/en/inbox/keywords?channel=SMS
+    #
+    # @param [String, nil] country_code The Country code to check its prices.
+    #    
+    # @return [Hash] Country Data.
+    # @return [String] Country name.
+    # @return [String] Code status of the response if 0 its a success else its an error.
+    def pricing (country_code = nil)
+      # Initialize Request
+      http = Net::HTTP.new('api.unifonic.com', 80)
+      path = base_path("Messages/Pricing")
+      headers = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+
+      # Add Body Parameters to request
+      body = "AppSid=#{api_key}"
+      body += "&CountryCode=#{country_code}" unless country_code.nil?
+
+      # Send Call Request
+      response = http.post(path, body, headers)
+      response_body = JSON.parse(response.body)
+
+      if response.code.to_i == 200 && !response_body["data"].nil? 
+        return { country: response_body["data"]["CountryCode"],
+                 country_name: response_body["data"]["CountryName"],
+                 code: 0 }
+      else
+        result = ErrorCode.get_error_code(response_body["errorCode"]) 
+
+        return result   
+      end   
+    end                                   
+  end
+end

data/lib/unifonic_sms/configuration.rb

@@ -0,0 +1,11 @@
+module UnifonicSms
+  class Configuration
+    
+    attr_accessor :api_key, :sender_phone
+
+    def initialize
+      @api_key = nil
+      @sender_phone = nil
+    end
+  end
+end

data/lib/unifonic_sms/error_code.rb

@@ -0,0 +1,96 @@
+module UnifonicSms
+  module ErrorCode    
+    # Translates the error code returned by the Api call
+    # @see https://unifonic.docs.apiary.io/#reference/errors-list for references
+    #
+    # @param [String] error_code the error code recieved from response.
+    def self.get_error_code(error_code)      
+      case error_code
+        when "ER-01"
+          {error: "Invalid AppSid", code: 1}
+        when "ER-02"
+          {error: "Missing parameter", code: 2}
+        when "ER-03"
+          {error: "Sender ID already exists", code: 3}
+        when "ER-04"
+          {error: "Wrong sender ID format, sender ID should not exceed 11 characters or 16 numbers, only English letters allowed with no special characters or spaces", code: 4}
+        when "ER-05"
+          {error: "Sender ID is blocked and can't be used", code: 5}
+        when "ER-06"
+          {error: "Sender ID doesn't exist", code: 6}
+        when "ER-07"
+          {error: "Default sender ID can't be deleted", code: 7}
+        when "ER-08"
+          {error: "Sender ID is not approved", code: 8}
+        when "ER-09"
+          {error: "No sufficient balance", code: 9}
+        when "ER-10"
+          {error: "Wrong number format , mobile numbers must be in international format without 00 or + Example: (4452023498)", code: 10}
+        when "ER-11"
+          {error: "Unsupported destination", code: 11}
+        when "ER-12"
+          {error: "Message body exceeded limit", code: 12}
+        when "ER-13"
+          {error: "Service not found", code: 13}
+        when "ER-14"
+          {error: "Sender ID is blocked on the required destination", code: 14}
+        when "ER-15"
+          {error: "User is Not active", code: 15}
+        when "ER-16"
+          {error: "Exceed throughput limit", code: 16}
+        when "ER-17"
+          {error: "Inappropriate content in message body", code: 17}
+        when "ER-18"
+          {error: "Invalid Message ID", code: 18}
+        when "ER-19"
+          {error: "Wrong date format, date format should be yyyy-mm-dd", code: 19}
+        when "ER-20"
+          {error: "Page limit Exceeds (10000)", code: 20}
+        when "ER-21"
+          {error: "Method not found.", code: 21}
+        when "ER-22"
+          {error: "Language not supported", code: 22}
+        when "ER-23"
+          {error: "You have exceeded your Sender ID's requests limit, delete one sender ID to request a new one", code: 23}
+        when "ER-24"
+          {error: "Wrong Status data , message status should be one of the following statuses \"Queued\" , \"Sent\" , \"Failed\" or \"Rejected\"", code: 24}
+        when "ER-25"
+          {error: "This request is not included in your account plan", code: 25}
+        when "ER-26"
+          {error: "Invalid Call ID", code: 26}
+        when "ER-27"
+          {error: "Wrong Status Data", code: 27}
+        when "ER-28"
+          {error: "Wrong Email Format", code: 28}
+        when "ER-29"
+          {error: "Invalid Email ID", code: 29}
+        when "ER-30"
+          {error: "Invalid Security Type", code: 30}
+        when "ER-31"
+          {error: "Wrong Passcode", code: 31}
+        when "ER-32"
+          {error: "Passcode expired", code: 32}
+        when "ER-33"
+          {error: "Wrong channel type, Channel value should be TextMessage, Call or Both", code: 33}
+        when "ER-34"
+          {error: "Wrong time to live value TTL, TTL should be between 1 and 60 minutes, and should not exceed the Expiry time", code: 34}
+        when "ER-35"
+          {error: "MessageID already sent", code: 35}
+        when "ER-36"
+          {error: "Wrong voice type, voice value should be Male or Female", code: 36}
+        when "ER-37"
+          {error: "", code: 37}
+        when "ER-38"
+          {error: "Invalid number; number is not available or had expired for the submitted AppSid", code: 38}
+        when "ER-39"
+          {error: "Invalid Rule ; rule should be: Is, StartsWith, Contains, Any. Only \"Is\" is available for a shared number", code: 39}
+        when "ER-40"
+          {error: "Keyword not defined", code: 40}
+        when "ER-41"
+          {error: "Invalid Country code", code: 41}
+        else 
+          {error: "Unknown error code", code: error_code}
+      end
+    end
+  end
+end

data/lib/unifonic_sms/normalizer.rb

@@ -0,0 +1,29 @@
+module UnifonicSms
+  module Normalizer
+    # Normalize phone numbers to be used by Unifonic
+    # must remove any '+' or '0' at the start.
+    #
+    # @param [String] number the phone number to be normalized.
+    #
+    # @example Normalize a phone number
+    #   "Normalizer.normalize_number('+01234667876')" #=> "1234667876" 
+    def self.normalize_number(number)
+      n = number.dup
+      while n.start_with?('+') || n.start_with?('0')
+        n.slice!(0)
+      end
+      return n
+    end
+
+    # Normalize message to be used by Unifonic
+    # must be in UTF-8 Encoding.
+    #
+    # @param [String] message the message that will be sent.
+    #
+    # @example Normalize an SMS message
+    #   "Normalizer.normalize_message('Test Message').encoding" #=> "UTF_8" 
+    def self.normalize_message(message)
+      message.encode(Encoding::UTF_8)
+    end
+  end
+end

data/lib/unifonic_sms/version.rb

@@ -0,0 +1,4 @@
+module UnifonicSms
+  # Gem Version
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: unifonic_sms
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Assen Deghady
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.1.1
+description: 
+email:
+- assem.deghady@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/unifonic_sms.rb
+- lib/unifonic_sms/configuration.rb
+- lib/unifonic_sms/error_code.rb
+- lib/unifonic_sms/normalizer.rb
+- lib/unifonic_sms/version.rb
+homepage: https://github.com/AssemDeghady/unifonic_sms
+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.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Send SMS messages using Unifonic Api.
+test_files: []