wireway 202009261101 → 202012161641

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9237eaee0fd2deb0be287b9fbdc82c055547985a059d4f60c36f22ca6ebd56c
-  data.tar.gz: f524f667e4a0c2b4feb00fc4194c2647ceeaee07dcfeb8a5b4961b526e48caa2
+  metadata.gz: 8330c413fc8bd8b3bddd33990d1c124c2974ad0a9a45c4ec7e8b220f933dc417
+  data.tar.gz: db406a9c62ad0fbb1c0d42f4f41f20490e35ca6e7b95957f9424d881bd78728f
 SHA512:
-  metadata.gz: 2b72a87f14671df8d89f55673f3321f27f27742fb848d293a7880f7e038f526ae7f90a8aab5cfe9f0de9f9f54dd6615a6fcac97baff50fd157cd059673029bbf
-  data.tar.gz: 3d3e2e50c7bef6c6e0ccb1a8990b0f0fe6d94d6a6d47db85e4067dd3461fe094226277a1f04b2c17ce14404b29c39d19e3145bf925cff60a4ed85dc4b2f30e49
+  metadata.gz: 4d84f15fe9da85b6348362085c0b0e574061448262b50701f209b2b234bbfbfcf92806e223fabba2b8b3d67eecd6f73094a777cd415acca2fb0f718465e8a72f
+  data.tar.gz: a42d73253abb53f7ac68c6ba95225bee4cb164238e2548d2c1233af639201da95f81b0169f44cb41dbcd77e84bd9e1ce488c544860e2afe3f6e348815eb7fc47

data/README.md

@@ -1,3 +1,15 @@
+
+<!-- TOC -->
+
+- [说明](#说明)
+  - [执照](#执照)
+  - [插件作用](#插件作用)
+  - [行为准则](#行为准则)
+  - [关于C919](#关于c919)
+  - [使用示例](#使用示例)
+
+<!-- /TOC -->
+
 # 说明
 
 ## 执照
@@ -27,4 +39,14 @@ C919为系列Gem组件的集合,具体组成部分及相关示例[参考](https:
 ```ruby
 Wireway::Spark.satcom(api_code: :finance_fund_base_info, code: '161725')
 # => [true, {:基金全称=>"招商中证白酒指数分级证券投资基金", :基金简称=>"招商中证白酒指数分级", :基金代码=>"161725（前端）", :基金类型=>"股票指数", :发行日期=>"2015年05月12日", :"成立日期/规模"=>"2015年05月27日 / 3.965亿份", :资产规模=>"129.25亿元（截止至：2020年06月30日）", :份额规模=>"184.0866亿份（截止至：2020年08月26日）", :基金经理人=>"侯昊", :基金托管人=>"中国银行", :成立来分红=>"每份累计0.00元（0次）", :管理费率=>"1.00%（每年）", :托管费率=>"0.22%（每年）", :销售服务费率=>"---（每年）", :最高认购费率=>"0.80%（前端）", :业绩比较基准=>"中证白酒指数收益率×95%+金融机构人民币活期存款基准利率(税后)×5%", :跟踪标的=>"中证白酒指数", :母子基金=>"161725（母）150269 150270（子）", :是否配对转换=>"是", :是否转LOF=>"否", :封闭期=>"无", :提前结束条款=>"无", :定期折算日=>"每个会计年度的12月15日(遇节假日顺延)", :不定期折算条件=>"当招商中证白酒份额的基金份额净值达到1.500元;当招商中证白酒B份额的基金份额参考净值达到0.250元。", :固定收益份额年化收益率=>"一年期定期存款利率(税后)+3%", :亏损临界点=>"无", :保收益临界点=>"无", :超额收益临界点=>"无"}]
+```
+
+或无需引用Gem直接发起Post请求:
+
+```bash
+curl --location --request POST '123.57.155.17:3114/wireway/restful/request_api' \
+--header 'Content-Type: application/x-www-form-urlencoded' \
+--data-urlencode 'platform=satcom' \
+--data-urlencode 'api_code=finance_fund_base_info' \
+--data-urlencode 'code=161725'
 ```

data/app/controllers/wireway/application_controller.rb

@@ -1,5 +1,6 @@
 module Wireway
   class ApplicationController < ActionController::Base
     protect_from_forgery with: :exception
+    skip_before_action :verify_authenticity_token
   end
 end

data/app/controllers/wireway/restful_controller.rb

@@ -0,0 +1,13 @@
+module Wireway
+  class RestfulController < ApplicationController
+    def request_api
+      # TODO 初步了解为rails5的安全机制 去除存在风险 暂时先这样
+      args = params.permit!.to_hash.reject!{|key| ["action", "controller"].include?(key)}.deep_symbolize_keys
+
+      res = Wireway::Spark.send(args[:platform], args)
+      tmp = {success: res[0], result: res[1]}
+      (tmp.merge!(res[2]) rescue nil) if res[2].present?
+      render json: tmp.merge!(tmp)
+    end
+  end
+end

data/app/models/wireway/business_logic/restful.rb

@@ -11,14 +11,16 @@ module Wireway
       def node_addresses
         return $wireway_node_addresses unless $wireway_node_addresses == 404
 
-        hosts = ['172.28.81.156:3113']
+        nodes = ['123.57.155.17:3113']
         route = '/satcom/other/c919/node_addresses.json'
-        res = get(addresses: hosts, route: route) do |result|
+        res = get(addresses: nodes, route: route) do |result|
           hash = JSON.parse(result[1][:body]).deep_symbolize_keys 
           [true, hash]
         end
-        raise res[1] unless res[0]
-        $wireway_node_addresses = res[1].map{|key, value| [key, value[:nodes]]}.to_h
+
+        return res unless res[0]
+        nodes = res[1].map{|key, value| [key, value[:nodes]]}.to_h
+        $wireway_node_addresses = [true, nodes]
       end 
 
       def dashboard(**args)
@@ -26,8 +28,9 @@ module Wireway
           response_type: 'json',
         }.merge!(args)
         route = '/dashboard/restful/request_api'
-
-        post(addresses: node_addresses[:dashboard], route: route, params: params) do |result|
+        res = node_addresses
+        return res unless res[0]
+        post(addresses: res[1][:dashboard], route: route, params: params) do |result|
           return result if (params[:response_type] != 'json')
           body = JSON.parse(result[1][:body]).deep_symbolize_keys 
           return [false, body[:result]] unless body[:success]
@@ -38,14 +41,40 @@ module Wireway
       def satcom(**args)
         params = {}.merge!(args)
         route = '/satcom/restful/request_api'
+        res = node_addresses
+        return res unless res[0]
+        post(addresses: res[1][:satcom], route: route, params: params) do |result|
+          body = JSON.parse(result[1][:body]).deep_symbolize_keys 
+          return [false, body[:result], body[:errors]].compact unless body[:success]
+          [true, body[:result]]
+        end
+      end
 
-        post(addresses: node_addresses[:satcom], route: route, params: params) do |result|
+      def wireway(**args)
+        params = {
+          local: false
+        }.merge!(args)
+        route = '/wireway/restful/request_api'
+        res = node_addresses
+        return res unless res[0]
+        post(addresses: res[1][:wireway], route: route, params: params) do |result|
           body = JSON.parse(result[1][:body]).deep_symbolize_keys 
-          return [false, body[:result]] unless body[:success]
+          return [false, body[:result], body[:errors]].compact unless body[:success]
           [true, body[:result]]
         end
       end
 
+      def black_box(**args)
+        params = {}.merge!(args)
+        route = '/black_box/restful/request_api'
+        res = node_addresses
+        return res unless res[0]
+        res = post(addresses: res[1][:black_box], route: route, params: params) do |result|
+          body = JSON.parse(result[1][:body]).deep_symbolize_keys
+          return [false, body[:result], body[:errors]].compact unless body[:success]
+          [true, body]
+        end
+      end
 
       def get(addresses:, route:, params: {})
         result = round_robin(addresses: addresses) do |address|
@@ -58,7 +87,7 @@ module Wireway
         begin
           yield result
         rescue
-          return [false, '运行时结果处理异常', {errors: {message: $!.to_s, path: $@}}]
+          return [false, '[Wireway]运行时结果处理异常', {errors: {message: $!.to_s, path: $@}}]
         end
       end 
 
@@ -71,7 +100,7 @@ module Wireway
         begin
           yield result
         rescue
-          return [false, '运行时结果处理异常', {errors: {message: $!.to_s, path: $@}}]
+          return [false, '[Wireway]运行时结果处理异常', {errors: {message: $!.to_s, path: $@}}]
         end
       end 
 
@@ -92,7 +121,7 @@ module Wireway
         def get_response
           begin
             response = yield
-            return [false, "响应码异常:#{response.code}", {response: response}] unless (response.code == 200)
+            return [false, "[Wireway]响应码异常:#{response.code}", {response: response}] unless (response.code == 200)
 
             hash = {code: 200}
             res = handle_body_encode(body: response.body)
@@ -100,7 +129,7 @@ module Wireway
 
             hash.merge!({body: res[1]})
           rescue
-            return [false, '请求异常', {errors: {message: $!.to_s, path: $@}}]
+            return [false, '[Wireway]请求异常', {errors: {message: $!.to_s, path: $@}}]
           end
           
           [true, hash]

data/app/models/wireway/spark.rb

@@ -1,17 +1,21 @@
 module Wireway
   module Spark
-    
-    # Wireway::Spark.dashboard(api_code: :publish_other_request_assets, rely_assets: ["bootstrap_4", "jQuery_3_5_1", "chart_js"])
-    # Wireway::Spark.satcom(api_code: :finance_fund_base_info, code: '161725')
-    def self.method_missing(method_name, **args)
+    def self.method_missing(method_name, local: true, **args)
       begin
         target = Wireway::BusinessLogic::Restful
-        return [false, '未找到相关定义方法'] unless target.respond_to?(method_name)
+        unless [true, 'true', 1, '1', 'yes'].include?(local)
+          return [false, "未找到名称为:#{method_name}的方法定义."] unless target.respond_to?(method_name)
+        end
         res = target.send(method_name, args)
       rescue
-        return [false, '请求异常', {errors: {message: $!.to_s, path: $@}}]
+        error_msg = [false, '[Wireway]请求异常', {errors: {message: $!.to_s, path: $@}}]
+        return error_msg unless [true, 'true', 1, '1', 'yes'].include?(local)
+        # 当以Gem形式的组件无法处理请求时,尝试请求线上版组件是否可以正常处理请求
+        # 即当gem出现问题时会请求线上服务 有利于断点排查
+        args.merge!(platform: method_name)
+        res = target.wireway(args)
       end
-    end 
+    end
 
   end
 end

data/app/models/wireway/standard.rb

@@ -0,0 +1,145 @@
+module Wireway
+  # 接口请求参数标准
+  module Standard
+    extend self
+
+      # 全自检项检查
+      def inspect_all(ideal:, reality:)
+        ideal_reality = {ideal: ideal, reality: reality}
+
+        res = default_value(ideal_reality)
+        return res unless res[0]
+
+        res = value_type(ideal_reality)
+        return res unless res[0]
+        
+        res = attribute_necessary(ideal_reality)
+        return res unless res[0]
+
+        # res = check_data_format(described: described, reality: reality)
+        # return res unless res[0]
+        [true, '']
+      end 
+
+      # 参数项检查
+      def attribute_necessary(ideal:, reality:)
+        # 检查必须参数是否缺失
+        necessary_standards = ideal.select{|standard| standard[:necessary] == true}
+        necessary_standards.each do |standard|
+          key = standard[:key]
+          unless (reality[key.to_sym] || reality[key]).present?
+            return [false, "#{standard[:name]}(#{key})为必须项,不能为空"]
+          end 
+        end 
+        
+        # 检查参数值是否符合正则式要求
+        reality.each do |key, value|
+          standard = ideal.select{|standard| [key, key.to_sym, key.to_s].uniq.include?(standard[:key])}[0]
+          # return [false, "未找到关于参数:#{key} 的定义"] unless standard
+          next unless standard
+
+          if standard[:regular] && (value.to_s =~ standard[:regular]).nil?
+            tmp = "参数:#{standard[:name]}(#{key})的参数值(#{value})不满足要求"
+            tmp+= ", 请参考: #{standard[:explain]}" if standard[:explain].present?
+            tmp+= ", 示例值: #{standard[:example]}" if standard[:example].present?
+            tmp+= ", 默认值: #{standard[:default]}" if standard[:default].present?
+            tmp+='.'
+            return [false, tmp] 
+          end 
+        end 
+
+        [true, '']
+      end 
+
+      # 参数默认值检查
+      def default_value(ideal:, reality:)
+        ideal.select{|standard| !standard[:default].nil?}.each do |standard|
+          unless reality[standard[:key].to_sym].present?
+            reality.merge!({standard[:key].to_sym => standard[:default]})
+          end
+        end 
+
+        [true, '']
+      end
+
+      # 参数值格式检查
+      def value_type(ideal:, reality:)
+        ideal.each do |standard|
+          unless standard[:value_type].present?
+            return [false, "自描述参数标准检查异常: #{standard[:name]}(#{standard[:key]})未设置对应参数值类型(value_type)."]
+          end 
+        end
+
+        ideal.each do |standard|
+          old_value = reality[standard[:key].to_sym]
+
+          case standard[:value_type].to_sym
+          when :string_or_array, :array_or_string
+            new_value = (JSON.parse(old_value) rescue false)
+            new_value = old_value.split(/, |,/) unless new_value
+          when :array
+            error_msg = [false, "参数:#{standard[:key]},参数类型不符合Json数组要求."]
+            next if old_value.is_a?(Array)
+
+            new_value = (JSON.parse(old_value) rescue (return error_msg))
+            return error_msg unless new_value.is_a?(Array)
+          when :key_value
+            error_msg = [false, "参数:#{standard[:key]},参数类型不符合Json键值对要求."]
+            next if old_value.is_a?(Hash)
+
+            new_value = (JSON.parse(old_value) rescue (return error_msg))
+            return error_msg unless new_value.is_a?(Hash)
+          when :boolean
+            new_value = [true, 'true', '1', 1].include?(old_value)
+          when :integer
+            max_value = standard[:max]
+            return [false, "参数:#{standard[:key]},参数值:#{old_value} 大于接口定义最大值:#{max_value}."] if max_value.present? && (old_value.to_i > max_value)
+            next if old_value.is_a?(Integer)
+            if old_value == '0'
+              new_value = 0
+            else
+              return [false, "参数:#{standard[:key]},参数类型不符合数字要求."] if ((old_value.to_i rescue 0) == 0)
+              new_value = old_value.to_i
+            end
+          else
+            next
+          end 
+
+          unless (old_value == new_value)
+            reality.merge!({standard[:key].to_sym => new_value})
+          end 
+        end
+
+        [true, '']
+      end 
+
+      def check_data_format(described:, reality:)
+        data_format = {}
+        if (reality[:data_format] == ['original']) && (reality[:key_type] == 'zh')
+          described[:data_structure].map do |key, value| 
+            data_format.merge!([[value, key]].to_h)
+          end
+          reality[:data_format] = data_format
+          return [true, ''] 
+        elsif (reality[:data_format] == ['original'])
+          described[:data_structure].each do |key, value| 
+            data_format.merge!([[key, key]].to_h)
+          end
+          reality[:data_format] = data_format
+          return [true, ''] 
+        end 
+        
+        data_format = reality[:data_format]
+        data_format = data_format.map(&:to_sym)
+        data_structure = {}
+        described[:data_structure].map{|key, value| data_structure.merge!([[key, key], [value.to_sym, key]].to_h)}
+        hit_items = data_structure.select{|key, value| data_format.include?(key)}
+        missed = (data_format - hit_items.keys).join(',')
+        return [false, "所提供数据格式中:#{missed},未找到对应匹配数据项"] if missed.present?
+        
+        reality[:data_format] = hit_items
+        [true, '']
+      end 
+
+  end
+end

data/config/routes.rb

@@ -1,2 +1,7 @@
 Wireway::Engine.routes.draw do
+  resources :restful, only:[] do 
+    collection do
+      post :request_api
+    end 
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wireway
 version: !ruby/object:Gem::Version
-  version: '202009261101'
+  version: '202012161641'
 platform: ruby
 authors:
 - ff4c00
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-26 00:00:00.000000000 Z
+date: 2020-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -86,12 +86,14 @@ files:
 - app/assets/javascripts/wireway/application.js
 - app/assets/stylesheets/wireway/application.css
 - app/controllers/wireway/application_controller.rb
+- app/controllers/wireway/restful_controller.rb
 - app/helpers/wireway/application_helper.rb
 - app/jobs/wireway/application_job.rb
 - app/mailers/wireway/application_mailer.rb
 - app/models/wireway/application_record.rb
 - app/models/wireway/business_logic/restful.rb
 - app/models/wireway/spark.rb
+- app/models/wireway/standard.rb
 - app/views/layouts/wireway/application.html.erb
 - config/routes.rb
 - lib/tasks/wireway_tasks.rake