tlconnor-activemerchant 1.20.4 → 1.23.0

data/lib/active_merchant/billing/integrations/robokassa/common.rb

@@ -0,0 +1,19 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Robokassa
+        module Common
+          def generate_signature_string
+            custom_param_keys = params.keys.select {|key| key =~ /^shp/}.sort
+            custom_params = custom_param_keys.map {|key| "#{key}=#{params[key]}"}
+            [main_params, secret, custom_params].flatten.compact.join(':')
+          end
+
+          def generate_signature
+            Digest::MD5.hexdigest(generate_signature_string)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/robokassa/helper.rb

@@ -0,0 +1,50 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Robokassa
+        class Helper < ActiveMerchant::Billing::Integrations::Helper
+          include Common
+
+          def initialize(order, account, options = {})
+            @md5secret = options.delete(:secret)
+            super
+          end
+
+          def form_fields
+            @fields.merge(ActiveMerchant::Billing::Integrations::Robokassa.signature_parameter_name => generate_signature)
+          end
+
+          def main_params
+            [:account, :amount, :order].map {|key| @fields[mappings[key]]}
+          end
+
+          def params
+            @fields
+          end
+
+          def secret
+            @md5secret
+          end
+
+          def method_missing(method_id, *args)
+            method_id = method_id.to_s.gsub(/=$/, '')
+
+            # support for robokassa custom parameters
+            if method_id =~ /^shp/
+              add_field method_id, args.last
+            end
+
+            super
+          end
+
+          mapping :account, 'MrchLogin'
+          mapping :amount, 'OutSum'
+          mapping :currency, 'IncCurrLabel'
+          mapping :order, 'InvId'
+          mapping :description, 'Desc'
+          mapping :email, 'Email'
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/robokassa/notification.rb

@@ -0,0 +1,55 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Robokassa
+        class Notification < ActiveMerchant::Billing::Integrations::Notification
+          include Common
+
+          def self.recognizes?(params)
+            params.has_key?('InvId') && params.has_key?('OutSum')
+          end
+
+          def complete?
+            true
+          end
+
+          def amount
+            BigDecimal.new(gross)
+          end
+
+          def item_id
+            params['InvId']
+          end
+
+          def security_key
+            params[ActiveMerchant::Billing::Integrations::Robokassa.signature_parameter_name].to_s.downcase
+          end
+
+          def gross
+            params['OutSum']
+          end
+
+          def status
+            'success'
+          end
+
+          def secret
+            @options[:secret]
+          end
+
+          def main_params
+            [gross, item_id]
+          end
+
+          def acknowledge
+            security_key == generate_signature
+          end
+
+          def success_response(*args)
+            "OK#{item_id}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/robokassa/return.rb

@@ -0,0 +1,17 @@
+module ActiveMerchant #:nodoc:
+  module Billing #:nodoc:
+    module Integrations #:nodoc:
+      module Robokassa
+        class Return < ActiveMerchant::Billing::Integrations::Return
+          def item_id
+            @params['InvId']
+          end
+
+          def amount
+            @params['OutSum']
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/integrations/two_checkout.rb

@@ -6,9 +6,31 @@ module ActiveMerchant #:nodoc:
         autoload 'Return', File.dirname(__FILE__) + '/two_checkout/return'
         autoload 'Notification', File.dirname(__FILE__) + '/two_checkout/notification'
        
-        mattr_accessor :service_url
-        self.service_url = 'https://www.2checkout.com/checkout/purchase'
-
+        mattr_accessor :payment_routine
+        self.payment_routine = :single_page
+        
+        def self.service_url
+          case self.payment_routine
+          when :multi_page
+            'https://www.2checkout.com/checkout/purchase'  
+          when :single_page
+            'https://www.2checkout.com/checkout/spurchase'
+          else
+            raise StandardError, "Integration payment routine set to an invalid value: #{self.payment_routine}"
+          end
+        end
+        
+        def self.service_url=(service_url)
+          # Note: do not use this method, it is here for backward compatibility
+          # Use the payment_routine method to change service_url
+          if service_url =~ /spurchase/
+            self.payment_routine = :single_page
+          else
+            self.payment_routine = :multi_page
+          end
+        end
+        
+        
         def self.notification(post, options = {})
           Notification.new(post)
         end  

data/lib/active_merchant/billing/integrations/two_checkout/helper.rb

@@ -6,52 +6,84 @@ module ActiveMerchant #:nodoc:
           def initialize(order, account, options = {})
             super
             add_field('fixed', 'Y')
-            
+
             if ActiveMerchant::Billing::Base.integration_mode == :test || options[:test]
               add_field('demo', 'Y')
-            end 
+            end
           end
-          
+
           # The 2checkout vendor account number
           mapping :account, 'sid'
-          
-          # he total amount to be billed, in decimal form, without a currency symbol. (8 characters, decimal, 2 characters: Example: 99999999.99)
+
+          # The total amount to be billed, in decimal form, without a currency symbol. (8 characters, decimal, 2 characters: Example: 99999999.99)
           mapping :amount, 'total'
-        
-          # a unique order id from your program. (128 characters max)
+
+          # Pass your order id if you are using Third Part Cart Parameters. (128 characters max)
           mapping :order, 'cart_order_id'
 
+          # Pass your order id if you are using the Pass Through Products Parameters.  (50 characters max)
+          mapping :invoice, 'merchant_order_id'
+
+          # Left here for backward compatibility, do not use. The line_item method will add automatically.
+          mapping :mode, 'mode'
 
           mapping :customer, :email      => 'email',
-                             :phone      => 'phone'
+                  :phone      => 'phone'
 
           mapping :billing_address, :city     => 'city',
-                                    :address1 => 'street_address',
-                                    :address2 => 'street_address2',
-                                    :state    => 'state',
-                                    :zip      => 'zip',
-                                    :country  => 'country'
-          
+                  :address1 => 'street_address',
+                  :address2 => 'street_address2',
+                  :state    => 'state',
+                  :zip      => 'zip',
+                  :country  => 'country'
+
           mapping :shipping_address, :city     => 'ship_city',
-                                     :address1 => 'ship_street_address',
-                                     :state    => 'ship_state',
-                                     :zip      => 'ship_zip',
-                                     :country  => 'ship_country'
-          
-          mapping :invoice, 'merchant_order_id'
-          
+                  :address1 => 'ship_street_address',
+                  :state    => 'ship_state',
+                  :zip      => 'ship_zip',
+                  :country  => 'ship_country'
+
           # Does nothing, since we've disabled the Continue Shopping button by using the fixed = Y field
           mapping :return_url, 'return_url'
-          
-          #mapping :description, ''
-          #mapping :tax, ''
-          #mapping :shipping, ''
-          
+
+          # Approved URL path
+          mapping :notification_url, 'x_receipt_link_url'
+
           def customer(params = {})
             add_field(mappings[:customer][:email], params[:email])
             add_field(mappings[:customer][:phone], params[:phone])
             add_field('card_holder_name', "#{params[:first_name]} #{params[:last_name]}")
           end
+
+          # Uses Pass Through Product Parameters to pass in lineitems.
+          # (must mark tanigble sales as shipped to settle the transaction)
+          def line_item(params = {})
+            add_field('mode', '2CO')
+            (max_existing_line_item_id = form_fields.keys.map do |key|
+              i = key.to_s[/^li_(\d+)_/, 1]
+              (i && i.to_i)
+            end.compact.max || 0)
+
+            line_item_id = max_existing_line_item_id + 1
+            params.each do |key, value|
+              add_field("li_#{line_item_id}_#{key}", value)
+            end
+          end
+
+          # Uses Third Party Cart parameter set to pass in lineitem details.
+          # (sales settle automatically)
+          def auto_settle(params = {})
+            add_field('id_type', '1')
+            (max_existing_line_item_id = form_fields.keys.map do |key|
+              i = key.to_s[/^c_prod_(\d+)/, 1]
+              (i && i.to_i)
+            end.compact.max || 0)
+
+            line_item_id = max_existing_line_item_id + 1
+            params.each do |key, value|
+              add_field("c_#{key}_#{line_item_id}", value)
+            end
+          end
         end
       end
     end

data/lib/active_merchant/billing/integrations/two_checkout/notification.rb

@@ -7,44 +7,65 @@ module ActiveMerchant #:nodoc:
     module Integrations #:nodoc:
       module TwoCheckout
         class Notification < ActiveMerchant::Billing::Integrations::Notification
-        #  order_number	2Checkout.com order number
-        #   	card_holder_name	Card holder's name
-        #   	street_address	Card holder's address
-        #   	city	Card holder's city
-        #   	state	Card holder's state
-        #   	zip	Card holder's zip
-        #   	country	Card holder's country
-        #   	email	Card holder's email
-        #   	phone	Card holder's phone
-        #   	credit_card_processed	Y if successful, K if waiting for approval
-        #   	total	 Total purchase amount
-        #   	ship_name	Shipping information
-        #   	ship_street_address	Shipping information
-        #   	ship_city	Shipping information
-        #   	ship_state	Shipping information
-        #   	ship_zip	 Shipping information
-        #   	ship_country	Shipping information
-        #   	product_id	2Checkout product ID for purchased items will append a number if more than one item. 
-        #  ex. product_id,product_id1,product_id2
-        #   	quantity	quantity of corresponding product will append a number if more than one item.
-        #  ex. quantity,quantity1,quantity2
-        #   	merchant_product_id	 your product ID for purchased items will append a number if more than one item.
-        #  ex. merchant_product_id,merchant_product_id1,merchant_product_id2
-        #   	product_description	your description for purchased items will append a number if more than one item.
-        #  ex. product_description,product_description1,product_description2
-          
+          # card_holder_name - Provides the customer’s name.
+          # city - Provides the customer’s city.
+          # country - Provides the customer’s country.
+          # credit_card_processed - This parameter will always be passed back as Y.
+          # demo - Defines if an order was live, or if the order was a demo order. If the order was a demo, the MD5 hash will fail.
+          # email - Provides the email address the customer provided when placing the order.
+          # fixed - This parameter will only be passed back if it was passed into the purchase routine.
+          # ip_country - Provides the customer’s IP location.
+          # key - An MD5 hash used to confirm the validity of a sale.
+          # lang - Customer language
+          # merchant_order_id - The order ID you had assigned to the order.
+          # order_number - The 2Checkout order number associated with the order.
+          # invoice_id - The 2Checkout invoice number.
+          # pay_method - Provides seller with the customer’s payment method. CC for Credit Card, PPI for PayPal.
+          # phone - Provides the phone number the customer provided when placing the order.
+          # ship_name - Provides the ship to name for the order.
+          # ship_street_address - Provides ship to address.
+          # ship_street_address2 - Provides more detailed shipping address if this information was provided by the customer.
+          # ship_city - Provides ship to city.
+          # ship_state - Provides ship to state.
+          # ship_zip - Ship Zip
+
+          # Pass Through Products Only
+          # li_#_name - Name of the corresponding lineitem.
+          # li_#_quantity - Quantity of the corresponding lineitem.
+          # li_#_price - Price of the corresponding lineitem.
+          # li_#_tangible - Specifies if the corresponding li_#_type is a tangible or intangible. ‘Y’ OR ‘N’
+          # li_#_product_id - ID of the corresponding lineitem.
+          # li_#_product_description - Description of the corresponding lineitem.
+          # li_#_recurrence - # WEEK | MONTH | YEAR – always singular.
+          # li_#_duration - Forever or # WEEK | MONTH | YEAR – always singular, defaults to Forever.
+          # li_#_startup_fee - Amount in account pricing currency.
+          # li_#_option_#_name - Name of option. 64 characters max – cannot include '<' or '>'.
+          # li_#_option_#_value - Name of option. 64 characters max – cannot include '<' or '>'.
+          # li_#_option_#_surcharge - Amount in account pricing currency.
+
+          #Third Party Cart Only
+          # cart_order_id - The order ID you had assigned to the order.
+
+          # Allow seller to define default currency (should match 2Checkout account pricing currency)
           def currency
-            'USD'
+              'USD'
           end
-          
+
           def complete?
             status == 'Completed'
-          end 
+          end
 
+          # Third Party Cart parameters will return 'card_order_id'
+          # Pass Through Product parameters will only return 'merchant_order_id'
           def item_id
-            params['cart_order_id']
+            if (params['cart_order_id'].nil?)
+              params['merchant_order_id']
+            else
+              params['cart_order_id']
+            end
           end
 
+          # 2Checkout Sale ID
           def transaction_id
             params['order_number']
           end
@@ -53,60 +74,64 @@ module ActiveMerchant #:nodoc:
             params['']
           end
 
+          #Customer Email
           def payer_email
             params['email']
           end
-         
+
           def receiver_email
             params['']
-          end 
+          end
 
           # The MD5 Hash
           def security_key
             params['key']
           end
 
-          # the money amount we received in X.2 decimal.
+          # The money amount we received in X.2 decimal.
           def gross
             params['total']
           end
 
           # Was this a test transaction? # Use the hash
+          # Please note 2Checkout forces the order number computed in the hash to '1' on demo sales.
           def test?
             params['demo'] == 'Y'
           end
 
+          # 2Checkout only returns 'Y' for this parameter. If the sale is not authorized, no passback occurs.
           def status
             case params['credit_card_processed']
-            when 'Y'
-              'Completed'
-            when 'K'
-              'Pending'
-            else
-              'Failed'
+              when 'Y'
+                'Completed'
+              else
+                'Failed'
             end
           end
-          
+
+          # Secret Word defined in 2Checkout account
           def secret
             @options[:credential2]
           end
-          
+
+          # Checks against MD5 Hash
           def acknowledge
             return false if security_key.blank?
-            
+
             Digest::MD5.hexdigest("#{secret}#{params['sid']}#{transaction_id}#{gross}").upcase == security_key.upcase
           end
-          
+
           private
-          
+
+          # Parses Header Redirect Query String
           def parse(post)
             @raw = post.to_s
-            for line in @raw.split('&')    
+            for line in @raw.split('&')
               key, value = *line.scan( %r{^(\w+)\=(.*)$} ).flatten
               params[key] = CGI.unescape(value || '')
             end
           end
-          
+
         end
       end
     end