africastalking-ruby 2.1.7 → 2.1.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2d722d05cc6899aee30f158a0f27ccb5f0b76622967212a8bde12d0c81954501
-  data.tar.gz: b16602ad3063feac0786308f60e7f94a3066e4ad0e5052c5c7972e7ab6c46078
+  metadata.gz: d1caf1f74d9b3372cbc660fa10382e4fdc5b9c0bf6a56b5bbc3db624efa68fe8
+  data.tar.gz: 7225710bdc096661538b16c80ac95c9131d85602f3e7defdc078a9c2104e796d
 SHA512:
-  metadata.gz: 39219fd71b9e35e731d38899131430596e950eb9c962af9c01f4c6af4cd388580f711d27ffcd42983083f5df9986878e5ef6f688af0ff060a2b60d4d0b551c3d
-  data.tar.gz: e8580c4b2fb9dd1579f57dd7a97ac075a1b83f57c20563ca76cd8bcaad17d8fdf444286d7951aed5959d0bfe078b49251cebb246b178273a64c5f40e1e5ec708
+  metadata.gz: e5b1b59ee256c9d6f10b37ebcb0e1fe903766fc51e879c3c18f51ce7948e30731c8de594206d3de9ef82ebfafec82c60c5c08060dc899a72be16f564cbdcac5e
+  data.tar.gz: d6bceffcbede1d93df1872eb84749db148659fe6d6a3f2f91dacd48bc537f633d7fafb30b01e1d9353c8086a748dbb86aba85bebbc4d81d8de5eb334b6b8f97f

data/.gitignore

@@ -6,6 +6,7 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem
 
 # rspec failure tracking
 .rspec_status

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    africastalking-ruby (2.1.5.beta.1)
+    africastalking-ruby (2.1.9)
       httparty (= 0.16.1)
 
 GEM
@@ -114,7 +114,7 @@ DEPENDENCIES
   pry (~> 0)
   rake (~> 10.0)
   rspec (~> 3.0)
-  rspec-rails (~> 3.7.2)
+  rspec-rails (~> 3.7, >= 3.7.2)
   rubocop (~> 0.54.0)
 
 BUNDLED WITH

data/README.md

@@ -68,6 +68,8 @@ airtime.send options
         - `currency`:3-digit ISO format currency code . `REQUIRED`
         - `amount`: Amount sent `>= 10 && <= 10K` with currency e.g `KES 100` `REQUIRED`
 
+ - `maxNumRetry`: This allows you to specify the maximum number of retries in case of failed airtime deliveries due to various reasons such as telco unavailability. The default retry period is 8 hours and retries occur every 60seconds. For example, setting `maxNumRetry=4` means the transaction will be retried every 60seconds for the next 4 hours.`OPTIONAL`.
+  
 ### Sms
 
 ```ruby
@@ -178,6 +180,41 @@ account = @AT.account
 account.fetchUserData
 ```
 
+### Mobile Data
+
+Send mobile data to phone numbers
+
+```ruby
+mobiledata = @AT.mobiledata
+
+mobiledata.send options
+```
+- `options`
+    - `productName`:  This is the application's product name. `REQUIRED`
+    - `recipients`: An array of objects containing the following keys:
+
+        - `phoneNumber`: Recipient of the mobile data. `REQUIRED`
+        - `quantity`:  a numeric value for the amount of mobile data. It is based on the available mobile data package[(see "Bundle Package" column of mobile data pricing)](https://africastalking.com/pricing). `REQUIRED`
+        - `unit`: The units for the specified data quantity, the format is: ``MB`` or ``GB``. It is based on the available mobile data package[(see "Bundle Package" column of mobile data pricing)](https://africastalking.com/pricing). `REQUIRED`
+        - `validity`: The period of the data bundle’s validity this can be `Day`, `Week`, `BiWeek`, `Month`, or `Quarterly`. It is based on the available mobile data package [(see "Validity" column of mobile data pricing)](https://africastalking.com/pricing). `REQUIRED`
+        - `metadata`:  A JSON object of any metadata that you would like us to associate with the request. `OPTIONAL`
+
+#### Find Transaction
+```ruby
+mobiledata.findTransaction options
+```
+- Find a mobile data transaction
+- `options`
+    - `transactionId`: ID of trancation to find `REQUIRED`
+
+#### Fetch Wallet Balance
+```ruby
+mobiledata.fetchWalletBalance
+```
+- Fetch a mobile data product balance
+
+For more information, please read the [https://developers.africastalking.com/docs/data/overview](https://developers.africastalking.com/docs/data/overview) 
+
 ### Payments
 ```ruby
 payments = @AT.payments
@@ -327,19 +364,7 @@ payments.mobileB2B options
     - `requester`: PhoneNumber through which KPLC will send tokens when using B2B to buy electricity tokens.
     - `metadata`: Some optional data to associate with transaction.`REQUIRED`
 
-#### Mobile Data
-```ruby
-payments.mobileData options
-```
-- `options`
-    - `productName`: Your Payment Product. `REQUIRED`
-    - `recipients`: A list of recipients. Each recipient has:
 
-        - `phoneNumber`: Customer phone number (in international format). `REQUIRED`
-        - `quantity`: Mobile data amount. `REQUIRED`
-        - `unit`: Mobile data unit. Can either be `MB` or `GB`. `REQUIRED`
-        - `validity`: How long the mobile data is valid for. Must be one of `Day`, `Week` and `Month`. `REQUIRED`
-        - `metadata`: Additional data to associate with the transaction. `REQUIRED`
 
 #### Wallet Transfer
 ```ruby
@@ -392,18 +417,7 @@ payments.fetchWalletTransactions options
         - `endDate`: End Date to consider when fetching
         - `categories`: Comma delimited list of categories to consider when fetching
 
-#### Find Transaction
-```ruby
-payments.findTransaction options
-```
-- `options`
-    - `transactionId`: ID of trancation to find `REQUIRED`
 
-#### Fetch Wallet Balance
-```ruby
-payments.fetchWalletBalance
-```
-- Fetch your payment wallet balance
 
 
 ## Development

data/lib/AfricasTalking/Airtime.rb

@@ -12,15 +12,23 @@ class Airtime
 	def send options
 		url      = getAirtimeUrl() + "/send"
 
-		recipients = options.each{|item| 
+		recipients = options['recipients'].each{|item| 
 			validateParamsPresence? item, %w(phoneNumber currencyCode amount)
 			item['amount'].to_s.prepend(item['currencyCode'].to_s + " ") 
 			item.delete('currencyCode')
 		}
 		post_body = {
-					'username'   => @username,
-					'recipients' => recipients.to_json,
-				}
+			'username'   => @username,
+			'recipients' => recipients.to_json,
+		}
+
+		if options['maxNumRetry'] && options['maxNumRetry'] > 0
+            post_body['maxNumRetry'] = options['maxNumRetry'].to_i
+
+        else
+            puts "Please make sure #{options['maxNumRetry']} is a number and greater than zero!"
+        end
+
 		response = sendNormalRequest(url, post_body) 
 		if (@response_code == HTTP_CREATED)
 			responses = JSON.parse(response, :quirky_mode =>true)

data/lib/AfricasTalking/Mobiledata.rb

@@ -0,0 +1,159 @@
+class Mobiledata
+	include AfricasTalking
+	HTTP_CREATED     = 201
+	HTTP_OK          = 200
+
+	def initialize username, apikey
+		@username    = username
+		@apikey      = apikey
+	end
+
+	def send options
+		url      = getMobileDataUrl()
+
+        validateParamsPresence? options, %w(productName)
+		recipients = options['recipients'].map do |item|
+            required_params = %w(phoneNumber quantity unit validity)
+            if item['metadata'].is_a?(Hash)
+                required_params << 'metadata'
+              end
+
+            validateParamsPresence?(item, required_params)
+			item
+		end
+
+		post_body = {
+			'username'   => @username,
+            'productName' => options['productName'],
+			'recipients' => recipients,
+		}
+
+		idempotency_key = options['idempotencyKey'].to_s if options['idempotencyKey']
+
+		post_body['idempotencyKey'] = idempotency_key if idempotency_key
+
+		response = sendJSONRequest(url, post_body, idempotency_key)
+
+		if (@response_code == HTTP_CREATED)
+			responses = JSON.parse(response, :quirky_mode =>true)
+
+			if (responses['entries'].length > 0)
+
+				results = responses['entries'].collect{ |data|
+
+					MobileDataResponse.new data['phoneNumber'], data['provider'], data['status'], data['transactionId'], data['value']
+				}
+
+				return results
+			else
+				raise AfricasTalkingException, responses['errorMessage']
+			end
+			raise AfricasTalkingException, response
+		end
+	end
+
+    def findTransaction options
+		validateParamsPresence? options, ['transactionId']
+		parameters = {
+			'username'    => @username,
+			'transactionId' => options['transactionId']
+		}
+		url      = getFindTransactionUrl()
+		response = sendJSONRequest(url, parameters, true, false)
+		if (@response_code == HTTP_OK)
+			resultObj = JSON.parse(response, :quirky_mode =>true)
+			transactionData = nil
+			if resultObj['status'] === 'Success'
+				transactionData = TransactionData.new resultObj['data']['requestMetadata'], resultObj['data']['sourceType'],resultObj['data']['source'], resultObj['data']['provider'], resultObj['data']['destinationType'],resultObj['data']['description'],
+					resultObj['data']['providerChannel'], resultObj['data']['providerRefId'], resultObj['data']['providerMetadata'],resultObj['data']['status'], resultObj['data']['productName'], resultObj['data']['category'],
+					resultObj['data']['transactionDate'], resultObj['data']['destination'], resultObj['data']['value'], resultObj['data']['transactionId'], resultObj['data']['creationTime']
+			end
+			return FindTransactionResponse.new resultObj['status'], transactionData
+		end
+		raise AfricasTalkingException, response
+	end
+
+    def fetchWalletBalance
+		parameters = { 'username' => @username }
+		url        = getFetchWalletBalanceUrl()
+		response = sendJSONRequest(url, parameters, true, false)
+		if (@response_code == HTTP_OK)
+			resultObj = JSON.parse(response, :quirky_mode =>true)
+
+			return FetchWalletBalanceResponse.new resultObj['status'], resultObj['balance']
+		end
+		raise AfricasTalkingException, response
+	end
+
+	private
+		def getMobileDataUrl()
+			return getApiHost() + "/mobile/data/request"
+		end
+
+        def getFindTransactionUrl()
+			return getApiHost() + "/query/transaction/find"
+		end
+
+        def getFetchWalletBalanceUrl()
+			return getApiHost() + "/query/wallet/balance"
+		end
+
+		def getApiHost()
+			if(@username == "sandbox")
+				return "https://bundles.sandbox.africastalking.com"
+			else
+				return "https://bundles.africastalking.com"
+			end
+		end
+end
+
+class MobileDataResponse
+	attr_reader :phoneNumber, :provider, :status, :transactionId, :value
+
+	def initialize phoneNumber_, provider_, status_, transactionId_, value_
+			@phoneNumber     = phoneNumber_
+			@provider        = provider_
+			@status          = status_
+            @transactionId   = transactionId_
+			@value           = value_
+	end
+end
+
+class FetchWalletBalanceResponse
+	attr_reader :status, :balance
+	def initialize status_, balance_
+		@status = status_
+		@balance = balance_
+	end
+end
+
+class FindTransactionResponse
+	attr_reader :status, :transactionData
+	def initialize status_, transactionData_
+		@status = status_
+		@transactionData = transactionData_
+	end
+end
+
+class TransactionData
+	attr_reader :requestMetadata, :sourceType, :source, :provider, :destinationType, :description, :providerChannel, :providerRefId, :providerMetadata, :status, :productName, :category, :transactionDate, :destination, :value, :transactionId, :creationTime
+	def initialize requestMetadata_, sourceType_, source_, provider_, destinationType_, description_, providerChannel_, providerRefId_, providerMetadata_, status_, productName_, category_, transactionDate_, destination_, value_, transactionId_, creationTime_
+		@requestMetadata =requestMetadata_
+		@sourceType = sourceType_
+		@source = source_
+		@provider = provider_
+		@destinationType = destinationType_
+		@description = description_
+		@providerChannel = providerChannel_
+		@providerRefId = providerRefId_
+		@providerMetadata = providerMetadata_
+		@status = status_
+		@productName = productName_
+		@category = category_
+		@transactionDate = transactionDate_
+		@destination = destination_
+		@value = value_
+		@transactionId = transactionId_
+		@creationTime = creationTime_
+	end
+end

data/lib/AfricasTalking/version.rb

@@ -1,3 +1,3 @@
 module AfricasTalking
-  VERSION = "2.1.7"
+  VERSION = "2.1.9"
 end

data/lib/AfricasTalking.rb

@@ -3,6 +3,7 @@ require 'httparty'
 require "AfricasTalking/Sms"
 require "AfricasTalking/Airtime"
 require "AfricasTalking/Payments"
+require "AfricasTalking/Mobiledata"
 require "AfricasTalking/Voice"
 require "AfricasTalking/Token"
 require "AfricasTalking/Application"
@@ -17,29 +18,33 @@ module AfricasTalking
 		attr_accessor :username, :apikey
 		def initialize username, apikey
 			@username    = username
-			@apikey      = apikey 
+			@apikey      = apikey
 		end
-		
+
 		def sms
-			return Sms.new @username, @apikey		
+			return Sms.new @username, @apikey
 		end
-	
+
 		def payments
 			return Payments.new @username, @apikey
 		end
-	
+
+		def mobiledata
+			return Mobiledata.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
@@ -54,8 +59,8 @@ module AfricasTalking
 	end
 
 
-	private 
-		
+	private
+
 		def sendNormalRequest url_, data_ = nil
 			uri		 	     = URI.parse(url_)
 			http		     = Net::HTTP.new(uri.host, uri.port)
@@ -78,7 +83,7 @@ module AfricasTalking
 			return response.body
 		end
 
-		def sendJSONRequest url_, data_, get_request = false
+		def sendJSONRequest url_, data_, get_request = false, idempotency_key
 			uri	       = URI.parse(url_)
 			http         = Net::HTTP.new(uri.host, uri.port)
 			http.use_ssl = true
@@ -88,11 +93,18 @@ module AfricasTalking
 			else
 				req = Net::HTTP::Post.new(uri.request_uri, 'Content-Type'=>"application/json")
 				req.body = data_.to_json
+
 			end
-			
+
 			req["apikey"] = @apikey
 			req["Accept"] = "application/json"
+
+			if idempotency_key
+				req['Idempotency-Key'] = idempotency_key
+			end
+
 			response  = http.request(req)
+
 			if (DEBUG)
 				puts "Full response #{response.body}"
 			end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: africastalking-ruby
 version: !ruby/object:Gem::Version
-  version: 2.1.7
+  version: 2.1.9
 platform: ruby
 authors:
 - Michael Mwirigi
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-05-21 00:00:00.000000000 Z
+date: 2023-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -135,6 +135,7 @@ files:
 - lib/AfricasTalking.rb
 - lib/AfricasTalking/Airtime.rb
 - lib/AfricasTalking/Application.rb
+- lib/AfricasTalking/Mobiledata.rb
 - lib/AfricasTalking/Payments.rb
 - lib/AfricasTalking/Sms.rb
 - lib/AfricasTalking/Token.rb
@@ -159,7 +160,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.8
 signing_key: 
 specification_version: 4
 summary: Simple gem that helps you build integrations with AfricasTalking