alphaSDK 0.0.3 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5a6989546d20cbfdaf28a7ea73877b274c72e45a037bbad9055b898a78a91cac
-  data.tar.gz: f9ab083d60b26b3610ee29aa2eff0b7d508af818f52cb58c0b960795ffe842f2
+  metadata.gz: fce1ae63c92d753f9e6259e1879e31943136eee81eee60ee7282da75a1295da8
+  data.tar.gz: 9225dc4c5c30c1c31a127dccb540b73db610c9d611f9369b1fb2480accd25f3f
 SHA512:
-  metadata.gz: 578f474795b250585bb20934b0627ed579bd104fa533a81b00a0847a57bdba749dcd3d32cb4974b95d9a7cedc7b38ee3c5afcbc9ba3ea33ba1f2812cb688149f
-  data.tar.gz: ca4109823dee36c7a55004eef82a497ed15eac7fb21229f69cd12f4c1b4d0a46a62392616e5aee2321463512cd4b2c8ce269f8d9b2ec5c6d7e7e65cdb7cd2699
+  metadata.gz: d70c86ed0f885b71e485fb725aa52049d42e3d729b25a52fe6c2204b0e1156caa4524e47cf9c001380149b183f31f2c2937796019c081e1fbb44b1cca9b700e8
+  data.tar.gz: fca1964701315edb2eb1324164819b76311ee30d27e44a72c33db6fa425a235fe6117da8494bc33aa8989b48a527dcf9e11887a43aa55e84b4748a41ab1d989d

data/.gitignore

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

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -1,74 +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/
+# 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

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

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    alphaSDK (0.0.1)
+    alphaSDK (0.2.5)
+      rake (>= 12.0)
+      rspec (>= 3.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     diff-lcs (1.4.4)
-    rake (12.3.3)
+    rake (12.0.0)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
@@ -27,8 +29,8 @@ PLATFORMS
 
 DEPENDENCIES
   alphaSDK!
-  rake (~> 12.0)
-  rspec (~> 3.0)
+  rake (>= 12.0)
+  rspec (>= 3.0)
 
 BUNDLED WITH
    2.1.4

data/LICENSE.txt

@@ -1,21 +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.
+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

@@ -1,44 +1,202 @@
-# Gameball
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gameball`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'gameball'
-```
-
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install gameball
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
-
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gameball. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/gameball/blob/master/CODE_OF_CONDUCT.md).
-
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-
-## Code of Conduct
-
-Everyone interacting in the Gameball project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gameball/blob/master/CODE_OF_CONDUCT.md).
+# 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.