Skip to content

stelace/stelace-stripe

Repository files navigation

Stelace plugin: Stripe wrapper

Stripe-node library endpoints are wrapped for convenience in this plugin so you can use them right from Stelace SDK or Workflows.

CircleCI JavaScript Style Guide Conventional Commits

For instructions about using and developing Stelace plugins, have a look at server docs.

Example usage

With Stelace JavaScript SDK:

const { createInstance } = require('stelace')

// Please ensure the code is run in a secure environment
// The API key must include the permission 'integrations:read_write:stripe'
const stelace = createInstance({ apiKey: 'seck_...' })

const customers = await stelace.forward.post('/integrations/stripe/request', {
  // It will invoke the method `stripe.customers.list` from Stripe Node.js SDK
  // https://github.com/stripe/stripe-node
  // method invoked without parameters
  method: 'customers.list'
})

const customer = await stelace.forward.post('/integrations/stripe/request', {
  method: 'customers.create',

  // one parameter
  args: {
    name: 'Jenny Rosen'
  }
})

const updatedCustomer = await stelace.forward.post('/integrations/stripe/request', {
  method: 'customers.update',

  // multiple parameters
  args: [
    customer.id,
    {
      email: '[email protected]'
    }
  ]
})

const deletedCustomer = await stelace.forward.post('/integrations/stripe/request', {
  method: 'customers.del',

  // one parameter
  args: customer.id
})

With plain REST API calls, using axios:

const axios = require('axios')

const encodeBase64 = str => Buffer.from(str).toString('base64')

// Please ensure the code is run in a secure environment
// The API key must include the permission 'integrations:read_write:stripe'
const secretApiKey = 'seck_...'

const authorizationHeaders = {
  authorization: `Basic ${encodeBase64(`${secretApiKey}:`)}`
}

const { data: customers } = await axios.post(
  'https://api.stelace.com/integrations/stripe/request',

  // It will invoke the method `stripe.customers.list` from Stripe Node.js SDK
  // https://github.com/stripe/stripe-node
  // method invoked without parameters
  { method: 'customers.list' },
  { headers: authorizationHeaders }
)

const { data: customer } = await axios.post(
  'https://api.stelace.com/integrations/stripe/request',
  {
    method: 'customers.create',

    // one parameter
    args: {
      name: 'Jenny Rosen'
    }
  },
  { headers: authorizationHeaders }
)

const { data: updatedCustomer } = await axios.post(
  'https://api.stelace.com/integrations/stripe/request',
  {
    method: 'customers.update',

    // multiple parameters
    args: [
      customer.id,
      {
        email: '[email protected]'
      }
    ]
  },
  { headers: authorizationHeaders }
)

const { data: deletedCustomer } = await axios.post(
  'https://api.stelace.com/integrations/stripe/request',
  {
    method: 'customers.del',

    // one parameter
    args: customer.id
  },
  { headers: authorizationHeaders }
)

Configuration

The Stripe plugin works if the following private configuration values are provided:

With Stelace SDK:

await stelace.config.updatePrivate({
  stelace: {
    integrations: {
      stripe: {
        secretApiKey, // Stripe secret API key

        // Stripe webhook secret,
        // optional but recommended if you want to have access to Stripe events within Stelace
        webhookSecret
      }
    }
  }
})

Equivalent to:

await axios.patch(
  'https://api.stelace.com/config/private',
  {
    // config body
  },
  { headers: authorizationHeaders }
)

Tests and development

A Stripe secret API key must be provided in the .env file, or in CI environment.

STRIPE_SECRET_API_KEY=...

Install plugin dependencies:

yarn

Databases should be up and running. You can use stelace-server installed as a dependency for development:

# not needed if you’re already running stelace-server databases
yarn --cwd node_modules/stelace-server/ run docker:db

Please also ensure that additional stelace-server plugins specified in the server environment variable INSTALLED_PLUGINS are installed:

yarn plugins:server

Run tests

yarn test

Run plugin tests and all server tests with yarn test:server.

License

© Stelace 2019-present

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

A copy of the GNU General Public License is included in this program, and is also available at https://www.gnu.org/licenses/gpl-3.0.txt.

About

Stelace server wrapper plugin for Stripe

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 3

  •  
  •  
  •