alphaSDK 0.2.0 → 0.2.8

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gameball"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/examples.rb

@@ -0,0 +1,174 @@
+# This file is not to be executed, this is for offering examples for the usage of the SDK
+require "gameball"
+Gameball.api_key = "7c7636658209418c9a82306a421f76a5"
+Gameball.api_version = "v2.0"
+Gameball::transaction_key = "26e1967d89114388bdd1772587c336c8"
+# Events
+# Example 1
+Gameball::Event.send_event({
+  events: {
+    place_order: {
+      total_amount: "100",
+      category: [
+        "electronics",
+        "cosmetics",
+      ],
+    },
+    review: {},
+  },
+  playerUniqueId: "player123",
+})
+# Example 2
+Gameball::Event.send_event({
+  events: {
+    reserve: {
+      rooms: 2,
+    },
+  },
+  playerUniqueId: " player123",
+  playerAttributes: {
+    displayName: " Jon Snow",
+    email: "jon.snow@example.com",
+    dateOfBirth: "1980-09-19T00:00:00.000Z",
+    joinDate: "2019-09-19T21:06:29.158Z",
+  },
+})
+# Example 3
+Gameball::Event.send_event({
+  events: {
+    reserve: {
+      rooms: 2,
+    },
+  },
+  playerUniqueId: " player123",
+  playerAttributes: {
+    displayName: " Jon Snow",
+    email: "jon.snow@example.com",
+    dateOfBirth: "1980-09-19T00:00:00.000Z",
+    joinDate: "2019-09-19T21:06:29.158Z",
+    custom: {
+      location: "Miami",
+      graduationDate: "2018-07-04T21:06:29.158Z",
+      isMarried: false,
+    },
+  },
+})
+# Referrals
+# Example 1
+Gameball::Referral.create_referral({
+  playerCode: "CODE11",
+  playerUniqueId: "player456",
+})
+# Example 2
+Gameball::Referral.create_referral({
+  playerCode: "CODE11",
+  playerUniqueId: "player456",
+  playerAttributes: {
+    displayName: " Tyrion Lannister",
+    firstName: "Tyrion",
+    lastName: "Lannister",
+    email: "tyrion@example.com",
+    gender: "M",
+    dateOfBirth: "1978-01-11T00:00:00.000Z",
+    joinDate: "2019-09-19T21:06:29.158Z",
+    custom: {
+      location: "Miami",
+      graduationDate: "2018-07-04T21:06:29.158Z",
+      isMarried: false,
+    },
+  },
+})
+# Reward
+# Example 1
+Gameball::Transaction.reward_points({
+  playerUniqueId: "player123",
+  amount: 99.98,
+  transactionId: "tra_123456789"
+})
+# Example 2
+Gameball::Transaction.reward_points({
+  playerUniqueId: "player456",
+  amount: 2500,
+  transactionId: "tra_123456789",
+  playerAttributes: {
+    displayName: " Tyrion Lannister",
+    firstName: "Tyrion",
+    lastName: "Lannister",
+    email: "tyrion@example.com",
+    gender: "M",
+    dateOfBirth: "1978-01-11T00:00:00.000Z",
+    joinDate: "2019-09-19T21:06:29.158Z",
+    custom: {
+      location: "Miami",
+      graduationDate: "2018-07-04T21:06:29.158Z",
+      isMarried: false,
+    },
+  }
+})
+# Get Player Balance
+Gameball::Transaction.get_player_balance("player456")
+# Hold
+# Example 1
+Gameball::Transaction.hold_points({
+  playerUniqueId: "player456",
+  amount: 98.89
+})
+# Redeem
+# Example 1
+Gameball::Transaction.redeem_points({
+  playerUniqueId: "player456",
+  amount: 10,
+  transactionId: "tra_123456789",
+  holdReference: "2342452352435234"
+})
+# Reverse Transaction
+# Example 1
+Gameball::Transaction.reverse_transaction({
+  playerUniqueId: "player456",
+  transactionId: "1234567890",
+  reversedTransactionId: "234567891"
+})
+Gameball::Transaction.reverse_hold({
+  playerUniqueId: " player456",
+  holdReference: "9245fe4a-d402-451c-b9ed-9c1a04247482"
+})
+
+# Action
+# Example 1
+Gameball::Action.send_action({
+	playerUniqueId: "your_player_unique_id",
+	events: {
+		review: {},
+		reserve: {
+			rooms: 2
+		}
+	}
+})
+# Example 2
+Gameball::Action.send_action({
+	playerUniqueId: "your_player_unique_id",
+	events: {
+		review: {},
+		reserve: {
+			rooms: 2
+		}
+	},
+	pointsTransaction: {
+		rewardAmount: 2,
+		transactionId: "234567890"
+	}
+})
+# Example 3
+Gameball::Action.send_action({
+	playerUniqueId: "your_player_unique_id",
+	events: {
+		review: {},
+		reserve: {
+			rooms: 2
+		}
+	},
+	pointsTransaction: {
+		rewardAmount: 2,
+		holdReference: "2342452352435234",
+		transactionId: "234567890"
+	}

data/gameball.gemspec

@@ -0,0 +1,29 @@
+require_relative 'lib/gameball/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "alphaSDK"
+  spec.version       = Gameball::VERSION  
+  spec.authors       = ["Alsouidan"]
+  spec.email         = ["alsouidan@gmail.com"]
+
+  spec.summary       = "Ruby SDK for Gameball's API"
+  spec.homepage      = "https://www.gameball.co/"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+  spec.add_dependency 'rake','>= 12.0'
+  spec.add_dependency 'rspec','>= 3.0'
+  # spec.metadata["allowed_push_host"] = "https://github.com/Alsouidan/alphasdk"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "http://mygemserver.com"
+  spec.metadata["changelog_uri"] = "http://mygemserver.com"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/gameball.rb

@@ -1,11 +1,12 @@
+# Requiring all dependencies needed
 require "net/http"
 require "net/http"
 require "openssl"
 require "uri"
-require 'Time'
-require 'digest/sha1'
-require 'json'
-require 'async'
+require "Time"
+require "digest/sha1"
+require "json"
+# Requiring all the other files to help us require this fiel only
 require_relative "./gameball/utils/request"
 require_relative "./gameball/utils/helper"
 require_relative "./gameball/utils/validation"
@@ -13,23 +14,23 @@ require_relative "./gameball/models/player"
 require_relative "./gameball/models/event"
 require_relative "./gameball/models/transaction"
 require_relative "./gameball/models/referral"
+require_relative "./gameball/models/coupon"
+require_relative "./gameball/models/action"
 require_relative "./gameball/exceptions/gameballException"
 
-
 module Gameball
-    @api_base = "https://gb-api.azurewebsites.net"
-    @max_retries=1
-    @read_timeout=60
-    @keep_alive_timeout=30
-    @api_version="v1.0"
-    class << self
-        attr_accessor :api_key
-        attr_accessor :api_version
-        attr_accessor :transaction_key
-        attr_accessor :read_timeout
-        attr_accessor :max_retries
-        attr_reader :keep_alive_timeout
-        attr_reader :api_base
-
-    end
+  @api_base = "https://gb-api.azurewebsites.net"
+  @max_retries = 1
+  @read_timeout = 60
+  @keep_alive_timeout = 30
+  @api_version = "v2.0"
+  class << self
+    attr_accessor :api_key
+    attr_accessor :api_version
+    attr_accessor :transaction_key
+    attr_accessor :read_timeout
+    attr_accessor :max_retries
+    attr_reader :keep_alive_timeout
+    attr_reader :api_base
+  end
 end

data/lib/gameball/exceptions/gameballException.rb

@@ -1,7 +1,7 @@
 module Gameball
-    class GameballError < StandardError
-        def initialize (msg="Something went wrong while authorizing your request")
-            super(msg)
-        end
+  class GameballError < StandardError # Custom GameballError that inherits from Ruby StandardError
+    def initialize(msg = "Something went wrong while authorizing your request")
+      super(msg)
     end
-end
+  end
+end

data/lib/gameball/models/action.rb

@@ -1,13 +1,31 @@
 module Gameball
-    class Action
-        def send_action(body)
-            Gameball::Utils.validate(body,['playerUniqueId'],['playerAttributes','events','pointsTransaction'])
-            res=Gameball::Utils::request("post","/Integrations/Action",body)
-            unless res.kind_of? Net::HTTPSuccess
-                raise Gameball::GameballError.new(res) # use custom message
-            else 
-                return res
-            end
+  class Action
+    def self.send_action(body)
+      # Validating keys in incoming body
+      Gameball::Utils.validate(body, ["playerUniqueId"], ["playerAttributes", "events", "pointsTransaction"])
+      if body.has_key? (:pointsTransaction)
+        # Validating pointsTransaction object in body
+        Gameball::Utils.validate(body[:pointsTransaction], ['transactionId'],['rewardAmount','holdReference'])
+        body[:pointsTransaction][:transactionTime]=Time.now.utc
+        amount=''
+        if body[:pointsTransaction].has_key?(:rewardAmount)
+          amount=body[:pointsTransaction][:rewardAmount]
         end
+        body[:pointsTransaction]['hash']=Gameball::Utils.hashBody(playerUniqueId:body[:playerUniqueId],transactionTime:body[:pointsTransaction][:transactionTime],amount:amount)
+        body[:pointsTransaction][:transactionTime]=Time.now.utc.iso8601
+      end
+
+      res = Gameball::Utils::request("post", "/Integrations/Action", body)
+      # Check for HTTP Success and throws error if not success
+      unless res.kind_of? Net::HTTPSuccess
+        if res.kind_of? Net::HTTPInternalServerError
+          raise Gameball::GameballError.new("An Internal Server Error has occurred")
+        else
+          raise Gameball::GameballError.new(res.body) 
+        end
+      else
+        return res
+      end
     end
-end
+  end
+end

data/lib/gameball/models/coupon.rb

@@ -1,37 +1,58 @@
 module Gameball
- class Coupon
-    def self.create_discount_coupon(body)
-        Gameball::Utils.validate(body,['playerUniqueId','transactionTime'],['startAt','endsAt','entitledCollectionIds','entitledProductIds',
-            'oncePerCustomer','prerequisiteQuantityRange','prerequisiteShippingPriceRange','prerequisiteSubtotalRange',
-            'prerequisiteCollectionIds','prerequisiteProductIds','code','usageLimit','value','valueType','cap'])
-        body["hash"]=Gameball::Utils::hashBody(playerUniqueId:body[:playerUniqueId])
-        res=Gameball::Utils::request("post","/Integrations/Coupon",body)        
-            unless res.kind_of? Net::HTTPSuccess
-                raise Gameball::GameballError.new(res) # use custom message
-            else 
-                return res
-            end
+  class Coupon
+    def self.create_discount_coupon(body) 
+      # Validating keys in incoming body
+      Gameball::Utils.validate(body, ["playerUniqueId"], ["startAt", "endsAt", "entitledCollectionIds", "entitledProductIds",
+                                                          "oncePerCustomer", "prerequisiteQuantityRange", "prerequisiteShippingPriceRange", "prerequisiteSubtotalRange",
+                                                          "prerequisiteCollectionIds", "prerequisiteProductIds", "code", "usageLimit", "value", "valueType", "cap"])
+
+      body[:transactionTime] = Time.now.utc
+      body["hash"] = Gameball::Utils::hashBody(playerUniqueId: body[:playerUniqueId])
+      res = Gameball::Utils::request("post", "/Integrations/Coupon", body)
+      # Check for HTTP Success and throws error if not success
+      unless res.kind_of? Net::HTTPSuccess
+        if res.kind_of? Net::HTTPInternalServerError
+          raise Gameball::GameballError.new("An Internal Server Error has occurred")
+        else
+          raise Gameball::GameballError.new(res.body) 
+        end
+      else
+        return res
+      end
     end
     def self.validate_discount_coupon(body)
-        Gameball::Utils.validate(body,['playerUniqueId','code','transactionTime'])
-        body["hash"]=Gameball::Utils::hashBody(playerUniqueId:body[:playerUniqueId])
-        res=Gameball::Utils::request("post","/Integrations/Coupon/Validate",body)
-        unless res.kind_of? Net::HTTPSuccess
-            raise Gameball::GameballError.new(res) # use custom message
-        else 
-            return res
+      # Validating keys in incoming body
+      Gameball::Utils.validate(body, ["playerUniqueId", "code"])
+      body[:transactionTime] = Time.now.utc
+      body["hash"] = Gameball::Utils::hashBody(playerUniqueId: body[:playerUniqueId])
+      res = Gameball::Utils::request("post", "/Integrations/Coupon/Validate", body)
+      # Check for HTTP Success and throws error if not success
+      unless res.kind_of? Net::HTTPSuccess
+        if res.kind_of? Net::HTTPInternalServerError
+          raise Gameball::GameballError.new("An Internal Server Error has occurred")
+        else
+          raise Gameball::GameballError.new(res.body) 
         end
+      else
+        return res
+      end
     end
     def self.redeem_discount_coupon(body)
-        Gameball::Utils.validate(body,['playerUniqueId','code','transactionTime'])
-        body["hash"]=Gameball::Utils::hashBody(playerUniqueId:body[:playerUniqueId])
-        res=Gameball::Utils::request("post","/Integrations/Coupon/Redeem",body)
-        unless res.kind_of? Net::HTTPSuccess
-            raise Gameball::GameballError.new(res) # use custom message
-        else 
-            return true
+      # Check for HTTP Success and throws error if not success
+      Gameball::Utils.validate(body, ["playerUniqueId", "code"])
+      body[:transactionTime] = Time.now.utc
+      body["hash"] = Gameball::Utils::hashBody(playerUniqueId: body[:playerUniqueId])
+      res = Gameball::Utils::request("post", "/Integrations/Coupon/Redeem", body)
+      # Check for HTTP Success and throws error if not success
+      unless res.kind_of? Net::HTTPSuccess
+        if res.kind_of? Net::HTTPInternalServerError
+          raise Gameball::GameballError.new("An Internal Server Error has occurred")
+        else
+          raise Gameball::GameballError.new(res.body) 
         end
+      else
+        return true
+      end
     end
-
- end
-end
+  end
+end

data/lib/gameball/models/event.rb

@@ -1,29 +1,34 @@
 module Gameball
-    class Event
-        # include Gameball::Request
-        def self.sendEvent (eventBody)
-            Gameball::Utils.validate(eventBody,['events','playerUniqueId'],['playerAttributes'])
-        if eventBody.has_key?(:playerAttributes)
-            # Gameball::Utils.validate(eventBody[:playerAttributes],['displayName','firstName','lastName','email','gender','mobileNumber','dateOfBirth','joinDate'],['custom'])
-            end
-            res=Gameball::Utils::request("post","/integrations/event",eventBody)
-            unless res.kind_of? Net::HTTPSuccess
-                raise Gameball::GameballError.new(res.body) # use custom message
-            else 
-                return true
-            end
+  class Event
+    def self.sendEvent(eventBody)
+      # Validating keys in incoming body
+      Gameball::Utils.validate(eventBody, ["events", "playerUniqueId"], ["playerAttributes"])
+      res = Gameball::Utils::request("post", "/integrations/event", eventBody)
+      # Check for HTTP Success and throws error if not success
+      unless res.kind_of? Net::HTTPSuccess
+        if res.kind_of? Net::HTTPInternalServerError
+          raise Gameball::GameballError.new("An Internal Server Error has occurred")
+        else
+          raise Gameball::GameballError.new(res.body) 
         end
-        def self.sendEvent_async (eventBody)
-            Gameball::Utils.validate(eventBody,['events','playerUniqueId'],['playerAttributes'])
-        if eventBody.has_key?(:playerAttributes)
-            # Gameball::Utils.validate(eventBody[:playerAttributes],['displayName','firstName','lastName','email','gender','mobileNumber','dateOfBirth','joinDate'],['custom'])
-            end
-            res=Gameball::Utils::request_async("post","/integrations/event",eventBody)
-            unless res.kind_of? Net::HTTPSuccess
-                raise Gameball::GameballError.new(res.body) # use custom message
-            else 
-                return true
-            end
+      else
+        return true
+      end
+    end
+    def self.sendEvent_async(eventBody)
+      # Validating keys in incoming body
+      Gameball::Utils.validate(eventBody, ["events", "playerUniqueId"], ["playerAttributes"])
+      res = Gameball::Utils::request_async("post", "/integrations/event", eventBody)
+      # Check for HTTP Success and throws error if not success
+      unless res.kind_of? Net::HTTPSuccess
+        if res.kind_of? Net::HTTPInternalServerError
+          raise Gameball::GameballError.new("An Internal Server Error has occurred")
+        else
+          raise Gameball::GameballError.new(res.body) 
         end
+      else
+        return true
+      end
     end
-end
+  end
+end