Basically it's a gem that makes it easy to integrate your app with the new M-PESA platform dubbed G2 (for M-PESA 2nd generation platform). It Handles all the SOAP stuff abstracting any direct interaction with the API endpoints so that you can focus on what matters. Building awesome.
The gem should be up on RubyGems.org, it's accompanying API reference here, the CHANGELOG here and all the releases here.
Add this line to your application's Gemfile:
gem 'mpesa'
And then execute:
$ bundle install
Or install it yourself as:
$ gem install mpesa
Bug reports and pull requests are welcome on GitHub at github.com/itsmrwave/mpesa-gem. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Code of Conduct.
After checking out the repo, run this to set up your local machine:
$ bin/setup
To get an interactive prompt that will allow you to experiment:
$ bin/console
For learning how to read a WSDL document, read the Beginner's Guide by Thomas Bayer. It's a good idea to know what you're working with and this might really help you debug certain problems.
The contributing flow/process I'd recommend can be found here.
You may start up a local documentation server at http://0.0.0.0:8808 to
preview the gem API documentation locally. Just call:
$ bundle exec yard server --reload
The result should be similar as to what will eventually be available as the RubyDoc API reference.
To run tests, call:
$ bundle exec rspec spec
To check if the style guide has been violated:
$ bundle exec rubocop
Job King'ori Maina © 2016. The MIT License bundled therein is a permissive license that is short and to the point. It lets people do anything they want as long as they provide attribution and waive liability. You can learn more about it here.