mpesarb 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68d96fb20a2f0f9d3f463f6bb4b0d6d1e520c20d1c11f2d2a938aaf451d4ef4e
-  data.tar.gz: 92017a2a811f1f6de9f233c083be65b892ebb591bbc2c392dd31aeedac9a4212
+  metadata.gz: f58f3c8c8bb861948c8c2418733a9dea0ab7d51de6be5a8366503c4d778c9949
+  data.tar.gz: 79cdd313fc5da2e6aa4d01cbc399a4756726949d353285991ed6ec7a6a75d33b
 SHA512:
-  metadata.gz: 3c23bd5e3eb258bf86062cfbdc5bde0745617c5d6cb8f59da3927333331ab231e1c6c8d6c1296d5b342594b7cc7acb73d4f1c8c6ddc218de39389a79f58e37e6
-  data.tar.gz: ded8afec648b6cd69b45d4d0b4f958c27c43dbe7b2113e939c4c4f83aaeb807dc5e8e7c2091ed609709b32673f8f47c47c28b9e80b1c166049c91ebf0f9cd56e
+  metadata.gz: 1c8ca8bbf672b89f9fc73516000e487397f9e5aec26c35e0d12131a5e1e9a28519adc3f4bd4dad5d29304794f2052c765a68009d7ce1e47e2e91a557735629e8
+  data.tar.gz: bff2fd36423ad9d2601a4b5f733c1644dc00cc82ba5a33c5b49e87c3f5916533cf75496d80a72476d4cc4fb7c4bff5468175affd9f5891053f963be96402c77c

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-### Unreleased
+### 2022-01-04
+- Support `response` `to_hash` method
+### 2020-01-20
 - Update gemspec
 - Read certificate full path
 - Return early if get access token fail

data/Gemfile

@@ -1,4 +1,6 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in mpesa.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mpesarb (0.3.0)
+    mpesarb (0.3.1)
       activesupport (>= 5.0.0)
       faraday (>= 1.1)
       faraday_middleware (~> 1.1)
@@ -10,7 +10,7 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (6.1.4.1)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -32,7 +32,7 @@ GEM
     crack (0.4.5)
       rexml
     docile (1.4.0)
-    faraday (1.7.1)
+    faraday (1.8.0)
       faraday-em_http (~> 1.0)
       faraday-em_synchrony (~> 1.0)
       faraday-excon (~> 1.1)
@@ -51,11 +51,12 @@ GEM
     faraday-net_http_persistent (1.2.0)
     faraday-patron (1.0.0)
     faraday-rack (1.0.0)
-    faraday_middleware (1.1.0)
+    faraday_middleware (1.2.0)
       faraday (~> 1.0)
     hashdiff (1.0.1)
     i18n (1.8.10)
       concurrent-ruby (~> 1.0)
+    ipaddr (1.2.3)
     json (2.5.1)
     method_source (1.0.0)
     minitest (5.14.4)
@@ -65,7 +66,8 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     multipart-post (2.1.1)
-    openssl (2.2.0)
+    openssl (2.2.1)
+      ipaddr
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
@@ -95,10 +97,11 @@ GEM
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (>= 2.1.4)
@@ -113,4 +116,4 @@ DEPENDENCIES
   webmock (~> 3.7)
 
 BUNDLED WITH
-   2.2.17
+   2.2.27

data/README.md

@@ -12,7 +12,7 @@ This Gem provides an interface that developers can use to convert JSON to `OpenS
 
 Install via `Gemfile`
 ```
-gem 'mpesarb', '~> 0.3.0'
+gem 'mpesarb', '~> 0.3.2'
 ```
 
 Or
@@ -100,6 +100,44 @@ respose.ResponseDescription # "Accept the service request successfully."
 
 ```
 
+### Transaction Status
+Check Transation Status
+
+```rb
+response = client.status(
+   shortcode: '600426',
+   transaction_id: 'OEI2AK4Q16',
+   identifier_type: 1,
+   initiator_username: 'testapi',
+   initiator_password: 'Safaricom426!',
+   timeout_url: 'https://example.com/result',
+   result_url: 'https://example.com/result'
+)
+
+response.ConversationID
+response.ResponseCode
+```
+
+### Reversal 
+Initiate a reversal
+
+```
+ response = client.reversal(
+   initiator_password: 'Safaricom426!',
+   initiator_username: 'testapi',
+   transaction_id: 'OEI2AK4Q16',
+   amount: '100',
+   receiver: '600610',
+   receiver_type: '4',
+   timeout_url: 'https://example.com/result',
+   result_url: 'https://example.com/result'
+ )
+
+response.ConversationID
+response.ResponseCode
+
+```
+
 
 ## Development
 

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
 
 Rake::TestTask.new(:test) do |t|
-  t.libs << "test"
-  t.libs << "lib"
-  t.test_files = FileList["test/**/*_test.rb"]
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require 'bundler/setup'
 require 'mpesa'
@@ -10,7 +11,13 @@ require 'mpesa'
 # require "pry"
 # Pry.start
 
-client = Mpesa::Client.new(key: 'ZtkRW6ATbVtFpNml5w5SfG26Adfyagn9', secret: 'dosFI1yQ8bvHEVFw', env: 'sandbox')
+client = Mpesa::Client.new(
+  key: 'ZtkRW6ATbVtFpNml5w5SfG26Adfyagn9', 
+  secret: 'dosFI1yQ8bvHEVFw', 
+  env: 'sandbox', 
+  shortcode: '174379',
+  pass_key: 'bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919'
+)
 
 require 'irb'
 IRB.start(__FILE__)

data/lib/mpesa/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 
@@ -30,6 +32,18 @@ module Mpesa
       Payout.new(self, args).call
     end
 
+    def status(**args)
+      Status.new(self, args).call
+    end
+
+    def balance(**args)
+      Balance.new(self, args).call
+    end
+
+    def reversal(**args)
+      Reversal.new(self, args).call
+    end
+
     def connection(basic_auth: false)
       @connection ||= Faraday.new do |conn|
         conn.url_prefix = "https://#{subdomain}.safaricom.co.ke"

data/lib/mpesa/error.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mpesa
   class Error < StandardError; end
 end

data/lib/mpesa/object.rb

@@ -1,7 +1,11 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
 module Mpesa
   class Object
+    attr_reader :attributes
+
     def initialize(attributes)
       @attributes = OpenStruct.new(attributes)
     end
@@ -14,5 +18,9 @@ module Mpesa
     def respond_to_missing?(_method, _include_private = false)
       true
     end
+
+    def to_hash
+      attributes.to_h
+    end
   end
 end

data/lib/mpesa/objects/instace.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mpesa
   class Intance < Object
   end

data/lib/mpesa/resource.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mpesa
   class Resource
     attr_reader :client, :args

data/lib/mpesa/resources/balance.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mpesa
   class Status < Resource
     PATH = 'mpesa/transactionstatus/v1/query'

data/lib/mpesa/resources/payout.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Mpesa
   class Payout < Resource
-    PATH = 'mpesa/b2c/v1/paymentrequest'.freeze
+    PATH = 'mpesa/b2c/v1/paymentrequest'
 
     def call
       Object.new post_request(url: PATH, body: body).body

data/lib/mpesa/resources/register.rb

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 module Mpesa
   class Register < Resource
-    PATH = 'mpesa/c2b/v1/registerurl'.freeze
+    PATH = 'mpesa/c2b/v1/registerurl'
 
     def call
       Object.new post_request(url: PATH, body: body).body

data/lib/mpesa/resources/reversal.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Mpesa
+  class Reversal < Resource
+    PATH = 'mpesa/reversal/v1/request'
+
+    def call
+      Object.new post_request(url: PATH, body: body).body
+    end
+
+    def body
+      {
+        "Initiator": args[:initiator_username],
+        "SecurityCredential": credentials,
+        "CommandID": 'TransactionReversal',
+        "TransactionID": args[:transaction_id],
+        "Amount": args[:amount],
+        "ReceiverParty": args[:receiver],
+        "RecieverIdentifierType": args[:receiver_type],
+        "Remarks": args[:remarks] || 'check status',
+        "QueueTimeOutURL": args[:timeout_url],
+        "ResultURL": args[:result_url],
+        "Occasion": args[:occasion] || 'check status'
+      }
+    end
+
+    def credentials
+      SecurityCred.new(args[:initiator_password], client.env).password_credential
+    end
+  end
+end

data/lib/mpesa/resources/status.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mpesa
   class Status < Resource
     PATH = 'mpesa/transactionstatus/v1/query'
@@ -7,8 +9,21 @@ module Mpesa
 
     def body
       {
-
+        "CommandID": 'TransactionStatusQuery',
+        "PartyA": args[:shortcode] || client.shortcode,
+        "IdentifierType": args[:identifier_type],
+        "Remarks": args[:remarks] || 'check status',
+        "Initiator": args[:initiator_username],
+        "SecurityCredential": credentials,
+        "QueueTimeOutURL": args[:timeout_url],
+        "ResultURL": args[:result_url],
+        "TransactionID": args[:transaction_id],
+        "Occasion": args[:occasion] || 'check status'
       }
     end
+
+    def credentials
+      SecurityCred.new(args[:initiator_password], client.env).password_credential
+    end
   end
 end

data/lib/mpesa/resources/stk.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 module Mpesa
@@ -10,13 +12,13 @@ module Mpesa
 
     def body
       {
-        'BusinessShortCode': args[:shortcode] || client.shortcode,
+        'BusinessShortCode': shortcode,
         'Password': password,
         'Timestamp': timestamp.to_s,
         'TransactionType': 'CustomerPayBillOnline',
         'Amount': args[:amount],
         'PartyA': args[:phone],
-        'PartyB': args[:shortcode] || client.shortcode,
+        'PartyB': shortcode,
         'PhoneNumber': args[:phone],
         'CallBackURL': args[:callback_url],
         'AccountReference': args[:reference],
@@ -25,11 +27,15 @@ module Mpesa
     end
 
     def password
-      Base64.strict_encode64("#{args[:shortcode]}#{client.pass_key || args[:pass_key]}#{timestamp}")
+      Base64.strict_encode64("#{shortcode}#{args[:pass_key] || client.pass_key}#{timestamp}")
     end
 
     def timestamp
       Time.now.strftime('%Y%m%d%H%M%S').to_i
     end
+
+    def shortcode
+      args[:shortcode] || client.shortcode
+    end
   end
 end

data/lib/mpesa/resources/token.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'active_support/cache'
 require 'active_support/cache/memory_store'
 require 'active_support/notifications'

data/lib/mpesa/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mpesa
-  VERSION = '0.3.1'
+  VERSION = '0.3.2'
 end

data/lib/mpesa.rb

@@ -16,6 +16,7 @@ module Mpesa
   autoload :Payout, 'mpesa/resources/payout'
   autoload :Status, 'mpesa/resources/status'
   autoload :Balance, 'mpesa/resources/balance'
+  autoload :Reversal, 'mpesa/resources/reversal'
 
   autoload :Instance, 'mpesa/objects/instace'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpesarb
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Moses Gathuku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -224,6 +224,7 @@ files:
 - lib/mpesa/resources/balance.rb
 - lib/mpesa/resources/payout.rb
 - lib/mpesa/resources/register.rb
+- lib/mpesa/resources/reversal.rb
 - lib/mpesa/resources/status.rb
 - lib/mpesa/resources/stk.rb
 - lib/mpesa/resources/token.rb