ost-sdk-ruby 0.0.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f464f45bf2828dc33b12c7b2b0082ff7b5f8f2b7
+  data.tar.gz: 749d9645db7f14080470aac04ba0c49b335376a8
+SHA512:
+  metadata.gz: 1c8d34a8444024ec94b8cc2d9ce61d6025d6a6f61c57dcf00b0bb68fe6bb1cb5730bbaed66ec457f3488c02038b3c8b0dd0be13e6b8ee8dab18d5da547b118e5
+  data.tar.gz: d4ae0c67743b36f91cde79b3f822f167d6b8d5d0f725e36d568f1d9439495e9def5888a41ab3c00f34d7e6e594314a1d4540faa5fbc940353120a2744b9288c2

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+
+require 'rake/rdoctask'
+
+Rake::RDocTask.new do |rd|
+  rd.main = "README.rdoc"
+  rd.rdoc_files.include("README.rdoc", "lib/**/*.rb")
+end

data/lib/ost-sdk-ruby.rb

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

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

@@ -0,0 +1,12 @@
+require_relative 'saas/base'
+require_relative 'saas/transaction_kind'
+require_relative 'saas/addresses'
+require_relative 'saas/users'
+
+module OSTSdk
+
+  module Saas
+
+  end
+
+end

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

@@ -0,0 +1,32 @@
+module OSTSdk
+
+  module Saas
+
+    class Addresses < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   environment: (String)
+      #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
+      #
+      def initialize(environment, credentials, api_spec = false)
+        super
+        @url_prefix = '/addresses'
+      end
+
+      # Fetches balances transaction types
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def fetch_balances(params)
+        http_helper.send_get_request("#{@url_prefix}/fetch-utility-chain-balances", params)
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,32 @@
+module OSTSdk
+
+  module Saas
+
+    class Base
+
+      include OSTSdk::Util::ServicesHelper
+
+      attr_reader :http_helper
+
+      # Initialize
+      #
+      # Arguments:
+      #   environment: (String)
+      #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
+      #
+      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, api_spec)
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,56 @@
+module OSTSdk
+
+  module Saas
+
+    class TransactionKind < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   environment: (String)
+      #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
+      #
+      def initialize(environment, credentials, api_spec = false)
+        super
+        @url_prefix = '/transaction/kind'
+      end
+
+      # Fetches the list of all transaction types
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def list(params = {})
+        http_helper.send_get_request("#{@url_prefix}/get-all", params)
+      end
+
+      # Creates a new transaction type
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def create(params)
+        http_helper.send_post_request("#{@url_prefix}/new", params)
+      end
+
+      # Updates an existing transaction type
+      #
+      # Arguments:
+      #   params: (Hash)
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def edit(params)
+        http_helper.send_post_request("#{@url_prefix}/edit", params)
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,68 @@
+module OSTSdk
+
+  module Saas
+
+    class Users < OSTSdk::Saas::Base
+
+      # Initialize
+      #
+      # Arguments:
+      #   environment: (String)
+      #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
+      #
+      def initialize(environment, credentials, api_spec = false)
+        super
+        @url_prefix = '/users'
+      end
+
+      # Create a new user
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def create(params = {})
+        http_helper.send_post_request("#{@url_prefix}/create", params)
+      end
+
+      # Edit an existing user
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def edit(params = {})
+        http_helper.send_post_request("#{@url_prefix}/edit", params)
+      end
+
+      # Fetches the list of all users
+      #
+      # Returns:
+      #   response: (OSTSdk::Util::Result)
+      #
+      def list(params = {})
+        http_helper.send_post_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-tokens", 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/get-status", params)
+      end
+
+    end
+
+  end
+
+end

data/lib/ost-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 OSTSdk
+
+  module Util
+
+  end
+
+end

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

@@ -0,0 +1,32 @@
+module OSTSdk
+
+  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-sdk-ruby/util/common_validator.rb

@@ -0,0 +1,50 @@
+module OSTSdk
+
+  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
+
+      #
+      #
+      # 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-sdk-ruby/util/http_helper.rb

@@ -0,0 +1,187 @@
+module OSTSdk
+
+  module Util
+
+    class HTTPHelper
+
+      require "uri"
+      require "open-uri"
+      require "openssl"
+      require "net/http"
+      require "json"
+
+      # Initialize
+      #
+      # Arguments:
+      #   environment: (String)
+      #   credentials: (OSTSdk::Util::APICredentials)
+      #   api_spec: (Boolean)
+      #
+      def initialize(environment, credentials, api_spec)
+        set_api_base_url(environment)
+        @api_key = credentials.api_key
+        @api_secret = credentials.api_secret
+        @api_spec = api_spec
+      end
+
+      # Send POST requests
+      #
+      # Arguments:
+      #   end_point: (String)
+      #   request_params: (Hash)
+      #
+      # Returns:
+      #   OSTSdk::Util::Result
+      #
+      def send_post_request(endpoint, request_params)
+        perform_and_handle_exceptions('u_hh_1', 'POST request failed') do
+          base_params = get_base_params(endpoint, request_params)
+          uri = post_api_uri(endpoint)
+          http = setup_request(uri)
+          r_params = base_params.merge(request_params)
+          if @api_spec
+            return OSTSdk::Util::Result.success({data: {request_uri: uri.to_s, request_type: 'POST', request_params: hash_to_query_string(r_params)}})
+          else
+            result = http.post(uri.path, hash_to_query_string(r_params))
+            return format_response(result)
+          end
+        end
+      end
+
+      # Send GET requests
+      #
+      # Arguments:
+      #   end_point: (String)
+      #   request_params: (Hash)
+      #
+      # Returns:
+      #   OSTSdk::Util::Result
+      #
+      def send_get_request(endpoint, request_params)
+        perform_and_handle_exceptions('u_hh_2', 'GET request Failed') do
+          base_params = get_base_params(endpoint, request_params)
+          r_params = base_params.merge(request_params)
+          uri = URI(get_api_url(endpoint))
+          uri.query = URI.encode_www_form(r_params)
+          if @api_spec
+            return OSTSdk::Util::Result.success({data: {request_uri: uri.to_s.split("?")[0], request_type: 'GET', request_params: hash_to_query_string(r_params)}})
+          else
+            result = Net::HTTP.get_response(uri)
+            return format_response(result)
+          end
+        end
+      end
+
+      private
+
+      def set_api_base_url(env)
+        ost_sdk_saas_api_endpoint = ENV['CA_SAAS_API_ENDPOINT']
+        if ost_sdk_saas_api_endpoint.present?
+          @api_base_url =  ost_sdk_saas_api_endpoint
+        else
+          case env
+            when 'sandbox'
+              @api_base_url = 'https://sandboxapi.ost.com'
+            when 'main'
+              @api_base_url = 'https://api.ost.com'
+            else
+              fail "unrecognized ENV #{env}"
+          end
+        end
+      end
+
+      def setup_request(uri)
+        http = Net::HTTP.new(uri.host, uri.port)
+        http.read_timeout = 5
+        http.open_timeout = 5
+        if uri.scheme == "https"
+          http.use_ssl = true
+          http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+        end
+        http
+      end
+
+      def get_base_params(endpoint, request_params)
+        request_timestamp = Time.now.to_i.to_s
+        str = endpoint + '::' + request_timestamp + '::' + format_request_params(request_params).to_json
+        signature = generate_signature(str)
+        {"request-timestamp" => request_timestamp, "signature" => signature, "api-key" => @api_key}
+      end
+
+      def generate_signature(string_to_sign)
+        digest = OpenSSL::Digest.new('sha256')
+        OpenSSL::HMAC.hexdigest(digest, @api_secret, string_to_sign)
+      end
+
+      def post_api_uri(endpoint)
+        URI(@api_base_url + endpoint)
+      end
+
+      def get_api_url(endpoint)
+        @api_base_url + endpoint
+      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
+          OSTSdk::Util::Result.exception(se, {error: err_code, error_message: err_message})
+        end
+      end
+
+      def format_request_params(request_params)
+        sorted_array = request_params.sort {|a, b| a[0].downcase <=> b[0].downcase}
+        sorted_hash = {}
+        sorted_array.each do |element|
+          value = element[1]
+          value = value.to_s
+          sorted_hash[element[0].to_s] = value
+        end
+        sorted_hash
+      end
+
+      def hash_to_query_string(hash)
+        str_array = []
+        hash.each do |k, v|
+          str_array << "#{k}=#{v.to_s}"
+        end
+        str_array.join('&')
+      end
+
+      def format_response(response)
+        response.code == '200' ? format_success_response(response.body) : format_failure_response(response.code)
+      end
+
+      def format_success_response(raw_response)
+        json_raw_response = JSON.parse(raw_response)
+        if json_raw_response['success']
+          OSTSdk::Util::Result.success({data: json_raw_response['data']})
+        else
+          err_data = json_raw_response['err']
+          OSTSdk::Util::Result.error(
+              {
+                  error: err_data['code'],
+                  error_message: err_data['msg'],
+                  error_data: err_data['error_data']
+              }
+          )
+        end
+      end
+
+      def format_failure_response(response_code)
+        OSTSdk::Util::Result.error(
+            {
+                error: response_code,
+                error_message: 'Non 200 HTTP Status',
+                http_code: response_code
+            }
+        )
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,247 @@
+module OSTSdk
+
+  module Util
+
+    class Result
+
+      attr_accessor :error,
+                    :error_message,
+                    :error_display_text,
+                    :error_display_heading,
+                    :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)
+        @error_display_text = params[:error_display_text] if params.key?(:error_display_text)
+        @error_display_heading = params[:error_display_heading] if params.key?(:error_display_heading)
+      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)
+        @http_code = h_c || 200
+      end
+
+      # Set Exception
+      #
+      # Arguments:
+      #   e: (Exception)
+      def set_exception(e)
+        @exception = e
+        @error_data = {
+            msg: e.message,
+            trace: e.backtrace
+        }
+      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?
+        @error ||
+            @error_message ||
+            @error_data ||
+            @error_display_text ||
+            @error_display_heading ||
+            @exception
+      end
+
+      # Exception message
+      #
+      # Returns:
+      #   exception_message: (String)
+      #
+      def exception_message
+        @e_m ||= @exception.nil? ? '' : @exception.message
+      end
+
+      # Exception backtrace
+      #
+      # Returns:
+      #   exception_backtrace: (String)
+      #
+      def exception_backtrace
+        @e_b ||= @exception.nil? ? '' : @exception.backtrace
+      end
+
+      # Get instance variables Hash style from object
+      #
+      def [](key)
+        instance_variable_get("@#{key}")
+      end
+
+      # Error
+      #
+      # Returns:
+      #   obj: (OSTSdk::Util::Result)
+      #
+      def self.error(params)
+        new(params)
+      end
+
+      # Success
+      #
+      # Returns:
+      #   obj: (OSTSdk::Util::Result)
+      #
+      def self.success(params)
+        new(params.merge!(no_error))
+      end
+
+      # Exception
+      #
+      # Returns:
+      #   obj: (OSTSdk::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,
+            error_display_text: nil,
+            error_display_heading: 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,
+            :error_display_text,
+            :error_display_heading
+        ]
+      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: {
+                  code: hash[:error],
+                  msg: hash[:error_message],
+                  display_text: hash[:error_display_text].to_s,
+                  display_heading: hash[:error_display_heading].to_s,
+                  error_data: hash[:error_data] || {}
+              },
+              data: hash[:data]
+          }
+        end
+
+      end
+
+    end
+    
+  end
+
+end

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

@@ -0,0 +1,120 @@
+module OSTSdk
+
+  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:
+      #   OSTSdk::Util::Result
+      #
+      def perform_and_handle_exceptions(err_code = 'swt', err_message = 'Something Went Wrong', &block)
+        begin
+          yield if block_given?
+        rescue StandardError => se
+          OSTSdk::Util::Result.exception(se, {error: err_code, error_message: err_message, data: @params} )
+        end
+      end
+
+      # returns current time
+      #
+      # Returns:
+      #   Time
+      #
+      def current_time
+        @c_time ||= Time.now
+      end
+
+      # returns current timestamp
+      #
+      # Returns:
+      #   Integer
+      #
+      def current_timestamp
+        @c_tstamp ||= current_time.to_f
+      end
+
+      # Success
+      #
+      # Returns:
+      #   OSTSdk::Util::Result
+      #
+      def success
+        success_with_data({})
+      end
+
+      # Success with data
+      #
+      # Arguments:
+      #   data: (Hash)
+      #
+      # Returns:
+      #   OSTSdk::Util::Result
+      #
+      def success_with_data(data)
+
+        # Allow only Hash data to pass ahead
+        data = {} unless Util::CommonValidator.is_a_hash?(data)
+
+        OSTSdk::Util::Result.success({data: data})
+
+      end
+
+      # Error with data
+      #
+      # Arguments:
+      #   code: (String)
+      #   msg: (String)
+      #   data: (Hash)
+      #
+      # Returns:
+      #   OSTSdk::Util::Result
+      #
+      def error_with_data(code, msg, data = {})
+
+        OSTSdk::Util::Result.error(
+            {
+                error: code,
+                error_message: msg,
+                data: data
+            }
+        )
+
+      end
+
+      #
+      # Exception with data and wthout action
+      #
+      # Arguments:
+      #   e: (Exception)
+      #   code: (String)
+      #   msg: (String)
+      #   data: (Hash optional)
+      #
+      # Returns:
+      #   OSTSdk::Util::Result
+      #
+      def exception_with_data(e, code, msg, data = {})
+
+        OSTSdk::Util::Result.exception(
+            e, {
+            error: code,
+            error_message: msg,
+            data: data
+          }
+        )
+
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,5 @@
+module OSTSdk
+
+  VERSION = "0.0.6"
+
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: ost-sdk-ruby
+version: !ruby/object:Gem::Version
+  version: 0.0.6
+platform: ruby
+authors:
+- OST Devs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-03-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: OST Ruby SDK provides easy integration with https://api.ost.com built
+  on top of OpenST Platform
+email: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/ost-sdk-ruby.rb
+- lib/ost-sdk-ruby/saas.rb
+- lib/ost-sdk-ruby/saas/addresses.rb
+- lib/ost-sdk-ruby/saas/base.rb
+- lib/ost-sdk-ruby/saas/transaction_kind.rb
+- lib/ost-sdk-ruby/saas/users.rb
+- lib/ost-sdk-ruby/util.rb
+- lib/ost-sdk-ruby/util/api_credentials.rb
+- lib/ost-sdk-ruby/util/common_validator.rb
+- lib/ost-sdk-ruby/util/http_helper.rb
+- lib/ost-sdk-ruby/util/result.rb
+- lib/ost-sdk-ruby/util/services_helper.rb
+- lib/ost-sdk-ruby/version.rb
+homepage: http://ost.com
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: OST Ruby SDK
+test_files: []