adyen_client 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bed3b1c2cd6bad30f1278dedc5bbf0a6eb1192e6
+  data.tar.gz: eb471bf5fc009cfaa44ba2c4809602363c3bfdc5
+SHA512:
+  metadata.gz: 3b31679659538ec245122826e0c465836b80ab6d02e3a171c5f729dfade0773191d7d570ddf90cdfd50bbc1e92dac245e10bf387b5551387d50d4f3e38a2dfb5
+  data.tar.gz: 2f344b0abdd6fd6ad19dfca2db359bbb769ad2c5f702fe9370a0cb9369e80d7890aa9de54eb4055c99a321f57562550ef57629fcc9054980c017a9bc11a5166c

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Lukas Rieder
+
+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,128 @@
+# A simple client that talks to the Adyen API
+
+[![Inline docs](http://inch-ci.org/github/Overbryd/adyen_client.svg?branch=master)](http://inch-ci.org/github/Overbryd/adyen_client)
+
+> Does not try to be smart, stays close to the documentation while adhering to Ruby conventions.
+
+## Setup & Configuration
+
+`gem install adyen_client`
+
+In your Gemfile:
+
+`gem "adyen_client"`
+
+Require and configure the client:
+
+```ruby
+require "adyen_client"
+
+# Block style
+AdyenClient.configure do |c|
+  c.environment = :test
+  c.username = "ws_123456@Company.FooBar"
+  c.password = "correctbatteryhorsestaple"
+  c.cse_public_key = "10001|..."
+  c.default_merchant_account = "FooBar123"
+  c.default_currency = "EUR"
+end
+
+# Hash style works too, string or symbol keys
+AdyenClient.configure(environment: :test, username: "ws_123456@Company.FooBar", ...)
+
+# That comes in handy to configure the client from a YAML file
+AdyenClient.configure(YAML.load_file(Rails.root.join("config", "adyen.yml"))[Rails.env.to_s])
+
+# You can override all default options for each instance of a client
+client = AdyenClient.new(merchant_account: "FooBarSubMerchant123")
+eur_client = AdyenClient.new(currency: "EUR")
+```
+
+## Examples
+
+### Simple payment
+
+```ruby
+client = AdyenClient.new
+response = client.authorise(amount: 100, encrypted_card: "adyenjs_0_1_15$OlmG...")
+if response.authorised?
+  puts "( ﾉ ﾟｰﾟ)ﾉ"
+else
+  puts "(－‸ლ)"
+end
+```
+
+### Setup a recurring contract, charge users later
+
+```ruby
+user = User.create(email: "john@doe.com", last_ip: request.remote_ip)
+
+client = AdyenClient.new
+response = client.create_recurring_contract(encrypted_card: "adyenjs_0_1_15$OlmG...", shopper: {
+  reference: user.id,
+  email: user.email,
+  ip: user.last_ip # optional but recommended
+})
+if response.authorised?
+  # now we know the users card is valid
+else
+  # something is wrong with the users card or we got an error
+end
+```
+
+Later, we want to charge the user based on that contract.
+
+```ruby
+user = User.find_by_email("john@doe.com")
+
+client = AdyenClient.new
+response = client.authorise_recurring_payment(amount: 1699, shopper: { reference: user.id })
+if response.authorised?
+  # we know the payment is on its way
+else
+  # something is wrong, maybe we got an error
+end
+```
+
+## Documentation
+
+All publicly usable [methods and classes are documented here](http://rdoc.info/projects/Overbryd/adyen_client).
+
+This library does not try to be too smart, it simply provides a layer of abstraction on top of the Adyen JSON API.
+Also the default `AdyenClient::Response` class basically just wraps the JSON response.
+The only work it does is converting `camelCase` keys to `sneak_case`, removing unnecessary object nestings and providing you with a convenience `authorised?` method. 
+
+If you want a more sophisticated response class, you can easily hook up your own.
+The only method you need to provide is `::new`. It will receive one argument, the [`HTTParty::Response`](http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/Response) for the given request.
+
+```ruby
+class MyAdyenResponse
+  def self.parse(http_response)
+    # ... your fancy code
+  end
+end
+```
+
+Hook it up by initialising the client like this: `AdyenClient.new(response_class: MyAdyenResponse)`.
+
+Similar, if you want nothing else than the bare `HTTParty::Response`, initialise the client with: `response_class: nil`.
+
+
+## Contributing
+
+I am very happy to receive pull requests or bug reports for problems with the library.
+Please make sure you are only reporting an actual issue with the library itself, I cannot help with your payment flow or advise you on anything related to the Adyen API.
+
+## Disclaimer
+
+I am not associated with Adyen in any way.
+If you have problems with your adyen account or your payment flow, please contact the very helpful Adyen support using `support ät adyen.com`.
+
+Please make yourself comfortable [with the Adyen documentation](https://docs.adyen.com/) on how you want to setup your payment flow.
+
+## License
+
+The MIT License (MIT), Copyright (c) 2015 Lukas Rieder
+
+See [`LICENSE`](https://github.com/Overbryd/adyen_client/blob/master/LICENSE).
+

data/lib/adyen_client/configuration.rb

@@ -0,0 +1,27 @@
+class AdyenClient
+
+  class Configuration
+    BASE_URI = "https://pal-%s.adyen.com/pal/servlet"
+    attr_accessor :environment
+    attr_accessor :username
+    attr_accessor :password
+    attr_accessor :cse_public_key
+    attr_accessor :default_merchant_account
+    attr_accessor :default_currency
+
+    def set(hash)
+      hash.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+    end
+
+    def apply(klass)
+      klass.base_uri(BASE_URI % environment)
+      klass.basic_auth(username, password)
+      # prevent following redirects and raise HTTParty::RedirectionTooDeep
+      klass.no_follow(true)
+      klass.format(:json)
+      klass.headers("Content-Type" => "application/json; charset=utf-8")
+    end
+  end
+
+end
+

data/lib/adyen_client/response.rb

@@ -0,0 +1,34 @@
+class AdyenClient
+
+  class Response
+    def self.parse(http_response)
+      new(http_response.code, Utils.massage_response(http_response.parsed_response))
+    end
+
+    attr_reader :code, :data
+    alias_method :to_hash, :data
+
+    def initialize(code, data)
+      @code, @data = code, data
+    end
+
+    def success?
+      code == 200
+    end
+
+    def authorised?
+      success? && result_code == "Authorised"
+    end
+    alias_method :authorized?, :authorised? # for our friends abroad
+
+    def respond_to_missing?(name, include_private = false)
+      @data.has_key?(name.to_s) || super
+    end
+
+    def method_missing(name, *args, &block)
+      @data.fetch(name.to_s) { super(name, *args, &block) }
+    end
+  end
+
+end
+

data/lib/adyen_client/utils.rb

@@ -0,0 +1,33 @@
+class AdyenClient
+
+  module Utils
+    def massage_response(value, parent = nil)
+      case value
+      when Array
+        value.map { |v| massage_response(v, value) }
+      when Hash
+        if parent.is_a?(Array) && value.count == 1
+          _, v = value.first
+          massage_response(v, value)
+        else
+          Hash[value.map { |k, v| [snake_caseify(k), massage_response(v, value)] }]
+        end
+      else
+        value
+      end
+    end
+
+    def snake_caseify(string)
+      string
+        .gsub("::", "/")
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr("-", "_")
+        .downcase
+    end
+
+    extend self
+  end
+
+end
+

data/lib/adyen_client.rb

@@ -0,0 +1,253 @@
+require "httparty"
+require "adyen_client/utils"
+require "adyen_client/response"
+require "adyen_client/configuration"
+
+class AdyenClient
+  include HTTParty
+
+  # Internal: Access the configuration instance.
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Public: Configure the AdyenClient class.
+  #
+  # hash   - The configuration to apply. Will be evaluated before &block. (optional if &block is given)
+  # &block - Yields the configuration instance. (optional if hash is given)
+  #
+  # Examples
+  #
+  #   # Block style
+  #   AdyenClient.configure do |c|
+  #     c.environment = :test
+  #     c.username = "ws_123456@Company.FooBar"
+  #     c.password = "correctbatteryhorsestaple"
+  #     c.cse_public_key = "10001|..."
+  #     c.default_merchant_account = "FooBar123"
+  #     c.default_currency = "EUR"
+  #   end
+  #
+  #   # Hash style works too, string or symbol keys
+  #   AdyenClient.configure(environment: :test, username: "ws_123456@Company.FooBar", ...)
+  #
+  #   # That comes in handy to configure the client from a YAML file
+  #   AdyenClient.configure(YAML.load_file(Rails.root.join("config", "adyen.yml"))[Rails.env.to_s])
+  #
+  #   # You can override all default options for each instance of a client
+  #   client = AdyenClient.new(merchant_account: "FooBarSubMerchant123")
+  #   eur_client = AdyenClient.new(currency: "EUR")
+  #
+  # Yields the configuration singleton.
+  #
+  # Returns the configuration singleton.
+  def self.configure(hash = nil)
+    configuration.set(hash) if hash
+    yield configuration if block_given?
+    configuration.apply(self)
+    configuration
+  end
+
+  # Public: Returns an ISO8601 formatted datetime string used in Adyens generationTime.
+  def self.generation_time
+    Time.now.iso8601
+  end
+
+  # Public: Returns the configured CSE (client side encryption) public key.
+  def self.cse_public_key
+    configuration.cse_public_key
+  end
+
+  attr_reader :merchant_account
+
+  # Public: Initializes a new instance of the AdyenClient.
+  #         You can override merchant_account and currency from the default configuration.
+  #
+  # :merchant_account - Sets the default_merchant_account for this instance. (optional)
+  # :currency         - Sets the default_currency for this instance. (optional)
+  # :response_class   - Use a custom class for handling responses from Adyen. (optional)
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def initialize(merchant_account: configuration.default_merchant_account, currency: configuration.default_currency, response_class: Response)
+    @merchant_account = merchant_account
+    @currency = currency
+    @response_class = response_class
+  end
+
+  # Public: Charge a user by referencing his stored payment method.
+  #
+  # :shopper_reference   - The user reference id from your side.
+  # :amount              - The amount to charge in cents.
+  # :reference           - Your reference id for this transaction.
+  # :recurring_reference - Use when referencing a specific payment method stored for the user. (default: "LATEST")
+  # :merchant_account    - Use a specific merchant account for this transaction. (default: set by the instance or configuration default merchant account)
+  # :currency            - Use a specific 3-letter currency code. (default: set by the instance or configuration default currency)
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def authorise_recurring_payment(reference:, shopper_reference:, amount:, recurring_reference: "LATEST", merchant_account: @merchant_account, currency: configuration.default_currency)
+    postJSON("/Payment/v12/authorise",
+      reference: reference,
+      amount: { value: amount, currency: currency },
+      merchantAccount: merchant_account,
+      shopperReference: shopper_reference,
+      selectedRecurringDetailReference: recurring_reference,
+      selectedBrand: "",
+      recurring: { contract: "RECURRING" },
+      shopperInteraction: "ContAuth"
+    )
+  end
+  alias_method :authorize_recurring_payment, :authorise_recurring_payment
+
+  # Public: List the stored payment methods for a user.
+  #
+  # :shopper_reference   - The user reference id from your side.
+  # :merchant_account    - Use a specific merchant account for this transaction. (default: set by the instance or configuration default merchant account)
+  # :currency            - Use a specific 3-letter currency code. (default: set by the instance or configuration default currency)
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def list_recurring_details(shopper_reference:, merchant_account: @merchant_account, contract: "RECURRING")
+    postJSON("/Recurring/v12/listRecurringDetails",
+      shopperReference: shopper_reference,
+      recurring: { contract: contract },
+      merchantAccount: merchant_account
+    )
+  end
+
+  # Public: Store a payment method on a reference id for recurring/later use.
+  #         Does verify the users payment method, but does not create a charge.
+  #
+  # :encrypted_card    - The encrypted credit card information generated by the CSE (client side encryption) javascript integration.
+  # :reference         - Your reference id for this transaction.
+  # :shopper           - The hash describing the shopper for this contract:
+  #                     :reference - Your reference id for this shopper/user. (mandatory)
+  #                     :email     - The shoppers email address. (optional but recommended)
+  #                     :ip        - The shoppers last known ip address. (optional but recommended)
+  # :merchant_account  - Use a specific merchant account for this transaction. (default: set by the instance or configuration default merchant account)
+  # :currency          - Use a specific 3-letter currency code. (default: set by the instance or configuration default currency)
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def create_recurring_contract(encrypted_card:, reference:, shopper:, merchant_account: @merchant_account, currency: @currency)
+    postJSON("/Payment/v12/authorise",
+      reference: reference,
+      additionalData: { "card.encrypted.json": encrypted_card },
+      amount: { value: 0, currency: currency },
+      merchantAccount: merchant_account,
+      shopperEmail: shopper[:email],
+      shopperIP: shopper[:ip],
+      shopperReference: shopper[:reference],
+      recurring: { contract: "RECURRING" }
+    )
+  end
+
+  # Public: Charge a credit card.
+  #
+  # :encrypted_card   - The encrypted credit card information generated by the CSE (client side encryption) javascript integration.
+  # :amount           - The integer amount in cents.
+  # :reference        - Your reference id for this transaction.
+  # :merchant_account - Use a specific merchant account for this transaction. (default: set by the instance or configuration default merchant account)
+  # :currency         - Use a specific 3-letter currency code. (default: set by the instance or configuration default currency)
+  # :shopper          - The hash describing the shopper for this transaction, optional but recommended (default: {}):
+  #                    :email     - The shoppers email address (optional but recommended).
+  #                    :ip        - The shoppers last known ip address (optional but recommended).
+  #                    :reference - Your reference id for this shopper/user (optional).
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def authorise(encrypted_card:, amount:, reference:, merchant_account: @merchant_account, currency: @currency, shopper: {})
+    postJSON("/Payment/v12/authorise",
+      reference: reference,
+      amount: { value: amount, currency: currency },
+      merchantAccount: merchant_account,
+      additionalData: { "card.encrypted.json": encrypted_card }
+    )
+  end
+  alias_method :authorize, :authorise
+
+  # Public: Verify a credit card (does not create a charge, but may be verified for a specified amount).
+  #
+  # :encrypted_card   - The encrypted credit card information generated by the CSE (client side encryption) javascript integration.
+  # :reference        - Your reference id for this transaction.
+  # :amount           - The integer amount in cents. Will not be charged on the card. (default: 0)
+  # :merchant_account - Use a specific merchant account for this transaction (default: set by the instance or configuration default merchant account).
+  # :currency         - Use a specific 3-letter currency code (default: set by the instance or configuration default currency).
+  # :shopper          - The hash describing the shopper for this transaction, optional but recommended (default: {}):
+  #                    :email     - The shoppers email address (optional but recommended).
+  #                    :ip        - The shoppers last known ip address (optional but recommended).
+  #                    :reference - Your reference id for this shopper/user (optional).
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def verify(encrypted_card:, reference:, amount: 0, merchant_account: @merchant_account, currency: @currency, shopper: {})
+    postJSON("/Payment/v12/authorise",
+      reference: reference,
+      amount: { value: 0, currency: currency },
+      additionalAmount: { value: amount, currency: currency },
+      merchantAccount: merchant_account,
+      additionalData: { "card.encrypted.json": encrypted_card }
+    )
+  end
+
+  # Public: Cancels a credit card transaction.
+  #
+  # :original_reference - The psp_reference from Adyen for this transaction.
+  # :reference          - Your reference id for this transaction.
+  # :merchant_account   - Use a specific merchant account for this transaction (default: set by the instance or configuration default merchant account).
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def cancel(original_reference:, reference:, merchantAccount: @merchant_account)
+    postJSON("/Payment/v12/cancel",
+      reference: reference,
+      merchantAccount: merchant_account,
+      originalReference: original_reference
+    )
+  end
+
+  # Public: Refunds a credit card transaction.
+  #
+  # :original_reference - The psp_reference from Adyen for this transaction.
+  # :amount             - The amount in cents to be refunded.
+  # :reference          - Your reference id for this transaction.
+  # :merchant_account   - Use a specific merchant account for this transaction (default: set by the instance or configuration default merchant account).
+  # :currency           - Use a specific 3-letter currency code (default: set by the instance or configuration default currency).
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def refund(original_reference:, amount:, reference:, merchantAccount: @merchant_account, currency: @currency)
+    postJSON("/Payment/v12/refund",
+      reference: reference,
+      merchantAccount: merchant_account,
+      modificationAmount: { value: amount, currency: currency },
+      originalReference: original_reference
+    )
+  end
+
+  # Public: Cancels or refunds a credit card transaction. Use this if you don't know the exact state of a transaction.
+  #
+  # :original_reference - The psp_reference from Adyen for this transaction.
+  # :reference          - Your reference id for this transaction.
+  # :merchant_account   - Use a specific merchant account for this transaction (default: set by the instance or configuration default merchant account).
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def cancel_or_refund(original_reference:, reference:, merchantAccount: @merchant_account)
+    postJSON("/Payment/v12/cancelOrRefund",
+      reference: reference,
+      merchantAccount: merchant_account,
+      originalReference: original_reference
+    )
+  end
+
+  # Internal: Send a POST request to the Adyen API.
+  #
+  # path - The Adyen JSON API endpoint path.
+  # data - The Hash describing the JSON body for this request.
+  #
+  # Returns an AdyenClient::Response or your specific response implementation.
+  def postJSON(path, data)
+    response = self.class.post(path, body: data.to_json)
+    @response_class ? @response_class.parse(response) : response
+  end
+
+  # Internal: Returns the AdyenClient configuration singleton
+  def configuration
+    self.class.configuration
+  end
+
+end
+

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: adyen_client
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Lukas Rieder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.5
+description: Does not try to be smart, stays close to the documentation while adhering
+  to ruby conventions.
+email: l.rieder@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- lib/adyen_client.rb
+- lib/adyen_client/configuration.rb
+- lib/adyen_client/response.rb
+- lib/adyen_client/utils.rb
+homepage: https://github.com/Overbryd/adyen_client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple client that talks to the Adyen API
+test_files: []