active_merchant_first_data 1.0.0 → 1.1.0

data/README.md

@@ -1,5 +1,5 @@
-First Data gateway for Active Merchant
-======================================
+First Data Latvia gateway for Active Merchant
+=============================================
 
 [![Continuous Integration status](https://secure.travis-ci.org/ebeigarts/active_merchant_first_data.png)](http://travis-ci.org/ebeigarts/active_merchant_first_data)
 
@@ -32,14 +32,16 @@ require "active_merchant_first_data"
 
 3. Copy the 3 files you received in e-mail to `spec/certs/`:
 
-    * 1234567.pem
-    * 1234567_certificate_chain.p7.pem
-    * ECOMM.pem
+    ```
+    1234567.pem
+    1234567_certificate_chain.p7.pem
+    ECOMM.pem
+    ```
 
 4. Convert the certificates and keys to `1234567_keystore.pem`
 
     ```bash
-    $ openssl pkcs12 -export -in 1234567.pem -out spec/certs/1234567_keystore.p12 -certfile spec/certs/ECOMM.pem -inkey spec/certs/1234567_key.pem
+    $ openssl pkcs12 -export -in spec/certs/1234567.pem -out spec/certs/1234567_keystore.p12 -certfile spec/certs/ECOMM.pem -inkey spec/certs/1234567_key.pem
     Enter pass phrase for 1234567_key.pem: 81f174259v45
     Enter Export Password: <empty>
     ```

data/lib/active_merchant/billing/first_data_gateway.rb

@@ -18,15 +18,60 @@ module ActiveMerchant #:nodoc:
       self.default_currency = '428' # LVL (http://en.wikipedia.org/wiki/ISO_4217)
       self.money_format = :cents
 
+      CURRENCY_CODES = {
+        'ADP' => '020', 'AED' => '784', 'AFA' => '004', 'ALL' => '008', 'AMD' => '051',
+        'ANG' => '532', 'AOA' => '973', 'ARS' => '032', 'AUD' => '036', 'AWG' => '533',
+        'AZM' => '031', 'BAM' => '977', 'BBD' => '052', 'BDT' => '050', 'BGL' => '100',
+        'BGN' => '975', 'BHD' => '048', 'BIF' => '108', 'BMD' => '060', 'BND' => '096',
+        'BOB' => '068', 'BOV' => '984', 'BRL' => '986', 'BSD' => '044', 'BTN' => '064',
+        'BWP' => '072', 'BYR' => '974', 'BZD' => '084', 'CAD' => '124', 'CDF' => '976',
+        'CHF' => '756', 'CLF' => '990', 'CLP' => '152', 'CNY' => '156', 'COP' => '170',
+        'CRC' => '188', 'CUP' => '192', 'CVE' => '132', 'CYP' => '196', 'CZK' => '203',
+        'DJF' => '262', 'DKK' => '208', 'DOP' => '214', 'DZD' => '012', 'ECS' => '218',
+        'ECV' => '983', 'EEK' => '233', 'EGP' => '818', 'ERN' => '232', 'ETB' => '230',
+        'EUR' => '978', 'FJD' => '242', 'FKP' => '238', 'GBP' => '826', 'GEL' => '981',
+        'GHC' => '288', 'GIP' => '292', 'GMD' => '270', 'GNF' => '324', 'GTQ' => '320',
+        'GWP' => '624', 'GYD' => '328', 'HKD' => '344', 'HNL' => '340', 'HRK' => '191',
+        'HTG' => '332', 'HUF' => '348', 'IDR' => '360', 'ILS' => '376', 'INR' => '356',
+        'IQD' => '368', 'IRR' => '364', 'ISK' => '352', 'JMD' => '388', 'JOD' => '400',
+        'JPY' => '392', 'KES' => '404', 'KGS' => '417', 'KHR' => '116', 'KMF' => '174',
+        'KPW' => '408', 'KRW' => '410', 'KWD' => '414', 'KYD' => '136', 'KZT' => '398',
+        'LAK' => '418', 'LBP' => '422', 'LKR' => '144', 'LRD' => '430', 'LSL' => '426',
+        'LTL' => '440', 'LVL' => '428', 'LYD' => '434', 'MAD' => '504', 'MDL' => '498',
+        'MGF' => '450', 'MKD' => '807', 'MMK' => '104', 'MNT' => '496', 'MOP' => '446',
+        'MRO' => '478', 'MTL' => '470', 'MUR' => '480', 'MVR' => '462', 'MWK' => '454',
+        'MXN' => '484', 'MXV' => '979', 'MYR' => '458', 'MZM' => '508', 'NAD' => '516',
+        'NGN' => '566', 'NIO' => '558', 'NOK' => '578', 'NPR' => '524', 'NZD' => '554',
+        'OMR' => '512', 'PAB' => '590', 'PEN' => '604', 'PGK' => '598', 'PHP' => '608',
+        'PKR' => '586', 'PLN' => '985', 'PYG' => '600', 'QAR' => '634', 'ROL' => '642',
+        'RUB' => '643', 'RUR' => '810', 'RWF' => '646', 'SAR' => '682', 'SBD' => '090',
+        'SCR' => '690', 'SDD' => '736', 'SEK' => '752', 'SGD' => '702', 'SHP' => '654',
+        'SIT' => '705', 'SKK' => '703', 'SLL' => '694', 'SOS' => '706', 'SRG' => '740',
+        'STD' => '678', 'SVC' => '222', 'SYP' => '760', 'SZL' => '748', 'THB' => '764',
+        'TJS' => '972', 'TMM' => '795', 'TND' => '788', 'TOP' => '776', 'TPE' => '626',
+        'TRL' => '792', 'TRY' => '949', 'TTD' => '780', 'TWD' => '901', 'TZS' => '834',
+        'UAH' => '980', 'UGX' => '800', 'USD' => '840', 'UYU' => '858', 'UZS' => '860',
+        'VEB' => '862', 'VND' => '704', 'VUV' => '548', 'XAF' => '950', 'XCD' => '951',
+        'XOF' => '952', 'XPF' => '953', 'YER' => '886', 'YUM' => '891', 'ZAR' => '710',
+        'ZMK' => '894', 'ZWD' => '716'
+      }
+
+      class Error < StandardError
+        attr_reader :response
+
+        def initialize(response, msg=nil)
+          @response = response
+          super(msg || response[:error])
+        end
+      end
+
       # Creates a new FirstDataGateway
       #
       # The gateway requires that a valid pem and password be passed
       # in the +options+ hash.
       #
-      # Options:
-      #
-      # * <tt>:pem</tt> -- The First Data cert/key (REQUIRED)
-      # * <tt>:pem_password</tt> -- The First Data password. (REQUIRED)
+      # @option options [String] :pem First Data cert/key (REQUIRED)
+      # @option options [String] :pem_password First Data cert password (REQUIRED)
       #
       def initialize(options = {})
         requires!(options, :pem, :pem_password)
@@ -37,12 +82,13 @@ module ActiveMerchant #:nodoc:
       # Perform a purchase, which is essentially an authorization and capture in a single operation.
       #
       # Registering of SMS transaction
-      # @param int $amount transaction amount in minor units, mandatory 
-      # @param int $currency transaction currency code, mandatory 
-      # @param string $ip clientís IP address, mandatory
-      # @param string $desc description of transaction, optional
-      # @param string $language authorization language identificator, optional 
-      # @return string TRANSACTION_ID
+      #
+      # @param [Integer] amount transaction amount in minor units, mandatory
+      # @option params [Integer, String] :currency transaction currency code, mandatory
+      # @option params [String] :client_ip_addr client's IP address, mandatory
+      # @option params [String] :description description of transaction, optional
+      # @option params [String] :language authorization language identificator, optional
+      # @return [ActiveSupport::HashWithIndifferentAccess] TRANSACTION_ID
       #
       def purchase(amount, params = {})
         params = params.reverse_merge(
@@ -50,6 +96,7 @@ module ActiveMerchant #:nodoc:
           :amount => amount,
           :currency => default_currency
         )
+        lookup_currency(params)
         requires!(params, :amount, :currency, :client_ip_addr)
         commit(params)
       end
@@ -58,12 +105,13 @@ module ActiveMerchant #:nodoc:
       # charge the card.
       #
       # Registering of DMS authorisation
-      # @param int $amount transaction amount in minor units, mandatory 
-      # @param int $currency transaction currency code, mandatory 
-      # @param string $ip clientís IP address, mandatory
-      # @param string $desc description of transaction, optional
-      # @param string $language authorization language identificator, optional 
-      # @return string TRANSACTION_ID
+      #
+      # @param [Integer] amount transaction amount in minor units, mandatory
+      # @option params [Integer, String] :currency transaction currency code, mandatory
+      # @option params [String] :client_ip_addr client's IP address, mandatory
+      # @option params [String] :description description of transaction, optional
+      # @option params [String] :language authorization language identificator, optional
+      # @return [ActiveSupport::HashWithIndifferentAccess] TRANSACTION_ID
       #
       def authorize(amount, params = {})
         params = params.reverse_merge(
@@ -72,6 +120,7 @@ module ActiveMerchant #:nodoc:
           :amount => amount,
           :currency => default_currency
         )
+        lookup_currency(params)
         requires!(params, :amount, :currency, :client_ip_addr, :msg_type)
         commit(params)
       end
@@ -79,12 +128,13 @@ module ActiveMerchant #:nodoc:
       # Captures the funds from an authorized transaction.
       #
       # Making of DMS transaction
-      # @param int $auth_id id of previously made successeful authorisation
-      # @param int $amount transaction amount in minor units, mandatory 
-      # @param int $currency transaction currency code, mandatory 
-      # @param string $ip clientís IP address, mandatory
-      # @param string $desc description of transaction, optional
-      # @return string RESULT, RESULT_CODE, RRN, APPROVAL_CODE
+      #
+      # @param [Integer] amount transaction amount in minor units, mandatory
+      # @param [Integer] trans_id id of previously made successeful authorisation
+      # @option params [Integer, String] :currency transaction currency code, mandatory
+      # @option params [String] :client_ip_addr client's IP address, mandatory
+      # @option params [String] :description description of transaction, optional
+      # @return [ActiveSupport::HashWithIndifferentAccess] RESULT, RESULT_CODE, RRN, APPROVAL_CODE
       #
       def capture(amount, trans_id, params = {})
         params = params.reverse_merge(
@@ -94,15 +144,16 @@ module ActiveMerchant #:nodoc:
           :amount => amount,
           :currency => default_currency
         )
+        lookup_currency(params)
         requires!(params, :trans_id, :amount, :currency, :client_ip_addr)
         commit(params)
       end
 
       # Transaction result
       #
-      # @param int $trans_id transaction identifier, mandatory
-      # @param string $ip clientís IP address, mandatory
-      # @return string RESULT, RESULT_CODE, 3DSECURE, AAV, RRN, APPROVAL_CODE
+      # @param [Integer] trans_id transaction identifier, mandatory
+      # @option params [String] :client_ip_addr client's IP address, mandatory
+      # @return [ActiveSupport::HashWithIndifferentAccess] RESULT, RESULT_CODE, 3DSECURE, AAV, RRN, APPROVAL_CODE
       #
       def result(trans_id, params = {})
         params = params.reverse_merge(
@@ -113,14 +164,15 @@ module ActiveMerchant #:nodoc:
         commit(params)
       end
 
-      # credit() allows you to return money to a card that was previously billed.
+      # refund() allows you to return money to a card that was previously billed.
       #
       # Transaction reversal
-      # @param int $trans_id transaction identifier, mandatory
-      # @param int $amount transaction amount in minor units, mandatory 
-      # @return string RESULT, RESULT_CODE
       #
-      def credit(amount, trans_id = nil)
+      # @param [Integer] amount transaction amount in minor units, mandatory
+      # @param [Integer] trans_id transaction identifier, mandatory
+      # @return [ActiveSupport::HashWithIndifferentAccess] RESULT, RESULT_CODE
+      #
+      def refund(amount, trans_id = nil)
         params = {
           :command => :r,
           :trans_id => trans_id,
@@ -130,6 +182,95 @@ module ActiveMerchant #:nodoc:
         commit(params)
       end
 
+      def credit(amount, trans_id = nil)
+        deprecated CREDIT_DEPRECATION_MESSAGE
+        refund(amount, trans_id)
+      end
+
+      # Register new recurring payment along with the first payment
+      #
+      # @param [Integer] amount transaction amount in minor units, mandatory (up to 12 digits)
+      # @option params [Integer, String] :currency transaction currency code, mandatory
+      # @option params [String] :client_ip_addr client's IP address, mandatory
+      # @option params [String] :description transaction details, mandatory (up to 125 characters)
+      # @option params [String] :biller_client_id recurring payment identifier, mandatory (up to 30 characters)
+      # @option params [String] :perspayee_expiry preferred deadline for a Recurring payment, mandatory (MMYY)
+      #   (system will compare two expiry dates - recurring payment expiry date provided by Merchant and
+      #   card expiry date provided by Cardholder. In response Merchant will receive back the earliest expiry dates of both).
+      #   For example, Recurring payment date is 1214 but card expiry date 1213 then Merchant will receive back 1213.
+      #   First Data system will save the earliest expiry date as Recurring payment expiry date.
+      # @option params [Integer] :perspayee_overwrite set to 1 to overwrite existing recurring payment card data
+      #   together with payment, optional
+      # @option params [String] :language authorization language identificator, optional
+      # @return [ActiveSupport::HashWithIndifferentAccess] TRANSACTION_ID
+      #
+      # Afterwards when transaction result is requested then result response includes also RECC_PMNT_ID and RECC_PMNT_EXPIRY
+      #
+      def recurring(amount, params = {})
+        params = params.reverse_merge(
+          :command => :z,
+          :amount => amount,
+          :currency => default_currency,
+          :msg_type => 'SMS',
+          :perspayee_gen => 1
+        )
+        lookup_currency(params)
+        requires!(params, :amount, :currency, :client_ip_addr, :description, :biller_client_id, :perspayee_expiry)
+        commit(params)
+      end
+
+      # Execute subsequent recurring payment
+      #
+      # @param [Integer] amount transaction amount in minor units, mandatory (up to 12 digits)
+      # @option params [Integer, String] :currency transaction currency code, mandatory
+      # @option params [String] :client_ip_addr client's IP address, mandatory
+      #   (the same IP address which was provided when registered recurring payment)
+      # @option params [String] :description transaction details, mandatory (up to 125 characters)
+      # @option params [String] :biller_client_id recurring payment identifier, mandatory (up to 30 characters)
+      # @return [ActiveSupport::HashWithIndifferentAccess] TRANSACTION_ID, RESULT, RESULT_CODE, RRN, APPROVAL_CODE
+      #
+      def execute_recurring(amount, params = {})
+        params = params.reverse_merge(
+          :command => :e,
+          :amount => amount,
+          :currency => default_currency
+        )
+        lookup_currency(params)
+        requires!(params, :amount, :currency, :client_ip_addr, :description, :biller_client_id)
+        commit(params)
+      end
+
+      # Overwriting existing recurring payment card data without payment
+      #
+      # @option params [Integer, String] :currency transaction currency code, mandatory
+      # @option params [String] :client_ip_addr client's IP address, mandatory
+      # @option params [String] :description transaction details, mandatory (up to 125 characters)
+      # @option params [String] :biller_client_id existing recurring payment identifier, mandatory (up to 30 characters)
+      # @option params [String] :perspayee_expiry preferred deadline for a Recurring payment, mandatory (MMYY)
+      #   (system will compare two expiry dates - recurring payment expiry date provided by Merchant and
+      #   card expiry date provided by Cardholder. In response Merchant will receive back the earliest expiry dates of both).
+      #   For example, Recurring payment date is 1214 but card expiry date 1213 then Merchant will receive back 1213.
+      #   First Data system will save the earliest expiry date as Recurring payment expiry date.
+      # @option params [String] :language authorization language identificator, optional
+      # @return [ActiveSupport::HashWithIndifferentAccess] TRANSACTION_ID
+      #
+      # Afterwards when transaction result is requested then result response includes also RECC_PMNT_ID and RECC_PMNT_EXPIRY
+      #
+      def update_recurring(params = {})
+        params = params.reverse_merge(
+          :command => :p,
+          :amount => 0,
+          :currency => default_currency,
+          :msg_type => 'SMS',
+          :msg_type => 'AUTH',
+          :perspayee_gen => 1,
+          :perspayee_overwrite => 1
+        )
+        lookup_currency(params)
+        requires!(params, :currency, :client_ip_addr, :description, :biller_client_id, :perspayee_expiry)
+        commit(params)
+      end
+
       # Close business day.
       def close_day
         commit({ :command => :b })
@@ -139,12 +280,18 @@ module ActiveMerchant #:nodoc:
         test? ? test_url : live_url
       end
 
-      def redirect_url
-        test? ? test_redirect_url : live_redirect_url
+      def redirect_url(trans_id = nil)
+        url = test? ? test_redirect_url : live_redirect_url
+        url += "?trans_id=#{CGI.escape trans_id}" if trans_id
+        url
       end
 
       private
 
+      def lookup_currency(params)
+        params[:currency] = CURRENCY_CODES[params[:currency]] || params[:currency]
+      end
+
       # Convert HTTP response body to a Ruby Hash.
       def parse(body)
         results = ActiveSupport::HashWithIndifferentAccess.new
@@ -157,7 +304,9 @@ module ActiveMerchant #:nodoc:
 
       def commit(params = {})
         response = parse(ssl_post(endpoint_url, post_data(params)))
-        raise response[:error] unless response[:error].blank?
+        # FIXME: test cases 17 and 19 return unnecessary error even when result and result_code are present
+        # should be removed when this issue is fixed on gataway side
+        raise Error.new(response) if !response[:error].blank? && response[:result_code].blank?
         response
       end
 

metadata

@@ -1,73 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: active_merchant_first_data
 version: !ruby/object:Gem::Version
-  version: 1.0.0
   prerelease: 
+  version: 1.1.0
 platform: ruby
 authors:
 - Edgars Beigarts
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-08 00:00:00.000000000 +03:00
-default_executable: 
+date: 2013-02-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: activemerchant
-  requirement: &2152366380 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.15.0
     none: false
+  prerelease: false
+  name: activemerchant
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.15.0
+    none: false
   type: :runtime
-  prerelease: false
-  version_requirements: *2152366380
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &2152366000 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
     none: false
+  prerelease: false
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
   type: :development
-  prerelease: false
-  version_requirements: *2152366000
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &2152365440 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.10'
     none: false
+  prerelease: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.6.0
+        version: '2.10'
+    none: false
   type: :development
-  prerelease: false
-  version_requirements: *2152365440
 - !ruby/object:Gem::Dependency
-  name: vcr
-  requirement: &2152365020 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.11'
     none: false
+  prerelease: false
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.11'
+    none: false
   type: :development
-  prerelease: false
-  version_requirements: *2152365020
 - !ruby/object:Gem::Dependency
-  name: fakeweb
-  requirement: &2152364560 !ruby/object:Gem::Requirement
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
     none: false
+  prerelease: false
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.3'
+    none: false
   type: :development
-  prerelease: false
-  version_requirements: *2152364560
-description: First Data gateway for Active Merchant
+description: First Data Latvia gateway for Active Merchant
 email:
 - edgars.beigarts@makit.lv
 executables: []
@@ -78,7 +102,6 @@ files:
 - lib/active_merchant_first_data.rb
 - README.md
 - LICENSE
-has_rdoc: true
 homepage: https://github.com/ebeigarts/active_merchant_first_data
 licenses: []
 post_install_message: 
@@ -86,21 +109,27 @@ rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+      segments:
+      - 0
+      hash: 4550487914721957976
   none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 4550487914721957976
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
-summary: First Data gateway for Active Merchant
+summary: First Data Latvia gateway for Active Merchant
 test_files: []