rtml 1.2.2

data/app_generators/rtml/templates/rtml/app/models/rtml/card.rb

@@ -0,0 +1,83 @@
+class Rtml::Card < ActiveRecord::Base
+  #TODO: Many of the has_one relationships need to be turned into has_many, but this is not as trivial
+  #as it sounds.
+  @@allow_secure_info = false
+  set_table_name "rtml_cards"
+  serialize :input_type
+  belongs_to :data, :polymorphic => true, :autosave => true, :dependent => :destroy
+  has_one :transaction, :dependent => :destroy, :class_name => 'Rtml::Transaction', :foreign_key => 'card_id', :autosave => true
+  has_one :card_parser, :dependent => :destroy, :class_name => 'Rtml::CardParser', :foreign_key => 'card_id', :autosave => true
+  has_one :avs, :dependent => :destroy, :class_name => 'Rtml::CardAvs', :foreign_key => 'card_id', :autosave => true
+  has_one :cvv, :dependent => :destroy, :class_name => 'Rtml::CardCvv', :foreign_key => 'card_id', :autosave => true
+  has_one :pin, :dependent => :destroy, :class_name => 'Rtml::CardPin', :foreign_key => 'card_id', :autosave => true
+  validate :validate_no_secure_info
+  
+  def validate_no_secure_info
+    errors.add_to_base "Cannot save secure information." unless allow_secure_info?
+  end
+
+  def allow_secure_info?
+    @@allow_secure_info
+  end
+
+  def self.allow_secure_info?
+    @@allow_secure_info
+  end
+
+  # Call this method to allow credit card information to be saved to the database.
+  # This will raise a warning in development mode.
+  #
+  #  IMPORTANT: When card information is saved, RTML does NOT encrypt or obfuscate the data.
+  #  If you intend to save card data to your database, you should consider encrypting this
+  #  data prior to saving it, and decrypting it when it is loaded.
+  #
+  def self.allow_secure_info!
+    logger.warn "WARNING: Secure card data will be saved to database!" if ENV['RAILS_ENV'] != 'production'
+    @@allow_secure_info = true
+  end
+
+  # Initializes a Card object (and its associations) from a params hash.
+  # The difference between this and #initialize is that <code>from</code> will search
+  # the hash for values that belong in this structure, but follow a slightly nonstandard
+  # structure (due to TML naming conventions).
+  def from(params)
+    self.issue_number = params[:issue_number]
+    self.input_type = (params[:input_type].kind_of? Fixnum) ? Rtml::Beryl::Constants::InputMethod[params[:input_type]] : params[:input_type]
+    
+    self.expiry_date = (params[:expiry_date].kind_of? String) ? Time.parse(params[:expiry_date]) : params[:expiry_date]
+    self.effective_date = (params[:effective_date].kind_of? String) ? Time.parse(params[:effective_date]) : params[:effective_date]
+
+    self.cardholder_name = params[:cardholder_name]
+    self.pan = params[:pan]
+    self.issue_number = params[:issue_number]
+    self.issuer_name = params[:issuer_name]
+    self.scheme = params[:scheme]
+    
+    if params[:avs]
+      self.avs = Rtml::CardAvs.from(params[:avs])
+    end
+    
+    if params[:cvv]
+      self.cvv = Rtml::CardCvv.from(params[:cvv])
+    end
+    
+    if params[:emv] and params[:emv][:aid]
+      self.data = Rtml::EmvCardData.from(params[:emv])
+    elsif params[:mag]
+      self.data = Rtml::MagCardData.from(params[:mag])
+    end
+    
+    if params[:parser]
+      self.card_parser = Rtml::CardParser.from(params[:parser])
+    end
+    
+    self.pin = Rtml::CardPin.from(params)
+    
+    self
+  end
+  
+  # same as Rtml::Card.new.from(params)
+  def self.from(params)
+    self.new.from(params)
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/card_avs.rb

@@ -0,0 +1,14 @@
+class Rtml::CardAvs < ActiveRecord::Base
+  set_table_name "rtml_card_avs"
+  belongs_to :card, :class_name => 'Rtml::Card'
+  
+  def self.from(params)
+    self.new.from(params)
+  end
+  
+  def from(params)
+    self.zip = params[:zip]
+    self.address = params[:address]
+    self
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/card_cvv.rb

@@ -0,0 +1,14 @@
+class Rtml::CardCvv < ActiveRecord::Base
+  set_table_name 'rtml_card_cvvs'
+  belongs_to :card, :class_name => 'Rtml::Card'
+  
+  def self.from(params)
+    self.new.from(params)
+  end
+  
+  def from(params)
+    self.value = params[:value]
+    self.reason_skipped = params[:reason_skipped]
+    self
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/card_parser.rb

@@ -0,0 +1,21 @@
+class Rtml::CardParser < ActiveRecord::Base
+  set_table_name "rtml_card_parsers"
+  belongs_to :card, :class_name => 'Rtml::Card'
+  
+  # Initializes an MagCardData object (and its associations) from a params hash.
+  # The difference between this and #initialize is that <code>from</code> will search
+  # the hash for values that belong in this structure, but follow a slightly nonstandard
+  # structure (due to TML naming conventions).
+  def from(params)
+    for i in %W(card_type reject_reason verdict cvm cvr)
+      self.send("#{i}=", params[i])
+    end
+    
+    self
+  end
+  
+  # same as Rtml::Card.new.from(params)
+  def self.from(params)
+    self.new.from(params)
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/card_pin.rb

@@ -0,0 +1,18 @@
+class Rtml::CardPin < ActiveRecord::Base
+  set_table_name 'rtml_card_pins'
+  belongs_to :card, :class_name => 'Rtml::Card'
+  
+  def self.from(params)
+    self.new.from(params)
+  end
+  
+  def from(params)
+    # both fields need to be converted to uppercase.
+    # smid needs to strip out leading "ffff".
+    
+    self.block = params[:pin].to_s.upcase
+    self.smid = params['pin.smid'].to_s[4..-1].to_s.upcase
+    
+    self
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/emv_card_data.rb

@@ -0,0 +1,25 @@
+class Rtml::EmvCardData < ActiveRecord::Base
+  set_table_name "rtml_emv_card_data"
+  has_one :card, :as => :data
+  
+  # Initializes an EmvCardData object (and its associations) from a params hash.
+  # The difference between this and #initialize is that <code>from</code> will search
+  # the hash for values that belong in this structure, but follow a slightly nonstandard
+  # structure (due to TML naming conventions).
+  def from(params)
+    self.aid = params[:aid]
+    for i in %W(aip app_pan_seq atc auc last_attempt signature unumber)
+      self.send("#{i}=", params[i])
+    end
+    for i in %W(aac arqc cvmr iac_default iac_denial iac_online iad iso_track2 tc tvr)
+      self.send("#{i}=", params[i])
+    end
+    
+    self
+  end
+  
+  # same as Rtml::Card.new.from(params)
+  def self.from(params)
+    self.new.from(params)
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/mag_card_data.rb

@@ -0,0 +1,21 @@
+class Rtml::MagCardData < ActiveRecord::Base
+  set_table_name "rtml_mag_card_data"
+  has_one :card, :as => :data
+  
+  # Initializes an MagCardData object (and its associations) from a params hash.
+  # The difference between this and #initialize is that <code>from</code> will search
+  # the hash for values that belong in this structure, but follow a slightly nonstandard
+  # structure (due to TML naming conventions).
+  def from(params)
+    for i in %W(iso1_track iso2_track iso3_track service_code)
+      self.send("#{i}=", params[i])
+    end
+    
+    self
+  end
+  
+  # same as Rtml::Card.new.from(params)
+  def self.from(params)
+    self.new.from(params)
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/reference_code.rb

@@ -0,0 +1,26 @@
+module Rtml
+  # Contains terminals' state information.
+  class ReferenceCode < ActiveRecord::Base
+    set_table_name "rtml_reference_codes"
+    belongs_to :transaction, :class_name => 'Rtml::Transaction'
+    validates_uniqueness_of :value
+    
+    def after_initialize
+      if self.value.nil?
+        if Rtml::ReferenceCode.last.nil?
+          self.value = Time.now.to_i.to_s
+        else
+          self.value = (Rtml::ReferenceCode.last.value.to_i+1).to_s
+        end
+      end
+    end
+    
+    def self.next
+      self.new
+    end
+    
+    def to_s
+      self.value#.rjust(12, "0")
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/state.rb

@@ -0,0 +1,12 @@
+module Rtml
+  # Contains terminals' state information.
+  class State < ActiveRecord::Base
+    set_table_name "rtml_states"
+    serialize :state#, HashWithIndifferentAccess
+    has_one :terminal, :class_name => 'Rtml::Terminal', :dependent => :destroy
+    validates_presence_of :terminal
+    
+    def [](a); (self.state ||= HashWithIndifferentAccess.new)[a]; end
+    def []=(a,b); (self.state ||= HashWithIndifferentAccess.new)[a] = b; end
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/terminal.rb

@@ -0,0 +1,8 @@
+module Rtml
+  # Contains terminals which have executed transactions using this database
+  class Terminal < ActiveRecord::Base
+    set_table_name "rtml_terminals"
+    has_many :transactions, :class_name => 'Rtml::Transaction', :dependent => :destroy
+    belongs_to :state, :class_name => 'Rtml::State'
+  end
+end

data/app_generators/rtml/templates/rtml/app/models/rtml/transaction.rb

@@ -0,0 +1,68 @@
+# Contains individual transactions executed by terminals
+class Rtml::Transaction < ActiveRecord::Base
+  set_table_name "rtml_transactions"
+  serialize :state
+  serialize :additional_data, Hash
+  serialize :hidden_data, Hash
+  belongs_to :terminal, :class_name => 'Rtml::Terminal'
+  belongs_to :card, :class_name => 'Rtml::Card'
+  has_one :reference_code, :dependent => :destroy, :class_name => 'Rtml::ReferenceCode', :foreign_key => 'transaction_id', :autosave => true
+  attr_accessor :payment_data, :payment_order #TODO: Add a migration for this to store in DB.
+
+  def before_validation
+    # FIXME: There's probably a better way to do this.
+    @__card = self.card
+    self.card = nil unless self.card.allow_secure_info?
+  end
+  
+  def after_save
+    # FIXME: There's probably a better way to do this.
+    # restore unsaved card data for use in views
+    self.card = @__card
+  end
+  
+  def after_initialize
+    self.payment_data ||= ActiveSupport::OrderedHash.new
+    self.additional_data ||= ActiveSupport::OrderedHash.new
+    self.state ||= :new
+    self.reference_code ||= Rtml::ReferenceCode.next
+    self.hidden_data ||= HashWithIndifferentAccess.new
+    self.payment_order ||= []
+    
+    # special items
+    self.payment_data[:amount] = :amount
+    self.payment_data[:cashback] = proc { |txn| txn.amount_other.to_i == 0 ? nil : 0 }
+    self.payment_data[:total] = proc { |txn| txn.amount_other.to_i == 0 ? nil : txn.amount + txn.amount_other }
+  end
+  
+  # Initializes a Transaction object (and its associations) from a params hash.
+  # The difference between this and #initialize is that <code>from</code> will search
+  # the hash for values that belong in this structure, but follow a slightly nonstandard
+  # structure (due to TML naming conventions).
+  #
+  # auth_code and message are intentionally left blank, for developer to fill.
+  def from(params)
+    self.post_id = params[:post_id]
+    self.action = params[:action]
+    if params[:payment]
+      self.amount = params[:payment][:amount].to_i
+      self.amount_other = params[:payment][:amount_other].to_i
+      self.txn_type = params[:payment][:trans_type]
+    end
+    if params[:oebr]
+      self.txn_mode = params[:oebr][:submit_mode]
+    end
+    if params[:card]
+      self.card = Rtml::Card.from(params[:card])
+    end
+    
+    self.terminal = Rtml::Terminal.find_by_itid(params[:itid])
+
+    self
+  end
+  
+  # same as Rtml::Transaction.new.from(params)
+  def self.from(params)
+    self.new.from(params)
+  end
+end

data/app_generators/rtml/templates/rtml/app/views/beryl/auth_result/another_rcpt.rtml.erb

@@ -0,0 +1,15 @@
+<table width='100%'>
+   <tr>
+      <td align='center' valign='middle' colspan='2'>
+         CUSTOMER COPY?
+      </td>
+   </tr>
+   <tr>
+      <td align='left'>
+         <%=link_to "YES", :anchor => :receipt%>
+      </td>
+      <td align='right'>
+         <%=link_to "NO", :anchor => :complete%>
+      </td>
+   </tr>
+</table>

data/app_generators/rtml/templates/rtml/app/views/beryl/auth_result/receipt.rtml.erb

@@ -0,0 +1,108 @@
+<table width='100%'>
+  <%spacer = "<tr><td class='small' colspan='2'><br/></td></tr>"%>
+  <%=spacer%>
+  <tr>
+    <td align='center' class='large bold' colspan='2'>
+      <%=receipt_text(controller.feature_config.common.receipt_header)%>
+    </td>
+  </tr>
+  <%=spacer%>
+  <tr>
+    <%=left @transaction.created_at.strftime("%m/%d/%y")%>
+    <%=right @transaction.created_at.strftime("%H:%M:%S")%>
+  </tr>
+  <tr>
+    <%=left "TID: "%>
+    <%=right tid_for_transaction(@transaction).to_s%>
+  </tr>
+  <tr>
+    <%=left "Entry Method:"%>
+    <%=right @transaction.card.input_type.to_s.titleize%>
+  </tr>
+  <%unless @transaction.batch.blank?%>
+    <tr>
+      <%=left "Batch #:"%>
+      <%=right @transaction.batch%>
+    </tr>
+  <%end%>
+  <%unless @transaction.additional_data.empty?
+    @transaction.additional_data.each do |label, value|%>
+      <tr>
+        <%=left label.to_s.titleize%>
+        <%=right value%>
+      </tr>
+    <%end
+  end%>
+  <tr>
+    <%=left :bold, "REF #:"%>
+    <%=right :bold, @transaction.reference_code.to_s%>
+  </tr>
+  <%=spacer%>
+  
+  <tr>
+    <%=left :bold, "Auth Code:"%>
+    <%=right :bold, @transaction.auth_code%>
+  </tr>
+  <tr>
+    <%=left :bold, "Card:"%>
+    <%=right :bold, "<getvar name='card.pan' format='n#*n4' />"%>
+  </tr>
+  <%payment_keys.each do |key|%>
+    <%value = payment_value(key)
+    unless value.blank?%>
+      <tr>
+        <%if key.blank? || key == :blank%>
+          <%=spacer%>
+        <%else
+          if value.kind_of?(String)%>
+            <%=left :bold, "#{key.to_s.titleize}:"%>
+            <%=right :bold, value%>
+          <%elsif value.nil?%>
+            <%=left :bold, key.to_s.titleize%>
+          <%else%>
+            <%=left :bold, "#{key.to_s.titleize}:"%>
+            <%=right :bold, integer_as_currency(value)%>
+          <%end
+        end%>
+      </tr>
+    <%end%>
+  <%end%>
+
+  <%=spacer%>
+  <tr>
+    <td colspan='2' align='center' class='small'>
+      <%=@transaction.message%>
+    </td>
+  </tr>
+  <%=spacer%>
+  <tr>
+    <td align='center' colspan='2'>
+      <%if @duplicate || @transaction.hidden_data[:duplicate]%>
+        (DUPLICATE TRANSACTION)
+      <%else%>
+        <getvar name='signature_line' />
+      <%end%>
+    </td>
+  </tr>
+  <%=spacer%>
+  <tr>
+    <td align='center' colspan='2'>
+      <%=receipt_text(controller.feature_config.common.receipt_agreement)%>
+    </td>
+  </tr>
+  <%=spacer%>
+  <tr>
+    <td align='center' colspan='2'>
+      <%=receipt_text(controller.feature_config.common.receipt_footer)%>
+    </td>
+  </tr>
+  <%=spacer%>
+  <tr>
+    <td align='center' colspan='2'>
+      <getvar name='owner' /> COPY
+    </td>
+  </tr>
+</table>
+<br/><br/><br/>
+<br/><br/><br/>
+<br/><br/><br/>