ost-kyc-sdk-ruby 2.0.0.beta.1 → 2.0.0.beta.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9ab41657d4c62ab3dd0db4591fb314668e98655f2d98690ad5e743d61fd6c50
-  data.tar.gz: f4276b1a35be0352976a3d45ac10bd104b5d12a0b734d3204278b2e409d327cc
+  metadata.gz: 5aa3fa49768c56a8193a60c086bf03a6cd61d43d8837fa5d71973f38d606818f
+  data.tar.gz: c90dfe42fc423c08ad21f749b5a4cda0d18bdc2ccee1ba6667a38748d6b05bb1
 SHA512:
-  metadata.gz: 5c59db9b297ab2a2430449fa096f66de2073fb5a3a0215cdb53c6bf8b6dd917ec641060f305472679ac548073e76658cdf29485beb8855e5f582b907ebb4c65f
-  data.tar.gz: eaa01133fb5e6eb9f263ca4ba9f3774fd9b90f2963e115c7e07a65eb0226be0f26a165fa38870629208a90fc9d65e7d34217eb5e8db5b6468f34bf0a1d1bc1e8
+  metadata.gz: 4a0fcd2f3b009a3c28e8ea1e94e10ad8fe94324edd198644b648b76976df7b99bfefe6c74aa389ea782ecec1e9a22ba4fbecbbab1006f467340577760f8f3249
+  data.tar.gz: f51a5799fe42b1973f735ce645e8f2b09ea36bd4b7b9752f16ab0df6092b0640ed4c4a09c4843b93abc145e214ce58a92f4461f17d043ba6f158e0d769788e5a

data/lib/config.rb

@@ -0,0 +1,8 @@
+class Config
+
+  API_BASE_URL = ENV['OST_KYC_API_ENDPOINT']
+  API_KEY = ENV['OST_KYC_API_KEY']
+  API_SECRET = ENV['OST_KYC_API_SECRET']
+  OST_SDK = OstKycSdkRuby::Saas::Services.new({api_key: API_KEY, api_secret: API_SECRET, api_base_url: API_BASE_URL})
+
+end

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

@@ -0,0 +1,8 @@
+
+module OstKycSdkRuby
+
+end
+
+require "ost-kyc-sdk-ruby/version"
+require "ost-kyc-sdk-ruby/util"
+require "ost-kyc-sdk-ruby/saas"

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

@@ -0,0 +1,18 @@
+require_relative 'saas/services'
+
+require_relative 'saas/base'
+
+require_relative 'saas/services'
+require_relative 'saas/manifest'
+require_relative 'saas/users'
+require_relative 'saas/users_kyc'
+require_relative 'saas/users_kyc_detail'
+require_relative 'saas/validators'
+
+module OstKycSdkRuby
+
+  module Saas
+
+  end
+
+end

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

@@ -0,0 +1,116 @@
+module OstKycSdkRuby
+
+  module Saas
+
+    class Base
+
+      REGEX_VALUE = /\A[0-9a-z\.\-]+\z/i
+
+      include OstKycSdkRuby::Util::ServicesHelper
+
+      attr_reader :http_helper
+
+      # OstKycSdkRuby::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+
+        fail 'missing API Base URL' if params[:api_base_url].nil?
+        fail 'missing API Key' if params[:api_key].nil?
+        fail 'missing API Secret' if params[:api_secret].nil?
+
+        params[:api_base_url] = sanitize_api_base_url(params[:api_base_url])
+
+        @http_helper = OstKycSdkRuby::Util::HTTPHelper.new(params)
+
+      end
+
+      private
+
+      # Get id key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   id: (Integer)
+      #
+      #
+      # if (null == params || !params.containsKey("id") || null == params.get("id")) {
+      #             throw new MissingParameter("id");
+      #         }
+      def get_id!(params)
+        get_value_for_key(params, "id")
+      end
+
+      # Get user_id key from params hash and delete it
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   id: (Integer)
+      #
+      def get_user_id!(params)
+        get_value_for_key(params, "user_id")
+      end
+
+      # Get value for specific key
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   id: (Integer)
+      #
+      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
+        raise "#{key.to_s} missing in request params" if value.nil?
+        raise "#{key.to_s} invalid in request params" if !(is_valid_value?(value.to_s))
+        value
+      end
+
+      # Sanitize API Base URL
+      #
+      # Arguments:
+      #   params: (String)
+      #
+      # Returns:
+      #   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
+
+      # Is the value is valid for given key
+      #
+      # * Author: Puneet
+      # * Date: 10/10/2017
+      # * Reviewed By: Sunil
+      #
+      # @return [Boolean] returns a boolean
+      #
+      def is_valid_value?(value)
+        value =~ REGEX_VALUE
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,30 @@
+module OstKycSdkRuby
+
+  module Saas
+
+    class Manifest
+
+      attr_reader :users_kyc, :users, :users_kyc_detail, :validators
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+
+        @users = OstKycSdkRuby::Saas::Users.new(params)
+        @users_kyc = OstKycSdkRuby::Saas::UsersKyc.new(params)
+        @users_kyc_detail = OstKycSdkRuby::Saas::UserKycDetail.new(params)
+        @validators = OstKycSdkRuby::Saas::Validators.new(params)
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,44 @@
+module OstKycSdkRuby
+
+  module Saas
+
+    class Services
+
+      ## OstKycSdkRuby::Saas::Services
+
+      attr_reader :services
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+
+        fail 'missing API Base URL' if params[:api_base_url].nil?
+        fail 'missing API Key' if params[:api_key].nil?
+        fail 'missing API Secret' if params[:api_secret].nil?
+
+        params[:api_base_url] = params[:api_base_url].gsub(/\/$/, '') # remove trailing slash
+        params[:api_spec] = false if params[:api_spec].nil?
+
+        set_manifest(params)
+
+      end
+
+      private
+
+      def set_manifest(params)
+
+        @services = OstKycSdkRuby::Saas::Manifest.new(params)
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,51 @@
+module OstKycSdkRuby
+
+  module Saas
+
+    class Users < OstKycSdkRuby::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/api/v2/users'
+      end
+
+      # Create a new user
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def create(params = {})
+        http_helper.send_post_request("#{@url_prefix}", params)
+      end
+
+      # Get an existing user
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def get(params)
+        http_helper.send_get_request("#{@url_prefix}/#{get_id!(params)}", params)
+      end
+
+      # Fetches the list of an existing users
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def list(params = {})
+        http_helper.send_get_request("#{@url_prefix}", params)
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,81 @@
+module OstKycSdkRuby
+
+  module Saas
+
+    class UsersKyc < OstKycSdkRuby::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/api/v2/users-kyc'
+      end
+
+      # Fetches the list of an existing Users Kyc
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def list(params = {})
+        http_helper.send_get_request("#{@url_prefix}", params)
+      end
+
+      # Creates/Updates a new User Kyc
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def submit_kyc(params)
+        http_helper.send_post_request("#{@url_prefix}/#{get_user_id!(params)}", params)
+      end
+
+      # Get an existing User Kyc
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def get(params)
+        http_helper.send_get_request("#{@url_prefix}/#{get_user_id!(params)}", params)
+      end
+
+      # Get an existing Presigned URL via POST call
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def get_presigned_url_post(params = {})
+        http_helper.send_get_request("#{@url_prefix}/pre-signed-urls/for-post", params)
+      end
+
+      # Get an existing Presigned URL via PUT call
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def get_presigned_url_put(params = {})
+        http_helper.send_get_request("#{@url_prefix}/pre-signed-urls/for-put", params)
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,33 @@
+module OstKycSdkRuby
+
+  module Saas
+
+    class UserKycDetail < OstKycSdkRuby::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/api/v2/users-kyc-detail'
+      end
+
+      # Get an existing User Kyc Detail
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def get(params)
+        http_helper.send_get_request("#{@url_prefix}/#{get_user_id!(params)}", params)
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,36 @@
+module OstKycSdkRuby
+
+  module Saas
+
+    class Validators < OstKycSdkRuby::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+        super
+        @url_prefix = '/api/v2'
+      end
+
+      # Verify Ethereum Address
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OstKycSdkRuby::Util::Result)
+      #
+      def verify_ethereum_address(params)
+        http_helper.send_get_request("#{@url_prefix}/ethereum-address-validation", params)
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/test/signature_generation_test.rb

@@ -0,0 +1,35 @@
+require_relative "../../../lib/ost-kyc-sdk-ruby/util"
+require_relative "../../../lib/ost-kyc-sdk-ruby/saas"
+require "test/unit"
+require_relative "../../../lib/config"
+
+class SignatureGenerationTest < Test::Unit::TestCase
+
+  def signature_test_obj
+    params = {api_secret: "35f346e5ef825ed4499da98a6ac6b401"}
+    @signature_test_obj ||= OstKycSdkRuby::Util::HTTPHelper.new(params)
+  end
+
+  def test_signature
+    test_obj_for_signature = {
+        k1: 'Rachin',
+        k2: 'tejas',
+        list2: [
+            {a: 'L21A', b: 'L21B'},
+            {a: 'L22A', b: 'L22B'},
+            {a: 'L23A', b: 'L23B'}
+        ],
+        make_mistakes: "",
+        nice_param: [],
+        empty_obj: {},
+        empty_str: '',
+        garbage_str: "~^[]%$#@!&*~,./?~()-_'this is garbage",
+        id: 11003,
+        email: 'mayur+67@ost.com'
+    }
+    test_endpoint = "/api/v2/users"
+    signature = signature_test_obj.get_signature_for_test(test_endpoint,test_obj_for_signature)
+    assert_equal(signature, "c42188c53bfdf84e542a0a9c0a78d19c9f497c61e816f169e1907bc98477eb82")
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/test/user_kyc_detail_test.rb

@@ -0,0 +1,17 @@
+require_relative "../../../lib/ost-kyc-sdk-ruby/util"
+require_relative "../../../lib/ost-kyc-sdk-ruby/saas"
+require "test/unit"
+require_relative "../../../lib/config"
+
+class UserKycDetailTest < Test::Unit::TestCase
+
+  def user_kyc_detail_obj
+    @user_kyc_detail_obj ||= Config::OST_SDK.services.users_kyc_detail
+  end
+
+  def test_user_kyc_detail_get
+    result = user_kyc_detail_obj.get(user_id: ENV['USER_ID'])
+    assert_equal(result.success?, true )
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/test/user_kyc_test.rb

@@ -0,0 +1,41 @@
+require_relative "../../../lib/ost-kyc-sdk-ruby/util"
+require_relative "../../../lib/ost-kyc-sdk-ruby/saas"
+require "test/unit"
+require_relative "../../../lib/config"
+
+class UserKycTest < Test::Unit::TestCase
+
+  def user_kyc_obj
+    @user_kyc_obj ||= Config::OST_SDK.services.users_kyc
+  end
+
+  def test_user_kyc_get
+    result = user_kyc_obj.get(user_id: ENV['USER_ID'])
+    assert_equal(result.success?, true )
+  end
+
+  def test_submit_kyc
+    params = {user_id: ENV['USER_ID'], first_name:'aniket',last_name:'ayachit', birthdate:'21/12/1991', country:'india', nationality:'indian', document_id_number:'arqpa7659a',document_id_file_path:'2/i/016be96da275031de2787b57c99f1471', selfie_file_path:'2/i/9e8d3a5a7a58f0f1be50b7876521aebc', residence_proof_file_path:'2/i/4ed790b2d525f4c7b30fbff5cb7bbbdb', ethereum_address: '0xdfbc84ccac430f2c0455c437adf417095d7ad68e', estimated_participation_amount:'2', street_address:'afawfveav ',city:'afawfveav', state:'afawfveav',postal_code:'afawfveav','investor_proof_files_path':['2/i/9ff6374909897ca507ba3077ee8587da', '2/i/4872730399670c6d554ab3821d63ebce']}
+    result = user_kyc_obj.submit_kyc(params)
+    assert_equal(result.success?, false )
+  end
+
+  def test_user_kyc_list
+    result = user_kyc_obj.list()
+    assert_equal(result.success?, true )
+  end
+
+  def test_presigned_url_for_put
+    params = {files: {selfie: "image/jpeg"}}
+    result = user_kyc_obj.get_presigned_url_put(params)
+    assert_equal(result.success?, true )
+  end
+
+  def test_presigned_url_for_post
+    params = {files: {selfie: "image/jpeg"}}
+    result = user_kyc_obj.get_presigned_url_post(params)
+    assert_equal(result.success?, true )
+  end
+
+
+end

data/lib/ost-kyc-sdk-ruby/test/user_test.rb

@@ -0,0 +1,47 @@
+require_relative "../../../lib/ost-kyc-sdk-ruby/util"
+require_relative "../../../lib/ost-kyc-sdk-ruby/saas"
+require "test/unit"
+require_relative "../../../lib/config"
+
+class UserTest < Test::Unit::TestCase
+
+  def user_obj
+    @user_obj ||= Config::OST_SDK.services.users
+  end
+
+  def test_user_get
+    result = user_obj.get(id: ENV['USER_ID'])
+    assert_equal(result.success?, true)
+  end
+
+  def test_user_get_with_zero_as_user_id
+    result = user_obj.get(id: 0)
+    assert_equal(result.success?, false)
+  end
+
+  def test_user_get_with_null_as_user_id
+    assert_raise(RuntimeError) {
+      user_obj.get(id: "")
+    }
+  end
+
+  def test_user_list_with_total_entry_in_meta
+    params = {order: 'asc', limit: 1, filters: {is_kyc_submitted: false}}
+    result = user_obj.list(params)
+    assert_equal(result.data["meta"]["next_page_payload"]["limit"], 1)
+    assert_equal(result.data["meta"]["next_page_payload"]["filters"]["is_kyc_submitted"], "false")
+  end
+
+  def test_user_create
+    unique_email = "usertest+#{Time.now.to_i}_#{RUBY_VERSION}@ost.com"
+    result = user_obj.create(email: unique_email)
+    assert_equal(result.success?, true)
+  end
+
+  def test_user_list
+    result = user_obj.list()
+    assert_equal(result.success?, true)
+  end
+
+
+end

data/lib/ost-kyc-sdk-ruby/test/validators_test.rb

@@ -0,0 +1,17 @@
+require_relative "../../../lib/ost-kyc-sdk-ruby/util"
+require_relative "../../../lib/ost-kyc-sdk-ruby/saas"
+require "test/unit"
+require_relative "../../../lib/config"
+
+class ValidatorsTest < Test::Unit::TestCase
+
+  def validators_obj
+    @validators_obj ||= Config::OST_SDK.services.validators
+  end
+
+  def test_validators_get
+    result = validators_obj.verify_ethereum_address(ethereum_address: "0x7f2ED21D1702057C7d9f163cB7e5458FA2B6B7c4")
+    assert_equal(result.success?, true )
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/util.rb

@@ -0,0 +1,13 @@
+require_relative 'util/common_validator'
+require_relative 'util/result'
+require_relative 'util/api_credentials'
+require_relative 'util/http_helper'
+require_relative 'util/services_helper'
+
+module OstKycSdkRuby
+
+  module Util
+
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/util/api_credentials.rb

@@ -0,0 +1,32 @@
+module OstKycSdkRuby
+
+  module Util
+
+    class APICredentials
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_key: (String)
+      #   api_secret: (String)
+      #
+      def initialize(api_key, api_secret)
+        @api_key = api_key
+        @api_secret = api_secret
+      end
+
+      # Returns:
+      #   api_key: (String)
+      #
+      attr_reader :api_key
+
+      # Returns:
+      #   api_secret: (String)
+      #
+      attr_reader :api_secret
+
+    end
+
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/util/common_validator.rb

@@ -0,0 +1,50 @@
+module OstKycSdkRuby
+
+  module Util
+
+    class CommonValidator
+
+      # Check for numeric-ness of an input
+      #
+      # Arguments:
+      #   object: (Float)
+      #
+      # Returns:
+      #   Boolean
+      #
+      def self.is_numeric?(object)
+        true if Float(object) rescue false
+      end
+
+      # Check for boolean-ness of an input
+      #
+      # Arguments:
+      #   object: (Boolean)
+      #
+      # Returns:
+      #   Boolean
+      #
+      def self.is_boolean?(object)
+        [
+            true,
+            false
+        ].include?(object)
+      end
+
+      # Is the given object Hash
+      #
+      # Arguments:
+      #   object: (Hash)
+      #
+      # Returns:
+      #   Boolean
+      #
+      def self.is_a_hash?(obj)
+        obj.is_a?(Hash) || obj.is_a?(ActionController::Parameters)
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/util/http_helper.rb

@@ -0,0 +1,251 @@
+module OstKycSdkRuby
+
+  module Util
+
+    class HTTPHelper
+
+      # OstKycSdkRuby::Util::HTTPHelper
+
+      require "uri"
+      require "open-uri"
+      require "openssl"
+      require "net/http"
+      require "json"
+
+      # Initialize
+      #
+      # Arguments:
+      #   api_base_url: (String)
+      #   api_key: (String)
+      #   api_secret: (String)
+      #   api_spec: (Boolean)
+      #
+      def initialize(params)
+        @api_base_url = params[:api_base_url]
+        @api_key = params[:api_key]
+        @api_secret = params[:api_secret]
+        @api_spec = params[:api_spec]
+        @timeout = 10
+        if (params.key?(:config))
+          config = params[:config]
+          if (config.key?(:timeout))
+            @timeout = config[:timeout]
+          end
+        end
+      end
+
+      # Send POST requests
+      #
+      # Arguments:
+      #   end_point: (String)
+      #   request_params: (Hash)
+      #
+      # Returns:
+      #   OstKycSdkRuby::Util::Result
+      #
+      def send_post_request(endpoint, request_params)
+        perform_and_handle_exceptions('u_hh_1', 'POST request failed') do
+          escaped_query_string = get_query_string(endpoint, request_params)
+          uri = URI(get_api_url(endpoint))
+          http = setup_request(uri)
+          if @api_spec
+            return OstKycSdkRuby::Util::Result.success({data: {request_uri: uri.to_s, request_type: 'POST', request_params: escaped_query_string}})
+          else
+            result = http.post(uri.path, escaped_query_string)
+            return format_response(result)
+          end
+        end
+      end
+
+      # Send GET requests
+      #
+      # Arguments:
+      #   end_point: (String)
+      #   request_params: (Hash)
+      #
+      # Returns:
+      #   OstKycSdkRuby::Util::Result
+      #
+      def send_get_request(endpoint, request_params)
+        perform_and_handle_exceptions('u_hh_2', 'GET request Failed') do
+          escaped_query_string = get_query_string(endpoint, request_params)
+          raw_url = get_api_url(endpoint) + "?#{escaped_query_string}"
+          uri = URI(raw_url)
+          if @api_spec
+            return OstKycSdkRuby::Util::Result.success({data: {request_uri: uri.to_s.split("?")[0], request_type: 'GET', request_params: escaped_query_string}})
+          else
+            result = {}
+            Timeout.timeout(@timeout) do
+              result = Net::HTTP.get_response(uri)
+            end
+            return format_response(result)
+          end
+        end
+      end
+
+      def get_signature_for_test(endpoint, request_params)
+        escaped_query_string = get_escaped_query_string(request_params)
+        string_to_sign = "#{endpoint}?#{escaped_query_string}"
+        generate_signature(string_to_sign)
+      end
+
+      private
+
+      def setup_request(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = @timeout
+        http.open_timeout = @timeout
+        if uri.scheme == "https"
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http
+      end
+
+      def get_query_string(endpoint, request_params)
+        request_timestamp = Time.now.to_i
+        request_params = request_params.merge("request_timestamp" => request_timestamp, "api_key" => @api_key)
+        escaped_query_string = get_escaped_query_string(request_params)
+        string_to_sign = endpoint + "?" + escaped_query_string
+        signature = generate_signature(string_to_sign)
+        "#{escaped_query_string}&signature=#{escape(signature)}"
+      end
+
+      def get_escaped_query_string(request_params)
+        sorted_request_params = sort_param(request_params)
+        build_nested_query(sorted_request_params)
+      end
+
+      def generate_signature(string_to_sign)
+        digest = OpenSSL::Digest.new('sha256')
+        OpenSSL::HMAC.hexdigest(digest, @api_secret, string_to_sign)
+      end
+
+      def get_api_url(endpoint)
+        @api_base_url + endpoint
+      end
+
+      def build_nested_query(value, prefix = nil)
+        case value
+        when Array
+          value.map {|v|
+            build_nested_query(v, "#{prefix}[]")
+          }.join("&")
+        when Hash
+          value.map {|k, v|
+            build_nested_query(v, prefix ? "#{prefix}[#{k}]" : k)
+          }.reject(&:empty?).join('&')
+          # when nil
+          #   "#{escape(prefix)}="
+        else
+          raise ArgumentError, "value must be a Hash" if prefix.nil?
+          "#{escape(prefix)}=#{escape(value)}"
+        end
+      end
+
+      def escape(s)
+        s = URI.encode_www_form_component(s)
+        URI.escape(s, "*")
+      end
+
+      # Method which is called in service perform and handle exceptions
+      #
+      def perform_and_handle_exceptions(err_code = 'swt', err_message = 'Something Went Wrong', &block)
+        begin
+          yield if block_given?
+        rescue StandardError => se
+          OstKycSdkRuby::Util::Result.exception(se, {error: err_code, error_message: err_message})
+        end
+      end
+
+      def sort_param(params)
+
+        if params.is_a?(Hash)
+          params = JSON.parse(params.to_json)
+          data = {}
+          params.sort.each do |ele|
+            key = ele[0]
+            val = ele[1]
+            data[key] = sort_param(val)
+          end
+
+        elsif params.is_a?(Array)
+          params = JSON.parse(params.to_json)
+          data = []
+          params.each do |ele|
+            data << sort_param(ele)
+          end
+        else
+          data = params.to_s
+        end
+
+        return data
+      end
+
+      def format_response(response)
+        json_raw_response = JSON.parse(response.body)
+        # If internal response
+        if json_raw_response.has_key?('success') || json_raw_response.has_key?('err')
+          format_internal_response(response)
+        else
+          format_external_response(response.code)
+        end
+      end
+
+      def format_internal_response(response)
+        json_raw_response = JSON.parse(response.body)
+        if json_raw_response['success']
+          OstKycSdkRuby::Util::Result.success(
+              {
+                  data: json_raw_response['data'],
+                  http_code: response.code
+              }
+          )
+        else
+          err_data = json_raw_response['err']
+          OstKycSdkRuby::Util::Result.error(
+              {
+                  error: err_data['code'],
+                  internal_id: err_data['internal_id'],
+                  error_message: err_data['msg'],
+                  error_data: err_data['error_data'],
+                  http_code: response.code
+              }
+          )
+        end
+      end
+
+      def format_external_response(response_code)
+        case response_code.to_i
+        when 502
+          code = 'BAD_GATEWAY'
+          internal_id = 'SDK(BAD_GATEWAY)'
+          message = 'Something went wrong.'
+        when 503
+          code = 'SERVICE_UNAVAILABLE'
+          internal_id = 'SDK(SERVICE_UNAVAILABLE)'
+          message = 'API under maintenance.'
+        when 504
+          code = 'GATEWAY_TIMEOUT'
+          internal_id = 'SDK(GATEWAY_TIMEOUT)'
+          message = 'Request timed out.'
+        else
+          code = 'SOMETHING_WENT_WRONG'
+          internal_id = 'SDK(SOMETHING_WENT_WRONG)'
+          message = 'Something went wrong.'
+        end
+        OstKycSdkRuby::Util::Result.error(
+            {
+                error: code,
+                internal_id: internal_id,
+                error_message: message,
+                http_code: response_code
+            }
+        )
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/util/result.rb

@@ -0,0 +1,233 @@
+module OstKycSdkRuby
+
+  module Util
+
+    class Result
+
+      # OstKycSdkRuby::Util::Result
+
+      attr_accessor :error,
+                    :error_message,
+                    :internal_id,
+                    :error_data,
+                    :message,
+                    :data,
+                    :exception,
+                    :http_code
+
+      # Initialize
+      #
+      # Arguments:
+      #   params: (Hash)
+      def initialize(params = {})
+        set_error(params)
+        set_message(params[:message])
+        set_http_code(params[:http_code])
+        @data = params[:data] || {}
+      end
+
+      # Set Error
+      #
+      # Arguments:
+      #   params: (Hash)
+      def set_error(params)
+        @error = params[:error] if params.key?(:error)
+        @error_message = params[:error_message] if params.key?(:error_message)
+        @error_data = params[:error_data] if params.key?(:error_data)
+        @internal_id = params[:internal_id] if params.key?(:internal_id)
+      end
+
+      # Set Message
+      #
+      # Arguments:
+      #   msg: (String)
+      def set_message(msg)
+        @message = msg
+      end
+
+      # Set HTTP Code
+      #
+      # Arguments:
+      #   msg: (String)
+      def set_http_code(h_c)
+        if h_c.nil?
+          @http_code = 200
+        else
+          @http_code = h_c.to_i
+        end
+      end
+
+      # Set Exception
+      #
+      # Arguments:
+      #   e: (Exception)
+      def set_exception(e)
+        @exception = e
+      end
+
+      # is valid?
+      #
+      # @return [Boolean] returns True / False
+      #
+      def valid?
+        !invalid?
+      end
+
+      # is invalid?
+      #
+      # @return [Boolean] returns True / False
+      #
+      def invalid?
+        errors_present?
+      end
+
+      # Define error / failed methods
+      #
+      [:error?, :errors?, :failed?].each do |name|
+        define_method(name) { invalid? }
+      end
+
+      # Define success method
+      #
+      [:success?].each do |name|
+        define_method(name) { valid? }
+      end
+
+      # are errors present?
+      #
+      # @return [Boolean] returns True / False
+      #
+      def errors_present?
+        @internal_id ||
+            @error ||
+            @error_message ||
+            @error_data ||
+            @exception
+      end
+
+      # Exception message
+      #
+      # Returns:
+      #   exception_message: (String)
+      #
+      def exception_message
+        @e_m ||= @exception.nil? ? '' : @exception.message
+      end
+
+      # Get instance variables Hash style from object
+      #
+      def [](key)
+        instance_variable_get("@#{key}")
+      end
+
+      # Error
+      #
+      # Returns:
+      #   obj: (OstKycSdkRuby::Util::Result)
+      #
+      def self.error(params)
+        new(params)
+      end
+
+      # Success
+      #
+      # Returns:
+      #   obj: (OstKycSdkRuby::Util::Result)
+      #
+      def self.success(params)
+        new(params.merge!(no_error))
+      end
+
+      # Exception
+      #
+      # Returns:
+      #   obj: (OstKycSdkRuby::Util::Result)
+      #
+      def self.exception(e, params = {})
+        obj = new(params)
+        obj.set_exception(e)
+        return obj
+      end
+
+      # No Error
+      #
+      # Returns:
+      #   obj: (Hash)
+      #
+      def self.no_error
+        @n_err ||= {
+            error: nil,
+            error_message: nil,
+            error_data: nil,
+            internal_id: nil
+        }
+      end
+
+      # Fields
+      #
+      # Returns:
+      #   obj: (Array)
+      #
+      def self.fields
+        error_fields + [:data, :message]
+      end
+
+      # Error Fields
+      #
+      # Returns:
+      #   obj: (Array)
+      #
+      def self.error_fields
+        [
+            :error,
+            :error_message,
+            :error_data,
+            :internal_id
+        ]
+      end
+
+      # Create an Hash out of all instance vars
+      #
+      # Returns:
+      #   obj: (Hash)
+      #
+      def to_hash
+        self.class.fields.each_with_object({}) do |key, hash|
+          val = send(key)
+          hash[key] = val if !val.nil?
+        end
+      end
+
+      # To JSON
+      #
+      # Returns:
+      #   obj: (Hash)
+      #
+      def to_json
+
+        hash = self.to_hash
+
+        if (hash[:error] == nil)
+          h = {
+              success: true
+          }.merge(hash)
+          h
+        else
+          {
+              success: false,
+              err: {
+                  internal_id: hash[:internal_id] || 'SDK',
+                  code: hash[:error],
+                  msg: hash[:error_message],
+                  error_data: hash[:error_data] || []
+              }
+          }
+        end
+
+      end
+
+    end
+    
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/util/services_helper.rb

@@ -0,0 +1,102 @@
+module OstKycSdkRuby
+
+  module Util
+
+    module ServicesHelper
+
+      # Wrapper Method which could be used to execute business logic
+      # Error handling code wraps execution of business logic
+      #
+      # Arguments:
+      #   err_code: (String)
+      #   err_message: (String)
+      #   block: (Proc)
+      #
+      # Returns:
+      #   OstKycSdkRuby::Util::Result
+      #
+      def perform_and_handle_exceptions(err_code = 'swt', err_message = 'Something Went Wrong', &block)
+        begin
+          yield if block_given?
+        rescue StandardError => se
+          OstKycSdkRuby::Util::Result.exception(se, {error: err_code, error_message: err_message, data: @params} )
+        end
+      end
+
+      # Success
+      #
+      # Returns:
+      #   OstKycSdkRuby::Util::Result
+      #
+      def success
+        success_with_data({})
+      end
+
+      # Success with data
+      #
+      # Arguments:
+      #   data: (Hash)
+      #
+      # Returns:
+      #   OstKycSdkRuby::Util::Result
+      #
+      def success_with_data(data)
+
+        # Allow only Hash data to pass ahead
+        data = {} unless Util::CommonValidator.is_a_hash?(data)
+
+        OstKycSdkRuby::Util::Result.success({data: data})
+
+      end
+
+      # Error with data
+      #
+      # Arguments:
+      #   code: (String)
+      #   msg: (String)
+      #   data: (Hash)
+      #
+      # Returns:
+      #   OstKycSdkRuby::Util::Result
+      #
+      def error_with_data(code, msg, data = {})
+
+        OstKycSdkRuby::Util::Result.error(
+            {
+                error: code,
+                error_message: msg,
+                data: data
+            }
+        )
+
+      end
+
+      #
+      # Exception with data and without action
+      #
+      # Arguments:
+      #   e: (Exception)
+      #   code: (String)
+      #   msg: (String)
+      #   data: (Hash optional)
+      #
+      # Returns:
+      #   OstKycSdkRuby::Util::Result
+      #
+      def exception_with_data(e, code, msg, data = {})
+
+        OstKycSdkRuby::Util::Result.exception(
+            e, {
+            error: code,
+            error_message: msg,
+            data: data
+          }
+        )
+
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-kyc-sdk-ruby/version.rb

@@ -0,0 +1,5 @@
+module OstKycSdkRuby
+
+  VERSION = "2.0.0.beta.2"
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ost-kyc-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 2.0.0.beta.1
+  version: 2.0.0.beta.2
 platform: ruby
 authors:
 - OST
@@ -44,7 +44,29 @@ email: []
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- lib/config.rb
+- lib/ost-kyc-sdk-ruby.rb
+- lib/ost-kyc-sdk-ruby/saas.rb
+- lib/ost-kyc-sdk-ruby/saas/base.rb
+- lib/ost-kyc-sdk-ruby/saas/manifest.rb
+- lib/ost-kyc-sdk-ruby/saas/services.rb
+- lib/ost-kyc-sdk-ruby/saas/users.rb
+- lib/ost-kyc-sdk-ruby/saas/users_kyc.rb
+- lib/ost-kyc-sdk-ruby/saas/users_kyc_detail.rb
+- lib/ost-kyc-sdk-ruby/saas/validators.rb
+- lib/ost-kyc-sdk-ruby/test/signature_generation_test.rb
+- lib/ost-kyc-sdk-ruby/test/user_kyc_detail_test.rb
+- lib/ost-kyc-sdk-ruby/test/user_kyc_test.rb
+- lib/ost-kyc-sdk-ruby/test/user_test.rb
+- lib/ost-kyc-sdk-ruby/test/validators_test.rb
+- lib/ost-kyc-sdk-ruby/util.rb
+- lib/ost-kyc-sdk-ruby/util/api_credentials.rb
+- lib/ost-kyc-sdk-ruby/util/common_validator.rb
+- lib/ost-kyc-sdk-ruby/util/http_helper.rb
+- lib/ost-kyc-sdk-ruby/util/result.rb
+- lib/ost-kyc-sdk-ruby/util/services_helper.rb
+- lib/ost-kyc-sdk-ruby/version.rb
 homepage: https://kyc.ost.com
 licenses:
 - MIT