adyen-ruby-api-library 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c1e232c26570c84897b5c8489e97d13be2a80eb8e93938d4bed2de7ff6eb0461
+  data.tar.gz: e4ce5d02812ec19be6dd485b3fc0813d6702f6c8ff1815cd559224b4a85e895a
+SHA512:
+  metadata.gz: bf9bfbbd60354a4c2c8dfdfb39a21d40036968d71cfe3fd74f9052ebcf1315f091713c1615e9cf69c272977c46a708998b045b726a7c06d9c185bd8459c6d88f
+  data.tar.gz: 6d0e48db6cfc3eca5c316a06af595416e5874884e389f97b6bca7ca596098c2d3024b0dcf9cadcfcfe9537d9298d79df86f6a4996b1687bc0a3326fba89db683

data/.gitignore

@@ -0,0 +1,13 @@
+design.txt
+/Gemfile.lock
+*.gem
+
+# VSCode
+.vs
+*.code-workspace
+
+.rspec
+.rspec_status
+
+.bundle
+.ruby-version

data/.travis.yml

@@ -0,0 +1,14 @@
+sudo: false
+language: ruby
+
+rvm:
+- 2.5
+- 2.4
+- 2.3
+- 2.2
+- 2.1
+
+notifications:
+  email: false
+
+script: bundle exec rspec

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+ruby "> 2.1.0"
+
+gem "faraday"
+
+gem "bundler", :group => :development
+gem "webmock", :group => :development
+gem "rspec", :group => :development
+gem "activesupport", :group => :development

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Adyen
+
+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/README.md

@@ -0,0 +1,140 @@
+# Adyen API Library for Ruby
+
+The Adyen API Library for Ruby lets you easily work with Adyen's API.
+
+## Integration
+
+The Library supports all APIs under the following services:
+
+* checkout
+* checkout utility
+* payments
+* modifications
+* payouts
+* recurring
+* marketpay
+
+## Requirements
+
+Built for Ruby >= 2.1
+
+## Installation
+
+The sole dependency is faraday for http communication - run `bundle install` to install faraday if you don't already have it
+
+To validate functionality of client, use `bundle install --with development` and `rspec` to run mock API tests.
+
+## Documentation
+
+Follow the rest of our guides from the [documentation](https://adyen.github.io/adyen-ruby-api-library/) on how to use this library.
+
+## Usage
+
+### Create a client to connect to the Adyen API
+```ruby
+require 'adyen-ruby-api-library'
+
+adyen = Adyen::Client.new
+
+# for API-key based implementations
+adyen.api_key = 'AF5XXXXXXXXXXXXXXXXXXXX'
+
+# for basic-auth based implementations
+adyen.ws_user = 'ws@Company.Adyen'
+adyen.ws_password = 'super_secure_password123'
+```
+
+### Make a Payment
+```ruby
+response = adyen.checkout.payments({
+  :amount => {
+    :currency => "EUR",
+    :value => 1000
+  },
+  :reference => "Your order number",
+  :paymentMethod => {
+    :type => "scheme",
+    :encryptedCardNumber => "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
+    :encryptedExpiryMonth => "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
+    :encryptedExpiryYear => "adyenjs_0_1_18$MT6ppy0FAMVMLH...",
+    :encryptedSecurityCode => "adyenjs_0_1_18$MT6ppy0FAMVMLH..."
+  },
+  :returnUrl => "https://your-company.com/checkout/",
+  :merchantAccount => "YourMerchantAccount"
+})
+```
+
+## List of supported methods
+
+**checkout:**
+- payment_session
+- payments.result
+- payment_methods
+- payments
+- payments.details
+
+**checkout utility:**
+- origin_keys
+
+**payments:**
+- authorise
+- authorise3d
+
+**modifications:**
+- capture
+- cancel
+- refund
+- cancel_or_refund
+- adjust_authorisation
+
+**payouts:**
+- confirm_third_party
+- decline_third_party
+- store_detail
+- submit_third_party
+- store_detail_and_submit_third_party
+
+**recurring:**
+- list_recurring_details
+- disable
+- store_token
+
+**marketpay.account:**
+- create_account_holder
+- get_account_holder
+- update_account_holder
+- update_account_holder_state
+- suspend_account_holder
+- un_suspend_account_holder
+- close_account_holder
+- create_account
+- update_account
+- close_account
+- upload_document
+- get_uploaded_documents
+- delete_bank_accounts
+- delete_shareholders
+
+**marketpay.fund:**
+- account_holder_balance
+- account_holder_transaction_list
+- payout_account_holder
+- transfer_funds
+- setup_beneficiary
+- refund_not_paid_out_transfers
+
+**marketpay.notification:**
+- create_notification_configuration
+- get_notification_configuration
+- get_notification_configuration_list
+- test_notification_configuration
+- update_notification_configuration
+- delete_notification_configurations
+
+## Support
+
+If you have any problems, questions or suggestions, create an issue here or send your inquiry to support@adyen.com.
+  
+## Licence
+
+MIT license. For more information, see the LICENSE file.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/adyen-ruby-api-library.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/adyen/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'adyen-ruby-api-library'
+  spec.version = Adyen::VERSION
+  spec.required_ruby_version = '>= 2.1.0'
+  spec.authors = ['Adyen']
+  spec.email = ['support@adyen.com']
+
+  spec.summary = 'Official Adyen  Ruby API Library'
+  spec.description = 'Official Adyen API Library for Ruby. Simplifies integrating with the Adyen API, including Checkout, Marketpay, payments, recurring, and payouts.  For support please reach out to support@adyen.com.  If you would like to contribute please submit a comment or pull request at https://github.com/Adyen/adyen-ruby-api-library.'
+  spec.homepage = 'https://www.adyen.com'
+  spec.license = 'MIT'
+
+  spec.metadata = {
+    'documentation_uri' => 'https://docs.adyen.com/developers/development-resources/libraries',
+    'homepage_uri' => 'https://www.adyen.com',
+    'source_code_uri' => 'https://github.com/Adyen/adyen-ruby-api-library'
+  }
+
+  spec.files = `git ls-files`.split("\n")
+
+  spec.add_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'activesupport'
+end

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/adyen.rb"
+
+# 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

@@ -0,0 +1,8 @@
+#!/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/docs/checkout.html

@@ -0,0 +1,111 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <title>Adyen-ruby-api-library by Adyen</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css">
+    <link rel="stylesheet" href="stylesheets/github-light.css">
+    <meta name="viewport" content="width=device-width">
+
+    <link rel="stylesheet" href="stylesheets/prism.css">
+    <script src="javascripts/prism.js"></script>
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Adyen-ruby-api-library</h1>
+        <p>Adyen API Library for ruby</p>
+
+      <p class="view"><a href="https://github.com/Adyen/adyen-ruby-api-library">View the Project on GitHub <small>Adyen/adyen-ruby-api-library</small></a></p>
+        <ul>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+      	<h2 id="availablemethods">Available methods</h2>
+
+        <ul>
+        <li>payment_session</li>
+
+        <li>payments.result</li>
+
+        <li>payment_methods</li>
+
+        <li>payments</li>
+
+        <li>payments.details</li>
+        </ul>
+
+        <h2 id="authentication">Authentication</h2>
+
+        <p>Checkout is authenticated via api-key:
+        <pre><code class="ruby language-ruby">adyen.api_key = "AP5XXXXXXXXX"</code></pre></p>
+
+        <h2 id="usagecheckoutsdk">Usage - Checkout SDK</h2>
+
+        <p>Checkout SDK is a javascript library which loads an Adyen-hosted iframe into your website.  Once loaded, it communicates directly with Adyen, abstracting away all server communication and lowering your PCI compliance load.</p>
+
+        <p>The front-end is described <a href="https://docs.adyen.com/developers/checkout/integrations-overview">here</a>
+        </p>
+
+        <p>To perform the initial paymentSession call to Adyen, call its method as below:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.checkout.paymentSession('{
+  "amount": {
+    "value": 1500,
+    "currency": "EUR"
+  },
+  "countryCode": "US",
+  "origin": "www.example.com",
+  "returnUrl": "www.example.com",
+  "reference": "Merchant Reference",
+  "merchantAccount": "TestMerchant"
+}')</code></pre>
+
+        <p>Then send the response to the client-side javascript library to initialize the SDK.</p>
+
+        <h2 id="usagecheckoutapi">Usage - Checkout API</h2>
+
+        <p>Raw payment method details can be sent directly to Adyen through the Checkout API.  For instance, to send raw credit card data you could use a request like the below:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.checkout.payments('{
+  "card": {
+    "number": "4111111111111111",
+    "expiryMonth": "8",
+    "expiryYear": "2018",
+    "cvc": "737",
+    "holderName": "John Smith"
+  },
+  "amount": {
+    "value": 1500,
+    "currency": "EUR"
+  },
+  "reference": "YOUR_REFERENCE",
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}')</code></pre>
+
+        <p>You can also get a list of payment methods which are available for a given transaction to display a page with custom styling to your shoppers:</p>
+
+        <pre><code class="ruby language-ruby">response = adyen.checkout.payment_methods('{
+  "merchantAccount": "YOUR_MERCHANT_ACCOUNT"
+}')</code></pre>
+
+        <p>A successful call to payment_methods will return a list of supported payment methods along with redirect URL's so that you can send your shoppers directly to the issuer's site without losing control of front-end styling / logic.</p>
+
+      </section>
+      <footer>
+        <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="javascripts/scale.fix.js"></script>
+
+  </body>
+</html>

data/docs/index.html

@@ -0,0 +1,50 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <title>Adyen-ruby-api-library by Adyen</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css">
+    <link rel="stylesheet" href="stylesheets/github-light.css">
+    <meta name="viewport" content="width=device-width">
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Adyen-ruby-api-library</h1>
+        <p>Adyen API Library for Ruby</p>
+
+        <p class="view"><a href="https://github.com/Adyen/adyen-ruby-api-library">View the Project on GitHub <small>Adyen/adyen-ruby-api-library</small></a></p>
+
+        <ul>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+        <h1><a id="adyen-apis-library-for-ruby" class="anchor" href="#adyen-apis-library-for-ruby" aria-hidden="true"><span aria-hidden="true" class="octicon octicon-link"></span></a>Adyen APIs Library for Ruby</h1>
+        <p>
+          This manual describes API communication to the Adyen payment system using this API library for Ruby. 
+          You will get familiar with the following concepts and scenarios:
+        </p>
+        <ul>
+          <li><a title="Install the library" href="install-library.html">Install the library</a></li>
+           <li><a title="Using the library" href="using-library.html">Using the library</a></li>
+        </ul>
+        <h2>DISCLAIMER</h2>
+        <p>The ownership of the content of the Adyen API Library remains with Adyen. The content of the Adyen API Library may only be used in connection with the services of Adyen and subject to the applicable license (Apache License, Version 2.0, the “License”), a copy of which is included in the library. Unless required by applicable law or agreed to in writing, the library is offered and/or distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. Adyen does not warrant that the library or any content will be available uninterrupted or error free, that defects will be corrected, or that the library or its supporting systems are free of viruses or bugs. Please refer to the License for the specific language governing permissions and limitations under the License.</p>
+      </section>
+      <footer>
+        <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="javascripts/scale.fix.js"></script>
+
+  </body>
+</html>

data/docs/install-library.html

@@ -0,0 +1,61 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="chrome=1">
+    <title>Adyen-php-api-library by Adyen</title>
+
+    <link rel="stylesheet" href="stylesheets/styles.css">
+    <link rel="stylesheet" href="stylesheets/github-light.css">
+    <meta name="viewport" content="width=device-width">
+
+    <link rel="stylesheet" href="stylesheets/prism.css">
+    <script src="javascripts/prism.js"></script>
+    <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+  </head>
+  <body>
+    <div class="wrapper">
+      <header>
+        <h1>Adyen-ruby-api-library</h1>
+        <p>Adyen API Library for Ruby</p>
+
+        <p class="view"><a href="https://github.com/Adyen/adyen-ruby-api-library">View the Project on GitHub <small>Adyen/adyen-ruby-api-library</small></a></p>
+
+
+        <ul>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/zipball/master">Download <strong>ZIP File</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library/tarball/master">Download <strong>TAR Ball</strong></a></li>
+          <li><a href="https://github.com/Adyen/adyen-ruby-api-library">View On <strong>GitHub</strong></a></li>
+        </ul>
+      </header>
+      <section>
+        <h1>Install the library</h1>
+        <p>
+        	<h2>Requirements:</h2>
+        	<ul>
+        		<li>Ruby >= 2.1</li>
+        	</ul>
+        </p>
+        <h2>Installation</h2>
+        <p>
+        	<ol>
+        		<li>
+        		The preferred method is via <a href="https://www.rubygems.org/packages/Adyen.EcommLibrary">RubyGems</a>.
+        		</li>
+        		<li>
+        			Download Release from GitHub: Go to our GitHub releases tab and download the zip file that is included in the release.
+        		</li>
+        	</ol>
+        </p>
+    	</section>
+      <footer>
+        <p>This project is maintained by <a href="https://github.com/Adyen">Adyen</a></p>
+        <p><small>Hosted on GitHub Pages &mdash; Theme by <a href="https://github.com/orderedlist">orderedlist</a></small></p>
+      </footer>
+    </div>
+    <script src="javascripts/scale.fix.js"></script>
+
+  </body>
+</html>