mpesarb 0.3.1 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68d96fb20a2f0f9d3f463f6bb4b0d6d1e520c20d1c11f2d2a938aaf451d4ef4e
-  data.tar.gz: 92017a2a811f1f6de9f233c083be65b892ebb591bbc2c392dd31aeedac9a4212
+  metadata.gz: 468884d21cb1bf62fff53e71c500cda1e315b84dfb84b6db029fb5cefffad542
+  data.tar.gz: b83e2ffadf87e97def39ab7bdc0d9ff31c5279ba98b33a42afce0592abf03e29
 SHA512:
-  metadata.gz: 3c23bd5e3eb258bf86062cfbdc5bde0745617c5d6cb8f59da3927333331ab231e1c6c8d6c1296d5b342594b7cc7acb73d4f1c8c6ddc218de39389a79f58e37e6
-  data.tar.gz: ded8afec648b6cd69b45d4d0b4f958c27c43dbe7b2113e939c4c4f83aaeb807dc5e8e7c2091ed609709b32673f8f47c47c28b9e80b1c166049c91ebf0f9cd56e
+  metadata.gz: 8ce05d2a42c251d92c6a85e6a1f03a698d7a6f7b83b834709ca56a4f983c2363101cf2712ad466197a74ae23bca4c34d59eda297d47174c3fa7b1bc9bd9ab4ac
+  data.tar.gz: e10df0ee91669afb21e04f2f0762dfb4eca1c86587d105cc65af33ba1631a09257571ab1b7e2add8e97e6c7ee426dccdc362de7a57a9f4248985964e0cae7807

data/.github/workflows/mpesa.yml

@@ -9,10 +9,10 @@ jobs:
 
     steps:
     - uses: actions/checkout@v1
-    - name: Set up Ruby 2.6
+    - name: Set up Ruby 2.7
       uses: actions/setup-ruby@v1
       with:
-        ruby-version: 2.6.x
+        ruby-version: 2.7.x
     - name: Build and test with Rake
       run: |
         gem install bundler

data/.gitpod.yml

@@ -0,0 +1,8 @@
+# This configuration file was automatically generated by Gitpod.
+# Please adjust to your needs (see https://www.gitpod.io/docs/config-gitpod-file)
+# and commit this file to your remote git repository to share the goodness with others.
+
+tasks:
+  - init: bin/setup
+
+

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-### Unreleased
+### 2022-05-31
+- Faraday 2.0.1 or greater
+### 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,28 +1,26 @@
 PATH
   remote: .
   specs:
-    mpesarb (0.3.0)
+    mpesarb (0.3.4)
       activesupport (>= 5.0.0)
-      faraday (>= 1.1)
-      faraday_middleware (~> 1.1)
+      faraday (>= 2.0.1)
       openssl (>= 2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (6.1.4)
+    activesupport (7.0.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
-      zeitwerk (~> 2.3)
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
     ansi (1.5.0)
     builder (3.2.4)
     byebug (11.1.3)
     coderay (1.1.3)
-    concurrent-ruby (1.1.9)
+    concurrent-ruby (1.1.10)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -32,47 +30,29 @@ GEM
     crack (0.4.5)
       rexml
     docile (1.4.0)
-    faraday (1.7.1)
-      faraday-em_http (~> 1.0)
-      faraday-em_synchrony (~> 1.0)
-      faraday-excon (~> 1.1)
-      faraday-httpclient (~> 1.0.1)
-      faraday-net_http (~> 1.0)
-      faraday-net_http_persistent (~> 1.1)
-      faraday-patron (~> 1.0)
-      faraday-rack (~> 1.0)
-      multipart-post (>= 1.2, < 3)
+    faraday (2.3.0)
+      faraday-net_http (~> 2.0)
       ruby2_keywords (>= 0.0.4)
-    faraday-em_http (1.0.0)
-    faraday-em_synchrony (1.0.0)
-    faraday-excon (1.1.0)
-    faraday-httpclient (1.0.1)
-    faraday-net_http (1.0.1)
-    faraday-net_http_persistent (1.2.0)
-    faraday-patron (1.0.0)
-    faraday-rack (1.0.0)
-    faraday_middleware (1.1.0)
-      faraday (~> 1.0)
+    faraday-net_http (2.0.3)
     hashdiff (1.0.1)
-    i18n (1.8.10)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
-    json (2.5.1)
+    json (2.6.2)
     method_source (1.0.0)
-    minitest (5.14.4)
-    minitest-reporters (1.4.3)
+    minitest (5.15.0)
+    minitest-reporters (1.5.0)
       ansi
       builder
       minitest (>= 5.0)
       ruby-progressbar
-    multipart-post (2.1.1)
-    openssl (2.2.0)
+    openssl (3.0.0)
     pry (0.13.1)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.9.0)
       byebug (~> 11.0)
       pry (~> 0.13.0)
-    public_suffix (4.0.6)
+    public_suffix (4.0.7)
     rake (13.0.6)
     rexml (3.2.5)
     ruby-progressbar (1.11.0)
@@ -85,20 +65,20 @@ GEM
     sync (0.5.0)
     term-ansicolor (1.7.1)
       tins (~> 1.0)
-    thor (1.1.0)
-    tins (1.29.1)
+    thor (1.2.1)
+    tins (1.31.1)
       sync
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
-    vcr (6.0.0)
+    vcr (6.1.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    zeitwerk (2.4.2)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (>= 2.1.4)
@@ -113,4 +93,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
@@ -42,6 +42,7 @@ Optional
 - `adapter` - Faraday HTTP adapter. Default `:net_http`
 - `shortcode` - Mpesa shortcode
 - `pass_key` - LPNMO pass Key( used by STK API)
+- `raise_errors` - `Boolean` raise errors if response status code is not 200. Default: `true`
 
 
 ### Register Urls
@@ -100,6 +101,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,17 +1,19 @@
+# frozen_string_literal: true
+
 require 'faraday'
-require 'faraday_middleware'
 
 module Mpesa
   class Client
-    attr_reader :key, :secret, :env, :adapter, :shortcode, :pass_key
+    attr_reader :key, :secret, :env, :adapter, :shortcode, :pass_key, :raise_errors
 
-    def initialize(key:, secret:, shortcode: nil, pass_key: nil, env: 'production', adapter: Faraday.default_adapter)
+    def initialize(key:, secret:, shortcode: nil, pass_key: nil, env: 'production', adapter: Faraday.default_adapter, raise_errors: true)
       @key = key
       @secret = secret
       @env = env
       @adapter = adapter
       @pass_key = pass_key
       @shortcode = shortcode
+      @raise_errors = raise_errors
     end
 
     def auth
@@ -30,14 +32,26 @@ 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"
         conn.request :json
         conn.response :json, content_type: 'application/json'
         conn.adapter adapter
-        conn.request :basic_auth, key, secret if basic_auth
-        conn.request :authorization, :Bearer, auth.access_token unless basic_auth
+        conn.request :authorization, :basic, key, secret if basic_auth
+        conn.request :authorization, 'Bearer', auth.access_token unless basic_auth
       end
     end
 

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
@@ -16,6 +18,8 @@ module Mpesa
     end
 
     def handle_response(response)
+      return response unless client.raise_errors
+
       case response.status
       when 400
         raise Error, "Your request was malformed. #{response.body['errorMessage']}"
@@ -30,5 +34,12 @@ module Mpesa
       end
       response
     end
+
+    def format_phone(phone)
+      phone = phone.to_s
+      return phone if phone.match?(/\A254/)
+
+      phone.sub(/\A[+0]?(254)?(\d+)/, '254\2')
+    end
   end
 end

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
@@ -13,7 +15,7 @@ module Mpesa
         'CommandID': args[:command_id],
         'Amount': args[:amount],
         'PartyA': client.shortcode || args[:shortcode],
-        'PartyB': args[:phone],
+        'PartyB': format_phone(args[:phone]),
         'Remarks': args[:remarks],
         'QueueTimeOutURL': args[:timeout_url],
         'ResultURL': args[:result_url],

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,14 +12,14 @@ module Mpesa
 
     def body
       {
-        'BusinessShortCode': args[:shortcode] || client.shortcode,
+        'BusinessShortCode': shortcode,
         'Password': password,
-        'Timestamp': timestamp.to_s,
+        'Timestamp': timestamp,
         'TransactionType': 'CustomerPayBillOnline',
         'Amount': args[:amount],
-        'PartyA': args[:phone],
-        'PartyB': args[:shortcode] || client.shortcode,
-        'PhoneNumber': args[:phone],
+        'PartyA': format_phone(args[:phone]),
+        'PartyB': shortcode,
+        'PhoneNumber': format_phone(args[:phone]),
         'CallBackURL': args[:callback_url],
         'AccountReference': args[:reference],
         'TransactionDesc': args[:trans_desc]
@@ -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
+      Time.now.strftime('%Y%m%d%H%M%S')
+    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.4'
 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

data/mpesa.gemspec

@@ -31,8 +31,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '>= 12.3'
   # dependancies
   spec.add_runtime_dependency 'activesupport', '>= 5.0.0'
-  spec.add_runtime_dependency 'faraday', '>= 1.1'
-  spec.add_runtime_dependency 'faraday_middleware', '~> 1.1'
+  spec.add_runtime_dependency 'faraday', '>= 2.0.1'
   spec.add_runtime_dependency 'openssl', '>= 2.1'
   # request
   spec.add_development_dependency 'minitest'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpesarb
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.4
 platform: ruby
 authors:
 - Moses Gathuku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -58,28 +58,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.1'
-- !ruby/object:Gem::Dependency
-  name: faraday_middleware
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: openssl
   requirement: !ruby/object:Gem::Requirement
@@ -201,6 +187,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/mpesa.yml"
 - ".gitignore"
+- ".gitpod.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -224,6 +211,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
@@ -252,7 +240,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: a simple gem to integrate ruby with mpesa Apis