africastalking-ruby 1.0.0 → 2.0.0

data/lib/AfricasTalking/Sms.rb

@@ -0,0 +1,242 @@
+class Sms
+	include AfricasTalking
+
+	HTTP_CREATED     = 201
+	HTTP_OK          = 200
+
+	#Set debug flag to to true to view response body
+
+	def initialize username, apikey
+		@username    = username
+		@apikey      = apikey
+	end
+
+	# def initialize
+	# 	super
+	# end
+
+	
+	def send options
+		# 
+		post_body = {
+
+			'username'    => @username, 
+			'message'     => options['message'], 
+			'to'          => options['to']
+		}	
+		if options['from'] != nil
+			post_body['from'] = options['from']
+		end
+		if options['enqueue'] != nil
+			post_body['enqueue'] = options['enqueue']
+		end
+		if options['bulkSMSMode'] != nil
+			post_body['bulkSMSMode'] = options['bulkSMSMode']
+		end
+		if options['retryDurationInHours'] != nil
+			post_body['retryDurationInHours'] = options['retryDurationInHours']
+		end
+		# 
+		if validateParamsPresence?(options, ['message', 'to'])
+			response = sendNormalRequest(getSmsUrl(), post_body)
+		end
+		if @response_code == HTTP_CREATED
+			messageData = JSON.parse(response,:quirks_mode=>true)["SMSMessageData"]
+			recipients = messageData["Recipients"]
+			
+			if recipients.length > 0
+				reports = recipients.collect { |entry|
+					StatusReport.new entry["number"], entry["status"], entry["cost"], entry["messageId"]
+				}
+				# 
+				return reports
+			end
+			
+			raise AfricasTalkingException, messageData["Message"]
+			
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
+	def sendPremium options
+		post_body = {
+			'username'    => @username, 
+			'message'     => options['message'], 
+			'to'          => options['to'],
+			'keyword'     => options['keyword'],
+			'linkId'      => options['linkId'],
+		}
+		if options['retryDurationInHours'] != nil
+			post_body['retryDurationInHours'] = options['retryDurationInHours']
+		end
+		if options['bulkSMSMode'] != nil
+			post_body['bulkSMSMode'] = options['bulkSMSMode']
+		end
+		if options['enqueue'] != nil
+			post_body['enqueue'] = options['enqueue']
+		end
+		if options['from'] != nil
+			post_body['from'] = options['from']
+		end
+		# 
+		if validateParamsPresence?(options, ['message', 'to', 'keyword', 'linkId'])
+			response = sendNormalRequest(getSmsUrl(), post_body)
+		end
+		
+		# 
+		if @response_code == HTTP_CREATED
+			messageData = JSON.parse(response,:quirks_mode=>true)["SMSMessageData"]
+			recipients = messageData["Recipients"]
+			
+			if recipients.length > 0
+				reports = recipients.collect { |entry|
+					StatusReport.new entry["number"], entry["status"], entry["cost"], entry["messageId"]
+				}
+				return SendPremiumMessagesResponse.new reports, messageData["Message"]
+			end
+			
+			raise AfricasTalkingException, messageData["Message"]
+			
+		else
+			raise AfricasTalkingException, response
+		end
+
+		# 
+	end
+
+	def fetchMessages options
+		url = getSmsUrl() + "?username=#{@username}&lastReceivedId=#{options['last_received_id']}"
+		response = sendNormalRequest(url)
+		if @response_code == HTTP_OK
+			messages = JSON.parse(response, :quirky_mode => true)["SMSMessageData"]["Messages"].collect { |msg|
+				SMSMessages.new msg["id"], msg["text"], msg["from"] , msg["to"], msg["linkId"], msg["date"]
+			}
+				# messages
+
+			return FetchMessagesResponse.new messages
+
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
+	def fetchSubscriptions options
+		if validateParamsPresence?(options, ['shortCode', 'keyword'])
+			url = getSmsSubscriptionUrl() + "?username=#{@username}&shortCode=#{options['shortCode']}&keyword=#{options['keyword']}&lastReceivedId=#{options['lastReceivedId']}"
+			response = sendNormalRequest(url)
+		end
+		if(@response_code == HTTP_OK)
+			# 
+			subscriptions = JSON.parse(response)['responses'].collect{ |subscriber|
+				PremiumSubscriptionNumbers.new subscriber['phoneNumber'], subscriber['id'], subscriber['date']
+			}
+			# 
+			return subscriptions
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
+	def createSubcription options
+		post_body = {
+						'username'    => @username,
+						'phoneNumber' => options['phoneNumber'],
+						'shortCode'   => options['shortCode'],
+						'keyword'     => options['keyword']
+					}
+		if options['checkoutToken'] != nil
+			post_body['checkoutToken'] = options['checkoutToken']
+		end
+		url = getSmsSubscriptionUrl() + "/create"
+		if validateParamsPresence?(options, ['shortCode', 'keyword', 'phoneNumber'])
+			response = sendNormalRequest(url, post_body)
+		end
+		if(@response_code == HTTP_CREATED)
+			r = JSON.parse(response, :quirky_mode => true)
+			return CreateSubscriptionResponse.new r['status'], r['description'] 
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
+	private
+
+		def getSmsUrl()
+			return  getApiHost() + "/version1/messaging"
+		end
+
+		def getSmsSubscriptionUrl()
+			return getApiHost() + "/version1/subscription"
+		end
+
+		def getApiHost()
+			if(@username == "sandbox")
+				return "https://api.sandbox.africastalking.com"
+			else
+				return "https://api.africastalking.com"
+			end
+		end
+end
+# ////////////////////////
+
+class StatusReport
+	attr_reader :number, :status, :cost, :messageId
+
+	def initialize(number_, status_, cost_,messageId_)
+		@number = number_
+		@status = status_
+		@cost   = cost_
+		@messageId = messageId_
+	end
+end
+
+class PremiumSubscriptionNumbers
+	attr_reader :phoneNumber, :id, :date
+
+	def initialize number_, id_, date_
+		@phoneNumber = number_
+		@id     = id_
+		@date = date_
+	end
+end
+
+
+class FetchMessagesResponse
+	attr_reader :responses, :status 
+	def initialize responses_, status_= nil
+		@responses = responses_
+		@status = status_
+	end
+end
+
+class CreateSubscriptionResponse
+	attr_reader :status, :description
+	def initialize status_, description_
+		@description = description_
+		@status = status_
+	end
+end
+
+
+class SendPremiumMessagesResponse
+	attr_reader :recipients, :overview 
+	def initialize recipients_, overview_
+		@recipients = recipients_
+		@overview = overview_
+	end
+end
+
+class SMSMessages
+	attr_reader :id, :text, :from, :to, :linkId, :date
+
+	def initialize(id_, text_, from_, to_, linkId_, date_)
+		@id     = id_
+		@text   = text_
+		@from   = from_
+		@to     = to_
+		@linkId = linkId_
+		@date   = date_
+	end
+end
+

data/lib/AfricasTalking/Token.rb

@@ -0,0 +1,66 @@
+class Token
+	include AfricasTalking
+	HTTP_CREATED     = 201
+	HTTP_OK          = 200
+
+	#Set debug flag to to true to view response body
+	def initialize username, apikey
+		@username    = username
+		@apikey      = apikey
+	end
+
+	def generateAuthToken
+		post_body = {
+			'username' => @username
+		}
+		url = getApiHost() + "/auth-token/generate"
+		response = sendJSONRequest(url, post_body)
+		# 
+		if(@response_code == HTTP_CREATED)
+			r=JSON.parse(response, :quirky_mode => true)
+			return AuthTokenResponse.new r["token"], r["lifetimeInSeconds"]
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
+	def createCheckoutToken options
+		post_body = {
+			'phoneNumber' => options['phoneNumber']
+		}
+		url = getApiHost() + "/checkout/token/create"
+		response = sendNormalRequest(url, post_body)
+		# 
+		if(@response_code == HTTP_CREATED)
+			r= JSON.parse(response, :quirky_mode => true)
+			return CheckoutTokenResponse.new r['token'], r['description']
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
+	private
+
+		def getApiHost()
+			if(@username == "sandbox")
+				return "https://api.sandbox.africastalking.com"
+			else
+				return "https://api.africastalking.com"
+			end
+		end
+end
+
+class AuthTokenResponse
+	attr_accessor :token, :lifetimeInSeconds
+	def initialize token_, lifetimeInSeconds_
+		@token      = token_
+		@lifetimeInSeconds = lifetimeInSeconds_
+	end
+end
+class CheckoutTokenResponse
+	attr_accessor :token, :description
+	def initialize token_, description_
+		@token      = token_
+		@description = description_
+	end
+end

data/lib/AfricasTalking/Voice.rb

@@ -0,0 +1,141 @@
+class Voice
+	include AfricasTalking
+	HTTP_CREATED     = 201
+	HTTP_OK          = 200
+
+	#Set debug flag to to true to view response body
+
+	def initialize username, apikey
+		@username    = username
+		@apikey      = apikey
+	end
+
+	def call options
+		if validateParamsPresence?(options, ['from', 'to'])
+			post_body = {
+				'username' => @username, 
+				'from'     => options['from'], 
+				'to'       => options['to']
+			}
+			# 
+			response = sendNormalRequest(getVoiceHost() + "/call", post_body)
+		end
+		if(@response_code == HTTP_OK || @response_code == HTTP_CREATED)
+			ob = JSON.parse(response, :quirky_mode => true)
+			# 
+			if (ob['entries'].length > 0)
+				results = ob['entries'].collect{|result|
+					CallEntries.new result['status'], result['phoneNumber']
+				}
+			end
+			return CallResponse.new results, ob['errorMessage']
+			# 
+		else
+			raise AfricasTalkingException, response
+		end
+	end
+
+	def fetchQueuedCalls options
+		if validateParamsPresence?(options, ['phoneNumber'])
+			post_body = {
+				'username'    => @username,
+				'phoneNumbers' => options['phoneNumber'],
+			}
+
+			url = getVoiceHost() + "/queueStatus"
+			response = sendNormalRequest(url, post_body)
+		end
+		# 
+		if(@response_code == HTTP_OK || @response_code == HTTP_CREATED)
+			ob = JSON.parse(response, :quirky_mode => true)
+			results = []
+			if (ob['entries'].length > 0)
+				results = ob['entries'].collect{|result|
+					QueuedCalls.new result['phoneNumber'], result['numCalls'], result['queueName']
+				}
+			end
+			# 
+			return QueuedCallsResponse.new ob['status'], ob['errorMessage'], results
+		end
+		
+		raise AfricasTalkingException, response
+		
+	end
+
+	def uploadMediaFile options
+		if validateParamsPresence?(options, ['url','phoneNumber'])
+			
+			post_body = {
+							'username' => @username,
+							'url'      => options['url'],
+							'phoneNumber' => options['phoneNumber']
+						}
+			url = getVoiceHost() + "/mediaUpload"
+			# 
+			response = sendNormalRequest(url, post_body)
+		end
+		if(@response_code == HTTP_OK || @response_code == HTTP_CREATED)
+			return UploadMediaResponse.new response
+		end
+		# 
+		raise AfricasTalkingException, response
+	end
+
+
+	private
+		def getVoiceHost()
+			if(@username == "sandbox")
+				return "https://voice.sandbox.africastalking.com"
+			else
+				return "https://voice.africastalking.com"
+			end
+		end
+
+end
+
+
+class CallResponse
+	attr_reader :errorMessage, :entries
+
+	def initialize(entries_, errorMessage_)
+		@errorMessage      = errorMessage_
+		@entries = entries_
+	end
+end
+
+class CallEntries
+	attr_reader :status, :phoneNumber
+
+	def initialize(status_, number_)
+		@status      = status_
+		@phoneNumber = number_
+	end
+end
+
+class QueuedCalls
+	attr_reader :numCalls, :phoneNumber, :queueName
+	
+	def initialize(number_, numCalls_, queueName_)
+		@phoneNumber = number_
+		@numCalls    = numCalls_
+		@queueName   = queueName_
+	end
+end
+
+class QueuedCallsResponse
+	attr_reader :status, :errorMessage, :entries
+
+	def initialize(status_, errorMessage_, entries_)
+		@status = status_
+		@errorMessage    = errorMessage_
+		@entries   = entries_
+	end
+end
+
+class UploadMediaResponse
+	attr_reader :status
+	def initialize status
+		@status = status
+	end
+end
+

data/lib/AfricasTalking/version.rb

@@ -0,0 +1,3 @@
+module AfricasTalking
+  VERSION = "2.0.0"
+end

data/lib/AfricasTalking.rb

@@ -0,0 +1,118 @@
+require "AfricasTalking/version"
+require 'httparty'
+require "AfricasTalking/Sms"
+require "AfricasTalking/Airtime"
+require "AfricasTalking/Payments"
+require "AfricasTalking/Voice"
+require "AfricasTalking/Token"
+require "AfricasTalking/Application"
+
+module AfricasTalking
+	DEBUG            = false
+	@username = nil
+	@apikey = nil
+	@response_code = nil
+
+	class Initialize
+		attr_accessor :username, :apikey
+		def initialize username, apikey
+			@username    = username
+			@apikey      = apikey 
+		end
+		
+		def sms
+			return Sms.new @username, @apikey		
+		end
+	
+		def payments
+			return Payments.new @username, @apikey
+		end
+	
+		def airtime
+			return Airtime.new @username, @apikey
+		end
+	
+		def voice
+			return Voice.new @username, @apikey
+		end
+	
+		def token
+			return Token.new @username, @apikey
+		end
+	
+		def application
+			return Application.new @username, @apikey
+		end
+	end
+
+	class AfricasTalkingException < Exception
+		# error handling appear here
+		# def initialize(msg="My default message")
+		#     super
+		# end
+
+	end
+
+
+	private 
+		
+		def sendNormalRequest url_, data_ = nil
+			uri		 	     = URI.parse(url_)
+			http		     = Net::HTTP.new(uri.host, uri.port)
+			http.use_ssl     = true
+			headers = {
+				"apikey" => @apikey,
+				"Accept" => "application/json"
+			}
+			if(data_ != nil)
+				request = Net::HTTP::Post.new(uri.request_uri)
+				request.set_form_data(data_)
+			else
+				request = Net::HTTP::Get.new(uri.request_uri)
+			end
+			request["apikey"] = @apikey
+			request["Accept"] = "application/json"
+			response          = http.request(request)
+
+			if (DEBUG)
+				puts "Full response #{response.body}"
+			end
+
+			@response_code = response.code.to_i
+			return response.body
+		end
+
+		def sendJSONRequest (url_, data_)
+			uri	       = URI.parse(url_)
+			http         = Net::HTTP.new(uri.host, uri.port)
+			http.use_ssl = true
+			req          = Net::HTTP::Post.new(uri.request_uri, 'Content-Type'=>"application/json")
+			
+			req["apikey"] = @apikey
+			req["Accept"] = "application/json"
+			
+			req.body = data_.to_json
+
+			response  = http.request(req)
+			
+			if (DEBUG)
+				puts "Full response #{response.body}"
+			end
+
+			@response_code = response.code.to_i
+			return response.body
+		end
+
+		def validateParamsPresence? params, values
+			status =  values.each{ |v|
+				if !params.key?(v)
+					raise AfricasTalkingException, "Please make sure your params has key #{v}"
+				elsif v.empty?
+					raise AfricasTalkingException, "Please make sure your key #{v} is not empty"
+				end
+			}
+			return true
+
+		end
+			
+end