wechat_gate
1.0.0
Библиотека разработки общедоступной платформы WeChat
Поддерживаемые интерфейсы:
Функции:
Видеоруководство по использованию: разработка общедоступной учетной записи WeChat
Добавьте эту строку в Gemfile вашего приложения:
gem 'wechat-gate'И затем выполните:
$ bundle
Или установите его самостоятельно как:
$ gem install wechat-gate
Перед началом работы вам необходимо выполнить следующие настройки на платформе общедоступных учетных записей WeChat:
Создайте файл wechat.yml в каталоге конфигурации проекта Rails и настройте информацию о своей официальной учетной записи.
# 区分不同的环境
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')
Как access_token, так и билеты в JS_SDK имеют ограничение по сроку действия и времени обновления, которые здесь рассмотрены. Вам не нужно об этом беспокоиться. Если вы хотите обновить вручную, вы можете сделать это:
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"
endTicket.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 ) ;
} ) ( ) ; Сначала установите файл конфигурации меню config/wechat_menu.yml, который поддерживает erb. Формат см. в документе пользовательского меню 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.
Добавить тест
