mini_program 1.1.3 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 296c4dddb41810576f1dd0cedbc9aae7f730b1cf50f52b99fea2bdcdac7b8ba1
-  data.tar.gz: 89873bf39d9be8ebdc9e33602b6a00773266ba0c15751ae113755e1275719a76
+  metadata.gz: 299067c25a9cc3d5d9070719da62f4239dafa89990540db1c81d5686475d9dbe
+  data.tar.gz: 857dfd0f801159319c7663d12d2d4472149c7f3e34f0a32002dcc6b88cdd0fad
 SHA512:
-  metadata.gz: 475db5f1df160f23df1e8b5adbfbe34b84033f86dc55eb44107c99d0167ef0e036d5a994b67bd47e981de8167deb7c0ecc1e82cb6446d01101ce2144e17d7496
-  data.tar.gz: faa337e8129bbce833f0f4ffd5dea933f30d402618892579de31481c100df7f53ecc2c3d5671b69bdf386c075e948bfd5e8ad3b705304c58d327825b6812d272
+  metadata.gz: 4ff9c4555528100bee8afdcb11c0c8de0b8c1df110ee1f2cbf149ff78caba1cc035189b0f21a4a0dc18f1b395820bde5e2f63c4d68a1a4fdc3bb5ba8e865f79c
+  data.tar.gz: 6cd0e717e952fd257dd873d0511501c8098f8741a935254ed0b9c190370f0b46d7d6d676a82c56d9a785cf89e2be18b667c56f4bcae2db0bdb3e987b22461e61

data/README.md

@@ -48,7 +48,7 @@ code = "041PuvGa1rysrB0noDJa1n7RBv2PuvGe"
 encrypted_data = "3G/+Fh6kCBaQszXFTxz3h3HFSbu0UuVW/4aLbz8WGzrKfmbGpvnxYHAa4QrKXJvHpB++3ogOYoU6iiG+1HW18Lkt9qEJE9GyRw5OnuXSjTnUIPSRROT3sxeAYnT1kf4ngTAfrD3f4TFtLXkRIrrc1MzSqx/LV8iXA8Lu5Y+7kZx26eulz3yVrlXDH3BOIX6zcGOeprsK5XzDx2ltmf3j5w=="
 iv = "5tiyfVEHNVgHN4n8lzDrUA=="
 
-result = mp.get_phone_num(code: code, encrypted_data: encrypted_data, iv: iv)
+result = mp.decrypt_phone_num(code: code, encrypted_data: encrypted_data, iv: iv)
 
 if result.success?
   phone_num = result.data[:phone] 

data/app/controllers/mini_program/wechat_controller.rb

@@ -15,23 +15,26 @@ module MiniProgram
 
         after_mp_login if respond_to? :after_mp_login
 
-        render json: current_mp_user
+        render json: ServiceResult.new(success: true,
+                                       data: { current_user: current_mp_user },
+                                       message: "登录成功",
+                                       message_kind: :login_success)
       else
-        render json: { error: result.error }
+        render json: result, status: 500
       end
     end
 
     # POST /wechat/phone_num
     def phone_num
       client = MiniProgram::Client.new
-      result = client.get_phone_num(code: params[:code], encrypted_data: params[:encrypted_data], iv: params[:iv])
+      result = client.decrypt_phone_num(code: params[:code], encrypted_data: params[:encrypted_data], iv: params[:iv])
 
       if result.success?
         cookies.signed[:phone_num] = result.data[:phone_num]
 
-        render json: result.data
+        render json: result
       else
-        render json: { error: result.error }
+        render json: result, status: 500
       end
     end
   end

data/lib/exceptions/initialize_denied.rb

@@ -0,0 +1,2 @@
+
+class InitializeDenied < StandardError; end

data/lib/exceptions/unsupported_param_type.rb

@@ -0,0 +1,2 @@
+
+class UnsupportedParamType < StandardError; end

data/lib/mini_program/client.rb

@@ -23,17 +23,22 @@ 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::ServiceResult.new(success: true,
+                                              data: { access_token: access_token },
+                                              message: "获取 access token 成功",
+                                              message_kind: :get_access_token_success)
       end
 
       result = request_access_token
 
       if result.success?
-        # redis.setex access_token_store_key,  1.5.hours.to_i, result.data["access_token"]
         Rails.cache.write(access_token_store_key,
                           result.data["access_token"],
                           expires_in: 1.5.hours.to_i,
                           race_condition_ttl: 10)
+
+        result.message = "获取 access token 成功"
+        result.message_kind = :get_access_token_success
       end
 
       yield result if block_given?
@@ -57,15 +62,24 @@ module MiniProgram
       result = JSON.parse(response)
 
       if result["errcode"] && result["errcode"].to_s != "0"
-        logger.error <<~ERROR
-        Get access token failed.
-        api: #{api} 
-        error: #{result}
-        ERROR
-        return MiniProgram::ServiceResult.new(success: false, error: result, message: result["errmsg"])
+        logger.tagged "request access token" do
+          logger.error <<~ERROR
+          Get access token failed.
+          api: #{api} 
+          error: #{result}
+          ERROR
+        end
+
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result,
+                                       message: result["errmsg"],
+                                       message_kind: :request_access_token_failed)
+      else
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: { access_token: result["access_token"] },
+                                       message: "请求 access token 成功",
+                                       message_kind: :request_access_token_success)
       end
-
-      MiniProgram::ServiceResult.new(success: true, data: result)
     end
 
     # 调用微信授权登录 api
@@ -85,21 +99,31 @@ 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}
+          Get session key failed.
+          api: #{api}
+          result: #{result}
         ERROR
-        return MiniProgram::ServiceResult.new(error: result, message: result["errmsg"])
+
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result,
+                                       message: result["errmsg"],
+                                       message_kind: :login_failed)
+
+      else
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: result,
+                                       message: "小程序登录成功",
+                                       message_kind: :login_success)
       end
 
-      MiniProgram::ServiceResult.new(success: true, data: result)
     end
 
     # 发送订阅消息
     # @param [MiniProgram::Msg] msg
     # @param [String] to 用户的openid
-    def send_msg(msg, to: )
+    def send_msg(msg, to:)
       openid = to.try(:openid) || to
 
       payload = msg.as_json.merge!(touser: openid)
@@ -114,19 +138,34 @@ module MiniProgram
       result = post(api, payload)
 
       if result["errcode"].to_s != "0"
-        msg_logger.error {"{params: #{payload}, response: #{result}}"}
-        return MiniProgram::ServiceResult.new(success: false, error: result)
+        logger.tagged "Subscribe Message" do
+          logger.error { "{params: #{payload}, response: #{result}}" }
+        end
+
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result,
+                                       message: "发送订阅消息失败",
+                                       message_kind: :send_subscribed_message_failed)
+      else
+        logger.tagged "Subscribe Message" do
+          logger.info { "{params: #{payload}, response: #{result}}" }
+        end
+
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: {
+                                         msgid: result.data["msgid"]
+                                       },
+                                       message: "发送订阅消息成功",
+                                       message_kind: :send_subscribed_message_success)
       end
 
-      msg_logger.info {"{params: #{payload}, response: #{result}}"}
-      MiniProgram::ServiceResult.new(success: true, data: result)
     end
 
     # 「发送统一服务消息」
     # 统一服务消息原本是可以从调用小程序的 api ，通过用户小程序的 openid 发送模板消息到小程序和公众号那里去，
     # 现在小程序的模板消息功能关闭了，就只剩下发送模板消息到公众号这个功能了
     #
-    def send_uniform_msg(msg, to: )
+    def send_uniform_msg(msg, to:)
       openid = to.try(:openid) || to
 
       payload = msg.as_json
@@ -143,16 +182,26 @@ module MiniProgram
       })
 
       if result["errcode"].to_s != "0"
-        msg_logger.error {"{params: #{payload}, response: #{result}}"}
-        return MiniProgram::ServiceResult.new(success: false, error: result["errmsg"])
+        logger.tagged "uniform message" do
+          logger.error { "{params: #{payload}, response: #{result}}" }
+        end
+
+        MiniProgram::ServiceResult.new(success: false,
+                                       error: result["errmsg"],
+                                       message: "发送统一服务消息失败",
+                                       message_kind: :send_uniform_message_failed)
+      else
+        msg_logger.info { "{params: #{payload}, response: #{result}}" }
+        MiniProgram::ServiceResult.new(success: true,
+                                       data: result,
+                                       message: "发送统一服务消息成功",
+                                       message_kind: :send_uniform_message_success)
       end
 
-      msg_logger.info { "{params: #{payload}, response: #{result}}"}
-      MiniProgram::ServiceResult.new(success: true, data: result)
     end
 
     # 获取用户手机号
-    def get_phone_num(code:, encrypted_data:, iv:)
+    def decrypt_phone_num(code:, encrypted_data:, iv:)
       login_result = login(code)
       return login_result if login_result.failure?
 
@@ -165,17 +214,26 @@ module MiniProgram
 
       MiniProgram::ServiceResult.new(
         success: true,
+        message: "解密手机号成功",
+        message_kind: :decrypt_phone_number_success,
         data: {
           openid: openid,
           phone_num: phone_num
-      })
+        })
+    rescue OpenSSL::Cipher::CipherError => e
+      MiniProgram::ServiceResult.new(
+        success: false,
+        message: "解密手机号失败",
+        message_kind: :decrypt_phone_data_failed,
+        error: e
+      )
     end
 
     def config
       appid, app_secret = if MiniProgram.appid && MiniProgram.app_secret
                             [MiniProgram.appid, MiniProgram.app_secret]
 
-                          # 如果有挂载 WechatPayment 的 engine 时，使用里边的小程序配置
+                            # 如果有挂载 WechatPayment 的 engine 时，使用里边的小程序配置
                           elsif Object.const_defined? "WechatPayment"
                             [WechatPayment.sub_appid || WechatPayment.appid, WechatPayment.sub_app_secret || WechatPayment.app_secret]
                           else
@@ -186,32 +244,32 @@ module MiniProgram
     end
 
     #获取小程序二维码
-    def qrcode_unlimited(scene:, page:, width: 280, check_path: true, env_version: "release") 
-      get_token_result = get_access_token
-      if get_access_token.failure?  
-        return get_token_result
+    def qrcode_unlimited(scene:, page:, width: 280, check_path: true, env_version: "release")
+      get_token_result = get_access_token.on_failure do |result|
+        return result
       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"] 
-        msg_logger.error {"{params: #{params}, response: #{result}}"}
-        return MiniProgram::ServiceResult.new(success: false, error: result)
+      params = { scene:, page:, width:, check_path:, env_version: }
+
+      result = post(api, params)
+
+      if result["errcode"]
+        logger.error { "{ action: 'generate qrcode', params: #{params}, response: #{result}}" }
+        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::ServiceResult.new(success: true,
+                                       data: { image: result },
+                                       message: "获取二维码成功",
+                                       message_kind: :get_unlimited_qrcode_success)
       end
-       
-      MiniProgram::ServiceResult.new(success: true, data: { image: result })
     end
-     
+
     private
 
     def get(api, payload = {})
@@ -222,7 +280,7 @@ module MiniProgram
       end
 
       Net::HTTP.get(uri)
-    end 
+    end
 
     def post(api, payload = {}, options = {})
       uri = URI(api)
@@ -232,14 +290,16 @@ module MiniProgram
       options = {
         use_ssl: true
       }.merge(options)
-       
+
       res = Net::HTTP.start(uri.host, uri.port, **options) do |http|
         http.request(req, payload.to_json)
-      end  
-     
-      return res.body if res["Content-Type"] == "image/jpeg"
-      
-      JSON.parse(res.body) 
+      end
+
+      image_content_types = ["image/jpeg", "image/jpg", "image/gif", "image/png"]
+
+      return res.body if res["Content-Type"].in? image_content_types
+
+      JSON.parse(res.body)
     end
 
     def decrypt_phone_data(encrypted_data, iv, session_key)

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/request_result.rb

@@ -0,0 +1,4 @@
+
+class MiniProgram::RequestResult
+
+end

data/lib/{service_result.rb → mini_program/service_result.rb}

@@ -2,9 +2,9 @@ module MiniProgram
   class ServiceResult
     attr_accessor :success,
                   :error,
-                  :error_type,
                   :data,
                   :message,
+                  :message_kind,
                   :message_type
 
     delegate :[], :[]=, to: :data
@@ -13,12 +13,15 @@ module MiniProgram
                    error: nil,
                    message: nil,
                    message_type: nil,
+                   message_kind: nil,
                    data: {})
+
       self.success = success
       self.data = (data.presence || {}).with_indifferent_access
       self.error = error
       self.message = message
       self.message_type = message_type
+      self.message_kind = message_kind
     end
 
     alias success? :success
@@ -49,12 +52,12 @@ module MiniProgram
 
     def as_json(options = nil)
       {
-        success: success,
-        data: data,
-        message: message,
+        success:,
+        data:,
+        message:,
         message_type: get_message_type,
-        error: error,
-        error_type: error_type
+        message_kind:,
+        error:,
       }
     end
   end

data/lib/mini_program/version.rb

@@ -1,3 +1,3 @@
 module MiniProgram
-  VERSION = '1.1.3'
+  VERSION = '1.3.0'
 end

data/lib/mini_program.rb

@@ -4,8 +4,9 @@ require "mini_program/client"
 require "mini_program/msg"
 require "mini_program/user"
 require "application_controller_ext"
-require "r_logger"
-require "service_result"
+require "mini_program/r_logger"
+require "mini_program/log_formatter"
+require "mini_program/service_result"
 require "mocha"
 
 module MiniProgram

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mini_program
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.3.0
 platform: ruby
 authors:
 - ian
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-02-10 00:00:00.000000000 Z
+date: 2022-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,6 +63,8 @@ files:
 - app/views/mini_program/wechat/login.html.erb
 - config/routes.rb
 - lib/application_controller_ext.rb
+- lib/exceptions/initialize_denied.rb
+- lib/exceptions/unsupported_param_type.rb
 - lib/generators/mini_program/install/USAGE
 - lib/generators/mini_program/install/install_generator.rb
 - lib/generators/mini_program/install/templates/initializer.rb
@@ -73,10 +75,11 @@ files:
 - lib/mini_program/client.rb
 - lib/mini_program/engine.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/user.rb
 - lib/mini_program/version.rb
-- lib/r_logger.rb
-- lib/service_result.rb
 - lib/tasks/mini_program_tasks.rake
 homepage: https://github.com/bkyz/mini_program
 licenses:

data/lib/r_logger.rb

@@ -1,36 +0,0 @@
-module MiniProgram
-  class RLogger
-    def initialize
-      raise Exceptions::InitializeDenied.new("please use 'ILogger.make' instead of 'ILogger.new'")
-    end
-
-    class << self
-      def make(log_file)
-        @logger ||= {}
-
-        log_file_name = if log_file.class.in? [String, Symbol]
-                          log_file_name = log_file.to_sym
-
-                          unless log_file_name.to_s.end_with? ".log"
-                            log_file_name = "#{log_file_name}.log"
-                          end
-
-                          "#{root_path}/#{log_file_name}"
-                        elsif log_file.respond_to? :to_path
-                          log_file.to_path
-                        else
-                          raise Exceptions::UnsupportdParamType.new("log file parameter only support 'File' or 'String' Type.")
-                        end
-
-        # 如果已经存在日志对象，则返回已有的日志对象
-        @logger[log_file_name] ||= ::Logger.new(log_file_name)
-      end
-
-      def root_path
-        @root ||= "#{Rails.root}/log"
-      end
-    end
-
-
-  end
-end