most_ots 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: bd3e7c21684a590abd6f7805e99a3da0347b9d31b1e9e8cc6a3572cf2bb28e50
-  data.tar.gz: 4bf3bd4c9c7bd62ef0a48f55b11aa56b6cdd7536213d6c7aaecfbe090e34d714
+SHA1:
+  metadata.gz: 82a7bdbc23f446162b0a1bfaff3610bf8eb84572
+  data.tar.gz: 26aa1c644c27c17a1967584cadc19a6b36e95d94
 SHA512:
-  metadata.gz: 3ed2e1c9aa454551e763de4346ec252efe59bc2e1bb9e5eca8b8839317e055ccc1b34bc2a2c491591f10201862553ce7227389637f416173dffa3a5646ba1fe6
-  data.tar.gz: c2dee037cabf9068e39b78b547b77caac2214be402a2ad52c79ba60576d9f92f114e1bf79b7b2a447ef989ab914f296a220016b3d3c9051371a7d6f9514b84b8
+  metadata.gz: ed089c5f4a2c654fc535c47705061d232e405d18b352b8282d4e9926b809ac5b3e8fb7a87c2d391d2c3215792d7b93ac6209e962afde244a558091dd389e06f5
+  data.tar.gz: ccc96f86ee0c10df7ed37a722fd9625510d88c871fbb8915444e7c3b59aa29aa30b4d2053a971e1d95815235c12e6bc6b30084d0f5e1946ee5a93d2661d15a16

data/README.md

@@ -1,6 +1,10 @@
 # MostMoneyOts
 
 [![Gem Version](https://badge.fury.io/rb/most_ots.svg)](https://badge.fury.io/rb/most_ots) [![Build Status](https://travis-ci.org/ssxenon01/most_ots.svg?branch=master)](https://travis-ci.org/ssxenon01/most_ots)
+[![Maintainability](https://api.codeclimate.com/v1/badges/afbec1dd7a17291317f5/maintainability)](https://codeclimate.com/github/ssxenon01/most_ots/maintainability)
+[![codebeat badge](https://codebeat.co/badges/d51c6f19-41bd-4778-9492-629a0601d40d)](https://codebeat.co/projects/github-com-ssxenon01-most_ots-master)
+[![Inline docs](http://inch-ci.org/github/ssxenon01/most_ots.svg?branch=master)](http://inch-ci.org/github/ssxenon01/most_ots)
+[![Dependency Status](https://beta.gemnasium.com/badges/github.com/ssxenon01/most_ots.svg)](https://beta.gemnasium.com/projects/github.com/ssxenon01/most_ots)
 
 [Most Money](https://customer.mostmoney.mn/index.aspx?page=content/uctrademerchant#content~share)
 External Protocol

data/lib/most_ots/models/base.rb

@@ -0,0 +1,20 @@
+module MostOts
+  class Base
+
+    def initialize(data)
+      @data = data
+    end
+
+    def method_missing(method_name, *args, &block)
+      if @data.key?(method_name)
+        @data[method_name]
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(method_name, _include_private = false)
+      @data.key?(method_name)
+    end
+  end
+end

data/lib/most_ots/models/response.rb

@@ -0,0 +1,5 @@
+module MostOts
+  class Response < Base
+    
+  end
+end

data/lib/most_ots/service.rb

@@ -1,4 +1,3 @@
-require 'net/http'
 require 'json'
 require 'openssl'
 require 'base64'
@@ -6,86 +5,95 @@ require 'most_ots/logging'
 require 'httparty'
 
 module MostOts
-  #
+  # Most Money HTTP Service Wrapper
   class Service
     include Logging
     # Fields that needs to be encrypted
     ENCRYPTED_FIELDS = %i[traceNo qrAccountNumber qrCode srcMsisdn tan].freeze
+    # Current Protocol Version
+    PROTOCOL_VERSION = '05'.freeze
 
-    attr_accessor :cipher_key, :cipher_iv
+    # @return [String] 16byte key string
+    attr_accessor :cipher_key
+
+    # @return [Array] cipher IV binary
+    attr_accessor :cipher_iv
+
+    # Base Parameters
+    # @return [Hash]
+    attr_accessor :base_params
+
+    # Most Provided Public Key
+    # @return [File] or [String] certificate_string
+    attr_accessor :certificate
+
+    # Most API Endpoint
+    # @return [String] MOST Service HOST
+    attr_accessor :api_host
 
     # @param [Hash] options
     def initialize(options = {})
       logger.debug('MostOts Service API Initializing')
-      @base_params = {
-        lang: options.fetch(:lang) { '0' },
-        srcInstId: options.fetch(:src_inst_id) { ENV['SRC_INST_ID'] }
-      }
-      @protocol_version = options.fetch(:protocol_version) { '05' }
-      @most_cert_file = options.fetch(:most_cert_file)
-      @api_host = options.fetch(:host) { 'http://202.131.242.165:9089' }
-
-      @payee_id = options[:payee_id] if options.key?(:payee_id)
-      @qr_bank_code = options[:qr_bank_code] if options.key?(:qr_bank_code)
-      @qr_account_name = options[:qr_account_name] if options.key?(:qr_account_name)
-      @qr_account_number = options[:qr_account_number] if options.key?(:qr_account_number)
-      @tran_cur = options[:tran_cur] if options.key?(:tran_cur)
-      @pos_no = options[:pos_no] if options.key?(:pos_no)
-      @base_params[:channel] = options[:channel] if options.key?(:channel)
-      @base_params[:device_mac] = options[:device_mac] if options.key?(:device_mac)
-      @base_params[:device_ip] = options[:device_ip] if options.key?(:device_ip)
-      @base_params[:device_name] = options[:device_name] if options.key?(:device_name)
-      @cipher_key = options[:cipher_key]
-      @cipher_iv = options.fetch(:cipher_iv)
-
-      @user_agent = "most_ots/#{VERSION} ruby/#{RUBY_VERSION}"
-      @user_agent << " #{options[:app_name]}/#{options[:app_version]}" if options.key?(:app_name) && options.key?(:app_version)
+      setup_base_params(options)
+      self.certificate = options.fetch(:most_cert_file)
+      self.api_host    = options.fetch(:host) { 'http://202.131.242.165:9089' }
+      self.cipher_key  = options[:cipher_key]
+      self.cipher_iv   = options.fetch(:cipher_iv)
     end
 
+    # @param [Hash] params
+    # @return [JSON] response
     def purchase_qr(params)
       logger.debug('MostOts Service Purchase QR Called')
-      base = {}
-      base[:payeeId] = @payee_id unless @payee_id.nil?
-      base[:posNo] = @pos_no unless @pos_no.nil?
-      base[:tranCur] = @tran_cur unless @tran_cur.nil?
-      api_request('/api/mapi/TT3051', base.merge(params))
+      # Mandatory Fields
+      mf = %i[srcInstId channel lang traceNo payeeId posNo tranAmount tranCur tranDesc]
+      # Optional Fields 
+      of = %i[billId deviceIP deviceMac deviceName qrPaidLimit]
+      api_request('/api/mapi/TT3051', configure_params(params, mf, of))
     end
 
+    # @param [Hash] params
+    # @return [JSON] response
     def transfer_qr(params)
       logger.debug('MostOts Service Transfer QR Called')
-      base = {}
-      base[:qrBankCode] = @qr_bank_code unless @qr_bank_code.nil?
-      base[:qrAccountName] = @qr_account_name unless @qr_account_name.nil?
-      base[:qrAccountNumber] = @qr_account_number unless @qr_account_number.nil?
-      base[:tranCur] = @tran_cur unless @tran_cur.nil?
-      api_request('/api/mapi/TT3061', params)
+      # Mandatory Fields
+      mf = %i[srcInstId channel lang traceNo qrBankCode qrAccountName qrAccountNumber tranAmount tranCur]
+      # Optional Fields
+      of = %i[tranDesc]
+      api_request('/api/mapi/TT3061', configure_params(params, mf, of))
     end
 
+    # @param [Hash] params
+    # @return [JSON] response
     def wait_payment_response(params)
       logger.debug('MostOts Service Waiting Payment Response')
-      base = {}
-      base[:payeeId] = @payee_id unless @payee_id.nil?
-      base[:posNo] = @pos_no unless @pos_no.nil?
-      api_request('/api/mapi/TT3064', params)
+      # Mandatory Fields
+      mf = %i[srcInstId channel lang qrBankCode qrAccountName qrAccountNumber tranAmount tranCur]
+      # Optional Fields
+      of = %i[tranDesc]
+      api_request('/api/mapi/TT3064', configure_params(params, mf, of))
     end
 
+    # @param [Hash] params
+    # @return [JSON] response
     def check_qr_payment(params)
       logger.debug('MostOts Service Check QR Payment Called')
-      base = {}
-      base[:payeeId] = @payee_id unless @payee_id.nil?
-      base[:posNo] = @pos_no unless @pos_no.nil?
-      base[:tranCur] = @tran_cur unless @tran_cur.nil?
-      api_request('/api/mapi/TT3065', params)
+      # Mandatory Fields
+      mf = %i[srcInstId channel lang traceNo qrCode payeeId posNo billId isCheckQr]
+      # Optional Fields
+      of = %i[deviceIP deviceMac deviceName]
+      api_request('/api/mapi/TT3065', configure_params(params, mf, of))
     end
 
-    # @param [Object] params
+    # @param [Hash] params
+    # @return [JSON] response
     def purchase_tan(params)
       logger.debug('MostOts Service Purchase Tan Called')
-      base = {}
-      base[:payeeId] = @payee_id unless @payee_id.nil?
-      base[:posNo] = @pos_no unless @pos_no.nil?
-      base[:tranCur] = @tran_cur unless @tran_cur.nil?
-      api_request('/api/mapi/TT1608', params)
+      # Mandatory Fields
+      mf = %i[srcInstId channel lang traceNo payeeId posNo srcMsisdn tan tranAmount tranCur]
+      # Optional Fields
+      of = %i[billId tranDesc deviceIP deviceMac deviceName]
+      api_request('/api/mapi/TT1608', configure_params(params, mf, of))
     end
 
     private
@@ -94,16 +102,14 @@ module MostOts
     # @param [Hash or String] data
     # @return [Hash] encrypted hash with signature
     def encrypt(data)
-      data = JSON.generate(data) unless data.is_a?(String)
       cipher = OpenSSL::Cipher.new('AES-128-CBC')
       cipher.encrypt
-      cipher.iv = @cipher_iv.pack('c*')
-      rsa = OpenSSL::PKey::RSA.new @most_cert_file
-      key = @cipher_key.nil? ? cipher.random_key : @cipher_key
-      cipher.key = key
+      cipher.iv  = cipher_iv.pack('c*')
+      rsa        = OpenSSL::PKey::RSA.new certificate
+      cipher.key = cipher_key_string
       {
         SD: Base64.encode64("#{cipher.update(data)}#{cipher.final}"),
-        EK: Base64.encode64(rsa.public_encrypt(key)),
+        EK: Base64.encode64(rsa.public_encrypt(cipher_key_string)),
         SG: Digest::SHA1.base64digest(data)
       }
     end
@@ -112,34 +118,75 @@ module MostOts
     # @param [Hash] params
     # @return [Object] response
     def api_request(path, params = nil)
-      params = generate_params(params)
+      params  = encrypt_params(params)
       headers = {
-        'Content-Type' => 'application/json',
-        :Accept => 'application/json',
+        'Content-Type'   => 'application/json',
+        :Accept          => 'application/json',
         'Accept-Charset' => 'utf-8',
-        :TT => path.split('TT').last,
-        :RS => '00',
-        'User-Agent' => @user_agent,
-        :PV => @protocol_version
+        :TT              => path.split('TT').last,
+        :RS              => '00',
+        'User-Agent'     => user_agent,
+        :PV              => PROTOCOL_VERSION
       }
-      logger.debug("Service Called With endpoint #{@api_host}#{path} params: #{params}")
-      logger.debug("headers: #{headers}")
-      req = HTTParty.post(
-        "#{@api_host}#{path}",
-        body: params,
-        headers: headers
-      )
+      logger.debug("Service Called With endpoint #{api_host}#{path} params: #{params}")
+      req = HTTParty.post("#{api_host}#{path}", body: params, headers: headers)
       JSON.parse(req.body)
     end
 
+    def configure_params(params, mandatory_fields, optional_fields = [])
+      params           = base_params.merge(params)
+      processed_params = {}
+      required         = mandatory_fields.select { |mk| params[mk].nil? }
+      if required.any?
+        raise "Following mandatory Fields cannot be nil: #{required.join('.')}"
+      end
+      params.each do |k, v|
+        processed_params[k] = v if (mandatory_fields + optional_fields).include?(k) && !v.nil?
+      end
+      processed_params
+    end
+
     # @param [Hash] params
-    def generate_params(params)
+    # @return [String] json_string
+    def encrypt_params(params)
       to_encrypt = {}
       ENCRYPTED_FIELDS.each do |encrypted_key|
         to_encrypt[encrypted_key] = params.delete(encrypted_key) if params.key?(encrypted_key)
       end
-      JSON.generate(@base_params.merge(params).merge(encrypt(to_encrypt)))
+      JSON.generate(params.merge(encrypt(JSON.generate(to_encrypt))))
     end
 
+    # @param [Hash] options
+    # @return [Hash] base_params
+    def setup_base_params(options)
+      self.base_params = {
+        lang:            options.fetch(:lang) { '0' },
+        srcInstId:       options.fetch(:src_inst_id) { ENV['SRC_INST_ID'] },
+        channel:         options[:channel],
+        deviceMac:       options[:device_mac],
+        deviceIp:        options[:device_ip],
+        deviceName:      options[:device_name],
+        payeeId:         options[:payee_id],
+        qrBankCode:      options[:qr_bank_code],
+        qrAccountName:   options[:qr_account_name],
+        qrAccountNumber: options[:qr_account_number],
+        tranCur:         options[:tran_cur],
+        posNo:           options[:pos_no]
+      }
+    end
+
+    # @return [String] 16 byte key string
+    def cipher_key_string
+      if cipher_key.nil?
+        cipher = OpenSSL::Cipher.new('AES-128-CBC')
+        cipher.encrypt
+        self.cipher_key = cipher.random_key
+      end
+      cipher_key
+    end
+
+    def user_agent
+      "most_ots/#{VERSION} ruby/#{RUBY_VERSION}"
+    end
   end
 end

data/lib/most_ots/version.rb

@@ -1,3 +1,3 @@
 module MostOts
-  VERSION = '0.1.1'.freeze
+  VERSION = '0.1.2'.freeze
 end

data/most_ots.gemspec

@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'ruby-jmeter', '~> 3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: most_ots
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Gundsambuu Natsagdorj
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-26 00:00:00.000000000 Z
+date: 2018-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: ruby-jmeter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
 description: 
 email:
 - ssxenon01@gmail.com
@@ -103,6 +117,8 @@ files:
 - lib/most_ots/errors/error.rb
 - lib/most_ots/errors/server_error.rb
 - lib/most_ots/logging.rb
+- lib/most_ots/models/base.rb
+- lib/most_ots/models/response.rb
 - lib/most_ots/service.rb
 - lib/most_ots/version.rb
 - most_ots.gemspec
@@ -126,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.4
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Most Money External Protocol