Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wallee-payment/ruby-sdk
The ruby SDK allows an easy integration of wallee into ruby applications.
https://github.com/wallee-payment/ruby-sdk
payment payment-integration ruby ruby-sdk rubygem wallee
Last synced: about 2 months ago
JSON representation
The ruby SDK allows an easy integration of wallee into ruby applications.
- Host: GitHub
- URL: https://github.com/wallee-payment/ruby-sdk
- Owner: wallee-payment
- License: apache-2.0
- Created: 2017-07-12T11:59:29.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-02-12T14:01:40.000Z (11 months ago)
- Last Synced: 2024-04-24T08:18:22.532Z (9 months ago)
- Topics: payment, payment-integration, ruby, ruby-sdk, rubygem, wallee
- Language: Ruby
- Size: 2.3 MB
- Stars: 4
- Watchers: 6
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wallee Ruby Library
The wallee Ruby library wraps around the wallee API. This library facilitates your interaction with various services such as transactions, accounts, and subscriptions.
## Documentation
[wallee Web Service API](https://app-wallee.com/doc/api/web-service)
## Requirements
- Ruby 3.0.0+
## Installation
# RubyGem install (recommended)
```sh
$ gem install wallee-ruby-sdk
```
## Usage
The library needs to be configured with your account's space id, user id, and secret key which are available in your [wallee
account dashboard](https://app-wallee.com/account/select). Set `space_id`, `user_id`, and `api_secret` to their values. You can also optionally set `default_headers` to set some headers that will be sent to all requests:
### Configuring a Service
```ruby
require 'wallee-ruby-sdk'
space_id = 405
app_user_id = 512
app_user_key = "FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ="
# default_headers is an optional param, that represents headers sent to all requests
# timeout is an optional param, that allows to configure custom timeout (default is 25 seconds)
Wallee.configure do |config|
config.user_id = app_user_id
config.authentication_key = app_user_key
config.default_headers = {"x-meta-custom-header": 'value-1', "x-meta-custom-header-2": 'value-2'}
config.timeout = 60
end
# TransactionService
transaction_service = Wallee::TransactionService.new
# TransactionPaymentPageService
transaction_payment_page_service = Wallee::TransactionPaymentPageService.new
```
To get stated with sending transactions you can review the example below:
```ruby
require 'wallee-ruby-sdk'
space_id = 405
app_user_id = 512
app_user_key = "FKrO76r5VwJtBrqZawBspljbBNOxp5veKQQkOnZxucQ="
# timeout is an optional param, that allows to configure custom timeout (default is 25 seconds)
Wallee.configure do |config|
config.user_id = app_user_id
config.authentication_key = app_user_key
config.timeout = 60
end
# TransactionService
transaction_service = Wallee::TransactionService.new
# TransactionPaymentPageService
transaction_payment_page_service = Wallee::TransactionPaymentPageService.new
transaction = Wallee::TransactionCreate.new({
billingAddress: Wallee::AddressCreate.new({
city: "City",
country: "US",
emailAddress: "[email protected]",
familyName: "Family",
givenName: "Given",
postCode: "98100",
postalState: "WA",
street: "Street"
}),
currency: 'EUR',
customerEmailAddress: "[email protected]",
customerPresence: Wallee::CustomersPresence::VIRTUAL_PRESENT,
failedUrl: "http://localhost/failure",
invoiceMerchantReference: "order-1",
language: "en_US",
lineItems: [
Wallee::LineItemCreate.new({
amountIncludingTax: 29.60,
name: "Item 1",
quantity: 1,
shippingRequired: true,
sku: "sku-1",
taxes: [
Wallee::TaxCreate.new({
rate: 8,
title: "VAT"
})
],
type: Wallee::LineItemType::PRODUCT,
uniqueId: "unique-id-item-1",
}),
Wallee::LineItemCreate.new({
amountIncludingTax: 5.60,
name: "Test Shipping",
quantity: 1,
shippingRequired: false,
sku: "test-shipping",
taxes: [
Wallee::TaxCreate.new({
rate: 8,
title: "VAT"
})
],
type: Wallee::LineItemType::SHIPPING,
uniqueId: "unique-id-shipping-1",
}),
],
merchantReference: "order-1",
shippingAddress: Wallee::AddressCreate.new({
city: "City",
country: "US",
emailAddress: "[email protected]",
familyName: "Family",
givenName: "Given",
postCode: "98100",
postalState: "WA",
street: "Street"
}),
shippingMethod: "Test Shipping",
successUrl: "http://localhost/success"
})
transaction = transaction_service.create(space_id, transaction)
payment_page_url = transaction_payment_page_service.payment_page_url(space_id, transaction.id)
# redirect to payment_page_url
```
### Integrating Webhook Payload Signing Mechanism into webhook callback handler
The HTTP request which is sent for a state change of an entity now includes an additional field `state`, which provides information about the update of the monitored entity's state. This enhancement is a result of the implementation of our webhook encryption mechanism.
Payload field `state` provides direct information about the state update of the entity, making additional API calls to retrieve the entity state redundant.
#### ⚠️ Warning: Generic Pseudocode
> **The provided pseudocode is intentionally generic and serves to illustrate the process of enhancing your API to leverage webhook payload signing. It is not a complete implementation.**
>
> Please ensure that you adapt and extend this code to meet the specific needs of your application, including appropriate security measures and error handling.
For a detailed webhook payload signing mechanism understanding we highly recommend referring to our comprehensive
[Webhook Payload Signing Documentation](https://app-wallee.com/doc/webhooks#_webhook_payload_signing_mechanism).
```ruby
post '/webhook/callback' do
request_payload = request.body.read
signature = request.env['HTTP_X_SIGNATURE']
if signature.nil? || signature.empty?
# Make additional API call to retrieve the entity state
# ...
else
if webhook_encryption_service.is_content_valid(signature, request_payload)
# Parse request_payload to extract 'state' value
# Process entity's state change
# ...
end
end
# Process the received webhook data
# ...
end
```
## License
Please see the [license file](https://github.com/wallee-payment/ruby-sdk/blob/master/LICENSE) for more information.