wireway 0.1.0 → 202012021551

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de44bf149733f3105823eecc87f0b9b120fc9380f93bbac7182a3766b6be529b
-  data.tar.gz: 92067746481272029ba0a9e10ef473403d98bd52f6501835086187cf559210e2
+  metadata.gz: 8568460d0bef7166032661c260370d9b10cdeb8b677b9b18340b33464295e4ca
+  data.tar.gz: 1f2b0e0593783e059bcbf9f903579e28392c1cc4bc47ebd8a5870ae3bde5e58e
 SHA512:
-  metadata.gz: 1f85c0a7225e7be7463108a06269f6dd1f0108a8ab1ec1f6389aeb4c337d48c7e428f9c97baeb073cc155e2c04f316e89d8b7fa4e772cb22d24851cf47aa0f80
-  data.tar.gz: 95eb22ae3434dfa438c46e4d4cf57349875ade2dbb5786cb6f229c37abfd98112b607d69cac0f5c10b2da6979a482065c0a320446dfefb850a356f128e93ad46
+  metadata.gz: 37e37be17d98fb26481d70973b53e13d1fb487d4515d64cdb386ce2e958d8bd15b1ad796402bada5711767a3e8a034a3e1938f84478e48c47beb5ba1af4c84a2
+  data.tar.gz: fae03643a8cee2b0f3925d6db73a59e314b0c2e54f01d41a0e746b5a133ef4539f109966fce605bab0c712354950e1407bff939729e44a3d6450cae2980af198

data/README.md

@@ -1,5 +1,28 @@
+
+<!-- TOC -->
+
+- [说明](#说明)
+  - [执照](#执照)
+  - [插件作用](#插件作用)
+  - [行为准则](#行为准则)
+  - [关于C919](#关于c919)
+  - [使用示例](#使用示例)
+
+<!-- /TOC -->
+
 # 说明
 
+## 执照
+
+根据以下条款,该Gem可作为开源软件使用 [MIT License](https://opensource.org/licenses/MIT).
+
+## 插件作用
+
+该Gem主要起到反向代理作用,通过该Gem可实现C919系列插件的调用.
+
+该Gem本身并不实现任何具体功能,只是将请求转发给具体的服务接口.<br>
+因此,具体可用功能以及参数格式以各组件示例页面为准.
+
 ## 行为准则
 
 0. 集成该Gem后可实现各组件任意调用.
@@ -7,31 +30,23 @@
 0. 各组件的具体配置信息可以通过Satcom实时获取最新配置内容.
 0. 后期应允许符合某种安全机制的节点自主加入并注册允许发现.
 
-# Wireway
-Short description and motivation.
+## 关于C919
 
-## Usage
-How to use my plugin.
+C919为系列Gem组件的集合,具体组成部分及相关示例[参考](https://gitlab.com/ff4c00/space/-/tree/master/%E7%9F%A5%E8%AF%86%E4%BD%93%E7%B3%BB/%E5%BA%94%E7%94%A8%E7%A7%91%E5%AD%A6/%E8%AE%A1%E7%AE%97%E6%9C%BA%E7%A7%91%E5%AD%A6/%E8%BD%AF%E4%BB%B6%E5%B7%A5%E7%A8%8B/Rails/C919)
 
-## Installation
-Add this line to your application's Gemfile:
+## 使用示例
 
 ```ruby
-gem 'wireway'
+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%", :亏损临界点=>"无", :保收益临界点=>"无", :超额收益临界点=>"无"}]
 ```
 
-And then execute:
-```bash
-$ bundle
-```
+或无需引用Gem直接发起Post请求:
 
-Or install it yourself as:
 ```bash
-$ gem install wireway
-```
-
-## Contributing
-Contribution directions go here.
-
-## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+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

@@ -3,61 +3,105 @@ module Wireway
     module Restful
       extend self
 
-      def request_path
-        {
-          # url路径不需要动态获取,只有ip和端口是动态的,如果请求路径都不一致,不能认为是正常的节点.
-          dashboard: '/dashboard/restful/request_api',
-          satcom: '/satcom/restful/request_api',
-        }
+      $wireway_node_addresses = 404
+
+      # 后期应由专门组件对于已登记地址信息进行活跃验证,并将可用节点信息回传给Satcom
+      # 后期当某一节点调用不通过时将常量赋值为404进行更新
+      # url路径不需要动态获取,只有ip和端口是动态的,如果请求路径都不一致,不能认为是合规的节点.
+      def node_addresses
+        return $wireway_node_addresses unless $wireway_node_addresses == 404
+
+        nodes = ['123.57.155.17:3113']
+        route = '/satcom/other/c919/node_addresses.json'
+        res = get(addresses: nodes, route: route) do |result|
+          hash = JSON.parse(result[1][:body]).deep_symbolize_keys 
+          [true, hash]
+        end
+
+        return res unless res[0]
+        $wireway_node_addresses = res[1].map{|key, value| [key, value[:nodes]]}.to_h
       end 
 
       def dashboard(**args)
         params = {
           response_type: 'json',
         }.merge!(args)
-        
-        url = 'http://172.28.81.156:3111/dashboard/restful/request_api'
+        route = '/dashboard/restful/request_api'
 
-        res = post(url: url, params: params)
-        return res unless res[0]
-        
-        body = (JSON.parse(res[1][:body]) rescue (return [false, '接口返回内容JSON格式化异常']))
-        return [false, body['result']] unless body["success"]
-        
-        [true, body['html_content']]
+        post(addresses: node_addresses[: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]
+          [true, body[:html_content]]
+        end 
       end
       
       def satcom(**args)
-        params = {
-        }.merge!(args)
-
-        url = 'http://172.28.81.156:3113/satcom/restful/request_api'
+        params = {}.merge!(args)
+        route = '/satcom/restful/request_api'
 
-        res = post(url: url, params: params)
-        return res unless res[0]
-
-        body = (JSON.parse(res[1][:body]).deep_symbolize_keys rescue (return [false, '接口返回内容JSON格式化异常']))
-        return [false, body[:result]] unless body[:success]
-        
-        [true, body[:result]]        
+        post(addresses: node_addresses[: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
 
+      def wireway(**args)
+        params = {
+          local: false
+        }.merge!(args)
+        route = '/wireway/restful/request_api'
+
+        post(addresses: node_addresses[:wireway], 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 
 
-      def get(url:, params: {})
-        get_response do 
-          full_url = [url, URI.encode_www_form(params)]
+      def get(addresses:, route:, params: {})
+        result = round_robin(addresses: addresses) do |address|
+          full_url = [address+route, URI.encode_www_form(params)]
           full_url.delete_if{|item| !item.present? }
           RestClient.get(full_url.join("?"))
         end
+        return result unless (result[0] && block_given?)
+        
+        begin
+          yield result
+        rescue
+          return [false, '运行时结果处理异常', {errors: {message: $!.to_s, path: $@}}]
+        end
       end 
 
-      def post(url:, params: {})
-        get_response do 
-          RestClient.post url, params
+      def post(addresses:, route:, params: {})
+        result = round_robin(addresses: addresses) do |address|
+          RestClient.post "#{address}/#{route}", params
+        end
+        return result unless (result[0] && block_given?)
+
+        begin
+          yield result
+        rescue
+          return [false, '运行时结果处理异常', {errors: {message: $!.to_s, path: $@}}]
         end
       end 
 
       private
+        def round_robin(addresses:)
+          res = nil
+          addresses.each do |address|
+            res = get_response do
+              yield address
+            end
+            # TODO: 后期应该优化判断是服务不可以用还是传递参数问题倒是返回false
+            # 或者当一定比例节点均无法正常响应时即判定为参数问题
+            break if res[0]
+          end 
+          res
+        end
+
         def get_response
           begin
             response = yield

data/app/models/wireway/spark.rb

@@ -3,10 +3,21 @@ module Wireway
     
     # 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)
-      target = Wireway::BusinessLogic::Restful
-      return [false, '未找到相关定义方法'] unless target.respond_to?(method_name)
-      res = target.send(method_name, args)
+    # Wireway::BusinessLogic::Restful::node_addresses
+    # Wireway::Spark.wireway(platform: :satcom, api_code: :finance_fund_base_info, code: '161725')
+    def self.method_missing(method_name, local: true, **args)
+      begin
+        target = Wireway::BusinessLogic::Restful
+        return [false, '未找到相关定义方法'] unless target.respond_to?(method_name)
+        res = target.send(method_name, args)
+      rescue
+        error_msg = [false, '请求异常', {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

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

data/lib/wireway/version.rb

@@ -1,3 +1,3 @@
 module Wireway
-  VERSION = '0.1.0'
+  VERSION = Time.now.strftime("%Y%m%d%H%M")
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wireway
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: '202012021551'
 platform: ruby
 authors:
 - ff4c00
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-25 00:00:00.000000000 Z
+date: 2020-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -72,7 +72,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.9.0
-description: 用于C919各组件间相互调用,组网协助.
+description: 用于反向代理C919各组件,实现组件间组网协作.
 email:
 - ff4c00@gmail.com
 executables: []
@@ -86,6 +86,7 @@ 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