wei-backend 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89c1731dc45e222e2af055b01d36d25ad34cfa71
-  data.tar.gz: 0d958cec757c981191d472fc29aebdac9bc42c43
+  metadata.gz: c3f0021088d9e698689cd29d21e80aaff92c7471
+  data.tar.gz: 93e01ff4fde62445cef476919c502f9759374d03
 SHA512:
-  metadata.gz: bd00720f925a9843733ac78cd680b55c2846a6d9d72555d7a3e7e40b814cb12ae468494bdb37c7d8eec5d177bd137e4b8f5db04ada1fa247616ec6be3dd34f16
-  data.tar.gz: 8c680f884c42ab2c0840bb53ef53b093566f95dbb2d761aacae32755c7ac9f2cfa8c93cf6989b0c81be0a506cb03402626413c27cae3f685f887a6724d8a623f
+  metadata.gz: 4b2177cd5fa8259c5c344fcdae4e94c343d6cd3253e1ddcbe64b83f04d515be5e43cef3fcb64d90dec24acc0a6b708b374c3392b93d874d1e4bfbcdea32988a4
+  data.tar.gz: 20dbec32ec7eea7d8b0d45d3d7e6ce8a09f4f52d3aa398fd5c56e4cd85550e1fa715ff7204eaa144b1812ec11e619909e836b0c91555591395c2cae2406bf0fd

data/README.md

@@ -1,23 +1,84 @@
 微信公众平台后台框架
 ========
-## Ruby version:
-**ruby-2.0.0-p247**
+## 如何安装:
+* ### 使用bundler
+	将`wei-backend`添加到`Gemfile`里：
+	
+		gem 'wei-backend'
 
-可以使用[rvm](http://rvm.io)安装：
+* ### 使用`gem`直接安装：
 
-	rvm install ruby-2.0.0-p247
+		gem install wei-backend
+
+## 如何使用
+* 创建一个文件，如app.js，写入如下内容：
+
+		require ‘sinatra’
+		require 'wei-backend'
+		
+		on_text do
+			"Received a text message: #{params[:Content]}!!, and send back a text message!"
+		end
 
-## 如何定制
 * 启动
  
-		git clone https://github.com/charleyw/weixin-sinatra.git
-		bundle install
-		rake dev:start 
-* 所有的业务逻辑可以查看`lib/wei_xin_request_handler`		
+		ruby app.rb
+* 测试
+
+	```
+curl -H 'Content-type:text/xml' -d@- localhost:4567 << EOF
+	<xml>
+	 <ToUserName><![CDATA[toUser]]></ToUserName>
+	 <FromUserName><![CDATA[fromUser]]></FromUserName> 
+	 <CreateTime>1348831860</CreateTime>
+	 <MsgType><![CDATA[text]]></MsgType>
+	 <Content><![CDATA[This is a text message]]></Content>
+	 <MsgId>1234567890123456</MsgId>
+	</xml>
+EOF
+	
+	```	
+	
+	将会得到一段text返回值，一切OK:
+	
+	```
+<xml>
+	<ToUserName><![CDATA[fromUser]]></ToUserName>
+	<FromUserName><![CDATA[toUser]]></FromUserName>
+	<CreateTime><![CDATA[1386522760]]></CreateTime>
+	<MsgType><![CDATA[text]]></MsgType>
+	<Content><![CDATA[Received a text message: This is a text message!!, and send back a text message!]]></Content>
+</xml>
+
+	```
+	
+## 接口说明：
+		
+1. ### on_text
+当用户向微信公众发送消息的时候，微信会POST一段XML到公众号的后台服务器，`on_text`方法中定义的代码会处理这个请求，这`on_text`方法中可以访问到的请求参数：
+
+	* `params[:ToUserName]`: 发送请求的用户
+	* `params[:FromUserName]`: 公众号用户
+	* `params[:CreateTime]`: 创建时间
+	* `params[:MsgType]`: 消息类型，在这里是text
+	* `params[:Content]`: 消息内容
+
+1. ### on_event
+处理微信发送过来的event请求:
+
+	* `params[:ToUserName]`: 发送请求的用户
+	* `params[:FromUserName]`: 公众号用户
+	* `params[:CreateTime]`: 创建时间
+	* `params[:MsgType]`: 消息类型，在这里是event
+	* `params[:Event]`: 消息内容，如_**subscribe**_, _**unsubscribe**_
 
-访问`http://localhost:9393?echostr=test`,页面会显示**echostr**的值
 
-## 如何部署
-	git clone https://github.com/charleyw/weixin-sinatra.git
-	bundle install
-	rake prod:start
+1. ### on_location
+当用户想微信公众号分享位置信息时，微信会POST相应的位置信息到公众号后台服务器		
+	* `params[:ToUserName]`: 发送请求的用户
+	* `params[:FromUserName]`: 公众号用户
+	* `params[:CreateTime]`: 创建时间
+	* `params[:MsgType]`: 消息类型，在这里是location
+	* `params[:Latitude]`: 地理位置纬度
+	* `params[:Longitude]`: 地理位置经度				* `params[:Precision]`: 地理位置精度
+		 			

data/lib/wei-backend/base.rb

@@ -8,6 +8,10 @@ module WeiBackend
       create_model results
     end
 
+    def handle_event_message
+      send(:"handle_#{params[:Event].downcase}_message")
+    end
+
     def create_model data
       data.is_a?(Hash) || data.is_a?(Array) ? image_text_message(data) : text_message(data)
     end
@@ -52,6 +56,14 @@ module WeiBackend
       define_method(:handle_location_message, &block)
     end
 
+    def self.on_subscribe &block
+      define_method(:handle_location_message, &block)
+    end
+
+    def self.on_unsubscribe &block
+      define_method(:handle_location_message, &block)
+    end
+
 
   end
 
@@ -65,7 +77,7 @@ module WeiBackend
       end
     end
 
-    delegate :on_text, :on_event, :on_voice, :on_location
+    delegate :on_text, :on_event, :on_voice, :on_location, :on_subscribe, :on_unsubscribe
 
     class << self
       attr_accessor :target

data/lib/wei-backend/version.rb

@@ -1,3 +1,3 @@
 module WeiBackend
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/spec_helper.rb

@@ -15,6 +15,25 @@ EVENT_MESSAGE_REQUEST='<xml><ToUserName><![CDATA[toUser]]></ToUserName>'+
     '<FromUserName><![CDATA[fromUser]]></FromUserName><CreateTime>123456789</CreateTime>'+
     '<MsgType><![CDATA[event]]></MsgType><Event><![CDATA[subscribe]]></Event></xml>'
 
+LOCATION_EVENT_REQUEST='<xml>
+	<ToUserName><![CDATA[toUser]]></ToUserName>
+	<FromUserName><![CDATA[fromUser]]></FromUserName>
+	<CreateTime>123456789</CreateTime>
+	<MsgType><![CDATA[event]]></MsgType>
+	<Event><![CDATA[LOCATION]]></Event>
+	<Latitude>23.137466</Latitude>
+	<Longitude>113.352425</Longitude>
+	<Precision>119.385040</Precision>
+</xml>'
+
+SUBSCRIBE_EVENT_REQUEST='<xml>
+	<ToUserName><![CDATA[toUser]]></ToUserName>
+	<FromUserName><![CDATA[FromUser]]></FromUserName>
+	<CreateTime>123456789</CreateTime>
+	<MsgType><![CDATA[event]]></MsgType>
+	<Event><![CDATA[subscribe]]></Event>
+</xml>'
+
 PARSED_PARAMS={
     :ToUserName => 'toUser',
     :FromUserName => 'fromUser',

data/spec/wei_backend_spec.rb

@@ -39,14 +39,24 @@ describe 'app' do
     last_response.body.should include '<Title><![CDATA[title1]]></Title>'
   end
 
-  it 'should echo event request message when receive a event message' do
-    WeiBackend::MessageDispatcher.on_event do
-      'hello event'
+  it 'should echo location message when receive a location event message' do
+    WeiBackend::MessageDispatcher.on_location do
+      "location event: #{params[:Latitude]}"
     end
 
-    post '/', EVENT_MESSAGE_REQUEST, 'CONTENT_TYPE' => 'text/xml'
+    post '/', LOCATION_EVENT_REQUEST, 'CONTENT_TYPE' => 'text/xml'
     last_response.body.should include '<ToUserName><![CDATA[fromUser]]></ToUserName>'
-    last_response.body.should include '<Content><![CDATA[hello event]]></Content>'
+    last_response.body.should include '<Content><![CDATA[location event: 23.137466]]></Content>'
+  end
+
+  it 'should echo location message when receive a location event message' do
+    WeiBackend::MessageDispatcher.on_subscribe do
+      'Thank you for subscribe!'
+    end
+
+    post '/', LOCATION_EVENT_REQUEST, 'CONTENT_TYPE' => 'text/xml'
+    last_response.body.should include '<ToUserName><![CDATA[fromUser]]></ToUserName>'
+    last_response.body.should include '<Content><![CDATA[Thank you for subscribe!]]></Content>'
   end
 
 end

data/wei-backend.gemspec

@@ -0,0 +1,15 @@
+$LOAD_PATH.unshift File.expand_path('../lib', __FILE__)
+require 'wei-backend/version'
+
+Gem::Specification.new 'wei-backend', WeiBackend::VERSION do |s|
+  s.description       = 'wei-backend is a DSL for quickly creating weixin open platform backend system.'
+  s.summary           = 'Best DSL for weixin development'
+  s.authors           = ['Wang Chao']
+  s.email             = 'cwang8023@gmail.com'
+  s.homepage          = 'https://github.com/charleyw/weixin-sinatra'
+  s.license           = 'MIT'
+  s.files             = `git ls-files`.split("\n") - %w[.gitignore .travis.yml .ruby-version .ruby-gemset]
+  s.test_files        = s.files.select { |p| p =~ /^spec\/.*_spec.rb/ }
+
+  s.add_dependency 'sinatra', '~> 1.4.4'
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wei-backend
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Wang Chao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-08 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -34,7 +34,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
-- Rakefile
+- examples/waiting_bus/Rakefile
 - examples/waiting_bus/ai_bang_client.rb
 - examples/waiting_bus/app.rb
 - examples/waiting_bus/bus_helper.rb
@@ -56,7 +56,8 @@ files:
 - spec/wei_backend_spec.rb
 - spec/wei_backend_utils_spec.rb
 - spec/weixin_message_handler_spec.rb
-homepage: 
+- wei-backend.gemspec
+homepage: https://github.com/charleyw/weixin-sinatra
 licenses:
 - MIT
 metadata: {}