adyen_client 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bed3b1c2cd6bad30f1278dedc5bbf0a6eb1192e6
-  data.tar.gz: eb471bf5fc009cfaa44ba2c4809602363c3bfdc5
+  metadata.gz: 2cfdbe290375469bcc8fd26d9251665f60d1efcd
+  data.tar.gz: 67ff26eb4a0581b77e87ee650185faa17c896862
 SHA512:
-  metadata.gz: 3b31679659538ec245122826e0c465836b80ab6d02e3a171c5f729dfade0773191d7d570ddf90cdfd50bbc1e92dac245e10bf387b5551387d50d4f3e38a2dfb5
-  data.tar.gz: 2f344b0abdd6fd6ad19dfca2db359bbb769ad2c5f702fe9370a0cb9369e80d7890aa9de54eb4055c99a321f57562550ef57629fcc9054980c017a9bc11a5166c
+  metadata.gz: 5fbd7f75937c17840214e66bca9ae2c2b72722315b594288e3f578ca7e4c179d4876a031e324682ba360fda4fbff893543364ed6e6e44e65431aeef6481ebfa1
+  data.tar.gz: 527cae7b474e4140c0a7c1584e397f468573aa69fdc952c4b9298d82cf7e6532f21ecc3f0e1e1105eb9b9329e43c060f524a8d297f4c44be6f0a807ed75e046e

data/README.md

@@ -33,7 +33,7 @@ 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
+# You can override all default_* options for each instance of a client
 client = AdyenClient.new(merchant_account: "FooBarSubMerchant123")
 eur_client = AdyenClient.new(currency: "EUR")
 ```
@@ -93,7 +93,7 @@ Also the default `AdyenClient::Response` class basically just wraps the JSON res
 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.
+The only method you need to provide is `::parse`. It will receive one argument, the [`HTTParty::Response`](http://www.rubydoc.info/github/jnunemaker/httparty/HTTParty/Response) for the given request.
 
 ```ruby
 class MyAdyenResponse

data/lib/adyen_client.rb

@@ -1,8 +1,8 @@
 require "httparty"
-require "adyen_client/utils"
-require "adyen_client/response"
-require "adyen_client/configuration"
 
+# Public: Main class for interacting with the Adyen API
+#
+# Use an instance to configure for the situation and talk to the API.
 class AdyenClient
   include HTTParty
 
@@ -82,14 +82,17 @@ class AdyenClient
   # :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)
+  # :statement           - Supply a statement that should be shown on the customers credit card bill. (default: "")
+  #                        Note however that most card issues allow for not more than 22 characters.
   #
   # 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)
+  def authorise_recurring_payment(reference:, shopper_reference:, amount:, recurring_reference: "LATEST", merchant_account: @merchant_account, currency: configuration.default_currency, statement: "")
     postJSON("/Payment/v12/authorise",
       reference: reference,
       amount: { value: amount, currency: currency },
       merchantAccount: merchant_account,
       shopperReference: shopper_reference,
+      shopperStatement: statement,
       selectedRecurringDetailReference: recurring_reference,
       selectedBrand: "",
       recurring: { contract: "RECURRING" },
@@ -118,6 +121,8 @@ class AdyenClient
   #
   # :encrypted_card    - The encrypted credit card information generated by the CSE (client side encryption) javascript integration.
   # :reference         - Your reference id for this transaction.
+  #                      Caveat: According to Adyen a hyphen "-" is treated as a separator for multiple references.
+  #                      If you are using something like `SecureRandom.uuid` be sure to replace "-" with something else.
   # :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)
@@ -144,20 +149,28 @@ class AdyenClient
   # :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.
+  #                     Caveat: According to Adyen a hyphen "-" is treated as a separator for multiple references.
+  #                     If you are using something like `SecureRandom.uuid` be sure to replace "-" with something else.
   # :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).
+  #                     :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).
+  # :statement        - Supply a statement that should be shown on the customers credit card bill. (default: "")
+  #                     Note however that most card issues allow for not more than 22 characters.
   #
   # Returns an AdyenClient::Response or your specific response implementation.
-  def authorise(encrypted_card:, amount:, reference:, merchant_account: @merchant_account, currency: @currency, shopper: {})
+  def authorise(encrypted_card:, amount:, reference:, merchant_account: @merchant_account, currency: @currency, shopper: {}, statement: "")
     postJSON("/Payment/v12/authorise",
       reference: reference,
       amount: { value: amount, currency: currency },
       merchantAccount: merchant_account,
-      additionalData: { "card.encrypted.json": encrypted_card }
+      additionalData: { "card.encrypted.json": encrypted_card },
+      shopperEmail: shopper[:email],
+      shopperIP: shopper[:ip],
+      shopperReference: shopper[:reference],
+      shopperStatement: statement
     )
   end
   alias_method :authorize, :authorise
@@ -166,22 +179,30 @@ class AdyenClient
   #
   # :encrypted_card   - The encrypted credit card information generated by the CSE (client side encryption) javascript integration.
   # :reference        - Your reference id for this transaction.
+  #                     Caveat: According to Adyen a hyphen "-" is treated as a separator for multiple references.
+  #                     If you are using something like `SecureRandom.uuid` be sure to replace "-" with something else.
   # :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).
+  #                     :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).
+  # :statement        - Supply a statement that should be shown on the customers credit card bill. (default: "")
+  #                     Note however that most card issues allow for not more than 22 characters.
   #
   # Returns an AdyenClient::Response or your specific response implementation.
-  def verify(encrypted_card:, reference:, amount: 0, merchant_account: @merchant_account, currency: @currency, shopper: {})
+  def verify(encrypted_card:, reference:, amount: 0, merchant_account: @merchant_account, currency: @currency, shopper: {}, statement: "")
     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 }
+      additionalData: { "card.encrypted.json": encrypted_card },
+      shopperEmail: shopper[:email],
+      shopperIP: shopper[:ip],
+      shopperReference: shopper[:reference],
+      shopperStatement: statement
     )
   end
 
@@ -251,3 +272,6 @@ class AdyenClient
 
 end
 
+require "adyen_client/utils"
+require "adyen_client/response"
+require "adyen_client/configuration"

data/lib/adyen_client/configuration.rb

@@ -1,27 +1,23 @@
-class AdyenClient
+class AdyenClient::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
 
-  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
+  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
 

data/lib/adyen_client/response.rb

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

data/lib/adyen_client/utils.rb

@@ -1,33 +1,29 @@
-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
+module AdyenClient::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
-        value
+        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
+  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
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: adyen_client
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Lukas Rieder
@@ -57,8 +57,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A simple client that talks to the Adyen API
 test_files: []
+has_rdoc: