ige_isb_api 1.0.0

data/lib/ige_isb_api/constants.rb

@@ -0,0 +1,284 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+module IGE_ISB_API
+  class Constants
+    API_VERSION = '2.1'
+
+    LICENSEE_ID = ENV['ISB_LICENSEE_ID'].to_i      # issued by ISB
+    CASINO = ENV['ISB_CASINO_ID']                  # issued by ISB
+    SECRET_KEY = ENV['ISB_SECRET_KEY']             # issued by ISB
+    BONUS_API_KEY = ENV['ISB_BONUS_API_KEY']       # issued by ISB
+    BONUS_SECRET_KEY = ENV['ISB_BONUS_SECRET_KEY'] # issued by ISB
+    CALLBACK_ID = ENV['ISB_CALLBACK_ID'].to_i      # issued by ISB
+    API_SERVER = ENV['ISB_API_SERVER']             # issued by ISB
+    BONUS_API_SERVER = ENV['ISB_BONUS_API_SERVER'] # issued by ISB
+    SERVER = {fun: ENV['ISB_FUN_URL'], real: ENV['ISB_REAL_URL']} # issued by ISB
+
+    DEFAULT_ENCODING = 'utf-8'
+    ALLOWED_CURRENCIES = %w(EUR GBP USD)
+    ALLOWED_MODES = %w(window gpu opaque transparent direct)
+    ALLOWED_GAME_TYPES = %w(flash html5)
+    ALLOWED_LIMITATIONS = %w(bet loss time exclusion deposit_extra deposit) # all must be lower case, despite what the docs say
+    ALLOWED_FREQUENCIES = %w(daily weekly monthly) # all must be lower case, despite what the docs say
+    ALLOWED_BONUS_TYPES = ['before-wager redeemable', 'before-wager non-redeemable', 'after-wager', 'cash']
+    ALLOWED_BONUS_STATUSES = [ 'pending', 'accepted', 'active', 'completed',
+                                'cancelled', 'declined', 'expired',
+                                'completed non-redeemable', 'queue']
+    LANGUAGES = {en: 0, fr: 1, es: 2, it: 3, de: 5} # de is documented as being 4, but it's actually 5. The doc is a misprint.
+    DEFAULT_CURRENCY_CODE = 'USD'
+    DEFAULT_LANGUAGE = 'en'
+    
+    MALE = 0
+    FEMALE = 1
+    REAL = 0
+    FUN = 1
+    TEST = 2
+    USER_INACTIVE = 0
+    USER_ACTIVE = 1
+    USER_BANNED = 2
+    
+    ALLOWED_COUNTRY_CODES = {
+      af: 'Afghanistan',
+      al: 'Albania',
+      dz: 'Algeria',
+      as: 'American Samoa',
+      ad: 'Andorra',
+      ao: 'Angola',
+      ai: 'Anguilla',
+      aq: 'Antarctica',
+      ag: 'Antigua and Barbuda',
+      ar: 'Argentina',
+      am: 'Armenia',
+      aw: 'Aruba',
+      au: 'Australia',
+      at: 'Austria',
+      az: 'Azerbaijan',
+      bs: 'Bahamas, The',
+      bh: 'Bahrain',
+      bd: 'Bangladesh',
+      bb: 'Barbados',
+      by: 'Belarus',
+      be: 'Belgium',
+      bz: 'Belize',
+      bj: 'Benin',
+      bm: 'Bermuda',
+      bt: 'Bhutan',
+      bo: 'Bolivia',
+      ba: 'Bosnia and Herzegovina',
+      bw: 'Botswana',
+      bv: 'Bouvet Island',
+      br: 'Brazil',
+      io: 'British Indian Ocean Territory',
+      vg: 'British Virgin Islands',
+      bn: 'Brunei',
+      bg: 'Bulgaria',
+      bf: 'Burkina Faso',
+      mm: 'Burma',
+      bi: 'Burundi',
+      kh: 'Cambodia',
+      cm: 'Cameroon',
+      ca: 'Canada',
+      cv: 'Cape Verde',
+      ky: 'Cayman Islands',
+      cf: 'Central African Republic',
+      td: 'Chad',
+      cl: 'Chile',
+      cn: 'China',
+      cx: 'Christmas Island',
+      cc: 'Cocos (Keeling) Islands',
+      co: 'Colombia',
+      cd: 'Congo, Democratic Republic of the',
+      cg: 'Congo, Republic of the',
+      ck: 'Cook Islands',
+      cr: 'Costa Rica',
+      ci: "Cote d'Ivoire",
+      hr: 'Croatia',
+      cu: 'Cuba',
+      cy: 'Cyprus',
+      cz: 'Czech Republic',
+      dk: 'Denmark',
+      dj: 'Djibouti',
+      dm: 'Dominica',
+      do: 'Dominican Republic',
+      ec: 'Ecuador',
+      eg: 'Egypt',
+      sv: 'El Salvador',
+      gq: 'Equatorial Guinea',
+      er: 'Eritrea',
+      ee: 'Estonia',
+      et: 'Ethiopia',
+      fk: 'Falkland Islands (Islas Malvinas)',
+      fo: 'Faroe Islands',
+      fj: 'Fiji',
+      fi: 'Finland',
+      fr: 'France',
+      gf: 'French Guiana',
+      pf: 'French Polynesia',
+      tf: 'French Southern and Antarctic Lands',
+      ga: 'Gabon',
+      gm: 'Gambia, The',
+      ge: 'Georgia',
+      de: 'Germany',
+      gh: 'Ghana',
+      gi: 'Gibraltar',
+      gr: 'Greece',
+      gl: 'Greenland',
+      gd: 'Grenada',
+      gp: 'Guadeloupe',
+      gu: 'Guam',
+      gt: 'Guatemala',
+      gg: 'Guernsey',
+      gn: 'Guinea',
+      gw: 'Guinea-Bissau',
+      gy: 'Guyana',
+      ht: 'Haiti',
+      hm: 'Heard Island and McDonald Islands',
+      va: 'Holy See (Vatican City)',
+      hn: 'Honduras',
+      hk: 'Hong Kong',
+      hu: 'Hungary',
+      is: 'Iceland',
+      in: 'India',
+      id: 'Indonesia',
+      ir: 'Iran',
+      iq: 'Iraq',
+      ie: 'Ireland',
+      im: 'Isle of Man',
+      il: 'Israel',
+      it: 'Italy',
+      jm: 'Jamaica',
+      jp: 'Japan',
+      je: 'Jersey',
+      jo: 'Jordan',
+      kz: 'Kazakhstan',
+      ke: 'Kenya',
+      ki: 'Kiribati',
+      kp: 'Korea, North',
+      kr: 'Korea, South',
+      kw: 'Kuwait',
+      kg: 'Kyrgyzstan',
+      la: 'Laos',
+      lv: 'Latvia',
+      lb: 'Lebanon',
+      ls: 'Lesotho',
+      lr: 'Liberia',
+      ly: 'Libya',
+      li: 'Liechtenstein',
+      lt: 'Lithuania',
+      lu: 'Luxembourg',
+      mo: 'Macau',
+      mk: 'Macedonia',
+      mg: 'Madagascar',
+      mw: 'Malawi',
+      my: 'Malaysia',
+      mv: 'Maldives',
+      ml: 'Mali',
+      mt: 'Malta',
+      mh: 'Marshall Islands',
+      mq: 'Martinique',
+      mr: 'Mauritania',
+      mu: 'Mauritius',
+      yt: 'Mayotte',
+      mx: 'Mexico',
+      fm: 'Micronesia, Federated States of',
+      md: 'Moldova',
+      mc: 'Monaco',
+      mn: 'Mongolia',
+      ms: 'Montserrat',
+      ma: 'Morocco',
+      mz: 'Mozambique',
+      na: 'Namibia',
+      nr: 'Nauru',
+      np: 'Nepal',
+      nl: 'Netherlands',
+      an: 'Netherlands Antilles',
+      nc: 'New Caledonia',
+      nz: 'New Zealand',
+      ni: 'Nicaragua',
+      ne: 'Niger',
+      ng: 'Nigeria',
+      nu: 'Niue',
+      nf: 'Norfolk Island',
+      mp: 'Northern Mariana Islands',
+      no: 'Norway',
+      om: 'Oman',
+      pk: 'Pakistan',
+      pw: 'Palau',
+      pa: 'Panama',
+      pg: 'Papua New Guinea',
+      py: 'Paraguay',
+      pe: 'Peru',
+      ph: 'Philippines',
+      pn: 'Pitcairn Islands',
+      pl: 'Poland',
+      pt: 'Portugal',
+      pr: 'Puerto Rico',
+      qa: 'Qatar',
+      re: 'Reunion',
+      ro: 'Romania',
+      ru: 'Russia',
+      rw: 'Rwanda',
+      sh: 'Saint Helena',
+      kn: 'Saint Kitts and Nevis',
+      lc: 'Saint Lucia',
+      pm: 'Saint Pierre and Miquelon',
+      vc: 'Saint Vincent and the Grenadines',
+      ws: 'Samoa',
+      sm: 'San Marino',
+      st: 'Sao Tome and Principe',
+      sa: 'Saudi Arabia',
+      sn: 'Senegal',
+      cs: 'Serbia and Montenegro',
+      sc: 'Seychelles',
+      sl: 'Sierra Leone',
+      sg: 'Singapore',
+      sk: 'Slovakia',
+      si: 'Slovenia',
+      sb: 'Solomon Islands',
+      so: 'Somalia',
+      za: 'South Africa',
+      gs: 'South Georgia and the South Sandwich Islands',
+      es: 'Spain',
+      lk: 'Sri Lanka',
+      sd: 'Sudan',
+      sr: 'Suriname',
+      sj: 'Svalbard',
+      sz: 'Swaziland',
+      se: 'Sweden',
+      ch: 'Switzerland',
+      sy: 'Syria',
+      tw: 'Taiwan',
+      tj: 'Tajikistan',
+      tz: 'Tanzania',
+      th: 'Thailand',
+      tp: 'Timor-Leste',
+      tg: 'Togo',
+      tk: 'Tokelau',
+      to: 'Tonga',
+      tt: 'Trinidad and Tobago',
+      tn: 'Tunisia',
+      tr: 'Turkey',
+      tm: 'Turkmenistan',
+      tc: 'Turks and Caicos Islands',
+      tv: 'Tuvalu',
+      ug: 'Uganda',
+      ua: 'Ukraine',
+      ae: 'United Arab Emirates',
+      gb: 'United Kingdom',
+      us: 'United States',
+      uy: 'Uruguay',
+      uz: 'Uzbekistan',
+      vu: 'Vanuatu',
+      ve: 'Venezuela',
+      vn: 'Vietnam',
+      vi: 'Virgin Islands',
+      wf: 'Wallis and Futuna',
+      ps: 'West Bank',
+      eh: 'Western Sahara',
+      ye: 'Yemen',
+      zm: 'Zambia',
+      zw: 'Zimbabwe'
+    }
+  end
+end

data/lib/ige_isb_api/games.rb

@@ -0,0 +1,433 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+require "ige_isb_api"
+require "ige_isb_api/constants"
+require 'nokogiri'
+
+# Email from iSB on 2 Sept 2013 says
+# please use the following parameters:               
+# Loginc = XX,player_ID (Where XX is your licensee ID)
+# Passc =  random string
+# also can ignore the 'file' tag in the games_info.xml file.
+# and confirmed that :swf_revision will always be an integer.
+# ignore language code
+# ignore <fun> tag in game info.
+
+# email from ISB on 2 Oct 2013
+# We will use a new parameter within pass strings something called “hostID”.
+# However being a string, we need to agree over an internal naming convention to know which URL corresponds to the string used.
+# For example: if hostID is “1”, the url for end of session json return is https://api.luckygoldfish.com/isb/end-session.
+# The url for returning the json doesn’t needs to point to a domain whitelisted in these case as the initiation is made from our side (have to double check it though)
+# By these, we needed to change the structure for login and pass while calling our games in real mode.
+# Please use the following:
+# 
+# Flash:
+# loginc: 54,playerID
+# passc: requestID,token,hostID
+# 
+# html5
+# name: 54,playerID
+# password: requestID,token,hostID
+# 
+# where: 
+# playerID - unique player identification
+# requestID - has to be unique for every new game session
+# token - SHA256 digest of our 'SECRETKEY' + 'IDREQUEST' which we will use to authenticate the incoming info.
+# hostID - the host id (configured as INT) assigned to the real URL on our site (url to IGE api will be changeable and will be depend on the hostID parameter). 
+# see https://github.com/Interactive-Gaming-Entertainment/ISBAPI/issues/5
+# this has changed now as follows:
+# Flash:
+# loginc: 54,player_login
+# passc: requestID,token,hostID
+# 
+# html5
+# name: 54,player_login
+# password: requestID,token,hostID
+
+module IGE_ISB_API
+  class GameInfo
+    attr_accessor :mode, # :fun or :real
+                  :url, :swf_revision, :host, :use_custom_loader, :custom_loader,
+                  :preloader # all the rest of the info is the same or ignored
+  
+    def initialize(mode = :fun)
+      raise ArgumentError, "Invalid mode #{mode}, should be :fun or :real" unless mode == :fun || mode == :real
+      @mode = mode
+    end
+
+    def use_custom_loader?
+      return @use_custom_loader if (defined? @use_custom_loader && !@use_custom_loader.nil?)
+      return false
+    end
+
+  end
+
+  class Game    
+    attr_accessor :id, :name, :description, :images, :is_fun_active, :is_real_active,
+                  :coin_values, :identifier, :category, :main_category, :skin,
+                  :coin, :coin_min, :coin_max, :wmode, :casino, :use_preloader, # use preloader is the same for both fun and real modes.
+                  :game_type, :restricted_countries, :custom_backgrounds,
+                  :info, :translated, :language
+
+    # 'tra', 'tfa', and 'ta' are deprecated fields and should be ignored.
+
+    def initialize()
+      @info = {}
+    end
+
+    def has_info?(mode)
+      return !self.info[mode].nil?
+    end
+
+    def get_info(mode)
+      the_info = self.info[mode]
+      raise ArgumentError, "No Info associated with mode #{mode}" unless self.has_info?(mode)
+      return the_info 
+    end
+
+    def use_preloader?
+      return @use_preloader if (defined? @use_preloader && !@use_preloader.nil?)
+      return false
+    end
+    
+    def game_html5_url(mode)
+      the_info = self.get_info(mode)
+      return "#{IGE_ISB_API::Constants::SERVER[mode]}html/#{self.identifier}/#{self.identifier}_r#{the_info.swf_revision}/#{self.identifier}.html"
+    end
+    
+    def game_swf_url(mode)
+      check_mode!(mode)
+      the_info = self.get_info(mode)
+      if the_info.use_custom_loader?
+        raise RuntimeError, "Custom Loader not specified" if the_info.custom_loader.nil? || the_info.custom_loader.empty?
+        return "#{IGE_ISB_API::Constants::SERVER[mode]}#{self.main_category}/#{the_info.custom_loader}"
+      end
+      if self.use_preloader?
+        raise RuntimeError, "Preloader not specified" if the_info.preloader.nil? || the_info.preloader.empty?
+        return "#{IGE_ISB_API::Constants::SERVER[mode]}#{self.main_category}/#{the_info.preloader}"
+      end
+      return "#{IGE_ISB_API::Constants::SERVER[mode]}#{self.main_category}/#{game_swf_path(mode)}"
+    end
+ 
+    # must not start with a '/'
+    # With custom loader, you load the custom loader swf, and the gameurl flash var has to be absolute url
+    # With preloader, you load the preloader swf, and the gameurl flash var has to be absolute url
+    # Without custom loader or preloader, you have to load the main game swf, and the gameurl remains relative url 
+    def game_swf_path(mode)
+      check_mode!(mode)
+      raise RuntimeError, "Game Identifier Unknown" if self.identifier.nil? || self.identifier.empty?
+      raise RuntimeError, "Game Server Unknown" if IGE_ISB_API::Constants::SERVER[mode].nil? || IGE_ISB_API::Constants::SERVER[mode].empty?
+      the_info = self.get_info(mode)
+      raise RuntimeError, "SWF Revision not specified" if the_info.swf_revision.nil?
+      if the_info.use_custom_loader? || self.use_preloader?
+        return "#{IGE_ISB_API::Constants::SERVER[mode]}#{self.main_category}/swf_files/#{self.identifier}_r#{the_info.swf_revision}.swf"
+      end
+      return "swf_files/#{self.identifier}_r#{the_info.swf_revision}.swf"
+    end
+    
+    def game_info_url(mode)
+      check_mode!(mode)
+      raise RuntimeError, "Game Indentifier Unknown" if self.identifier.nil? || self.identifier.empty?
+      raise RuntimeError, "Game Server Unknown" if IGE_ISB_API::Constants::SERVER[mode].nil? || IGE_ISB_API::Constants::SERVER[mode].empty?
+      return "#{IGE_ISB_API::Constants::SERVER[mode]}xml_game_info/#{self.identifier}_info.xml"
+    end
+    
+    def load_info(some_xml)
+      doc = Nokogiri::XML(some_xml)
+      gn = doc.xpath("//game").first
+      @skin = gn.xpath('skin_id').first.text.to_i
+      @coin = gn.xpath('coin').first.text.to_f
+      @coin_min = gn.xpath('coin_min').first.text.to_f
+      @coin_max = gn.xpath('coin_max').first.text.to_f
+      @casino = gn.xpath('casino').first.text
+      @game_type = gn.xpath('type').first.text
+      @wmode = gn.xpath('wmode').first.text
+      # mode specific info
+      fun = gn.xpath('fun').first.text == '1'
+      mode = fun ? :fun : :real
+      the_info = self.has_info?(mode) ? self.get_info(mode) : GameInfo.new(mode)
+      the_info.url = gn.xpath('url').first.text
+      the_info.swf_revision = gn.xpath('swf_revision').first.text.to_i
+      the_info.host = gn.xpath('host').first.text
+      the_info.use_custom_loader = (gn.xpath('use_custom_loader').first.text == '1')
+      the_info.custom_loader = gn.xpath('custom_loader').first.text
+      the_info.preloader = gn.xpath('prelfile').first.text if self.use_preloader?
+      self.info[mode] = the_info
+      return [] unless ((self.fun? && self.has_info?(:fun)) && (self.real? && self.has_info?(:real)))
+      return any_errors?
+    end
+    
+    def fun?
+      return @is_fun_active
+    end
+    
+    def real?
+      return @is_real_active
+    end
+    
+    def translated?
+      return @translated
+    end
+    
+    # Image Sizes
+    # simg – preview of the game, the size of the preview is 160px – 60px
+    # limg – preview of the game, the size of the preview is 197px - 88px
+    # html_img – preview of the game, the size of the preview is 120px -158px
+    # img_v2 – preview of the game, the size of the preview is 240px – 135px
+    def main_image
+      images = self.images
+      image = ''
+      image = images[:v2] unless images[:v2].nil? || images[:v2].empty?
+      image = images[:l] if image.empty? && !(images[:l].nil? || images[:l].empty?)
+      image = images[:html] if image.empty? && !(images[:html].nil? || images[:html].empty?)
+      return image
+    end
+    
+    def thumb_image
+      images = self.images
+      thumb = ''
+      thumb = images[:s] unless images[:s].nil? || images[:s].empty?
+      thumb = main_image if thumb.empty?
+      return thumb
+    end
+
+    def warnings
+      warnings = []
+      warnings << {game: self, message: "Missing description, defaulting to ''."} if self.description.nil? || self.description.empty?
+      images = self.images
+      warnings << {game: self, message: "Missing ':l' image in #{images.inspect}"} if images[:l].nil? || images[:l].empty?
+      warnings << {game: self, message: "Missing ':s' image in #{images.inspect}"} if images[:s].nil? || images[:s].empty?
+      warnings << {game: self, message: "Missing ':html' image in #{images.inspect}"} if images[:html].nil? || images[:html].empty?
+      # => almost all games are missing the :v2 image completely so only warn if empty, not nil.
+      warnings << {game: self, message: "Missing :v2 image in  #{images.inspect}"} if !images[:v2].nil? && images[:v2].empty?
+      return warnings
+    end
+
+    def self.from_node(node, cat, lang)
+      g = Game.new
+      g.category = cat
+      g.id = node['id'].to_i
+      g.name = node['n']
+      g.images = {
+        s: node['simg'], # preview of the game, the size of the preview is 160px – 60px. Sometimes missing.
+        l: node['limg'], # preview of the game, the size of the preview is 197px - 88px.
+        html: node['html_img'], # preview of the game, the size of the preview is 120px -158px.
+        v2: node['img_v2'] # preview of the game, the size of the preview is 240px – 135px. This is typically nil
+      }
+      g.is_fun_active = (node['fa'] == '1')
+      g.is_real_active = (node['ra'] == '1')
+      g.use_preloader = (node['p'] == '1')
+      g.coin_values = node['c'].split('; ').map {|s| s.to_f}
+      g.restricted_countries = node['rc'].split(', ')
+      g.identifier = node['i']
+      g.description = node.xpath('d').first.text
+      mcn = node.xpath('main_cat').first
+      g.main_category = mcn.text unless mcn.nil?
+      g.translated = (node['translated'] == '1')
+      g.language = g.translated? ? lang : IGE_ISB_API::Constants::DEFAULT_LANGUAGE
+      return g
+    end
+
+    # request_id must be unique for each request
+    def self.encode_password(idrequest)
+      raise ArgumentError, "You must supply a unique :idrequest" if idrequest.nil?
+      # password: idrequest,token,hostID
+      # token - SHA256 digest of our 'SECRETKEY' + 'idrequest' which we will use to authenticate the incoming info.
+      token = (Digest::SHA256.new << "#{IGE_ISB_API::Constants::SECRET_KEY}#{idrequest}").to_s
+      return "#{idrequest},#{token},#{IGE_ISB_API::Constants::CALLBACK_ID}"
+    end
+
+    def self.encode_login(player_login)
+      raise ArgumentError, "You must supply a valid :player_login" if player_login.nil?
+      return "#{IGE_ISB_API::Constants::LICENSEE_ID},#{player_login}"
+    end
+
+    def self.game_launcher_url(opts = {})
+      options = {
+        currency: IGE_ISB_API::Constants::DEFAULT_CURRENCY_CODE
+      }.merge(opts)
+      password = options[:fun] ? 'fun' : Game.encode_password(options[:idrequest])
+      name = options[:fun] ? 'fun' : Game.encode_login(options[:player_login])
+      vars = [
+        "name=#{name}",
+        "password=#{password}",
+        "lang=#{options[:language]}",
+        "currency=#{options[:currency]}",
+        "funmode=#{options[:fun].to_s}"
+      ].join('&')
+      return "#{options[:game_html5_url]}?#{vars}"
+    end
+
+    # Flash:
+    # loginc: 54,playerID
+    # passc: requestID,token,hostID
+    def self.embed_swfobject(opts = {})
+      options = {
+        width: '100%',
+        height: '100%',
+        container: 'game',
+        currency: IGE_ISB_API::Constants::DEFAULT_CURRENCY_CODE,
+        gm_api: 1 # see https://github.com/Interactive-Gaming-Entertainment/ISBAPI/issues/10
+        
+      }.merge(opts)
+      mode = options[:fun] ? :fun : :real
+      password = options[:fun] ? 'fun' : Game.encode_password(options[:idrequest])
+      name = options[:fun] ? 'fun' : Game.encode_login(options[:player_login])
+      vars = [
+        "gamename: '#{options[:name]}'",
+        "gameurl: '#{options[:game_swf_path]}'",
+        "gameid: '#{options[:identifier]}'",
+        "skin_id: '#{options[:skin]}'",
+        "hostname: '#{options[:host]}'",
+        "loginc: '#{name}'",
+        "passc: '#{password}'",
+        "cur: '#{options[:currency]}'",
+        "forfun: #{options[:fun] ? 1 : 0}",
+        "langue: #{IGE_ISB_API::Constants::LANGUAGES[options[:language].to_sym]}",
+        "casino: '#{options[:casino]}'",
+        "coinval: '#{options[:coin_min]}'",
+        "table: 0",
+        "tokenuse: 0",
+        "realc: 60",
+        "gmAPI: #{options[:gm_api]}",
+        "settingsXMLProvider: '#{IGE_ISB_API::Constants::SERVER[mode]}#{options[:main_category]}/xml/#{options[:language]}/#{options[:identifier]}_settings_#{mode.to_s}.xml'",
+        "translationXMLProvider: '#{IGE_ISB_API::Constants::SERVER[mode]}#{options[:main_category]}/xml/#{options[:language]}/#{options[:identifier]}_translations.xml'"
+      ].join(', ')
+      pars = [
+        "align: 'middle'",
+        "allowScriptAccess: 'always'",
+        "allowFullScreen: 'true'",
+        "quality: 'high'",
+        "bgcolor: '#{options[:colour]}'",
+        "wmode: '#{options[:wmode]}'"
+      ].join(', ')
+      result = "<script>var vars = {#{vars}}, params = {#{pars}}, swfUrl = '#{options[:game_swf_url]}'; "
+      result << "swfobject.embedSWF(swfUrl, '#{options[:container]}', '#{options[:width]}', '#{options[:height]}', '11.0.0', null, vars, params);</script>"
+      return result
+    end
+
+    # settingsXMLProvider - the location of the game's settings xml file (/[main_cat]/xml/[language identifier]/[game identifier]_settings_[fun/real].xml)
+    def self.embed_game_html(opts = {})
+      options = {
+        width: '100%',
+        height: '100%',
+        currency: IGE_ISB_API::Constants::DEFAULT_CURRENCY_CODE,
+        gm_api: 1 # see https://github.com/Interactive-Gaming-Entertainment/ISBAPI/issues/10
+      }.merge(opts)
+      mode = options[:fun] ? :fun : :real
+      password = options[:fun] ? 'fun' : Game.encode_password(options[:idrequest])
+      name = options[:fun] ? 'fun' : Game.encode_login(options[:player_login])
+      flashvars = [
+        "gamename=#{options[:name]}",
+        "gameurl=#{options[:game_swf_path]}",
+        "gameid=#{options[:identifier]}",
+        "skin_id=#{options[:skin]}",
+        "hostname=#{options[:host]}",
+        "loginc=#{name}",
+        "passc=#{password}",
+        "cur=#{options[:currency]}",
+        "forfun=#{options[:fun] ? 1 : 0}",
+        "langue=#{IGE_ISB_API::Constants::LANGUAGES[options[:language].to_sym]}",
+        "casino=#{options[:casino]}",
+        "coinval=#{options[:coin_min]}",
+        "table=0",
+        "tokenuse=0",
+        "realc=60",
+        "gmAPI=#{options[:gm_api]}",
+        "settingsXMLProvider=#{IGE_ISB_API::Constants::SERVER[mode]}#{options[:main_category]}/xml/#{options[:language]}/#{options[:identifier]}_settings_#{mode.to_s}.xml",
+        "translationXMLProvider=#{IGE_ISB_API::Constants::SERVER[mode]}#{options[:main_category]}/xml/#{options[:language]}/#{options[:identifier]}_translations.xml"
+      ].join('&')
+      result = "<object classid='clsid:D27CDB6E-AE6D-11cf-96B8-444553540000' codebase='http://download.macromedia.com/pub/shockwave/cabs/flash/swflash.cab#version=6,0,40,0' width='#{options[:width]}' height='#{options[:height]}' id='#{options[:identifier]}'>"
+      result << "<object type='application/x-shockwave-flash' data='#{options[:game_swf_url]}' width='#{options[:width]}' height='#{options[:height]}'>"
+      result << "<param name='movie' value='#{options[:game_swf_url]}' />"
+      result << "<param name='flashvars' value='#{flashvars}' />"
+      result << "<param name='align' value='middle' />"
+      result << "<param name='allowFullScreen' value='true' />"
+      result << "<param name='allowScriptAccess' value='always' />"
+      result << "<param name='quality' value='high' />"
+      result << "<param name='bgcolor' value='#{options[:colour]}' />"
+      result << "<param name='wmode' value='#{options[:wmode]}' />"
+      result << "<param name='base' value='.' />"
+      result << "</object></object>"
+      return result
+    end
+
+    private
+    
+    def check_mode!(mode)
+      raise ArgumentError, "Invalid mode #{mode}, should be :fun or :real" unless mode == :fun || mode == :real
+      raise ArgumentError, "Invalid mode #{mode}, :fun not allowed for this game." if mode == :fun && !self.fun?
+      raise ArgumentError, "Invalid mode #{mode}, :real not allowed for this game." if mode == :real && !self.real?      
+    end
+    
+    def any_errors?
+      errors = []
+      errors << {game: self, message: "Missing casino"} if self.casino.nil? || self.casino.empty?
+      errors << {game: self, message: "Missing identifier"} if self.identifier.nil? || self.identifier.empty?
+      errors << {game: self, message: "Missing game_swf_path(:fun)"} if self.fun? && (self.game_swf_path(:fun).nil? || self.game_swf_path(:fun).empty?)
+      errors << {game: self, message: "Missing game_swf_url(:fun)"} if self.fun? && (self.game_swf_url(:fun).nil? || self.game_swf_url(:fun).empty?)
+      errors << {game: self, message: "Missing game_swf_path(:real)"} if self.real? && (self.game_swf_path(:real).nil? || self.game_swf_path(:real).empty?)
+      errors << {game: self, message: "Missing game_swf_url(:real)"} if self.real? && (self.game_swf_url(:real).nil? || self.game_swf_url(:real).empty?)
+      errors << {game: self, message: "Missing main_category"} if self.game_type === 'flash' && (self.main_category.nil? || self.main_category.empty?)
+      errors << {game: self, message: "Missing wmode"} if self.wmode.nil? || self.wmode.empty?
+      errors << {game: self, message: "Missing type"} if self.game_type.nil? || self.game_type.empty?
+      errors << {game: self, message: "Invalid game type"} unless IGE_ISB_API::Constants::ALLOWED_GAME_TYPES.include?(self.game_type)
+      errors << {game: self, message: "Missing coin_min: coin_values are #{self.coin_values.inspect} coin: #{self.coin} max: #{self.coin_max}"} if self.coin_min.nil? || self.coin_min <= 0.0
+      errors << {game: self, message: "Unable to determine main image"} if self.main_image.empty?
+      errors << {game: self, message: "Unable to determine thumbnail image"} if self.thumb_image.empty?
+      errors << {game: self, message: "Invalid wmode"} unless IGE_ISB_API::Constants::ALLOWED_MODES.include?(self.wmode)
+      errors << {game: self, message: "Neither fun, nor real"} if !(self.fun? || self.real?)
+      errors << {game: self, message: "Missing fun game info"} if (self.fun? && !self.has_info?(:fun))
+      errors << {game: self, message: "Missing real game info"} if (self.real? && !self.has_info?(:real))
+      return errors
+    end
+  end
+
+  class Category
+    attr_accessor :parent, :children, :id, :name, :description, :games, :icon, :language
+    
+    def initialize()
+      @children = []
+      @games = []
+      @language = IGE_ISB_API::Constants::DEFAULT_LANGUAGE
+    end
+
+    def self.from_node(node, opts = {})
+      c = Category.new
+      c.id = node['id'].to_i
+      c.icon = node['i']
+      c.name = node['n']
+      @language = opts[:language] unless opts[:language].nil?
+      c.description = node['d']
+      node.xpath("c").each do |subcat|
+        # puts "found subcat #{subcat['n']}"
+        Category.from_node subcat, parent: c, language: @language
+      end
+      node.xpath("g").each do |game|
+        c.games << Game.from_node(game, c, @language)
+      end
+      
+      c.parent = opts[:parent]
+      c.parent.children << c unless c.parent.nil?
+      return c
+    end
+  end
+  
+  class Games
+    attr_accessor :images, :categories
+
+    def initialize()
+      @categories = []
+      @games = []
+    end
+
+    def load_from_xml(the_xml, language = IGE_ISB_API::Constants::DEFAULT_LANGUAGE)
+      doc = Nokogiri::XML(the_xml)
+      @images = doc.xpath("//images").first['url']
+      doc.xpath("//games/c").each do |cat_node|
+        @categories << Category.from_node(cat_node, language: language)
+      end
+    end
+  end
+end