README

Work In Progress

This package is in very early development and lots of things may change! Please explore the source and test cases to get a clearer understanding. Also make sure you sign up to GoCardless Pro and read their documentation.

Take a look in the examples folder to get started

Installation

The recommended way to install GoCardless Pro is with Composer <http://getcomposer.org>_. Composer is a dependency management tool for PHP that allows you to declare the dependencies your project needs and installs them into your project.

# Install Composer
curl -sS https://getcomposer.org/installer | php

You can add GoCardless Pro as a dependency using the composer.phar CLI:

php composer.phar require sneek/gocardless-pro:@stable

Alternatively, you can specify GoCardless Pro as a dependency in your project's existing composer.json file:

{
  "require": {
     "sneek/gocardless-pro": "@stable"
  }
}

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at [getcomposer.org] (http://getcomposer.org).

Bleeding edge

During your development, you can keep up with the latest changes on the master branch by setting the version requirement for GoCardless Pro to @dev.

{
  "require": {
     "sneek/gocardless-pro": "@dev"
  }
}

License

Licensed using the MIT license.

Copyright (c) 2015 Sneek Digital <https://github.com/sneek>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

Contributing

Guidelines

GoCardless Pro follows PSR-0, PSR-1, and PSR-2.
All pull requests must have an open issue to reference the bug / change
All pull requests must include unit tests to ensure the change works as expected and to prevent regressions.

Running the tests

In order to contribute, you'll need to checkout the source from GitHub and install GoCardless Pro's dependencies using Composer:

git clone https://github.com/sneek/gocardless-pro.git
cd guzzle && curl -s http://getcomposer.org/installer | php && ./composer.phar install --dev

GoCardless Pro is unit tested with PHPUnit. You will need to setup a GoCardless account and configure the API keys so you can authenticate. Run the tests using the vendored PHPUnit binary:

vendor/bin/phpunit

sneek / gocardless-pro

Maintainers

Details