Merge pull request #3 from OpenSTFoundation/develop

Preparing for release v0.9.2

Author: Abhay Kumar Singh

.gitignore

@@ -39,6 +39,7 @@ build-iPhoneSimulator/
 /.bundle/
 /vendor/bundle
 /lib/bundler/man/
+.idea
 
 # for a library or gem, you might want to ignore these files since the code is
 # intended to run in multiple environments; otherwise, check them in:

LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2018 Puneet Khushwani
+Copyright (c) 2018 OST.com Ltd.
 
 MIT License
 

README.md

@@ -1,59 +1,136 @@
 # 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/)
+
 ## Installation
 
-Add this line to your application's Gemfile:
-
-    gem 'ost-sdk-ruby'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install ost-sdk-ruby
-
-## Usage
-
-1. TransactionKind Module 
-
-    environment = 'sandbox' # possible values sandbox / production
-    
-    credentials = OSTSdk::Util::APICredentials.new('2fb1cd4ff54f8d842805', '018215e8eeda1084ebcf1fefb5b702799a2d52d0cda955209d98e65bd55a69e0')
-    
-    obj = OSTSdk::Saas::TransactionKind.new(environment, credentials)
-    
-    obj.list()
-    
-    obj.create(name: 'ABC', kind: 'user_to_user', value_currency_type: 'usd', value_in_usd: '1.1', value_in_bt: '1.1', commission_percent: '0.0')
-
-    obj.edit(client_transaction_id: '12', name: 'test_1_1_1')
-    
-2. Address Module
-
-    environment = 'sandbox' # possible values sandbox / production
-    
-    credentials = OSTSdk::Util::APICredentials.new('2fb1cd4ff54f8d842805', '018215e8eeda1084ebcf1fefb5b702799a2d52d0cda955209d98e65bd55a69e0')
-    
-    obj = OSTSdk::Saas::Addresses.new(environment, credentials)
-    
-    obj.fetch_balances(balance_types: ['ost', 'ostPrime', 'eth', 'FRC'], address_uuid: '0xddA2cB099235F657b77b8ABf055725c88cbc6112')
-    
-3. User Module
- 
-    obj = OSTSdk::Saas::Users.new(environment, credentials)
-    
-    obj.create(name: 'test test')
-    
-    obj.edit(name: 'test test', address_uuid: '0xddA2cB099235F657b77b8ABf055725c88cbc6112')
-    
-    obj.list()
-    
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/ost-sdk-ruby/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+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
+environment = 'sandbox'
+credentials = OSTSdk::Util::APICredentials.new(<api_key>, <api_secret>)
+```
+
+### Transaction Kind Module 
+
+Initialize a `TransactionKind` object to perform transaction-related actions:
+
+```ruby
+ostTransactionKindObject = OSTSdk::Saas::TransactionKind.new(environment, credentials)
+```
+
+Create new transaction kinds:
+
+```ruby
+ostTransactionKindObject.create(name: 'Like', kind: 'user_to_user', currency_type: 'usd', currency_value: '1.25', commission_percent: '12')
+```
+
+```ruby
+ostTransactionKindObject.create(name: 'Grant', kind: 'company_to_user', currency_type: 'bt', currency_value: '12', commission_percent: '0')
+```
+
+```ruby
+ostTransactionKindObject.create(name: 'Buy', kind: 'user_to_company', currency_type: 'bt', currency_value: '100', commission_percent: '0')
+```
+
+Get a list of existing transaction kinds and other data:
+
+```ruby
+ostTransactionKindObject.list()
+```
+
+Edit an existing transaction kind:
+
+```ruby
+ostTransactionKindObject.edit(client_transaction_id: '12', name: 'New Transaction Kind')
+```
+
+Execute a branded token transfer by transaction kind:
+
+```ruby
+ostTransactionKindObject.execute(from_uuid: '1234-1928-1081dsds-djhksjd', to_uuid: '1234-1928-1081-1223232', transaction_kind: 'Purchase')
+```
+
+Get the status of an executed transaction:
+  
+```ruby
+ostTransactionKindObject.status(transaction_uuids: ['5f79063f-e22a-4d28-99d7-dd095f02c72e'])
+```
+
+### Users Module
+
+Initialize a `Users` object to perform user specific actions:
+
+```ruby
+ostUsersObject = OSTSdk::Saas::Users.new(environment, credentials)
+```
+
+Create a new user:
+
+```ruby
+ostUsersObject.create(name: 'Alice')
+```
+
+Get a list of users and other data:
+
+```ruby
+ostUsersObject.list()
+```
+
+Edit an existing user:
+
+```ruby
+ostUsersObject.edit(uuid: '1234-1928-1081dsds-djhksjd', name: 'Bob')
+```
+
+Airdrop branded tokens to users:
+
+```ruby
+ostUsersObject.airdrop_tokens(amount: 100, list_type: 'all')
+```
+
+As airdropping tokens is an asynchronous task, you can check the airdrop's status:
+
+```ruby
+ostUsersObject.get_airdrop_status(airdrop_uuid: '1234-1928-1081dsds-djhksjd')
+```
+
+### Request Specs
+
+To obtain request/API specification, pass in `true` for the optional `api_spec` parameter when initializing a `TransactionKind` or `Users` module object:
+
+```ruby
+ostTransactionKindObject = OSTSdk::Saas::TransactionKind.new(environment, credentials, true)
+```
+
+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>"}>
+```

VERSION

@@ -0,0 +1 @@
+0.9.2

lib/ost-sdk-ruby/saas.rb

@@ -1,6 +1,5 @@
 require_relative 'saas/base'
 require_relative 'saas/transaction_kind'
-require_relative 'saas/addresses'
 require_relative 'saas/users'
 
 module OSTSdk

lib/ost-sdk-ruby/saas/addresses.rb

@@ -10,15 +10,18 @@ class Base
 
       # Initialize
       #
-      # @param [Hash] params (mandatory) is a Hash
+      # Arguments:
+      #   environment: (String)
+      #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
       #
-      def initialize(environment, credentials)
+      def initialize(environment, credentials, api_spec)
 
         fail 'missing param environment' if environment.nil?
         fail 'missing/invalid param credentials' if credentials.nil? ||
             credentials.class != OSTSdk::Util::APICredentials
 
-        @http_helper = OSTSdk::Util::HTTPHelper.new(environment, credentials)
+        @http_helper = OSTSdk::Util::HTTPHelper.new(environment, credentials, api_spec)
 
       end
 

lib/ost-sdk-ruby/saas/base.rb

@@ -9,10 +9,11 @@ class TransactionKind < OSTSdk::Saas::Base
       # Arguments:
       #   environment: (String)
       #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
       #
-      def initialize(environment, credentials)
+      def initialize(environment, credentials, api_spec = false)
         super
-        @url_prefix = '/transaction/kind'
+        @url_prefix = '/transaction-types'
       end
 
       # Fetches the list of all transaction types
@@ -21,7 +22,7 @@ def initialize(environment, credentials)
       #   response: (OSTSdk::Util::Result)
       #
       def list(params = {})
-        http_helper.send_get_request("#{@url_prefix}/get-all", params)
+        http_helper.send_get_request("#{@url_prefix}/list", params)
       end
 
       # Creates a new transaction type
@@ -33,7 +34,7 @@ def list(params = {})
       #   response: (OSTSdk::Util::Result)
       #
       def create(params)
-        http_helper.send_post_request("#{@url_prefix}/new", params)
+        http_helper.send_post_request("#{@url_prefix}/create", params)
       end
 
       # Updates an existing transaction type
@@ -48,6 +49,30 @@ def edit(params)
         http_helper.send_post_request("#{@url_prefix}/edit", params)
       end
 
+      # Execute transfer BT by tx kind
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def execute(params)
+        http_helper.send_post_request("#{@url_prefix}/execute", params)
+      end
+
+      # Get details of a transaction(s)
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def status(params)
+        http_helper.send_post_request("#{@url_prefix}/status", params)
+      end
+
     end
 
   end

lib/ost-sdk-ruby/saas/transaction_kind.rb

@@ -9,8 +9,9 @@ class Users < OSTSdk::Saas::Base
       # Arguments:
       #   environment: (String)
       #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
       #
-      def initialize(environment, credentials)
+      def initialize(environment, credentials, api_spec = false)
         super
         @url_prefix = '/users'
       end
@@ -39,7 +40,25 @@ def edit(params = {})
       #   response: (OSTSdk::Util::Result)
       #
       def list(params = {})
-        http_helper.send_post_request("#{@url_prefix}/list", params)
+        http_helper.send_get_request("#{@url_prefix}/list", params)
+      end
+
+      # Airdrop Branded Token to list of users
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def airdrop_tokens(params = {})
+        http_helper.send_post_request("#{@url_prefix}/airdrop/drop", params)
+      end
+
+      # Get status of an Airdrop request for users.
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def get_airdrop_status(params = {})
+        http_helper.send_get_request("#{@url_prefix}/airdrop/status", params)
       end
 
     end