Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/wolfg1969/rack-weixin

微信公众平台开放消息接口 Rack Middleware
https://github.com/wolfg1969/rack-weixin
rack rack-middleware rails ruby weixin
Last synced: 6 days ago
JSON representation
微信公众平台开放消息接口 Rack Middleware
Host: GitHub
URL: https://github.com/wolfg1969/rack-weixin
Owner: wolfg1969
Created: 2013-02-20T13:55:36.000Z (over 11 years ago)
Default Branch: master
Last Pushed: 2014-03-06T02:25:59.000Z (over 10 years ago)
Last Synced: 2024-03-14T23:47:12.042Z (8 months ago)
Topics: rack, rack-middleware, rails, ruby, weixin
Language: Ruby
Homepage: http://rubygems.org/gems/rack-weixin
Size: 492 KB
Stars: 105
Watchers: 18
Forks: 27
Open Issues: 0
Metadata Files:
- Readme: README.md
Awesome Lists containing this project

README

        微信公众平台 开放消息接口 Rack Middleware

========================================

[![Build Status](https://travis-ci.org/wolfg1969/rack-weixin.png?branch=master)](https://travis-ci.org/wolfg1969/rack-weixin) [![Gem Version](https://badge.fury.io/rb/rack-weixin.png)](http://badge.fury.io/rb/rack-weixin)

* 验证微信请求 with 'weixin/middleware'

* 解析推送消息 with 'weixin/model'

* 生成回复消息 with 'weixin/model'

Installation

------------

```

$ gem install rack-weixin

```

Usage

-----

A sinatra demo

```ruby

# -*- encoding : utf-8 -*-

require 'sinatra'

require 'rack-weixin'

use Weixin::Middleware, 'your api token', '/your_app_root' 

configure do

    set :wx_id, 'your_weixin_account'

end

helpers do

  def msg_router(msg)

    case msg.MsgType

    when 'text'

      # text message handler

    when 'image'

      # image message handler

    when 'location'

      # location message handler

    when 'link'

      # link message handler

    when 'event'

      # event messge handler

    when 'voice'

      # voice message handler

    when 'video'

      # video message handler

    else

      Weixin.text_msg(msg.ToUserName, msg.FromUserName, '未知消息类型')

    end

  end

end

get '/your_app_root' do

    params[:echostr]

end

post '/your_app_root' do

    content_type :xml, 'charset' => 'utf-8'

    message = request.env[Weixin::Middleware::WEIXIN_MSG]

    logger.info "原始数据: #{request.env[Weixin::Middleware::WEIXIN_MSG_RAW]}"

    

    # handle the message according to your business logic

    msg_router(message) unless message.nil?

end

```

### Padrino下使用

在`Gemfile`里加入:

	gem 'rack-weixin'

在`config/apps.rb`关闭以下两个：

	set :protection, false

	set :protect_from_csrf, false

	

在`app.rb`里加入：

	use Weixin::Middleware, 'your api token', '/your_app_root' 

	configure do

    	  set :wx_id, 'your_weixin_account'

	end

### Rack和Rails ActionController配合下使用

``` ruby

class WeixinController < ActionController::Base

  def index

    params[:echostr]

  end

  def create

    xml_message = request.env[Weixin::Middleware::WEIXIN_MSG]

    raw_message = request.env[Weixin::Middleware::WEIXIN_MSG_RAW]

    Rails.logger.debug "raw_message = " do

      raw_message

    end

    if xml_message.present?

      response_xml = msg_router(xml_message)

      Rails.logger.info "Weixin response_xml = " do

        response_xml

      end

    end

    if response_xml.present?

      render xml: response_xml

    else

      render :nothing => true, :status => 200, :content_type => 'text/html'

    end

  end

  def msg_router(msg)

    case msg.MsgType

      when 'text'

        text_parse(msg)

      when 'image'

        image_parse(msg)

      when 'location'

        location_parse(msg)

      when 'link'

        link_parse(msg)

      when 'event'

        event_parse(msg)

      when 'voice'

        voice_parse(msg)

      when 'video'

        video_parse(msg)

      else

    end

  end

end

```

### Rails before_filter验证消息，用于接入多个微信公众号

``` ruby

class WeixinController < ActionController::Base

  before_filter :check_signature

  def index

    render :text => params[:echostr]

  end

  def create

    raw_msg = env[Weixin::Middleware::POST_BODY].read

    begin

       xml_message = Weixin::Message.factory(raw_msg)

    rescue Exception => e

      message = "weixin post message error!"

      Rails.logger.error "#{message} params = " do

        params

      end

    end

    

    Rails.logger.debug "raw_message = " do

      raw_message

    end

    if xml_message.present?

      response_xml = msg_router(xml_message)

      Rails.logger.info "Weixin response_xml = " do

        response_xml

      end

    end

    if response_xml.present?

      render xml: response_xml

    else

      render :nothing => true, :status => 200, :content_type => 'text/html'

    end

  end

  private

  def msg_router(msg)

    case msg.MsgType

      when 'text'

        text_parse(msg)

      when 'image'

        image_parse(msg)

      when 'location'

        location_parse(msg)

      when 'link'

        link_parse(msg)

      when 'event'

        event_parse(msg)

      when 'voice'

        voice_parse(msg)

      when 'video'

        video_parse(msg)

      else

    end

  end

  def check_signature

    fullpath = "#{request.protocol + request.host_with_port + request.path}"

    Rails.logger.debug "fullpath = " do

      fullpath

    end

    # 根据fullpath查询不同的token

    # token = query_token_by_fullpath(fullpath)

    Rails.logger.debug "token = " do

      token

    end

    if token.present? && Weixin::Middleware.request_is_valid?(token, params)

    else

      Rails.logger.error "token is null or request_is_valid! params = " do

        params

      end

      render :status => 401

    end

  end

end

```

### 微信接口

初始化Weixin::Client

``` ruby

client = Weixin::Client.new('your_weixin_app_key', 'your_weixin_app_secret')

```

[获取access token](http://mp.weixin.qq.com/wiki/index.php?title=%E8%8E%B7%E5%8F%96access_token)

``` ruby

client.access_token

```

[获取用户基本信息](http://mp.weixin.qq.com/wiki/index.php?title=%E8%8E%B7%E5%8F%96%E7%94%A8%E6%88%B7%E5%9F%BA%E6%9C%AC%E4%BF%A1%E6%81%AF)

``` ruby

client.user.info('openid')

```

[发送客服消息](http://mp.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E5%AE%A2%E6%9C%8D%E6%B6%88%E6%81%AF)

``` ruby

# 发送文本消息

message = <"OPENID", "msgtype"=>"text", "text"=>{"content"=>"Hello World"}} 

client.message_custom.send(message)

# 发送图片消息

message = <"OPENID", "msgtype"=>"image", "image"=>{"media_id"=>"MEDIA_ID"}}

client.message_custom.send(message)

# 发送语音消息

message = <"OPENID", "msgtype"=>"voice", "voice"=>{"media_id"=>"MEDIA_ID"}}

client.message_custom.send(message)

# 发送视频消息

message = <"OPENID", "msgtype"=>"video", "video"=>{"media_id"=>"MEDIA_ID", "title"=>"TITLE", "description"=>"DESCRIPTION"}}

client.message_custom.send(message)

# 发送音乐消息

message = <"OPENID", "msgtype"=>"music", "music"=>{"title"=>"MUSIC_TITLE", "description"=>"MUSIC_DESCRIPTION", "musicurl"=>"MUSIC_URL", "hqmusicurl"=>"HQ_MUSIC_URL", "thumb_media_id"=>"THUMB_MEDIA_ID"}}

client.message_custom.send(message)

# 发送图文消息

message = <"OPENID", "msgtype"=>"news", "news"=>{"articles"=>[{"title"=>"Happy Day", "description"=>"Is Really A Happy Day", "url"=>"URL", "picurl"=>"PIC_URL"}, {"title"=>"Happy Day", "description"=>"Is Really A Happy Day", "url"=>"URL", "picurl"=>"PIC_URL"}]}} 

client.message_custom.send(message)

```

[自定义菜单创建接口](http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E5%88%9B%E5%BB%BA%E6%8E%A5%E5%8F%A3)

``` ruby

menu_string = <[{"type"=>"click", "name"=>"今日歌曲", "key"=>"V1001_TODAY_MUSIC"}, {"type"=>"click", "name"=>"歌手简介", "key"=>"V1001_TODAY_SINGER"}, {"name"=>"菜单", "sub_button"=>[{"type"=>"view", "name"=>"搜索", "url"=>"http://www.soso.com/"}, {"type"=>"view", "name"=>"视频", "url"=>"http://v.qq.com/"}, {"type"=>"click", "name"=>"赞一下我们", "key"=>"V1001_GOOD"}]}]} 

menu.add(menu_hash)

```

[自定义菜单查询接口](http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E6%9F%A5%E8%AF%A2%E6%8E%A5%E5%8F%A3)

``` ruby

menu = Weixin::Menu.new('your_weixin_app_key', 'your_weixin_app_secret')

menu.get

```

[自定义菜单删除接口](http://mp.weixin.qq.com/wiki/index.php?title=%E8%87%AA%E5%AE%9A%E4%B9%89%E8%8F%9C%E5%8D%95%E5%88%A0%E9%99%A4%E6%8E%A5%E5%8F%A3)

``` ruby

menu.delete

```

TODO

----

Copyright

---------

Permission is hereby granted, free of charge, to any person obtaining a copy

of this software and associated documentation files (the "Software"), to

deal in the Software without restriction, including without limitation the

rights to use, copy, modify, merge, publish, distribute, sublicense, and/or

sell copies of the Software, and to permit persons to whom the Software is

furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in

all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL

THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 

IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/wolfg1969/rack-weixin/trend.png)](https://bitdeli.com/free "Bitdeli Badge")