Skip to content

Latest commit

 

History

History
85 lines (54 loc) · 3.43 KB

README.md

File metadata and controls

85 lines (54 loc) · 3.43 KB

Official Braintree + PayPal integration for Spree Commerce

Build Status Code Climate

This is the official Braintree + PayPal extension for Spree Commerce. It supports:

Behind-the-scenes, this extension uses Braintree Ruby SDK.

Installation

  1. Add this extension to your Gemfile with this line:

    Spree >= 3.1

    gem 'spree_braintree_vzero', '~> 3.5'

    Spree 3.0 and Spree 2.x

    gem 'spree_braintree_vzero', github: 'spree-contrib/spree_braintree_vzero', branch: 'X-X-stable'

    The branch option is important: it must match the version of Spree you're using. For example, use 3-0-stable if you're using Spree 3-0-stable or any 3.0.x version.

  2. Install the gem using Bundler:

    bundle install
  3. Copy & run migrations

    bundle exec rails g spree_braintree_vzero:install
  4. Restart your server

    If your server was running, restart it so that it can find the assets properly.

Documentation

See wiki for more detailed documentation.

Heroku installation (optional)

Additional to migrations the gem adds a cron task (via the Whenever gem) which is needed for updating transaction states from submited for settlement to settled (Braintree v.zero transaction states). To run on Heroku you have to add a task to Heroku Scheduler:

rake spree_braintree_vzero:update_states

Recommended frequency is every 6 hours.

Contributing

If you'd like to contribute, please take a look at the instructions for installing dependencies and crafting a good pull request.

License

Spree Braintree V.zero is copyright © 2015-2021 Spark Solutions Sp. z o.o.. It is free software, and may be redistributed under the terms specified in the LICENCE file.

About Spark Solutions

Spark Solutions

Spree Braintree V.zero is maintained by Spark Solutions Sp. z o.o. and funded by PayPal, Inc. The names and logos are trademarks of PayPal, inc.

We are passionate about open source software. We are available for hire.