activemerchant-payline 0.1.9

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b75d6271696189f8272a67a62ae50f3bd1b912e3
+  data.tar.gz: 14668c93e6ea755462537b6fa18566737c90a550
+SHA512:
+  metadata.gz: 5808ddf102cf04d14b13f395ed8300d14d168dc852e77f563e731d26b9d8391194eb4e4b89ed2b90da7b1fcbc6e93dc238db99dc260cbf13c805bdf9e617a7e5
+  data.tar.gz: 273f1057b88d40cee4c5f187dc3cd84e906c2313dfbadd0c9cb3ba8d8a43b0f4b96858c9ef960ba6269e71945d07533b16714aadbee6a57903e67b85b66e342e

data/.env.example

@@ -0,0 +1,5 @@
+PAYLINE_MERCHANT_ID="1234567891011"
+PAYLINE_ACCESS_KEY="password"
+PAYLINE_CONTRACT_NUMBER="1234567"
+PAYLINE_RETURN_URL="http://test.com"
+PAYLINE_CANCEL_RETURN_URL="http://test.com"

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.env

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+- 2.3.3
+bundler_args: --jobs=2
+script:
+  - ruby test/run_test.rb
+cache: bundler
+notifications:
+  slack: c4dna:3PjAjqHWqGxzjKIXZfedtV7U

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in payline-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012-2013 Goldmund International, Kareea SARL, Samuel Lebeau
+
+MIT License
+
+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,57 @@
+# ActiveMerchant Payline
+
+[![Build Status](https://travis-ci.com/c4ddna/active_merchant_payline.svg?token=TCtHVJZbagUskWponM9C&branch=master)](https://travis-ci.com/c4ddna/active_merchant_payline)
+
+ActiveMerchant implementation of the [Payline] [1] Gateway.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+  gem 'activemerchant-payline'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install activemerchant-payline
+
+
+## Usage
+
+```
+  payline = PaylineGateway.new(
+    merchant_id: "1234567891011" # Your merchant ID,
+    merchant_access_key: "your_merchant_api_access_key",
+    contract_number: "1234567",
+    return_url: "http://test.com",
+    cancel_return_url: "http://test.com",
+    test: true
+  )
+
+  payline.do_web_payment(100, order_id: "MYORDERID")
+```
+
+Please note that all methods aren't implemented yet. Contributions are welcome.
+
+## Useful payline links
+Test API: http://www.concupourvendre.com/demo/
+Documentation: https://payline.atlassian.net/wiki/display/DT/Documentation
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+Test your code:
+- Create a .env file in the test folder and complete it following the .env.example
+- Write your tests and launch tests using the ruby test/run_test.rb command
+
+
+[1]: http://www.payline.com/
+[2]: https://homologation-admin.payline.com/

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/activemerchant-payline.gemspec

@@ -0,0 +1,33 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |gem|
+  gem.name          = "activemerchant-payline"
+  gem.version       = "0.1.9"
+  gem.authors       = ["Samuel Lebeau", "Arpsara", "CT2C"]
+  gem.email         = ["samuel.lebeau@gmail.com", "contact@ct2c.fr"]
+  gem.summary       = %q{ActiveMerchant implementation of the Payline Gateway.}
+  gem.homepage      = "https://github.com/Goldmund/activemerchant-payline"
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.require_paths = ["lib"]
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+
+  gem.add_dependency 'activemerchant', '~> 1.73.0'
+  gem.add_dependency 'savon', '2.11.1'
+
+  gem.add_dependency('activesupport', '>= 3.2.14')
+  gem.add_dependency('i18n', '>= 0.6.9')
+  gem.add_dependency('builder', '>= 2.1.2', '< 4.0.0')
+  gem.add_dependency('nokogiri', "~> 1.4")
+
+  gem.add_development_dependency('rake')
+  gem.add_development_dependency('test-unit', '> 3.0.0')
+  gem.add_development_dependency('mocha', '~> 1')
+  gem.add_development_dependency('thor')
+  gem.add_development_dependency('dotenv')
+  gem.add_development_dependency('vcr')
+  gem.add_development_dependency('webmock')
+end

data/lib/active_merchant/billing/gateways/payline.rb

@@ -0,0 +1,57 @@
+require 'activemerchant'
+require_relative 'payline/payline_constants'
+require_relative 'payline/payline_common'
+require_relative 'payline/payline_direct_api'
+require_relative 'payline/payline_management_payment_api'
+require_relative 'payline/payline_wallet_management'
+require_relative 'payline/payline_web_api'
+require_relative 'payline/payline_status_api'
+
+module ActiveMerchant
+  module Billing
+    class PaylineGateway < Gateway
+      include PaylineCommon
+      include PaylineDirectAPI
+      include PaylineWalletManagementAPI
+      include PaylineManagementPaymentAPI
+      include PaylineWebAPI
+      include PaylineStatusAPI
+      include ISO4217CurrencyCodes
+
+      API_VERSION = '4.24'.freeze
+
+      self.display_name = 'Payline'
+      self.homepage_url = 'http://www.payline.com/'
+
+      self.default_currency = 'EUR'
+      self.money_format = :cents
+      self.supported_cardtypes = [:visa, :master, :american_express, :diners_club, :jcb]
+
+      class_attribute :web_live_url, :web_test_url, :instance_writer => false
+
+      class_attribute :extended_payment_url, :extended_test_payment_url, :instance_writer => false
+
+      self.live_url = 'https://services.payline.com/V4/services/DirectPaymentAPI'.freeze
+      self.test_url = 'https://homologation.payline.com/V4/services/DirectPaymentAPI'.freeze
+
+      self.web_live_url = 'https://services.payline.com/V4/services/WebPaymentAPI/'.freeze
+      self.web_test_url = 'https://homologation.payline.com/V4/services/WebPaymentAPI/'.freeze
+
+      self.extended_payment_url = 'https://services.payline.com/V4/services/ExtendedAPI'.freeze
+      self.extended_test_payment_url = 'https://homologation.payline.com/V4/services/ExtendedAPI'.freeze
+
+      # :merchant_id [String]
+      # :merchant_secret [String]
+      # :contract_number [String] Contract Number
+      # :return_url [String] Return url - Must begin with http:// or https://
+      # :cancel_return_url [String] Cancel url - Must begin with http:// or https://
+      # :test [Boolean] Set it to true if you want to point to homologation services
+      def initialize(options = {})
+        requires!(options, :merchant_id, :merchant_access_key, :contract_number)
+        @options = options
+      end
+    end
+
+    Payline = ActiveSupport::Deprecation::DeprecatedConstantProxy.new('ActiveMerchant::Billing::Payline', PaylineGateway)
+  end
+end

data/lib/active_merchant/billing/gateways/payline/payline_common.rb

@@ -0,0 +1,368 @@
+require_relative '../../iso_4217_currency_codes'
+require 'savon'
+
+module ActiveMerchant
+  module Billing
+    module PaylineCommon
+
+      include PaylineConstants
+
+      protected
+        # Make a savon request
+        def savon_request(client, method_name, data)
+          add_shared_data(data)
+
+          response = client.call :"#{method_name}", { message: data }
+
+          if response.success?
+            response = response.to_hash[:"#{method_name}_response"]
+            build_response(response)
+          else
+            message = (response.soap_fault? ? response.soap_fault : response.http_error).to_s
+            Response.new(false, message, {}, { :test => test? })
+          end
+        end
+
+        def direct_api_request(method_name, data)
+          savon_request(direct_api_savon_client, method_name, data)
+        end
+
+        def direct_api_savon_client
+          @direct_api_savon_client ||= create_savon_client(test? ? test_url : live_url)
+        end
+
+        # Create a savon client
+        def create_savon_client(endpoint)
+          Savon.client(
+            wsdl:         test? ? WDSL_TEST_URL : WDSL_URL,
+            endpoint:     endpoint,
+            basic_auth:   [options[:merchant_id], options[:merchant_access_key]],
+            log: options[:log] ? options[:log] : false
+          )
+        end
+
+        def build_response(response)
+          message = message_from(result = response[:result])
+          if transaction = response[:transaction]
+            transaction_id = transaction[:id] if String === transaction[:id]
+          end
+          format_response!(response = response.with_indifferent_access)
+          Response.new(success?(result), message, response, {
+            :authorization => transaction_id,
+            :test => test?
+          })
+        end
+
+        def message_from(result)
+          message = result[:short_message]
+          message << ": " << result[:long_message] unless result[:long_message] == message
+          message << " (code #{result[:code]})"
+          message
+        end
+
+        def success?(result)
+          SUCCESS_CODES.include?(result[:code])
+        end
+
+        def contract_number
+          options[:contract_number]
+        end
+
+        def language_code(locale)
+          LANGUAGE_CODES[locale.to_s.downcase] if locale
+        end
+
+        def format_date(time)
+          time.strftime(DATETIME_FORMAT)
+        end
+
+        def format_boolean(boolean, default = false)
+          case boolean.nil? ? default : boolean
+            when true, 1
+              1
+            else
+              0
+          end
+        end
+
+        def format_response!(response)
+          unless response.delete("@xmlns") && response.empty?
+            response.each do |key, value|
+              if Hash === value
+                response[key] = format_response!(value)
+              elsif Array === value
+                value.map! { |el| format_response!(el) }
+              end
+            end
+          end
+        end
+
+        # Merge shared data with data
+        # Shared data are version, contract_number and others parameters in add_web_params
+        def add_shared_data(data)
+          hashes_to_merge = [add_version, add_contract_number, add_web_params(options)]
+          shared_data = hashes_to_merge.inject(&:merge)
+
+          data.merge!(shared_data)
+        end
+
+        # Optional parameters: md, pares, xid, eci, cavv, cavv_algorithm, vads_result, type_securisation, pa_res_status, ve_res_status
+        def add_authentication_3D_secure(authentication_3D_secure)
+          if authentication_3D_secure
+            optional_parameters = ['md',
+              'pares',
+              'xid',
+              'eci',
+              'cavv',
+              'cavvAlgorithm',
+              'vadsResult',
+              'typeSecurisation',
+              'PaResStatus',
+              'VeResStatus'
+            ]
+
+            objects = [add_optional_parameters(authentication_3D_secure, optional_parameters)]
+
+            data = {
+              authentication3DSecure: merged_data(objects)
+            }
+          end
+          data ||= {}
+        end
+
+        def add_contract_number
+          { contractNumber: contract_number }
+        end
+
+        def add_contract_number_wallet_list(contract_number)
+          if contract_number
+            data = { contractNumberWalletList:
+              {
+                contractNumberWallet: contract_number
+              }
+            }
+          end
+          data ||= {}
+        end
+
+        def add_credit_card(card)
+          if card
+            parameters = {
+              number: card[:number],
+              type: CARD_BRAND_CODES[card[:brand]],
+              expirationDate: expiration_date(card[:month], card[:year]),
+              cvx: card[:verification_value]
+            }
+            data = { card: parameters }
+          end
+          data ||= { card: {} }
+        end
+
+        def add_version
+          {version: WEB_API_VERSION}
+        end
+
+        def add_owner(owner_data)
+          optional_parameters = ['lastName', 'firstName', 'issueCardDate']
+
+          if owner_data
+            objects = [
+              add_address(owner_data[:billing_address], :billing_address),
+              add_optional_parameters(owner_data, optional_parameters)
+            ]
+            data = { owner: merged_data(objects) }
+          end
+
+          data ||= {}
+        end
+
+        def add_payment(amount, currency, action, mode = nil, options = {})
+          optional_parameters = ['differedActionDate', 'method', 'softDescriptor', 'cardBrand']
+          required_parameters = {
+            amount:   amount,
+            currency: currency,
+            action:   action_code(action),
+            mode:     payment_mode(mode),
+            contractNumber: contract_number
+          }
+
+          parameters = [
+            required_parameters,
+            add_optional_parameters(options, optional_parameters)
+          ]
+
+          data = { payment: merged_data(parameters) }
+        end
+
+        def add_order(amount, currency, ref, options)
+          optional_parameters = ['origin',
+            'country',
+            'taxes',
+            'details',
+            'deliveryMode',
+            'deliveryExpectedDate',
+            'deliveryExpectedDelay'
+          ]
+
+          date = options[:date] if !options.blank?
+          date ||= Time.now
+
+          required_parameters = {
+            amount: amount,
+            currency: currency,
+            ref: ref,
+            date: format_date(date)
+          }
+
+          details = add_details(options[:details]) if options &&  options[:details]
+
+          parameters = [
+            required_parameters,
+            # Optional parameters
+            details,
+            add_optional_parameters(options, optional_parameters)
+          ]
+
+          data = { order: merged_data(parameters) }
+        end
+
+        def add_buyer(buyer_data)
+          optional_parameters = [
+            'title',
+            'lastName',
+            'firstName',
+            'email',
+            'accountCreateDate',
+            'accountAverageAmount',
+            'accountOrderCount',
+            'walletId',
+            'walletDisplayed',
+            'walletSecured',
+            'walletCardInd',
+            'ip',
+            'mobilePhone',
+            'customerId',
+            'legalStatus',
+            'legalDocument',
+            'birthDate',
+            'fingerprintID',
+            'deviceFingerprint',
+            'isBot',
+            'isIncognito',
+            'isBehindProxy',
+            'isFromTor',
+            'isEmulator',
+            'isRooted',
+            'hasTimezoneMismatch'
+          ]
+
+          if buyer_data
+            # Note: Yes, shipping_adress with only one d because of Payline wrong attribute...
+            objects = [
+              add_address(buyer_data[:shipping_address], :shipping_adress),
+              add_address(buyer_data[:billing_address], :billing_address),
+              add_optional_parameters(buyer_data, optional_parameters)
+            ]
+
+            data = { buyer: merged_data(objects) }
+          end
+
+          data ||= { buyer: {} }
+        end
+
+        def add_address(address, address_name = :address)
+          optional_parameters = [
+            'title',
+            'name',
+            'firstName',
+            'lastName',
+            'street1',
+            'street2',
+            'cityName',
+            'zipCode',
+            'country', # TODO Values
+            'phone',
+            'state',
+            'county',
+            'phoneType' # TODO Values
+          ]
+
+          data = { "#{address_name}": add_optional_parameters(address, optional_parameters) } unless address.blank?
+          data ||= {}
+        end
+
+        def action_code(action)
+          action = :purchase if action.blank?
+          if ACTION_CODES.key?(action)
+            ACTION_CODES[action]
+          else
+            action
+          end
+        end
+
+        def payment_mode(mode)
+          mode = :direct if mode.blank?
+          if PAYMENT_MODES.key?(mode)
+            PAYMENT_MODES[mode]
+          else
+            mode
+          end
+        end
+
+        def add_details(details_data)
+          optional_parameters = [
+            'ref', 'price', 'quantity', 'comment', 'category', 'brand', 'subcategory1', 'subcategory2', 'additionalData', 'taxRate'
+          ]
+          data =  { details: add_optional_parameters(details_data, optional_parameters) }
+          data ||= { details: {} }
+        end
+
+        def add_private_data(private_data)
+          data = {}
+          if private_data
+            i = 0
+
+            private_data.to_hash.each do |key, value|
+              data.merge!({ "privateData_#{i}": { key: key, value: value } })
+              i += 1
+            end
+            data = { privateDataList: data}
+          end
+          data ||= {}
+        end
+
+        def add_selected_contract_list(contract_number, all_contract_numbers = [])
+          if !all_contract_numbers.blank?
+            data = { selectedContractList: { selectedContract: all_contract_numbers.uniq } }
+          elsif contract_number
+            data = { selectedContractList: { selectedContract: contract_number } }
+          end
+          data ||= {}
+        end
+
+        def underscore(camel_cased_word)
+          camel_cased_word.to_s.gsub(/::/, '/').
+            gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+            gsub(/([a-z\d])([A-Z])/,'\1_\2').
+            tr("-", "_").
+            downcase
+        end
+
+        def add_optional_parameters(options, optional_parameters=[])
+          data = {}
+          if options
+            optional_parameters.each do |parameter|
+              value = options[underscore(parameter).to_sym]
+
+              data.merge!({"#{parameter}".to_sym => value}) unless value.blank?
+            end
+          end
+          data
+        end
+
+        def merged_data(data = [])
+          data.reject{|x| x.blank?}.inject(&:merge)
+        end
+    end
+  end
+end