wechat 0.17.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01d659a1b0109803a9d9a7efcfa27c60d0a741f135fb1df1ea7eda8bfc1840f1
-  data.tar.gz: 79d712076d72b55661649ddcd3de79e39823b53dd366e82552f8f080b162910a
+  metadata.gz: 7c59986fcf04aecd798a52b731fb9dfbe5cf145198defa76dfcb73351a8b2096
+  data.tar.gz: b4c2bd303e624cadd77537642f74e913d566d5dcc30eca97d5616807b70dd696
 SHA512:
-  metadata.gz: 959af434e46ae8e97d22e5c9263a92add7e9b6fc8b19acf72b7a6522ae4c747f140b9c3535fb1bc979522a9b8c0953f22ac08650e6fe8b5b65910f70f95447be
-  data.tar.gz: 1e3a8f527f15ace70e5fd49fba1bd5b298c3f5150f4b904a965363c02d631bd54b1325fb0afadaa0cc2a58796fdcfe6dc7e5c639e81b82669b806354d636bbac
+  metadata.gz: 44916ab7ae7f8881d7d8c6e9b5f92165e253530f6d4a0dee020fe2e6af677ba1e551cbaed437fef6787b8da9fa33ef206a98fd1226bab1290090650a72b96746
+  data.tar.gz: 552eef6ce3131be319c5aa5a68e0eecb775f74e036f90b8287c3c8995992ee0525d265c787430aa210a673e2330387b6fb145d429b79c1fd4963fe85b0c47c1c

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+
+## v1.0.0 (released at 2025-05-17)
+
+* WECHAT_PROXY_URL should be writen with port, like `export WECHAT_PROXY_URL=http://127.0.0.1:6152`, since WECHAT_PROXY_PORT removed.
+* Replace http with httpx, [reason](https://honeyryderchuck.gitlab.io/2023/10/15/state-of-ruby-http-clients-use-httpx.html)
+* Feat: add account_type to WechatConfig. by @leepood #324
+
 ## v0.17.7 (released at 2025-03-02)
 
 * Adding ostruct into its gemspec. Fix #323

data/README-CN.md

@@ -227,6 +227,7 @@ test:
 environment | 字串 | 必填。配置对应的运行环境，一般有：`production`、`development`、`test`。比如  `production`  配置仅在生产环境有效。默认为  `development`。 
 account | 字串 | 必填。自定义的微信账户名称。同一  `environment`  下，账户名称不允许重复。 
 enabled | 布尔 | 必填。配置是否生效。默认  `true`。 
+account_type | 字串 | 非必填。当前只支持`mp`,表示小程序。
 appid | 字串 | 公众号 id ，此字段和  `corpid`  两者必填其一。 
 secret | 字串 | 公众号相关配置。当公众号  `appid`  存在时必填。 
 corpid | 字串 | 企业号 id。此字段和 `appid` 两者必填其一。
@@ -896,6 +897,5 @@ end
 
 ## 已知问题
 
-* 企业微信接受菜单消息时，Wechat 腾讯服务器无法解析部分域名，请使用 iP 绑定回调 URL，用户的普通消息目前不受影响。
 * 企业微信全量覆盖成员使用的 CSV 通讯录格式，直接将下载的模板导入[是不工作的](http://qydev.weixin.qq.com/qa/index.php?qa=13978)，必须使用 Excel 打开，然后另存为 CSV 格式才会变成合法格式。
-* 如果使用 Nginx + Unicron 部署方案，并且使用了 Https，必须设置 `trusted_domain_fullname` 为 Https，否则会导致 JS-SDK 签名失效。
+* 在开发模式上使用外部反响代理 https 回调，可能需要设置 `trusted_domain_fullname` 为 https，否则会导致 JS-SDK 签名失效。

data/README.md

@@ -254,6 +254,7 @@ Attribute | Type | Annotation
 ---- | ---- | ----
 environment | string | Required. Environment of account configuration. Typical values are: `production`, `development` and `test`. For example, a `production` config will only be available in `production`. Default to `development`.
 account | string | Required. Custom wechat account name. Account names must be unique within each environment.
+account_type | string | account type, only support `mp` which is short for `mini program` currently
 enabled | boolean | Required. Whether this configuration is activated. Default to `true`.
 appid | string | Public account id. Either this attribute or `corpid` must be specified.
 secret | string | Public account configuration. Required when `appid` exists.
@@ -928,6 +929,5 @@ end
 
 ## Known Issues
 
-* Sometimes, enterprise account can not receive the menu message due to Tencent server unable to resolve DNS, so using IP as a callback URL is more stable, but it never happens for user sent text messages.
 * Enterprise batch "replace users" uses a CSV format file, but if you are using the downloaded template directly, it's [not working](http://qydev.weixin.qq.com/qa/index.php?qa=13978), must open the CSV file in Excel first, then save as CSV format again, seems Tencent only supports Excel "Save as CSV" file format.
-* If you using unicorn behind nginx and https, you need to set `trusted_domain_fullname` and point it to https, otherwise it will be http and will lead to invalid signature in the JS-SDK.
+* Using an external feedback proxy HTTPS callback in development mode may require setting `trusted_domain_fullname` to HTTPS, otherwise the JS-SDK signature will be invalid.

data/lib/action_controller/wechat_responder.rb

@@ -41,7 +41,6 @@ module ActionController
       self.skip_verify_ssl = opts.key?(:skip_verify_ssl) ? opts[:skip_verify_ssl] : cfg.skip_verify_ssl
 
       proxy_url = opts.key?(:proxy_url) ? opts[:proxy_url] : cfg.proxy_url
-      proxy_port = opts.key?(:proxy_port) ? opts[:proxy_port] : cfg.proxy_port
       proxy_username = opts.key?(:proxy_username) ? opts[:proxy_username] : cfg.proxy_username
       proxy_password = opts.key?(:proxy_password) ? opts[:proxy_password] : cfg.proxy_password
 
@@ -56,7 +55,7 @@ module ActionController
       api_type = opts[:type] || cfg.type
       secret = corpid.present? ? opts[:corpsecret] || cfg.corpsecret : opts[:secret] || cfg.secret
 
-      network_setting = Wechat::NetworkSetting.new(timeout, skip_verify_ssl, proxy_url, proxy_port, proxy_username, proxy_password)
+      network_setting = Wechat::NetworkSetting.new(timeout, skip_verify_ssl, proxy_url, proxy_username, proxy_password)
       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)
     end

data/lib/generators/wechat/templates/app/models/wechat_config.rb

@@ -9,10 +9,11 @@ class WechatConfig < ActiveRecord::Base
   validates :access_token, presence: true
   validates :jsapi_ticket, presence: true
   validates :encoding_aes_key, presence: { if: :encrypt_mode? }
+  validates :account_type, inclusion: { in: %w[mp] }, if: -> { account_type.present? }
 
   validate :app_config_is_valid
 
-  ATTRIBUTES_TO_REMOVE = %w[environment account created_at updated_at enabled].freeze
+  ATTRIBUTES_TO_REMOVE = %w[environment account created_at updated_at enabled account_type].freeze
 
   def self.get_all_configs(environment)
     WechatConfig.where(environment: environment, enabled: true).each_with_object({}) do |config, hash|
@@ -21,7 +22,9 @@ class WechatConfig < ActiveRecord::Base
   end
 
   def build_config_hash
-    as_json(except: ATTRIBUTES_TO_REMOVE)
+    config_hash = as_json(except: ATTRIBUTES_TO_REMOVE)
+    config_hash[:type] = account_type if account_type.present?
+    config_hash
   end
 
   private

data/lib/generators/wechat/templates/db/config_migration.rb.erb

@@ -5,6 +5,8 @@ class CreateWechatConfigs < ActiveRecord::Migration<%= migration_version %>
       t.string :environment, null: false, default: 'development'
       # account name
       t.string :account, null: false
+      # account type, "mp" is short for mini program
+      t.string :account_type
       # whether this config is activated
       t.boolean :enabled, default: true
 

data/lib/wechat/api_loader.rb

@@ -12,7 +12,7 @@ module Wechat
       js_token_file = options[:js_token_file] || c.jsapi_ticket.presence || '/var/tmp/wechat_jsapi_ticket'
       type = options[:type] || c.type
 
-      network_setting = Wechat::NetworkSetting.new(c.timeout, c.skip_verify_ssl, c.proxy_url, c.proxy_port, c.proxy_username, c.proxy_password)
+      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
@@ -166,7 +166,6 @@ module Wechat
                 timeout: ENV.fetch('WECHAT_TIMEOUT', nil),
                 skip_verify_ssl: ENV.fetch('WECHAT_SKIP_VERIFY_SSL', nil),
                 proxy_url: ENV.fetch('WECHAT_PROXY_URL', nil),
-                proxy_port: ENV.fetch('WECHAT_PROXY_PORT', nil),
                 proxy_username: ENV.fetch('WECHAT_PROXY_USERNAME', nil),
                 proxy_password: ENV.fetch('WECHAT_PROXY_PASSWORD', nil),
                 encoding_aes_key: ENV.fetch('WECHAT_ENCODING_AES_KEY', nil),

data/lib/wechat/concern/common.rb

@@ -144,12 +144,6 @@ module Wechat
         post 'menu/delconditional', JSON.generate(menuid: menuid)
       end
 
-      def material(media_id)
-        ActiveSupport::Deprecation.new.warn('material is deprecated. use get_material instead.')
-
-        post 'material/get_material', JSON.generate(media_id: media_id), as: :file
-      end
-
       def get_material(media_id)
         post 'material/get_material', JSON.generate(media_id: media_id), as: :file
       end

data/lib/wechat/concern/qcloud.rb

@@ -102,7 +102,7 @@ module Wechat
                                             'x-cos-security-token': x_cos_security_token,
                                             'x-cos-meta-fileid': x_cos_meta_fileid,
                                             file: form_file })
-        client.httprb.post(upload_url, form: form_data, ssl_context: client.ssl_context)
+        client.httpx.post(upload_url, form: form_data)
       end
 
       def tcb_upload_file(q_path, file)

data/lib/wechat/corp_api.rb

@@ -170,12 +170,6 @@ module Wechat
       post 'material/batchget', JSON.generate(type: type, agentid: agentid, offset: offset, count: count)
     end
 
-    def material(media_id)
-      ActiveSupport::Deprecation.new.warn('material is deprecated. use get_material instead.')
-
-      post 'material/get_material', JSON.generate(media_id: media_id), params: { agentid: agentid }, as: :file
-    end
-
     def get_material(media_id)
       post 'material/get_material', JSON.generate(media_id: media_id), params: { agentid: agentid }, as: :file
     end

data/lib/wechat/http_client.rb

@@ -1,51 +1,49 @@
 # frozen_string_literal: true
 
-require 'http'
+require 'httpx'
 
 module Wechat
   class HttpClient
-    attr_reader :base, :ssl_context, :httprb
+    attr_reader :base, :httpx
 
     def initialize(base, network_setting)
       @base = base
-      @httprb = if HTTP::VERSION.to_i >= 4
-                  HTTP.timeout(write: network_setting.timeout, connect: network_setting.timeout, read: network_setting.timeout)
-                else
-                  HTTP.timeout(:global, write: network_setting.timeout, connect: network_setting.timeout, read: network_setting.timeout)
-                end
-
-      unless network_setting.proxy_url.nil?
-        @httprb = @httprb.via(network_setting.proxy_url, network_setting.proxy_port.to_i, network_setting.proxy_username, network_setting.proxy_password)
+      @httpx = HTTPX.with(timeout: { connect_timeout: network_setting.timeout, request_timeout: network_setting.timeout })
+
+      if network_setting.proxy_url.present?
+        @httpx = @httpx.with_proxy(uri: network_setting.proxy_url,
+                                   username: network_setting.proxy_username,
+                                   password: network_setting.proxy_password)
       end
 
-      @ssl_context = OpenSSL::SSL::SSLContext.new
-      @ssl_context.ssl_version = 'TLSv1_2'
-      @ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE if network_setting.skip_verify_ssl
+      return unless network_setting.skip_verify_ssl
+
+      @httpx = @httpx.with(ssl: { verify_mode: OpenSSL::SSL::VERIFY_NONE })
     end
 
     def get(path, get_header = {})
-      request(path, get_header) do |url, header|
-        params = header.delete(:params)
-        httprb.headers(header).get(url, params: params, ssl_context: ssl_context)
+      request(path, get_header) do |url, headers|
+        params = headers.delete(:params)
+        httpx.with(headers: headers)
+             .get(url, params: params)
       end
     end
 
     def post(path, payload, post_header = {})
-      request(path, post_header) do |url, header|
-        params = header.delete(:params)
-        httprb.headers(header).post(url, params: params, body: payload, ssl_context: ssl_context)
+      request(path, post_header) do |url, headers|
+        params = headers.delete(:params)
+        httpx.with(headers: headers)
+             .post(url, params: params, body: payload)
       end
     end
 
     def post_file(path, file, post_header = {})
-      request(path, post_header) do |url, header|
-        params = header.delete(:params)
+      request(path, post_header) do |url, headers|
+        params = headers.delete(:params)
         form_file = file.is_a?(HTTP::FormData::File) ? file : HTTP::FormData::File.new(file)
-        httprb.headers(header)
-              .post(url, params: params,
-                         form: { media: form_file,
-                                 hack: 'X' }, # Existing here for http-form_data 1.0.1 handle single param improperly
-                         ssl_context: ssl_context)
+        httpx.with(headers: headers)
+             .post(url, params: params,
+                        form: { media: form_file })
       end
     end
 
@@ -80,7 +78,7 @@ module Wechat
     end
 
     def parse_response(response, as_type)
-      content_type = response.headers[:content_type]
+      content_type = response.headers['content-type']
       parse_as = {
         %r{^application/json} => :json,
         %r{^image/.*} => :file,

data/lib/wechat/message.rb

@@ -238,7 +238,7 @@ module Wechat
         key = key.to_s
         [TO_JSON_KEY_MAP[key] || (keep_camel_case_key ? key : key.downcase), value]
       end
-      json_hash = json_hash.transform_keys(&:downcase).select { |k, _v| TO_JSON_ALLOWED.include? k }
+      json_hash = json_hash.transform_keys(&:downcase).slice(*TO_JSON_ALLOWED)
 
       case json_hash['msgtype']
       when 'text'

data/lib/wechat/network_setting.rb

@@ -2,13 +2,12 @@
 
 module Wechat
   class NetworkSetting
-    attr_reader :timeout, :skip_verify_ssl, :proxy_url, :proxy_port, :proxy_username, :proxy_password
+    attr_reader :timeout, :skip_verify_ssl, :proxy_url, :proxy_username, :proxy_password
 
-    def initialize(timeout, skip_verify_ssl, proxy_url, proxy_port, proxy_username, proxy_password)
+    def initialize(timeout, skip_verify_ssl, proxy_url, proxy_username, proxy_password)
       @timeout = timeout
       @skip_verify_ssl = skip_verify_ssl
       @proxy_url = proxy_url
-      @proxy_port = proxy_port
       @proxy_username = proxy_username
       @proxy_password = proxy_password
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.17.7
+  version: 1.0.0
 platform: ruby
 authors:
 - Skinnyworm
@@ -35,7 +35,7 @@ cert_chain:
   200/Tqe769E/Y40VHi+y7u06vT756gzVfC7nH5EUd2eIFAePlp8wMvNFW5+56bKl
   LbbJnkHtUxxHWQTe2lJQuFErTSuYIaN9DhzJYNot7Ot7SPbdeChVsbPtjPg=
   -----END CERTIFICATE-----
-date: 2025-03-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -58,25 +58,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '9'
 - !ruby/object:Gem::Dependency
-  name: http
+  name: httpx
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.4
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '6'
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -153,28 +147,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.70.0
+        version: 1.72.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.70.0
+        version: 1.72.2
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: '7.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 8.0.0
+        version: '7.2'
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -276,9 +270,12 @@ 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/v0.17.7#readme
-  source_code_uri: https://github.com/Eric-Guo/wechat/tree/v0.17.7
+  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
   rubygems_mfa_required: 'true'
+post_install_message: |2
+
+  BREAKING changes: WECHAT_PROXY_URL should be written with port now, like `export WECHAT_PROXY_URL=http://127.0.0.1:6152`, since WECHAT_PROXY_PORT removed.
 rdoc_options: []
 require_paths:
 - lib
@@ -293,7 +290,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 3.1.6
 requirements: []
-rubygems_version: 3.6.5
+rubygems_version: 3.6.9
 specification_version: 4
 summary: DSL for wechat message handling and API
 test_files: []