global_collect 0.1.0

data/lib/global_collect/request_models/base.rb

@@ -0,0 +1,37 @@
+module GlobalCollect::RequestModels
+  class Base
+    attr_accessor :errors
+    def suggested_response_mixins
+      []
+    end
+    
+    def fields
+      {}
+    end
+    
+    def initialize(attributes)
+      @attributes = {}
+      attributes.each {|k,v| self[k] = v }
+    end
+    
+    def validate
+      fields.each do |field, validations|
+        validator = GlobalCollect::FieldValidator.new(*validations)
+        unless validator.validate(@attributes[field])
+          @errors = { field => "is invalid. Should conform to #{validations.inspect}" }
+        end
+      end
+      return @errors.blank?
+    end
+    
+    def [](key)
+      raise ArgumentError.new("Invalid attribute name '#{key}'!") unless fields.key?(key)
+      @attributes[key]
+    end
+    
+    def []=(key, value)
+      raise ArgumentError.new("Invalid attribute name '#{key}'!") unless fields.key?(key)
+      @attributes[key] = value
+    end
+  end
+end

data/lib/global_collect/request_models/do_refund/credit_card_payment.rb

@@ -0,0 +1,12 @@
+module GlobalCollect::RequestModels::DoRefund
+  class CreditCardPayment < Payment
+    # WDL §5.16.1 specifies the full list of possible fields
+    def fields
+      super.merge({
+        "PAYMENTPRODUCTID" => ["N5",  "O"],
+        "CREDITCARDNUMBER" => ["N19", "O"],
+        "EXPIRYDATE"       => ["N4",  "O"]
+      })
+    end
+  end
+end

data/lib/global_collect/request_models/do_refund/payment.rb

@@ -0,0 +1,39 @@
+module GlobalCollect::RequestModels::DoRefund
+  class Payment < GlobalCollect::RequestModels::Base
+    def suggested_response_mixins
+      [
+        GlobalCollect::Responses::SuccessRow,
+        GlobalCollect::Responses::DoRefund::ResponseMethods
+      ]
+    end
+    
+    # WDL §5.16.1 specifies the full list of possible fields
+    def fields
+      super.merge({
+        "ORDERID"               => ["N10",  "R"],
+        "EFFORTID"              => ["N5",   "O"],
+        "MERCHANTREFERENCE"     => ["AN30", "R"],
+        "REFERENCEORIGPAYMENT"  => ["AN30", "O"],
+        "CURRENCYCODE"          => ["AN3",  "O"],
+        "AMOUNT"                => ["N12",  "O"],
+        "COUNTRYCODE"           => ["AN2",  "O"],
+        "REFUNDDATE"            => ["D",    "O"],
+        "SURNAME"               => ["AN35", "O"],
+        "FIRSTNAME"             => ["AN15", "O"],
+        "PREFIXSURNAME"         => ["AN15", "O"],
+        "TITLE"                 => ["AN35", "O"],
+        "COMPANYNAME"           => ["AN40", "O"],
+        "COMPANYDATA"           => ["AN50", "O"],
+        "STREET"                => ["AN50", "O"],
+        "HOUSENUMBER"           => ["AN15", "O"],
+        "ADDITIONALADDRESSINFO" => ["AN50", "O"],
+        "ZIP"                   => ["AN10", "O"],
+        "CITY"                  => ["AN40", "O"],
+        "STATE"                 => ["AN35", "O"],
+        "EMAILADDRESS"          => ["AN70", "O"],
+        "EMAILTYPEINDICATOR"    => ["N1",   "O"]
+      })
+    end
+  end
+end
+

data/lib/global_collect/request_models/insert_order_with_payment/credit_card_online_payment.rb

@@ -0,0 +1,44 @@
+module GlobalCollect::RequestModels::InsertOrderWithPayment
+  class CreditCardOnlinePayment < Payment
+    def suggested_response_mixins
+      [
+        GlobalCollect::Responses::SuccessRow,
+        GlobalCollect::Responses::InsertOrderWithPayment::CreditCardOnlinePaymentResponseMethods
+      ]
+    end
+    # WDL §5.28.1 TABLE 106 specifies the full list of possible fields
+    def fields
+      super.merge({
+        "EXPIRYDATE"              => ['N4',   'R'],
+        "CREDITCARDNUMBER"        => ['N19',  'R'],
+        "ISSUENUMBER"             => ['N2',   'O'],
+        "CVV"                     => ['N4',   'O'],
+        "CVVINDICATOR"            => ['N1',   'O'],
+        "AVSINDICATOR"            => ['N1',   'O'],
+        "AUTHENTICATIONINDICATOR" => ['N1',   'O'],
+        "STTINDICATOR"            => ['N1',   'O'],
+        "FIRSTNAME"               => ['AN15', 'O'],
+        "PREFIXSURNAME"           => ['AN15', 'O'],
+        "SURNAME"                 => ['AN35', 'O'],
+        "STREET"                  => ['AN50', 'O'],
+        "HOUSENUMBER"             => ['AN15', 'O'],
+        "CUSTOMERIPADDRESS"       => ['AN32', 'O'],
+        "ADDITIONALADDRESSINFO"   => ['AN50', 'O'],
+        "ZIP"                     => ['AN10', 'O'],
+        "CITY"                    => ['AN40', 'O'],
+        "STATE"                   => ['AN35', 'O'],
+        "PHONENUMBER"             => ['AN20', 'O'],
+        "EMAIL"                   => ['AN70', 'O'],
+        "BIRTHDATE"               => ['N8',   'O'],
+        "DCCINDICATOR"            => ['N1',   'O'],
+        "ISSUERAMOUNT"            => ['N12',  'O'],
+        "ISSUERCURRENCYCODE"      => ['AN3',  'O'],
+        "MARGINRATEPERCENTAGE"    => ['N6 ',  'O'],
+        "EXCHANGERATESOURCENAME"  => ['AN32', 'O'],
+        "EXCHANGERATE"            => ['N12',  'O'],
+        "EXCHANGERATEVALIDTO"     => ['N14',  'O'],
+        "MAC"                     => ['AN64', 'O']
+      })
+    end
+  end
+end

data/lib/global_collect/request_models/insert_order_with_payment/hosted_credit_card_online_payment.rb

@@ -0,0 +1,19 @@
+module GlobalCollect::RequestModels::InsertOrderWithPayment
+  class HostedCreditCardOnlinePayment < CreditCardOnlinePayment
+    def initialize(attributes)
+      super(attributes)
+      @attributes["HOSTEDINDICATOR"] = "1"
+    end
+    
+    def suggested_response_mixins
+      super + [GlobalCollect::Responses::InsertOrderWithPayment::HostedMerchantLinkPaymentResponseMethods]
+    end
+    
+    def fields
+      super.merge({
+        "EXPIRYDATE"              => ['N4',   'O'],
+        "CREDITCARDNUMBER"        => ['N19',  'O']
+      })
+    end
+  end
+end

data/lib/global_collect/request_models/insert_order_with_payment/order.rb

@@ -0,0 +1,67 @@
+module GlobalCollect::RequestModels::InsertOrderWithPayment
+  class Order < GlobalCollect::RequestModels::Base
+    # WDL §5.28.1 First table specifies the full list of possible fields
+    def fields
+      super.merge({
+        "ORDERID"                        => ["N10"   , "R"],
+        "ORDERTYPE"                      => ["N1"    , "O"],
+        "AMOUNT"                         => ["N12"   , "R"],
+        "AMOUNTSIGN"                     => ["AN1"   , "O"],
+        "CURRENCYCODE"                   => ["AN3"   , "R"],
+        "LANGUAGECODE"                   => ["AN2"   , "R"],
+        "COUNTRYCODE"                    => ["AN2"   , "R"],
+        "OVERWRITEPAYMENTREFERNCE"       => ["AN12"  , "O"],
+        "IPADDRESSCUSTOMER"              => ["AN32"  , "O"],
+        "CUSTOMERID"                     => ["AN15"  , "O"],
+        "MANDATE"                        => ["AN10"  , "O"],
+        "TITLE"                          => ["AN35"  , "O"],
+        "FIRSTNAME"                      => ["AN15"  , "O"],
+        "PREFIXSURNAME"                  => ["AN15"  , "O"],
+        "SURNAME"                        => ["AN35"  , "O"],
+        "STREET"                         => ["AN50"  , "O"],
+        "HOUSENUMBER"                    => ["AN15"  , "O"],
+        "ADDITIONALADDRESSINFO"          => ["AN50"  , "O"],
+        "ZIP"                            => ["AN10"  , "O"],
+        "CITY"                           => ["AN40"  , "O"],
+        "STATE"                          => ["AN35"  , "O"],
+        "SHIPPINGTITLE"                  => ["AN35"  , "O"],
+        "SHIPPINGFIRSTNAME"              => ["AN15"  , "O"],
+        "SHIPPINGPREFIXSURNAME"          => ["AN15"  , "O"],
+        "SHIPPINGSURNAME"                => ["AN35"  , "O"],
+        "SHIPPINGSTREET"                 => ["AN50"  , "O"],
+        "SHIPPINGHOUSENUMBER"            => ["AN15"  , "O"],
+        "SHIPPINGADDITIONALADDRESSINFO"  => ["AN50"  , "O"],
+        "SHIPPINGZIP"                    => ["AN10"  , "O"],
+        "SHIPPINGCITY"                   => ["AN40"  , "O"],
+        "SHIPPINGSTATE"                  => ["AN35"  , "O"],
+        "SHIPPINGCOUNTRYCODE"            => ["AN2"   , "O"],
+        "MERCHANTREFERENCE"              => ["AN30"  , "R"],
+        "DESCRIPTOR"                     => ["AN50"  , "O"],
+        "RESELLERID"                     => ["N10"   , "O"],
+        "EMAIL"                          => ["AN70"  , "O"],
+        "EMAILTYPEINDICATOR"             => ["N1"    , "O"],
+        "COMPANYNAME"                    => ["AN40"  , "O"],
+        "COMPANYDATA"                    => ["AN40"  , "O"],
+        "SEX"                            => ["AN1"   , "O"],
+        "VATNUMBER"                      => ["AN17"  , "O"],
+        "PHONENUMBER"                    => ["AN20"  , "O"],
+        "FAXNUMBER"                      => ["AN20"  , "O"],
+        "INVOICENUMBER"                  => ["AN20"  , "O"],
+        "INVOICETYPE"                    => ["AN2"   , "O"],
+        "INVOICEDATE"                    => ["D"     , "O"],
+        "INVOICECLASS"                   => ["AN10"  , "O"],
+        "ORDERDATE"                      => ["D"     , "O"],
+        "BIRTHDATE"                      => ["N8"    , "O"],
+        "TEXTQUALIFIER1"                 => ["AN10"  , "O"],
+        "TEXTQUALIFIER2"                 => ["AN10"  , "O"],
+        "TEXTQUALIFIER3"                 => ["AN10"  , "O"],
+        "ADDITIONALDATA"                 => ["AN500" , "O"],
+        "STARTDATE"                      => ["N14"   , "O"],
+        "ENDDATE"                        => ["N14"   , "O"],
+        "NUMBEROFPAYMENTS"               => ["N5"    , "O"],
+        "STEPWEEK"                       => ["N5"    , "O"],
+        "STEPMONTH"                      => ["N5"    , "O"]
+      })
+    end
+  end
+end

data/lib/global_collect/request_models/insert_order_with_payment/payment.rb

@@ -0,0 +1,17 @@
+module GlobalCollect::RequestModels::InsertOrderWithPayment
+  class Payment < GlobalCollect::RequestModels::Base
+    # WDL §5.28.1 TABLE 105 specifies the full list of possible fields
+    def fields
+      super.merge({
+        "PAYMENTPRODUCTID" => ["N5"   , "R"],
+        "AMOUNT"           => ["N12"  , "R"],
+        "AMOUNTSIGN"       => ["AN1"  , "O"],
+        "CURRENCYCODE"     => ["AN3"  , "R"],
+        "LANGUAGECODE"     => ["AN2"  , "R"],
+        "COUNTRYCODE"      => ["AN2"  , "R"],
+        "HOSTEDINDICATOR"  => ["N1"   , "O"],
+        "RETURNURL"        => ["AN512", "O"]
+      })
+    end
+  end
+end

data/lib/global_collect/request_models/set_payment/payment.rb

@@ -0,0 +1,17 @@
+module GlobalCollect::RequestModels::SetPayment
+  class Payment < GlobalCollect::RequestModels::Base
+    # WDL §5.33.1 specifies the full list of possible fields
+    def fields
+      super.merge({
+        "ORDERID"          => ["N10", "R"],
+        "EFFORTID"         => ["N5",  "O"],
+        "PAYMENTPRODUCTID" => ["N5",  "R"],
+        "AMOUNT"           => ["N12", "O"],
+        "CURRENCYCODE"     => ["AN3", "O"],
+        "DATECOLLECT"      => ["D8",  "O"]
+      })
+    end
+  end
+end
+
+

data/lib/global_collect/requests/base.rb

@@ -0,0 +1,43 @@
+module GlobalCollect::Requests
+  class Base
+    attr_accessor :action
+    attr_reader :version
+    attr_reader :suggested_response_mixins
+    
+    def initialize(action)
+      @action = action
+      @suggested_response_mixins ||= []
+      @version = GlobalCollect::default_api_version
+    end
+    
+    def version=(v)
+      raise ArgumentError.new("Invalid version identifier!") unless %w[1.0 2.0].include?(v)
+      @version = v
+    end
+    
+    # WDL §3.1
+    def default_xml_encoding_options
+      { :encoding => "UTF-8" }
+    end
+
+    # WDL §4
+    def to_xml
+      xml = Builder::XmlMarkup.new
+      xml.instruct!(:xml, default_xml_encoding_options)
+      xml.tag!("XML") do |xml_node|
+        xml_node.tag!("REQUEST") do |req_node|
+          req_node.tag!("ACTION", @action)
+          req_node.tag!("META") do |meta_node|
+            meta_node.tag!("IPADDRESS" , GlobalCollect::ip_address ) if GlobalCollect::authentication_scheme == :ip_check
+            meta_node.tag!("MERCHANTID", GlobalCollect::merchant_id)
+            meta_node.tag!("VERSION"   , version)
+          end
+          req_node.tag!("PARAMS") do |params_node|
+            yield(params_node)
+          end
+        end
+      end
+      xml.target!
+    end
+  end
+end

data/lib/global_collect/requests/cancel_payment.rb

@@ -0,0 +1,22 @@
+module GlobalCollect::Requests
+  class CancelPayment < GlobalCollect::Requests::Simple
+    # WDL §5.2
+    def initialize(order_id, effort_id, attempt_id)
+      super("CANCEL_PAYMENT", { 
+        "ORDERID"   => order_id,
+        "EFFORTID"  => effort_id,
+        "ATTEMPTID" => attempt_id
+      })
+    end
+    
+    def wrapper; "PAYMENT"; end
+    
+    def fields
+      {
+        "ORDERID"   => ["N10", "R"],
+        "EFFORTID"  => ["N5",  "R"],
+        "ATTEMPTID" => ["N5",  "R"]
+      }
+    end
+  end
+end

data/lib/global_collect/requests/composite.rb

@@ -0,0 +1,23 @@
+module GlobalCollect::Requests
+  class Composite < GlobalCollect::Requests::Base
+    
+    def initialize(action, model_builder_pairs)
+      unless model_builder_pairs.map(&:size).uniq == [2]
+        raise ArgumentError.new("Models and builders must be in array pairs like [[model,builder_class],...]!")
+      end
+      @contents = model_builder_pairs
+      super(action)
+      @suggested_response_mixins = model_builder_pairs.map(&:first).map(&:suggested_response_mixins).flatten.uniq
+    end
+    
+    def to_xml
+      super do |params_node|
+        @contents.each do |model,builder_class|
+          raise "Invalid model #{model.inspect}. Errors: #{model.errors.inspect}!" unless model.validate
+          builder = builder_class.new(model)
+          builder.build(params_node) 
+        end
+      end
+    end
+  end
+end

data/lib/global_collect/requests/convert_amount.rb

@@ -0,0 +1,29 @@
+module GlobalCollect::Requests
+  class ConvertAmount < GlobalCollect::Requests::Simple
+    # WDL §5.7
+    def initialize(amount, source_currency, target_currency)
+      super("CONVERT_AMOUNT", {
+        "AMOUNT"             => amount,
+        "SOURCECURRENCYCODE" => source_currency,
+        "TARGETCURRENCYCODE" => target_currency
+      })
+    end
+    
+    def suggested_response_mixins
+      [
+        GlobalCollect::Responses::SuccessRow,
+        GlobalCollect::Responses::ConvertAmount::ResponseMethods
+      ]
+    end
+    
+    def wrapper; "GENERAL"; end
+    
+    def fields
+      {
+        "AMOUNT"             => ["N12", "R"],
+        "SOURCECURRENCYCODE" => ["AN3", "R"],
+        "TARGETCURRENCYCODE" => ["AN3", "R"]
+      }
+    end
+  end
+end

data/lib/global_collect/requests/do_refund.rb

@@ -0,0 +1,8 @@
+module GlobalCollect::Requests
+  class DoRefund < GlobalCollect::Requests::Composite
+    # WDL §5.16 requires a PAYMENT node
+    def initialize(payment_and_builder)
+      super("DO_REFUND", [payment_and_builder])
+    end
+  end
+end

data/lib/global_collect/requests/get_order_status.rb

@@ -0,0 +1,24 @@
+module GlobalCollect::Requests
+  class GetOrderStatus < GlobalCollect::Requests::Simple
+    # WDL §5.23
+    def initialize(order_id)
+      super("GET_ORDERSTATUS", { "ORDERID" => order_id })
+    end
+    
+    def suggested_response_mixins
+      case self.version
+      when "1.0" then [GlobalCollect::Responses::GetOrderStatus::V1ResponseMethods]
+      when "2.0" then [GlobalCollect::Responses::GetOrderStatus::V2ResponseMethods]
+      else []
+      end
+    end
+    
+    def wrapper; "ORDER"; end
+    
+    def fields
+      {
+        "ORDERID" => ["N10", "R"]
+      }
+    end
+  end
+end

data/lib/global_collect/requests/insert_order_with_payment.rb

@@ -0,0 +1,10 @@
+module GlobalCollect::Requests
+  class InsertOrderWithPayment < GlobalCollect::Requests::Composite
+    # WDL §5.28 requires ORDER and PAYMENT nodes in PARAMS, but may optionally
+    # include AIRLINEDATA and ORDERLINES, as well.
+    def initialize(order_and_builder, payment_and_builder, *extra_pairs)
+      all_pairs = [order_and_builder, payment_and_builder] + extra_pairs
+      super("INSERT_ORDERWITHPAYMENT", all_pairs)
+    end
+  end
+end

data/lib/global_collect/requests/process_challenged.rb

@@ -0,0 +1,22 @@
+module GlobalCollect::Requests
+  class ProcessChallenged < GlobalCollect::Requests::Simple
+    # WDL §5.30
+    def initialize(order_id, effort_id=nil, attempt_id=nil)
+      super("PROCESS_CHALLENGED", { 
+        "ORDERID"   => order_id,
+        "EFFORTID"  => effort_id,
+        "ATTEMPTID" => attempt_id
+      })
+    end
+    
+    def wrapper; "PAYMENT"; end
+    
+    def fields
+      {
+        "ORDERID"   => ["N10", "R"],
+        "EFFORTID"  => ["N5",  "O"],
+        "ATTEMPTID" => ["N5",  "O"]
+      }
+    end
+  end
+end