Merge pull request #17 from OpenSTFoundation/release-1.0

Release 1.0

Author: sunilkhedar

CHANGELOG.md

@@ -0,0 +1,11 @@
+[OST Ruby SDK v1.0.0](https://github.com/OpenSTFoundation/ost-sdk-ruby/tree/v1.0.0) May 17 2018
+---
+
+* Added support for interacting with V1 API along with V0 
+* [README.md](README.md) has API V1 usage instructions
+* [README_V0.md](README.md) has API V0 usage instructions  
+
+[OST Ruby SDK v0.9.2](https://github.com/OpenSTFoundation/ost-sdk-ruby/tree/v0.9.2) March 15 2018
+---
+Initial release of the official OST Ruby SDK<br />
+This release has the OST API V0 interaction layer implementation.

README.md

@@ -32,105 +32,162 @@ require('ost-sdk-ruby')
 Set variables for initializing SDK objects:
 
 ```ruby
-environment = 'sandbox'
-credentials = OSTSdk::Util::APICredentials.new(<api_key>, <api_secret>)
+ost_sdk = OSTSdk::Saas::Services.new({api_key: <api_key>, api_secret: <api_secret>, api_base_url: <api_base_url>})
 ```
 
-### Transaction Kind Module 
+### Users Module 
 
-Initialize a `TransactionKind` object to perform transaction-related actions:
+```ruby
+ost_users_object = ost_sdk.services.users
+```
+
+Create a new user:
 
 ```ruby
-ostTransactionKindObject = OSTSdk::Saas::TransactionKind.new(environment, credentials)
+ost_users_object.create(name: 'Alice').to_json
 ```
 
-Create new transaction kinds:
+Edit an existing user:
 
 ```ruby
-ostTransactionKindObject.create(name: 'Like', kind: 'user_to_user', currency_type: 'usd', currency_value: '1.25', commission_percent: '12')
+ost_users_object.edit(id: 'e55feef0-26e6-438a-9f1a-f348ce2e3c44', name: 'Bob').to_json
 ```
 
+Get an existing user:
+
+```ruby
+ost_users_object.get(id: 'e55feef0-26e6-438a-9f1a-f348ce2e3c44').to_json
+```
+
+Get a list of users and other data:
+
 ```ruby
-ostTransactionKindObject.create(name: 'Grant', kind: 'company_to_user', currency_type: 'bt', currency_value: '12', commission_percent: '0')
+ost_users_object.list({page_no: 1, limit: 5}).to_json
 ```
 
+### Airdrops Module 
+
 ```ruby
-ostTransactionKindObject.create(name: 'Buy', kind: 'user_to_company', currency_type: 'bt', currency_value: '100', commission_percent: '0')
+ost_airdrop_object = ost_sdk.services.airdrops
 ```
 
-Get a list of existing transaction kinds and other data:
+Execute Airdrop:
 
 ```ruby
-ostTransactionKindObject.list()
+ost_airdrop_object.execute({amount: 1, user_ids: 'e55feef0-26e6-438a-9f1a-f348ce2e3c44'}).to_json
 ```
 
-Edit an existing transaction kind:
+Get Airdrop Status:
+```ruby
+ost_airdrop_object.get({id: 'ecd9b0b2-a0f4-422c-95a4-f25f8fc88334'}).to_json
+```
 
+List Airdrop
 ```ruby
-ostTransactionKindObject.edit(client_transaction_id: '12', name: 'New Transaction Kind')
+ost_airdrop_object.list({page_no: 1, limit: 50, current_status: 'processing,complete'}).to_json
 ```
 
-Execute a branded token transfer by transaction kind:
+
+### Token Module 
 
 ```ruby
-ostTransactionKindObject.execute(from_uuid: '1234-1928-1081dsds-djhksjd', to_uuid: '1234-1928-1081-1223232', transaction_kind: 'Purchase')
+ost_token_object = ost_sdk.services.token
 ```
 
-Get the status of an executed transaction:
-  
+Get details:
+
 ```ruby
-ostTransactionKindObject.status(transaction_uuids: ['5f79063f-e22a-4d28-99d7-dd095f02c72e'])
+ost_token_object.get({}).to_json
 ```
 
-### Users Module
+### Actions Module 
 
-Initialize a `Users` object to perform user specific actions:
 
 ```ruby
-ostUsersObject = OSTSdk::Saas::Users.new(environment, credentials)
+ost_action_object = ost_sdk.services.actions
 ```
 
-Create a new user:
+Create a new action:
 
 ```ruby
-ostUsersObject.create(name: 'Alice')
+ost_action_object.create({name: 'Test', kind: 'user_to_user', currency: 'USD', arbitrary_amount: false, amount: 1.01, 
+                          arbitrary_commission: true}).to_json
 ```
 
-Get a list of users and other data:
+Edit an action:
 
 ```ruby
-ostUsersObject.list()
+ost_action_object.edit({id: 1234, amount: 2}).to_json
 ```
 
-Edit an existing user:
+Get an action:
+
+```ruby
+ost_action_object.get(id: 1234).to_json
+```
 
+List actions:
+
+```ruby
+ost_action_object.list(page_no: 1).to_json
+```
+
+### Transaction Module 
+
+```ruby
+ost_transaction_object = ost_sdk.services.transactions
+```
+
+Execute Transaction:
+
+```ruby
+ost_transaction_object.execute({from_user_id:'f87346e4-61f6-4d55-8cb8-234c65437b01', to_user_id:'c07bd853-e893-4400-b7e8-c358cfa05d85', action_id:'20145'}).to_json
+```
+
+Get Transaction Status:
+```ruby
+ost_transaction_object.get({id: '0ab712ec-dc41-4e31-ac31-c93bc148bbb9'}).to_json
+```
+
+List Transactions
 ```ruby
-ostUsersObject.edit(uuid: '1234-1928-1081dsds-djhksjd', name: 'Bob')
+ost_transaction_object.list({page_no: 1, limit: 50}).to_json
 ```
 
-Airdrop branded tokens to users:
+### Transfer Module 
 
 ```ruby
-ostUsersObject.airdrop_tokens(amount: 100, list_type: 'all')
+ost_transfer_object = ost_sdk.services.transfers
 ```
 
-As airdropping tokens is an asynchronous task, you can check the airdrop's status:
+Execute Transfer:
 
 ```ruby
-ostUsersObject.get_airdrop_status(airdrop_uuid: '1234-1928-1081dsds-djhksjd')
+ost_transfer_object.execute({to_address:'0xd2b789293674faEE51bEb2d0338d15401dEbfdE3', amount:1}).to_json
+```
+
+Get Transfer Status:
+```ruby
+ost_transfer_object.get({id: 'd0589dc5-d0a0-4996-b9f8-847295fd2c3b'}).to_json
+```
+
+List Transfers
+```ruby
+ost_transfer_object.list().to_json
 ```
 
 ### Request Specs
 
-To obtain request/API specification, pass in `true` for the optional `api_spec` parameter when initializing a `TransactionKind` or `Users` module object:
+To obtain request/API specification, pass in `true` for the optional `api_spec` parameter when initializing SDK object:
 
 ```ruby
-ostTransactionKindObject = OSTSdk::Saas::TransactionKind.new(environment, credentials, true)
+ost_sdk = OSTSdk::Saas::Services.new({api_key: <api_key>, api_secret: <api_secret>, api_base_url: <api_base_url>, api_spec: true})
+ost_action_object = ost_sdk.services.actions
 ```
 
 And then call a method:
 
 ```ruby
-> ostTransactionKindObject.list()
-=> #<OSTSdk::Util::Result:0x007ffccab36c98 @error=nil, @error_message=nil, @error_data=nil, @error_display_text=nil, @error_display_heading=nil, @message=nil, @http_code=200, @data={:request_uri=>"https://sandboxapi.ost.com/transaction-types/list", :request_type=>"GET", :request_params=>"request_timestamp=<request_epoch_timestamp>&signature=<signature>&api_key=<api_key>"}>
-```
+ost_action_object.list().to_json
+ {:success=>true, :data=>{:request_uri=>"https://playground2api.stagingost.com/v1/actions/", :request_type=>"GET", :request_params=>"request_timestamp=1526541627&signature=410f6fef1ab2ad34e74caef589a15b56490b63a316fc46509d31bb133bf11678&api_key=7cad25e082390a90114e"}} 
+ ```

README_V0.md

@@ -0,0 +1,133 @@
+# Ost::Sdk::Ruby
+
+A Ruby wrapper for the [OST Developers API](https://dev.ost.com/).
+
+## Requirements
+
+To use this gem, developers will need to:
+1. Sign-up on [https://kit.ost.com](https://kit.ost.com).
+2. Launch a branded token economy with the OST KIT Economy Planner.
+3. Obtain an API Key and API Secret from [https://kit.ost.com/developer-api-console](https://kit.ost.com/developer-api-console).
+
+## Documentation
+
+[https://dev.ost.com/](https://dev.ost.com/docs/0.9.1/simpletoken.html/)
+
+## Installation
+
+Install OST Ruby SDK
+
+```bash
+> gem install ost-sdk-ruby
+```
+
+## Example Usage
+
+Require the OST Ruby SDK:
+
+```ruby
+require('ost-sdk-ruby')
+```
+
+Set variables for initializing SDK objects:
+
+```ruby
+ost_sdk = OSTSdk::Saas::Services.new({api_key: <api_key>, api_secret: <api_secret>, api_base_url: <api_base_url>})
+```
+
+### Transaction Kind Module 
+
+
+```ruby
+ost_transaction_object = ost_sdk.services.transaction_kind
+```
+
+Create new transaction kinds:
+
+```ruby
+ost_transaction_object.create(name: 'Like', kind: 'user_to_user', currency_type: 'usd', currency_value: '1.25', commission_percent: '12').to_json
+```
+
+```ruby
+ost_transaction_object.create(name: 'Grant', kind: 'user_to_user', currency_type: 'bt', currency_value: '12', commission_percent: '0').to_json
+```
+
+```ruby
+ost_transaction_object.create(name: 'Buy', kind: 'user_to_company', currency_type: 'bt', currency_value: '100').to_json
+```
+
+Get a list of existing transaction kinds and other data:
+
+```ruby
+ost_transaction_object.list().to_json
+```
+
+Edit an existing transaction kind:
+
+```ruby
+ost_transaction_object.edit(client_transaction_id: '21728', name: 'New Transaction Kind').to_json
+```
+
+Execute a branded token transfer by transaction kind:
+
+```ruby
+ost_transaction_object.execute(from_uuid: 'aeb9e7e3-a054-4883-a005-0bd8c4f0df7a', to_uuid: '53d906b3-ce0c-4798-8aa7-b1352daab757', transaction_kind: 'Upvote').to_json
+```
+
+Get the status of an executed transaction:
+  
+```ruby
+ost_transaction_object.status(transaction_uuids: ['b6f099a3-2a65-431e-b3ec-54056d7d81eb']).to_json
+```
+
+### Users Module
+
+```ruby
+ost_users_object = ost_sdk.services.users
+```
+
+Create a new user:
+
+```ruby
+ost_users_object.create(name: 'Alice').to_json
+```
+
+Get a list of users and other data:
+
+```ruby
+ost_users_object.list().to_json
+```
+
+Edit an existing user:
+
+```ruby
+ost_users_object.edit(uuid: 'ab1aa227-0545-4d7a-9921-abe9d9c34146', name: 'BobTheBuilder').to_json
+```
+
+Airdrop branded tokens to users:
+
+```ruby
+ost_users_object.airdrop_tokens(amount: 1, list_type: 'never_airdropped').to_json
+```
+
+As airdropping tokens is an asynchronous task, you can check the airdrop's status:
+
+```ruby
+ost_users_object.get_airdrop_status(airdrop_uuid: 'd2b8714d-cc2e-46ba-beca-313de32d0280').to_json
+```
+
+### Request Specs
+
+To obtain request/API specification, pass in `true` for the optional `api_spec` parameter when initializing SDK object:
+
+```ruby
+ost_sdk = OSTSdk::Saas::Services.new({api_key: <api_key>, api_secret: <api_secret>, api_base_url: <api_base_url>, api_spec: true})
+ost_transaction_object = ost_sdk.services.transaction_kind
+```
+
+And then call a method:
+
+```ruby
+ost_transaction_object.list().to_json
+ {:success=>true, :data=>{:request_uri=>"https://playground2api.stagingost.com/transaction-types/list", :request_type=>"GET", :request_params=>"request_timestamp=1526540175&signature=6c2819714cd184fbb3ff5f495724bea3737679074055a5c90698d6a317515323&api_key=7cad25e082390a90114e"}} 
+ ```

lib/ost-sdk-ruby/saas.rb

@@ -1,6 +1,18 @@
+require_relative 'saas/services'
+
 require_relative 'saas/base'
-require_relative 'saas/transaction_kind'
-require_relative 'saas/users'
+
+require_relative 'saas/v0/services'
+require_relative 'saas/v0/transaction_kind'
+require_relative 'saas/v0/users'
+
+require_relative 'saas/v1/services'
+require_relative 'saas/v1/users'
+require_relative 'saas/v1/token'
+require_relative 'saas/v1/actions'
+require_relative 'saas/v1/airdrops'
+require_relative 'saas/v1/transfers'
+require_relative 'saas/v1/transactions'
 
 module OSTSdk