should = require('chai').should()
expect = require('chai').expect
sinon = require 'sinon'
crypto = require 'crypto'
querystring = require 'querystring'
modulePath = "../../../../app/js/Features/Subscription/RecurlyWrapper"
SandboxedModule = require('sandboxed-module')
tk = require("timekeeper")
fixtures =
"subscriptions/44f83d7cba354d5b84812419f923ea96":
"" +
"" +
" " +
" " +
" gold" +
" Gold plan" +
" " +
" 44f83d7cba354d5b84812419f923ea96" +
" active" +
" 800" +
" EUR" +
" 1" +
" 2011-05-27T07:00:00Z" +
" " +
" " +
" 2011-06-27T07:00:00Z" +
" 2011-07-27T07:00:00Z" +
" " +
" " +
" " +
" " +
" ipaddresses" +
" 10" +
" 150" +
" " +
" " +
" " +
" " +
" " +
""
"recurly_js/result/70db44b10f5f4b238669480c9903f6f5":
"" +
"" +
" " +
" " +
" gold" +
" Gold plan" +
" " +
" 44f83d7cba354d5b84812419f923ea96" +
" active" +
" 800" +
" EUR" +
" 1" +
" 2011-05-27T07:00:00Z" +
" " +
" " +
" 2011-06-27T07:00:00Z" +
" 2011-07-27T07:00:00Z" +
" " +
" " +
" " +
" " +
" ipaddresses" +
" 10" +
" 150" +
" " +
" " +
" " +
" " +
" " +
""
"accounts/104":
"" +
"" +
" " +
" " +
" " +
" " +
" " +
" " +
" 104" +
" active" +
" " +
" verena@example.com" +
" Verena" +
" Example" +
" " +
" a92468579e9c4231a6c0031c4716c01d" +
" 2011-10-25T12:00:00" +
""
mockApiRequest = (options, callback) ->
if fixtures[options.url]
callback(null, {statusCode : 200}, fixtures[options.url])
else
callback("Not found", {statusCode : 404})
describe "RecurlyWrapper", ->
before ->
@settings =
plans: [{
planCode: "collaborator"
name: "Collaborator"
features:
collaborators: -1
versioning: true
}]
defaultPlanCode:
collaborators: 0
versioning: false
apis:
recurly:
apiKey: 'nonsense'
privateKey: 'private_nonsense'
@RecurlyWrapper = RecurlyWrapper = SandboxedModule.require modulePath, requires:
"settings-sharelatex": @settings
"logger-sharelatex":
err: sinon.stub()
error: sinon.stub()
log: sinon.stub()
"request": sinon.stub()
describe "sign", ->
before (done) ->
tk.freeze Date.now() # freeze the time for these tests
@RecurlyWrapper.sign({
subscription :
plan_code : "gold"
name : "$$$"
}, (error, signature) =>
@signature = signature
done()
)
after ->
tk.reset()
it "should be signed correctly", ->
signed = @signature.split("|")[0]
query = @signature.split("|")[1]
crypto.createHmac("sha1", @settings.apis.recurly.privateKey).update(query).digest("hex").should.equal signed
it "should be url escaped", ->
query = @signature.split("|")[1]
should.equal query.match(/\[/), null
query.match(/\%5B/).should.not.equal null
it "should contain the passed data", ->
query = querystring.parse @signature.split("|")[1]
query["subscription[plan_code]"].should.equal "gold"
query["subscription[name]"].should.equal "$$$"
it "should contain a nonce", ->
query = querystring.parse @signature.split("|")[1]
should.exist query["nonce"]
it "should contain a timestamp", ->
query = querystring.parse @signature.split("|")[1]
query["timestamp"].should.equal Math.round(Date.now() / 1000) + ""
describe "_parseXml", ->
it "should convert different data types into correct representations", (done) ->
xml = """
gold
Gold plan
44f83d7cba354d5b84812419f923ea96
active
800
EUR
1
2011-05-27T07:00:00Z
2011-06-27T07:00:00Z
2011-07-27T07:00:00Z
ipaddresses
10
150
"""
@RecurlyWrapper._parseXml xml, (error, data) ->
data.subscription.plan.plan_code.should.equal "gold"
data.subscription.plan.name.should.equal "Gold plan"
data.subscription.uuid.should.equal "44f83d7cba354d5b84812419f923ea96"
data.subscription.state.should.equal "active"
data.subscription.unit_amount_in_cents.should.equal 800
data.subscription.currency.should.equal "EUR"
data.subscription.quantity.should.equal 1
data.subscription.activated_at.should.deep.equal new Date("2011-05-27T07:00:00Z")
should.equal data.subscription.canceled_at, null
should.equal data.subscription.expires_at, null
data.subscription.current_period_started_at.should.deep.equal new Date("2011-06-27T07:00:00Z")
data.subscription.current_period_ends_at.should.deep.equal new Date("2011-07-27T07:00:00Z")
should.equal data.subscription.trial_started_at, null
should.equal data.subscription.trial_ends_at, null
data.subscription.subscription_add_ons[0].should.deep.equal {
add_on_code: "ipaddresses"
quantity: "10"
unit_amount_in_cents: "150"
}
data.subscription.account.url.should.equal "https://api.recurly.com/v2/accounts/1"
data.subscription.url.should.equal "https://api.recurly.com/v2/subscriptions/44f83d7cba354d5b84812419f923ea96"
data.subscription.plan.url.should.equal "https://api.recurly.com/v2/plans/gold"
done()
describe "getSubscription", ->
describe "with proper subscription id", ->
before ->
@apiRequest = sinon.stub(@RecurlyWrapper, "apiRequest", mockApiRequest)
@RecurlyWrapper.getSubscription "44f83d7cba354d5b84812419f923ea96", (error, recurlySubscription) =>
@recurlySubscription = recurlySubscription
after ->
@RecurlyWrapper.apiRequest.restore()
it "should look up the subscription at the normal API end point", ->
@apiRequest.args[0][0].url.should.equal "subscriptions/44f83d7cba354d5b84812419f923ea96"
it "should return the subscription", ->
@recurlySubscription.uuid.should.equal "44f83d7cba354d5b84812419f923ea96"
describe "with ReculyJS token", ->
before ->
@apiRequest = sinon.stub(@RecurlyWrapper, "apiRequest", mockApiRequest)
@RecurlyWrapper.getSubscription "70db44b10f5f4b238669480c9903f6f5", {recurlyJsResult: true}, (error, recurlySubscription) =>
@recurlySubscription = recurlySubscription
after ->
@RecurlyWrapper.apiRequest.restore()
it "should return the subscription", ->
@recurlySubscription.uuid.should.equal "44f83d7cba354d5b84812419f923ea96"
it "should look up the subscription at the RecurlyJS API end point", ->
@apiRequest.args[0][0].url.should.equal "recurly_js/result/70db44b10f5f4b238669480c9903f6f5"
describe "with includeAccount", ->
beforeEach ->
@apiRequest = sinon.stub(@RecurlyWrapper, "apiRequest", mockApiRequest)
@RecurlyWrapper.getSubscription "44f83d7cba354d5b84812419f923ea96", {includeAccount: true}, (error, recurlySubscription) =>
@recurlySubscription = recurlySubscription
afterEach ->
@RecurlyWrapper.apiRequest.restore()
it "should request the account from the API", ->
@apiRequest.args[1][0].url.should.equal "accounts/104"
it "should populate the account attribute", ->
@recurlySubscription.account.account_code.should.equal "104"
describe "updateSubscription", ->
beforeEach (done) ->
@recurlySubscriptionId = "subscription-id-123"
@apiRequest = sinon.stub @RecurlyWrapper, "apiRequest", (options, callback) =>
@requestOptions = options
callback null, {}, fixtures["subscriptions/44f83d7cba354d5b84812419f923ea96"]
@RecurlyWrapper.updateSubscription @recurlySubscriptionId, { plan_code : "silver", timeframe: "now" }, (error, recurlySubscription) =>
@recurlySubscription = recurlySubscription
done()
afterEach ->
@RecurlyWrapper.apiRequest.restore()
it "should send an update request to the API", ->
@apiRequest.called.should.equal true
@requestOptions.body.should.equal """
silver
now
"""
@requestOptions.url.should.equal "subscriptions/#{@recurlySubscriptionId}"
@requestOptions.method.should.equal "put"
it "should return the updated subscription", ->
should.exist @recurlySubscription
@recurlySubscription.plan.plan_code.should.equal "gold"
describe "cancelSubscription", ->
beforeEach (done) ->
@recurlySubscriptionId = "subscription-id-123"
@apiRequest = sinon.stub @RecurlyWrapper, "apiRequest", (options, callback) =>
options.url.should.equal "subscriptions/#{@recurlySubscriptionId}/cancel"
options.method.should.equal "put"
callback()
@RecurlyWrapper.cancelSubscription(@recurlySubscriptionId, done)
afterEach ->
@RecurlyWrapper.apiRequest.restore()
it "should send a cancel request to the API", ->
@apiRequest.called.should.equal true
describe "reactivateSubscription", ->
beforeEach (done) ->
@recurlySubscriptionId = "subscription-id-123"
@apiRequest = sinon.stub @RecurlyWrapper, "apiRequest", (options, callback) =>
options.url.should.equal "subscriptions/#{@recurlySubscriptionId}/reactivate"
options.method.should.equal "put"
callback()
@RecurlyWrapper.reactivateSubscription(@recurlySubscriptionId, done)
afterEach ->
@RecurlyWrapper.apiRequest.restore()
it "should send a cancel request to the API", ->
@apiRequest.called.should.equal true
describe "redeemCoupon", ->
beforeEach (done) ->
@recurlyAccountId = "account-id-123"
@coupon_code = "312321312"
@apiRequest = sinon.stub @RecurlyWrapper, "apiRequest", (options, callback) =>
options.url.should.equal "coupons/#{@coupon_code}/redeem"
options.body.indexOf("#{@recurlyAccountId}").should.not.equal -1
options.body.indexOf("USD").should.not.equal -1
options.method.should.equal "post"
callback()
@RecurlyWrapper.redeemCoupon(@recurlyAccountId, @coupon_code, done)
afterEach ->
@RecurlyWrapper.apiRequest.restore()
it "should send the request to redem the coupon", ->
@apiRequest.called.should.equal true
describe "_addressToXml", ->
beforeEach ->
@address =
address1: "addr_one"
address2: "addr_two"
country: "some_country"
state: "some_state"
zip: "some_zip"
nonsenseKey: "rubbish"
it 'should generate the correct xml', () ->
result = @RecurlyWrapper._addressToXml @address
should.equal(
result,
"""
addr_one
addr_two
some_country
some_state
some_zip
\n
"""
)
describe 'createSubscription', ->
beforeEach ->
@user =
_id: 'some_id'
email: 'user@example.com'
@subscriptionDetails =
currencyCode: "EUR"
plan_code: "some_plan_code"
coupon_code: ""
isPaypal: true
address:
address1: "addr_one"
address2: "addr_two"
country: "some_country"
state: "some_state"
zip: "some_zip"
@subscription = {}
@recurly_token_id = "a-token-id"
@call = (callback) =>
@RecurlyWrapper.createSubscription(@user, @subscriptionDetails, @recurly_token_id, callback)
describe 'when paypal', ->
beforeEach ->
@subscriptionDetails.isPaypal = true
@_createPaypalSubscription = sinon.stub(@RecurlyWrapper, '_createPaypalSubscription')
@_createPaypalSubscription.callsArgWith(3, null, @subscription)
afterEach ->
@_createPaypalSubscription.restore()
it 'should not produce an error', (done) ->
@call (err, sub) =>
expect(err).to.equal null
expect(err).to.not.be.instanceof Error
done()
it 'should produce a subscription object', (done) ->
@call (err, sub) =>
expect(sub).to.deep.equal @subscription
done()
it 'should call _createPaypalSubscription', (done) ->
@call (err, sub) =>
@_createPaypalSubscription.callCount.should.equal 1
done()
describe "when _createPaypalSubscription produces an error", ->
beforeEach ->
@_createPaypalSubscription.callsArgWith(3, new Error('woops'))
it 'should produce an error', (done) ->
@call (err, sub) =>
expect(err).to.be.instanceof Error
done()
describe 'when not paypal', ->
beforeEach ->
@subscriptionDetails.isPaypal = false
@_createCreditCardSubscription = sinon.stub(@RecurlyWrapper, '_createCreditCardSubscription')
@_createCreditCardSubscription.callsArgWith(3, null, @subscription)
afterEach ->
@_createCreditCardSubscription.restore()
it 'should not produce an error', (done) ->
@call (err, sub) =>
expect(err).to.equal null
expect(err).to.not.be.instanceof Error
done()
it 'should produce a subscription object', (done) ->
@call (err, sub) =>
expect(sub).to.deep.equal @subscription
done()
it 'should call _createCreditCardSubscription', (done) ->
@call (err, sub) =>
@_createCreditCardSubscription.callCount.should.equal 1
done()
describe "when _createCreditCardSubscription produces an error", ->
beforeEach ->
@_createCreditCardSubscription.callsArgWith(3, new Error('woops'))
it 'should produce an error', (done) ->
@call (err, sub) =>
expect(err).to.be.instanceof Error
done()
describe '_createCreditCardSubscription', ->
beforeEach ->
@user =
_id: 'some_id'
email: 'user@example.com'
@subscriptionDetails =
currencyCode: "EUR"
plan_code: "some_plan_code"
coupon_code: ""
isPaypal: true
address:
address1: "addr_one"
address2: "addr_two"
country: "some_country"
state: "some_state"
zip: "some_zip"
@subscription = {}
@recurly_token_id = "a-token-id"
@apiRequest = sinon.stub(@RecurlyWrapper, 'apiRequest')
@response =
statusCode: 200
@body = "is_bad"
@apiRequest.callsArgWith(1, null, @response, @body)
@_parseSubscriptionXml = sinon.stub(@RecurlyWrapper, '_parseSubscriptionXml')
@_parseSubscriptionXml.callsArgWith(1, null, @subscription)
@call = (callback) =>
@RecurlyWrapper._createCreditCardSubscription(@user, @subscriptionDetails, @recurly_token_id, callback)
afterEach ->
@apiRequest.restore()
@_parseSubscriptionXml.restore()
it 'should not produce an error', (done) ->
@call (err, sub) =>
expect(err).to.not.be.instanceof Error
expect(err).to.equal null
done()
it 'should produce a subscription', (done) ->
@call (err, sub) =>
expect(sub).to.equal @subscription
done()
it 'should call apiRequest', (done) ->
@call (err, sub) =>
@apiRequest.callCount.should.equal 1
done()
it 'should call _parseSubscriptionXml', (done) ->
@call (err, sub) =>
@_parseSubscriptionXml.callCount.should.equal 1
done()
describe 'when api request produces an error', ->
beforeEach ->
@apiRequest.callsArgWith(1, new Error('woops'))
it 'should produce an error', (done) ->
@call (err, sub) =>
expect(err).to.be.instanceof Error
done()
it 'should call apiRequest', (done) ->
@call (err, sub) =>
@apiRequest.callCount.should.equal 1
done()
it 'should not _parseSubscriptionXml', (done) ->
@call (err, sub) =>
@_parseSubscriptionXml.callCount.should.equal 0
done()
describe 'when parse xml produces an error', ->
beforeEach ->
@_parseSubscriptionXml.callsArgWith(1, new Error('woops'))
it 'should produce an error', (done) ->
@call (err, sub) =>
expect(err).to.be.instanceof Error
done()
describe '_createPaypalSubscription', ->
beforeEach ->
@checkAccountExists = sinon.stub(@RecurlyWrapper._paypal, 'checkAccountExists')
@createAccount = sinon.stub(@RecurlyWrapper._paypal, 'createAccount')
@createBillingInfo = sinon.stub(@RecurlyWrapper._paypal, 'createBillingInfo')
@setAddress = sinon.stub(@RecurlyWrapper._paypal, 'setAddress')
@createSubscription = sinon.stub(@RecurlyWrapper._paypal, 'createSubscription')
@user =
_id: 'some_id'
email: 'user@example.com'
@subscriptionDetails =
currencyCode: "EUR"
plan_code: "some_plan_code"
coupon_code: ""
isPaypal: true
address:
address1: "addr_one"
address2: "addr_two"
country: "some_country"
state: "some_state"
zip: "some_zip"
@subscription = {}
@recurly_token_id = "a-token-id"
# set up data callbacks
user = @user
subscriptionDetails = @subscriptionDetails
recurly_token_id = @recurly_token_id
@checkAccountExists.callsArgWith(1, null,
{user, subscriptionDetails, recurly_token_id,
userExists: false, account: {accountCode: 'xx'}}
)
@createAccount.callsArgWith(1, null,
{user, subscriptionDetails, recurly_token_id,
userExists: false, account: {accountCode: 'xx'}}
)
@createBillingInfo.callsArgWith(1, null,
{user, subscriptionDetails, recurly_token_id,
userExists: false, account: {accountCode: 'xx'}, billingInfo: {token_id: 'abc'}}
)
@setAddress.callsArgWith(1, null,
{user, subscriptionDetails, recurly_token_id,
userExists: false, account: {accountCode: 'xx'}, billingInfo: {token_id: 'abc'}}
)
@createSubscription.callsArgWith(1, null,
{user, subscriptionDetails, recurly_token_id,
userExists: false, account: {accountCode: 'xx'}, billingInfo: {token_id: 'abc'}, subscription: @subscription}
)
@call = (callback) =>
@RecurlyWrapper._createPaypalSubscription @user, @subscriptionDetails, @recurly_token_id, callback
afterEach ->
@checkAccountExists.restore()
@createAccount.restore()
@createBillingInfo.restore()
@setAddress.restore()
@createSubscription.restore()
it 'should not produce an error', (done) ->
@call (err, sub) =>
expect(err).to.not.be.instanceof Error
done()
it 'should produce a subscription object', (done) ->
@call (err, sub) =>
expect(sub).to.not.equal null
expect(sub).to.equal @subscription
done()
it 'should call each of the paypal stages', (done) ->
@call (err, sub) =>
@checkAccountExists.callCount.should.equal 1
@createAccount.callCount.should.equal 1
@createBillingInfo.callCount.should.equal 1
@setAddress.callCount.should.equal 1
@createSubscription.callCount.should.equal 1
done()
describe 'when one of the paypal stages produces an error', ->
beforeEach ->
@createAccount.callsArgWith(1, new Error('woops'))
it 'should produce an error', (done) ->
@call (err, sub) =>
expect(err).to.be.instanceof Error
done()
it 'should stop calling the paypal stages after the error', (done) ->
@call (err, sub) =>
@checkAccountExists.callCount.should.equal 1
@createAccount.callCount.should.equal 1
@createBillingInfo.callCount.should.equal 0
@setAddress.callCount.should.equal 0
@createSubscription.callCount.should.equal 0
done()