rtml 1.2.2

data/app_generators/rtml/templates/rtml/app/helpers/rtml/oe/btmlpa_tml_helpers/index.rb

@@ -0,0 +1,191 @@
+Rtml.actions_for Rtml::Oe::BtmlpaController do
+  def index
+    on :cancel => :index
+    default_screen :index
+    includes url_for(:action => 'receipt', :only_path => true)
+    layout tml_layout
+    includes tml_stylesheet
+    supports_emv :entry_point => :emv_start,  :exit_point => :emv_submit,
+                 :on_abort    => :trans_abrt, :on_reject  => :reject_trans
+    
+    strings :decline_reason, :screen_after_call, :prev_txn_type => "-1", :currency_code => 'USD'
+    integers 'btmlpa.signature_check', 'btmlpa.dupl_available' => 0,
+             'btmlpa.duplicate_receipt' => 0, :reversal_txnid => -1, :transid => -1
+    date 'payment.txn_date'
+    
+    @main = url_for(:controller => "/rtml/oe/examples/index", :only_path => true)
+    @restart = url_for(:action => :index, :only_path => true)
+    @reverse = url_for(:action => "reverse", :only_path => true)
+    @icc = :emv_start#url_for(:action => 'icc', :anchor => 'check_apps', :only_path => true)
+    @auth = url_for(:action => "auth", :only_path => true)
+    @receipt = :rcpt_start #url_for(:action => 'receipt', :anchor => "rcpt_start", :only_path => true)
+    
+    screens do
+      index :next => :main_menu do
+        #set :screen_after_call => "#index"
+        card :parser => :mag, :params => :clean do
+          baddata "<getvar name='err.baddata_reason' />: <getvar name='err.description' />"
+        end
+      end
+      
+      # Submits EMV transaction data to host
+      emv_submit :next => @receipt do
+        set 'card.expiry_date', :to => '2010/12/31'
+        set 'oebr.submit_mode', :to => 'tmlvar:card.parser.verdict'
+        submit :target => @auth, :on_error => :icc_conn_fld do
+          get_variables :transid, :currency_code, 'oebr.submit_mode', 'oebr.time_zone',
+                        'payment.trans_type', 'payment.amount', 'payment.amount_other', 'payment.txn_date',
+                        'card.pan', 'card.issue_number', 'card.expiry_date', 'card.cardholder_name',
+                        'card.effective_date', 'card.input_type', 'card.mag.iso2_track',
+                        'card.emv.aid', 'card.emv.aip', 'card.emv.auc', 'card.emv.atc', 'card.emv.aac',
+                        'card.emv.tc', 'card.emv.arqc', 'card.emv.iad', 'card.emv.tvr', 'card.emv.unumber'
+        end
+      end      
+
+      main_menu(:next => :trans_abrt) { display }
+      about(:next   => :index, :timeout => 3) { display }
+      sale(:read_card) { set "payment.trans_type" => "debit" }
+      sale_cb(:read_card) { set "payment.trans_type" => "cashback" }
+      refund(:read_card) { set "payment.trans_type" => "credit" }
+      check_rev(:confirm_rev) { variants ["tmlvar:transid == -1","tmlvar:prev_txn_type == -1",
+                                                   "tmlvar:prev_txn_type == reversal"] => :rev_bad }
+      confirm_rev { display }
+      rev_bad(:timeout => 3, :next => :close_trans) { display }
+      conn_fld(:offline_rev) { variants [ "tmlvar:oebr.submit_mode == offline",
+                                                   "tmlvar:card.parser.verdict == offline" ] => :subm_err }
+      offline_rev(:submit_rev) { set "oebr.submit_mode" => "offline"; }
+      subm_err(@restart) { display }
+      to_man_entry(:timeout => 1, :next => :man_entry) { display }
+      
+      sub_rev_prep(:next => :submit_rev, :on_cancel => :trans_abrt) do
+        set 'payment.trans_type' => 'reversal'
+        set 'payment.auth_code' => ''
+        set "btmlpa.duplicate_receipt" => 0
+        set "oebr.submit_mode" => "tmlvar:card.parser.verdict"
+      end
+      
+      submit_rev(:on_cancel => :trans_abrt) do
+        submit :target => @reverse, :on_error => :conn_fld do
+          get_variable :transid
+          get_variable "oebr.submit_mode"
+        end
+      end
+
+
+      read_card :on_menu => :man_entry, :next => :read_amount do
+        # reset variables
+        set 'btmlpa.dupl_available' => 0
+        set 'btmlpa.duplicate_receipt' => 0
+        set 'payment.amount' => 0
+        set 'payment.amount_other' => 0
+        set 'oebr.submit_mode' => ''
+        set :reversal_txnid, :to => -1
+    
+        build :tform do
+          baddata :max => 3, :next => :to_man_entry.to_screen_ref do
+            table :border => 2, :class => 'warning' do; tr { td { span { getvar :name => 'err.baddata_reason' } } } end
+          end
+          build :name => :card, :parser => 'mag', :parser_params => 'read_data'
+          build :name => :card, :parser => 'icc_emv', :parser_params => 'init_app'
+          prompt { table :class => 'message' do; tr { td { span { "Please swipe / insert card<br/>Press MENU for keying" } } } end }
+        end
+      end
+      
+      man_entry(:card_nmb) do
+        set 'card.input_type' => 3
+        set 'card.parser.type' => ''
+        set 'card.pan' => ''
+        set 'card.expiry_date' => '2007/01/01'
+        set 'card.effective_date' => ''
+      end
+      
+      card_nmb(:on_cancel => :trans_abrt, :next => :read_amount) do
+        display
+      end
+      
+      read_amount(:on_cancel => :close_trans, :next => :assert) do
+        set :transid, :to => "tmlvar:oebr.unique_id"
+        variants "tmlvar:payment.trans_type contains debit" => :read_sale,
+                 "tmlvar:payment.trans_type contains cashback" => :read_scb,
+                 "tmlvar:payment.trans_type contains credit" => :read_refund
+      end
+      
+      read_sale :next => :rd_sale_disp do set "payment.amount", :to => ""; end
+      
+      [ :rd_sale_disp, :read_refund].each do |sym|
+        self.send sym, :on_cancel => :trans_abrt, :next => @icc do
+          next_screen :mg_risk_mgmt, :if => "tmlvar:card.parser.type == mag"
+          next_screen :mg_risk_mgmt, :if => "tmlvar:card.input_type == 3"
+          display
+        end
+      end
+      
+      read_scb :next => :scb_check, :on_cancel => :trans_abrt do
+        display
+      end
+      
+      scb_check :on_cancel => :close_trans do
+        next_screen @icc
+        next_screen :scb_check_f, :if => "tmlvar:payment.amount <= tmlvar:payment.amount_other"
+        next_screen :mg_risk_mgmt, :if => "tmlvar:card.parser.type == mag"
+        next_screen :mg_risk_mgmt, :if => "tmlvar:card.input_type == 3"
+      end
+      
+      scb_check_f :next => :close_trans do display end
+      
+      mg_risk_mgmt do
+        set "payment.txn_date", :to => "tmlvar:terminal.datetime"
+        next_screen :mg_submit
+        next_screen :reject_trans, :if => "tmlvar:card.parser.verdict == reject"
+        card :parser => 'mag', :params => 'risk_mgmt' do
+          baddata "<table border='2' class='warning'><tr><td><span><getvar name='err.baddata_reason'/></span></td></tr></table>"
+          baddata_options :max => 1, :next => :trans_abrt.to_screen_ref
+        end
+      end
+      
+      mg_submit :on_cancel => :trans_abrt do
+        set "oebr.submit_mode", :to => "tmlvar:card.parser.verdict"
+        set "payment.auth_code", :to => ""
+        submit :target => @auth, :on_error => :conn_failed do
+          get_variables *%W(oebr.submit_mode payment.trans_type card.pan card.issue_number
+                            card.expiry_date card.cardholder_name card.effective_date transid
+                            payment.amount payment.amount_other currency_code card.input_type
+                            card.mag.iso2_track payment.txn_date oebr.time_zone)
+        end
+      end
+      
+      conn_failed :timeout => 8 do
+        next_screen :mg_risk_mgmt
+        next_screen :print_pf, :if => "tmlvar:oebr.submit_mode == offline"
+        next_screen :print_pf, :if => "tmlvar:card.parser.verdict == offline"
+      end
+      
+      print_pf :next => :trans_abrt do display end
+        
+      duplicate do
+        next_screen :assert
+        next_screen :duplicate_na, :if => "tmlvar:btmlpa.dupl_available == 0"
+        next_screen :duplicate_av, :if => "tmlvar:btmlpa.dupl_available == 1"
+      end
+      
+      duplicate_na :timeout => 8, :next => :index do display end
+      duplicate_av :next => :receipt do set "btmlpa.duplicate_receipt", :to => 1; end
+      remove_card :next => "tmlvar:screen_after_call" do
+        card :parser => :icc_emv, :params => :wait_remove_card do prompt nil end
+      end
+      compl_txn :timeout => 4, :next => :index do set "err.baddata_reason", :to => ""; display end
+      reject_trans :next => :trans_abrt do display end
+      void_trans :next => :close_trans, :timeout => 1 do display end
+      close_trans do
+        set :screen_after_call, :to => :index.to_screen_ref
+        next_screen :index
+        next_screen :remove_card, :if => "tmlvar:card.input_type == 2"
+      end
+      trans_abrt :timeout => 1, :next => :close_trans do display end
+      sign_check :on_cancel => :sub_rev_prep do display end
+      assert :timeout => 3, :next => :index do display end
+      receipt :next => @receipt do end
+      error_scr :next => :index, :timeout => 5 do display end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/app/helpers/rtml/oe/btmlpa_tml_helpers/receipt.rb

@@ -0,0 +1,152 @@
+Rtml.actions_for Rtml::Oe::BtmlpaController do
+  def receipt
+    # used if all conditions fail
+    @assert = url_for :action => 'index', :anchor => 'assert', :only_path => true
+    
+    # used to transfer to set either emv or mag variables
+    @mag_or_emv = { "tmlvar:card.input_type == 1" => :rcpt_mag_man,
+                    "tmlvar:card.input_type == 2" => :rcpt_emv,
+                    "tmlvar:card.input_type == 3" => :rcpt_mag_man }
+    
+    includes '/stylesheets/rtml/oe/btmlpa/receipt.css'
+    includes tml_stylesheet
+    on :error => :error_scr
+    
+    # define btmlpa.receipt.header, btmlpa.receipt.emv_app_aid, etc.
+    # per OE BTMLPA app (see its example for details)
+    strings 'btmlpa.receipt.header', 'btmlpa.receipt.emv_app_aid', 'btmlpa.receipt.emv_app_label',
+            'btmlpa.receipt.store_name', 'btmlpa.receipt.store_address', 'btmlpa.receipt.currency',
+            'btmlpa.receipt.cashback_message', 'btmlpa.receipt.cashback_amount', 'btmlpa.receipt.signature', 
+            'btmlpa.receipt.pan_format', 'btmlpa.receipt.footr', 'btmlpa.receipt.target_screen',
+            'btmlpa.receipt.authorization'
+
+    # check the transaction type
+    screen :rcpt_start, :next => @assert do
+      set "btmlpa.receipt.pan_format" => "n4n#*n4"
+      set :prev_txn_type, :to => "tmlvar:payment.trans_type"
+      set :reversal_txnid, :to => "tmlvar:transid"
+      set 'btmlpa.receipt.store_name' => "Ingenico"
+      set 'btmlpa.receipt.store_address' => 'France'
+      set 'btmlpa.receipt.currency' => [' ', 'plus', 'tmlvar:currency_code']
+      variants "tmlvar:btmlpa.duplicate_receipt == 1" => :rcpt_duplct,
+               "tmlvar:payment.trans_type contains debit" => :rcpt_dbt,
+               "tmlvar:payment.trans_type contains cashback" => :rcpt_cshbck,
+               "tmlvar:payment.trans_type contains reversal" => :rcpt_rvrsl,
+               "tmlvar:payment.trans_type contains credit" => :rcpt_crdt
+      timeout 5
+    end
+  
+    # sets the variables that are printed for debit transaction
+    screen :rcpt_dbt, :next => @assert do
+      set 'btmlpa.receipt.header' => 'Debit'
+      set ['btmlpa.receipt.cashback_message', 'btmlpa.receipt.cashback_amount'], :to => ""
+      variants @mag_or_emv
+    end
+  
+    # sets the variables that are printed for cashback transaction
+    screen :rcpt_cshbck, :next => @assert do
+      set 'btmlpa.receipt.header' => 'Cashback'
+      set 'btmlpa.receipt.cashback_message' => "Cash back amount:"
+      set 'btmlpa.receipt.cashback_amount', :to => "tmlvar:payment.amount_other", :format => "^*0.00"
+      set 'btmlpa.receipt.cashback_amount' => "tmlvar:btmlpa.receipt.cashback_amount + tmlvar:btmlpa.receipt.currency"
+      variants @mag_or_emv
+    end
+  
+    # sets the variables that are printed for reversal transaction
+    screen :rcpt_rvrsl, :next => :rcpt_print do
+      set 'btmlpa.receipt.header' => "Transaction Cancelled"
+      set 'btmlpa.receipt.target_screen' => url_for(:action => 'index', :anchor => :void_trans, :only_path => true)
+      set 'btmlpa.receipt.signature' => ""
+      set 'btmlpa.receipt.footr' => ""
+      set 'btmlpa.dupl_available' => 0
+      set 'btmlpa.signature_check' => 0
+    end
+  
+    # sets the variables that are printed for credit transaction
+    screen :rcpt_crdt, :next => @assert do
+      set 'btmlpa.receipt.header' => 'Credit'
+      set ['btmlpa.receipt.cashback_message', 'btmlpa.receipt.cashback_amount'] => ''
+      variants @mag_or_emv
+    end
+  
+    # EMV-specific screens
+    # set the variables to be printed
+    screen :rcpt_emv, :next => :rcpt_emv2 do
+      set 'btmlpa.signature_check' => "tmlvar:card.emv.signature"
+      set 'btmlpa.receipt.header' => ["tmlvar:btmlpa.receipt.header", "+", " EMV"]
+      set 'btmlpa.receipt.authorization', :to => "tmlvar:card.emv.tc", :format => "hex"
+      set 'btmlpa.receipt.emv_app_aid' => "tmlvar:btmlpa.emv.txn_aid"
+      set 'btmlpa.receipt.emv_app_label' => "tmlvar:btmlpa.emv.txn_app"
+    end
+  
+    # call the card removal screen
+    screen :rcpt_emv2, :next => url_for(:action => 'index', :anchor => :remove_card, :only_path => true) do
+      set :screen_after_call, :to => url_for(params.merge({ :anchor => :rcpt_emv3, :only_path => true }))
+    end
+  
+    # check if the signature is necessary
+    screen :rcpt_emv3, :next => :rcpt_mrch do
+      next_screen :rcpt_sig, :if => "tmlvar:btmlpa.signature_check == 1"
+    end
+    # end EMV-specific screens
+  
+    # sets the variables that are printed for mag and manual entry transactions
+    screen :rcpt_mag_man, :next => :rcpt_mrch do
+      set 'btmlpa.receipt.header' => ["tmlvar:btmlpa.receipt.header", "+", " MAG"]
+      set ['btmlpa.receipt.authorization', 'btmlpa.receipt.emv_app_aid', 'btmlpa.receipt.emv_app_label'], :to => ""
+      set 'btmlpa.signature_check' => 1
+      next_screen :rcpt_sig, :if => "tmlvar:btmlpa.signature_check != 0"
+    end
+  
+    # sets the variables for the signature check
+    screen :rcpt_sig, :next => :rcpt_print do
+      set 'btmlpa.receipt.target_screen' => url_for(:action => 'index', :anchor => :sign_check, :only_path => true)
+      set 'btmlpa.receipt.signature' => "Please sign:"
+      set 'btmlpa.receipt.footr' => ""
+      set 'btmlpa.signature_check' => 0
+    end
+  
+    # sets the variables for the merchant copy where signature check is not required
+    screen :rcpt_mrch, :next => :rcpt_print do
+      set 'btmlpa.receipt.pan_format' => "n4n#*n4"
+      set 'btmlpa.receipt.target_screen' => "#rcpt_cust"
+      set 'btmlpa.receipt.signature' => ""
+      set 'btmlpa.receipt.footr' => "Merchant Copy"
+    end
+  
+    # sets the variables for the customer copy
+    screen :rcpt_cust, :next => :rcpt_print do
+      set 'btmlpa.receipt.pan_format' => "n4n#*n4"
+      set 'btmlpa.receipt.target_screen' => url_for(:action => 'index', :anchor => :compl_txn, :only_path => true)
+      set 'btmlpa.receipt.signature' => ""
+      set 'btmlpa.receipt.footr' => "Customer Copy"
+      set 'btmlpa.signature_check' => 0
+      set 'btmlpa.dupl_available' => 1
+    end
+  
+    # prepare for the duplicate receipt
+    # it will be identical to the previously printed customer copy
+    screen :rcpt_duplct, :next => :rcpt_print do
+      set 'btmlpa.receipt.target_screen', :to => url_for(:action => 'index', :only_path => true)
+    end
+  
+    # print the reciept
+    screen :rcpt_print, :next => "tmlvar:btmlpa.receipt.target_screen" do
+      concat :partial => 'receipt'
+    end
+  
+    # handling of some common printing errors
+    screen :error_scr, :next => url_for(:action => 'index', :anchor => :error_scr, :only_path => true) do
+      variants "tmlvar:err.code.high == -32921" => :error_paper,
+               "tmlvar:err.code.low  == -32921" => :error_paper
+    end
+  
+    screen :error_paper, :next => @assert do
+      next_screen :rcpt_print, :key => :enter
+      next_screen url_for(:action => "index", :anchor => :trans_abrt, :only_path => true), :key => :cancel
+      next_screen :error_paper, :key => :any
+      layout controller.tml_layout
+      display
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/app/helpers/rtml/rtml_app_helper.rb

@@ -0,0 +1,74 @@
+require 'net/http'
+require 'uri'
+
+module Rtml
+  # NOTE: This file is included into both RTMLAppController and any Views!
+  module RtmlAppHelper
+    include Rtml::Helpers::ControllerHelpers::MenuHelpers
+    
+    def connected_to_berylapp?
+      return @connected_to_berylapp unless @connected_to_berylapp.nil?
+      Net::HTTP.new("www.berylapp.com", 80).head("/")
+      @connected_to_berylapp = true
+    rescue SocketError
+      @connected_to_berylapp = false
+    end
+
+    def get_uml_image_data(graph_data)
+      data = { :data => graph_data.join(";"),
+               :tred => params[:tred] || false,
+               :rankdir => params[:rankdir] || 'LR' }
+      res = Net::HTTP.post_form(URI.parse('http://www.berylapp.com/graph/generate'), data)
+      res.body
+    end
+    
+    def uml_conditions_for(cond)
+      #return "" # due to URI length issues. Can go away after logic is moved to RTML core.
+      if cond.blank?
+        cond = ""
+      else
+        lo = ((cond =~ /lo="(.*?)"/) ? $~[1] : "")
+        op = ((cond =~ /op="(.*?)"/) ? $~[1] : "")
+        ro = ((cond =~ /ro="(.*?)"/) ? $~[1] : "")
+        key = ((cond =~ /key="(.*?)"/) ? $~[1] : "")
+        
+        lo = 'empty' if lo.blank?
+        ro = 'empty' if ro.blank?
+        
+        if key.blank? then cond = "#{lo} #{op} #{ro}"
+        else cond = key
+        end
+      
+        
+      end
+      #raise cond unless cond.blank?
+      format_for_uml(cond)
+    end
+    
+    def uml_for_screen(screen)
+      if screen.kind_of? String or screen.kind_of? Symbol
+        ret = "#{format_for_uml(screen)}\\nExternal Reference"
+      else
+        widgets = widgets_for_screen(screen).join(";")
+        ret = ''
+        ret.concat format_for_uml(screen.id)
+        ret.concat "\\n"
+        ret.concat format_for_uml(widgets)
+      end
+      
+      ret
+    end
+    
+    def format_for_uml(text)
+      #CGI::escape text.to_s
+      text.to_s
+    end
+    
+    def widgets_for_screen(screen)
+      return [] if screen.nil?
+      screen.widgets.collect do |widget|
+        widget.class.name.gsub(/^Rtml::Widgets::(.*)Widget$/, '\1').underscore.humanize
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/app/helpers/rtml/rtml_app_tml_helpers/common.rb

@@ -0,0 +1,9 @@
+Rtml::actions_for Rtml::RtmlAppController do
+  # Used to build the default list of menu items. Override this in your controller,
+  # preferably in the tml_helpers/common.rb file, but you should always call super
+  # first.
+  def build_menu
+  end
+
+  hide_action :build_menu
+end

data/app_generators/rtml/templates/rtml/app/helpers/rtml/tml_app_helper.rb

@@ -0,0 +1,43 @@
+module Rtml
+  module TmlAppHelper
+    include Rtml
+    include Rtml::Helpers::RenderHelper
+    include Rtml::Helpers::TerminalHelpers
+
+    # Returns the state hash for the terminal or browser. Proxies into TmlAppController#state.
+    def state
+      controller.send :state
+    end
+    
+    # Overrides the Rails default form_for method to produce a TML-compatible form.
+    # Does not affect non-RTML based controllers.
+    def form_for(record_or_name_or_array, *args, &proc)
+      record_or_name_or_array = "" if record_or_name_or_array.nil?
+      if request.format == :rtml
+        raise ArgumentError, "Missing block" unless block_given?
+        @tml_variables_for_submit = []
+        options = args.extract_options!.reverse_merge(:builder => Rtml::Helpers::ViewHelpers::RtmlFormBuilder)
+        case record_or_name_or_array
+          when String, Symbol
+            object_name = record_or_name_or_array
+          when Array
+            object = record_or_name_or_array.last
+            object_name = ActionController::RecordIdentifier.singular_class_name(object)
+            apply_form_for_options!(record_or_name_or_array, options)
+            args.unshift object
+          else
+            object = record_or_name_or_array
+            object_name = ActionController::RecordIdentifier.singular_class_name(object)
+            apply_form_for_options!([object], options)
+            args.unshift object
+        end
+        
+        concat "<form><div>"
+        fields_for(object_name, *(args << options), &proc)
+        concat "</div></form>"
+      else
+        super(record_or_name_or_array, *args, &proc)
+      end
+    end
+  end
+end