checkout_sdk 0.3.2 → 1.0.0.beta.0

data/.gitignore

@@ -1,11 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.3.7
-before_install: gem install bundler -v 1.16.5

data/Gemfile.lock

@@ -1,45 +0,0 @@
-PATH
-  remote: .
-  specs:
-    checkout_sdk (0.3.2)
-      excon (>= 0.66, <= 0.88.0)
-      multi_json (~> 1.0)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    excon (0.88.0)
-    method_source (0.9.2)
-    multi_json (1.15.0)
-    pry (0.11.3)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    rake (10.5.0)
-    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.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler (~> 2.0)
-  checkout_sdk!
-  pry (~> 0.11.3)
-  rake (~> 10.0)
-  rspec (~> 3.5)
-
-BUNDLED WITH
-   2.2.31

data/LICENSE

@@ -1,21 +0,0 @@
-MIT License
-
-Copyright (c) 2019 Checkout.com
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "checkout_sdk"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/checkout_sdk.gemspec

@@ -1,24 +0,0 @@
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "checkout_sdk/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "checkout_sdk"
-  spec.version       = CheckoutSdk::VERSION
-  spec.authors       = ["Khalid Jazaerly"]
-  spec.email         = ["khalid.jaz@gmail.com"]
-
-  spec.summary       = %q{A Ruby API wrapper for checkout.com.}
-  spec.description   = %q{A Ruby API wrapper for checkout.com.}
-  spec.homepage      = "http://checkout.com"
-  spec.files         = `git ls-files`.split("\n")
-  spec.require_paths = ["lib"]
-  spec.license       = "MIT"
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.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.88.0"
-end

data/documentation/.gitignore

@@ -1,20 +0,0 @@
-# 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

@@ -1,26 +0,0 @@
----
-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

@@ -1,48 +0,0 @@
----
-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

@@ -1,19 +0,0 @@
----
-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

@@ -1,21 +0,0 @@
----
-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

@@ -1,200 +0,0 @@
----
-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

@@ -1,53 +0,0 @@
----
-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)
-```

data/documentation/docs/tokens.md

@@ -1,88 +0,0 @@
----
-id: tokens
-title: Tokens
----
-
-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/Tokens).
-
-## Request a token for <Highlight color="#25c2a0">Apple Pay</Highlight>
-
-```ruby
-header_data = { "ephemeralPublicKey" => "XXX",
-                "publicKeyHash" => "XXX",
-                "transactionId" => "XXX" }
-
-token_request_source = CheckoutSdk::RequestToken.new
-token_request_source.type = "applepay"
-token_request_source.token_data_version = "EC_v1"
-token_request_source.token_data_data = "XXX"
-token_request_source.token_data_signature = "XXX"
-token_request_source.token_data_header = header_data
-
-# Send API call
-response = api_resource.request_token(token_request_source)
-
-# response parsing
-puts(response.data) # => {...}
-puts(response.body) # => "..."
-```
-
-## Request a token for <Highlight color="#25c2a0">Google Pay</Highlight>
-
-const token = await cko.tokens.request({
-    // type:"googlepay" is inferred
-    token_data: {
-        protocolVersion: 'EC_v1',
-        signature: 'XXX',
-        signedMessage: 'XXX'
-    }
-});
-
-```ruby
-token_request_source = CheckoutSdk::RequestToken.new
-token_request_source.type = "googlepay"
-token_request_source.token_data_protocolVersion = "ECv1"
-token_request_source.token_data_signature = "XXX"
-token_request_source.token_data_signedMessage = "XXX"
-
-# Send API call
-response = api_resource.request_token(token_request_source)
-
-# response parsing
-puts(response.data) # => {...}
-puts(response.body) # => "..."
-```
-
-## Request a token for <Highlight color="#25c2a0">raw card details</Highlight>
-
-:::warning
-
-If you do not have SAQ-D level PCI Compliance, this interaction can only be done in the Sandbox environment. This is in case you want to unit test your code and need a token to make a payment. In the Production environment, you need to use an integrated solution such as **[Frames](https://docs.checkout.com/quickstart/integrate/frames)** to generate the token for you.
-
-:::
-
-```ruby
-token_request_source = CheckoutSdk::RequestToken.new
-token_request_source.type = "card"
-token_request_source.card_number = "4242424242424242"
-token_request_source.card_expiry_month = 6
-token_request_source.card_expiry_year = 28
-token_request_source.card_cvv = "100"
-
-# Send API call
-response = api_resource.request_token(token_request_source)
-
-# response parsing
-puts(response.data) # => {...}
-puts(response.body) # => "..."
-```

data/documentation/docusaurus.config.js

@@ -1,60 +0,0 @@
-module.exports = {
-  title: "checkout-sdk-ruby",
-  tagline: "Checkout.com SDK for Ruby",
-  url: "https://checkout.github.io",
-  baseUrl: "/checkout-sdk-ruby/",
-  favicon: "img/favicon.png",
-  organizationName: "checkout", // Usually your GitHub org/user name.
-  projectName: "checkout-sdk-ruby", // Usually your repo name.
-  themeConfig: {
-    prism: {
-      additionalLanguages: ["ruby", "bash"],
-    },
-    navbar: {
-      title: "checkout-sdk-ruby",
-      logo: {
-        alt: "checkout-sdk-ruby",
-        src: "img/logo.png",
-      },
-      items: [
-        {
-          to: "getting_started",
-          activeBasePath: "docs",
-          label: "Docs",
-          position: "right",
-        },
-        {
-          href: "https://github.com/checkout/checkout-sdk-ruby",
-          label: "GitHub",
-          position: "right",
-        },
-      ],
-    },
-    footer: {
-      style: "dark",
-      copyright: `© ${new Date().getFullYear()} Checkout.com    `,
-    },
-    googleAnalytics: {
-      trackingID: "UA-165971486-1",
-    },
-  },
-  presets: [
-    [
-      "@docusaurus/preset-classic",
-      {
-        docs: {
-          sidebarPath: require.resolve("./sidebars.js"),
-          routeBasePath: "/",
-          // editUrl: 'https://github.com/facebook/docusaurus/edit/master/website/'
-        },
-        theme: {
-          customCss: require.resolve("./src/css/custom.css"),
-        },
-      },
-    ],
-  ],
-  plugins: [
-    // Basic usage.
-    // require.resolve('@docusaurus/plugin-google-analytics'),
-  ],
-};