rails_com 1.2.9 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 658f3acb70f80511ac3b2a823edc7ce07de24859407dbfc3dd9ca3de7628a1bd
-  data.tar.gz: 55366b92f42d626219b3f9549ebc8e0c21d7c955e1bbe9ed5ec66815932fb45e
+  metadata.gz: d6d150f8789dbd3a5cab12380e22eff676d21ba37859e984c22ac62d2e89291b
+  data.tar.gz: 8b203dc1deef8d462bcf25f92ec6f95b9b75be900582e6847565b28afd403b53
 SHA512:
-  metadata.gz: 72e837a0d1b390647540b9e56050b00de4edecd682a70b04f53d4da31a9cde9d305e5abf015e96174cce93335f0a5e2d21f081d00de11d7f75f5fe7cc08d7191
-  data.tar.gz: 585d98e624a98957a513cc595bfc6824465dd9d55505a8cb5ae00587b536149931d72f15632523a6fdcfe70545e62c7f0b78c417f4f6dac7b327490cec5c3de3
+  metadata.gz: 642d2e90a6dc4559a3ede4964db271d2e40ed1c4bf25b5413e7b3b0b1c8a3290a2bfc34479247bec417ef1626a60a5ec5210a628d5b48be164f2dc643aea54d5
+  data.tar.gz: 752d1b1a8501f903251bbc14bea7a12e67eae50dff2721b56efaa824f9c9503e959470fdd069d726a12c2520f15c61d6ab3fafb018806a44421e191acadaae1e

data/LICENSE

@@ -1,165 +1,20 @@
-                   GNU LESSER GENERAL PUBLIC LICENSE
-                       Version 3, 29 June 2007
-
- Copyright (C) 2019 Mingyuan Qin.
- Everyone is permitted to copy and distribute verbatim copies
- of this license document, but changing it is not allowed.
-
-
-  This version of the GNU Lesser General Public License incorporates
-the terms and conditions of version 3 of the GNU General Public
-License, supplemented by the additional permissions listed below.
-
-  0. Additional Definitions.
-
-  As used herein, "this License" refers to version 3 of the GNU Lesser
-General Public License, and the "GNU GPL" refers to version 3 of the GNU
-General Public License.
-
-  "The Library" refers to a covered work governed by this License,
-other than an Application or a Combined Work as defined below.
-
-  An "Application" is any work that makes use of an interface provided
-by the Library, but which is not otherwise based on the Library.
-Defining a subclass of a class defined by the Library is deemed a mode
-of using an interface provided by the Library.
-
-  A "Combined Work" is a work produced by combining or linking an
-Application with the Library.  The particular version of the Library
-with which the Combined Work was made is also called the "Linked
-Version".
-
-  The "Minimal Corresponding Source" for a Combined Work means the
-Corresponding Source for the Combined Work, excluding any source code
-for portions of the Combined Work that, considered in isolation, are
-based on the Application, and not on the Linked Version.
-
-  The "Corresponding Application Code" for a Combined Work means the
-object code and/or source code for the Application, including any data
-and utility programs needed for reproducing the Combined Work from the
-Application, but excluding the System Libraries of the Combined Work.
-
-  1. Exception to Section 3 of the GNU GPL.
-
-  You may convey a covered work under sections 3 and 4 of this License
-without being bound by section 3 of the GNU GPL.
-
-  2. Conveying Modified Versions.
-
-  If you modify a copy of the Library, and, in your modifications, a
-facility refers to a function or data to be supplied by an Application
-that uses the facility (other than as an argument passed when the
-facility is invoked), then you may convey a copy of the modified
-version:
-
-   a) under this License, provided that you make a good faith effort to
-   ensure that, in the event an Application does not supply the
-   function or data, the facility still operates, and performs
-   whatever part of its purpose remains meaningful, or
-
-   b) under the GNU GPL, with none of the additional permissions of
-   this License applicable to that copy.
-
-  3. Object Code Incorporating Material from Library Header Files.
-
-  The object code form of an Application may incorporate material from
-a header file that is part of the Library.  You may convey such object
-code under terms of your choice, provided that, if the incorporated
-material is not limited to numerical parameters, data structure
-layouts and accessors, or small macros, inline functions and templates
-(ten or fewer lines in length), you do both of the following:
-
-   a) Give prominent notice with each copy of the object code that the
-   Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the object code with a copy of the GNU GPL and this license
-   document.
-
-  4. Combined Works.
-
-  You may convey a Combined Work under terms of your choice that,
-taken together, effectively do not restrict modification of the
-portions of the Library contained in the Combined Work and reverse
-engineering for debugging such modifications, if you also do each of
-the following:
-
-   a) Give prominent notice with each copy of the Combined Work that
-   the Library is used in it and that the Library and its use are
-   covered by this License.
-
-   b) Accompany the Combined Work with a copy of the GNU GPL and this license
-   document.
-
-   c) For a Combined Work that displays copyright notices during
-   execution, include the copyright notice for the Library among
-   these notices, as well as a reference directing the user to the
-   copies of the GNU GPL and this license document.
-
-   d) Do one of the following:
-
-       0) Convey the Minimal Corresponding Source under the terms of this
-       License, and the Corresponding Application Code in a form
-       suitable for, and under terms that permit, the user to
-       recombine or relink the Application with a modified version of
-       the Linked Version to produce a modified Combined Work, in the
-       manner specified by section 6 of the GNU GPL for conveying
-       Corresponding Source.
-
-       1) Use a suitable shared library mechanism for linking with the
-       Library.  A suitable mechanism is one that (a) uses at run time
-       a copy of the Library already present on the user's computer
-       system, and (b) will operate properly with a modified version
-       of the Library that is interface-compatible with the Linked
-       Version.
-
-   e) Provide Installation Information, but only if you would otherwise
-   be required to provide such information under section 6 of the
-   GNU GPL, and only to the extent that such information is
-   necessary to install and execute a modified version of the
-   Combined Work produced by recombining or relinking the
-   Application with a modified version of the Linked Version. (If
-   you use option 4d0, the Installation Information must accompany
-   the Minimal Corresponding Source and Corresponding Application
-   Code. If you use option 4d1, you must provide the Installation
-   Information in the manner specified by section 6 of the GNU GPL
-   for conveying Corresponding Source.)
-
-  5. Combined Libraries.
-
-  You may place library facilities that are a work based on the
-Library side by side in a single library together with other library
-facilities that are not Applications and are not covered by this
-License, and convey such a combined library under terms of your
-choice, if you do both of the following:
-
-   a) Accompany the combined library with a copy of the same work based
-   on the Library, uncombined with any other library facilities,
-   conveyed under the terms of this License.
-
-   b) Give prominent notice with the combined library that part of it
-   is a work based on the Library, and explaining where to find the
-   accompanying uncombined form of the same work.
-
-  6. Revised Versions of the GNU Lesser General Public License.
-
-  The Free Software Foundation may publish revised and/or new versions
-of the GNU Lesser General Public License from time to time. Such new
-versions will be similar in spirit to the present version, but may
-differ in detail to address new problems or concerns.
-
-  Each version is given a distinguishing version number. If the
-Library as you received it specifies that a certain numbered version
-of the GNU Lesser General Public License "or any later version"
-applies to it, you have the option of following the terms and
-conditions either of that published version or of any later version
-published by the Free Software Foundation. If the Library as you
-received it does not specify a version number of the GNU Lesser
-General Public License, you may choose any version of the GNU Lesser
-General Public License ever published by the Free Software Foundation.
-
-  If the Library as you received it specifies that a proxy can decide
-whether future versions of the GNU Lesser General Public License shall
-apply, that proxy's public statement of acceptance of any version is
-permanent authorization for you to choose that version for the
-Library.
+Copyright (c) 2017-Present Mingyuan Qin <mingyuan0715@foxmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,24 +1,43 @@
 # RailsCom
-Rails 通用基础库
-
-## 功能
-* examples: puma, configs etc.
-* rails and ruby core extension;
-* methods deal rails model/controller/routes etc.
-* some helpers, for generator uuid based on time and more;
-
-## Module
-* Ruby core extension
-* Rails meta information: Controller/Model/Routes
-* Rails core extension
-  - ActiveStorage sync with url
-  - ActiveStorage copy to mirror
-* Utils
-  - UidHelper
-  - TimeHelper
-  - Jobber
-  - IpHelper
-  
+
+[![测试](https://github.com/work-design/rails_com/actions/workflows/test.yml/badge.svg)](https://github.com/work-design/rails_com/actions/workflows/test.yml)
+[![Docker构建](https://github.com/work-design/rails_com/actions/workflows/cd.yml/badge.svg)](https://github.com/work-design/rails_com/actions/workflows/cd.yml)
+[![Gem](https://github.com/work-design/rails_com/actions/workflows/gempush.yml/badge.svg)](https://github.com/work-design/rails_com/actions/workflows/gempush.yml)
+
+Rails 通用基础库，对 Rails 的各个组件进行了扩展。
+
+## 功能模块
+* Rails 核心类扩展
+  * ActiveStorage：[链接](lib/rails_com/active_storage) 
+    * 通过 url 同步文件；
+    * 将文件复制到镜像服务器；
+* 支持通过 ACME 自动申请及更新 SSL 证书
+* 记录Rails应用报错日志到数据库中，包含出错时的各种详尽信息
+  * 支持机器人发送通知
+    * 企业微信机器人：`WorkWechatBot`
+    * 飞书机器人：`FeishuBot`
+* 日志功能扩展：
+  * 在开发环境中（Loglevel 为 debug），打印 request headers 信息；
+  * 注重性能：使用订阅通知机制实现，而非 `rescue_from` 或者 `Rack middleware`;
+  * 在 err model 中记录了详尽的 debug 上下文信息，包含：cookies, session, headers, params，当前用户 等;
+```
+Started GET "/admin/log_csps" for 127.0.0.1 at 2018-11-06 15:11:45 +0800
+Processing by Log::Admin::LogCspsController#index as HTML
+  Headers: {"ACCEPT"=>"text/html, application/xhtml+xml", "ACCEPT_ENCODING"=>"gzip, deflate, br", "ACCEPT_LANGUAGE"=>"en,zh-CN;q=0.9,zh;q=0.8,en-US;q=0.7,zh-TW;q=0.6", "CONNECTION"=>"keep-alive", "HOST"=>"localhost:3000", "IF_NONE_MATCH"=>"W/\"0b91528b7e1207b8a0c59f74361bbb16\"", "REFERER"=>"http://localhost:3000/admin/log_mailers", "TURBOLINKS_CSP_NONCE"=>"usxcEjOGjTjPfcGLmodktA==", "TURBOLINKS_REFERRER"=>"http://localhost:3000/admin/log_mailers", "USER_AGENT"=>"Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_1) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/70.0.3538.77 Safari/537.36", "UTC_OFFSET"=>"-480", "VERSION"=>"HTTP/1.1"}
+```
+* 为内容安全策略提供 report url
+
+### 工具类
+  * UidHelper：基于时间生成 UUID，精确到微秒
+  * TimeHelper
+  * Jobber
+  * IpHelper
+
+## 例子 
+[examples](examples)
+* puma
+* configs
+
 ### Locals support
 
 ```erb
@@ -26,5 +45,9 @@ Rails 通用基础库
 ```
 
 
-## License
-The gem is available as open source under the terms of the [LGPL License](https://opensource.org/licenses/LGPL-3.0).
+
+## 注意
+
+
+## 版权
+遵循 [MIT](https://opensource.org/licenses/MIT) 协议

data/Rakefile

@@ -1,5 +1,6 @@
+# frozen_string_literal: true
+
 require 'bundler/setup'
-require 'pry'
 require 'sdoc'
 require 'rdoc/task'
 

data/app/apis/ali_dns.rb

@@ -0,0 +1,66 @@
+begin
+  require 'aliyunsdkcore'
+rescue LoadError
+end
+
+module AliDns
+  extend self
+
+  def client
+    @client = RPCClient.new(
+      endpoint: 'https://alidns.cn-hangzhou.aliyuncs.com',
+      api_version: '2015-01-09',
+      access_key_id: SETTING.aliyun[:key],
+      access_key_secret: SETTING.aliyun[:secret]
+    )
+  end
+
+  def records(domain)
+    body = {
+      action: 'DescribeDomainRecords'
+    }
+    body.merge! params: {
+      DomainName: domain
+    }
+    body.merge! opts: {
+      method: 'POST',
+      timeout: 15000
+    }
+    client.request(**body)
+  end
+
+  def check_record(domain, value)
+    result = records(domain).dig('DomainRecords', 'Record')
+    if result
+      result.find { |i| i['Type'] == 'TXT' && i['Value'] == value }
+    end
+  end
+
+  def add_acme_record(domain, value)
+    domain_arr = domain.split('.')
+    root_domain = domain_arr[-2..-1].join('.')
+    rr = ['_acme-challenge', *domain_arr[0...-2]].join('.')
+
+    body = {
+      action: 'AddDomainRecord'
+    }
+    body.merge! params: {
+      DomainName: root_domain,
+      Type: 'TXT',
+      RR: rr,
+      value: value
+    }
+    body.merge! opts: {
+      method: 'POST',
+      timeout: 15000
+    }
+
+    begin
+      response = client.request(**body)
+    rescue StandardError => e
+    ensure
+      records(root_domain)
+    end
+  end
+
+end

data/app/channels/com/session_channel.rb

@@ -0,0 +1,16 @@
+module Com
+  class SessionChannel < ApplicationCable::Channel
+
+    def subscribed
+      if verified_receiver.is_a?(Auth::AuthorizedToken)
+        stream_from "com:session:#{verified_receiver.identity}"
+      else
+        stream_from "com:session:#{verified_receiver}"
+      end
+    end
+
+    def unsubscribed
+    end
+
+  end
+end

data/app/channels/rails_com/connection.rb

@@ -0,0 +1,31 @@
+module RailsCom::Connection
+  extend ActiveSupport::Concern
+
+  included do
+    identified_by :verified_receiver
+  end
+
+  def connect
+    self.verified_receiver = find_verified_receiver
+  end
+
+  protected
+  def find_verified_receiver
+    if session && session['auth_token']
+      Rails.logger.silence do
+        Auth::AuthorizedToken.find_by token: session['auth_token']
+      end
+    else
+      session['session_id']
+    end
+  rescue
+    logger.error 'An unauthorized connection attempt was rejected'
+    nil
+  end
+
+  def session
+    session_key = Rails.configuration.session_options[:key]
+    cookies.encrypted[session_key]
+  end
+
+end

data/app/controllers/admin_controller.rb

@@ -0,0 +1,4 @@
+class AdminController < ApplicationController
+  include Com::Controller::Admin
+
+end

data/app/controllers/application_controller.rb

@@ -0,0 +1,7 @@
+class ApplicationController < ActionController::Base
+  include RailsCom::Application
+  include Auth::Controller::Application if defined? RailsAuth
+
+  protect_from_forgery with: :exception, unless: -> { json_format? }
+
+end

data/app/controllers/base_controller.rb

@@ -0,0 +1,2 @@
+class BaseController < ApplicationController
+end

data/app/controllers/board/base_controller.rb

@@ -0,0 +1,3 @@
+class Board::BaseController < BoardController
+
+end unless defined? Board::BaseController

data/app/controllers/board/home_controller.rb

@@ -0,0 +1,6 @@
+class Board::HomeController < Board::BaseController
+
+  def index
+  end
+
+end

data/app/controllers/board_controller.rb

@@ -0,0 +1,3 @@
+class BoardController < ApplicationController
+
+end

data/app/controllers/com/audios_controller.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+module Com
+  class AudiosController < BaseController
+    before_action :set_video, only: [:show, :transfer]
+    before_action do
+      ActiveStorage::Current.host = request.base_url
+    end
+
+    def show
+      expires_in ActiveStorage.service_urls_expire_in
+    end
+
+    def transfer
+      attached = @attachment.transfer_faststart
+      @video = attached.blob
+
+      flash[:notice] = 'well done!'
+      render 'show'
+    end
+
+    private
+    def set_video
+      @audio = ActiveStorage::Blob.find(params[:id])
+    end
+
+  end
+end

data/app/controllers/com/base_controller.rb

@@ -0,0 +1,4 @@
+module Com
+  class BaseController < PanelController
+  end
+end

data/app/controllers/com/common_controller.rb

@@ -0,0 +1,69 @@
+module Com
+  class CommonController < BaseController
+    if respond_to? :verify_authenticity_token
+      skip_before_action :verify_authenticity_token, only: [:deploy]
+    end
+
+    def info
+      q_params = {}
+      q_params.merge! params.permit(:platform)
+
+      @infos = Info.default_where(q_params)
+    end
+
+    def cancel
+    end
+
+    def cache_list
+      render json: CacheList.all.as_json(only: [:path, :key], methods: [:etag])
+    end
+
+    def enum_list
+      r = I18n.backend.translations[I18n.locale][:activerecord][:enum]
+
+      render json: { locale: I18n.locale, values: r }
+    end
+
+    def qrcode
+      options = qrcode_params.to_h.symbolize_keys
+      buffer = QrcodeHelper.code_png(params[:url], **options)
+
+      send_data buffer, filename: 'cert_file.png', disposition: 'inline', type: 'image/png'
+    end
+
+    def test_raise
+      raise 'error from test raise'
+    end
+
+    # commit message end with '@deploy'
+    def deploy
+      require 'deploy'
+      digest = request.headers['X-Hub-Signature'].to_s
+      digest.sub!('sha1=', '')
+      payload = JSON.parse(params[:payload])
+
+      if digest == Deploy.github_hmac(request.body.read) && payload.dig('head_commit', 'message').to_s.end_with?('@deploy')
+        result = Deploy.exec_cmds Rails.env.to_s
+      else
+        result = ''
+        logger.debug "==========> Deploy failed"
+      end
+
+      render plain: result
+    end
+
+    private
+    def qrcode_params
+      params.permit(
+        :resize_gte_to,
+        :resize_exactly_to,
+        :fill,
+        :color,
+        :size,
+        :border_modules,
+        :module_px_size
+      )
+    end
+
+  end
+end

data/app/controllers/com/controller/admin.rb

@@ -0,0 +1,114 @@
+module Com
+  module Controller::Admin
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :permit_keys, :model_klass, :model_name
+    end
+
+    def index
+      instance_variable_set "@#{controller_name.pluralize}", model_klass.page(params[:page])
+    end
+
+    def new
+      model = model_new_object
+      render :new, locals: { model: model }
+    end
+
+    def create
+      model = model_new_object
+
+      if model.save
+        render :create, status: :created
+      else
+        render :new, locals: { model: model }, status: :unprocessable_entity
+      end
+    end
+
+    def update
+      model = model_object
+      model.assign_attributes(model_params)
+
+      if model.save
+        render :update
+      else
+        render :edit, locals: { model: model }, status: :unprocessable_entity
+      end
+    end
+
+    def show
+      model = model_object
+      render :show, locals: { model: model }
+    end
+
+    def edit
+      model = model_object
+      render :edit, locals: { model: model }
+    end
+
+    def move_higher
+      model = model_object
+      model.move_higher
+    end
+
+    def move_lower
+      model = model_object
+      model.move_lower
+    end
+
+    def destroy
+      model = model_object
+      model.destroy
+    end
+
+    private
+    def model_klass
+      self.class.root_module.const_get(controller_name.classify)
+    end
+
+    def model_object
+      if instance_variable_defined? "@#{model_name}"
+        instance_variable_get "@#{model_name}"
+      elsif params[:id]
+        instance_variable_set "@#{model_name}", model_klass.find(params[:id])
+      end
+    end
+
+    def model_new_object
+      if instance_variable_defined? "@#{model_name}"
+        instance_variable_get "@#{model_name}"
+      else
+        instance_variable_set("@#{model_name}", model_klass.new(model_params))
+      end
+    end
+
+    def pluralize_model_name
+      controller_name.pluralize
+    end
+
+    def model_name
+      controller_name.singularize
+    end
+
+    def model_params
+      if self.class.private_method_defined?("#{model_name}_params") || self.class.method_defined?("#{model_name}_params")
+        send "#{model_name}_params"
+      else
+        model = model_object || model_klass.new
+        p = params.fetch(model_name, {}).permit(*permit_keys)
+        p.merge! default_form_params if model.respond_to?(:organ_id)
+        p
+      end
+    end
+
+    # todo, 如果 super controller 定义了同名，则将参数进行 & 操作。
+    def permit_keys
+      if self.class.private_method_defined?("#{model_name}_permit_params") || self.class.method_defined?("#{model_name}_permit_params")
+        model_klass.com_column_names & send("#{model_name}_permit_params").map(&:to_s)
+      else
+        model_klass.com_column_names
+      end
+    end
+
+  end
+end

data/app/controllers/com/controller/err_handler.rb

@@ -0,0 +1,13 @@
+module Com
+  module Controller::ErrHandler
+    extend ActiveSupport::Concern
+
+    included do
+      rescue_from ActiveRecord::RecordInvalid, with: :record_not_save
+    end
+
+    def record_not_save(exception)
+      render 'err', locals: { target: exception.record }, status: :unprocessable_entity
+    end
+  end
+end