Merge pull request #20 from OpenSTFoundation/santhosh/balances_model_and_cache

balances and ledger API

Author: sunilkhedar

CHANGELOG.md

@@ -1,3 +1,9 @@
+[OST Ruby SDK v1.0.1](https://github.com/OpenSTFoundation/ost-sdk-ruby/tree/v1.0.1) June 20 2018
+---
+
+* Added user balances module to V1 API's
+* Added transaction ledger module to V1 API's
+
 [OST Ruby SDK v1.0.0](https://github.com/OpenSTFoundation/ost-sdk-ruby/tree/v1.0.0) May 17 2018
 ---
 

README.md

@@ -176,6 +176,29 @@ List Transfers
 ost_transfer_object.list().to_json
 ```
 
+### Balances Module 
+
+```ruby
+ost_balance_object = ost_sdk.services.balances
+```
+
+Get balance of user:
+```ruby
+ost_balance_object.get({id: 'd0589dc5-d0a0-4996-b9f8-847295fd2c3b'}).to_json
+```
+
+### Transaction Ledger Module 
+
+```ruby
+ost_ledger_object = ost_sdk.services.ledger
+```
+
+Get balance of user:
+```ruby
+ost_ledger_object.get({id: 'd0589dc5-d0a0-4996-b9f8-847295fd2c3b'}).to_json
+```
+
+
 ### Request Specs
 
 To obtain request/API specification, pass in `true` for the optional `api_spec` parameter when initializing SDK object:

VERSION

@@ -1 +1 @@
-0.9.3
+1.0.1.beta.1

lib/ost-sdk-ruby/saas.rb

@@ -13,6 +13,8 @@
 require_relative 'saas/v1/airdrops'
 require_relative 'saas/v1/transfers'
 require_relative 'saas/v1/transactions'
+require_relative 'saas/v1/balances'
+require_relative 'saas/v1/ledger'
 
 module OSTSdk
 

lib/ost-sdk-ruby/saas/v1/balances.rb

@@ -0,0 +1,37 @@
+module OSTSdk
+
+  module Saas
+
+    module V1
+
+      class Balances < OSTSdk::Saas::Base
+
+        # Initialize
+        #
+        # Arguments:
+        #   api_base_url: (String)
+        #   api_key: (String)
+        #   api_secret: (String)
+        #   api_spec: (Boolean)
+        #
+        def initialize(params)
+          super
+          @url_prefix = '/balances'
+        end
+
+        # Get balances details of user
+        #
+        # Returns:
+        # response: (OSTSdk::Util::Result)
+        #
+        def get(params = {})
+          http_helper.send_get_request("#{@url_prefix}/#{get_id!(params)}", params)
+        end
+
+      end
+
+    end
+
+  end
+
+end

lib/ost-sdk-ruby/saas/v1/ledger.rb

@@ -0,0 +1,37 @@
+module OSTSdk
+
+  module Saas
+
+    module V1
+
+      class Ledger < OSTSdk::Saas::Base
+
+        # Initialize
+        #
+        # Arguments:
+        #   api_base_url: (String)
+        #   api_key: (String)
+        #   api_secret: (String)
+        #   api_spec: (Boolean)
+        #
+        def initialize(params)
+          super
+          @url_prefix = '/ledger'
+        end
+
+        # Get transactions ledger of user
+        #
+        # Returns:
+        # response: (OSTSdk::Util::Result)
+        #
+        def get(params = {})
+          http_helper.send_get_request("#{@url_prefix}/#{get_id!(params)}", params)
+        end
+
+      end
+
+    end
+
+  end
+
+end

lib/ost-sdk-ruby/saas/v1/services.rb

@@ -6,7 +6,7 @@ module V1
 
       class Services
 
-        attr_reader :users, :token, :actions, :airdrops, :transactions, :transfers
+        attr_reader :users, :token, :actions, :airdrops, :transactions, :transfers, :balances, :ledger
 
         # Initialize
         #
@@ -24,6 +24,8 @@ def initialize(params)
           @airdrops = OSTSdk::Saas::V1::Airdrops.new(params)
           @transactions = OSTSdk::Saas::V1::Transactions.new(params)
           @transfers = OSTSdk::Saas::V1::Transfers.new(params)
+          @balances = OSTSdk::Saas::V1::Balances.new(params)
+          @ledger = OSTSdk::Saas::V1::Ledger.new(params)
 
         end
 

lib/ost-sdk-ruby/version.rb

@@ -1,5 +1,5 @@
 module OSTSdk
 
-  VERSION = "1.0.0"
+  VERSION = "1.0.1.beta.1"
 
 end