ost-sdk-ruby-stag 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b96e7c5c27df333a3c8644e338e3f6b79c9a622
-  data.tar.gz: ed43d1b2efc6ecd25658d863f66dac6cf079718a
+  metadata.gz: 283ab5ad91903b3173b9c85bf5983a21ce75c11d
+  data.tar.gz: e65d90cccd9abd34eda8633000e2cab7636c47cf
 SHA512:
-  metadata.gz: e42af98750f584eefb29061c4984ce54546b9f7dca189a4fd865456658e5b9e8fd592036c90da45813a405b867d4bf7bc861ba9a6181cb1711b577d60a6181e9
-  data.tar.gz: 66a6956204b285b55cfe5ff98ed893885c7e1c360d342fed75030cd2ef614a0d92fa29d5244a48b9b66f3f840569418b6200639ff964d6cbcabbfc5cdb30eb78
+  metadata.gz: bd111ab00e189e4f1f138d9bc733a3ae0c5bf90d976803e43b89c1be6522511d7454ebecb5c331ba2ddc2e81bb2dfef139c11885d6686bde3134c48b3e15499e
+  data.tar.gz: 67411e8db18d015e80a38145d645a382b263c9b837938f1f796e4c296dbe411ae5c6c8e8b4e85999be9a00cfb4e2523047f6504ae01a20ab893c2f61b055aca7

data/Gemfile

@@ -1,4 +1,4 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ost-sdk-ruby-stag-stag.gemspec
+# Specify your gem's dependencies in ost-sdk-ruby-stag.gemspec
 gemspec

data/README.md

@@ -22,18 +22,7 @@ Or install it yourself as:
 
 ## Usage
 
-1. TransactionKind Module 
- 
-     environment = 'sandbox' # possible values sandbox / production
-     
-     credentials = OSTSdk::Util::APICredentials.new('api_key', 'api_secret')
-     
-     obj = OSTSdk::Saas::TransactionKind.new(environment, credentials)
-     
-     obj.list
-     
-     obj.create()
-
+TODO: Write usage instructions here
 
 ## Development
 

data/lib/ost/sdk/ruby/stag.rb

@@ -0,0 +1,11 @@
+require "ost/sdk/ruby/stag/version"
+
+module Ost
+  module Sdk
+    module Ruby
+      module Stag
+        # Your code goes here...
+      end
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Ost
+  module Sdk
+    module Ruby
+      module Stag
+        VERSION = "0.1.0"
+      end
+    end
+  end
+end

data/ost-sdk-ruby-stag.gemspec

@@ -1,11 +1,11 @@
 # coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'ost-sdk-ruby-stag/version'
+require 'ost/sdk/ruby/stag/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "ost-sdk-ruby-stag"
-  spec.version       = OSTSdk::VERSION
+  spec.version       = Ost::Sdk::Ruby::Stag::VERSION
   spec.authors       = ["Puneet Khushwani"]
   spec.email         = ["puneet.khushwani@pepo.com"]
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ost-sdk-ruby-stag
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Puneet Khushwani
@@ -51,17 +51,8 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
-- lib/ost-sdk-ruby-stag.rb
-- lib/ost-sdk-ruby-stag/saas.rb
-- lib/ost-sdk-ruby-stag/saas/base.rb
-- lib/ost-sdk-ruby-stag/saas/transaction_kind.rb
-- lib/ost-sdk-ruby-stag/util.rb
-- lib/ost-sdk-ruby-stag/util/api_credentials.rb
-- lib/ost-sdk-ruby-stag/util/common_validator.rb
-- lib/ost-sdk-ruby-stag/util/http_helper.rb
-- lib/ost-sdk-ruby-stag/util/result.rb
-- lib/ost-sdk-ruby-stag/util/services_helper.rb
-- lib/ost-sdk-ruby-stag/version.rb
+- lib/ost/sdk/ruby/stag.rb
+- lib/ost/sdk/ruby/stag/version.rb
 - ost-sdk-ruby-stag.gemspec
 homepage: https://sale.stagingsimpletoken.org/
 licenses: []

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

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

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

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

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

@@ -1,29 +0,0 @@
-module OSTSdk
-
-  module Saas
-
-    class Base
-
-      include OSTSdk::Util::ServicesHelper
-
-      attr_reader :http_helper
-
-      # Initialize
-      #
-      # @param [Hash] params (mandatory) is a Hash
-      #
-      def initialize(environment, credentials)
-
-        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)
-
-      end
-
-    end
-
-  end
-
-end

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

@@ -1,52 +0,0 @@
-module OSTSdk
-
-  module Saas
-
-    class TransactionKind < OSTSdk::Saas::Base
-
-      # Initialize
-      #
-      # Arguments:
-      #   environment: (String)
-      #   credentials: (OSTSdk::Util::APICredentials)
-      #
-      def initialize(environment, credentials)
-        super
-        @url_prefix = 'transaction/kind'
-      end
-
-      # Creates a new transaction type
-      #
-      def list
-        http_helper.send_get_request("#{@url_prefix}/get-all", {})
-      end
-
-      # Creates a new transaction type
-      #
-      # @param [Hash] params (mandatory) is a Hash
-      #
-      def create(params)
-        http_helper.send_post_request("#{@url_prefix}/create", params)
-      end
-
-      # Update a transaction type
-      #
-      # @param [Hash] params (mandatory) is a Hash
-      #
-      def update(params)
-        http_helper.send_post_request("#{@url_prefix}/update", params)
-      end
-
-      # Delete a transaction type
-      #
-      # @param [Hash] params (mandatory) is a Hash
-      #
-      def delete(params)
-        http_helper.send_post_request("#{@url_prefix}/delete", params)
-      end
-
-    end
-
-  end
-
-end

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

@@ -1,13 +0,0 @@
-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-stag/util/api_credentials.rb

@@ -1,32 +0,0 @@
-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-stag/util/common_validator.rb

@@ -1,50 +0,0 @@
-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-stag/util/http_helper.rb

@@ -1,138 +0,0 @@
-module OSTSdk
-
-  module Util
-
-    class HTTPHelper
-
-      require "uri"
-      require "open-uri"
-      require "openssl"
-      require "json"
-
-      # Initialize
-      #
-      # Arguments:
-      #   environment: (String)
-      #   credentials: (OSTSdk::Util::APICredentials)
-      #
-      def initialize(environment, credentials)
-        set_api_base_url(environment)
-        @api_key = credentials.api_key
-        @api_secret = credentials.api_secret
-      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)
-          result = http.post(uri.path, hash_to_query_string(r_params))
-          OSTSdk::Util::Result.success({data: JSON.parse(result.body)})
-        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)
-          raw_url = get_api_url(endpoint) + "?#{hash_to_query_string(r_params)}"
-          result = URI.parse(raw_url).read
-          OSTSdk::Util::Result.success({data: JSON.parse(result)})
-        end
-      end
-
-      private
-
-      def set_api_base_url(env)
-        case env
-          when 'sandbox'
-            @api_base_url = 'http://localhost:3000/'
-          when 'production'
-            @api_base_url = ''
-          else
-            fail "unrecognized ENV #{env}"
-        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 + '::' + sort_hash(request_params).to_s
-        signature = generate_signature(@api_secret, str)
-        {"request-timestamp" => request_timestamp, "signature" => signature, "api-key" => @api_key}
-      end
-
-      def generate_signature(api_secret, 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 sort_hash(request_params)
-        sorted_array = request_params.sort {|a,b| a[0]<=>b[0]}
-        sorted_hash = {}
-        sorted_array.each do |element|
-          sorted_hash[element[0]] = element[1]
-        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
-
-    end
-
-  end
-
-end

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

@@ -1,225 +0,0 @@
-module OSTSdk
-
-  module Util
-
-    class Result
-
-      attr_accessor :error,
-                    :error_message,
-                    :error_display_text,
-                    :error_display_heading,
-                    :error_data,
-                    :message,
-                    :data,
-                    :exception
-
-      # Initialize
-      #
-      # Arguments:
-      #   params: (Hash)
-      def initialize(params = {})
-        set_error(params)
-        set_message(params[:message])
-        @data = params[:data] || {}
-      end
-
-      # Set Error
-      #
-      # @param [Hash] params is a 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
-      #
-      # @param [String] msg is a String
-      #
-      def set_message(msg)
-        @message = msg
-      end
-
-      # Set Exception
-      #
-      # @param [Exception] e is an 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.present? ||
-            @error_message.present? ||
-            @error_data.present? ||
-            @error_display_text.present? ||
-            @error_display_heading.present? ||
-            @exception.present?
-      end
-
-      # Exception message
-      #
-      # @return [String]
-      #
-      def exception_message
-        @e_m ||= @exception.present? ? @exception.message : ''
-      end
-
-      # Exception backtrace
-      #
-      # @return [String]
-      #
-      def exception_backtrace
-        @e_b ||= @exception.present? ? @exception.backtrace : ''
-      end
-
-      # Get instance variables Hash style from object
-      #
-      def [](key)
-        instance_variable_get("@#{key}")
-      end
-
-      # Error
-      #
-      # @return [OSTSdk::Util::Result] returns object of OSTSdk::Util::Result class
-      #
-      def self.error(params)
-        new(params)
-      end
-
-      # Success
-      #
-      # @return [OSTSdk::Util::Result] returns object of OSTSdk::Util::Result class
-      #
-      def self.success(params)
-        new(params.merge!(no_error))
-      end
-
-      # Exception
-      #
-      # @return [OSTSdk::Util::Result] returns object of OSTSdk::Util::Result class
-      #
-      def self.exception(e, params = {})
-        obj = new(params)
-        obj.set_exception(e)
-        return obj
-      end
-
-      # No Error
-      #
-      # @return [Hash] returns 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
-      #
-      # @return [Array] returns Array object
-      #
-      def self.fields
-        error_fields + [:data, :message]
-      end
-
-      # Error Fields
-      #
-      # @return [Array] returns Array object
-      #
-      def self.error_fields
-        [
-            :error,
-            :error_message,
-            :error_data,
-            :error_display_text,
-            :error_display_heading
-        ]
-      end
-
-      # Create an Hash out of all instance vars
-      #
-      # @return [Hash] returns Hash object
-      #
-      def to_hash
-        self.class.fields.each_with_object({}) do |key, hash|
-          val = send(key)
-          hash[key] = val if val.present?
-        end
-      end
-
-      # To JSON
-      #
-      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-stag/util/services_helper.rb

@@ -1,111 +0,0 @@
-module OSTSdk
-
-  module Util
-
-    module ServicesHelper
-
-      # 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, 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-stag/version.rb

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