mpesarb 0.3.0 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d8b053eedae0cab3d4839a9a618f7b4f520b2deada034c07ab57358d69896b
-  data.tar.gz: da6f1486a2a3e329dc0999b0cb901791b97c4fe87caf1f85e364fdd864cec069
+  metadata.gz: 21c94fd454abe3e4127f6c716ee39c4f574924018af8d6daedafc0c1f1bee5d1
+  data.tar.gz: e68131c8d3f8d1531abd3c7419c9dfacc70331a555ecd48b881cf9f290239acf
 SHA512:
-  metadata.gz: d05e129b9e523fc31be44cb452283aa83993086b67b7cb540ce0832db3ba787a000c6baee3617f4529e34d6e7668ad31bbf97b78f5aa2e1fb9de73764ea326a5
-  data.tar.gz: a07ec8dc4b8d383028952722b5785fbba6884d640a0b5333005c6b1905015cba00b6678b30eeebb7cdce5e429cb3b71832a157c7eba149216fae652c5c94577b
+  metadata.gz: bf9183f955f48501ab1fbb634145bf2f0116b98cad63613b56bdf832ceedef03eabfa8e5e0cccb55161226af04149208c16afe75eaa986c4971c24e07f053d43
+  data.tar.gz: 599eaf780d0efc0e141218ef6848e21454e12a379f66ffe64d1b1bffe8ab6aaccb87f177f418c08848321f097efc3513ab9ee3d71e7d1eefb41dfbebf3a081ff

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,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,8 @@
 PATH
   remote: .
   specs:
-    mpesa (0.2.0)
+    mpesarb (0.3.1)
+      activesupport (>= 5.0.0)
       faraday (>= 1.1)
       faraday_middleware (~> 1.1)
       openssl (>= 2.1)
@@ -9,12 +10,19 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.4.1)
+      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)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -24,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)
@@ -43,9 +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)
@@ -55,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)
@@ -78,14 +90,18 @@ GEM
     thor (1.1.0)
     tins (1.29.1)
       sync
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     vcr (6.0.0)
     webmock (3.14.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
+    zeitwerk (2.5.1)
 
 PLATFORMS
   x86_64-darwin-19
+  x86_64-darwin-20
 
 DEPENDENCIES
   bundler (>= 2.1.4)
@@ -93,11 +109,11 @@ DEPENDENCIES
   coveralls
   minitest
   minitest-reporters
-  mpesa!
+  mpesarb!
   pry-byebug
   rake (>= 12.3)
   vcr
   webmock (~> 3.7)
 
 BUNDLED WITH
-   2.2.17
+   2.2.27

data/README.md

@@ -12,7 +12,12 @@ This Gem provides an interface that developers can use to convert JSON to `OpenS
 
 Install via `Gemfile`
 ```
-gem "mpesa", github: "gathuku/mpesa"
+gem 'mpesarb', '~> 0.3.2'
+```
+
+Or
+```
+bundle add mpesarb
 ```
 
 ## Usage
@@ -20,12 +25,25 @@ gem "mpesa", github: "gathuku/mpesa"
 ### Initialization
 
 ```ruby
-client = Mpesa::Client.new(key: "SKKSS" , secret: "SJSKS", env: "sandbox", adapter: )
+client = Mpesa::Client.new(key: 'ZtkRW6ATbVtFpNml5w5SfG26Adfyagn9', secret: 'dosFI1yQ8bvHEVFw', env: 'sandbox')
 
 response = client.auth
 response.access_token # XiKf3D6UrY0J8S2aeOQ7R7w0BuA5
 response.expires_in # 3599
 ```
+__Parameters__
+
+Required
+- `key` - API consumer key - Required
+- `secret` - API consumer secret  - Required
+
+Optional
+- `env` - API environment. Default `production`
+- `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
 
@@ -33,7 +51,8 @@ Register C2B Urls( confirmation and validation url)
 ```ruby
  response = client.register(
    shortcode: "44445",
-   confirmation_url: 'http://test.com', validation_url: 'http://test.com'
+   confirmation_url: 'http://example.com/confirm',
+   validation_url: 'http://example.com/validate'
  )
  response.OriginatorCoversationID #   "807-15591582-1"
  response.ResponseCode # "0"
@@ -82,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,20 @@
+# 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,6 +33,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
@@ -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,7 +1,35 @@
+# frozen_string_literal: true
+
+require 'active_support/cache'
+require 'active_support/cache/memory_store'
+require 'active_support/notifications'
+
 module Mpesa
   class Token < Resource
     def token
+      if cache.exist?('token')
+        expires_at = cache.send(:read_entry, 'token')&.expires_at
+        Object.new({
+                     "access_token": cache.fetch('token'),
+                     "expires_in": expires_at - Time.now.to_f
+                   })
+      else
+        cache_token
+      end
+    end
+
+    def cache_token
+      res = call
+      cache.write('token', res.access_token, expires_in: res.expires_in)
+      res
+    end
+
+    def call
       Object.new get_request(url: 'oauth/v1/generate?grant_type=client_credentials', basic_auth: true).body
     end
+
+    def cache
+      @cache ||= ActiveSupport::Cache::MemoryStore.new
+    end
   end
 end

data/lib/mpesa/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Mpesa
-  VERSION = '0.3.0'
+  VERSION = '0.3.3'
 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

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '>= 2.1.4'
   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 'openssl', '>= 2.1'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mpesarb
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.3
 platform: ruby
 authors:
 - Moses Gathuku
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-05 00:00:00.000000000 Z
+date: 2022-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
@@ -187,6 +201,7 @@ extra_rdoc_files: []
 files:
 - ".github/workflows/mpesa.yml"
 - ".gitignore"
+- ".gitpod.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
@@ -210,6 +225,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
@@ -238,7 +254,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