alphaSDK 0.1.0 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 308f9e81f59e64e557f81db86a025439b2640c95c81ea39b10a02c850d6ba93f
-  data.tar.gz: 41385ef3b306d58452a42247c13bed04cac8e65b8647f2ec02334cc97da1f71f
+  metadata.gz: 88ef178f4bd2c5c3f18a78e7c36c3bdf6e9f8a0f02aef00e0afe504a10e5a4b3
+  data.tar.gz: '05138f7347397ea0cd927cdb7a61bd614a075d60a66708d859122a65395b0064'
 SHA512:
-  metadata.gz: bc07f1568cdf93f77ce69eb3280faa6709a7295b4d3f721b3b60ef4dd5db56fb38ad33d1328efc51a1863c73b540d0edcaf0a6e7def2fdf7254fb76d1f0d5286
-  data.tar.gz: 10073fc6c998201b8493a9288108f1d82011eab00269c22b0a4c3059d6d0b4cd99f33740a514eb053faa1e38e316bbf4038a5b365bb1635f0ec3ffae2a337a29
+  metadata.gz: b4e5be9b8c39c2fe1a46c5277d47ad79014d20a58590a7938398649ec05380c3038c89403db404689fd37f272d61bea747be84a838b63eac2432a767f6be76d4
+  data.tar.gz: 8bfc3c8cb91c3a046037d530b62cf0303793afc8bbaa1c8ef72e513ae65437cc73336ff44e3166da6dd2638ad889458ef6083b05b66ed42809e01d87af165a55

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.6
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at alsouidan@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gameball.gemspec
+gemspec
+
+gem "rake", ">= 12.0"
+gem "rspec", ">= 3.0"

data/Gemfile.lock

@@ -0,0 +1,36 @@
+PATH
+  remote: .
+  specs:
+    alphaSDK (0.2.6)
+      rake (>= 12.0)
+      rspec (>= 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    rake (12.0.0)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  alphaSDK!
+  rake (>= 12.0)
+  rspec (>= 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Alsouidan
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,202 @@
+# Gameball Ruby SDK
+The Gameball Ruby SDK provides convenient access to the Gameball API from applications written in the Ruby language.
+
+## Documentation
+
+Please refer to the  [Gameball API docs](https://docs.gameball.co).
+
+## Installation
+
+You don't need this source code unless you want to modify the SDK. If you just
+want to use the SDK, just run:
+
+```sh
+gem install gameballSDK
+```
+
+### Requirements
+
+-   Ruby 2.6+  and Gem 3.0+
+
+## Usage
+
+The SDK needs to be configured with your account's API & Transaction keys available in your [Gameball Dashboard](https://help.gameball.co/en/articles/3467114-get-your-account-integration-details-api-key-and-transaction-key)
+
+```ruby
+require 'gameball'
+
+Gameball.api_key="api_key" 
+Gameball.api_version="v2.0" # Or latest
+Gameball.transaction_key="transaction_key" 
+```
+
+### Example
+
+#### Sending an Event
+
+```ruby
+# 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
+		}
+			}
+})
+
+
+```
+#### Create a new Referral
+```ruby
+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 Examples
+```ruby
+# Example 1
+Gameball::Transaction.reward_points({
+	playerUniqueId:"player123",
+	amount:99.98,
+	transactionId:"tra_123456789",
+	transactionTime:"2019-09-19T16:14:09.895Z"
+})
+# 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
+		}
+	},
+	transactionTime:"2019-09-19T16:14:09.895Z"
+}
+)
+```
+#### Get Player Balance Example
+```ruby
+Gameball::Transaction.get_player_balance("player456")
+```
+#### Hold Points Example
+```ruby
+Gameball::Transaction.hold_points({
+	playerUniqueId:"player456",
+	amount:98.89,
+	transactionTime:"2019-09-21T16:53:28.190Z"
+}
+)
+```
+#### Redeem Example
+```ruby 
+Gameball::Transaction.redeem_points({
+	playerUniqueId:"player456",
+	amount:10,
+	transactionId:"tra_123456789",
+	holdReference:"2342452352435234",
+	transactionTime:"2019-09-19T16:14:09.895Z"
+	})
+```
+#### Reverse Transaction Example
+```ruby
+Gameball::Transaction.reverse_transaction({
+	playerUniqueId:"player456",
+	transactionId:"1234567890",
+	reversedTransactionId:"234567891",
+	transactionTime:"2019-09-19T11:14:09.895Z"
+}
+)
+```
+#### Reverse Hold Example 
+```ruby
+Gameball::Transaction.reverse_hold({
+	playerUniqueId:" player456",
+	holdReference:"9245fe4a-d402-451c-b9ed-9c1a04247482",
+	transactionTime:"2019-09-21T16:53:28.190Z"
+} 
+)
+```
+
+### Handling exceptions
+
+Unsuccessful requests raise exceptions. The raised exception will reflect the sort of error that occurred with appropriate message and error code . Please refer to the  [Gameball API docs](https://docs.gameball.co).
+
+## Contribution
+The master branch of this repository contains the latest stable release of the SDK.
+
+## Contact
+For usage questions\suggestions drop us an email at support[ at ]gameball.co. Please report any bugs as issues.

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

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,140 @@
+# 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",
+  transactionTime: "2019-09-19T16:14:09.895Z",
+})
+# 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,
+    },
+  },
+  transactionTime: "2019-09-19T16:14:09.895Z",
+})
+# Get Player Balance
+Gameball::Transaction.get_player_balance("player456")
+# Hold
+# Example 1
+Gameball::Transaction.hold_points({
+  playerUniqueId: "player456",
+  amount: 98.89,
+  transactionTime: "2019-09-21T16:53:28.190Z",
+})
+# Redeem
+# Example 1
+Gameball::Transaction.redeem_points({
+  playerUniqueId: "player456",
+  amount: 10,
+  transactionId: "tra_123456789",
+  holdReference: "2342452352435234",
+  transactionTime: "2019-09-19T16:14:09.895Z",
+})
+# Reverse Transaction
+# Example 1
+Gameball::Transaction.reverse_transaction({
+  playerUniqueId: "player456",
+  transactionId: "1234567890",
+  reversedTransactionId: "234567891",
+  transactionTime: "2019-09-19T11:14:09.895Z",
+})
+Gameball::Transaction.reverse_hold({
+  playerUniqueId: " player456",
+  holdReference: "9245fe4a-d402-451c-b9ed-9c1a04247482",
+  transactionTime: "2019-09-21T16:53:28.190Z",
+})