pcp-server-ruby-sdk

PAYONE Commerce Platform Ruby SDK

Welcome to the Ruby SDK for the PAYONE Commerce Platform (api-version 1.35.0)! This repository contains a powerful, easy-to-use software development kit (SDK) designed to simplify the integration of online payment processing into your applications.

Requirements

This SDK requires Ruby 3.2 or later.

Table of Contents

• Features
• Installation
• Usage
  • General
  • Authentication Token Retrieval
  • Error Handling
  • Client Side
  • Apple Pay
• Demo App
• Contributing
• Releasing the library
  • Preparing the Release
  • Changelog Generation with Conventional Changelog
  • Merging the Release Branch
  • GitHub Action for Release
  • Optional: Creating a GitHub Release
• License

Features

• Easy Integration: Seamlessly integrate online payment processing into your application.
• Secure Transactions: Built with security best practices to ensure safe transactions.
• Extensive Documentation: Detailed documentation to help you get started quickly.
• Open Source: Fully open source and community-driven.

Installation

gem install pcp-server-ruby-sdk

back to top

Usage

General

To use this SDK you need to construct a PCPServerSDK::CommunicatorConfiguration which encapsulate everything needed to connect to the PAYONE Commerce Platform.

require 'pcp-server-ruby-sdk'

api_key = ENV['API_KEY']
api_secret = ENV['API_SECRET']

communicator_configuration = PCPServerSDK::CommunicatorConfiguration.new(
  api_key,
  api_secret,
  'https://api.preprod.commerce.payone.com'
)

With the configuration you can create an API client for each reource you want to interact with. For example to create a commerce case you can use the PCPServerSDK::Endpoints::CommerceCaseApiClient.

require 'pcp-server-ruby-sdk'

client = PCPServerSDK::Endpoints::CommerceCaseApiClient.new(communicator_configuration)

All payloads and reponses are availabe as ruby classes within the pcp-server-ruby-sdk package. The serialization and deserialization is handled by the SDK internally. For example, to create an empty commerce case you can pass a PCPServerSDK::Models::CreateCommerceCaseRequest instance:

createCommerceCaseRequest = PCPServerSDK::Models::CreateCommerceCaseRequest.new
createCommerceCaseResponse = client.create_commerce_case_request('merchant_id', createCommerceCaseRequest);

The models directly map to the API as described in PAYONE Commerce Platform API Reference. For an in depth example you can take a look at the demo app.

Authentication Token Retrieval

To interact with certain client-side SDKs (such as the credit card tokenizer), you need to generate a short-lived authentication JWT token for your merchant. This token can be retrieved using the SDK as follows:

require 'pcp-server-ruby-sdk'

authentication_client = PCPServerSDK::Endpoints::AuthenticationApiClient.new(communicator_configuration)
token = authentication_client.get_authentication_tokens(merchant_id)
puts "JWT Token: #{token.token}"
puts "Token ID: #{token.id}"
puts "Created: #{token.creation_date}"
puts "Expires: #{token.expiration_date}"

This token can then be used for secure operations such as initializing the credit card tokenizer or other client-side SDKs that require merchant authentication. The token is valid for a limited time (10 minutes) and should be handled securely.

Note: The get_authentication_tokens method requires a valid merchant_id. Optionally, you can provide an X-Request-ID header for tracing requests.

Error Handling

When making a request any client may throw a PCPServerSDK::Errors::ApiException. There two subtypes of this exception:

• PCPServerSDK::Errors::ApiErrorReponseException: This exception is thrown when the API returns an well-formed error response. The given errors are deserialized into PCPServerSDK::Models::APIError objects which are availble via the get_errors method on the exception. They usually contain useful information about what is wrong in your request or the state of the resource.
• PCPServerSDK::Errors::ApiResponseRetrievalException: This exception is a catch-all exception for any error that cannot be turned into a helpful error response. This includes malformed responses or unknown responses.

Network errors are not wrap, you can should handle the standard IOExeption.

Client Side

For most payment methods some information from the client is needed, e.g. payment information given by Apple when a payment via ApplePay suceeds. PAYONE provides client side SDKs which helps you interact the third party payment providers. You can find the SDKs under the PAYONE GitHub organization. Either way ensure to never store or even send credit card information to your server. The PAYONE Commerce Platform never needs access to the credit card information. The client side is responsible for safely retrieving a credit card token. This token must be used with this SDK.

Apple Pay

When a client is successfully made a payment via ApplePay it receives a ApplePayPayment. This structure is accessible as the PCPServerSDK::Models::ApplePayPayment class. You can use the PCPServerSDK::Transformer::ApplePayTransformer to map an PCPServerSDK::Models::ApplePayPayment to a PCPServerSDK::Models::MobilePaymentMethodSpecificInput which can be used for payment executions or order requests. The transformer has a static method PCPServerSDK::Transformer::transformApplePayPaymentToMobilePaymentMethodSpecificInput which takes an PCPServerSDK::Models::ApplePayPayment and returns a PCPServerSDK::Models::MobilePaymentMethodSpecificInput. The transformer does not check if the response is complete, if anything is missing the field will be set to null.

require 'pcp-server-ruby-sdk'

payment = PCPServerSDK::Models::ApplePayPayment.new(get_json_string_from_request_somehow)
# input is of type PCPServerSDK::Models::MobilePaymentMethodSpecificInput
input = PCPServerSDK::Transformer::transformApplePayPaymentToMobilePaymentMethodSpecificInput(payment)

back to top

Demo App

API_KEY=api_key API_SECRET=api_secret MERCHANT_ID=123 COMMERCE_CASE_ID=234 CHECKOUT_ID=345 ./scripts.sh run

back to top

Contributing

See Contributing

back to top

Releasing the library

Preparing the Release

• Checkout develop branch
• Create release branch (release/0.1.0)

git checkout -b release/0.1.0

• Run scripts.sh script to set correct version

./scripts.sh version 0.1.0

Changelog Generation with Conventional Changelog

When calling the ./scripts.sh version script, the changelog will now be generated automatically using conventional-changelog.

• Conventional Commit Messages:

  • Ensure all commit messages follow the conventional commit format, which is crucial for automatic changelog generation.
  • Commit messages should be in the format: type(scope): subject.

• Enforcing Commit Messages:

  • We enforce conventional commit messages using Lefthook with commitlint.
  • This setup ensures that all commit messages are validated before they are committed.

• Automatic Changelog Generation:

  • The ./scripts.sh version script will automatically generate and update the CHANGELOG.md file.
  • After running the script, review the updated changelog to ensure accuracy before proceeding with the release.

Merging the Release Branch

• Create PR on develop branch
• Merge develop in main branch

GitHub Action for Release

After successfully merging all changes to the main branch, an admin can trigger a GitHub Action to finalize and publish the release. This action ensures that the release process is automated, consistent, and deploys the new release from the main branch.

Triggering the GitHub Action:

• Only admins can trigger the release action.
• Ensure that all changes are committed to the main branch.
• Navigate to the Actions tab on your GitHub repository and manually trigger the release action for the main branch.

Optional: Creating a GitHub Release

Once the release has been published to PyPi, developers can start using the latest version of the SDK. However, if you want to make the release more visible and include detailed release notes, you can optionally create a GitHub release.

• Navigate to the Releases Page: Go to the "Releases" section of your repository on GitHub.
• Draft a New Release: Click "Draft a new release".
• Tag the Release: Select the version tag that corresponds to the version you just published on npm (e.g., v0.1.0).
• Release Title: Add a descriptive title for the release (e.g., v0.1.0 - Initial Release).
• Auto-Generated Release Notes: GitHub can automatically generate release notes based on merged pull requests and commit history. You can review these notes, adjust the content, and highlight important changes.
• Publish the Release: Once you're satisfied with the release notes, click "Publish release".

Creating a GitHub release is optional, but it can provide additional context and visibility for your users. For detailed guidance, refer to the GitHub documentation on managing releases.

back to top

License

This project is licensed under the MIT License - see the LICENSE file for details.

Thank you for using our SDK for Online Payments! If you have any questions or need further assistance, feel free to open an issue or contact us.