Project

mp_weixin

0.0
No commit activity in last 3 years
No release in over 3 years
A wrapper for weiXin MP platform
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

Runtime

<= 4, >= 3.0
>= 1.7.9
>= 0.5.2
<= 0.9, >= 0.5
>= 0
~> 1.4.4
 Project Readme

MpWeixin

A wrapper for weiXin MP platform

[Gem Version][gem] [Build Status][travis] [Dependency Status][gemnasium] [Code Climate][codeclimate] [Coverage Status][coveralls]

Installation

Add this line to your application's Gemfile:

gem 'mp_weixin'

And then execute:

$ bundle

Or install it yourself as:

$ gem install mp_weixin

Functions & Features

基础支持

  • 获取access token [DONE]
  • 全局返回码说明 [TODO]
  • 接口频率限制说明 [NOPLAN]
  • 上传下载多媒体文件 [TODO]

接收消息

  • 验证消息真实性 [DONE] prefer
  • 接收普通消息 [DONE] prefer
  • 接收事件推送 [DONE] prefer
  • 接收语音识别结果 [DONE] prefer

发送消息

  • 发送被动响应消息 [DONE] prefer
  • 发送客服消息 [DONE] prefer

用户管理

  • 分组管理接口 [DONE] prefer
  • 获取用户基本信息 [DONE] prefer
  • 获取关注者列表 [DONE] prefer
  • 获取用户地理位置 [DONE] prefer
  • 网页授权获取用户基本信息 [DONE] prefer
  • 网页获取用户网络状态(JS接口)[NOPLAN]

自定义菜单

  • 自定义菜单创建接口 [DONE] prefer
  • 自定义菜单查询接口 [DONE] prefer
  • 自定义菜单删除接口 [DONE] prefer
  • 自定义菜单事件推送 [DONE] prefer

推广支持

  • 生成带参数的二维码 [DONE] prefer

The Structure

$ tree lib/ -L 3
lib/
├── config
│   └── mp_weixin_error.yml
├── mp_weixin
│   ├── access_token.rb
│   ├── client.rb
│   ├── config.rb
│   ├── error.rb
│   ├── interface
│   │   ├── base.rb
│   │   ├── group.rb
│   │   ├── menu.rb
│   │   ├── message.rb
│   │   ├── promotion.rb
│   │   └── user.rb
│   ├── models
│   │   ├── event.rb
│   │   ├── message.rb
│   │   └── reply_message.rb
│   ├── response.rb
│   ├── response_rule.rb
│   ├── server_helper.rb
│   ├── server.rb
│   └── version.rb
└── mp_weixin.rb

client:

which initiate with an app_id and app_secret who have ability to request interface provider by 'https://api.weixin.qq.com'. Of course at first you must been authorize. Those include 发送客服消息, 用户管理, 自定义菜单.

server

It's a web service, used to receive all the http request from 'weixin server', and give and rigth response. those response include 接收消息, 发送被动响应消息.

want it should been like?

  1. first it should been a web service, it should have ability to '验证消息真实性', '接收普通消息 ', '发送被动响应消息', '接收事件推送', '接收语音识别结果'.
  2. then I want it should can match some custom rules(like rails route)
  3. all of those rule's return will response to 'https://api.weixin.qq.com'

models

some base data model used by [mp_weixin] eg message, event. Those model should have some usefully method been defined.

Usage

how boot mp_weixin

config mp_weixin.yml (eg spec/support/weixin.yml)

defaults: &defaults
  app_id: "12341432134"
  app_secret: "app_secret"
  url: "http://www.example.com"
  token: "secret"

development:
  <<: *defaults
production:
  <<: *defaults
test:
  <<: *defaults

initializer the MpWeixin (eg spec/support/mp_weixin.rb)

launch MpWeixin::Server

create file config.ru

require 'rubygems'
require 'bundler'

Bundler.require

# require 'mp_weixin'

run MpWeixin::Server
# rackup config.ru

request weixin api

through MpWeixin::Client module request some api interface at 'weixin'

# initalize and get new access_token
client = MpWeixin::Client.new
client.get_token
# initalize with exists access_token
token_hash = {"expires_in" => "7200", "access_token" => access_token}
client = MpWeixin::Client.from_hash(token_hash)

client.menu.get_menus
# more detail check 'spec/mp_weixin/interface/'

demo how guanxi use MpWeixin::Client

# encoding: utf-8
class WechatClient
  include Mongoid::Document
  include Mongoid::Timestamps

  field :access_token, type: String
  field :expires_at, type: Integer

  class << self
    attr_accessor :wechat_client

    def get_access_token
      wechat_client = self.first || self.new

      {
        access_token: wechat_client.access_token,
        expires_at: wechat_client.expires_at.try(:to_i)
      }.keep_if{|_, v| v.present?}
    end
    def set_access_token(access_token, expires_at)
      wechat_client = self.first || self.new

      wechat_client.update_attributes(
                                             access_token: access_token,
                                             expires_at: expires_at
                                           )
    end

    # return an instance of MpWeixin#client with 'is_authorized?' is true
    #
    # client = WechatClient.this_client
    # client.message.custom_send(touser: "ozIMPt8wb8I8iYm-IjD1DHP-IQ9s", msgtype: "text", text: {content: "hey, we found you!"})
    def this_client
      unless @wechat_client.try("is_authorized?")
        @wechat_client = fresh_client
      end

      @wechat_client
    end

    def fresh_client
      token_hash = WechatClient.get_access_token
      expires_at_time = Time.at(token_hash[:expires_at]) rescue 2.hours.from_now

      if token_hash[:access_token].present? and (expires_at_time > Time.now)
        client = MpWeixin::Client.from_hash(token_hash)
      else
        client = MpWeixin::Client.new
        client.get_token

        WechatClient.set_access_token(client.token.token, client.token.expires_at)
      end

      client
    end
  end
end

start weixin mp server

mount with Rails application

# /app/services/wechat/response_rule.rb
# encoding: utf-8
module ResponseRule
  # handle corrent data post from weixin
  #
  # please @rewrite me
  def handle_message(request, message)
    #
    logger.info "Hey, one request from '#{request.url}' been detected, and content is #{message.as_json}"
    # did you want save this message ???
  end

  def response_text_message(request, message)
    case message.Content
      when /greet/
        reply_message = message.reply_text_message({Content: "whosyourdaddy!"})
        logger.info "response with #{reply_message.to_xml}"
      else
        reply_message = message.reply_text_message({Content: "hey, guy you are welcome!"})
        logger.info "response with #{reply_message.to_xml}"
    end
  end

  # 发送被动响应消息'
  #
  # please @rewrite me
  #
  #
  # can rely with instance of those class eg, TextReplyMessage, ImageReplyMessage, VoiceReplyMessage
  # VideoReplyMessage, MusicReplyMessage, NewsReplyMessage
  # quickly generate reply content through call 'reply_#{msg_type}_message(attributes).to_xml' @see 'spec/mp_weixin/server_helper_spec.rb'
  #
  def response_message(request, message, &block)
    if block_given?
      block.call(request, message)
    end
    send("response_#{message.MsgType}_message", request, message)

    # reply with
    # reply_#{msg_type}_message(attributes).to_xml
  end
end

# load custom response_rule
class MpWeixin::Server
  helpers ResponseRule
end
# routes.rb
Gxservice::Application.routes.draw do
  require "mp_weixin"
  require "#{Rails.root}/app/services/wechat/response_rule"
  mount MpWeixin::Server, :at => '/weixin'
end

more detail pls check spec/

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. test changes (rake spec)
  4. Commit your changes (git commit -am 'Add some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request