Unofficial Paymob Ruby gem for Paymob
Install the gem and add to the application's Gemfile by executing:
$ bundle add paymob
If bundler is not being used to manage dependencies, install the gem by executing:
$ gem install paymob
Next, you need to run the generator:
$ rails generate paymob:install
Configure the gem with your configuration
PaymobRuby.configure do |config|
config.api_key = "api_key"
config.hmac_key = "hmac_key"
end💡 You can get your API_KEY from Settings -> Account info -> API Key in your Paymob portal.
For reference on the internals & specifics of Paymob, please head to their official documentation here
Any API call will return an object with following methods:
result = PaymobRuby.doSomething
result.success?
result.failure?
result.payload
result.erroruser = { first_name: "John", last_name: "Doe", email: "[email protected]", phone_number: "012xxxxxxxxx" }
result = PaymobRuby::PayCard.call(user:, amount: 10, integration_id: 12345678, iframe_id: 123)user = { first_name: "John", last_name: "Doe", email: "[email protected]", phone_number: "012xxxxxxxxx" }
result = PaymobRuby::PayToken.call(user:, amount: 10, integration_id: 12345678, token: "abc123") PaymobRuby::Hmac.valid_signature?(paymob_response)Errors could be one of the following:
AuthenticationError
InvalidRequestError (With `param` attribute)
APIErrorBug reports and pull requests are welcome.
The gem is available as open source under the terms of the MIT License.