mini_program 1.3.3 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ed845cf55dd393171e8738f4c44e0d2073a58b90937be6f375b462932a8ff212
-  data.tar.gz: c7eddc9f26d699721525bf239461e8bfd8646bd4bde246cb24399a5674bdeb37
+  metadata.gz: 819a9d88d29ed42dffc439ba5686b14c9afad196d9bc8f6068d371ad4d0db22c
+  data.tar.gz: 401802387b27e867b19d97382bf4bac8b18db259d873c1470b925177efe76ed3
 SHA512:
-  metadata.gz: bc14988b0f3ecd95652264929efce493845b00e4ff2608094ad623cbce53b5004d649c31cd326a5dcf694935420e1d04cfb52ce5b9da21b684d0a887fc60645a
-  data.tar.gz: afc0ab11bfc0b952c40431499d6b6b79ef473258b1ac92126bd3905cc306cf415e125e8450e12333e86deedc83f605e4cc77b7623472788b5aa6e350961e5a49
+  metadata.gz: f27016f2662ce3b21b435b27db456aa746b36044e3dc06a6fca2f8f140e9c6e138080b0df7a5dd8e9d39c44e59e365890e828871d421b3985e678226e6651ef9
+  data.tar.gz: 847a8165ed9d30d383e5e97de5792d612d0cab70410d16debf6c945b42c199aa1694650a92129aaf10a2cdb534fc2715de2d5bbb031eb9a6fa0bddeccaca97ac

data/lib/mini_program/client.rb

@@ -23,8 +23,7 @@ module MiniProgram
       access_token = Rails.cache.read(access_token_store_key)
 
       if access_token.present? && !fresh
-        return MiniProgram::ServiceResult.new(success: true,
-                                              data: { access_token: access_token },
+        return MiniProgram::SuccessResult.new(data: { access_token: access_token },
                                               message: "获取 access token 成功",
                                               message_kind: :get_access_token_success)
       end
@@ -62,21 +61,15 @@ module MiniProgram
       result = JSON.parse(response)
 
       if result["errcode"] && result["errcode"].to_s != "0"
-        logger.tagged "request access token" do
-          logger.error <<~ERROR
-          Get access token failed.
-          api: #{api} 
-          error: #{result}
-          ERROR
+        MiniProgram::Logger.error do
+          { action: :request_access_token, params: params, response: result }.to_json
         end
 
-        MiniProgram::ServiceResult.new(success: false,
-                                       error: result,
+        MiniProgram::FailureResult.new(error: result,
                                        message: result["errmsg"],
                                        message_kind: :request_access_token_failed)
       else
-        MiniProgram::ServiceResult.new(success: true,
-                                       data: { access_token: result["access_token"] },
+        MiniProgram::SuccessResult.new(data: { access_token: result["access_token"] },
                                        message: "请求 access token 成功",
                                        message_kind: :request_access_token_success)
       end
@@ -99,25 +92,20 @@ module MiniProgram
       result = JSON.parse(response)
 
       if result["errcode"] && result["errcode"].to_s != "0"
-        logger.tagged "login mini program"
-        logger.error <<~ERROR
-          Get session key failed.
-          api: #{api}
-          result: #{result}
-        ERROR
+        MiniProgram::Logger.error do
+          { action: :login, params: params, response: result }.to_json
+        end
 
-        MiniProgram::ServiceResult.new(success: false,
-                                       error: result,
+        MiniProgram::FailureResult.new(error: result,
                                        message: result["errmsg"],
                                        message_kind: :login_failed)
 
       else
-        MiniProgram::ServiceResult.new(success: true,
-                                       data: result,
+        MiniProgram::SuccessResult.new(data: result,
                                        message: "小程序登录成功",
                                        message_kind: :login_success)
-      end
 
+      end
     end
 
     # 发送订阅消息
@@ -137,26 +125,22 @@ 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"
-        logger.tagged "Subscribe Message" do
-          logger.error { "{params: #{payload}, response: #{result}}" }
+      if result["errcode"].to_s == "0"
+        MiniProgram::Logger.info do
+          { action: :send_subscribed_message, params: payload, response: result }.to_json
         end
 
-        MiniProgram::ServiceResult.new(success: false,
-                                       error: result,
-                                       message: "发送订阅消息失败",
-                                       message_kind: :send_subscribed_message_failed)
+        MiniProgram::SuccessResult.new(data: { msgid: result.data["msgid"] },
+                                       message: "发送订阅消息成功",
+                                       message_kind: :send_subscribed_message_success)
       else
-        logger.tagged "Subscribe Message" do
-          logger.info { "{params: #{payload}, response: #{result}}" }
+        MiniProgram::Logger.error do
+          { action: :send_subscribed_message, params: payload, response: result }.to_json
         end
 
-        MiniProgram::ServiceResult.new(success: true,
-                                       data: {
-                                         msgid: result.data["msgid"]
-                                       },
-                                       message: "发送订阅消息成功",
-                                       message_kind: :send_subscribed_message_success)
+        MiniProgram::FailureResult.new(error: result,
+                                       message: "发送订阅消息失败",
+                                       message_kind: :send_subscribed_message_failed)
       end
 
     end
@@ -181,23 +165,28 @@ module MiniProgram
         mp_template_msg: payload
       })
 
-      if result["errcode"].to_s != "0"
-        logger.tagged "uniform message" do
-          logger.error { "{params: #{payload}, response: #{result}}" }
+      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::ServiceResult.new(success: false,
-                                       error: result,
-                                       message: "发送统一服务消息失败",
-                                       message_kind: :send_uniform_message_failed)
-      else
-        msg_logger.info { "{params: #{payload}, response: #{result}}" }
-        MiniProgram::ServiceResult.new(success: true,
-                                       data: result,
-                                       message: "发送统一服务消息成功",
+        MiniProgram::SuccessResult.new(data: result,
+                                       message: message,
                                        message_kind: :send_uniform_message_success)
-      end
 
+      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,
+                                       message_kind: :send_uniform_message_failed)
+      end
     end
 
     # 获取用户手机号
@@ -212,19 +201,24 @@ module MiniProgram
 
       phone_num = JSON.parse(data)["phoneNumber"]
 
-      MiniProgram::ServiceResult.new(
-        success: true,
+      MiniProgram::SuccessResult.new(
         message: "解密手机号成功",
         message_kind: :decrypt_phone_number_success,
         data: {
           openid: openid,
           phone_num: phone_num
-        })
+        }
+      )
     rescue OpenSSL::Cipher::CipherError, ArgumentError => e
-      MiniProgram::ServiceResult.new(
-        success: false,
-        message: "解密手机号失败",
-        message_kind: :decrypt_phone_data_failed,
+      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,
         error: e
       )
     end
@@ -256,13 +250,19 @@ module MiniProgram
       result = post(api, params)
 
       if result["errcode"]
-        logger.error { "{ action: 'generate qrcode', params: #{params}, response: #{result}}" }
+        MiniProgram::Logger.error do
+          { action: 'generate_code', params: params, response: result }.to_json
+        end
+
         MiniProgram::ServiceResult.new(success: false,
                                        error: result,
                                        message: "获取二维码失败",
                                        message_kind: :get_unlimited_qrcode_failed)
       else
-        logger.info { "{ action: 'generate qrcode',  params: #{params}, response: #{result} }" }
+        MiniProgram::Logger.info do
+          { action: 'generate_code', params: params, response: result }.to_json
+        end
+
         MiniProgram::ServiceResult.new(success: true,
                                        data: { image: result },
                                        message: "获取二维码成功",
@@ -310,17 +310,9 @@ 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/failure_result.rb

@@ -0,0 +1,11 @@
+
+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

@@ -0,0 +1,18 @@
+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/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,
-                   data: {})
+                   message_kind: nil)
 
       self.success = success
       self.data = (data.presence || {}).with_indifferent_access
@@ -40,9 +40,9 @@ module MiniProgram
       self
     end
 
-    def get_message_type
-      if message_type.present?
-        message_type.to_sym
+    def message_type
+      if @message_type.present?
+        @message_type.to_sym
       elsif success?
         :notice
       else
@@ -50,14 +50,22 @@ module MiniProgram
       end
     end
 
+    def message_kind_prefix
+      "mini_program_"
+    end
+
+    def message_kind
+      "#{message_kind_prefix}#{@message_kind}"
+    end
+
     def as_json(options = nil)
       {
-        success:,
-        data:,
-        message:,
-        message_type: get_message_type,
-        message_kind:,
-        error:,
+        success: success,
+        data: data,
+        message: message,
+        message_type: message_type,
+        message_kind: message_kind,
+        error: error,
       }
     end
   end

data/lib/mini_program/success_result.rb

@@ -0,0 +1,11 @@
+
+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

data/lib/mini_program/version.rb

@@ -1,3 +1,3 @@
 module MiniProgram
-  VERSION = '1.3.3'
+  VERSION = '1.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_program
 version: !ruby/object:Gem::Version
-  version: 1.3.3
+  version: 1.4.0
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-24 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -74,10 +74,12 @@ 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
@@ -103,7 +105,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.13
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: a engine for develop mini program

data/lib/mini_program/r_logger.rb

@@ -1,34 +0,0 @@
-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