Skip to content

Latest commit

 

History

History
238 lines (179 loc) · 9.25 KB

README.md

File metadata and controls

238 lines (179 loc) · 9.25 KB
Raw

Checkout.com Ruby SDK

build-status CodeQL

build-status GitHub release Gem Version

GitHub license

Getting started

Version 1.0.0 is here!

We improved the initialization of SDK making it easier to understand the available options.
Now NAS accounts are the default instance for the SDK and ABC structure was moved to a previous prefixes.

Gem installer

gem install checkout_sdk

Bundler

Bundler provides a consistent environment for Ruby projects by tracking and installing the exact gems and versions that you need.

source 'https://rubygems.org'

gem 'checkout_sdk'

🚀 Please check in GitHub releases for all the versions available.

📖 Checkout our official documentation.

📚 Check out our official API documentation guide, where you can also find more usage examples.

How to use the SDK

This SDK can be used with two different pair of API keys provided by Checkout. However, using different API keys imply using specific API features.
Please find in the table below the types of keys that can be used within this SDK.

Account System Public Key (example) Secret Key (example)
Default pk_pkhpdtvabcf7hdgpwnbhw7r2uic sk_m73dzypy7cf3gf5d2xr4k7sxo4e
Previous pk_g650ff27-7c42-4ce1-ae90-5691a188ee7b sk_gk3517a8-3z01-45fq-b4bd-4282384b0a64

Note: sandbox keys have a sbox_ or test_ identifier, for Default and Previous accounts respectively.

If you don't have your own API keys, you can sign up for a test account here.

PLEASE NEVER SHARE OR PUBLISH YOUR CHECKOUT CREDENTIALS.

Default

Default keys client instantiation can be done as follows:

api = CheckoutSdk.builder
                 .static_keys
                 .with_secret_key('secret_key')
                 .with_public_key('public_key') # optional, only required for operations related with tokens
                 .with_environment(CheckoutSdk::Environment.sandbox)
                 .build

Default OAuth

The SDK supports client credentials OAuth, when initialized as follows:

api = CheckoutSdk.builder
                 .oauth
                 .with_authorization_uri('https://access.sandbox.checkout.com/connect/token') # custom authorization URI, optional
                 .with_client_credentials("client_id", "client_secret")
                 .with_scopes([CheckoutSdk::OAuthScopes::VAULT, CheckoutSdk::OAuthScopes::GATEWAY]) # array of scopes
                 .with_environment(CheckoutSdk::Environment.sandbox)
                 .build

Previous

If your pair of keys matches the previous system type, this is how the SDK should be used:

api = CheckoutSdk.builder
                 .previous
                 .static_keys
                 .with_secret_key('secret_key')
                 .with_public_key('public_key') # optional, only required for operations related with tokens
                 .with_environment(CheckoutSdk::Environment.sandbox)
                 .build

Then just get any client, and start making requests:

request = {
  source: {
    type: 'token',
    token: 'tok_4gzeau5o2uqubbk6fufs3m7p54',
  },
  reference: '9bf2e1e9-193a-400a-86d5-debabc495237',
  amount: 10,
  currency: 'GBP',
}
payment_response = api.payments.request_payment(request)

Logging

The SDK supports custom Log provider, you need to provide your log configuration via SDK initialization by default uses Logger from Ruby.

api = CheckoutSdk.builder
                 .static_keys
                 .with_secret_key('secret_key')
                 .with_public_key('public_key') # optional, only required for operations related with tokens
                 .with_environment(CheckoutSdk::Environment.sandbox)
                 .with_logger(logger) # your own custom configuration
                 .build

Exception handling

All the API responses that do not fall in the 2** status codes will cause a CheckoutSdk::CheckoutApiException. The exception encapsulates the http_metadata and a map of error_details, if available.

Custom Http Client

Ruby SDK supports your own configuration for http client using Faraday::Connection object, you can pass through the SDK instantiation as follows:

http_client = Faraday.new do |conn|
  conn.options.timeout = 10
  conn.proxy "http://localhost:8080"
end

api = CheckoutSdk.builder
                 .static_keys
                 .with_secret_key('secret_key')
                 .with_public_key('public_key') # optional, only required for operations related with tokens
                 .with_environment(CheckoutSdk::Environment.sandbox)
                 .with_http_client(http_client)
                 .build

You don't need to specify the URL for Faraday constructor the SDK grabs the belong URI from CheckoutSdk::Environment however if you want to use specific URI's without a proxy you can create the Environment object as follows.

environment = CheckoutSdk::Environment.new('https://the.base.uri/', # the uri for all CKO operations
                                           'https://the.oauth.uri/connect/token', # the uri used for OAUTH authorization, only required for OAuth operations
                                           'https://the.files.uri/', # the uri used for Files operations, only required for Accounts module
                                           'https://the.transfers.uri/', # the uri used for Transfer operations, only required for Transfers module
                                           'https://the.balances.uri/', # the uri used for Balances operations, only required for Balances module
                                           false)

If you want to provide your own http client and wants to use the upload_file functionality from Disputes or Accounts modules, you also need to specify the custom http client for multipart requests:

http_client = Faraday.new do |conn|
  conn.options.timeout = 10
  conn.proxy "http://localhost:8080"
  conn.response :raise_error
end

multipart_client = Faraday.new do |f|
  f.request :multipart
end

api = CheckoutSdk.builder
                 .static_keys
                 .with_secret_key('secret_key')
                 .with_public_key('public_key') # optional, only required for operations related with tokens
                 .with_environment(CheckoutSdk::Environment.sandbox)
                 .with_http_client(http_client)
                 .with_multipart_http_client(multipart_client)
                 .build

If you want to use your own http_client and wants to use Reports module, the get_report_file function follows a redirect URL from Checkout, Ruby SDK uses faraday-follow-redirects which is an open source solution that came after Faraday 2.0 deprecation, you must add it otherwise Ruby SDK will not be able to download the contents file, or provide your custom redirect adapter.

http_client = Faraday.new do |f|
  f.response :follow_redirects
  f.response :raise_error
end

api = CheckoutSdk.builder
                 .static_keys
                 .with_secret_key('secret_key')
                 .with_public_key('public_key') # optional, only required for operations related with tokens
                 .with_environment(CheckoutSdk::Environment.sandbox)
                 .with_http_client(http_client)
                 .build

Building from source

Once you check out the code from GitHub, the project can be built using gem:

gem build checkout_sdk.gemspec

The execution of integration tests require the following environment variables set in your system:

  • For default account systems (NAS): CHECKOUT_DEFAULT_PUBLIC_KEY & CHECKOUT_DEFAULT_SECRET_KEY
  • For default account systems (OAuth): CHECKOUT_DEFAULT_OAUTH_CLIENT_ID & CHECKOUT_DEFAULT_OAUTH_CLIENT_SECRET
  • For Previous account systems (ABC): CHECKOUT_PREVIOUS_PUBLIC_KEY & CHECKOUT_PREVIOUS_SECRET_KEY

Code of Conduct

Please refer to Code of Conduct

Licensing

MIT