Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hndrs/stripe-spring-boot-starter
https://github.com/hndrs/stripe-spring-boot-starter
spring-boot spring-boot-starter stripe stripe-checkout stripe-event stripe-payments webhook
Last synced: 20 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/hndrs/stripe-spring-boot-starter
- Owner: hndrs
- License: mit
- Created: 2021-02-13T13:23:57.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-03-08T22:13:19.000Z (almost 4 years ago)
- Last Synced: 2023-03-07T15:08:37.326Z (almost 2 years ago)
- Topics: spring-boot, spring-boot-starter, stripe, stripe-checkout, stripe-event, stripe-payments, webhook
- Language: Kotlin
- Homepage:
- Size: 65.4 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://search.maven.org/search?q=io.hndrs)
[](https://sonarcloud.io/dashboard?id=hndrs_stripe-spring-boot-starter)
[]()
[]()
[](https://github.com/sponsors/marvinschramm)
# stripe-spring-boot-starter
Follow the [Getting Started Guide](GETTING_STARTED_GUIDE.md) or look at the [Sample](/sample) to help setting up
stripe-spring-boot-starter.
#### Dependency
```kotlin
implementation("io.hndrs:stripe-spring-boot-starter:1.0.0")
//skip this if you already have the stripe dependency in your project
implementation("com.stripe:stripe-java:")
```
> Gradle
#### Configuration
```properties
hndrs.stripe.signing-secret=whsec_*******************
hndrs.stripe.webhook-path=/stripe-events
```
> application.properties
#### StripeEventReceiver
There are 3 conditional methods that can be used to narrow the execution condition (Note: there is an
internal ```class``` conditional that makes sure that the receiver only receives the defined generic type. You can
override any of the following methods (by default they return true)
- ```onCondition(event: Event)```
- *It is recommended to use this conditional to check at least the event type*
- ```onReceive(stripeObject: Subscription)```
- *It is recommended to use this when your condition **only** needs values from the ```stripeObject``` for your
business logic
- ```onCondition(previousAttributes: Map?)```
- *It is recommended to use this conditional when your condition needs **only** values from
the ```previousAttributes```*
- ```onCondition(previousAttributes: Map?, stripeObject: Subscription)```
- *It is recommended to use this conditional when your condition needs a combination of the ```previousAttributes```
and the received ```stripeObject```*
Implementing a ```StripeEventReceiver``` looks like the following:
```kotlin
@Component
open class ExampleReceiver : StripeEventReceiver(Subscription::class.java) {
override fun onCondition(event: Event): Boolean {
// conditional based stripe event
return event.type == "customer.subscription.updated"
}
override fun onCondition(stripeObject: Subscription): Boolean {
// conditional based stripe object
return true
}
override fun onCondition(previousAttributes: Map): Boolean {
// conditional based on previousAttributes
return true
}
override fun onCondition(previousAttributes: Map, stripeObject: Subscription): Boolean {
// conditional based previousAttributes and stripe object
return true
}
override fun onReceive(stripeObject: Subscription) {
// do something with the received object
}
}
```
> The ```StripeEventReceiver``` generic needs to be subclass of a [StripeObject](https://github.com/stripe/stripe-java/blob/master/src/main/java/com/stripe/model/StripeObject.java)
#### Accessing Snapshots
To access [snapshot builds](https://github.com/hndrs/stripe-spring-boot-starter/packages) add the following to your
gradle script
```kotlin
maven {
url = uri("https://maven.pkg.github.com/hndrs/stripe-spring-boot-starter")
credentials {
username = ""
password = " Your personal access token needs the read:packages scope (Download packages from GitHub Package Registry)