hypercharge/hypercharge-schema

Hypercharge API JSON Schema

hypercharge-schema

json-schema for hypercharge payment request data., _(*1)

Matches hypercharge-API-doc version 2.24 2014/09/16, _(*2)

, _(*3)

Fixtures

There is a rather complete set of hypercharge API xml requests, respsonses and notifications provided as fixtures in /test/fixtures/, _(*4)

A fixture loader is provided for php, ruby and javascript., _(*5)

php:, _(*6)

// requests to hypercharge
$xmlString = Hypercharge\JsonSchemaFixture::request('sale.xml');

// or as json string
$jsonString = Hypercharge\JsonSchemaFixture::request('sale.json');

// response from hypercharge
$xmlString = Hypercharge\JsonSchemaFixture::response('sale.xml');

// notification from hypercharge
$postData = json_decode(Hypercharge\JsonSchemaFixture::notification('transaction_notification.json'), true);

ruby:, _(*7)

# request to hypercharge
xmlString = Hypercharge::Schema::Fixture.xml 'requests/sale'

# or as parsed json
jsonData = Hypercharge::Schema::Fixture.json 'requests/sale'

# response from hypercharge
xmlString = Hypercharge::Schema::Fixture.xml 'responses/sale'

# notification from hypercharge
jsonData = Hypercharge::Schema::Fixture.json 'notifications/transaction_notification'

javascript (sync, no async atm.):, _(*8)

var Schema = require('hypercharge-schema').Schema;

// request to hypercharge
var xmlString = Schema.Fixture.xml('requests/sale');

// or as parsed json
var jsonData = Schema.Fixture.json('requests/sale');

// response from hypercharge
var xmlString = Schema.Fixture.xml('responses/sale');

// notification from hypercharge
var postData = Schema.Fixture.json('notifications/transaction_notification');

Tests

Assuming you have all dependencies installed (see below) you can run all tests (ruby, php, javascript) at once., _(*9)

./test/all.sh

Or one by one:, _(*10)

Ruby

ruby >= 1.9.3, _(*11)

Install dependencies, _(*12)

bundle

Run tests, _(*13)

rake

PHP

php >= 5.3, _(*14)

Install Composer and dependencies, _(*15)

curl -o composer.phar http://getcomposer.org/composer.phar
php composer.phar install
php composer.phar update --dev

run test, _(*16)

php test/php/all.php

JavaScript

Install node.js, _(*17)

Install dependencies, _(*18)

npm install

run test, _(*19)

npm test

Btw: nvm is a handy tool for installing and handling multiple node.js versions on one mashine., _(*20)

Warranty

This software is provided "as is" and without any express or implied warranties, including, without limitation, the implied warranties of merchantibility and fitness for a particular purpose., _(*21)