ost-sdk-ruby-stag 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 210d873ea1a2bca2ad9bb02d0471e87f156e317d
+  data.tar.gz: 7f76480e6ee7cdea999b58cfa3f40c7222536c72
+SHA512:
+  metadata.gz: 4dc0387fcfdf8d506b2d7ca7febe40dee0e3249a57862865951a2bb3a309e5ee217a25143b5572592dfdfb6166d405c3be2adc59a0efbf126d776c4e2300ffaa
+  data.tar.gz: 35aea0fd57e5bf600fb58359b775929db8e30bc38e06cd0d771af7e5fff3c7410462c12c42c48d114219b3395eb8c08647b1b634f4d324da131764ca6486aca4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/Gemfile

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

data/README.md

@@ -0,0 +1,46 @@
+# Ost::Sdk::Ruby::Stag
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/ost/sdk/ruby/stag`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ost-sdk-ruby-stag'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ost-sdk-ruby-stag
+
+## Usage
+
+1. TransactionKind Module 
+ 
+    environment = 'sandbox' # possible values sandbox / production
+    
+    credentials = OSTSdk::Util::APICredentials.new('api_key', '2e3ec863fdffcc4425a3d73878e685e702b42bf8')
+    
+    obj = OSTSdk::Saas::TransactionKind.new(environment, credentials)
+    
+    obj.list(clientId: '1')
+    
+    obj.create(client_id: '1', name: 'test_1', kind: '1', value_currency_type: '1')
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/ost-sdk-ruby-stag.
+

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ost/sdk/ruby/stag"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

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

@@ -0,0 +1,8 @@
+
+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

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

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

@@ -0,0 +1,29 @@
+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

@@ -0,0 +1,43 @@
+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
+      #
+      # 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
+
+    end
+
+  end
+
+end

data/lib/ost-sdk-ruby-stag/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-stag/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-stag/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-stag/util/http_helper.rb

@@ -0,0 +1,138 @@
+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_json
+        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].downcase<=>b[0].downcase}
+        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

@@ -0,0 +1,225 @@
+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

@@ -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-stag/version.rb

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

data/ost-sdk-ruby-stag.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ost-sdk-ruby-stag/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ost-sdk-ruby-stag"
+  spec.version       = OSTSdk::VERSION
+  spec.authors       = ["Puneet Khushwani"]
+  spec.email         = ["puneet.khushwani@pepo.com"]
+
+  spec.summary       = "OST Ruby SDK"
+  spec.description   = "Init Version"
+  spec.homepage      = "https://sale.stagingsimpletoken.org/"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: ost-sdk-ruby-stag
+version: !ruby/object:Gem::Version
+  version: 0.0.1.pre
+platform: ruby
+authors:
+- Puneet Khushwani
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Init Version
+email:
+- puneet.khushwani@pepo.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- 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
+- ost-sdk-ruby-stag.gemspec
+homepage: https://sale.stagingsimpletoken.org/
+licenses: []
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: OST Ruby SDK
+test_files: []