wechat_gate
1.0.0
Entwicklungsbibliothek für die öffentliche WeChat-Plattform
Unterstützte Schnittstellen:
Merkmale:
Nutzungsvideo-Tutorial: Entwicklung eines öffentlichen WeChat-Kontos
Fügen Sie diese Zeile zur Gemfile Ihrer Anwendung hinzu:
gem 'wechat-gate'Und dann ausführen:
$ bundle
Oder installieren Sie es selbst als:
$ gem install wechat-gate
Bevor Sie mit der Arbeit beginnen, müssen Sie die folgenden Konfigurationen auf der öffentlichen WeChat-Kontoplattform vornehmen:
Erstellen Sie die Datei wechat.yml im Konfigurationsverzeichnis des Rails-Projekts und konfigurieren Sie Ihre offiziellen Kontoinformationen.
# 区分不同的环境
eggman:
development:
host: http://wechat-test1.eggman.tv
wechat_id: xxxxxxxxxx
app_id: xxxxxxxxxx
app_secret: xxxxxxxxxx
oauth2_redirect_uri: "http://wechat-test1.eggman.tv/wechat/users/callback"
push_url: "http://wechat-test1.eggman.tv/wechat/push"
push_token: xxxxxxxxxxxxxxxxxxxx
production:
host: https://eggman.tv
wechat_id: xxxxxxxxxx
app_id: xxxxxxxxxxxxxxxxxxxx
app_secret: xxxxxxxxxxxxxxxxxxxxxxxxxx
# 如果不需要多环境支持，也可以这样
app_name:
app_id: <%= ENV['WECHAT_APP_NAME_APP_ID'] %>
app_secret: <%= ENV['WECHAT_APP_NAME_APP_SECRET'] %>
oauth2_redirect_uri: <%= ENV['WECHAT_APP_NAME_OAUTH2_REDIRECT_URI'] %>
Geben Sie dann den Namen des offiziellen Kontos an, das im ApplicationController gelesen werden soll:
self.wechat_gate_app_name = 'eggman'
Hintergrund-API-Vorgänge (z. B. Erfassung von WeChat-Benutzerinformationen usw.).
Standardmäßig wurde die Konfiguration im Controller initialisiert. Die Methode lautet wechat_gate_config . Verwenden Sie sie einfach direkt.
wechat_gate_config . users # 获取用户列表
wechat_gate_config . user ( 'ONE_OPEN_ID' ) # 获取一个用户的详细信息
wechat_gate_config . access_token # 获取当前access_token
# OAuth 2
wechat_gate_config . oauth2_entrance_url ( scope : "snsapi_userinfo" , state : "CURENT_STATE" ) # 获取当前OAuth2授权入口URL
wechat_gate_config . oauth2_access_token ( "TOKEN" ) # 根据OAuth2返回的TOKEN获取access_token
wechat_gate_config . oauth2_user ( "ACCESS_TOKEN" , "ONE_OPEN_ID" ) # 获取一个用户的信息
wechat_gate_config . medias # 获取素材列表, 参数type: image | video | voice | news (图文)
wechat_gate_config . menu_get # 获取菜单
wechat_gate_config . menu_create ( MENU_HASH ) # 创建菜单
wechat_gate_config . generate_js_request_params ( REFERER_URL ) # 返回JS-SDK的验证参数，供前端JS-SDK使用Natürlich können Sie die Konfiguration auch manuell initialisieren oder sogar den Pfad zur Konfigurationsdatei angeben:
config = WechatGate::Config.new('eggman', '/path/to/what/ever/you/want.yml')
Sowohl access_token als auch Tickets in JS_SDK haben eine Ablaufzeit und Aktualisierungszeiten, die hier berücksichtigt wurden. Wenn Sie eine Aktualisierung manuell durchführen möchten, können Sie Folgendes tun:
config.refresh_access_token
config.refresh_jsapi_ticket
Die Konfigurationsdatei unterstützt erb
Weitere Schnittstellen und Dokumentation finden Sie direkt im Quellcode, der sehr detailliert geschrieben ist.
def ticket
url = CGI . unescape ( params [ :url ] ) # 微信中用户访问的页面
@data = wechat_gate_config . generate_js_request_params ( url ) # 生成微信JS-SDK所需的jsapi_ticket，signature等等参数供前段js使用
render content_type : "application/javascript"
endticket.js.erb:
var wxServerConfig = <%= @data.to_json.html_safe %>;
<%= params[:callback] %>();
Führen Sie dann den folgenden Code auf der WeChat-Seite ein:
( function ( ) {
var ticket = document . createElement ( "script" ) ;
ticket . src = "http://localhost/api/wechat_ticket/ticket.js?url=" + encodeURIComponent ( window . location . href . split ( '#' ) [ 0 ] ) + "&callback=wxCallback" ;
var s = document . getElementsByTagName ( "script" ) [ 0 ] ;
s . parentNode . insertBefore ( ticket , s ) ;
} ) ( ) ; Legen Sie zunächst die Menükonfigurationsdatei config/wechat_menu.yml fest, die erb unterstützt. Das Format finden Sie im benutzerdefinierten WeChat-Menüdokument:
button:
- type: view
name: 我的2
url: <%= @config.oauth2_entrance_url(scope: 'snsapi_userinfo', state: 'profile') %>
- type: view
name: 课程
sub_button:
- type: view
name: 免费课程
url: <%= @config.oauth2_entrance_url(scope: 'snsapi_userinfo', state: 'free') %>
- type: view
name: 付费课程
url: <%= @config.oauth2_entrance_url(scope: 'snsapi_userinfo', state: 'paid') %>
Die Variable **@config** ist die aktuelle öffentliche WeChat-Kontoinstanz. Bitte ändern Sie sie nicht und verwenden Sie sie direkt.
Führen Sie dann die Rake-Aufgabe aus:
$rails wechat_gate:create_menu APP_NAME=eggman CONFIG=/path/to/wechat.yml MENU=/path/to/wechat_menu.ymlUnter diesen ist CONFIG standardmäßig config/wechat.yml, MENU standardmäßig config/wechat_menu.yml und APP_NAME muss angegeben werden.
Test hinzufügen
