Simpal

A simple, lightweight wrapper around PayPal's REST API.

Add this line to your application's Gemfile:

gem 'simpal'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install simpal

First, create a client ID and secret from the Applications page of your PayPal account dashboard.

Then, create a client which uses these credentials:

Simpal.client = Simpal::Client.new(
  client_id: 'CLIENT_ID',
  client_secret: 'CLIENT_SECRET',
  sandbox: true
)

The value of Simpal.client is to make requests, unless the client attribute is specified on a per-request basis. The sandbox attribute defaults to false if omitted.

Once the client has been setup, it's easy to retrieve an order:

Simpal::Order.retrieve('ORDER_ID')

After checking out the repo, run bundle to install dependencies. Then, run bundle exec rake spec to run the tests. You can also run bin/console for an interactive prompt that allows you to experiment with the gem.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in constants.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Bug reports and pull requests are welcome on GitHub at https://github.com/NialtoServices/simpal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

The gem is available as open source under the terms of the Apache 2.0 License.

Everyone interacting in the Simpal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.