ige_isb_api 1.1.2 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2a0598200aa8da360e75d735127dd278f92d6c62
-  data.tar.gz: 4d1b31f6327eaddbd62a9433bb631641e94c4073
+  metadata.gz: 67aece4b49ff763e9136f0f46590cf9b120f38c1
+  data.tar.gz: 4f46335786f00997db20ebb3b1ba77e6254f7928
 SHA512:
-  metadata.gz: 8e852c53bdd61b97086cf53b6a397a94f09bff002db832191a223ff4fe724096de58e1dbb975f98a9712e1488ec79fa6f45bcb23bcab86e9bbcc82a70441a175
-  data.tar.gz: 733667b0820942f85eb0c480c839138eec999cce842b80db8825697c5eccd1bea6d2a6fb9b464b4313b1ba7a03e55355ba392a684c5aad3dbfaab61ed56af364
+  metadata.gz: b4dbf5fcaf83c753927d1d79a632f984b87e5d003232d24610d01bf5dabea8f42b34d1708f348cc9197a5d5aaa260be45198dbf2228b89cc8e90c6b12b32e356
+  data.tar.gz: b78c664e78e4053067888e15848e143214dad6b192779efc1410dbad874db96695255fab75853f5faa4e62a726d0c3139839165bbebaca6b47d84951d942d2e5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ige_isb_api (1.1.2)
+    ige_isb_api (1.1.3)
       nokogiri
       rfc-822
 
@@ -11,10 +11,10 @@ GEM
     diff-lcs (1.2.5)
     dotenv (0.9.0)
     mini_portile (0.5.2)
-    nokogiri (1.6.0)
+    nokogiri (1.6.1)
       mini_portile (~> 0.5.0)
-    rake (10.1.0)
-    rfc-822 (0.3.0)
+    rake (10.1.1)
+    rfc-822 (0.4.0)
     rspec (2.14.1)
       rspec-core (~> 2.14.0)
       rspec-expectations (~> 2.14.0)

data/README.md

@@ -1,7 +1,7 @@
 IGE's Wrapper for ISB APIs
 ==========================
 
-Ruby Wrapper for ISB's `User API Version 2.1`, as well as the documents
+Ruby Wrapper for ISB's `User API Version 2.3`, as well as the documents
 `Integrating ISB HTML5 Games_v1.3` and `Integrating ISB Flash Games_v1.4` (available from ISB), and ISB Bonus API version 1.5.
 
 ## Usage
@@ -143,14 +143,14 @@ url = IGE_ISB_API::Game.game_launcher_url player_id: 'player_id', currency: 'EUR
                                           idrequest: 'somethingunique'
 ```
 
-## Parsing Callback Data
+## Parsing Game Session Callback Data
 
 Once a player has finished their gameplay session, ISB will post session details back
 to the casino server in the form of a JSON serialized blob of data.
 You can easily parse that data into a standard Ruby Hash for your application to use as needed.
 
 ```Ruby
-data = IGE_ISB_API::Callback.parse raw_data
+data = IGE_ISB_API::Callback::GameplaySession.parse raw_data
 player = data[:player]                # player login as passed in via IGE_ISB_API.register
 requestid = data[:requestid]          # the request id passed in when the game is launched.
 session_start = data[:session_start]  # a Time object in UTC timezone
@@ -167,6 +167,22 @@ end
 
 It will throw an `IGE_ISB_API::ValidationException` if the incoming data is bad.
 
+## Parsing Withdrawal Callback Data
+
+Once a player's pending withdrawal has been approved, ISB will post withdrawal details back
+to the casino server in the form of a JSON serialized blob of data.
+You can easily parse that data into a standard Ruby Hash for your application to use as needed.
+
+```Ruby
+data = IGE_ISB_API::Callback::Withdrawal.parse raw_data
+player = data[:player]                # player login as passed in via IGE_ISB_API.register
+ref = data[:withdrawal_reference]     # the withdrawal_reference passed in when the pending withdrawal was created.
+approved = data[:approved]            # true or false
+operator = data[:operator]            # the username of the person who approved the withdrawal
+```
+
+It will throw an `IGE_ISB_API::ValidationException` if the incoming data is bad.
+
 ## The Bonus API
 
 ```Ruby

data/ige_isb_api.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.version       = IGE_ISB_API::VERSION
   spec.authors       = ["Dave Sag"]
   spec.email         = ["davesag@gmail.com"]
-  spec.description   = "Implements all of the features of the ISB API version #{IGE_ISB_API::Constants::API_VERSION}."
-  spec.summary       = "A Ruby Wrapper for the ISB API version #{IGE_ISB_API::Constants::API_VERSION}"
+  spec.description   = "Implements all of the features of the ISB USER API version #{IGE_ISB_API::Constants::USER_API_VERSION}, and BONUS API version #{IGE_ISB_API::Constants::BONUS_API_VERSION}."
+  spec.summary       = "A Ruby Wrapper for the ISB USER and BONUS APIs, and Game Launcher"
   spec.homepage      = "https://github.com/Interactive-Gaming-Entertainment/IGE_ISB_API"
   spec.license       = "MIT"
   spec.date          = Time.now.utc.strftime("%Y-%m-%d")

data/lib/ige_isb_api/callback.rb

@@ -3,81 +3,134 @@
 require 'digest'
 
 module IGE_ISB_API
-  class Callback
+  module Callback
+    class GameplaySession
 
-    # {
-    #   "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']
+      # {
+      #   "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
+    
+    class Withdrawal
+
+      # Parses incoming Withdrawl data of the form:
+      # [
+      #   {
+      #     “player” : “<the player’s username>”,
+      #     “withdrawal_reference” : “<the reference we supplied via UserAPI.withdraw>”,
+      #     “approved” : true | false, # if false then the withdrawal was declined, not approved.
+      #     “operator” : “<the username of the LGF Staff member who approved / declined the withdrawal via the Back Office>”,
+      #     “checksum” : "<SHA256 of (player + withdrawal_reference + SECRET_KEY)>"
+      #   }, …
+      # ]
+      def self.parse(raw_data)
+        raise ValidationException, "No data to parse" if raw_data.nil? || raw_data.empty?
+        begin
+          data = JSON.parse(raw_data)
+          result = data.map do |wd|
+            player = wd['player']
+            IGE_ISB_API::Validation.test('player', player, 'username')
+            withdrawal_reference = wd['withdrawal_reference'].to_i
+            IGE_ISB_API::Validation.test('withdrawal_reference', withdrawal_reference, 'int')
+            approved = wd['approved']
+            unless !!approved == approved
+              if approved.is_a?(String) && ( approved == 'true' || approved == 'false')
+                approved = (approved == 'true')
+              else
+                raise ArgumentError, "Expected 'approved' to be true or false"
+              end
+            end
+            checksum = wd['checksum']
+            expected = (Digest::SHA256.new << "#{player}#{withdrawal_reference}#{IGE_ISB_API::Constants::SECRET_KEY}").to_s
+            raise ValidationException, "Invalid Checksum" unless checksum == expected
+            operator = wd['operator']
+            IGE_ISB_API::Validation.test('operator', operator, 'username')
+          
             {
-              action: :win,
-              amount: act['win']['amount'].to_f
+              player: player,
+              withdrawal_reference: withdrawal_reference,
+              approved: approved,
+              operator: operator
             }
-          else
-            raise ValidationException, "Invalid Action"
           end
+          return result
+        rescue ArgumentError => ae
+          raise ValidationException, ae.message
+        rescue JSON::ParserError => jpe
+          raise ValidationException, "Invalid JSON format in supplied data: #{jpe.message}"
         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

data/lib/ige_isb_api/constants.rb

@@ -3,7 +3,8 @@
 
 module IGE_ISB_API
   class Constants
-    API_VERSION = '2.2'
+    USER_API_VERSION = '2.3'
+    BONUS_API_VERSION = '1.5'
 
     LICENSEE_ID = ENV['ISB_LICENSEE_ID'].to_i      # issued by ISB
     CASINO = ENV['ISB_CASINO_ID']                  # issued by ISB

data/lib/ige_isb_api/request.rb

@@ -55,7 +55,8 @@ module IGE_ISB_API
         'amount' => {:required => true, :type => 'int'},
         'reference' => {:required => true, :type => 'string', :length => 32},
         'cur' => {:required => true, :type => 'currency_code', :length => 3},
-        'wallet' => {:required => true, :type => 'string', :length => 32}
+        'wallet' => {:required => true, :type => 'string', :length => 32},
+        'creditcardnumber' => {:required => true, :type => 'string', :length => 32}
         },
       'cancel_withdrawal' => {
         'withdrawalid' => {:required => true, :type => 'int'}

data/lib/ige_isb_api/version.rb

@@ -2,5 +2,5 @@
 #coding: utf-8
 
 module IGE_ISB_API
-  VERSION = "1.1.2"
+  VERSION = "1.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ige_isb_api
 version: !ruby/object:Gem::Version
-  version: 1.1.2
+  version: 1.1.3
 platform: ruby
 authors:
 - Dave Sag
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -94,7 +94,8 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Implements all of the features of the ISB API version 2.2.
+description: Implements all of the features of the ISB USER API version 2.3, and BONUS
+  API version 1.5.
 email:
 - davesag@gmail.com
 executables: []
@@ -139,5 +140,5 @@ rubyforge_project:
 rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: A Ruby Wrapper for the ISB API version 2.2
+summary: A Ruby Wrapper for the ISB USER and BONUS APIs, and Game Launcher
 test_files: []