wechat_gate
1.0.0
WeChatパブリックプラットフォーム開発ライブラリ
サポートされているインターフェース:
特徴：
使用方法ビデオ チュートリアル: WeChat パブリック アカウントの開発
次の行をアプリケーションの Gemfile に追加します。
gem 'wechat-gate'そして、以下を実行します。
$ bundle
または、次のように自分でインストールします。
$ gem install wechat-gate
作業を開始する前に、WeChat パブリック アカウント プラットフォームで次の構成を行う必要があります。
Rails プロジェクトの config ディレクトリにファイル wechat.yml を作成し、公式アカウント情報を設定します。
# 区分不同的环境
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'] %>
次に、ApplicationController に読み込む公式アカウントの名前を指定します。
self.wechat_gate_app_name = 'eggman'
バックグラウンドAPI操作（WeChatユーザー情報取得など）。
デフォルトでは、設定はコントローラーで初期化されており、メソッドはwechat_gate_configなので、それを直接使用してください。
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使用もちろん、構成を手動で初期化することも、構成ファイルへのパスを指定することもできます。
config = WechatGate::Config.new('eggman', '/path/to/what/ever/you/want.yml')
JS_SDK の access_token とチケットには両方とも有効期限と更新回数の制限がありますが、これはここで考慮されています。手動で更新したい場合は、次のようにすることができます。
config.refresh_access_token
config.refresh_jsapi_ticket
設定ファイルはerbをサポートします
その他のインターフェイスとドキュメントについては、非常に詳細に記述されているソース コードを直接参照してください。
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"
endチケット.js.erb:
var wxServerConfig = <%= @data.to_json.html_safe %>;
<%= params[:callback] %>();
次に、WeChat ページに次のコードを導入します。
( 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 ) ;
} ) ( ) ; まず、erb をサポートするメニュー構成ファイル config/wechat_menu.yml を設定します。形式については、WeChat カスタム メニューのドキュメントを参照してください。
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') %>
**@config** 変数は現在の WeChat パブリック アカウント インスタンスです。変更せずに直接使用してください。
次に、rake タスクを実行します。
$rails wechat_gate:create_menu APP_NAME=eggman CONFIG=/path/to/wechat.yml MENU=/path/to/wechat_menu.ymlこのうち、CONFIG のデフォルトは config/wechat.yml、MENU のデフォルトは config/wechat_menu.yml であり、APP_NAME を指定する必要があります。
テストの追加
