a4tools 1.2.7

data/lib/clients/deployment_client.rb

@@ -0,0 +1,53 @@
+module A4Tools
+  class DeploymentClient < CachingClient
+    attr_accessor :cache_timeout
+
+    cache :buildList, :authenticate => true do
+      {
+        allowedAppIds:nil,
+        allowedCommitIds:nil
+      }
+    end
+
+    query :buildPublicationList, :authenticate => true do |site_id|
+      {
+        siteId:site_id
+      }
+    end
+
+    def publish_build(build, sites)
+      sites = [*sites]
+      return false unless authenticate_if_needed
+
+      request = {
+        commitId:build[:commitId],
+        appIds:[build[:appId]],
+        publicationTime:0,
+        siteIds:sites
+      }
+
+      result = send_message(wrapped_message("buildPublish", "com.acres4.common.info.build.BuildPublishRequest", request))
+      return false unless result.code.to_i >= 200 and result.code.to_i < 300
+
+      true
+    end
+
+    def index_list_by_app
+      builds = cache(:buildList)
+      apps = {}
+      builds.each do |build|
+        apps[build[:appId]] ||= []
+        apps[build[:appId]].push build
+      end
+
+      apps.values.each { |app_builds| app_builds.sort! { |a,b| a[:postDate] <=> b[:postDate] } }
+      apps
+    end
+
+    def builds_for_milestone(milestone, builds=nil)
+      index = index_list_by_app(builds)
+      in_milestone = []
+      (index.map { |app, builds| (builds.select { |b| b[:branches].is_a? Array and b[:branches].include? milestone }).last }).compact
+    end
+  end
+end

data/lib/clients/kai_config_client.rb

@@ -0,0 +1,39 @@
+module A4Tools
+  class KaiConfigClient < CachingClient
+    attr_accessor :cache_timeout
+
+    #cache :getConfigWebVersion, :authenticate => true
+
+    query :configValueRequest, :authenticate => true do |id_config|
+      {
+        idConfig:id_config
+      }
+    end
+
+    def strip_wrapper(result)
+      body = result[:configValueWrappers][0][:wrappedConfigValues][0][:body]
+      body[:__class] = result[:configValueWrappers][0][:wrappedConfigValues][0][:className]
+      body
+    end
+
+    def site_version
+      response_body(send_message(empty_query(:getConfigWebVersion)))[:stringValue] rescue nil
+    end
+
+    def section_bank_info
+      strip_wrapper(query(:configValueRequest, talk["SECTION_BANK_LOCATION_VALUES"]))
+    end
+
+    def machines
+      (section_bank_info[:locations].map { |loc| loc[:location] })
+    end
+
+    def sections
+      (section_bank_info[:sections].map { |sect| sect[:sectionName] })
+    end
+
+    def banks
+      (section_bank_info[:banks].map { |bank| bank[:bankName] })
+    end
+  end
+end

data/lib/clients/usher_client.rb

@@ -0,0 +1,72 @@
+module A4Tools
+  class UsherClient < AcresClient
+    class << self
+      def mirrors
+        [
+          "http://s01.ushers.acres4.net:8080/usher2/json?wrap",
+          "http://s02.ushers.acres4.net:8080/usher2/json?wrap",
+          "http://s03.ushers.acres4.net:8080/usher2/json?wrap"
+        ]
+      end
+
+      def random_mirror
+        _m = mirrors
+        _m[rand(_m.length)]
+      end
+    end
+
+    attr_reader :response
+
+    def initialize(uri=nil)
+      super(uri || self.class.random_mirror)
+    end
+
+    def usher_request_for_params(params)
+      request = {
+        app: app_info,
+        device: device_info
+      }
+
+      request[:device][:serialNumber] = params[:serial] if params.has_key?(:serial)
+      request[:ipOverride] = params[:ip] if params.has_key?(:ip)
+
+      request
+    end
+
+    def list_servers_raw(params={})
+      response = send_message(wrapped_message(params[:full] ? "usherAlt" : "usher", "com.acres4.common.info.usher.UsherRequest", usher_request_for_params(params)))
+      @list = response_body response
+      response
+    end
+
+    def list_servers(params={})
+      list_servers_raw
+      @list
+    end
+
+    def dump_usher_response(response=nil)
+      response ||= @list
+      s = "Site #{response['siteID']} (#{response['siteName']})\n"
+
+      response[:hosts].each do |host|
+        s += "\t#{host["product"]}, #{host["url"]}#{host["context"]}\n"
+      end
+      s += "\n"
+    end
+
+    def locate_service(service, response=nil)
+      list_servers unless @list
+      response ||= @list
+
+      products = response[:hosts].select do |h|
+        h[:product].match("^#{service}(-(Secure|Server))?$")
+      end
+
+      products.sort! do |h,o|
+        h[:product] <=> o[:product]
+      end
+
+      products.first
+    end
+  end
+end

data/lib/clients/usher_mgmt_client.rb

@@ -0,0 +1,201 @@
+require 'pp'
+
+module A4Tools
+  class UsherMgmtClient < CachingClient
+    attr_accessor :cache_timeout
+    def initialize(destination, username, password, timeout=300)
+      super(destination || "https://usherm.acres4.net:8181/usher2/json", username, password, timeout)
+    end
+
+    cache :usherSystemId
+    cache :devSiteInfoSync
+    cache :usherInfo, :authenticate => true do
+      {
+        force:false,
+        crc:nil
+      }
+    end
+
+    def find_device_in_info(serial, site_info_list=nil, sync=false)
+      if site_info_list.nil? then
+        site_info_list = cache(:devSiteInfoSync, sync)
+        return nil if site_info_list.nil?
+      end
+
+      site_info_list ||= @site_info_list
+
+      site_info_list[:devSiteInfoArray].each do |info|
+        return info if info[:serialNumber] == serial
+      end
+
+      nil
+    end
+
+    def make_device(serial, description, site)
+      {
+        idDevSiteInfo: 0,
+        serialNumber: serial,
+        description: description,
+        idSite: site,
+        __class: "com.acres4.common.info.usher.DevSiteInfo"
+      }
+    end
+
+    def make_edit_for_device(device)
+      {
+        editObj: {
+          className:"com.acres4.common.info.usher.DevSiteInfo",
+          body:device
+        },
+        tok:@token
+      }
+    end
+
+    def update_device(serial, description, site, default_description="Added via API")
+      return nil unless authenticate_if_needed
+      device = find_device_in_info(serial) || make_device(serial, description || default_description, site)
+      device[:description] = description unless description.nil?
+      device[:idSite] = site
+
+      result = send_message(jsonrpc_message("usherEdit", nil, "com.acres4.common.info.usher.UsherEditRequest", make_edit_for_device(device)))
+      dirty
+      response_body(result)
+    end
+
+    def delete_device(serial)
+      return nil unless authenticate_if_needed
+      device = find_device_in_info(serial) || make_device(serial, description || default_description, site)
+      return nil if device.nil?
+      
+      device[:idDevSiteInfo] = -1 * device[:idDevSiteInfo]
+
+      result = send_message(jsonrpc_message("usherEdit", nil, "com.acres4.common.info.usher.UsherEditRequest", make_edit_for_device(device)))
+      response_body(result)
+    end
+
+    def datacenter(id, sync=false)
+      cache(:usherSystemId,sync)[:dataCenters].each { |ctr| return ctr if ctr[:idDataCenter] == id }
+      nil
+    end
+
+    def provider(id, sync=false)
+      cache(:usherSystemId,sync)[:systemProviders].each { |provider| return provider if provider[:idSystemProvider].to_i == id.to_i }
+      nil
+    end
+
+    def env_type(type)
+      case type
+      when 0
+        "Development"
+      when 1
+        "QA"
+      when 2
+        "Production"
+      else
+        "Unknown (#{type})"
+      end
+    end
+
+    def system_type(type)
+      case type
+      when -1
+        "All"
+      when -2
+        "Development"
+      when -3
+        "Production"
+      else
+        "Unknown (#{type})"
+      end
+    end
+
+    def host_named(hostname, sync=false)
+      (cache(:usherSystemId, sync)[:systemHosts].each { |host| return host if host[:hostName] == hostname }) rescue nil
+      nil
+    end
+
+    def host_with_id(host_id, sync=false)
+      (cache(:usherSystemId, sync)[:systemHosts].each { |host| return host if host[:idSystemHost] == host_id.to_i }) rescue nil
+      nil
+    end
+
+    def site_with_id(site_id, sync=false)
+      (cache(:usherSystemId, sync)[:usherSites].each { |site| return site if site[:idSite] == site_id.to_i }) rescue nil
+      nil
+    end
+
+    def site_with_name(site_name, sync=false)
+      (cache(:usherSystemId, sync)[:usherSites].each { |site| return site if site[:name] == site_name }) rescue nil
+      nil
+    end
+
+    def acls_for_host_id(id, sync=false)
+      (cache(:usherInfo, sync)[:systemAcls].select { |acl| acl[:idSystemHost] == id }) rescue nil
+    end
+
+    def service_for_id(id, sync=false)
+      (cache(:usherInfo, sync)[:services].each { |service| return service if service[:idService] == id }) rescue nil
+    end
+
+    def acl_for_service(host, name)
+      begin
+        host = host_named(host) if host.is_a? String
+        acls = acls_for_host_id(host[:idSystemHost])
+        acls.each do |acl|
+          service = service_for_id(acl[:idService])
+          return acl if service[:name] == name
+        end
+      rescue
+        host
+      end
+      nil
+    end
+
+    def providers_for_site(site_id)
+      providers = self[:usherSystemId][:systemProviders]
+      providers = providers.sort { |a,b| a[:product] <=> b[:product] }
+      providers = providers.reject { |p| p[:idSites].nil? or not p[:idSites].include?(site_id.to_i) }
+    end
+
+    def hosts_for_provider(provider)
+      internal = provider[:usherHostsInternal] || []
+      external = provider[:usherHostsExternal] || []
+      hosts = internal + external
+      secure = hosts.select { |host| host[:product] == provider[:product] + "-Secure" }
+      return hosts if secure.empty?
+      secure
+    end
+
+    def provider_for_product(site_id, product)
+      providers = providers_for_site(site_id)
+      return nil if providers.nil?
+      providers.each { |prov| return prov if prov[:product] == product }
+      nil
+    end
+
+    def url_for_provider(provider)
+      opts = hosts_for_provider(provider).map { |host| { :host => host[:host], :port => host[:port], :url => host[:url] } }
+      result = try_connection_options(opts)
+      return (result[:url] rescue nil)
+    end
+
+    def host_for_url(url)
+      url = URI(url) unless url.is_a? URI
+
+      self[:usherSystemId][:systemProviders].each do |prov|
+        hosts_for_provider(prov).each do |host|
+          return host[:hostName] if host_matches_url(host, url)
+        end
+      end
+
+      nil
+    end
+
+    def host_matches_url(host, url)
+      host_url = URI(host[:url]) rescue nil
+      return true if host_url and url.host == host_url.host and url.port == host_url.port and url.scheme == host_url.scheme
+      return true if url.host == host[:hostName] and url.port == host[:port]
+      false
+    end
+  end
+end

data/lib/event_manager.rb

@@ -0,0 +1,24 @@
+module A4Tools
+  class EventManager
+    attr_accessor :events
+
+    def initialize(events=nil)
+      events = File.read(File.join(File.dirname(__FILE__), "events.json")) if events.nil?
+      events = File.read(events) if events.is_a? String and File.exists? events
+      events = JSON.parse(events) if events.is_a? String
+
+      @events = transform_events(events)
+    end
+
+    def transform_events(events)
+      events.map do |event|
+        { code:event["code"].to_i, key:event["key"].to_sym, description:event["description"] }
+      end
+    end
+
+    def event(id)
+      @events.each { |event| return event if event[:code] == id.to_i or event[:key] == id.to_sym }
+      nil
+    end
+  end
+end

data/lib/events.json

@@ -0,0 +1 @@
+[{"code":10,"description":"Ticket printed - cashable voucher","key":"ticket_print"},{"code":20,"description":"Cash out button pressed","key":"cash_out"},{"code":30,"description":"Ticket inserted","key":"ticket_insert"},{"code":40,"description":"Ticket redeemed","key":"ticket_redeem"},{"code":50,"description":"Card removed","key":"card_remove"},{"code":70,"description":"Player card inserted","key":"card_insert_player"},{"code":80,"description":"Bill 20 inserted","key":"bill_insert_20"},{"code":90,"description":"Bill 5 inserted","key":"bill_insert_5"},{"code":100,"description":"Cash out occurred","key":"cash_out"},{"code":110,"description":"Bill 1 inserted","key":"bill_insert_1"},{"code":120,"description":"Bill acceptor bill rejected","key":"bill_reject"},{"code":130,"description":"Machine link up","key":"machine_link_up"},{"code":140,"description":"Machine link down","key":"machine_link_down"},{"code":150,"description":"Xtra Credit Played","key":"extra_credit_played"},{"code":160,"description":"Main door closed","key":"door_closed"},{"code":170,"description":"Bill 100 inserted","key":"bill_insert_100"},{"code":180,"description":"Bill 10 inserted","key":"bill_insert_10"},{"code":190,"description":"Change light off","key":"change_light_off"},{"code":200,"description":"Change light on","key":"change_light_on"},{"code":210,"description":"Illegal machine door opened","key":"door_open_illegal"},{"code":220,"description":"General tilt","key":"tilt_general"},{"code":230,"description":"Belly door closed","key":"belly_door_closed"},{"code":240,"description":"Cash box door closed","key":"cashbox_door_close"},{"code":250,"description":"Hopper Paid Progressive","key":"hopper_paid_progressive"},{"code":260,"description":"Cash box door opened","key":"cashbox_door_open"},{"code":270,"description":"Main door opened","key":"main_door_open"},{"code":280,"description":"Employee card inserted","key":"card_insert_employee"},{"code":290,"description":"Bill acceptor removed","key":"bill_acceptor_remove"},{"code":300,"description":"Bill acceptor inserted","key":"bill_acceptor_insert"},{"code":310,"description":"Belly door opened","key":"belly_door_open"},{"code":320,"description":"Printer paper low","key":"printer_paper_low"},{"code":330,"description":"Poker Bonus","key":"poker_bonus"},{"code":340,"description":"Invalid Player card inserted","key":"card_insert_invalid"},{"code":350,"description":"Totals zeroed","key":"totals_zeroed"},{"code":360,"description":"Points -> XtraCredits","key":"points_to_credit"},{"code":370,"description":"Illegal belly door open ","key":"belly_door_open_illegal"},{"code":380,"description":"Drop door closed","key":"drop_door_close"},{"code":390,"description":"Illegal drop door opened","key":"drop_door_open_illegal"},{"code":400,"description":"New Member Player card inserted","key":"card_insert_new_player"},{"code":410,"description":"Game buffer full","key":"game_buffer_full"},{"code":420,"description":"Bill 50 inserted","key":"bill_insert_50"},{"code":430,"description":"BE2 Online","key":"be2_online"},{"code":440,"description":"Bill acceptor hardware error","key":"bill_acceptor_hardware_error"},{"code":450,"description":"Printer paper out","key":"printer_paper_out"},{"code":460,"description":"BE2 Offline","key":"be2_offline"},{"code":470,"description":"Ticket rejected - rejected by","key":"ticket_reject_1"},{"code":480,"description":"Logic cage opened","key":"logiccage_open"},{"code":490,"description":"Logic cage closed","key":"logiccage_close"},{"code":500,"description":"Hot Player","key":"hot_player"},{"code":510,"description":"Display meters entered","key":"display_meters_enter"},{"code":520,"description":"Display meters exited","key":"display_meters_exit"},{"code":530,"description":"Game power on","key":"game_power_on"},{"code":540,"description":"Printer carriage jam","key":"printer_carriage_jam"},{"code":550,"description":"Game power off","key":"game_power_off"},{"code":560,"description":"Game recall","key":"game_recall"},{"code":570,"description":"Illegal cash box door opened","key":"cashbox_door_illegal"},{"code":580,"description":"Ticket rejected - amt not mult","key":"ticket_reject_2"},{"code":590,"description":"Account PIN locked","key":"account_pin_lock"},{"code":600,"description":"Time discrepancy","key":"time_discrepency"},{"code":610,"description":"Ticket rejected - redemption d","key":"ticket_reject_3"},{"code":620,"description":"Self test entered","key":"self_test_enter"},{"code":630,"description":"Self test exited","key":"self_test_exit"},{"code":640,"description":"Card PIN locked","key":"card_pin_lock"},{"code":650,"description":"OP changed","key":"op_change"},{"code":660,"description":"Printer on","key":"printer_on"},{"code":670,"description":"BE2 reset","key":"be2_reset"},{"code":680,"description":"Account PIN unlocked","key":"account_pin_unlock"},{"code":690,"description":"Printer comm error","key":"printer_comm_error"},{"code":700,"description":"Ticket rejected - timeout","key":"ticket_reject_4"},{"code":710,"description":"Power off slot door access ","key":"door_access_power_off"},{"code":720,"description":"FJP Ticket printed","key":"fjp_ticket_print"},{"code":730,"description":"Printer off","key":"printer_off"},{"code":740,"description":"Coin-in runaway limit exceeded","key":"coinin_runaway_limit"},{"code":750,"description":"Bill acceptor jam","key":"bill_acceptor_jam"},{"code":760,"description":"Handpay reset","key":"handpay_reset"},{"code":770,"description":"Power off cashbox door access ","key":"cashbox_door_open_power_off"},{"code":780,"description":"Logic cage door closed","key":"logiccage_door_close"},{"code":790,"description":"Illegal logic cage door opened","key":"logiccage_door_open_illegal"},{"code":800,"description":"FJP Handpay Ticket","key":"fjp_handpay_ticket"},{"code":820,"description":"Ticket printed - jackpot recor","key":"ticket_print_jackpot_record"},{"code":830,"description":"Drop door opened ","key":"drop_door_open"},{"code":840,"description":"Out of service","key":"out_of_service"},{"code":850,"description":"Bill acceptor full","key":"bill_acceptor_full"},{"code":860,"description":"Ticket rejected - unable to ac","key":"ticket_reject_5"},{"code":870,"description":"Device passed CRC","key":"device_passed_crc"},{"code":880,"description":"Ticket rejected - validator fa","key":"ticket_reject_6"},{"code":890,"description":"Ticket accepted/rejected","key":"ticket_accepted_rejected"},{"code":900,"description":"Activate paytable(s) ","key":"paytable_activate"},{"code":910,"description":"FJP Cancel Credit Ticket","key":"fjp_cancel_credit_ticket"},{"code":920,"description":"Reel tilt","key":"tilt_reel"},{"code":930,"description":"Abandoned Player card inserted","key":"card_insert_abandoned"},{"code":940,"description":"Ticket rejected - amt > credit","key":"ticket_reject_7"},{"code":950,"description":"XC used during session","key":"extra_credit_used_during_session"},{"code":960,"description":"Cancel credit reset","key":"cancel_credit_reset"},{"code":970,"description":"Coin test card inserted","key":"card_insert_cointest"},{"code":980,"description":"Abandoned Card","key":"abandoned_card"},{"code":990,"description":"Bonus changed","key":"bonus_changed"},{"code":1000,"description":"Ticket printed - handpay recor","key":"ticket_print_handpay_record"},{"code":1010,"description":"Reel disconnected","key":"reel_disconnected"},{"code":1020,"description":"Cancel credit pending","key":"cancel_credit_pending"},{"code":1030,"description":"Reel 3 tilt","key":"tilt_reel_3"},{"code":1040,"description":"Deactivate paytable(s) ","key":"paytable_deactivate"},{"code":1050,"description":"Ticket rejected - out of cycle","key":"ticket_reject_8"},{"code":1060,"description":"KDC node added","key":"kdc_node_add"},{"code":1070,"description":"Memory error reset","key":"memory_error_reset"},{"code":1080,"description":"KDC node removed","key":"kdc_node_remove"},{"code":1090,"description":"Reel 5 tilt","key":"tilt_reel_5"},{"code":1100,"description":"EGM removed from bonus","key":"egm_remove_from_bonus"},{"code":1110,"description":"Meter zeroed","key":"meter_zeroed"},{"code":1120,"description":"FJP Short Pay Ticket","key":"fjp_short_pay_ticket"},{"code":1140,"description":"Power off card cage access ","key":"card_cage_access_power_off"},{"code":1150,"description":"Progressive Jackpot pending W2","key":"progressive_jackpot_pending_w2"},{"code":1160,"description":"Power off drop door access ","key":"drop_door_open_power_off"},{"code":1170,"description":"Ticket rejected - bad transfer","key":"ticket_reject_9"},{"code":1180,"description":"Low battery","key":"low_battery"},{"code":1190,"description":"EGM added to bonus","key":"egm_add_to_bonus"},{"code":1200,"description":"FJP Progressive Ticket","key":"fjp_progressive_jackpot"},{"code":1210,"description":"Reel 2 tilt","key":"tilt_reel_2"},{"code":1220,"description":"Progressive Link failure","key":"progressive_link_failure"},{"code":1230,"description":"KDC node updated","key":"kdc_node_update"},{"code":1240,"description":"Card Inserted","key":"card_insert"},{"code":1250,"description":"Coin in tilt","key":"tilt_coin_in"},{"code":1260,"description":"Reel 1 tilt","key":"tilt_reel_1"},{"code":1270,"description":"Pay out reset","key":"pay_out_reset"},{"code":1280,"description":"Jackpot pending","key":"jackpot_pending"},{"code":1281,"description":"Tilt: Reel #1","key":"tilt_reel_1a"},{"code":1282,"description":"Tilt: Reel #2","key":"tilt_reel_2a"},{"code":1283,"description":"Tilt: Reel #3","key":"tilt_reel_3a"},{"code":1284,"description":"Tilt: Reel #4","key":"tilt_reel_4a"},{"code":1285,"description":"Tilt: Reel #5","key":"tilt_reel_5a"},{"code":1290,"description":"Reel 4 tilt","key":"tilt_reel_4"},{"code":1300,"description":"Node on line","key":"node_online"},{"code":1310,"description":"Enabled games or denoms changed ","key":"change_game_config"},{"code":1320,"description":"Node off line","key":"node_offline"},{"code":1330,"description":"Logic cage door opened","key":"logiccage_door_open"},{"code":1340,"description":"Unknown handpay","key":"unknown_handpay"},{"code":1350,"description":"Logic cage ram error data recovered","key":"logiccage_ram_error_recover"},{"code":1360,"description":"Eprom data error","key":"eprom_data_error"},{"code":1370,"description":"Device passed SHA","key":"device_passed_sha"},{"code":1380,"description":"Hopper full","key":"hopper_full"},{"code":1390,"description":"No response to SHA challenge","key":"sha_no_response"},{"code":1400,"description":"Bill acceptor bill reversed","key":"bill_acceptor_bill_reverse"},{"code":1410,"description":"Reverse coin in","key":"coin_in_reverse"},{"code":1420,"description":"BE2 door opened","key":"be2_door_open"},{"code":1430,"description":"Logic cage ram error data lost","key":"logiccage_ram_error_lost"},{"code":1440,"description":"Ticket rejected - number doesn","key":"ticket_reject_10"},{"code":1450,"description":"Cashout Ticket Printed","key":"ticket_print_cashout"},{"code":1460,"description":"PEprom bad checksum version","key":"eprom_checksum_error"},{"code":1500,"description":"Bonus Card Out","key":"bonus_card_out"},{"code":1510,"description":"Cash Transfer Tracking","key":"cash_transfer_tracking"},{"code":1520,"description":"Hopper low","key":"hopper_low"},{"code":1530,"description":"Jackpot Reset Key","key":"jackpot_reset_key"},{"code":1550,"description":"Mechanic In","key":"mechanic_in"},{"code":1560,"description":"Mechanic Out","key":"mechanic_out"},{"code":1570,"description":"Meter Comparison In","key":"meter_comparison_in"},{"code":1580,"description":"Meter Comparison Out","key":"meter_comparison_out"},{"code":1590,"description":"Personal Banker","key":"personal_banker"},{"code":1600,"description":"Player Update","key":"player_update"},{"code":1610,"description":"Possible Bad Card Reader","key":"cardreader_bad_reader"},{"code":1620,"description":"Progressive JP - Hopper Paid","key":"progressive_jackpot_hopper_paid"},{"code":1630,"description":"Progressive Level 0","key":"progressive_level_0"},{"code":1640,"description":"Progressive Level 1","key":"progressive_level_1"},{"code":1650,"description":"Progressive Level 2","key":"progressive_level_2"},{"code":1660,"description":"Progressive Level 3","key":"progressive_level_3"},{"code":1670,"description":"Progressive Level 4","key":"progressive_level_4"},{"code":1680,"description":"Progressive Level 5","key":"progressive_level_5"},{"code":1690,"description":"Progressive Level 6","key":"progressive_level_6"},{"code":1700,"description":"Progressive Level 7","key":"progressive_level_7"},{"code":1710,"description":"Progressive Level 8","key":"progressive_level_8"},{"code":1720,"description":"Progressive Level 9","key":"progressive_level_9"},{"code":1730,"description":"Request system validation #","key":"request_system_validation"},{"code":1740,"description":"Request Ticket Information","key":"request_ticket_information"},{"code":1750,"description":"Ticket Processing","key":"ticket_processing"},{"code":1760,"description":"Ticket Printed, System Val #","key":"ticket_printed"},{"code":1770,"description":"Comp Ticket Printed","key":"comp_ticket_printed"},{"code":1780,"description":"Machine rejected voucher","key":"voucher_rejected"},{"code":1790,"description":"Ticket confiscated by machine","key":"ticket_confiscated"},{"code":1800,"description":"Print status unknown","key":"print_status_unknown"},{"code":1810,"description":"Game timeout awaiting val #","key":"game_timeout_waiting"},{"code":1820,"description":"Invalid print message","key":"print_message_invalid"},{"code":1830,"description":"Printer failure, unable to print","key":"printer_failure_no_print"},{"code":1840,"description":"Unknow vend ticket status","key":"ticket_status"},{"code":1850,"description":"Reply timeout","key":"reply_timeout"},{"code":1860,"description":"Incompatible denomination","key":"incompatible_denomination"},{"code":1870,"description":"Ticket over limit","key":"ticket_over_limit"},{"code":1880,"description":"Ticket over credit limit","key":"ticket_over_credit_limit"},{"code":1890,"description":"Validator failure","key":"validator_failure"},{"code":1900,"description":"Vend request denied by DPU","key":"vend_request_denied"},{"code":1910,"description":"Val # request denied by DPU","key":"val_request_denied"},{"code":1920,"description":"ROM warning, version change","key":"rom_warning_version"},{"code":1930,"description":"Send Configuration","key":"configuration_send"},{"code":1940,"description":"Sentinel On, Memory OK","key":"sentinel_on"},{"code":1950,"description":"Serial Communications Down","key":"serial_comm_down"},{"code":1960,"description":"Serial Communications Up","key":"serial_comm_up"},{"code":1970,"description":"Soft Drop In","key":"soft_drop_in"},{"code":1980,"description":"Soft Drop Out","key":"soft_drop_out"},{"code":1990,"description":"Stacker Installed","key":"stacker_installed"},{"code":2000,"description":"Stacker Removed","key":"stacker_removed"},{"code":2010,"description":"Tilt: Hopper","key":"tilt_hopper"},{"code":2020,"description":"Tilt: Printer hardware failure","key":"tilt_printer_hardware_failure"},{"code":2030,"description":"Top Award","key":"top_award"},{"code":2040,"description":"Unknown","key":"unknown"},{"code":2050,"description":"Hopper Empty","key":"hopper_empty"}]

data/lib/net_shell/builtin_command.rb

@@ -0,0 +1,312 @@
+module A4Tools
+  class BuiltinCommand
+    attr_accessor :input, :error, :output, :args, :shell, :params
+    attr_reader :status, :result
+
+    class << self
+      attr_reader :category_text, :description_text, :usage_text, :help_text, :validator, :tab_completors, :run_block, :opts, :is_user_defined
+      attr_accessor :sha1, :filepath, :command
+
+      def setup
+        @description_text = ""
+        @usage_text = ""
+        @help_text = ""
+        @category_text = "General"
+        @validator = proc { true }
+        @tab_completors = { default: proc { [] } }
+        @run_block = proc { "" }
+        @opts = []
+      end
+
+      ## Command category.
+      ## Used to sort items in help.
+      def category(category)
+        @category_text = category
+      end
+
+      ## Summary of command
+      ## One-line description of command for use in help
+      def description(description)
+        @description_text = description
+      end
+
+      ## Command line usage
+      ## Added to end of usage argment. e.g. return "arg1 arg2" to get a string like "usage: my_command arg1 arg2"
+      def usage(usage)
+        @usage_text = usage
+      end
+
+      ## Help text
+      ## Supplemental help added to end of --help.
+      def help(help)
+        @help_text = help
+      end
+
+      ## Command line validation
+      ## Return true to indicate command line is valid.
+      ## Return false to generate error and return usage help.
+      ## Return a string to generate error and display the returned string.
+      def validate(&validator)
+        @validator = validator
+      end
+
+      ## Tab completion
+      ## Return an array of possible values. You are not responsible for filtering these values for those matching the current argument.
+      ## If an index is supplied, the block will only be invoked for that argument.
+      def tab(index=nil, &tab_completor)
+        if index.nil? then
+          @tab_completors[:default] = tab_completor 
+        else
+          @tab_completors[index] = tab_completor
+        end
+      end
+
+      ## Defines a command line argument. Identical syntax to Trollop.
+      ##  opt :name, "Supplies a name", :type => :string
+      def opt(key, description, params={})
+        @opts.push({ key:key, description:description, params:params })
+      end
+
+      ## Actual code block to execute when the command is run
+      def run(&block)
+        @run_block = block
+      end
+
+      ###
+      # Load from a file (don't call this directly)
+      def load_command(file, userdefined=false)
+        cmdname = File.basename(file.to_s, ".rb")
+        subclass = Class.new(A4Tools::BuiltinCommand) {}
+        contents = IO.read(file)
+
+        subclass.setup
+        subclass.command = cmdname
+        subclass.filepath = file
+        subclass.sha1 = Digest::SHA1.hexdigest contents
+        subclass.user_defined if userdefined
+        subclass.class_eval( contents, file )
+        subclass
+      end
+
+      # Identify a command as user-defined (called automatically)
+      def user_defined
+        @is_user_defined = true
+      end
+    end
+
+
+    ####
+    # convenience methods you might want to be aware of
+
+    def usher
+      if @shell.shared[:usher].nil? then
+        @shell.shared[:usher] = A4Tools::UsherClient.new()
+      end
+      @shell.shared[:usher]
+    end
+
+    def usherm
+      @shell.client(:usherm)
+    end
+
+    def client
+      @shell.active_client
+    end
+
+    def deployment
+      @shell.client(:deployment)
+    end
+
+    def qa
+      @shell.client(:qa)
+    end
+
+    def kaiconfig
+      @shell.client(:kaiconfig)
+    end
+
+    def show_error(msg)
+      @error.write "!!".style(:error) + " #{args[0].style(:command)}: #{msg}\n"
+      return "", 1
+    end
+
+    def show_exception(exception)
+      @error.write "\n"
+      @error.write "!!".style(:error) + "#{command} crashed: #{exception.class.to_s} #{exception.message}\n"
+      @error.write "Stack trace: #{exception.backtrace.map {|l| "  #{l}\n"}.join}"
+      ""
+    end
+
+    ####
+    # don't override these unless you really know what you're doing and have a good reason
+
+    def initialize(shell, input=nil, output=nil, error=nil)
+      @shell = shell
+      @parser = parser
+
+      @input = input || StandardInput.new
+      @output = output || StandardOutput.new
+      @error = error || StandardOutput.new
+    end
+
+    def category
+      self.class.category_text
+    end
+
+    def command
+      self.class.command
+    end
+
+    def description
+      self.class.description_text
+    end
+
+    def usage
+      self.class.usage_text
+    end
+
+    def help
+      self.class.help_text
+    end
+
+    def validate
+      block_call(&self.class.validator)
+    end
+
+    def user_defined?
+      self.class.is_user_defined
+    end
+
+    def block_call(&block)
+      self.class.send(:define_method, :__block_call, &block)
+      self.class.send(:instance_method, :__block_call).bind(self).call
+    end
+
+    def sym_for_param(param)
+      param[2..-1].to_sym rescue ""
+    end
+
+    def tab
+      # only include --command-arguments if we already have a dash
+      param_mix = []
+      param_mix = all_opts.map { |opt| "--" + opt[:key].to_s.gsub("_","-") } if @realargs.last[0] == '-'
+
+      key = if @realargs.length >= 2 and self.class.tab_completors.has_key? sym_for_param(@realargs[-2])
+        sym_for_param(@realargs[-2])
+      elsif self.class.tab_completors.has_key?(args.length-2)
+        args.length - 2
+      else
+        :default
+      end
+
+      param_mix + block_call(&(self.class.tab_completors[key]))
+    end
+
+    def perform
+      return [educate, 1] if params[:help]
+
+      errmsg = validate
+      return show_error(errmsg) if errmsg.is_a? String
+      return show_error(usage_msg) if errmsg.nil? or errmsg == false
+
+      begin
+        block_call(&self.class.run_block)
+      rescue Interrupt
+        @error.write "Killed\n"
+        return ["", 1]
+      rescue SystemExit # allow commands to call exit
+        raise
+      rescue Exception => exception
+        return show_exception(exception)
+      end
+    end
+
+    def execute(input, output, error, args)
+      @input = input
+      @output = output
+      @error = error
+      parse(args)
+
+      r = perform
+      r = [r, 0] unless r.is_a? Array
+      @result = r[0] || ""
+      @status = r[1]
+
+      txt = @result.to_s
+      unless txt.empty? then
+        txt += "\n" unless txt.end_with? "\n"
+        @output.write txt
+      end
+
+      @status
+    end
+
+    def global_opts
+      [ { key: :help, description:"Show help", params:{} } ]
+    end
+
+    def all_opts
+      global_opts + self.class.opts
+    end
+
+    def parser
+      Trollop::Parser.new(all_opts) do |opts|
+        opts.each do |option|
+          opt option[:key], option[:description], option[:params]
+        end
+      end
+    end
+
+    def parse(args)
+      @realargs = Array.new(args)
+
+      begin
+        @params = @parser.parse(args)
+      rescue Trollop::HelpNeeded
+        @params = {help:true}
+      rescue Trollop::VersionNeeded
+        @params = {help:true}
+      rescue Trollop::CommandlineError
+        @params = {help:true}
+      end
+      @args = @parser.leftovers
+      @args = args if @args.nil? or @args.empty?
+    end
+
+    def usage_msg
+      u = usage
+      if usage.is_a? Array then
+        "usage:\n" + (u.map { |line| "\t#{command} [flags] #{line}" }).join("\n")
+      else
+        "usage: #{command} [flags] #{usage}"
+      end
+    end
+
+    def educate
+      buffer = PipeBuffer.new
+      @parser.educate buffer
+      intro_line = "#{command.style(:command)}: #{description}"
+      userdef_line = user_defined? ? "User defined".style(:userdefined) : nil
+
+      top_section = [intro_line, category.style(:category), userdef_line ].compact.join("\n")
+
+      [top_section+"\n", usage_msg+"\n", buffer.buffer, help].compact.join("\n")
+    end
+
+    def print(s="")
+      @output.print s
+    end
+
+    def puts(s="")
+      @output.puts s
+    end
+
+    def console_puts(s)
+      $stdout.puts s.gsub("\n","\r\n")
+    end
+
+    def console_print(s)
+      $stdout.print s.gsub("\n","\r\n")
+    end
+  end
+end