mpesarb 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e9d8b053eedae0cab3d4839a9a618f7b4f520b2deada034c07ab57358d69896b
+  data.tar.gz: da6f1486a2a3e329dc0999b0cb901791b97c4fe87caf1f85e364fdd864cec069
+SHA512:
+  metadata.gz: d05e129b9e523fc31be44cb452283aa83993086b67b7cb540ce0832db3ba787a000c6baee3617f4529e34d6e7668ad31bbf97b78f5aa2e1fb9de73764ea326a5
+  data.tar.gz: a07ec8dc4b8d383028952722b5785fbba6884d640a0b5333005c6b1905015cba00b6678b30eeebb7cdce5e429cb3b71832a157c7eba149216fae652c5c94577b

data/.github/workflows/mpesa.yml

@@ -0,0 +1,20 @@
+name: Mpesa_Gem
+
+on: [push]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v1
+    - name: Set up Ruby 2.6
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.6.x
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install --jobs 4 --retry 3
+        bundle exec rake

data/.gitignore

@@ -0,0 +1,3 @@
+*.gem
+coverage
+pkg

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.0
+before_install: gem install bundler -v 2.1.0.pre.2

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+### Unreleased
+- Update gemspec
+- Read certificate full path
+- Return early if get access token fail
+### 2020-12-09
+- Reset configuration before new configuration
+- Encrypt initiator password with X506 Certificate key

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at TODO: Write your email address. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -0,0 +1,25 @@
+FROM ruby:rc-alpine3.10
+# update and upgrade packages
+RUN apk update && apk upgrade
+
+# Create non-root user
+RUN addgroup -S admin -g 1000 && adduser -S -g '' -u 1000 -G admin deploy
+
+# make a parrent directory
+RUN mkdir -p /mpesa
+
+# let deploy user own the directory
+RUN chown deploy /mpesa
+
+# set the deploy user
+USER deploy
+# set the directory as working DIR
+WORKDIR /mpesa
+
+# install gem bundler
+RUN gem install bundler
+
+# create a Gem
+#RUN bundle gem ruby_mpesa
+
+COPY --chown=deploy:admin . /mpesa

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,103 @@
+PATH
+  remote: .
+  specs:
+    mpesa (0.2.0)
+      faraday (>= 1.1)
+      faraday_middleware (~> 1.1)
+      openssl (>= 2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    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)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    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)
+      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)
+    hashdiff (1.0.1)
+    json (2.5.1)
+    method_source (1.0.0)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    multipart-post (2.1.1)
+    openssl (2.2.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)
+    rake (13.0.6)
+    rexml (3.2.5)
+    ruby-progressbar (1.11.0)
+    ruby2_keywords (0.0.5)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.1.0)
+    tins (1.29.1)
+      sync
+    vcr (6.0.0)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+
+DEPENDENCIES
+  bundler (>= 2.1.4)
+  byebug
+  coveralls
+  minitest
+  minitest-reporters
+  mpesa!
+  pry-byebug
+  rake (>= 12.3)
+  vcr
+  webmock (~> 3.7)
+
+BUNDLED WITH
+   2.2.17

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 TODO: Write your name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,103 @@
+# Mpesa
+
+Welcome to [mpesa](https://developer.safaricom.co.ke/) API gem. The gem defines the API resources and helps developers to make requests cleanly.
+
+When you receive a JSON response from an API endpoint, it's really easy to convert this to a Ruby hash. But hashes don't feel very Ruby-ish when you're working with them.
+
+To help on this gem parse the responses to `OpenStruct` Objects so a developer can interact with the response just like regular ruby objects we are used to.
+
+This Gem provides an interface that developers can use to convert JSON to `OpenStruct` objects, this is useful when you want to parse results callbacks data.
+
+## Installation
+
+Install via `Gemfile`
+```
+gem "mpesa", github: "gathuku/mpesa"
+```
+
+## Usage
+
+### Initialization
+
+```ruby
+client = Mpesa::Client.new(key: "SKKSS" , secret: "SJSKS", env: "sandbox", adapter: )
+
+response = client.auth
+response.access_token # XiKf3D6UrY0J8S2aeOQ7R7w0BuA5
+response.expires_in # 3599
+```
+
+### Register Urls
+
+Register C2B Urls( confirmation and validation url)
+```ruby
+ response = client.register(
+   shortcode: "44445",
+   confirmation_url: 'http://test.com', validation_url: 'http://test.com'
+ )
+ response.OriginatorCoversationID #   "807-15591582-1"
+ response.ResponseCode # "0"
+ response.ResponseDescription # "success"  
+```
+
+### STK (LPNMO)
+
+Lipa na mpesa online(Stk Push)
+
+```ruby
+response = client.stk(
+  shortcode: "174379",
+  pass_key: "bfb279f9aa9bdbcf158e97dd71a467cd2e0c893059b10f78e6b72ada1ed2c919", # Optional if passed in client initialization
+  amount: "10",
+  phone: "254705112855",
+  callback_url: "https://test.com",
+  reference: "REF",
+  trans_desc: "desc"
+)
+
+response.CheckoutRequestID # "ws_CO_040920212326513616"
+response.inspect # to see all available attributes
+```
+
+
+### B2C (Payout)
+
+```rb
+response = client.payout(
+  shortcode: "600998", # Optional if added in client initialization
+  initiator_username: "testapi",
+  initiator_password: "Safaricom998!",
+  command_id: "BusinessPayment",
+  phone: "254708374149",
+  amount: "100",
+  result_url: "https://example.com/result",
+  timeout_url: "https://example.com/result",
+  occasion: "some desc",
+  remarks: "remarks"
+)
+
+response.ConversationID # AG_20210904_0000574b3c8d93651740
+response.OriginatorConversationID #  "28831-15819693-1"
+respose.ResponseDescription # "Accept the service request successfully."
+
+```
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gathuku/mpesa. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/gathuku/mpesa/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Mpesa project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/gathuku/mpesa/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+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"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mpesa'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+client = Mpesa::Client.new(key: 'ZtkRW6ATbVtFpNml5w5SfG26Adfyagn9', secret: 'dosFI1yQ8bvHEVFw', env: 'sandbox')
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,6 @@
+version: "3"
+services:
+  app:
+    build: .
+    volumes:
+      - .:/mpesa

data/lib/cert/production.pem

@@ -0,0 +1,38 @@
+-----BEGIN CERTIFICATE-----
+MIIGkzCCBXugAwIBAgIKXfBp5gAAAD+hNjANBgkqhkiG9w0BAQsFADBbMRMwEQYK
+CZImiZPyLGQBGRYDbmV0MRkwFwYKCZImiZPyLGQBGRYJc2FmYXJpY29tMSkwJwYD
+VQQDEyBTYWZhcmljb20gSW50ZXJuYWwgSXNzdWluZyBDQSAwMjAeFw0xNzA0MjUx
+NjA3MjRaFw0xODAzMjExMzIwMTNaMIGNMQswCQYDVQQGEwJLRTEQMA4GA1UECBMH
+TmFpcm9iaTEQMA4GA1UEBxMHTmFpcm9iaTEaMBgGA1UEChMRU2FmYXJpY29tIExp
+bWl0ZWQxEzARBgNVBAsTClRlY2hub2xvZ3kxKTAnBgNVBAMTIGFwaWdlZS5hcGlj
+YWxsZXIuc2FmYXJpY29tLmNvLmtlMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB
+CgKCAQEAoknIb5Tm1hxOVdFsOejAs6veAai32Zv442BLuOGkFKUeCUM2s0K8XEsU
+t6BP25rQGNlTCTEqfdtRrym6bt5k0fTDscf0yMCoYzaxTh1mejg8rPO6bD8MJB0c
+FWRUeLEyWjMeEPsYVSJFv7T58IdAn7/RhkrpBl1dT7SmIZfNVkIlD35+Cxgab+u7
++c7dHh6mWguEEoE3NbV7Xjl60zbD/Buvmu6i9EYz+27jNVPI6pRXHvp+ajIzTSsi
+eD8Ztz1eoC9mphErasAGpMbR1sba9bM6hjw4tyTWnJDz7RdQQmnsW1NfFdYdK0qD
+RKUX7SG6rQkBqVhndFve4SDFRq6wvQIDAQABo4IDJDCCAyAwHQYDVR0OBBYEFG2w
+ycrgEBPFzPUZVjh8KoJ3EpuyMB8GA1UdIwQYMBaAFOsy1E9+YJo6mCBjug1evuh5
+TtUkMIIBOwYDVR0fBIIBMjCCAS4wggEqoIIBJqCCASKGgdZsZGFwOi8vL0NOPVNh
+ZmFyaWNvbSUyMEludGVybmFsJTIwSXNzdWluZyUyMENBJTIwMDIsQ049U1ZEVDNJ
+U1NDQTAxLENOPUNEUCxDTj1QdWJsaWMlMjBLZXklMjBTZXJ2aWNlcyxDTj1TZXJ2
+aWNlcyxDTj1Db25maWd1cmF0aW9uLERDPXNhZmFyaWNvbSxEQz1uZXQ/Y2VydGlm
+aWNhdGVSZXZvY2F0aW9uTGlzdD9iYXNlP29iamVjdENsYXNzPWNSTERpc3RyaWJ1
+dGlvblBvaW50hkdodHRwOi8vY3JsLnNhZmFyaWNvbS5jby5rZS9TYWZhcmljb20l
+MjBJbnRlcm5hbCUyMElzc3VpbmclMjBDQSUyMDAyLmNybDCCAQkGCCsGAQUFBwEB
+BIH8MIH5MIHJBggrBgEFBQcwAoaBvGxkYXA6Ly8vQ049U2FmYXJpY29tJTIwSW50
+ZXJuYWwlMjBJc3N1aW5nJTIwQ0ElMjAwMixDTj1BSUEsQ049UHVibGljJTIwS2V5
+JTIwU2VydmljZXMsQ049U2VydmljZXMsQ049Q29uZmlndXJhdGlvbixEQz1zYWZh
+cmljb20sREM9bmV0P2NBQ2VydGlmaWNhdGU/YmFzZT9vYmplY3RDbGFzcz1jZXJ0
+aWZpY2F0aW9uQXV0aG9yaXR5MCsGCCsGAQUFBzABhh9odHRwOi8vY3JsLnNhZmFy
+aWNvbS5jby5rZS9vY3NwMAsGA1UdDwQEAwIFoDA9BgkrBgEEAYI3FQcEMDAuBiYr
+BgEEAYI3FQiHz4xWhMLEA4XphTaE3tENhqCICGeGwcdsg7m5awIBZAIBDDAdBgNV
+HSUEFjAUBggrBgEFBQcDAgYIKwYBBQUHAwEwJwYJKwYBBAGCNxUKBBowGDAKBggr
+BgEFBQcDAjAKBggrBgEFBQcDATANBgkqhkiG9w0BAQsFAAOCAQEAC/hWx7KTwSYr
+x2SOyyHNLTRmCnCJmqxA/Q+IzpW1mGtw4Sb/8jdsoWrDiYLxoKGkgkvmQmB2J3zU
+ngzJIM2EeU921vbjLqX9sLWStZbNC2Udk5HEecdpe1AN/ltIoE09ntglUNINyCmf
+zChs2maF0Rd/y5hGnMM9bX9ub0sqrkzL3ihfmv4vkXNxYR8k246ZZ8tjQEVsKehE
+dqAmj8WYkYdWIHQlkKFP9ba0RJv7aBKb8/KP+qZ5hJip0I5Ey6JJ3wlEWRWUYUKh
+gYoPHrJ92ToadnFCCpOlLKWc0xVxANofy6fqreOVboPO0qTAYpoXakmgeRNLUiar
+0ah6M/q/KA==
+-----END CERTIFICATE-----

data/lib/cert/sandbox.pem

@@ -0,0 +1,37 @@
+-----BEGIN CERTIFICATE-----
+MIIGgDCCBWigAwIBAgIKMvrulAAAAARG5DANBgkqhkiG9w0BAQsFADBbMRMwEQYK
+CZImiZPyLGQBGRYDbmV0MRkwFwYKCZImiZPyLGQBGRYJc2FmYXJpY29tMSkwJwYD
+VQQDEyBTYWZhcmljb20gSW50ZXJuYWwgSXNzdWluZyBDQSAwMjAeFw0xNDExMTIw
+NzEyNDVaFw0xNjExMTEwNzEyNDVaMHsxCzAJBgNVBAYTAktFMRAwDgYDVQQIEwdO
+YWlyb2JpMRAwDgYDVQQHEwdOYWlyb2JpMRAwDgYDVQQKEwdOYWlyb2JpMRMwEQYD
+VQQLEwpUZWNobm9sb2d5MSEwHwYDVQQDExhhcGljcnlwdC5zYWZhcmljb20uY28u
+a2UwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCotwV1VxXsd0Q6i2w0
+ugw+EPvgJfV6PNyB826Ik3L2lPJLFuzNEEJbGaiTdSe6Xitf/PJUP/q8Nv2dupHL
+BkiBHjpQ6f61He8Zdc9fqKDGBLoNhNpBXxbznzI4Yu6hjBGLnF5Al9zMAxTij6wL
+GUFswKpizifNbzV+LyIXY4RR2t8lxtqaFKeSx2B8P+eiZbL0wRIDPVC5+s4GdpFf
+Y3QIqyLxI2bOyCGl8/XlUuIhVXxhc8Uq132xjfsWljbw4oaMobnB2KN79vMUvyoR
+w8OGpga5VoaSFfVuQjSIf5RwW1hitm/8XJvmNEdeY0uKriYwbR8wfwQ3E0AIW1Fl
+MMghAgMBAAGjggMkMIIDIDAdBgNVHQ4EFgQUwUfE+NgGndWDN3DyVp+CAiF1Zkgw
+HwYDVR0jBBgwFoAU6zLUT35gmjqYIGO6DV6+6HlO1SQwggE7BgNVHR8EggEyMIIB
+LjCCASqgggEmoIIBIoaB1mxkYXA6Ly8vQ049U2FmYXJpY29tJTIwSW50ZXJuYWwl
+MjBJc3N1aW5nJTIwQ0ElMjAwMixDTj1TVkRUM0lTU0NBMDEsQ049Q0RQLENOPVB1
+YmxpYyUyMEtleSUyMFNlcnZpY2VzLENOPVNlcnZpY2VzLENOPUNvbmZpZ3VyYXRp
+b24sREM9c2FmYXJpY29tLERDPW5ldD9jZXJ0aWZpY2F0ZVJldm9jYXRpb25MaXN0
+P2Jhc2U/b2JqZWN0Q2xhc3M9Y1JMRGlzdHJpYnV0aW9uUG9pbnSGR2h0dHA6Ly9j
+cmwuc2FmYXJpY29tLmNvLmtlL1NhZmFyaWNvbSUyMEludGVybmFsJTIwSXNzdWlu
+ZyUyMENBJTIwMDIuY3JsMIIBCQYIKwYBBQUHAQEEgfwwgfkwgckGCCsGAQUFBzAC
+hoG8bGRhcDovLy9DTj1TYWZhcmljb20lMjBJbnRlcm5hbCUyMElzc3VpbmclMjBD
+QSUyMDAyLENOPUFJQSxDTj1QdWJsaWMlMjBLZXklMjBTZXJ2aWNlcyxDTj1TZXJ2
+aWNlcyxDTj1Db25maWd1cmF0aW9uLERDPXNhZmFyaWNvbSxEQz1uZXQ/Y0FDZXJ0
+aWZpY2F0ZT9iYXNlP29iamVjdENsYXNzPWNlcnRpZmljYXRpb25BdXRob3JpdHkw
+KwYIKwYBBQUHMAGGH2h0dHA6Ly9jcmwuc2FmYXJpY29tLmNvLmtlL29jc3AwCwYD
+VR0PBAQDAgWgMD0GCSsGAQQBgjcVBwQwMC4GJisGAQQBgjcVCIfPjFaEwsQDhemF
+NoTe0Q2GoIgIZ4bBx2yDublrAgFkAgEMMB0GA1UdJQQWMBQGCCsGAQUFBwMCBggr
+BgEFBQcDATAnBgkrBgEEAYI3FQoEGjAYMAoGCCsGAQUFBwMCMAoGCCsGAQUFBwMB
+MA0GCSqGSIb3DQEBCwUAA4IBAQBMFKlncYDI06ziR0Z0/reptIJRCMo+rqo/cUuP
+KMmJCY3sXxFHs5ilNXo8YavgRLpxJxdZMkiUIVuVaBanXkz9/nMriiJJwwcMPjUV
+9nQqwNUEqrSx29L1ARFdUy7LhN4NV7mEMde3MQybCQgBjjOPcVSVZXnaZIggDYIU
+w4THLy9rDmUIasC8GDdRcVM8xDOVQD/Pt5qlx/LSbTNe2fekhTLFIGYXJVz2rcsj
+k1BfG7P3pXnsPAzu199UZnqhEF+y/0/nNpf3ftHZjfX6Ws+dQuLoDN6pIl8qmok9
+9E/EAgL1zOIzFvCRYlnjKdnsuqL1sIYFBlv3oxo6W1O+X9IZ
+-----END CERTIFICATE-----

data/lib/mpesa/client.rb

@@ -0,0 +1,48 @@
+require 'faraday'
+require 'faraday_middleware'
+
+module Mpesa
+  class Client
+    attr_reader :key, :secret, :env, :adapter, :shortcode, :pass_key
+
+    def initialize(key:, secret:, shortcode: nil, pass_key: nil, env: 'production', adapter: Faraday.default_adapter)
+      @key = key
+      @secret = secret
+      @env = env
+      @adapter = adapter
+      @pass_key = pass_key
+      @shortcode = shortcode
+    end
+
+    def auth
+      Token.new(self).token
+    end
+
+    def register(**args)
+      Register.new(self, args).call
+    end
+
+    def stk(**args)
+      Stk.new(self, args).call
+    end
+
+    def payout(**args)
+      Payout.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
+      end
+    end
+
+    def subdomain
+      env == 'production' ? 'api' : 'sandbox'
+    end
+  end
+end

data/lib/mpesa/error.rb

@@ -0,0 +1,3 @@
+module Mpesa
+  class Error < StandardError; end
+end

data/lib/mpesa/object.rb

@@ -0,0 +1,18 @@
+require 'ostruct'
+
+module Mpesa
+  class Object
+    def initialize(attributes)
+      @attributes = OpenStruct.new(attributes)
+    end
+
+    def method_missing(method, *args, &block)
+      attribute = @attributes.send(method, *args, &block)
+      attribute.is_a?(Hash) ? Object.new(attribute) : attribute
+    end
+
+    def respond_to_missing?(_method, _include_private = false)
+      true
+    end
+  end
+end

data/lib/mpesa/objects/instace.rb

@@ -0,0 +1,4 @@
+module Mpesa
+  class Intance < Object
+  end
+end

data/lib/mpesa/resource.rb

@@ -0,0 +1,34 @@
+module Mpesa
+  class Resource
+    attr_reader :client, :args
+
+    def initialize(client, args = {})
+      @client = client
+      @args = args
+    end
+
+    def get_request(url:, params: {}, headers: {}, basic_auth: true)
+      handle_response client.connection(basic_auth: basic_auth).get(url, params, headers)
+    end
+
+    def post_request(url:, body: {}, headers: {})
+      handle_response client.connection.post(url, body, headers)
+    end
+
+    def handle_response(response)
+      case response.status
+      when 400
+        raise Error, "Your request was malformed. #{response.body['errorMessage']}"
+      when 401
+        raise Error, "You did not supply valid authentication credentials. #{response.body['errorMessage']}"
+      when 403
+        raise Error, "You are not allowed to perform that action. #{response.body['errorMessage']}"
+      when 404
+        raise Error, "No results were found for your request. #{response.body['errorMessage']}"
+      when 500
+        raise Error, "Something wrong happened. #{response.body['errorMessage']}"
+      end
+      response
+    end
+  end
+end

data/lib/mpesa/resources/balance.rb

@@ -0,0 +1,23 @@
+module Mpesa
+  class Status < Resource
+    PATH = 'mpesa/transactionstatus/v1/query'
+    def call
+      Object.new post_request(url: PATH, body: body).body
+    end
+
+    def body
+      {
+        'CommandID': 'TransactionStatusQuery',
+        'PartyA': params['shortcode'],
+        'IdentifierType': 4,
+        'Remarks': params['remarks'],
+        'Initiator': params['initiator_username'],
+        'SecurityCredential': '',
+        'QueueTimeOutURL': params['timeout_url'],
+        'ResultURL': params['result_url'],
+        'TransactionID': params['transaction_id'],
+        'Occassion': params['occasion']
+      }
+    end
+  end
+end

data/lib/mpesa/resources/payout.rb

@@ -0,0 +1,28 @@
+module Mpesa
+  class Payout < Resource
+    PATH = 'mpesa/b2c/v1/paymentrequest'.freeze
+
+    def call
+      Object.new post_request(url: PATH, body: body).body
+    end
+
+    def body
+      {
+        'InitiatorName': args[:initiator_username],
+        'SecurityCredential': credentials,
+        'CommandID': args[:command_id],
+        'Amount': args[:amount],
+        'PartyA': client.shortcode || args[:shortcode],
+        'PartyB': args[:phone],
+        'Remarks': args[:remarks],
+        'QueueTimeOutURL': args[:timeout_url],
+        'ResultURL': args[:result_url],
+        'Occasion': args[:occasion]
+      }
+    end
+
+    def credentials
+      SecurityCred.new(args[:initiator_password], client.env).password_credential
+    end
+  end
+end

data/lib/mpesa/resources/register.rb

@@ -0,0 +1,18 @@
+module Mpesa
+  class Register < Resource
+    PATH = 'mpesa/c2b/v1/registerurl'.freeze
+
+    def call
+      Object.new post_request(url: PATH, body: body).body
+    end
+
+    def body
+      {
+        'ShortCode': args[:shortcode],
+        'ResponseType': 'Completed',
+        'ConfirmationURL': args[:confirmation_url],
+        'ValidationURL': args[:validation_url]
+      }
+    end
+  end
+end

data/lib/mpesa/resources/status.rb

@@ -0,0 +1,14 @@
+module Mpesa
+  class Status < Resource
+    PATH = 'mpesa/transactionstatus/v1/query'
+    def call
+      Object.new post_request(url: PATH, body: body).body
+    end
+
+    def body
+      {
+
+      }
+    end
+  end
+end

data/lib/mpesa/resources/stk.rb

@@ -0,0 +1,35 @@
+require 'base64'
+
+module Mpesa
+  class Stk < Resource
+    PATH = 'mpesa/stkpush/v1/processrequest'
+
+    def call
+      Object.new post_request(url: PATH, body: body).body
+    end
+
+    def body
+      {
+        'BusinessShortCode': args[:shortcode] || client.shortcode,
+        'Password': password,
+        'Timestamp': timestamp.to_s,
+        'TransactionType': 'CustomerPayBillOnline',
+        'Amount': args[:amount],
+        'PartyA': args[:phone],
+        'PartyB': args[:shortcode] || client.shortcode,
+        'PhoneNumber': args[:phone],
+        'CallBackURL': args[:callback_url],
+        'AccountReference': args[:reference],
+        'TransactionDesc': args[:trans_desc]
+      }
+    end
+
+    def password
+      Base64.strict_encode64("#{args[:shortcode]}#{client.pass_key || args[:pass_key]}#{timestamp}")
+    end
+
+    def timestamp
+      Time.now.strftime('%Y%m%d%H%M%S').to_i
+    end
+  end
+end

data/lib/mpesa/resources/token.rb

@@ -0,0 +1,7 @@
+module Mpesa
+  class Token < Resource
+    def token
+      Object.new get_request(url: 'oauth/v1/generate?grant_type=client_credentials', basic_auth: true).body
+    end
+  end
+end

data/lib/mpesa/securitycred.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'openssl'
+require 'base64'
+
+module Mpesa
+  # Security Credentials
+  class SecurityCred
+    attr_reader :initiator_password, :env
+
+    def initialize(pass, env)
+      @initiator_password = pass
+      @env = env
+    end
+
+    def password_credential
+      raw = if env == 'production'
+              File.read(File.join(File.dirname(__FILE__), '../cert/production.pem'))
+            else
+              File.read(File.join(File.dirname(__FILE__), '../cert/sandbox.pem'))
+            end
+
+      cert = OpenSSL::X509::Certificate.new(raw)
+      key = cert.public_key
+      Base64.strict_encode64(key.public_encrypt(initiator_password))
+    end
+  end
+end

data/lib/mpesa/version.rb

@@ -0,0 +1,3 @@
+module Mpesa
+  VERSION = '0.3.0'
+end

data/lib/mpesa.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require_relative 'mpesa/version'
+
+# main module
+module Mpesa
+  autoload :Error, 'mpesa/error'
+  autoload :Client, 'mpesa/client'
+  autoload :Object, 'mpesa/object'
+  autoload :Resource, 'mpesa/resource'
+  autoload :SecurityCred, 'mpesa/securitycred'
+
+  autoload :Register, 'mpesa/resources/register'
+  autoload :Token, 'mpesa/resources/token'
+  autoload :Stk, 'mpesa/resources/stk'
+  autoload :Payout, 'mpesa/resources/payout'
+  autoload :Status, 'mpesa/resources/status'
+  autoload :Balance, 'mpesa/resources/balance'
+
+  autoload :Instance, 'mpesa/objects/instace'
+end

data/mpesa.gemspec

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mpesa/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mpesarb'
+  spec.version       = Mpesa::VERSION
+  spec.authors       = ['Moses Gathuku']
+  spec.email         = ['mosesgathuku95@gmail.com']
+
+  spec.summary       = 'a simple gem to integrate ruby with mpesa Apis'
+  spec.description   = 'the gem will allow you to simply integrate with mpesa apis'
+  spec.homepage      = 'https://github.com/gathuku/ruby_mpesa'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new('>= 2.3.0')
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/gathuku/mpesa'
+  spec.metadata['changelog_uri'] = 'https://github.com/gathuku/mpesa'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '>= 2.1.4'
+  spec.add_development_dependency 'rake', '>= 12.3'
+  # dependancies
+  spec.add_runtime_dependency 'faraday', '>= 1.1'
+  spec.add_runtime_dependency 'faraday_middleware', '~> 1.1'
+  spec.add_runtime_dependency 'openssl', '>= 2.1'
+  # request
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock', '~> 3.7'
+  # debugging
+  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry-byebug'
+  # code coverage
+  spec.add_development_dependency 'coveralls'
+end

metadata

@@ -0,0 +1,245 @@
+--- !ruby/object:Gem::Specification
+name: mpesarb
+version: !ruby/object:Gem::Version
+  version: 0.3.0
+platform: ruby
+authors:
+- Moses Gathuku
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: openssl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.7'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: the gem will allow you to simply integrate with mpesa apis
+email:
+- mosesgathuku95@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/mpesa.yml"
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yml
+- lib/cert/production.pem
+- lib/cert/sandbox.pem
+- lib/mpesa.rb
+- lib/mpesa/client.rb
+- lib/mpesa/error.rb
+- lib/mpesa/object.rb
+- lib/mpesa/objects/instace.rb
+- lib/mpesa/resource.rb
+- lib/mpesa/resources/balance.rb
+- lib/mpesa/resources/payout.rb
+- lib/mpesa/resources/register.rb
+- lib/mpesa/resources/status.rb
+- lib/mpesa/resources/stk.rb
+- lib/mpesa/resources/token.rb
+- lib/mpesa/securitycred.rb
+- lib/mpesa/version.rb
+- mpesa.gemspec
+homepage: https://github.com/gathuku/ruby_mpesa
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/gathuku/ruby_mpesa
+  source_code_uri: https://github.com/gathuku/mpesa
+  changelog_uri: https://github.com/gathuku/mpesa
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: a simple gem to integrate ruby with mpesa Apis
+test_files: []