rtml 1.2.2

data/app_generators/rtml/templates/rtml/components/rtml/widgets/display_widget.rb

@@ -0,0 +1,66 @@
+module Rtml
+  module Widgets
+    # Renders a "display" tag. Only accessible from within a Screen
+    # object. If a Block is given, its return value is used for the content.
+    # Otherwise, the options hash is passed into WidgetSupport#content_of_view
+    # and whatever it returns is used for the content. The content is then laid out
+    # if a layout has been supplied, and wrapped in a <display> tag.
+    #
+    # Examples:
+    #   def index
+    #     screen :main_menu do
+    #       display # overridden for Screen to produce <display> tags around the View
+    #     end
+    #
+    #     screen :error_scr do
+    #       display "error occurred"
+    #     end
+    #
+    #     screen :welcome_scr do
+    #       display do
+    #         # return value will be wrapped in <display> and laid out.
+    #         if current_user then "Welcome, #{current_user.name}!"
+    #         else "You must be logged in."
+    #         end
+    #       endif
+    #     end
+    #
+    #     . . .
+    #
+    #   end
+    #
+    class DisplayWidget < Rtml::Widgets::Widget
+      silence_accessor_failures!
+      accessor Screen
+      accessor_alias :display
+      
+      def initialize(*a, &b) #:nodoc:
+        super(*a)
+        parent.widgets.each do |wi|
+          parent.widgets.delete wi if wi.kind_of? DisplayWidget and wi != self
+        end
+        @block_value = yield_with_optional_param(self, &b) if block_given?
+      end
+      
+      def self.assign_properties? #:nodoc:
+        false
+      end
+      
+      # rtml builds a widget calling to_tml with a block from render_tml. When
+      # render_tml doesn't exist, it falls back to to_tml without a block, and
+      # failing that it'll just call to_s on the object.
+      undef render_tml
+
+      def init_properties #:nodoc:
+      end
+
+      def to_tml(&b) #:nodoc:
+        if arguments.empty? and @block_value then c = content_of_view(@block_value)
+        else c = content_of_view(*arguments, &b).to_s
+        end
+        r = ((layout.nil? or layout == false) ? c : (layout.to_tml { c.indent })).to_s.indent
+        concat "<display>\n\t#{r}\n</display>"
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/components/rtml/widgets/element_builder_widget.rb

@@ -0,0 +1,123 @@
+module Rtml
+  module Widgets
+    # The Element Builder Widget is designed to help alleviate the sheer amount of typing necessary
+    # for developing raw TML. If you need to insert TML and don't have any RTML Widgets to fill the
+    # void, or if you're in the process of building an RTML Widget and are ready to build some actual
+    # TML without using Strings, you can take advantage of the Element Builder to keep your code pretty
+    # and easy to maintain.
+    #
+    # Examples:
+    #   This is an example of building a magnetic card reader with a prompt using Strings:
+    #     doc.concat <<-end_tml
+    #       <tform>
+    #         <baddata>
+    #           <getvar name=”err.baddata_reason” />
+    #         </baddata>
+    #         <card parser=”mag” parser_params=”read_data” />
+    #         <prompt>
+    #           Please Swipe Card.
+    #         </prompt>
+    #       </tform>
+    #     end_tml
+    #   
+    #   And this is the same example using Element Builder:
+    #     build :tform do
+    #       baddata { getvar :name => 'err.baddata_reason' }
+    #       prompt "Please swipe card."
+    #       card :parser => 'mag', :parser_params => 'read_data'
+    #     end
+    #
+    #   If the same example were using Views...
+    #
+    #     build :tform do
+    #       baddata { display :file => 'common/card_data_error' }
+    #       prompt { display }
+    #       card :parser => 'mag', :parser_params => 'read_data'
+    #     end
+    #
+    # ElementBuilder will help you keep ugly TML out of your application, and helps a little
+    # bit with DRYing it up -- but you'll want to design Widgets around it because if, for 
+    # example, you need a second Card Swipe prompt, you'd need to retype the above.
+    #
+    # Note that if you need to construct a TML tag that is also a valid method or Widget
+    # reference, you can do that by just adding another build element with the ambiguous name
+    # as the first (or only) argument:
+    #
+    #   build :display do
+    #     . . .
+    #   end
+    #
+    class ElementBuilderWidget < Rtml::Widgets::Widget
+      # Stores the key-value pairs for this element. You don't need to directly reference this.
+      property :attributes
+      # Stores the name of this element. You don't need to directly reference this.
+      property :name
+      accessor TMLDocument, Screen, Widget
+      accessor_alias :element_builder, :build
+      # If true, any attributes that have no content will not be added to the element.
+      # Defaults to false.
+      attr_accessor :drop_empty_attributes
+
+      def layout(*a, &b) parent.layout *a, &b end
+
+      def respond_to?(name) #:nodoc:
+        super or parent.respond_to? name
+      end
+      
+      def init_properties
+        attributes({})
+        name arguments.first
+      end
+        
+      def initialize(parent, *a, &b) #:nodoc:
+        super parent, &b
+        if a.length > 0
+          name a[0] if a[0].kind_of? Symbol or a[0].kind_of? String
+        end
+        a.each do |p|
+          if p.kind_of? Hash
+            if p[:name] and name.nil?
+              name p[:name]
+              p.delete :name
+            end
+            attributes.merge! p
+          end
+        end
+        attributes.each { |a,b| attributes[a] = b.to_screen_ref if a == 'next' || a == 'next_screen' }
+      end
+      
+      def method_missing(name, *args, &blk) #:nodoc:
+        return parent.send(name, *args, &blk) if parent.respond_to? name and not self.is_accessor? name
+        r = self.build name, *args, &blk
+        r.drop_empty_attributes = self.drop_empty_attributes
+        r
+      end
+      
+      def to_tml #:nodoc:
+        front = back = ""
+        inner = render_widget_tml
+        inner = block_value.to_s if inner.blank?
+        inner.strip!
+        if name.nil?
+          inner
+        else
+          front = "<#{name}"
+          attrs = {}
+          attributes.each { |k,v| attrs[k] = v unless drop_empty_attributes and v.blank? }
+          attrs = ((attrs.respond_to? :to_xml_params) ? attrs.to_xml_params : attrs.to_s)
+          front.concat " #{attrs}" unless attrs.blank?
+          if inner.blank?
+            front.concat " />"
+            return front
+          else
+            front.concat ">"
+            back = "</#{name}>"
+            front + "\n" +
+              inner.indent + "\n" +
+            back
+          end
+        end
+      end
+    end
+  end
+end

data/app_generators/rtml/templates/rtml/components/rtml/widgets/emv_support_widget.rb

@@ -0,0 +1,365 @@
+module Rtml
+  module Widgets
+    class EmvSupportWidget < Rtml::Widgets::Widget
+      property :swipe_card_prompt
+      property :baddata
+      property :entry_point
+      property :exit_point
+      property :on_error
+      property :on_cancel
+      property :on_abort
+      property :on_reject
+
+      accessor TMLDocument
+      accessor_alias :supports_emv
+      
+      def init_properties #:nodoc:
+        entry_point :required
+        exit_point  :required
+        on_error    'emv_error'
+        on_cancel   ((parent.default_screen.blank?) ? url_for(:action => params[:action]) : parent.default_screen)
+        on_abort    'emv_abort'
+        on_reject   'emv_reject'
+      end
+      
+      # Sets up EMV support (this must happen after initialization, but prior to rendering)
+      def after_initialize
+        build_emv_support
+      end
+      
+      # Returns the names of all TML variables defined and used by this Widget
+      def emv_variables
+        emv_string_variables + emv_integer_variables
+      end
+      
+      # Returns the names of all TML String variables defined and used by this Widget
+      def emv_string_variables
+        [:txt_cvm, :app_item, :app_sel_mode, :app, :aid, :app_status, :sep,
+         :selection_list, :selected_item, :txn_aid, :txn_app].collect { |s| "emv.#{s}" }
+      end
+      
+      # Returns the names of all TML Integer variables defined and used by this Widget
+      def emv_integer_variables
+        [:index, :count].collect { |s| "emv.#{s}" }
+      end
+      
+      def to_tml #:nodoc:
+        ''
+      end
+      
+      private
+      def build_emv_support
+        doc = parent.document
+        doc.strings emv_string_variables
+        doc.integers emv_integer_variables
+        doc.screen entry_point, :emv_chk_apps
+        
+        # Copy an application into the list of applications to be displayed
+        doc.concat <<-end_tml
+          <screen id="emv_copy_app" next="#emv_copyapp2">
+            <setvar name="emv.app" lo="tmlvar:card.emv.app_list" op="item" ro="tmlvar:emv.index" />
+            <strtemplate name="emv.app_item" format="%1%2: %3">
+              <getvar name="emv.sep" />
+              <getvar name="emv.index" format="^00" />
+              <getvar name="emv.app" />
+            </strtemplate>
+          </screen>
+        end_tml
+        
+        doc.screen :emv_error, doc.default_screen do |scr|
+          scr.display " EMV ERROR: #{data_dump}"
+        end
+        
+        doc.screen :emv_abort, doc.default_screen  do |scr| scr.display " TRANSACTION ABORTED " end
+        doc.screen :emv_reject, doc.default_screen do |scr| scr.display " TRANSACTION REJECTED " end
+        
+        # If card requires cardholder confirmation, display the list
+        # else, check if there are several applications or only a single one
+        doc.screen :emv_chk_apps do |scr|
+          scr.set 'emv.count', :lo => 'tmlvar:card.emv.app_status_list', :op => 'number'
+          scr.assert :emv_app_manl, :if => 'tmlvar:card.emv.selected_app == manual'
+          scr.assert :emv_chk_mult, :if => 'tmlvar:card.emv.selected_app == '
+        end
+        
+        # Check if there are several applications or only a single one.
+        # If there are several applications, display the list for manual selection,
+        #   even if not required (best practice)
+        # If there is only a single one, try to select it automatically
+        doc.screen :emv_chk_mult, :next => :emv_app_manl do |scr|
+          scr.next_screen :emv_app_auto, :if => "tmlvar:emv.count == 1"
+        end
+        
+        # Enable automatic application selection
+        doc.screen :emv_app_auto, :next => :emv_final do |scr|
+          scr.set 'emv.txn_app', :to => "tmlvar:card.emv.app_list"
+          scr.set 'emv.app_sel_mode', :to => "auto"
+          scr.set "card.emv.selected_app", :to => ""
+        end
+        
+        # Enable cardholder manual application selection
+        doc.screen :emv_app_manl, :timeout => 1 do |scr|
+          scr.set 'emv.app_sel_mode', :to => 'manual'
+          scr.assert :emv_prep_lst, :if => ['card.emv.app_list', '!=', '']
+        end
+        
+        # Build an application list for user selection
+        doc.screen :emv_prep_lst do |scr|
+          scr.set [ 'emv.sep', 'card.emv.app_list', 'card.emv.aid_list', 'emv.selection_list' ], :to => ''
+          scr.set 'emv.index' => 0
+          scr.set 'emv.count', :lo => 'tmlvar:card.emv.app_status_list', :op => 'number'
+          scr.assert :emv_chk_stat, :if => "tmlvar:emv.count >= 0"
+        end
+        
+        # Copy the active applications into the list to be displayed; inactive apps are skipped.
+        doc.screen :emv_chk_stat do |scr|
+          scr.set 'emv.app_status' => %W"tmlvar:card.emv.app_status_list item tmlvar:emv.index"
+          scr.assert :emv_copy_app, :if => 'tmlvar:emv.app_status == active'
+          scr.assert :emv_loop_app, :if => 'tmlvar:emv.app_status == inactive'
+        end
+        
+        doc.screen :emv_copyapp2, :next => :emv_loop_app do |scr|
+          scr.set 'emv.selection_list' => 'tmlvar:emv.selection_list + tmlvar:emv.app_item'
+          scr.set 'emv.app' => 'tmlvar:emv.sep + tmlvar:emv.app'
+          scr.set 'card.emv.app_list' => 'tmlvar:card.emv.app_list + tmlvar:emv.app'
+          scr.set 'emv.aid' => %W'tmlvar:card.emv.aid_list item tmlvar:emv.index'
+          scr.set 'emv.aid' => 'tmlvar:emv.sep + tmlvar:emv.aid'
+          scr.set 'card.emv.aid_list' => 'tmlvar:card.emv.aid_list + tmlvar:emv.aid'
+          scr.set 'emv.sep' => ';'
+        end
+        
+        # Increment the index for the app status check process
+        doc.screen :emv_loop_app, :next => :emv_chk_stat do |scr|
+          scr.set 'emv.index' => 'tmlvar:emv.index + 1'
+          scr.next_screen :emv_sel_1st, :if => 'tmlvar:emv.index == tmlvar:emv.count'
+        end
+        
+        # Check whether the list of available apps is empty or not
+        doc.screen :emv_sel_1st, :next => :emv_rej_noap do |scr|
+          scr.set 'emv.count', :lo => 'tmlvar:card.emv.app_list', :op => 'number'
+          scr.next_screen :emv_show_lst, :if => 'tmlvar:emv.count >= 0'
+        end
+        
+        # If no applications are active, abort the transaction
+        doc.screen :emv_rej_noap, :next => on_reject do |scr|
+          scr.display "All applications are inactive.<br/>Transaction will be rejected."
+        end
+        
+        # Show the list of available applications for cardholder selection
+        doc.screen :emv_show_lst, :on_cancel => on_cancel do |scr|
+          scr.set 'emv.selected_item' => %W"tmlvar:emv.selection_list item 0"
+          scr.assert :emv_sel_aid1, :if => ["tmlvar:emv.selected_item","!=",""]
+          scr.display <<-end_tml
+            <form>
+              <div class="title"><span class="title">Select ICC Application:</span></div>
+              <div class="menu">
+                <input type="list" name="emv.selected_item"
+                                   value="tmlvar:emv.selection_list"
+                                   rows="4" width="100%" multiple="no" />
+              </div>
+            </form>
+          end_tml
+        end
+        
+        # Based on cardholder selection, fill the card.emv.selected_aid variable
+        doc.screen :emv_sel_aid1, :on_cancel => on_cancel, :timeout => 1 do |scr|
+          scr.set 'emv.selected_item', :lo => "tmlvar:emv.selected_item", :op => :format, :format => :nn
+          scr.set 'emv.index' => "tmlvar:emv.selected_item"
+          scr.set "card.emv.selected_app" => ""
+          scr.set "card.emv.selected_aid" => %W(tmlvar:card.emv.aid_list item tmlvar:emv.index)
+          scr.set "emv.txn_aid" => "tmlvar:card.emv.selected_aid"
+          scr.set "emv.txn_app" => %W"tmlvar:card.emv.app_list item tmlvar:emv.index"
+          scr.assert :emv_final, :if => ["tmlvar:card.emv.selected_aid", "!=", ""]
+        end
+        
+        # Final application selection and initialization after application auto/manual choice
+        doc.screen :emv_final, :next => :emv_chk_resl do |scr|
+          scr.card :parser => :icc_emv, :params => :final_select do |p|
+            p.baddata "EMV Failure during Final Select: #{data_dump}" do |b|
+              b.max 1
+              b.next_screen on_abort
+            end
+          end
+        end
+        
+        # Ensure the final selection was OK. If not, the application list will be re-displayed
+        # If application selection was OK, go to PIN check
+        # Else, try to select another one
+        doc.screen :emv_chk_resl, :next => :emv_get_cvm do |scr|
+          scr.next :emv_dsp_sfld, :if => "tmlvar:err.code.low == -32817"
+          scr.next :emv_dsp_sfld, :if => "tmlvar:err.code.low == -4380"
+        end
+        
+        # Can be used to safely cancel an EMV transaction. Not normally required.
+        doc.screen :emv_cncltran, :next => :emv_dspcncl do |scr|
+          scr.card :parser => :icc_emv, :params => :cancel do |c|
+            c.baddata "<getvar name='err.baddata_reason' />", :max => 1, :next => on_abort
+          end
+        end
+        
+        doc.screen :emv_dspcncl, :next => on_cancel do |scr|
+          scr.display %Q`The transaction has been canceled.<br/>
+            Cardholder name: <getvar name='card.cardholder_name' /><br/>
+            AAC: <getvar name='card.emv.aac' />`
+        end
+        
+        # If final application selection failed, prompt the cardholder for another
+        # application selection if a list was previously displayed
+        doc.screen :emv_dsp_sfld, :next => :emv_app_auto do |scr|
+          scr.next_screen :emv_app_manl, :if => "tmlvar:emv.app_sel_mode == manual"
+          scr.display "EMV Failure during Application Selection:#{data_dump}<br/>" +
+                  "app: <getvar name='card.emv.app_list' /><br/>" +
+                  "status: <getvar name='card.emv.app_status_list' /><br/>"
+        end
+        
+        # analyzes card verification method
+        doc.screen :emv_get_cvm, :next => :emv_chksign do |scr|
+          scr.card :parser => :icc_emv, :params => :get_cvm do |c|
+            c.baddata "EMV Failure during Card Verification: #{data_dump}" do |b|
+              b.max 1
+              b.next_screen on_abort
+            end
+          end
+        end
+        
+        doc.screen :emv_chksign, :next => :emv_chkcvm do |scr|
+          scr.set 'emv.txt_cvm' => ''
+          scr.next_screen :emv_set_sign, :if => "tmlvar:card.emv.signature == 1"
+        end
+        
+        doc.screen :emv_set_sign, :next => :emv_chkcvm do |scr|
+          scr.set 'emv.txt_cvm' => " + SIGNATURE"
+        end
+        
+        doc.screen :emv_chkcvm do |scr|
+          scr.assert
+          scr.variants "tmlvar:card.parser.verdict == reject" => on_reject,
+                       "tmlvar:card.parser.cvm == pin" => :emv_pin,
+                       "tmlvar:card.parser.cvm == pin_online" => :emv_skip_cvm,
+                       "tmlvar:card.parser.cvm == no_cv" => :emv_cv_no_cv,
+                       "tmlvar:card.parser.cvm == " => :emv_rsk_mgmt
+        end
+        
+        doc.screen :emv_cv_no_cv, :next => :emv_get_cvm, :timeout => 1 do |scr|
+          scr.set 'card.parser.cvr', :to => 'ok'
+          scr.display "NO CVM <getvar name='emv.txt_cvm' />"
+        end
+        
+        doc.screen :emv_skip_cvm, :emv_get_cvm do |scr| scr.set 'card.parser.cvr' => :bypassed end
+        
+        doc.screen :emv_pin, :on_cancel => :emv_no_pin, :assert => nil do |scr|
+          scr.variants "tmlvar:card.emv.last_attempt == 0" => :emv_enterpin,
+                   "tmlvar:card.emv.last_attempt == 1" => :emv_pin_last
+        end
+        
+        doc.screen :emv_enterpin, :on_cancel => :emv_no_pin, :next => :emv_chk_pin do |scr|
+          scr.concat(%Q`
+            <tform>
+              <baddata max='1' next='#{on_abort}'>
+                #{(layout ? (layout.to_tml { "<getvar name='err.baddata_reason'/>" }) : "<getvar name='err.baddata_reason'/>")}
+              </baddata>
+              <!--calls SSA for secure PIN entry-->
+              <pinentry type='icc' prompt='Enter PIN' />
+            </tform>
+          `) #/
+        end
+        
+        doc.screen :emv_no_pin, :emv_get_cvm do |scr| scr.set "card.parser.cvr" => "failed" end
+        doc.screen :emv_pin_last, :timeout => 3, :on_cancel => :emv_no_pin, :next => :emv_enterpin do |scr|
+          display "Last Try."
+        end
+        
+        # Verify PIN
+        doc.screen :emv_chk_pin, :assert do |scr|
+          scr.variants "tmlvar:card.parser.verdict == reject" => on_reject,
+                       "tmlvar:card.parser.cvr == ok" => :emv_get_cvm,
+                       "tmlvar:card.parser.cvr == ok_msg" => :emv_pin_ok,
+                       "tmlvar:card.parser.cvr == failed" => :emv_pin_bad,
+                       "tmlvar:card.parser.cvr == pin_tries" => :emv_pin_bad
+          scr.card :parser => :icc_emv, :params => :verify do |p|
+            p.baddata '<getvar name="err.baddata_reason" />' do |b|
+              b.max 1
+              b.next_screen on_abort
+            end
+          end
+        end
+        
+        # Notifies user that s/he has entered correct PIN
+        doc.screen :emv_pin_ok, :next => :emv_get_cvm, :on_cancel => :emv_get_cvm do end
+        # Notifies user that s/he has entered incorrect PIN
+        doc.screen :emv_pin_bad, :timeout => 1, :on_cancel => :emv_get_cvm, :next => :assert do |scr|
+          scr.variants "tmlvar:card.parser.cvr == failed" => :emv_pin,
+                       "tmlvar:card.parser.cvr == pin_tries" => :emv_get_cvm
+          scr.display "Incorrect PIN"
+        end
+        
+        # Performs risk management.
+        # The "icc_emv" parser will:
+        #   1. Analyze amount and transaction type;
+        #   2. Analyze previous submission attempt ("oebr.econn" value);
+        #   3. Update "card.parser.verdict" variable;
+        #   4. Fill "card.parser.reject_reason" variable, if necessary.
+        doc.screen :emv_rsk_mgmt, :emv_verdict do |scr|
+          scr.set "emv.txn_aid" => "tmlvar:card.emv.aid"
+          scr.card :parser => :icc_emv, :params => :risk_mgmt do |c|
+            c.baddata "EMV Failure during Risk Management: #{data_dump}" do |b|
+              b.max 1
+              b.next_screen on_abort
+            end
+          end
+        end
+        
+        doc.screen :emv_verdict, :assert do |scr|
+          scr.set 'oebr.submit_mode' => 'tmlvar:card.parser.verdict'
+          scr.variants "tmlvar:card.parser.verdict == reject" => :emv_off_rej,
+                   "tmlvar:card.parser.verdict == offline" => :emv_off_comp,
+                   "tmlvar:card.parser.verdict == online" => :emv_submit
+        end
+        
+        doc.screen :emv_off_rej, :next => on_abort, :timeout => 1 do |scr| scr.display " REJECTED " end
+        doc.screen :emv_off_comp, :next => :emv_submit, :timeout => 1 do |scr| scr.display " TRANSACTION PROCESSED OFFLINE " end
+        
+        # Submits transaction data to host
+        doc.screen :emv_submit, exit_point do |scr| end
+          
+          
+#        doc.screen :emv_submit, on_error do |scr|
+#          scr.set 'card.expiry_date' => '2010/12/31',
+#                  'oebr.submit_mode' => 'tmlvar:card.parser.verdict'
+#          scr.submit :target => submit_to, :on_error => :emv_sub_fail do |sub|
+#            sub.get_variables :transid
+#          end
+#        end
+        
+        # Host is unreachable
+#        doc.screen :emv_sub_fail, :assert do
+#          variants "tmlvar:oebr.submit_mode == online" => :emv_fld_onln,
+#                   "tmlvar:oebr.submit_mode == offline"=> :emv_fld_ofln
+#        end
+        
+#        doc.screen :emv_fld_onln, :next => :emv_rsk_mgmt, :timeout => 2 do |scr| scr.display " HOST IS UNREACHABLE " end
+#        doc.screen :emv_fld_ofln, :next => :emv_off_rej, :timeout => 2 do |scr|
+#          scr.display " OFFLINE TRANSACTION POOL IS FULL "
+#        end
+        
+#        doc.screen :emv_tc_aac, :on_cancel => on_cancel, :next => void do |scr|
+#          scr.set 'oebr.submit_mode' => 'offline'
+#          scr.next_screen receipt, :if => 'tmlvar:card.emv.tc != '
+#          scr.submit :target => auth_icc_2, :on_error => exit_point do |sub|
+#            sub.get_variables 'card.emv.aac', 'card.emv.tc', 'transid'
+#          end
+#        end
+      end
+      
+#      def auth_icc_2
+#        url_for(:action => "auth_icc_2")
+#      end
+      
+      def data_dump
+        %Q`<getvar name="err.baddata_reason" /><br/><br/>
+           err.high = <getvar name="err.code.high" /><br/>
+           err.low  = <getvar name="err.code.low"  /><br/>
+           card.emv.apdu_list: <getvar name="card.emv.apdu_list" />`
+      end
+    end
+  end
+end