repository·main·Indexed 23 days ago
https://github.com/eric-guo/wechatA Ruby gem for Rails developers to integrate WeChat Official Accounts, WeChat Mini Programs, and Enterprise Accounts. It provides support for sending and receiving messages, JS-SDK configuration, OAuth 2.0 authentication, session management, and a command-line interface (CLI) for user, media, and menu management.
The wechat gem does not handle API privilege exceptions. Access to specific WeChat APIs is controlled by Tencent based on your public account type and certification level.
Note on Token Timeouts: The gem automatically handles token timeout retries and recovery internally, so these specific errors typically do not require manual intervention.
You can host multiple WeChat accounts (Public, Enterprise, or Mini Programs) in a single Rails application using two methods:
In config/wechat.yml, add new segments following the environment pattern. For example, to add an account named wx2, add wx2_development, wx2_test, and wx2_production.
To use a specific account in your code:
Wechat.api(:wx2) to access the API for that account.wechat_responder account: :wx2.You can provide configuration directly in the controller or use a Proc to determine the account from the request via account_from_request.
class WechatFirstController < ActionController::Base
wechat_responder account: :new_account, account_from_request: Proc.new{ |request| request.params[:wechat] }
on :text, with:"help", respond: "help content"
endwechat_responder account: :new_account, account_from_request: Proc.new{ |request| request.params[:wechat] }The library provides support for WeChat Mini Programs, including:
wxa_get_wxacode (v0.8.7).wxa_get_wxacode_unlimit (v0.11.3).0.11.2, you can allow a message to be sent to a specific party (department) within an Enterprise account.The library supports multiple WeChat accounts in several ways:
wechat_responder supports multiple accounts (v0.10.0).The wechat_config_js helper injects a configuration signature to control WeChat App behavior in HTML.
Requirements:
wechat_api or wechat_responder in your controller before using the helper.trusted_domain_fullname in your settings.Usage Example:
<body>
<%= wechat_config_js debug: false, api: %w(hideMenuItems closeWindow) -%>
<script type="application/javascript">
wx.ready(function() {
wx.hideOptionMenu();
});
</script>
<a href="javascript:wx.closeWindow();">Close</a>
</body>Version 0.5.0 introduced support for a Rails generator to simplify the installation process.
Run the following command in your Rails application to install the gem and set up the necessary components:
rails g wechat:install
Note: This feature was introduced in v0.5.0.
rails g wechat:installDepending on your environment, use one of the following installation methods:
Install the specific version via command line:
gem install wechat -v 0.12.4Add the gem to your Gemfile:
gem 'wechat', '~> 0.12.4'To optionally record sessions when receiving messages from users, run the session generator and migrate your database. This creates a wechat_sessions table. You can extend this table with more columns or link it to your users table. If using PostgreSQL, hstore or json columns are recommended for storing data, though adding dedicated columns is the standard Rails approach.
rails g wechat:session
rake db:migrateStarting from version 0.6.0, the syntax for handling specific events has changed to be more explicit. While some old syntax may still work, you should use the following patterns for better performance and correctness:
on :scan, with: 'BINDING_QR_CODE' instead of the old :event syntax.on :batch_job, with: 'replace_user' instead of the old :event syntax.on :click, with: 'BOOK_LUNCH' instead of :event. The :click syntax is faster and more natural.Note: These changes were introduced in v0.6.0.
You can manage WeChat menus using YAML configuration files. To generate a template for a menu definition in a Rails environment, use the generator:
rails g wechat:menuOnce the YAML file (e.g., menu.yaml) is configured, upload it using the CLI:
wechat menu_create menu.yamlNote: Ensure you have management privileges for the application, otherwise you may encounter error [60011].
button:
-
name: "Want"
sub_button:
-
type: "scancode_waitmsg"
name: "绑定用餐二维码"
key: "BINDING_QR_CODE"
-
type: "click"
name: "预订午餐"
key: "BOOK_LUNCH"
-
type: "view"
name: "About"
url: "http://blog.cloud-mes.com/"To support multiple WeChat accounts, enable database-backed configurations. This creates a wechat_configs table where you can store settings for various accounts.
rails g wechat:config
rake db:migrate