PayPro Ruby Library

The PayPro Ruby library can be used to make integrating with the PayPro API easier when using Ruby. It provides easy to use classes to interact with all resources available through the API.

It also provides the following:

• Built-in pagination support
• Easy configuration
• Webhook request verification helpers

• Ruby >= 3.0.0

You can install the gem like this:

gem install paypro

If you'd rather install the gem through bundler you can put this in your Gemfile:

source 'https://rubygems.org'

gem 'paypro'

In order to use the API you need to have a valid API key. You can find your API key in the PayPro dashboard

Example of using the API:

require 'paypro'

client = PayPro::Client.new('pp_...')

# Creating a payment
payment = client.payments.create({ amount: 500, currency: 'EUR', description: 'Test Payment' })

# Retrieving all subscriptions
subscriptions = client.subscriptions.list

# Retrieving a single customer
customer = client.customers.get('CUSSDGDCJVZH5K')

When you have multiple API keys to use during a single request, you can specify these in all requests.

require 'paypro'

client = PayPro::Client.new('pp_...')

# Creating a payment
payment = client.payments.create({ amount: 500, currency: 'EUR', description: 'Test Payment' }, api_key: 'pp_...')

# Retrieving five subscriptions
subscriptions = client.subscriptions.list({ limit: 5 }, api_key: 'pp_...')

# Retrieving a single customer
customer = client.customers.get('CUSSDGDCJVZH5K', api_key: 'pp_...', api_url: 'https://api-test.paypro.nl')

If you want to contribute to this project you can fork the repository. Create a new branch, add your feature and create a pull request. We will look at your request and determine if we want to add it.

To run all the tests:

bundle exec rspec

To run the linter:

bundle exec rubocop

To run an irb with the gem already required you can use:

bin/console