wechat 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7c59986fcf04aecd798a52b731fb9dfbe5cf145198defa76dfcb73351a8b2096
-  data.tar.gz: b4c2bd303e624cadd77537642f74e913d566d5dcc30eca97d5616807b70dd696
+  metadata.gz: 8d81118b4e78b92ca291b74b4040ac07d36c3c3bf5c433c583e247262a564598
+  data.tar.gz: 134affd462f41d996fa4cf30eb1787e3f682283ccf95b1eebd83b2ce63fdedd3
 SHA512:
-  metadata.gz: 44916ab7ae7f8881d7d8c6e9b5f92165e253530f6d4a0dee020fe2e6af677ba1e551cbaed437fef6787b8da9fa33ef206a98fd1226bab1290090650a72b96746
-  data.tar.gz: 552eef6ce3131be319c5aa5a68e0eecb775f74e036f90b8287c3c8995992ee0525d265c787430aa210a673e2330387b6fb145d429b79c1fd4963fe85b0c47c1c
+  metadata.gz: a73a0946f5e5451f731699f58c37133745a5403428cc74bccdd00006c0bff2ee935afc34d3bc4ac3f282c7fe3b59b21758b432e7d53d629adb3d6d94de3bc47a
+  data.tar.gz: 6a552e883d2218c46558c9f72eba7113c54f3019691c4c9874884244425958ede2487079f8ae671794bb5d5f0e2a8efd5ee4ba98afa6dcbc3cd9ce6f97bee20e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v1.1.0 (released at 2025-11-24)
+
+* Feat: api wxa_get_user_risk_rank. by @leepood #327
+
+## v1.0.1 (released at 2025-07-09)
+
+* Fix after introduce httpx, status method not available for HTTPX::ErrorResponse bug
+* Some Google Jules Refactor
 
 ## v1.0.0 (released at 2025-05-17)
 

data/README-CN.md

@@ -1,4 +1,4 @@
-WeChat [![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://rubygems.org/gems/wechat) [![Build Status](https://mixtint.semaphoreci.com/badges/wechat/branches/main.svg?style=shields)](https://mixtint.semaphoreci.com/projects/wechat) [![Maintainability](https://api.codeclimate.com/v1/badges/12885358487c13e91e00/maintainability)](https://codeclimate.com/github/Eric-Guo/wechat/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/12885358487c13e91e00/test_coverage)](https://codeclimate.com/github/Eric-Guo/wechat/test_coverage)
+WeChat [![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://rubygems.org/gems/wechat) [![Build Status](https://mixtint.semaphoreci.com/badges/wechat/branches/main.svg?style=shields)](https://mixtint.semaphoreci.com/projects/wechat)[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Eric-Guo/wechat)
 ======
 
 [![Join the chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Eric-Guo/wechat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

data/README.md

@@ -1,4 +1,4 @@
-WeChat [![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://rubygems.org/gems/wechat) [![Build Status](https://mixtint.semaphoreci.com/badges/wechat/branches/main.svg?style=shields)](https://mixtint.semaphoreci.com/projects/wechat) [![Maintainability](https://api.codeclimate.com/v1/badges/12885358487c13e91e00/maintainability)](https://codeclimate.com/github/Eric-Guo/wechat/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/12885358487c13e91e00/test_coverage)](https://codeclimate.com/github/Eric-Guo/wechat/test_coverage)
+WeChat [![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://rubygems.org/gems/wechat) [![Build Status](https://mixtint.semaphoreci.com/badges/wechat/branches/main.svg?style=shields)](https://mixtint.semaphoreci.com/projects/wechat)[![Ask DeepWiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/Eric-Guo/wechat)
 ======
 
 [![Join the chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Eric-Guo/wechat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)

data/lib/action_controller/wechat_responder.rb

@@ -4,6 +4,7 @@ module ActionController
   module WechatResponder
     def wechat_api(opts = {})
       include Wechat::ControllerApi
+
       account = opts.delete(:account)
       self.wechat_cfg_account = account ? account.to_sym : :default
       self.wechat_api_client = load_controller_wechat(wechat_cfg_account, opts)
@@ -11,6 +12,7 @@ module ActionController
 
     def wechat_responder(opts = {})
       include Wechat::Responder
+
       account = opts.delete(:account)
       self.account_from_request = opts.delete(:account_from_request)
       self.wechat_cfg_account = account ? account.to_sym : :default
@@ -56,17 +58,19 @@ module ActionController
       secret = corpid.present? ? opts[:corpsecret] || cfg.corpsecret : opts[:secret] || cfg.secret
 
       network_setting = Wechat::NetworkSetting.new(timeout, skip_verify_ssl, proxy_url, proxy_username, proxy_password)
+      # access_token is token_file, jsapi_ticket is jsapi_ticket_file
+      api_config = Wechat::ApiConfig.new(corpid.presence || appid, secret, access_token, jsapi_ticket, network_setting)
       qcloud_setting = Wechat::Qcloud::Setting.new(qcloud_env, qcloud_token, qcloud_token_lifespan)
-      get_wechat_api(api_type, corpid, appid, secret, access_token, agentid, network_setting, jsapi_ticket, qcloud_setting)
+      get_wechat_api(api_type, api_config, agentid, qcloud_setting)
     end
 
-    def get_wechat_api(api_type, corpid, appid, secret, access_token, agentid, network_setting, jsapi_ticket, qcloud_setting)
+    def get_wechat_api(api_type, api_config, agentid, qcloud_setting)
       if api_type && api_type.to_sym == :mp
-        Wechat::MpApi.new(appid, secret, access_token, network_setting, jsapi_ticket, qcloud_setting)
-      elsif corpid.present?
-        Wechat::CorpApi.new(corpid, secret, access_token, agentid, network_setting, jsapi_ticket)
+        Wechat::MpApi.new(api_config, qcloud_setting)
+      elsif api_config.appid.present? && agentid.present? # Assuming corpid is now in api_config.appid for CorpApi
+        Wechat::CorpApi.new(api_config, agentid)
       else
-        Wechat::Api.new(appid, secret, access_token, network_setting, jsapi_ticket)
+        Wechat::Api.new(api_config)
       end
     end
   end

data/lib/wechat/api.rb

@@ -2,11 +2,11 @@
 
 module Wechat
   class Api < ApiBase
-    def initialize(appid, secret, token_file, network_setting, jsapi_ticket_file, record = nil)
+    def initialize(api_config, record = nil)
       super()
-      @client = HttpClient.new(Wechat::Api::API_BASE, network_setting)
-      @access_token = Token::PublicAccessToken.new(@client, appid, secret, token_file, record)
-      @jsapi_ticket = Ticket::PublicJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
+      @client = HttpClient.new(Wechat::Api::API_BASE, api_config.network_setting)
+      @access_token = Token::PublicAccessToken.new(@client, api_config.appid, api_config.secret, api_config.token_file, record)
+      @jsapi_ticket = Ticket::PublicJsapiTicket.new(@client, @access_token, api_config.jsapi_ticket_file)
       @qcloud = nil
     end
 

data/lib/wechat/api_config.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Wechat
+  class ApiConfig
+    attr_reader :appid, :secret, :token_file, :jsapi_ticket_file, :network_setting
+
+    def initialize(appid, secret, token_file, jsapi_ticket_file, network_setting)
+      @appid = appid
+      @secret = secret
+      @token_file = token_file
+      @jsapi_ticket_file = jsapi_ticket_file
+      @network_setting = network_setting
+    end
+  end
+end

data/lib/wechat/api_loader.rb

@@ -13,20 +13,25 @@ module Wechat
       type = options[:type] || c.type
 
       network_setting = Wechat::NetworkSetting.new(c.timeout, c.skip_verify_ssl, c.proxy_url, c.proxy_username, c.proxy_password)
-      if c.appid && c.secret && token_file.present?
-        if type == 'mp'
-          qcloud_env = options[:qcloud_env] || c.qcloud_env
-          qcloud_token_file = options[:qcloud_token_file] || c.qcloud_token_file.presence || '/var/tmp/qcloud_access_token'
-          qcloud_token_lifespan = options[:qcloud_token_lifespan] || c.qcloud_token_lifespan
-          qcloud_setting = Wechat::Qcloud::Setting.new(qcloud_env, qcloud_token_file, qcloud_token_lifespan)
-          Wechat::MpApi.new(c.appid, c.secret, token_file, network_setting, js_token_file, qcloud_setting)
-        else
-          Wechat::Api.new(c.appid, c.secret, token_file, network_setting, js_token_file)
-        end
-      elsif c.corpid && c.corpsecret && token_file.present?
-        Wechat::CorpApi.new(c.corpid, c.corpsecret, token_file, c.agentid, network_setting, js_token_file)
-      else
-        raise 'Need create ~/.wechat.yml with wechat appid and secret or running at rails root folder so wechat can read config/wechat.yml'
+
+      current_appid = c.corpid.presence || c.appid
+      current_secret = c.corpsecret.presence || c.secret
+
+      unless current_appid && current_secret && token_file.present?
+        raise 'Need create ~/.wechat.yml with wechat appid and secret or corpid and corpsecret, or running at rails root folder so wechat can read config/wechat.yml'
+      end
+
+      api_config = Wechat::ApiConfig.new(current_appid, current_secret, token_file, js_token_file, network_setting)
+      if type == 'mp'
+        qcloud_env = options[:qcloud_env] || c.qcloud_env
+        qcloud_token_file = options[:qcloud_token_file] || c.qcloud_token_file.presence || '/var/tmp/qcloud_access_token'
+        qcloud_token_lifespan = options[:qcloud_token_lifespan] || c.qcloud_token_lifespan
+        qcloud_setting = Wechat::Qcloud::Setting.new(qcloud_env, qcloud_token_file, qcloud_token_lifespan)
+        Wechat::MpApi.new(api_config, qcloud_setting)
+      elsif c.corpid.present? # CorpApi needs agentid
+        Wechat::CorpApi.new(api_config, c.agentid)
+      else # Regular Public Api
+        Wechat::Api.new(api_config)
       end
     end
 

data/lib/wechat/concern/common.rb

@@ -93,6 +93,12 @@ module Wechat
         post 'business/getuserphonenumber', JSON.generate(code: code), base: Wechat::Api::WXA_BASE
       end
 
+      def wxa_get_user_risk_rank(openid, scene, **payload)
+        # https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/sec-center/safety-control-capability/getUserRiskRank.html
+        request_body = { appid: access_token.appid, openid: openid, scene: scene }.merge(payload)
+        post 'getuserriskrank', JSON.generate(request_body), base: Wechat::Api::WXA_BASE
+      end
+
       def wxa_get_wxacode(path, width = 430)
         post 'getwxacode', JSON.generate(path: path, width: width), base: Wechat::Api::WXA_BASE
       end
@@ -158,7 +164,7 @@ module Wechat
 
       def material_add(type, file, opts = {})
         params = { type: type }
-        params.merge!(description: opts.slice(:title, :introduction).to_json) if type == 'video'
+        params[:description] = opts.slice(:title, :introduction).to_json if type == 'video'
 
         post_file 'material/add_material', file, params: params
       end

data/lib/wechat/corp_api.rb

@@ -4,12 +4,12 @@ module Wechat
   class CorpApi < ApiBase
     attr_reader :agentid
 
-    def initialize(appid, secret, token_file, agentid, network_setting, jsapi_ticket_file)
+    def initialize(api_config, agentid)
       super()
-      @client = HttpClient.new(QYAPI_BASE, network_setting)
-      @access_token = Token::CorpAccessToken.new(@client, appid, secret, token_file)
+      @client = HttpClient.new(QYAPI_BASE, api_config.network_setting)
+      @access_token = Token::CorpAccessToken.new(@client, api_config.appid, api_config.secret, api_config.token_file)
       @agentid = agentid
-      @jsapi_ticket = Ticket::CorpJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
+      @jsapi_ticket = Ticket::CorpJsapiTicket.new(@client, @access_token, api_config.jsapi_ticket_file)
       @qcloud = nil
     end
 

data/lib/wechat/http_client.rb

@@ -55,7 +55,18 @@ module Wechat
       header['Accept'] ||= 'application/json'
       response = yield("#{url_base}#{path}", header)
 
-      raise "Request not OK, response status #{response.status}" if response.status != 200
+      # Error responses (network failures, DNS errors, etc.) are returned as
+      # `HTTPX::ErrorResponse` objects which **do not** implement `#status`.
+      # Attempting to access that method would raise a `NoMethodError`.
+      # Instead, surface the underlying error immediately so that callers can
+      # handle it using the existing error-handling flow.
+      if defined?(HTTPX::ErrorResponse) && response.is_a?(HTTPX::ErrorResponse)
+        # `response.error` returns the wrapped exception (e.g. Errno::ECONNREFUSED)
+        # Fallback to raising the response itself if no wrapped error exists.
+        raise(response.error || StandardError.new(response.inspect))
+      end
+
+      raise "Request not OK, response #{response}" if response.respond_to?(:status) && response.status != 200
 
       parse_response(response, as || :json) do |parse_as, data|
         break data unless parse_as == :json && data['errcode'].present?

data/lib/wechat/message.rb

@@ -9,16 +9,16 @@ module Wechat
 
       def to(to_users = '', towxname: nil, send_ignore_reprint: 0)
         if towxname.present?
-          new(ToWxName: towxname, CreateTime: Time.now.to_i)
+          new(ToWxName: towxname, CreateTime: Time.zone.now.to_i)
         elsif send_ignore_reprint == 1
-          new(ToUserName: to_users, CreateTime: Time.now.to_i, send_ignore_reprint: send_ignore_reprint)
+          new(ToUserName: to_users, CreateTime: Time.zone.now.to_i, send_ignore_reprint: send_ignore_reprint)
         else
-          new(ToUserName: to_users, CreateTime: Time.now.to_i)
+          new(ToUserName: to_users, CreateTime: Time.zone.now.to_i)
         end
       end
 
       def to_party(party)
-        new(ToPartyName: party, CreateTime: Time.now.to_i)
+        new(ToPartyName: party, CreateTime: Time.zone.now.to_i)
       end
 
       def to_mass(tag_id: nil, send_ignore_reprint: 0)
@@ -65,7 +65,7 @@ module Wechat
       Message.new(
         ToUserName: message_hash[:FromUserName],
         FromUserName: message_hash[:ToUserName],
-        CreateTime: Time.now.to_i,
+        CreateTime: Time.zone.now.to_i,
         WechatSession: session
       )
     end
@@ -239,7 +239,13 @@ module Wechat
         [TO_JSON_KEY_MAP[key] || (keep_camel_case_key ? key : key.downcase), value]
       end
       json_hash = json_hash.transform_keys(&:downcase).slice(*TO_JSON_ALLOWED)
+      json_hash = transform_json_hash_by_msgtype(json_hash)
+      JSON.generate(json_hash)
+    end
+
+    private
 
+    def transform_json_hash_by_msgtype(json_hash)
       case json_hash['msgtype']
       when 'text'
         json_hash['text'] = { 'content' => json_hash.delete('content') }
@@ -255,7 +261,7 @@ module Wechat
       when 'template'
         json_hash = { 'touser' => json_hash['touser'] }.merge!(json_hash['template'])
       end
-      JSON.generate(json_hash)
+      json_hash
     end
 
     def save_to!(model_class)
@@ -264,8 +270,6 @@ module Wechat
       self
     end
 
-    private
-
     def camelize_hash_keys(hash)
       deep_recursive(hash) { |key, value| [key.to_s.camelize.to_sym, value] }
     end

data/lib/wechat/mp_api.rb

@@ -2,11 +2,11 @@
 
 module Wechat
   class MpApi < ApiBase
-    def initialize(appid, secret, token_file, network_setting, jsapi_ticket_file, qcloud_setting)
+    def initialize(api_config, qcloud_setting)
       super()
-      @client = HttpClient.new(Wechat::Api::API_BASE, network_setting)
-      @access_token = Token::PublicAccessToken.new(@client, appid, secret, token_file)
-      @jsapi_ticket = Ticket::PublicJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
+      @client = HttpClient.new(Wechat::Api::API_BASE, api_config.network_setting)
+      @access_token = Token::PublicAccessToken.new(@client, api_config.appid, api_config.secret, api_config.token_file)
+      @jsapi_ticket = Ticket::PublicJsapiTicket.new(@client, @access_token, api_config.jsapi_ticket_file)
       @qcloud = Qcloud::Token.new(@client, @access_token, qcloud_setting)
     end
 

data/lib/wechat/qcloud/token.rb

@@ -59,7 +59,7 @@ module Wechat
       end
 
       def remain_life_seconds
-        qcloud_token_expired_time - Time.now.to_i
+        qcloud_token_expired_time - Time.zone.now.to_i
       end
     end
   end

data/lib/wechat/ticket/jsapi_base.rb

@@ -41,7 +41,7 @@ module Wechat
       def signature(url)
         params = {
           noncestr: SecureRandom.base64(16),
-          timestamp: Time.now.to_i,
+          timestamp: Time.zone.now.to_i,
           jsapi_ticket: ticket,
           url: url
         }
@@ -65,7 +65,7 @@ module Wechat
       end
 
       def write_ticket_to_store(ticket_hash)
-        ticket_hash['got_ticket_at'] = Time.now.to_i
+        ticket_hash['got_ticket_at'] = Time.zone.now.to_i
         ticket_hash['ticket_expires_in'] = ticket_hash.delete('expires_in')
         write_ticket(ticket_hash)
       end
@@ -79,7 +79,7 @@ module Wechat
       end
 
       def remain_life_seconds
-        ticket_life_in_seconds - (Time.now.to_i - got_ticket_at)
+        ticket_life_in_seconds - (Time.zone.now.to_i - got_ticket_at)
       end
     end
   end

data/lib/wechat/token/access_token_base.rb

@@ -35,7 +35,7 @@ module Wechat
       def write_token_to_store(token_hash)
         raise InvalidCredentialError unless token_hash.is_a?(Hash) && token_hash['access_token']
 
-        token_hash['got_token_at'] = Time.now.to_i
+        token_hash['got_token_at'] = Time.zone.now.to_i
         token_hash['token_expires_in'] = token_hash.delete('expires_in')
         write_token(token_hash)
       end
@@ -63,7 +63,7 @@ module Wechat
       end
 
       def remain_life_seconds
-        token_life_in_seconds - (Time.now.to_i - got_token_at)
+        token_life_in_seconds - (Time.zone.now.to_i - got_token_at)
       end
 
       private
@@ -77,7 +77,7 @@ module Wechat
 
         record.access_token = token_hash['access_token']
         record.token_expires_in = token_hash['token_expires_in']
-        record.got_token_at = Time.now
+        record.got_token_at = Time.zone.now
         record.save || record.save(validate: false)
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Skinnyworm
@@ -147,14 +147,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.72.2
+        version: 1.81.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.72.2
+        version: 1.81.7
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -175,14 +175,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '7.1'
+        version: '8.0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
@@ -242,6 +242,7 @@ files:
 - lib/wechat.rb
 - lib/wechat/api.rb
 - lib/wechat/api_base.rb
+- lib/wechat/api_config.rb
 - lib/wechat/api_loader.rb
 - lib/wechat/cipher.rb
 - lib/wechat/concern/common.rb
@@ -270,8 +271,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/Eric-Guo/wechat/issues
   changelog_uri: https://github.com/Eric-Guo/wechat/releases
-  documentation_uri: https://github.com/Eric-Guo/wechat/tree/v1.0.0#readme
-  source_code_uri: https://github.com/Eric-Guo/wechat/tree/v1.0.0
+  documentation_uri: https://github.com/Eric-Guo/wechat/tree/v1.1.0#readme
+  source_code_uri: https://github.com/Eric-Guo/wechat/tree/v1.1.0
   rubygems_mfa_required: 'true'
 post_install_message: |2
 
@@ -290,7 +291,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.1.6
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: DSL for wechat message handling and API
 test_files: []