Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svileng/stripy
Micro wrapper for Stripe's REST API.
https://github.com/svileng/stripy
elixir payments stripe stripe-api
Last synced: about 1 month ago
JSON representation
Micro wrapper for Stripe's REST API.
- Host: GitHub
- URL: https://github.com/svileng/stripy
- Owner: svileng
- License: mit
- Created: 2017-08-18T15:13:12.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2020-08-03T14:06:33.000Z (over 4 years ago)
- Last Synced: 2024-03-15T06:04:15.479Z (10 months ago)
- Topics: elixir, payments, stripe, stripe-api
- Language: Elixir
- Homepage: https://hexdocs.pm/stripy
- Size: 22.5 KB
- Stars: 52
- Watchers: 1
- Forks: 10
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Stripy [](https://hex.pm/packages/stripy) [](https://hexdocs.pm/stripy)
Stripy is a micro wrapper intended to be
used for sending requests to Stripe's REST API. It is
made for developers who prefer to work directly with the
official API and provide their own abstractions on top
if such are needed.
Stripy takes care of setting headers, encoding the data,
configuration settings, etc (the usual boring boilerplate);
it also makes testing easy by letting you plug your own
mock server (see Testing section below).
Some basic examples:
```elixir
iex> Stripy.req(:get, "subscriptions")
{:ok, %HTTPoison.Response{...}}
iex> Stripy.req(:post, "customers", %{"email" => "[email protected]", "metadata[user_id]" => 1})
{:ok, %HTTPoison.Response{...}}
```
Where `subscriptions` and `customers` are [REST API resources](https://stripe.com/docs/api).
If you prefer to work with a higher-level library, check out
"stripity_stripe" or "stripe_elixir" on Hex.
## Installation
Add to your `mix.exs` as usual:
```elixir
def deps do
[{:stripy, "~> 2.0"}]
end
```
If you're not using [application inference](https://elixir-lang.org/blog/2017/01/05/elixir-v1-4-0-released/#application-inference), then add `:stripy` to your `applications` list.
Then configure the `stripy` app per environment like so:
```elixir
config :stripy,
secret_key: "sk_test_xxxxxxxxxxxxx", # required
endpoint: "https://api.stripe.com/v1/", # optional
version: "2017-06-05", # optional
httpoison: [recv_timeout: 5000, timeout: 8000] # optional
```
You may also use environment variables:
``` elixir
config :stripy,
secret_key: {:system, "STRIPE_SECRET_KEY"},
endpoint: {:system, "STRIPE_ENDPOINT"},
version: {:system, "STRIPE_VERSION"}
```
## Testing
You can disable actual calls to the Stripe API like so:
```elixir
# Usually in your test.exs.
config :stripy,
testing: true
```
All functions that use Stripy would receive response `{:ok, %{status_code: 200, body: "{}"}}`.
To provide your own responses, you need to configure a mock server:
```elixir
config :stripy,
testing: true,
mock_server: MyApp.StripeMockServer
```
Here's an example mock server that mocks the `/customer` endpoint and returns a basic
object for a customer with id `cus_test`
```elixir
defmodule MyApp.StripeMockServer do
@behaviour Stripy.MockServer
@ok_res %{status_code: 200}
@impl Stripy.MockServer
def request(:get, "customers/cus_test", %{}) do
body = Poison.encode!(%{"email" => "[email protected]"})
{:ok, Map.put(@ok_res, :body, body)}
end
end
```
Now let's quickly write a naive function that gets user's billing email:
```elixir
def stripe_email(user) do
{:ok, res} = Stripy.req(:get, "customers/#{user.stripe_id}")
res["email"]
end
```
We can test it like so:
```elixir
fake_user = %{stripe_id: "cus_test"}
assert stripe_email(fake_user) == "[email protected]"
```
## Custom headers
You can add custom headers to the request by supplying a fourth parameter:
```elixir
Stripy.req(:post, "charges", %{amount: 1000}, %{"Idempotency-Key" => "123456"})
```
## License
- Stripy: See LICENSE file.