wechat_gate

WechatGate

Biblioteca de desenvolvimento de plataforma pública WeChat

Interfaces suportadas:

• access_token (usado pela API de back-end)
• Obtendo informações de autorização do usuário (OAuth2)
• JS-SDK
• Encapsulamento de mensagem de resposta
• Interface do menu
• Interface de materiais

Características:

• Gerencie automaticamente a atualização e expiração de tickets de access_token e JS-SDK
• Suporta múltiplas contas públicas do WeChat
• Suporte multiambiente (desenvolvimento, produção) para facilitar testes locais
• Métodos controladores e auxiliares (gerenciamento de sessões WeChat, etc.)
• Interface simples e fácil personalização

Tutorial em vídeo de uso: desenvolvimento de conta pública WeChat

Instalação

Adicione esta linha ao Gemfile da sua aplicação:

 gem 'wechat-gate'

E então execute:

 $ bundle

Ou instale você mesmo como:

 $ gem install wechat-gate

Conta oficial

Antes de começar a trabalhar, você precisa fazer as seguintes configurações na plataforma de conta pública WeChat:

1. Abra sua conta oficial (conta de serviço) e ative a autenticação WeChat (taxa de serviço de autenticação de 300 yuans)
2. Defina o nome de domínio de segurança da sua interface JS em "Configurações oficiais da conta" - "Configurações de função" no fundo da conta oficial, que é o nome de domínio do site chamado pela sua conta oficial
3. Defina o nome de domínio da página de retorno de chamada em "Permissões de interface" - "Autorização de página da Web para obter informações básicas do usuário". Isso é usado para autenticação de nome de domínio de retorno de chamada do OAuth2.
4. Visualize e configure seu AppID e AppSecret em "Configuração Básica"

Configuração

Crie o arquivo wechat.yml no diretório de configuração do projeto Rails e configure as informações oficiais da sua conta.

 # 区分不同的环境
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'] %>

Em seguida, especifique o nome da conta oficial a ser lida no ApplicationController:

 self.wechat_gate_app_name = 'eggman'

Chamada de back-end

Operações de API em segundo plano (como aquisição de informações do usuário WeChat, etc.).

Por padrão, a configuração foi inicializada no controlador, o método é wechat_gate_config , basta usá-lo diretamente.

 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使用

Claro, você também pode inicializar a configuração manualmente ou até mesmo especificar o caminho para o arquivo de configuração:

 config = WechatGate::Config.new('eggman', '/path/to/what/ever/you/want.yml')

Tanto o access_token quanto os tickets no JS_SDK têm tempo de expiração e limite de tempo de atualização, que foram considerados aqui. Você não precisa se preocupar com isso. Se quiser atualizar manualmente, você pode fazer isso:

 config.refresh_access_token
config.refresh_jsapi_ticket

Arquivo de configuração suporta erb

Para obter mais interfaces e documentação, consulte diretamente o código-fonte, que está escrito detalhadamente.

JS-SDK

  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

ticket.js.erb:

 var wxServerConfig = <%= @data.to_json.html_safe %>;
<%= params[:callback] %>();

Em seguida, introduza o seguinte código na página do 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 ) ;
} ) ( ) ; 

Outras funções

Menu personalizado

Primeiro defina o arquivo de configuração do menu, config/wechat_menu.yml, que suporta erb. Para o formato, consulte o documento do menu personalizado do 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') %>

A variável **@config** é a instância atual da conta pública do WeChat. Por favor, não a modifique e use-a diretamente.

Em seguida, execute a tarefa rake:

 $rails wechat_gate:create_menu APP_NAME=eggman CONFIG=/path/to/wechat.yml MENU=/path/to/wechat_menu.yml

Entre eles, o padrão CONFIG é config/wechat.yml, o padrão MENU é config/wechat_menu.yml e APP_NAME deve ser especificado.

PENDÊNCIA

Adicionar teste