checkout_sdk 0.1.4 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7591e018711ebd2cdb259c0e30f41d35ebb40fba79eca4417784c57311daa9fe
-  data.tar.gz: d9e7b078f08c69b592936f17ebf96413deb572140d714da37963043b1b13c58b
+  metadata.gz: ca6ee27eaf4e260f2d1456e773383fa936804a1b975804b1b483f6a201668650
+  data.tar.gz: 934c784f177c2958766a1142fc0a81ffaf5018bcd653c5303513902487f26983
 SHA512:
-  metadata.gz: b27186569eb0cf3d28280b07a91bca36d8e7320a0d8a0bd5b39cefc5870bfc0b03bf46d63754208a87b1bf2ef3bc454c88b5054a21710de8e609c692023ec810
-  data.tar.gz: 6fab6f773252974e82e824311359c0997c321054164d3595846fad8bc558f3c4e16d6c2c3d8f92e635e97aa76acbc61c8780d616474c78ec0e714b01f1243279
+  metadata.gz: e368612ae8505fa30cd8c0e1c828ba4b553b427b85ea1651eea66863b3c065e241e33a9d1a2a79c88ca8ed27fe88e25b14a599a19391668312c9556be3515957
+  data.tar.gz: 5c96b27ffc3d27992dd616f0a9805bdad031f8d6385d9ad4bacb25829da2bf132d2cadc334705b522f295ec80ba7573fff503a51918d4e99a2455c67d2312416

data/Gemfile.lock

@@ -1,45 +1,45 @@
 PATH
   remote: .
   specs:
-    checkout_sdk (0.1.4)
-      excon (~> 0.66.0)
+    checkout_sdk (0.3.2)
+      excon (>= 0.66, <= 0.88.0)
       multi_json (~> 1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    coderay (1.1.2)
-    diff-lcs (1.3)
-    excon (0.66.0)
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    excon (0.88.0)
     method_source (0.9.2)
-    multi_json (1.13.1)
+    multi_json (1.15.0)
     pry (0.11.3)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     rake (10.5.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.0)
   checkout_sdk!
   pry (~> 0.11.3)
   rake (~> 10.0)
-  rspec (~> 3.0)
+  rspec (~> 3.5)
 
 BUNDLED WITH
-   1.17.3
+   2.2.31

data/README.md

@@ -1,8 +1,10 @@
-# CheckoutSdk
+[![GitHub license](https://img.shields.io/github/license/checkout/checkout-sdk-ruby.svg)](https://github.com/checkout/checkout-sdk-ruby/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/checkout/checkout-sdk-ruby.svg)](https://GitHub.com/checkout/checkout-sdk-ruby/releases/)
 
-You are reading documentation for version: 0.1.4
+<p align="center"><img src="https://i.ibb.co/5Mx7ZsS/Screenshot-2020-07-30-at-17-20-31.png" width="20%"></p>
 
-## Installation
+# Checkout.com Ruby SDK
+
+# :rocket: Install
 
 Add this line to your application's Gemfile:
 
@@ -12,13 +14,17 @@ gem 'checkout_sdk'
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install checkout_sdk
+```bash
+$ gem install checkout_sdk
+```
 
-## Configuration
+# :wrench: Configure
 
 API keys must be configured in the gem setup. You can do this anywhere in your application before you make API calls using the gem.
 
@@ -27,11 +33,70 @@ CheckoutSdk.configure do |config|
   config.secret_key = ENV['SECRET_KEY']
   config.public_key = ENV['PUBLIC_KEY']
   config.base_url   = ENV['BASE_URL']
+  config.persistent = true|false # default: true
 end
 ```
 
-## Usage
+# :book: Documentation
+
+You can see the [SDK documentation here](https://checkout.github.io/checkout-sdk-ruby/getting_started/).
+
+# :dash: Quickstart
+
+#### Source Type: `token`
+A card token can be obtained using one of Checkout.com's JavaScript frontend solutions such as [Frames](https://docs.checkout.com/docs/frames "Frames") or any of the [mobile SDKs](https://docs.checkout.com/docs/sdks#section-mobile-sdk-libraries "Mobile SDKs")
+
+```ruby
+payment_request_source = CheckoutSdk::PaymentRequestSource.new
+payment_request_source.type = "token"
+payment_request_source.token = "tok_..."
+payment_request_source.amount = 2022
+payment_request_source.currency = "GBP"
+
+api_resource = CheckoutSdk::ApiResource.new
+
+# Send API call
+response = api_resource.request_payment(payment_request_source)
+
+# response parsing
+response.data           # => {...}
+response.body           # => "..."
+response.headers        # => {...}
+response.remote_ip      # => "..."
+response.status         # => 200
+response.remote_ip      # => "..."
+response.local_port     # => 51601
+response.local_address  # => "..."
+```
+
+#### Source Type: `id`
 
+```ruby
+payment_request_source = CheckoutSdk::PaymentRequestSource.new
+payment_request_source.type = "id"
+payment_request_source.token = "src_..."
+payment_request_source.amount = 2022
+payment_request_source.currency = "GBP"
+
+api_resource = CheckoutSdk::ApiResource.new
+
+# Send API call
+response = api_resource.request_payment(payment_request_source)
+
+# response parsing
+response.data           # => {...}
+response.body           # => "..."
+response.headers        # => {...}
+response.remote_ip      # => "..."
+response.status         # => 200
+response.remote_ip      # => "..."
+response.local_port     # => 51601
+response.local_address  # => "..."
+```
+
+
+#### Source Type: `card`
+[Fully PCI Compliant](https://docs.checkout.com/docs/pci-compliance) merchants only
 ```ruby
 payment_request_source = CheckoutSdk::PaymentRequestSource.new
 payment_request_source.type = "card"
@@ -42,23 +107,11 @@ payment_request_source.card_name = "Bruce Wayne"
 payment_request_source.card_cvv = "100"
 payment_request_source.amount = 2022
 payment_request_source.currency = "GBP"
-payment_request_source.capture = true
-payment_request_source.threeds_enabled = false
-payment_request_source.threeds_attempt_n3d = false
-payment_request_source.recipient_dob = "1992-04-06"
-payment_request_source.recipient_account_number = "1234567890"
-payment_request_source.recipient_zip = "12345"
-payment_request_source.recipient_last_name = "Elmo"
-payment_request_source.risk_enabled = true
-payment_request_source.billing_descriptor_name = "Nancy"
-payment_request_source.billing_descriptor_city = "Berlin"
-payment_request_source.processing_mid = "CheckoutSdk"
-
 
 api_resource = CheckoutSdk::ApiResource.new
 
 # Send API call
-response = api_resource.request_payments(payment_request_source)
+response = api_resource.request_payment(payment_request_source)
 
 # response parsing
 response.data           # => {...}
@@ -71,6 +124,27 @@ response.local_port     # => 51601
 response.local_address  # => "..."
 ```
 
-## Tests
+# :warning: Boolean/falsy values
+
+"nil" or empty strings will be stripped from API calls
+
+```ruby
+# ignored
+payment_request_source.capture = nil
+payment_request_source.capture = ""
+```
+
+but "false" or 0 are retained and sent in the request
 
-    $ rspec
+```ruby
+# sent
+payment_request_source.capture = false
+payment_request_source.capture = 0
+```
+See [api_resource_spec](https://github.com/checkout/checkout-sdk-ruby/blob/master/spec/checkout_sdk/api_resource_spec.rb#L10-L24) for details.
+
+# :rotating_light: Tests
+
+```bash
+$ rspec
+```

data/checkout_sdk.gemspec

@@ -15,10 +15,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
   spec.license       = "MIT"
 
-  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "bundler", "~> 2.0"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec", "~> 3.5"
   spec.add_development_dependency "pry",  "~> 0.11.3"
   spec.add_dependency "multi_json", '~> 1.0'
-  spec.add_dependency "excon", "~> 0.66.0"
+  spec.add_dependency "excon", ">= 0.66", "<= 0.88.0"
 end

data/documentation/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

data/documentation/docs/environment.md

@@ -0,0 +1,26 @@
+---
+id: environment
+title: Environment
+---
+
+The SDK will target an environment based on the **base_url** value you provide when you initialize it:
+
+**Sandbox**: https://api.sandbox.checkout.com
+
+**Live**: https://api.checkout.com
+
+:::caution
+
+Public and secret key pairs will only work for their relevant environment. Sandbox keys begin with "pk_test_" or "sk_test_". You will receive separate Live keys for use in your production environment when going live with Checkout.com.
+
+:::
+
+## Testing
+
+If you are testing in the Sandbox environment, Checkout.com provides a list of [test card details](https://docs.checkout.com/testing/test-card-numbers). You can also simulate a lot of edge cases like Declines, by using [special transaction values](https://docs.checkout.com/testing/response-code-testing).
+
+:::note
+
+You can also test 3D Secure with the test cards provided. If you want to test 3DS 2 flows, use the cards mentioned [here](https://docs.checkout.com/testing/3d-secure-testing).
+
+:::

data/documentation/docs/getting_started.md

@@ -0,0 +1,48 @@
+---
+id: getting_started
+title: Getting Started
+sidebar_label: Getting Started
+---
+
+The Checkout.com Ruby SDK makes it easy to interact with the Unified Payments API. You can easily accept card payments and manage these using the same integration.
+
+[![GitHub license](https://img.shields.io/github/license/checkout/checkout-sdk-ruby.svg)](https://github.com/checkout/checkout-sdk-ruby/blob/master/LICENSE) [![GitHub release](https://img.shields.io/github/release/checkout/checkout-sdk-ruby.svg)](https://GitHub.com/checkout/checkout-sdk-ruby/releases/)
+
+## Get a test account
+
+If you are starting the integration process, and you want to start interacting with Checkout.com's API, you will need a test account, so you can get your API keys.
+
+export const RedirectButton = ({text, link}) => (
+<a
+href={link}
+target="\_blank"
+className="get-test-account">{text}</a>
+);
+
+<RedirectButton text="Get a test account" link="https://www.checkout.com/get-test-account" />
+
+## Authentication
+
+export const Highlight = ({children, color}) => (
+<span
+style={{
+      backgroundColor: color,
+      borderRadius: '2px',
+      color: '#fff',
+      padding: '0.2rem',
+    }}>
+{children}
+</span>
+);
+
+When you sign up for an account, you are given a secret and public API key pair. They will be used to initialise the SDK. You can find the keys by navigating to <Highlight color="#1877F2">Settings > Channels > API keys</Highlight> in Checkout.com's Hub.
+
+:::warning
+
+Never share your secret keys. Keep them guarded and secure.
+
+:::
+
+## Payload and Responses
+
+If you want to see all the parameters that you can provide in API requests, as well as examples of possible responses, please follow the Checkout.com [API Reference](https://api-reference.checkout.com/).

data/documentation/docs/initialize.md

@@ -0,0 +1,19 @@
+---
+id: initialize
+title: Initialize
+---
+
+## Configuration
+
+API keys must be configured in the gem setup. You can do this anywhere in your application before you make API calls using the gem.
+
+```ruby
+CheckoutSdk.configure do |config|
+  config.secret_key = "your secret key"
+  config.public_key = "your public key"
+  config.base_url   = "https://api.sandbox.checkout.com" #for sandbox
+end
+
+api_resource = CheckoutSdk::ApiResource.new
+```
+

data/documentation/docs/install.md

@@ -0,0 +1,21 @@
+---
+id: install
+title: Install
+---
+
+## Add to your application's Gemfile
+
+```ruby
+gem 'checkout_sdk'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+## Or install yourself
+
+```bash
+$ gem install checkout_sdk
+```

data/documentation/docs/payments.md

@@ -0,0 +1,200 @@
+---
+id: payments
+title: Payments
+---
+
+You can find a list of request body parameters and possible outcomes [here](https://api-reference.checkout.com/#tag/Payments).
+
+export const Highlight = ({children, color}) => (
+<span
+style={{
+      color: color,
+      padding: '0.2rem',
+    }}>
+{children}
+</span>
+);
+
+:::important
+
+#### Using boolean/falsy values
+
+"nil" or empty strings will be stripped from API calls
+
+```ruby
+# ignored
+payment_request_source.capture = nil
+payment_request_source.capture = ""
+```
+
+but "false" or 0 are retained and sent in the request
+
+```ruby
+# sent
+payment_request_source.capture = false
+payment_request_source.capture = 0
+```
+See [api_resource_spec](https://github.com/checkout/checkout-sdk-ruby/blob/master/spec/checkout_sdk/api_resource_spec.rb#L10-L24) for details.
+
+:::
+
+## Request a card payment with a <Highlight color="#25c2a0">card token</Highlight>
+
+The card token is generated by front-end integration options such as [Frames](https://docs.checkout.com/docs/frames) or one of the [Mobile SDKs](https://docs.checkout.com/docs/sdks#section-mobile-sdk-libraries). Keep in mind that this token expires in 15 minutes and can only be used once.
+
+```ruby
+payment_request_source = CheckoutSdk::PaymentRequestSource.new
+payment_request_source.type = "token"
+payment_request_source.token = "tok_ubfj2q76miwundwlk72vxt2i7q"
+payment_request_source.amount = 1000
+payment_request_source.currency = "GBP"
+payment_request_source.reference = "ORD-090857"
+
+# Send API call
+response = api_resource.request_payment(payment_request_source)
+
+# response parsing
+puts(response.data) # => {...}
+puts(response.body) # => "..."
+```
+
+## Request a card payment with a <Highlight color="#25c2a0">full card details</Highlight>
+
+:::warning
+
+You need to have a high level of PCI Compliance (SAQ-D) to be able to send requests with full card details. Note that unless this payment option is enabled on your account by Checkout.com, the <Highlight color="#5A522C">request will fail</Highlight>. Contact you account manager to request access for this payment interaction.
+
+:::
+
+```ruby
+payment_request_source = CheckoutSdk::PaymentRequestSource.new
+payment_request_source.type = "card"
+payment_request_source.card_number = "4242424242424242"
+payment_request_source.card_expiry_month = 6
+payment_request_source.card_expiry_year = 2025
+payment_request_source.card_name = "Bruce Wayne"
+payment_request_source.card_cvv = "100"
+payment_request_source.amount = 1000
+payment_request_source.currency = "GBP"
+
+# Send API call
+response = api_resource.request_payment(payment_request_source)
+
+# response parsing
+puts(response.data) # => {...}
+puts(response.body) # => "..."
+```
+
+## Request a card payment with a <Highlight color="#25c2a0">an existing card</Highlight>
+
+After you perform at least one successful payment for a customer, Checkout.com will return a <Highlight color="#02b48f">source.id</Highlight>. This id does not expire, so it can be used to perform subsequent payments without needing the customer to enter the card details again.
+
+```ruby
+payment_request_source = CheckoutSdk::PaymentRequestSource.new
+payment_request_source.type = "id"
+payment_request_source.token = "src_vg3tm54ndfbefotjlmgrrvbxli"
+payment_request_source.amount = 1000
+payment_request_source.currency = "GBP"
+
+# Send API call
+response = api_resource.request_payment(payment_request_source)
+
+# response parsing
+puts(response.data) # => {...}
+puts(response.body) # => "..."
+```
+
+## Request a <Highlight color="#25c2a0">3D Secure payment</Highlight>
+
+You have the ability to authenticate with 3DS in a payment request. The request body is similar to normal card payments, but with some additional parameters. [Read more about 3DS](https://docs.checkout.com/docs/3d-secure-payments)
+
+```ruby
+payment_request_source = CheckoutSdk::PaymentRequestSource.new
+payment_request_source.type = "token"
+payment_request_source.token = "tok_ubfj2q76miwundwlk72vxt2i7q"
+payment_request_source.amount = 1000
+payment_request_source.currency = "GBP"
+payment_request_source.reference = "ORD-090857"
+payment_request_source.threeds_enabled = true
+
+# Send API call
+response = api_resource.request_payment(payment_request_source)
+
+# response parsing
+puts(response.data) # => {...}
+puts(response.body) # => "..."
+```
+
+3D Secure payments will return a redirection URL. Here is an example of a 3DS response:
+
+```json
+{
+  "id": "pay_hehfmlkpykeupofyxf7nbr6yyy",
+  "status": "Pending",
+  "customer": {
+    "id": "cus_u4a4zosnrw7ehhzr7jipbkdzo4"
+  },
+  "3ds": {
+    "downgraded": false,
+    "enrolled": "Y"
+  },
+  "_links": {
+    "self": {
+      "href": "https://api.sandbox.checkout.com/payments/pay_hehfmlkpykeupofyxf7nbr6yyy"
+    },
+    "redirect": {
+      "href": "https://sandbox.checkout.com/api2/v2/3ds/acs/sid_feixbit6us3utfedjulm6egnsu"
+    }
+  }
+}
+```
+
+You can access the redirection URL via the SDK like so:
+
+```ruby
+redirectURL = response.data._links.redirect.href
+```
+
+## Get payment details
+
+```ruby
+details = api_resource.get_payment_details("pay_juevt3h5mcjulir2t5g3wfug6u") # or with session id sid_XXX
+```
+
+## Get payment actions
+
+```ruby
+actions = api_resource.get_payment_actions("pay_juevt3h5mcjulir2t5g3wfug6u")
+```
+
+## Capture a payment
+
+```ruby
+capture_payment = CheckoutSdk::CapturePayment.new
+capture_payment.id = "pay_y3oqhf46pyzuxjbcn2giaqnb44"
+capture_payment.amount = "1000"
+capture_payment.reference = "your reference"
+
+response = api_resource.capture_payment(capture_payment)
+```
+
+## Refund a payment
+
+```ruby
+refund_payment = CheckoutSdk::RefundPayment.new
+refund_payment.id = "pay_y3oqhf46pyzuxjbcn2giaqnb44"
+refund_payment.amount = "1000"
+refund_payment.reference = "your reference"
+
+response = api_resource.refund_payment(refund_payment)
+```
+
+## Void a payment
+
+```ruby
+void_payment = CheckoutSdk::VoidPayment.new
+void_payment.id = "pay_y3oqhf46pyzuxjbcn2giaqnb44"
+void_payment.reference = "your reference"
+
+response = api_resource.void_payment(void_payment)
+```

data/documentation/docs/sources.md

@@ -0,0 +1,53 @@
+---
+id: sources
+title: Sources
+---
+
+export const Highlight = ({children, color}) => (
+<span
+style={{
+      color: color,
+      padding: '0.2rem',
+    }}>
+{children}
+</span>
+);
+
+You can find a list of request body parameters and possible outcomes [here](https://api-reference.checkout.com/#tag/Sources).
+
+## Add a <Highlight color="#25c2a0">SEPA source</Highlight>
+
+:::note
+
+SEPA is not enabled by default, so please let your account manager know if you want to use it.
+
+:::
+
+```ruby
+payment_source = CheckoutSdk::PaymentSource.new
+payment_source.type = "sepa"
+payment_source.reference = "X-080957-N34"
+
+payment_source.customer_id = "cus_y3oqhf46pyzuxjbcn2giaqnb44"
+payment_source.customer_email = "jokershere@gmail.com"
+payment_source.customer_name = "Jack Napier"
+
+payment_source.billing_address_line1 = "Checkout.com"
+payment_source.billing_address_line2 = "Shepherdess Walk"
+payment_source.billing_city = "London"
+payment_source.billing_state = "London"
+payment_source.billing_zip = "N1 7LH"
+payment_source.billing_country = "GB"
+
+payment_source.phone_country_code = "+1"
+payment_source.phone_number = "415 555 2671"
+
+payment_source.source_data_first_name = "Marcus"
+payment_source.source_data_last_name = "Barrilius Maximus"
+payment_source.source_data_account_iban = "DE25100100101234567893"
+payment_source.source_data_bic = "PBNKDEFFXXX"
+payment_source.source_data_billing_descriptor = "Ruby SDK test"
+payment_source.source_data_mandate_type = "single"
+
+response = api_resource.add_payment_source(payment_source)
+```