mini_program 1.4.3 → 1.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f5043ecc58767ee31b8ccd7833282a6dcea311b5e8918da20b42388df020a208
-  data.tar.gz: 1e6d9b5726bfdfc7f77a1edd6608f1a4e6557791855d2d4eada35a4e85678599
+  metadata.gz: 989d3f042ef00e840a26f6e051a1fdbf37c0a95b360debc1b7fe6684da39915b
+  data.tar.gz: 673745489d798f92a3f47be040f8b1c14c9a899755066e3243db0b314dd49be2
 SHA512:
-  metadata.gz: 6740168c1a5ecf8ce2d91785e04d529741e4653699a98b2f8aae4b7269ae7faa3d94800641098f472e643e01edb772de6fcbec28a381e3269d85587a2b3dc310
-  data.tar.gz: 94fcb924c05b597957f20685f2b8f6bb1c0c50739d866c957b0a4870cbca21c4018298bcb55dc2ef59293dd25c47258b45596a0d3d3505df0c4302d06050fcaa
+  metadata.gz: 2d70b971ecfc8428055cb22e2741ec7eb8f9358d55d6a5e23c8e04b219fec194009a04d6b95dc346261346937789d20a914da692634fb5dbb3bfc00d09a45864
+  data.tar.gz: 4bc9e581830bd4554f980fcc29823c6273b060759d59dfe71a5d1bf0388946bd0f8c5a789ecf7fc59a3badde57b82025a70b3c7d6338faaaaaa40720113cd24b

data/lib/mini_program/client.rb

@@ -23,7 +23,8 @@ module MiniProgram
       access_token = Rails.cache.read(access_token_store_key)
 
       if access_token.present? && !fresh
-        return MiniProgram::SuccessResult.new(data: { access_token: access_token },
+        return MiniProgram::ServiceResult.new(success: true,
+                                              data: { access_token: access_token },
                                               message: "获取 access token 成功",
                                               message_kind: :get_access_token_success)
       end
@@ -61,15 +62,21 @@ module MiniProgram
       result = JSON.parse(response)
 
       if result["errcode"] && result["errcode"].to_s != "0"
-        MiniProgram::Logger.error do
-          { action: :request_access_token, params: params, response: result }.to_json
+        logger.tagged "request access token" do
+          logger.error <<~ERROR
+          Get access token failed.
+          api: #{api} 
+          error: #{result}
+          ERROR
         end
 
-        MiniProgram::FailureResult.new(error: result,
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result,
                                        message: result["errmsg"],
                                        message_kind: :request_access_token_failed)
       else
-        MiniProgram::SuccessResult.new(data: { access_token: result["access_token"] },
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: { access_token: result["access_token"] },
                                        message: "请求 access token 成功",
                                        message_kind: :request_access_token_success)
       end
@@ -92,20 +99,25 @@ module MiniProgram
       result = JSON.parse(response)
 
       if result["errcode"] && result["errcode"].to_s != "0"
-        MiniProgram::Logger.error do
-          { action: :login, params: params, response: result }.to_json
-        end
+        logger.tagged "login mini program"
+        logger.error <<~ERROR
+          Get session key failed.
+          api: #{api}
+          result: #{result}
+        ERROR
 
-        MiniProgram::FailureResult.new(error: result,
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result,
                                        message: result["errmsg"],
                                        message_kind: :login_failed)
 
       else
-        MiniProgram::SuccessResult.new(data: result,
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: result,
                                        message: "小程序登录成功",
                                        message_kind: :login_success)
-
       end
+
     end
 
     # 发送订阅消息
@@ -125,22 +137,26 @@ module MiniProgram
       api = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send?access_token=#{get_token_result["access_token"]}"
       result = post(api, payload)
 
-      if result["errcode"].to_s == "0"
-        MiniProgram::Logger.info do
-          { action: :send_subscribed_message, params: payload, response: result }.to_json
+      if result["errcode"].to_s != "0"
+        logger.tagged "Subscribe Message" do
+          logger.error { "{params: #{payload}, response: #{result}}" }
         end
 
-        MiniProgram::SuccessResult.new(data: { msgid: result.data["msgid"] },
-                                       message: "发送订阅消息成功",
-                                       message_kind: :send_subscribed_message_success)
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result,
+                                       message: "发送订阅消息失败",
+                                       message_kind: :send_subscribed_message_failed)
       else
-        MiniProgram::Logger.error do
-          { action: :send_subscribed_message, params: payload, response: result }.to_json
+        logger.tagged "Subscribe Message" do
+          logger.info { "{params: #{payload}, response: #{result}}" }
         end
 
-        MiniProgram::FailureResult.new(error: result,
-                                       message: "发送订阅消息失败",
-                                       message_kind: :send_subscribed_message_failed)
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: {
+                                         msgid: result.data["msgid"]
+                                       },
+                                       message: "发送订阅消息成功",
+                                       message_kind: :send_subscribed_message_success)
       end
 
     end
@@ -165,28 +181,18 @@ module MiniProgram
         mp_template_msg: payload
       })
 
-      if result["errcode"].to_s == "0"
-        message = "发送统一服务消息成功"
-
-        MiniProgram::Logger.info do
-          { action: :send_uniform_message, message: message, params: payload, response: result }.to_json
-        end
-
-        MiniProgram::SuccessResult.new(data: result,
-                                       message: message,
-                                       message_kind: :send_uniform_message_success)
-
-      else
-        message = "发送统一服务消息失败"
-
-        MiniProgram::Logger.error do
-          { action: :send_uniform_message, message: message, params: payload, response: result }.to_json
-        end
-
-        MiniProgram::FailureResult.new(error: result["errmsg"],
-                                       message: message,
+      if result["errcode"].to_s != "0"
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result,
+                                       message: "发送统一服务消息失败",
                                        message_kind: :send_uniform_message_failed)
+      else
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: result,
+                                       message: "发送统一服务消息成功",
+                                       message_kind: :send_uniform_message_success)
       end
+
     end
 
     # 获取用户手机号
@@ -201,24 +207,19 @@ module MiniProgram
 
       phone_num = JSON.parse(data)["phoneNumber"]
 
-      MiniProgram::SuccessResult.new(
+      MiniProgram::ServiceResult.new(
+        success: true,
         message: "解密手机号成功",
         message_kind: :decrypt_phone_number_success,
         data: {
           openid: openid,
           phone_num: phone_num
-        }
-      )
+        })
     rescue OpenSSL::Cipher::CipherError, ArgumentError => e
-      message = "解密手机号失败"
-
-      MiniProgram::Logger.error do
-        { action: "decrypt_phone_num", message: message, error: e }.to_json
-      end
-
-      MiniProgram::FailureResult.new(
-        message: message,
-        message_kind: :decrypt_phone_number_failed,
+      MiniProgram::ServiceResult.new(
+        success: false,
+        message: "解密手机号失败",
+        message_kind: :decrypt_phone_data_failed,
         error: e
       )
     end
@@ -244,25 +245,18 @@ module MiniProgram
       end
 
       api = "https://api.weixin.qq.com/wxa/getwxacodeunlimit?access_token=#{get_token_result["access_token"]}"
-
       params = { scene:, page:, width:, check_path:, env_version: }
 
       result = post(api, params)
 
       if result["errcode"]
-        MiniProgram::Logger.error do
-          { action: 'generate_code', params: params, response: result }.to_json
-        end
-
+        logger.error { "{ action: 'generate qrcode', params: #{params}, response: #{result}}" }
         MiniProgram::ServiceResult.new(success: false,
                                        error: result,
                                        message: "获取二维码失败",
                                        message_kind: :get_unlimited_qrcode_failed)
       else
-        MiniProgram::Logger.info do
-          { action: 'generate_code', params: params, response: result }.to_json
-        end
-
+        logger.info { "{ action: 'generate qrcode',  params: #{params}, response: #{result} }" }
         MiniProgram::ServiceResult.new(success: true,
                                        data: { image: result },
                                        message: "获取二维码成功",
@@ -310,9 +304,17 @@ module MiniProgram
       aes.update(Base64::decode64(encrypted_data)) + aes.final
     end
 
+    def logger
+      @logger ||= MiniProgram::RLogger.make("mini_program")
+    end
+
     def access_token_store_key
       @access_token_store_key ||= "mp-#{appid}-access-token"
     end
 
+    def msg_logger
+      @msg_logger ||= MiniProgram::RLogger.make("wx_msg")
+    end
+
   end
 end

data/lib/mini_program/r_logger.rb

@@ -0,0 +1,34 @@
+module MiniProgram
+  class RLogger
+    def initialize
+      raise Exceptions::InitializeDenied.new("please use 'RLogger.make' instead of 'RLogger.new'")
+    end
+
+    class << self
+      def make(given_filename)
+        filename = log_filename(given_filename)
+
+        # 如果已经存在日志对象，则返回已有的日志对象
+        logger = Logger.new(filename)
+        ActiveSupport::TaggedLogging.new(logger)
+      end
+
+      def log_filename(given_filename)
+        return STDOUT if ENV["RAILS_LOG_TO_STDOUT"].present?
+
+        if given_filename.class.in? [String, Symbol]
+          unless given_filename.end_with? ".log"
+            given_filename = "#{given_filename}.log"
+          end
+
+          Rails.root.join("log/#{given_filename}")
+        elsif given_filename.respond_to? :to_path
+          given_filename.to_path
+        else
+          raise Exception::UnsupportedParamType.new("\"log filename parameter must be a String type or a Symbol\"")
+        end
+      end
+    end
+
+  end
+end

data/lib/mini_program/service_result.rb

@@ -10,11 +10,11 @@ module MiniProgram
     delegate :[], :[]=, to: :data
 
     def initialize(success: false,
-                   data: {},
                    error: nil,
                    message: nil,
                    message_type: nil,
-                   message_kind: nil)
+                   message_kind: nil,
+                   data: {})
 
       self.success = success
       self.data = (data.presence || {}).with_indifferent_access
@@ -40,32 +40,24 @@ module MiniProgram
       self
     end
 
-    def message_type
-      if @message_type.present?
-        @message_type.to_sym
+    def get_message_type
+      if message_type.present?
+        message_type.to_sym
       elsif success?
-        :info
+        :notice
       else
         :error
       end
     end
 
-    def message_kind_prefix
-      "mini_program_"
-    end
-
-    def message_kind
-      "#{message_kind_prefix}#{@message_kind}"
-    end
-
     def as_json(options = nil)
       {
-        success: success,
-        data: data,
-        message: message,
-        message_type: message_type,
-        message_kind: message_kind,
-        error: error,
+        success: ,
+        data: ,
+        message:,
+        message_type: get_message_type,
+        message_kind:,
+        error:,
       }
     end
   end

data/lib/mini_program/version.rb

@@ -1,3 +1,3 @@
 module MiniProgram
-  VERSION = '1.4.3'
+  VERSION = '1.4.4'
 end

data/lib/mini_program.rb

@@ -4,10 +4,8 @@ require "mini_program/client"
 require "mini_program/msg"
 require "mini_program/user"
 require "application_controller_ext"
+require "mini_program/r_logger"
 require "mini_program/service_result"
-require "mini_program/success_result"
-require "mini_program/failure_result"
-require "mini_program/logger"
 require "mocha"
 
 module MiniProgram

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_program
 version: !ruby/object:Gem::Version
-  version: 1.4.3
+  version: 1.4.4
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-17 00:00:00.000000000 Z
+date: 2022-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -74,12 +74,10 @@ files:
 - lib/mini_program.rb
 - lib/mini_program/client.rb
 - lib/mini_program/engine.rb
-- lib/mini_program/failure_result.rb
-- lib/mini_program/logger.rb
 - lib/mini_program/msg.rb
+- lib/mini_program/r_logger.rb
 - lib/mini_program/request_result.rb
 - lib/mini_program/service_result.rb
-- lib/mini_program/success_result.rb
 - lib/mini_program/user.rb
 - lib/mini_program/version.rb
 - lib/tasks/mini_program_tasks.rake
@@ -98,14 +96,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.13
 signing_key:
 specification_version: 4
 summary: a engine for develop mini program

data/lib/mini_program/failure_result.rb

@@ -1,11 +0,0 @@
-
-class MiniProgram::FailureResult < MiniProgram::ServiceResult
-  def initialize(data: {}, error: nil, message: nil, message_type: nil, message_kind: nil)
-    super(success: false,
-          data: data,
-          error: error,
-          message: message,
-          message_type: message_type,
-          message_kind: message_kind)
-  end
-end

data/lib/mini_program/logger.rb

@@ -1,18 +0,0 @@
-class MiniProgram::Logger
-
-  def self.tags
-    ["MiniProgram"]
-  end
-
-  %w{ info warn error fatal }.each do |level|
-    define_singleton_method level do |content = "", &block|
-      Rails.logger.tagged *tags do
-        if block.present?
-          Rails.logger.send(level, &block)
-        else
-          Rails.logger.send(level, content)
-        end
-      end
-    end
-  end
-end

data/lib/mini_program/success_result.rb

@@ -1,11 +0,0 @@
-
-class MiniProgram::SuccessResult < MiniProgram::ServiceResult
-  def initialize(data: {}, error: nil, message: nil, message_type: nil, message_kind: nil)
-    super(success: true,
-          data: data,
-          error: error,
-          message: message,
-          message_type: message_type,
-          message_kind: message_kind)
-  end
-end