Skip to content

Commit

Permalink
add captureCharge api
Browse files Browse the repository at this point in the history
  • Loading branch information
@takayukii
takayukii committed Sep 13, 2015
1 parent e4891dd commit ec93d21
Show file tree
Hide file tree
Showing 3 changed files with 324 additions and 1 deletion.
38 changes: 38 additions & 0 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,6 +102,44 @@ client.getCharge(chargeID, function(err, result) {
}
```

## Capture a Charge
``POST https://api.spike.cc/v1/charges/{CHARGE_ID}/capture``

```javascript
var chargeID = '20140609-064331-onjmfi1z5q';

// POST https://api.spike.cc/v1/charges/{CHARGE_ID}/capture
client.captureCharge(chargeID, function(err, result) {
if (!err) {
console.log(result);
}
});
```

#### result example:
```json
{
"id": "20150913-150339-c26bvg57np",
"object": "charge",
"created": 1442156619,
"livemode": false,
"paid": true,
"amount": 1080,
"currency": "JPY",
"refunded": false,
"card": {},
"source": {},
"captured": true,
"refunds": [],
"amount_refunded": null,
"customer": null,
"description": null,
"dispute": null,
"metadata": {},
"statement_description": null
}
```

## Refund a Charge
``POST https://api.spike.cc/v1/charges/{CHARGE_ID}/refund``

Expand Down
21 changes: 21 additions & 0 deletions lib/spike-api.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,27 @@ SpikeAPI.prototype.getCharge = function(id, callback) {
this._request('get', url, options, callback);
};

/**
* Capture the charge of specified ID by REST API.
* @param {string} id Charge ID.
* @param {function} callback function(err, result)
**/
SpikeAPI.prototype.captureCharge = function(id, callback) {
// validate argments
var isValid = _validateArgs([
'String', 'Function'
], arguments);

if (isValid !== true) {
return isValid.callback(isValid.err);
}
var url = REST_BASE_URL + 'charges/' + id + '/capture';
var options = this.requestDefaults;

// post API
this._request('post', url, options, callback);
};

/**
* Refund the charge of specified ID by REST API.
* @param {string} id charge id.
Expand Down
266 changes: 265 additions & 1 deletion test/spike-api.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -405,6 +405,204 @@ describe('SpikeAPI', function() {
});


/**
* SpileAPI#captureCharge()
*/
describe('#captureCharge()', function() {

it('should return an error when invalid arguments.', function(done) {
var client = new SpikeAPI();
client.captureCharge(123, function(err) {
err.should.to.be.an.instanceof(Error);
err.message.should.to.equal('Invalid argments.');
done();
});
});

it('should throw an error ' +
'when invalid arguments and no callback.', function() {
var client = new SpikeAPI();
client.captureCharge.should.throw(Error);
});

it('should return an error when invalid secret key.', function(done) {
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges/xxxxx/capture')
.reply(401, {}, {
Status: '401 Unauthorized'
});
}
var client = new SpikeAPI();
client.captureCharge('xxxxx', function(err) {
err.should.to.be.an.instanceof(Error);
err.should.to.have.property('message', '401 Unauthorized');
done();
});
});

it('should return an error when invalid charge id.', function(done) {
var invalidID = 'invalid-id';
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges/' + invalidID + '/capture')
.reply(400, {
error: {
type: 'invalid_request_error'
}
}, {
Status: '400 Bad Request'
});
}
var client = new SpikeAPI({secretKey: testConfig.secretKey});
client.captureCharge(invalidID, function(err, result) {
err.should.to.be.an.instanceof(Error);
err.should.to.have.property('message', '400 Bad Request');
result.should.to.have.property('error');
result.error.should.to.have.property(
'type', 'invalid_request_error');
done();
});
});

it('should capture the charge of the specified ID ' +
'when valid arguments.', function(done) {
// Create a new charge for capture.
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges')
.reply(201, {
'id': '20150213-090658-xxxxxxxxx',
'created': 1423818418,
'paid': false,
'refunded': false,
'refunds': [],
'captured': false
});
}
var client = new SpikeAPI({secretKey: testConfig.secretKey});
client.postCharge({
currency: 'JPY',
amount: 1080,
card: testConfig.cardToken,
capture: false,
products: products
}, function(err, result) {
if (err) {
return done(err);
}

// test #captureCharge()
var chargeID = result.id;
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges/' + chargeID + '/capture')
.reply(200, {
id: chargeID,
object: 'charge',
paid: true,
captured: true,
amount: 1080,
currency: 'JPY',
refunded: false
});
}

var client = new SpikeAPI({secretKey: testConfig.secretKey});
client.captureCharge(chargeID, function(err, result) {
should.equal(err, null);
result.should.to.have.property('id', chargeID);
result.should.to.have.property('object', 'charge');
result.should.to.have.property('paid', true);
result.should.to.have.property('captured', true);
result.should.to.have.property('refunded', false);
done();
});
});
});

it('should return an error when capturing the captured charge',
function(done) {
// Create a new charge for capture.
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges')
.reply(201, {
'id': '20150213-090658-xxxxxxxxx',
'created': 1423818418,
'paid': false,
'refunded': false,
'refunds': [],
'captured': false
});
}
var client = new SpikeAPI({secretKey: testConfig.secretKey});
client.postCharge({
currency: 'JPY',
amount: 1080,
card: testConfig.cardToken,
capture: false,
products: products
}, function(err, result) {
if (err) {
return done(err);
}

// test #captureCharge()
var chargeID = result.id;
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges/' + chargeID + '/capture')
.reply(200, {
id: chargeID,
object: 'charge',
paid: true,
captured: true,
amount: 1080,
currency: 'JPY',
refunded: false
});
}

var client = new SpikeAPI({secretKey: testConfig.secretKey});
client.captureCharge(chargeID, function(err, result) {
if (err) {
return done(err);
}
should.equal(err, null);
result.should.to.have.property('id', chargeID);
result.should.to.have.property('object', 'charge');
result.should.to.have.property('paid', true);
result.should.to.have.property('captured', true);
result.should.to.have.property('refunded', false);

if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges/' + chargeID + '/capture')
.reply(400, {
error: {
type: 'invalid_request_error',
message: 'Unable to capture order. The order is ' +
'already cancelled or captured.'
}
}, {
Status: '400 Bad Request'
});
}
client.captureCharge(chargeID, function(err, result) {
err.should.to.be.an.instanceof(Error);
err.should.to.have.property('message', '400 Bad Request');
result.should.to.have.property('error');
result.error.should.to.have.property(
'type', 'invalid_request_error');
done();
});
});
});
});
});


/**
* SpileAPI#refundCharge()
*/
Expand Down Expand Up @@ -465,7 +663,7 @@ describe('SpikeAPI', function() {
});
});

it('should to refund the charge of the specified ID ' +
it('should to refund the captured charge of the specified ID ' +
'when valid arguments.', function(done) {
// Create a new charge for refund.
if (!isActualTest) {
Expand Down Expand Up @@ -528,6 +726,72 @@ describe('SpikeAPI', function() {
});
});
});

it('should to refund the non-captured charge of the specified ID ' +
'when valid arguments.', function(done) {
// Create a new charge for refund.
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges')
.reply(201, {
'id': '20150213-090658-xxxxxxxxx',
'created': 1423818418,
'captured': false,
'paid': false,
'refunded': false
});
}
var client = new SpikeAPI({secretKey: testConfig.secretKey});
client.postCharge({
currency: 'JPY',
amount: 1080,
card: testConfig.cardToken,
capture: false,
products: products
}, function(err, result) {
if (err) {
return done(err);
}

// test #refundCharge()
var chargeID = result.id;
if (!isActualTest) {
nock('https://api.spike.cc/')
.post('/v1/charges/' + chargeID + '/refund')
.reply(200, {
id: chargeID,
object: 'charge',
paid: false,
captured: false,
amount: 1080,
currency: 'JPY',
refunded: true,
refunds: [
{
object: 'refund',
created: 1400220648,
amount: 1080,
currency: 'JPY'
}
]
});
}

var client = new SpikeAPI({secretKey: testConfig.secretKey});
client.refundCharge(chargeID, function(err, result) {
should.equal(err, null);
result.should.to.have.property('id', chargeID);
result.should.to.have.property('object', 'charge');
result.should.to.have.property('paid', false);
result.should.to.have.property('captured', false);
result.should.to.have.property('refunded', true);
result.should.to.have.property('refunds');
result.refunds[0].should.to.have.property('object', 'refund');
result.refunds[0].should.to.have.property('amount', 1080);
done();
});
});
});
});


Expand Down

0 comments on commit ec93d21

Please sign in to comment.