ost-sdk-ruby 1.1.0 → 2.0.0.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7a0cc043310846bc2c7640bc28d23a30036fb67
-  data.tar.gz: dd72349c8d308080ea34ea4727d7d92e8080d6d5
+  metadata.gz: 0e1ebbb4217e10f8fd93f4bfc34a297c3dea6aa5
+  data.tar.gz: c6308f534ae6a646e2b2c81168bcee121b47db30
 SHA512:
-  metadata.gz: 703768eef5e6641b6cfdb9eb9e47ed91e59d4d84718bc767f18c13567507da832a09089cad8f9e042fe536dc74c1c68720ff90536f619fde54b2b2a7a478559d
-  data.tar.gz: 8102fbffdba46e89fcbd6369392d52d15a40af7b7cf303ddd74d621aca9239f7def7410dabb695c59d109ffd650bc305e198e50b2d8b94c8403772f444092468
+  metadata.gz: d89dbac80afb427bbc7ff38a4d1ac2ae22692a4410fb2475cea04eabd61d95cf4f3c4939b279ab65e05483cf2433a308fd6a3b3c9e44cdbfb86e38a53f45088d
+  data.tar.gz: 3c5ee6e8896e85b7418d0fd05d0065eb70fcf1b9fbe1091be9af427846552567b5a8f23a43dcd3866c82799076d51b276d7b957f48c13cef4ae7503ed80faea4

data/lib/config.rb

@@ -0,0 +1,18 @@
+class Config
+
+  API_BASE_URL = ENV['OST_KIT_API_ENDPOINT']
+  API_KEY = ENV['OST_KIT_API_KEY']
+  API_SECRET = ENV['OST_KIT_API_SECRET']
+  OST_SDK = OSTSdk::Saas::Services.new({api_key: API_KEY, api_secret: API_SECRET,
+                                        api_base_url: API_BASE_URL, config: {timeout: 10}, api_spec: false})
+
+  OST_KIT_COMPANY_USER_ID = ENV['OST_KIT_COMPANY_USER_ID']
+  OST_KIT_AUX_CHAIN_ID = ENV['OST_KIT_AUX_CHAIN_ID']
+  OST_KIT_TRANSACTION_ID = ENV['OST_KIT_TRANSACTION_ID']
+  OST_KIT_USER_ID = ENV['OST_KIT_USER_ID']
+  OST_KIT_USER_DEVICE_ADDRESS = ENV['OST_KIT_USER_DEVICE_ADDRESS']
+  OST_KIT_SESSION_ADDRESS = ENV['OST_KIT_SESSION_ADDRESS']
+  OST_KIT_RULE_ADDRESS = ENV['OST_KIT_RULE_ADDRESS']
+  OST_KIT_USER2_TOKEN_HOLDER_ADDRESS = ENV['OST_KIT_USER2_TOKEN_HOLDER_ADDRESS']
+  OST_KIT_RECOVERY_OWNER_ADDRESS = ENV['OST_KIT_RECOVERY_OWNER_ADDRESS']
+end

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

@@ -1,22 +1,17 @@
 require_relative 'saas/services'
-
 require_relative 'saas/base'
-
-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'
-
-require_relative 'saas/v1.1/services'
-require_relative 'saas/v1.1/balances'
-require_relative 'saas/v1.1/ledger'
+require_relative 'saas/balance'
+require_relative 'saas/chains'
+require_relative 'saas/device_managers'
+require_relative 'saas/devices'
+require_relative 'saas/manifest'
+require_relative 'saas/price_points'
+require_relative 'saas/recovery_owners'
+require_relative 'saas/rules'
+require_relative 'saas/sessions'
+require_relative 'saas/tokens'
+require_relative 'saas/transactions'
+require_relative 'saas/users'
 
 module OSTSdk
 

data/lib/ost-sdk-ruby/saas/balance.rb

@@ -0,0 +1,35 @@
+module OSTSdk
+
+  module Saas
+
+    class Balance < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #   config: (Hash)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/users'
+        @url_suffix = '/balance'
+      end
+
+      # Get User's Balance
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def get(params = {})
+        http_helper.send_get_request("#{@url_prefix}/#{get_user_id!(params)}#{@url_suffix}", params)
+      end
+
+    end
+
+  end
+
+end

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

@@ -36,19 +36,103 @@ module OSTSdk
       #   params: (Hash)
       #
       # Returns:
-      #   id: (Integer)
+      #   id: (String)
       #
       def get_id!(params)
-        if params.has_key?(:id)
-          id = params[:id]
-          params.delete(:id)
-        elsif params.has_key?('id')
-          id = params['id']
-          params.delete('id')
-        else
-          fail "id missing in request params"
+        get_value_for_key!(params, "id")
+      end
+
+      # Get user_id key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   user_id: (String)
+      #
+      def get_user_id!(params)
+        get_value_for_key!(params, "user_id")
+      end
+
+      # Get chain_id key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   chain_id: (String)
+      #
+      def get_chain_id!(params)
+        get_value_for_key!(params, "chain_id")
+      end
+
+      # Get device_address key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   device_address: (String)
+      #
+      def get_device_address!(params)
+        get_value_for_key!(params, "device_address")
+      end
+
+      # Get session_address key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   session_address: (String)
+      #
+      def get_session_address!(params)
+        get_value_for_key!(params, "session_address")
+      end
+
+
+      # Get transaction_id key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   transaction_id: (String)
+      #
+      def get_transaction_id!(params)
+        get_value_for_key!(params, "transaction_id")
+      end
+
+      # Get user_id key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   user_id: (String)
+      #
+      def get_recovery_owner_address!(params)
+        get_value_for_key!(params, "recovery_owner_address")
+      end
+
+      # Get value for specific key
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   key: (String)
+      #
+      def get_value_for_key!(params, key)
+        if params.has_key?(key.to_sym)
+          value = params.delete(key.to_sym)
+        elsif params.has_key?(key.to_s)
+          value = params.delete(key.to_s)
         end
-        id
+
+        raise "#{key.to_s} missing in request params" if value.nil?
+        raise "#{key.to_s} invalid in request params" if !OSTSdk::Util::CommonValidator.is_valid_uuid_format?(value.to_s)
+        value
       end
 
       # Sanitize API Base URL
@@ -60,9 +144,7 @@ module OSTSdk
       #   api_base_url: (String)
       #
       def sanitize_api_base_url(api_base_url)
-
         api_base_url = api_base_url.gsub(/\/$/, '') # remove trailing slash
-
         return api_base_url
 
       end

data/lib/ost-sdk-ruby/saas/{v1.1/ledger.rb → chains.rb}

@@ -2,9 +2,7 @@ module OSTSdk
 
   module Saas
 
-    module V1Dot1
-
-      class Ledger < OSTSdk::Saas::Base
+      class Chains < OSTSdk::Saas::Base
 
         # Initialize
         #
@@ -13,25 +11,24 @@ module OSTSdk
         #   api_key: (String)
         #   api_secret: (String)
         #   api_spec: (Boolean)
+        #   config: (Hash)
         #
         def initialize(params)
           super
-          @url_prefix = '/ledger'
+          @url_prefix = '/chains'
         end
 
-        # Get transactions ledger of user
+        # Get chain details
         #
         # Returns:
-        # response: (OSTSdk::Util::Result)
+        #   response: (Hash)
         #
         def get(params = {})
-          http_helper.send_get_request("#{@url_prefix}/#{get_id!(params)}", params)
+          http_helper.send_get_request("#{@url_prefix}/#{get_chain_id!(params)}", params)
         end
 
       end
 
     end
 
-  end
-
 end

data/lib/ost-sdk-ruby/saas/{v1.1/balances.rb → device_managers.rb}

@@ -2,9 +2,7 @@ module OSTSdk
 
   module Saas
 
-    module V1Dot1
-
-      class Balances < OSTSdk::Saas::Base
+      class DeviceManagers < OSTSdk::Saas::Base
 
         # Initialize
         #
@@ -13,25 +11,25 @@ module OSTSdk
         #   api_key: (String)
         #   api_secret: (String)
         #   api_spec: (Boolean)
+        #   config: (Hash)
         #
         def initialize(params)
           super
-          @url_prefix = '/balances'
+          @url_prefix = '/users'
+          @url_suffix = '/device-managers'
         end
 
-        # Get balances details of user
+        # Get Device Manager Detail
         #
         # Returns:
-        # response: (OSTSdk::Util::Result)
+        #   response: (Hash)
         #
         def get(params = {})
-          http_helper.send_get_request("#{@url_prefix}/#{get_id!(params)}", params)
+          http_helper.send_get_request("#{@url_prefix}/#{get_user_id!(params)}#{@url_suffix}", params)
         end
 
       end
 
     end
 
-  end
-
 end

data/lib/ost-sdk-ruby/saas/devices.rb

@@ -0,0 +1,55 @@
+module OSTSdk
+
+  module Saas
+
+    class Devices < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #   config: (Hash)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/users'
+        @url_suffix = '/devices'
+      end
+
+      # Associate a Device with a User
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def create(params = {})
+        http_helper.send_post_request("#{@url_prefix}/#{get_user_id!(params)}#{@url_suffix}", params)
+      end
+
+      # List devices of a user
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def get_list(params = {})
+        http_helper.send_get_request("#{@url_prefix}/#{get_user_id!(params)}#{@url_suffix}", params)
+      end
+
+      # Get device of a user
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def get(params = {})
+        http_helper.send_get_request("#{@url_prefix}/#{get_user_id!(params)}#{@url_suffix}/#{get_device_address!(params)}",
+                                     params)
+      end
+
+
+    end
+
+  end
+
+end

data/lib/ost-sdk-ruby/saas/manifest.rb

@@ -0,0 +1,40 @@
+module OSTSdk
+
+  module Saas
+
+    class Manifest
+
+      attr_reader :balance, :chains, :device_managers, :devices, :price_points, :recovery_owners, :rules,
+                  :sessions, :tokens, :transactions, :users
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #   config: (Hash)
+      #
+      def initialize(params)
+
+        @balance = OSTSdk::Saas::Balance.new(params)
+        @chains = OSTSdk::Saas::Chains.new(params)
+        @device_managers = OSTSdk::Saas::DeviceManagers.new(params)
+        @devices = OSTSdk::Saas::Devices.new(params)
+        @price_points = OSTSdk::Saas::PricePoints.new(params)
+        @recovery_owners = OSTSdk::Saas::RecoveryOwners.new(params)
+
+        @rules = OSTSdk::Saas::Rules.new(params)
+        @sessions = OSTSdk::Saas::Sessions.new(params)
+        @tokens = OSTSdk::Saas::Tokens.new(params)
+        @transactions = OSTSdk::Saas::Transactions.new(params)
+        @users = OSTSdk::Saas::Users.new(params)
+
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-sdk-ruby/saas/price_points.rb

@@ -0,0 +1,35 @@
+module OSTSdk
+
+  module Saas
+
+    class PricePoints < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #   config: (Hash)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/chains'
+        @url_suffix = '/price-points'
+      end
+
+      # Get Chain Price Points
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def get(params = {})
+        http_helper.send_get_request("#{@url_prefix}/#{get_chain_id!(params)}#{@url_suffix}", params)
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-sdk-ruby/saas/recovery_owners.rb

@@ -0,0 +1,35 @@
+module OSTSdk
+
+  module Saas
+
+    class RecoveryOwners < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #   config: (Hash)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/users'
+        @url_suffix = '/recovery-owners'
+      end
+
+      # Get Recovery Owner
+      #
+      # Returns:
+      #   response: (Hash)
+      #
+      def get(params = {})
+        http_helper.send_get_request("#{@url_prefix}/#{get_user_id!(params)}#{@url_suffix}/#{get_recovery_owner_address!(params)}", params)
+      end
+
+    end
+
+  end
+
+end