ige_isb_api 1.0.0

data/lib/ige_isb_api/bonus.rb

@@ -0,0 +1,249 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+require "net/http"
+require "uri"
+require 'cgi'
+require 'date'
+require "ige_isb_api"
+require "ige_isb_api/constants"
+
+module IGE_ISB_API
+  class Bonus
+    attr_accessor :command, :params, :request
+
+    DEFAULT_PARAMS = {
+      'api_key' => IGE_ISB_API::Constants::BONUS_API_KEY
+    }
+
+    COMMON_FIELDS = {
+      'api_key' => {:required => true, :type => 'string', :length => 128}
+    }
+
+    COMMANDS = {
+      'get_trigger_bonus' => {
+        'login' => {:required => true, :type => 'username', :length => 32},
+        'trigger' => {required: true, type: 'string', values: ['sign up', 'deposit', 'promotion code']},
+        'transaction_ref' => {required: false, type: 'string', length: 128}
+      },
+      'get_client_bonuses' => {
+        'login' => {:required => true, :type => 'username', :length => 32},
+        'statuses' => {required: false, type: 'string',
+                      values: IGE_ISB_API::Constants::ALLOWED_BONUS_STATUSES},
+        'types' => {required: false, type: 'string',
+                      values: IGE_ISB_API::Constants::ALLOWED_BONUS_TYPES},
+        'cartecs' => {required: false, type: 'string', length: 255},
+        'start_date' => {required: false, type: 'date'},
+        'end_date' => {required: false, type: 'date'},
+        'start' => {required: false, type: 'int'},
+        'results_per_page' => {required: false, type: 'int'},
+        'order_by_field' => {required: false, type: 'string', values: [
+          'cartec', 'bonus_initial_value', 'bonus_current_value', 'bonus_state',
+          'bonus_type', 'issue_date', 'expiration_date', 'bonus_finish_date',
+          'issued_by', 'total_bet', 'name'
+        ]},
+        'order_by_dir' => {required: false, type: 'string', values: ['ASC', 'DESC']},
+        'include_expired' => {required: false, type: 'boolint'},
+        'only_expired' => {required: false, type: 'boolint'}
+      },
+      'count_client_bonuses' => {
+        'login' => {required: true, type: 'username'},
+        'statuses' => {required: false, type: 'string',
+                      values: IGE_ISB_API::Constants::ALLOWED_BONUS_STATUSES},
+        'types' => {required: false, type: 'string',
+                      values: IGE_ISB_API::Constants::ALLOWED_BONUS_TYPES},
+        'cartecs' => {required: false, type: 'string', length: 255},
+        'start_date' => {required: false, type: 'date'},
+        'end_date' => {required: false, type: 'date'},
+        'include_expired' => {required: false, type: 'boolint'},
+        'only_expired' => {required: false, type: 'boolint'}
+      },
+      'has_pending_offers' => {
+        'login' => {required: true, type: 'username'},
+      },
+      'accept_bonus' => {
+        'login' => {required: true, type: 'username'},
+        'id' => {required: true, type: 'int'}
+      },
+      'decline_bonus' => {
+        'login' => {required: true, type: 'username'},
+        'id' => {required: true, type: 'int'}
+      },
+      'get_remaining_playthrough' => {
+        'login' => {required: true, type: 'username'}
+      },
+      'remove_bonus_and_winnings_on_withdraw' => {
+        'login' => {required: true, type: 'username'}
+      },
+      'issue_bonus' => {
+        'login' => {required: true, type: 'username'},
+        'id_template' => {required: false, type: 'int'},
+        'amount' => {required: false, type: 'currency'},
+        'deposit_number' => {required: false, type: 'int'},
+        'transaction_ref' => {required: false, type: 'string'},
+        'transaction_type' => {required: false, type: 'string'},
+        'transaction_date' => {required: false, type: 'timestamp'},
+        'promo' => {required: false, type: 'string'},
+        'location' => {required: false, type: 'string', values: ['cert', 'certd']}
+      },
+      'cancel_bonus' => {
+        'login' => {required: true, type: 'username'},
+        'id_template' => {required: false, type: 'int'},
+        'comment' => {required: false, type: 'string'}
+      },
+      'reset_bonus' => {
+        'login' => {required: true, type: 'username'}
+      },
+      'update_active_balance_current_value' => {
+        'login' => {required: true, type: 'username'},
+        'deposit' => {required: true, type: 'currency'}
+      },
+      'assign_certificate_to_player' => {
+        'email' => {required: true, type: 'email', length: 50},
+        'certificate_name' => {required: true, type: 'string'}
+      },
+      'bonus_vip_points' => {
+        'login' => {required: true, type: 'username'},
+        'amount' => {required: true, type: 'currency'},
+        'reason' => {required: false, type: 'string'},
+        'name' => {required: true, type: 'string'}
+      },
+      'generate_certificate' => {
+        'template_certificate_id' => {required: true, type: 'int'}
+      },
+      'generate_player_assigned_certificate' => {
+        'login' => {required: true, type: 'username'},
+        'template_certificate_id' => {required: true, type: 'int'}
+      },
+      'get_template_id_by_name' => {
+        'name' => {required: true, type: 'string'}
+      },
+      'count_promo_codes' => {
+        'login' => {required: true, type: 'username'},
+        'start_date' => {required: true, type: 'timestamp'},
+        'end_date' => {required: true, type: 'timestamp'}
+      },
+      'sum_bonuses' => {
+        'login' => {required: true, type: 'username'},
+        'casino_prefix' => {required: false, type: 'string'}
+      },
+      'is_transaction_used' => {
+        'login' => {required: true, type: 'username'},
+        'transaction' => {required: true, type: 'string'}
+      },
+      'get_player_assigned_certificates' => {
+        'login' => {required: true, type: 'username'},
+        'promotion_code' => {required: false, type: 'string'},
+        'template_certificate_ids' => {required: false, type: 'string'},
+        'start_date' => {required: false, type: 'date'},
+        'end_date' => {required: false, type: 'date'}
+      },
+      'delete_player_assigned_certificate' => {
+        'login' => {required: true, type: 'username'},
+        'promotion_code' => {required: true, type: 'string'}
+      },
+      'delete_generated_certificate' => {
+        'promotion_code' => {required: true, type: 'string'}
+      },
+      'certificate_exists' => {
+        'promotion_code' => {required: true, type: 'string'}
+      }
+    }
+
+    def initialize(command, params = {})
+      self.command = command
+      self.params = self.class::DEFAULT_PARAMS.merge(self.convert_symbols_to_strings(params))
+      self.validate_parameters
+      # a bunch of stuff
+      self.sign
+      self.construct_request
+    end
+
+    def send
+      uri = URI.parse(IGE_ISB_API::Constants::BONUS_API_SERVER)
+      http = Net::HTTP.new(uri.host, uri.port)
+      # see http://www.rubyinside.com/nethttp-cheat-sheet-2940.html
+#       http.use_ssl = true
+#       http.cert = OpenSSL::X509::Certificate.new(pem)
+#       http.key = OpenSSL::PKey::RSA.new(pem)
+#       http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+      return http.request(self.request)
+    end
+
+    protected
+
+    # hash generated through the HMAC method using the sha256 algorithm with a private md5 key provided by ISB.
+    # The hash has to be made up of the url encoded query string, excluding the api_key
+    # Example: hash_hmac(“sha256”,urlencode(“param1=value1&param2=value2&param3=value3”),”private_key”)
+    def sign
+      return unless self.params['signature'].nil?
+      encoded_params = self.params.map { |key, value| "#{key}=#{value}" }
+      encoded_params.shift # remove the first item which is always the 'api_key'
+      hmac = Digest::HMAC.new(IGE_ISB_API::Constants::BONUS_SECRET_KEY, Digest::SHA256)
+      hmac << CGI.escape(encoded_params.join('&'))
+      self.params['signature'] = hmac.to_s
+      # puts "debugging params: api_key=#{self.params['api_key']}&#{encoded_params.join('&')}&signature=#{hmac.to_s}"
+    end
+
+    def convert_symbols_to_strings(a_hash = {})
+      return {} if a_hash.empty?
+      result = {}
+      a_hash.each {|key, value| result[key.to_s] = value }
+      return result
+    end
+
+    def validate_parameters
+      comfields = self.class::COMMANDS[self.command]
+      raise ValidationException, "Invalid command #{command}." if comfields.nil?
+      fields = self.class::COMMON_FIELDS.merge(comfields)
+      self.validate_fields(fields)
+      self.validate_no_extra_fields(fields)
+    end
+
+    def validate_fields(against)
+      against.each do |name, meta|
+        required = (meta[:required] === true)
+        # Check that all required parameters are present
+        if required && !self.params.keys.include?(name)
+          raise ValidationException, "Parameter #{name} is required, but missing from #{self.params.keys}"
+        end
+        if self.params.keys.include? name
+          p = self.params[name]
+          if p != nil
+            case meta[:type]
+            when 'timestamp'
+              self.params[name] = p = p.to_time.utc.to_i if p.is_a? Date
+              self.params[name] = p = p.utc.to_i if p.is_a?(Time)
+              self.params[name] = p = p.to_i if p.is_a?(String)
+            when 'currency'
+              p = p.to_f if p.is_a? String
+              if (p.is_a?(Float) || p.is_a?(Integer)) && p > 0
+                self.params[name] = p = "%.2f" % p 
+              end
+            end
+            opts = {}
+            opts[:length] = meta[:length] if meta[:length]
+            opts[:values] = meta[:values] if meta[:values]
+            IGE_ISB_API::Validation.test name, self.params[name], meta[:type], opts
+          end
+        end
+      end
+    end
+
+    def validate_no_extra_fields(against)
+      allowed_fields = against.keys
+      self.params.each do |key, value|
+        raise InternalException, "Field #{key} is not supported" if !allowed_fields.include?(key)
+      end
+    end
+
+    def construct_request
+      raise RuntimeError, "Missing environment variable 'ISOFTBET_BONUS_API_SERVER'" if IGE_ISB_API::Constants::BONUS_API_SERVER.nil?
+      uri = URI.parse("#{IGE_ISB_API::Constants::BONUS_API_SERVER}/bonus_system/api/#{self.command}")
+      # http = Net::HTTP.new(uri.host, uri.port)
+      self.request = Net::HTTP::Post.new(uri)
+      self.request.set_form_data(self.params)
+    end
+
+  end
+end

data/lib/ige_isb_api/bonus_api.rb

@@ -0,0 +1,125 @@
+#!/user/bin/env ruby
+#coding: utf-8
+
+module IGE_ISB_API
+  class BonusAPI
+
+    def initialize()
+      # nothing to do here right now.
+    end
+
+    # the following options *must* be passed in.
+    #     trigger: one of 'sign up', 'deposit', or 'promotion code'
+    #     login: "the user's username, as registered with ISB",
+    #
+    # The following may be passed in and are presented here with their defaults.
+    #     transaction_ref: some unique transaction reference,
+    def get_trigger_bonus(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+
+    def get_client_bonuses(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+ 
+    def count_client_bonuses(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+ 
+    def has_pending_offers(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+ 
+    def accept_bonus(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+ 
+    def decline_bonus(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+ 
+    def get_remaining_playthrough(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+ 
+    def remove_bonus_and_winnings_on_withdraw(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def issue_bonus(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def cancel_bonus(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def reset_bonus(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def update_active_balance_current_value(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def assign_certificate_to_player(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def bonus_vip_points(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def generate_certificate(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def generate_player_assigned_certificate(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def get_template_id_by_name(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def count_promo_codes(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def sum_bonuses(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def is_transaction_used(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def get_player_assigned_certificates(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def delete_player_assigned_certificate(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def delete_generated_certificate(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    def certificate_exists(opts = {})
+      return get_response_for __method__.to_s, opts
+    end
+    
+    protected
+    
+    def get_response_for(a_command, opts = {})
+      # puts "got command #{a_command} with options #{opts}"
+      raise ArgumentError, "Missing options." if opts.empty?
+      bonus_request = IGE_ISB_API::Bonus.new a_command, opts
+      resp = bonus_request.send
+      response = JSON.parse(resp.body)
+      return response
+    end
+
+  end
+end

data/lib/ige_isb_api/callback.rb

@@ -0,0 +1,83 @@
+#!/user/bin/env ruby
+#coding: utf-8
+require 'digest'
+
+module IGE_ISB_API
+  class Callback
+
+    # {
+    #   "player": String # player login as originally passed to ISB at .registration,
+    #   "requestid":Integer, # same as we provided in the IDREQUEST field
+    #   "token": String - # a SHA2 digest of our 'SECRETKEY' + 'IDREQUEST' which we will use to authenticate the incoming info.,
+    #   "sesson-start":"2013/10/25.10:54:18",
+    #   "sesson-end":"2013/10/25.12:32:51",
+    #   "skin_ID": 2019
+    #   "currency":"USD",
+    #   "hostID":1,
+    #   "actions":[
+    #     {
+    #       "bet":{
+    #          "amount": 1.00
+    #       },
+    #       "bet":{
+    #          "amount": 50.00
+    #       },
+    #       "win":{
+    #          "amount": 80.00
+    #       }
+    #     }
+    #   ]
+    # }
+    def self.parse(raw_data)
+      raise ValidationException, "No data to parse" if raw_data.nil? || raw_data.empty?
+      begin
+        data = JSON.parse(raw_data)
+        player = data['player']
+        IGE_ISB_API::Validation.test('player', player, 'username')
+        requestid = data['requestid'].to_i
+        IGE_ISB_API::Validation.test('requestid', requestid, 'int')
+        token = data['token']
+        expected = (Digest::SHA2.new << "#{IGE_ISB_API::Constants::SECRET_KEY}#{requestid}").to_s
+        raise ValidationException, "Invalid Token" unless token == expected
+        session_start = DateTime.strptime(data['session-start'], "%Y/%m/%d.%H:%M:%S").to_time.utc
+        session_end = DateTime.strptime(data['session-end'], "%Y/%m/%d.%H:%M:%S").to_time.utc
+        raise ValidationException, "session-end must be after session-start" unless session_start < session_end
+        skinid = data['skin_ID'].to_i
+        IGE_ISB_API::Validation.test('skin_ID', skinid, 'int')
+        currency = data['currency']
+        IGE_ISB_API::Validation.test('currency', currency, 'currency_code')
+        hostid = data['hostID'].to_i
+        actions = data['actions'].map do |act|
+          if act['bet']
+            {
+              action: :bet,
+              amount: act['bet']['amount'].to_f
+            }
+          elsif act['win']
+            {
+              action: :win,
+              amount: act['win']['amount'].to_f
+            }
+          else
+            raise ValidationException, "Invalid Action"
+          end
+        end
+        return {
+          player: player,
+          requestid: requestid,
+          session_start: session_start,
+          session_end: session_end,
+          skinid: skinid,
+          currency: currency,
+          hostid: hostid,
+          actions: actions
+        }
+      rescue ArgumentError => ae
+        raise ValidationException, ae.message
+      rescue JSON::ParserError => jpe
+        raise ValidationException, "Invalid JSON format in supplied data: #{jpe.message}"
+      end
+    end
+
+  end
+end