agms 0.1.0

data/lib/agms/invoicing.rb

@@ -0,0 +1,63 @@
+module Agms
+  class Invoicing < Agms
+    # A class representing AGMS Invoicing objects.
+
+    alias AgmsResetParameters resetParameters
+    alias AgmsSetParameter setParameter
+    alias AgmsDoConnect doConnect
+
+    def initialize
+      super()
+      @api_url = 'https://gateway.agms.com/roxapi/AGMS_BillPay.asmx'
+      @requestObject = 'InvoicingRequest'
+      @responseObject = 'InvoicingResponse'
+    end
+
+    # @return [Object]
+    def customer(params)
+      @op = 'RetrieveCustomerIDList'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      # self.execute()
+      # return @response.toArray()
+    end
+
+    # @return [Object]
+    def invoice(params)
+      @op = 'RetrieveInvoices'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      # self.execute()
+      # return @response.toArray()
+    end
+
+    # @return [Object]
+    def submit(params)
+      @op = 'SubmitInvoice'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      # self.execute()
+      # return @response.toArray()
+    end
+
+    protected
+    def execute
+      if self.op == 'RetrieveCustomerIDList'
+        AgmsDoConnect('RetrieveCustomerIDList', @responseObject)
+      elsif self.op == 'RetrieveInvoices'
+        AgmsDoConnect('RetrieveInvoices', @responseObject)
+      elsif self.op == 'SubmitInvoice'
+        AgmsDoConnect('SubmitInvoice', @responseObject)
+      else
+        raise InvalidRequestError, "Invalid request to Transaction API #{@op}"
+      end
+    end
+
+  end
+end

data/lib/agms/recurring.rb

@@ -0,0 +1,76 @@
+module Agms
+  class Recurring < Agms
+    # A class representing AGMS Recurring objects.
+
+    alias AgmsResetParameters resetParameters
+    alias AgmsSetParameter setParameter
+    alias AgmsDoConnect doConnect
+
+    def initialize
+      super()
+      @api_url = 'https://gateway.agms.com/roxapi/AGMS_Recurring.asmx'
+      @requestObject = 'RecurringRequest'
+      @responseObject = 'RecurringResponse'
+    end
+
+    # @return [Object]
+    def add(params)
+      @op = 'RecurringAdd'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    # @return [Object]
+    def update(params)
+      @op = 'RecurringUpdate'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    # @return [Object]
+    def delete(params)
+      @op = 'RecurringDelete'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    # @return [Object]
+    def get(params)
+      @op = 'RetrieveRecurringID'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    protected
+    def execute
+      if @op == 'RecurringAdd'
+        AgmsDoConnect('RecurringAdd', @responseObject)
+      elsif @op == 'RecurringUpdate'
+        AgmsDoConnect('RecurringUpdate', @responseObject)
+      elsif @op == 'RecurringDelete'
+        AgmsDoConnect('RecurringDelete', @responseObject)
+      elsif @op == 'RetrieveRecurringID'
+        AgmsDoConnect('RetrieveRecurringID', @responseObject)
+      else
+        raise InvalidRequestError, "Invalid request to Transaction API #{@op}"
+      end
+    end
+
+  end
+end

data/lib/agms/report.rb

@@ -0,0 +1,53 @@
+module Agms
+  class Report < Agms
+    # A class representing AGMS Report objects.
+
+    alias AgmsResetParameters resetParameters
+    alias AgmsSetParameter setParameter
+    alias AgmsDoConnect doConnect
+
+    def initialize
+      super()
+      @trans_api_url = 'https://gateway.agms.com/roxapi/agms.asmx'
+      @safe_api_url = 'https://gateway.agms.com/roxapi/AGMS_SAFE_API.asmx'
+      @requestObject = 'ReportRequest'
+      @responseObject = 'ReportResponse'
+    end
+
+    # @return [Object]
+    def listTransactions(params)
+      @op = 'TransactionAPI'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    # @return [Object]
+    def listSAFEs(params)
+      @op = 'QuerySAFE'
+      AgmsResetParameters()
+      params.each do |param, config|
+        AgmsSetParameter(param, config)
+      end
+      self.execute()
+      return @response.toArray()
+    end
+
+    protected
+    def execute
+      if @op == 'TransactionAPI'
+        @api_url = @trans_api_url
+        AgmsDoConnect('TransactionAPI', @responseObject)
+      elsif @op == 'QuerySAFE'
+        @api_url = @safe_api_url
+        AgmsDoConnect('QuerySAFE', @responseObject)
+      else
+        raise InvalidRequestError, "Invalid request to Transaction API #{@op}"
+      end
+    end
+
+  end
+end

data/lib/agms/request/hpp_request.rb

@@ -0,0 +1,181 @@
+module Agms
+  class HPPRequest < Request
+    # A class representing AGMS Transaction Request objects.
+
+    alias AgmsAutoValidate autoValidate
+
+    def initialize(op)
+      super(op)
+      @fields = {
+          :TransactionType => {:setting => '', :value => ''},
+          :Amount => {:setting => '', :value => ''},
+          :TipAmount => {:setting => '', :value => ''},
+          :Tax => {:setting => '', :value => ''},
+          :Shipping => {:setting => '', :value => ''},
+          :OrderDescription => {:setting => '', :value => ''},
+          :OrderID => {:setting => '', :value => ''},
+          :ClerkID => {:setting => '', :value => ''},
+          :PONumber => {:setting => '', :value => ''},
+          :RetURL => {:setting => '', :value => ''},
+          :ACHEnabled => {:setting => '', :value => ''},
+          :SAFE_ID => {:setting => '', :value => ''},
+          :Donation => {:setting => '', :value => ''},
+          :UsageCount => {:setting => '', :value => ''},
+          :Internal => {:setting => '', :value => ''},
+          :FirstName => {:setting => '', :value => ''},
+          :LastName => {:setting => '', :value => ''},
+          :Company => {:setting => '', :value => ''},
+          :Address1 => {:setting => '', :value => ''},
+          :Address2 => {:setting => '', :value => ''},
+          :City => {:setting => '', :value => ''},
+          :State => {:setting => '', :value => ''},
+          :Zip => {:setting => '', :value => ''},
+          :Country => {:setting => '', :value => ''},
+          :Phone => {:setting => '', :value => ''},
+          :Fax => {:setting => '', :value => ''},
+          :EMail => {:setting => '', :value => ''},
+          :Website => {:setting => '', :value => ''},
+          :ShippingFirstName => {:setting => '', :value => ''},
+          :ShippingLastName => {:setting => '', :value => ''},
+          :ShippingCompany => {:setting => '', :value => ''},
+          :ShippingAddress1 => {:setting => '', :value => ''},
+          :ShippingAddress2 => {:setting => '', :value => ''},
+          :ShippingCity => {:setting => '', :value => ''},
+          :ShippingState => {:setting => '', :value => ''},
+          :ShippingZip => {:setting => '', :value => ''},
+          :ShippingCountry => {:setting => '', :value => ''},
+          :ShippingEmail => {:setting => '', :value => ''},
+          :ShippingPhone => {:setting => '', :value => ''},
+          :ShippingFax => {:setting => '', :value => ''},
+          :ProcessorID => {:setting => '', :value => ''},
+          :TransactionID => {:setting => '', :value => ''},
+          :Tracking_Number => {:setting => '', :value => ''},
+          :Shipping_Carrier => {:setting => '', :value => ''},
+          :IPAddress => {:setting => '', :value => ''},
+          :Custom_Field_1 => {:setting => '', :value => ''},
+          :Custom_Field_2 => {:setting => '', :value => ''},
+          :Custom_Field_3 => {:setting => '', :value => ''},
+          :Custom_Field_4 => {:setting => '', :value => ''},
+          :Custom_Field_5 => {:setting => '', :value => ''},
+          :Custom_Field_6 => {:setting => '', :value => ''},
+          :Custom_Field_7 => {:setting => '', :value => ''},
+          :Custom_Field_8 => {:setting => '', :value => ''},
+          :Custom_Field_9 => {:setting => '', :value => ''},
+          :Custom_Field_10 => {:setting => '', :value => ''},
+          :HPPFormat => {:setting => '', :value => ''},
+          :StartDate => {:setting => '', :value => ''},
+          :EndDate => {:setting => '', :value => ''},
+          :StartTime => {:setting => '', :value => ''},
+          :EndTime => {:setting => '', :value => ''},
+          :SuppressAutoSAFE => {:setting => '', :value => ''}
+      }
+
+      @optionable = %w('FirstName', 'LastName', 'Company', 'Address1', 'Address2',
+            'City', 'State', 'Zip', 'Country', 'Phone', 'Fax',
+            'EMail', 'Website', 'Tax', 'Shipping', 'OrderID',
+            'PONumber', 'ShippingFirstName', 'ShippingLastName', 'ShippingCompany', 'ShippingAddress1',
+            'ShippingAddress2', 'ShippingCity', 'ShippingState', 'ShippingZip', 'ShippingCountry',
+            'ShippingEmail', 'ShippingPhone', 'ShippingFax', 'ShippingTrackingNumber', 'ShippingCarrier',
+            'Custom_Field_1', 'Custom_Field_2', 'Custom_Field_3', 'Custom_Field_4', 'Custom_Field_5',
+            'Custom_Field_6', 'Custom_Field_7', 'Custom_Field_8', 'Custom_Field_9', 'Custom_Field_10')
+
+      @numeric = %w(Amount Tax Shipping ProcessorID TransactionID CheckABA CheckAccount CCNumber CCExpDate)
+
+      @enums = {
+          :TransactionType => %w(sale auth safe\ only capture void refund update adjustment),
+          :Shipping_Carrier => %w(ups fedex dhl usps UPS Fedex DHL USPS),
+          :HPPFormat => %w(1 2)
+      }
+      @boolean = %w(Donation AutoSAFE SuppressAutoSAFE)
+
+      @date = %w(StartDate EndDate)
+
+      @digit_2 = %w(State ShippingState)
+
+      @amount = %w(Amount TipAmount Tax Shipping)
+
+      @required = %w(TransactionType)
+
+      # Override mapping with api-specific field maps
+      @mapping[:shipping_tracking_number] = :Tracking_Number
+      @mapping[:shipping_carrier] = :Shipping_Carrier
+
+    end
+
+    def validate
+      @required = Array.new
+
+      # All sales and auth require an amount unless donation
+      if ( ( @fields[:Donation][:value] != '' or
+            @fields[:Donation][:value] != false ) and
+          (@fields[:TransactionType][:value] == 'sale' or
+            @fields[:TransactionType][:value] == 'auth') )
+        @required.push(:Amount)
+      end
+
+      error_array = AgmsAutoValidate();
+
+      errors = error_array['errors'];
+      messages = error_array['messages'];
+
+      # ExpDate MMYY
+      if (  @fields.has_key?(:CCExpDate) and
+          @fields[:CCExpDate][:value] != '' and
+          ( @fields[:CCExpDate][:value].length != 4 or
+              not /(0[1-9]|1[0-2])([0-9][0-9])/.match(@fields[:CCExpDate][:value]) )  )
+        errors += 1
+        messages.push('CCExpDate (credit card expiration date) must be MMYY.')
+      end
+
+      # CCNumber length
+      if (  @fields.has_key?(:CCNumber) and
+          @fields[:CCNumber][:value] != ''  and
+          @fields[:CCNumber][:value].length != 16 and
+          @fields[:CCNumber][:value].length != 15 )
+        errors += 1
+        messages.push('CCNumber (credit card number) must be 15-16 digits long.')
+      end
+
+      # ABA length
+      if  ( @fields.has_key?(:CheckABA) and
+          @fields[:CheckABA][:value] != '' and
+          @fields[:CheckABA][:value].length != 9)
+        errors += 1
+        messages.push('CheckABA (routing number) must be 9 digits long.')
+      end
+
+      @validate_errors = errors;
+      @validate_messages = messages;
+
+      if errors == 0
+        return {'errors' => errors, 'messages' => messages}
+      else
+        raise RequestValidationError, "Request validation failed with #{messages.join(' ')}."
+      end
+
+    end
+
+    def getFields
+      fields =  getFieldArray
+      if fields.has_key?(:AutoSAFE)
+        if fields[:AutoSAFE] == true
+          fields[:AutoSAFE] = 1
+        else
+          fields[:AutoSAFE] = 0
+        end
+      end
+      if fields.has_key?(:SuppressAutoSAFE)
+        if fields[:SuppressAutoSAFE] == true
+          fields[:SuppressAutoSAFE] = 1
+        else
+          fields[:SuppressAutoSAFE] = 0
+        end
+      end
+      return fields
+    end
+
+    def getParams(request)
+      return {:objparameters => request}
+    end
+  end
+end

data/lib/agms/request/invoicing_request.rb

@@ -0,0 +1,8 @@
+module Agms
+	class InvoicingRequest < Request
+
+    def initialize(op)
+      super(op)
+    end
+	end
+end

data/lib/agms/request/recurring_request.rb

@@ -0,0 +1,115 @@
+module Agms
+  class RecurringRequest < Request
+    # A class representing AGMS Recurring Request objects.
+
+    alias AgmsAutoValidate autoValidate
+
+    def initialize(op)
+      super(op)
+      @fields1 = {
+          :RecurringID => {:setting => '', :value => ''},
+          :MerchantID => {:setting => '', :value => ''},
+          :PaymentType => {:setting => '', :value => 'creditcard'},
+          :InitialAmount => {:setting => '', :value => ''},
+          :RecurringAmount => {:setting => '', :value => ''},
+          :CCNumber => {:setting => '', :value => ''},
+          :CCExpDate => {:setting => '', :value => ''},
+          :CVV => {:setting => '', :value => ''},
+          :CheckName => {:setting => '', :value => ''},
+          :CheckABA => {:setting => '', :value => ''},
+          :CheckAccount => {:setting => '', :value => ''},
+          :AccountHolderType => {:setting => '', :value => ''},
+          :AccountType => {:setting => '', :value => ''},
+          :SecCode => {:setting => '', :value => ''},
+          :FirstName => {:setting => '', :value => ''},
+          :LastName => {:setting => '', :value => ''},
+          :Company => {:setting => '', :value => ''},
+          :Address1 => {:setting => '', :value => ''},
+          :Address2 => {:setting => '', :value => ''},
+          :City => {:setting => '', :value => ''},
+          :State => {:setting => '', :value => ''},
+          :Zip => {:setting => '', :value => ''},
+          :Country => {:setting => '', :value => ''},
+          :Phone => {:setting => '', :value => ''},
+          :Fax => {:setting => '', :value => ''},
+          :EMail => {:setting => '', :value => ''},
+          :Website => {:setting => '', :value => ''},
+          :Custom_Field_1 => {:setting => '', :value => ''},
+          :Custom_Field_2 => {:setting => '', :value => ''},
+          :Custom_Field_3 => {:setting => '', :value => ''},
+          :Custom_Field_4 => {:setting => '', :value => ''},
+          :Custom_Field_5 => {:setting => '', :value => ''},
+          :Custom_Field_6 => {:setting => '', :value => ''},
+          :Custom_Field_7 => {:setting => '', :value => ''},
+          :Custom_Field_8 => {:setting => '', :value => ''},
+          :Custom_Field_9 => {:setting => '', :value => ''},
+          :Custom_Field_10 => {:setting => '', :value => ''},
+          :StartDate => {:setting => '', :value => ''},
+          :Frequency => {:setting => '', :value => ''},
+          :Quantity => {:setting => '', :value => ''},
+          :NumberOfOccurrences => {:setting => '', :value => ''},
+          :EndDate => {:setting => '', :value => ''},
+          :NumberOfRetries => {:setting => '', :value => ''}
+      }
+
+      @numeric = %w(InitialAmount RecurringAmount Quantity NumberOfOccurrences NumberOfRetries CCNumber CCExpDate CheckABA CheckAccount)
+
+      @enums = {
+          :PaymentType => %w(creditcard check),
+          :SecCode => %w(PPD WEB TEL CCD),
+          :AccountHolderType => %w(business personal),
+          :AccountType => %w(checking savings),
+          :Frequency => %w(days weeks months)
+      }
+
+      @date = %w(StartDate EndDate)
+
+      @digit_2 = %w(State)
+
+      @amount = %w(Amount TipAmount Tax Shipping)
+
+      if @op == 'RecurringAdd'
+        @fields = @fields1
+      else
+        raise InvalidRequestError, "Invalid op #{@op} in Request."
+      end
+
+    end
+
+    def validate
+      @required = Array.new
+
+      if @fields[:Frequency][:value] == ''
+        @required.push(:Frequency)
+      end
+
+      # If no transaction type, require a Safe Action
+      if @fields[:NumberOfRetries][:value] == ''
+        @required.push(:NumberOfRetries)
+      end
+
+      error_array = AgmsAutoValidate();
+
+      errors = error_array['errors'];
+      messages = error_array['messages'];
+
+      @validate_errors = errors;
+      @validate_messages = messages;
+
+      if errors == 0
+        return {'errors' => errors, 'messages' => messages}
+      else
+        raise RequestValidationError, "Request validation failed with #{messages.join(' ')}."
+      end
+
+    end
+
+    def getFields
+      return getFieldArray
+    end
+
+    def getParams(request)
+      return {:vRecurringParams => request}
+    end
+  end
+end