activemerchant-paymentech-orbital 0.1.0

data/lib/active_merchant/billing/paymentech_orbital/request/profile_management.rb

@@ -0,0 +1,82 @@
+module ActiveMerchant
+  module Billing
+    module PaymentechOrbital
+      module Request
+        class ProfileManagement < PaymentechOrbital::Request::Base
+          attr_accessor :action, :credit_card
+
+          cattr_accessor :action_map
+          self.action_map = {
+            "create"   => "C",
+            "retrieve" => "R",
+            "update"   => "U",
+            "delete"   => "D"
+          }
+
+          def initialize(action, credit_card=nil, options={})
+            @action = action.to_s
+            @credit_card = credit_card
+            super(options)
+          end
+
+          def request_type; "Profile"; end
+
+          private
+          def customer_profile_action
+            self.class.action_map[action.downcase.to_s]
+          end
+
+          def writing?
+            ["create", "update"].include?(action)
+          end
+
+          def request_body(xml)
+            add_meta_info(xml)
+            add_profile_info(xml)
+
+            xml.tag! "CustomerProfileAction", customer_profile_action
+
+            add_customer_profile_management_options(xml)
+            add_account_info(xml) if writing?
+            add_credit_card_info(xml) if writing? && credit_card
+          end
+
+          def add_meta_info(xml)
+            xml.tag! "CustomerBin", bin
+            xml.tag! "CustomerMerchantID", merchant_id
+          end
+
+          def add_profile_info(xml)
+            xml.tag! "CustomerName", address[:name]
+            xml.tag! "CustomerRefNum", customer_ref_num if customer_ref_num
+            xml.tag! "CustomerAddress1", address[:address1]
+            xml.tag! "CustomerAddress2", address[:address]
+            xml.tag! "CustomerCity", address[:city]
+            xml.tag! "CustomerState", address[:state]
+            xml.tag! "CustomerZIP", address[:zip]
+            xml.tag! "CustomerEmail", address[:email]
+            xml.tag! "CustomerPhone", address[:phone]
+            xml.tag! "CustomerCountryCode", address[:country]
+          end
+
+          def add_customer_profile_management_options(xml)
+            unless customer_ref_num
+              xml.tag! "CustomerProfileOrderOverrideInd", "NO"
+              xml.tag! "CustomerProfileFromOrderInd", "A"
+            end
+          end
+
+          def add_account_info(xml)
+            xml.tag! "CustomerAccountType", "CC"
+            xml.tag! "Status", options[:status] || "A"
+          end
+
+          def add_credit_card_info(xml)
+            xml.tag! "CCAccountNum", credit_card.number
+            xml.tag! "CCExpireDate", "#{credit_card.month}#{credit_card.year}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/paymentech_orbital/request/void.rb

@@ -0,0 +1,39 @@
+module ActiveMerchant
+  module Billing
+    module PaymentechOrbital
+      module Request
+        class Void < PaymentechOrbital::Request::Base
+          attr_reader :tx_ref_num, :tx_ref_idx, :money
+
+          def initialize(tx_ref_num, tx_ref_idx, money=nil, options={})
+            @tx_ref_num = tx_ref_num
+            @tx_ref_idx = tx_ref_idx
+            @money = money
+            super(options)
+          end
+
+          def request_type; "Reversal"; end
+
+          private
+          def request_body(xml)
+            add_transaction_info(xml)
+            xml.tag! "AdjustedAmt", money if money
+            add_meta_info(xml)
+          end
+
+          def add_transaction_info(xml)
+            xml.tag! "TxRefNum", tx_ref_num
+            xml.tag! "TxRefIdx", tx_ref_idx
+          end
+
+          def add_meta_info(xml)
+            xml.tag! "OrderID", order_id
+            xml.tag! "BIN", bin
+            xml.tag! "MerchantID", merchant_id
+            xml.tag! "TerminalID", terminal_id
+          end
+        end
+      end
+    end
+  end
+end

data/lib/active_merchant/billing/paymentech_orbital/response.rb

@@ -0,0 +1,100 @@
+module ActiveMerchant
+  module Billing
+    module PaymentechOrbital
+      class Response
+        cattr_accessor :elements
+        attr_reader :doc, :request_type
+
+        self.elements = [ 
+          :industry_type, :message_type, :merchant_id,
+          :terminal_id, :card_brand, :account_num, 
+          :order_id, :tx_ref_num, :tx_ref_idx, :proc_status,
+          :approval_status, :resp_code, :avs_resp_code,
+          :cvv2_resp_code, :auth_code, :status_msg, :resp_msg,
+          :customer_ref_num, :customer_name, :profile_proc_status,
+          :customer_profile_message, :resp_time, :batch_seq_num,
+          :CCAccountNum, :customer_address_1, :customer_address_2,
+          :customer_city, :CustomerZIP, :customer_state,
+          :CCExpireDate
+        ]
+
+        def initialize(doc, request_type, options={})
+          @doc = REXML::Document.new(doc)
+          @request_type = request_type
+          @options = options
+        end
+
+        def success?
+          case request_type
+          when "NewOrder"
+            proc_success? && approved?
+          when "Profile"
+            profile_proc_success?
+          when "Reversal", "EndOfDay"
+            proc_success?
+          else
+            false
+          end
+        end
+
+        def proc_success?
+          proc_status == "0"
+        end
+
+        def profile_proc_success?
+          profile_proc_status == "0"
+        end
+
+        def approved?
+          approval_status == "1"
+        end
+
+        def authorization
+          approval_status
+        end
+
+        def test?
+          @options[:test] || false
+        end
+
+        def avs_result
+          @avs_result ||= AVSResult.new({:code => avs_resp_code})
+        end
+
+        def cvv_result
+          @cvv_result ||= CVVResult.new({:code => cvv2_result_code})
+        end
+
+        def to_xml
+          unless @_xml
+            @_xml = ""
+            doc.write(@_xml, 2)
+          end
+          @_xml
+        end
+
+        private
+        def tagify(s)
+          s.to_s.gsub(/\/(.?)/) { 
+            "::#{$1.upcase}" 
+          }.gsub(/(?:^|_)(.)/) { 
+            $1.upcase 
+          }
+        end
+
+        def value_at(sym)
+          node = REXML::XPath.first(@doc, "//#{tagify(sym)}")
+          node ? node.text : nil
+        end
+
+        def method_missing(sym, *args, &blk)
+          if self.class.elements.include?(sym)
+            value_at(sym)
+          else
+            super(sym, *args, &blk)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/activemerchant-paymentech-orbital.rb

@@ -0,0 +1,9 @@
+require 'active_merchant'
+
+require 'active_merchant/billing/paymentech_orbital'
+require 'active_merchant/billing/paymentech_orbital/request'
+require 'active_merchant/billing/paymentech_orbital/request/end_of_day'
+require 'active_merchant/billing/paymentech_orbital/request/new_order'
+require 'active_merchant/billing/paymentech_orbital/request/profile_management'
+require 'active_merchant/billing/paymentech_orbital/request/void'
+require 'active_merchant/billing/paymentech_orbital/response'

data/test/activemerchant-paymentech-orbital_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class ActivemerchantPaymentechOrbitalTest < Test::Unit::TestCase
+  def test_something_for_real
+    assert true
+  end
+end

data/test/factories.rb

@@ -0,0 +1,170 @@
+Factory.define :credit_card, {
+  :class => ActiveMerchant::Billing::CreditCard,
+  :default_strategy => :build
+} do |f|
+  f.number "4242424242424242"
+  f.month 9
+  f.year Time.now.year + 1
+  f.first_name 'Joe'
+  f.last_name 'Smith'
+  f.verification_value '123'
+  f.add_attribute :type, 'visa'
+end
+
+# Option factories
+Options.define(:billing_address, :defaults => {
+  :zip => "12345",
+  :address1 => "123 Happy Place",
+  :address2 => "Apt 1",
+  :city => "SuperVille",
+  :state => "NY",
+  :name => "Joe Smith",
+  :country => "US"
+})
+Options.define(:gateway_auth, :defaults => {
+  :login       => "user",
+  :password    => "mytestpass",
+  :merchant_id => "1",
+  :bin         => "1", 
+  :terminal_id => "1"
+})
+Options.define(:soft_descriptors, :defaults => {
+  :merchant_name => 'merchant',
+  :merchant_url => 'mmmerchant.com'
+})
+
+# Request options:
+Options.define(:request_options, :parent => :gateway_auth)
+Options.define(:end_of_day_options, :parent => :request_options)
+Options.define(:new_order_options, :parent => [
+  :request_options, :billing_address, :soft_descriptors
+], :defaults => {
+  :currency_code => "840",
+  :currency_exponent => "2",
+  :order_id => "1",
+  :recurring_frequency => "#{Date.today.strftime("%d")} * ?"
+})
+Options.define(:profile_management_options, :parent => [
+  :request_options, :billing_address
+], :defaults => {
+  :customer_ref_num => "123456"
+})
+Options.define(:void_options, :parent => :request_options, :defaults => {
+  :tx_ref_num => "1", 
+  :tx_ref_idx => "1",
+  :order_id => "1"
+})
+
+# Pseudo factories
+def gateway(options={})
+  ActiveMerchant::Billing::PaymentechOrbital::Gateway.new(Options(:gateway_auth, options))
+end
+
+def base_request(options={})
+  ActiveMerchant::Billing::PaymentechOrbital::Request::Base.new(
+    Options(:request_options, options)
+  )
+end
+
+def end_of_day_request(options={})
+  ActiveMerchant::Billing::PaymentechOrbital::Request::EndOfDay.new(
+    Options(:end_of_day_options, options)
+  )
+end
+
+def new_order_request(options={})
+  ActiveMerchant::Billing::PaymentechOrbital::Request::NewOrder.new(
+    "AC", 100, Factory(:credit_card), Options(:new_order_options, options)
+  )
+end
+
+def profile_management_request(action=:create, credit_card=Factory(:credit_card), options={})
+  ActiveMerchant::Billing::PaymentechOrbital::Request::ProfileManagement.new(
+    action, credit_card, Options(:profile_management_options, options)
+  )
+end
+
+def void_request(tx_ref_num="12345", tx_ref_idx="1", money="100", options={})
+  ActiveMerchant::Billing::PaymentechOrbital::Request::Void.new(
+    tx_ref_num, tx_ref_idx, money, Options(:void_options, options)
+  )
+end
+
+def new_order_response(doc=new_order_response_success, request_type="NewOrder", options={})
+  ActiveMerchant::Billing::PaymentechOrbital::Response.new(doc, request_type, options)
+end
+
+def new_order_response_success
+  <<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<Response>
+<NewOrderResp>
+  <IndustryType/>
+  <MessageType>AC</MessageType>
+  <MerchantID>000000</MerchantID>
+  <TerminalID>000</TerminalID>
+  <CardBrand>MC</CardBrand>
+  <AccountNum>5454545454545454</AccountNum>
+  <OrderID>1</OrderID>
+  <TxRefNum>4A785F5106CCDC41A936BFF628BF73036FEC5401</TxRefNum>
+  <TxRefIdx>1</TxRefIdx>
+  <ProcStatus>0</ProcStatus>
+  <ApprovalStatus>1</ApprovalStatus>
+  <RespCode>00</RespCode>
+  <AVSRespCode>B </AVSRespCode>
+  <CVV2RespCode>M</CVV2RespCode>
+  <AuthCode>tst554</AuthCode>
+  <RecurringAdviceCd/>
+  <CAVVRespCode/>
+  <StatusMsg>Approved</StatusMsg>
+  <RespMsg/>
+  <HostRespCode>100</HostRespCode>
+  <HostAVSRespCode>I3</HostAVSRespCode>
+  <HostCVV2RespCode>M</HostCVV2RespCode>
+  <CustomerRefNum>2145108</CustomerRefNum>
+  <CustomerName>JOE SMITH</CustomerName>
+  <ProfileProcStatus>0</ProfileProcStatus>
+  <CustomerProfileMessage>Profile Created</CustomerProfileMessage>
+  <RespTime>121825</RespTime>
+</NewOrderResp>
+</Response>
+  RESPONSE
+end
+
+def new_order_response_failure
+  <<-RESPONSE
+<?xml version="1.0" encoding="UTF-8"?>
+<Response>
+<QuickResp>
+  <ProcStatus>841</ProcStatus>
+  <StatusMsg>Error validating card/account number range</StatusMsg>
+  <CustomerBin></CustomerBin>
+  <CustomerMerchantID></CustomerMerchantID>
+  <CustomerName></CustomerName>
+  <CustomerRefNum></CustomerRefNum>
+  <CustomerProfileAction></CustomerProfileAction>
+  <ProfileProcStatus>9576</ProfileProcStatus>
+  <CustomerProfileMessage>Profile: Unable to Perform Profile Transaction. The Associated Transaction Failed. </CustomerProfileMessage>
+  <CustomerAddress1></CustomerAddress1>
+  <CustomerAddress2></CustomerAddress2>
+  <CustomerCity></CustomerCity>
+  <CustomerState></CustomerState>
+  <CustomerZIP></CustomerZIP>
+  <CustomerEmail></CustomerEmail>
+  <CustomerPhone></CustomerPhone>
+  <CustomerProfileOrderOverrideInd></CustomerProfileOrderOverrideInd>
+  <OrderDefaultDescription></OrderDefaultDescription>
+  <OrderDefaultAmount></OrderDefaultAmount>
+  <CustomerAccountType></CustomerAccountType>
+  <CCAccountNum></CCAccountNum>
+  <CCExpireDate></CCExpireDate>
+  <ECPAccountDDA></ECPAccountDDA>
+  <ECPAccountType></ECPAccountType>
+  <ECPAccountRT></ECPAccountRT>
+  <ECPBankPmtDlv></ECPBankPmtDlv>
+  <SwitchSoloStartDate></SwitchSoloStartDate>
+  <SwitchSoloIssueNum></SwitchSoloIssueNum>
+</QuickResp>
+</Response>
+  RESPONSE
+end

data/test/mocks/active_merchant/billing/gateway.rb

@@ -0,0 +1,9 @@
+module ActiveMerchant #:nodoc:
+  module Billing
+    class Gateway
+      def ssl_request(*args)
+        "<xml></xml>"
+      end
+    end
+  end
+end

data/test/options.rb

@@ -0,0 +1,85 @@
+# Simple stupid factory girl inspired way to easily setup
+# option hashes across the tests. 
+# 
+# Setup like:
+# 
+# Options.define(:address, :defaults => {
+#   :street => "1234 somewhere lane",
+#   :city   => "right here town",
+#   :zip    => "12345"
+# })
+# 
+# Use like:
+# 
+# Options(:address)
+# 
+# Over ride defaults like:
+# 
+# Options(:address, :street => "4321 somewhere else")
+# 
+# Provide nil to remove an option:
+# 
+# Options(:address, :street => nil) => {:city => "right here town", :zip => "12345"}
+# 
+# Option hashes can have parent hashes:
+# 
+# Options.define(:new_address, {
+#   :parent => :address,
+#   :defaults => {
+#     :street => "4321 somewhere else",
+#     :apartment => "3"
+#   }
+# })
+# Options(:new_address) => {
+#   :street => "4321 somewhere else", :apartment => "3", :city => "right here town", :zip => "12345"
+# }
+# 
+# Multiple parents can be combined:
+# 
+# Options.define(:name, :defaults => {
+#   :first_name => "joe", 
+#   :last_name => "smith"
+# })
+# 
+# Options.define(:full_address, :parent => [ :name, :address ], :defaults => {
+#   :phone_number => "5555555555"
+# })
+# 
+# Options(:full_address) => {
+#   :street=>"1234 somewhere lane", :zip=>"12345", :city=>"right here town", 
+#   :first_name=>"joe", :phone_number=>"5555555555", :last_name=>"smith"
+# }
+# 
+class Options
+  class << self
+    def define(name, options={})
+      self[name] = (self[options[:parent]] || {}).merge(options[:defaults] || {})
+    end
+
+    def [](k)
+      return {} if k.nil?
+
+      if k.is_a?(Array)
+        Hash[*k.map { |default| 
+          self[default].map { |k,v| 
+            [k,v] 
+          } 
+        }.flatten]
+      else
+        factories[k.to_sym]
+      end
+    end
+
+    def []=(k,v)
+      factories[k.to_sym] = v
+    end
+
+    def factories
+      @@_factories ||= {}
+    end
+  end
+end
+
+def Options(name, options={})
+  Options[name].merge(options).delete_if { |k,v| v.nil? }
+end