wei-backend 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: efd7c139fbed96e67acc306ca3ead44d1b86cbde
-  data.tar.gz: d237dceed8014aa44670e6ab152c5b01a95dad05
+  metadata.gz: 23dbcfa965bc6620b9c97fa48fbc177cdd3a3c1b
+  data.tar.gz: 6b06a2ffe5d7d029f1b5fbae6982fcfc123a22ac
 SHA512:
-  metadata.gz: 6858cfc02322e9f18a3c5bc332b112ec6d66f0ff54ce6240aa52bf56faff531ec85e6a1a1592520422030f7bf95f5bbbf59ae6db691fa5fcffba18ae634a232d
-  data.tar.gz: 2f926684b91a5d02f79acedca03dbb201b3c9204a0022381cd80d9ff02c6aa5a39fcf4ff59559c6e95d625e937e0302199f2631eb92c7edc326cf6a8b30b62cf
+  metadata.gz: 35a59017b78eb7949354ba531d4dcef446ca2a3758f51e1597a057d03c81ba7b6b46d5b203c850bdc5a94dd46019c77142294a364c6718ad294a6e39442c4fad
+  data.tar.gz: 84d270c3beaa61d60bde04e396cf4c542912cf592e38ce3e9f5652d5936a3c13c575a783213461c1c844a29cfdcddcba870a0f4bd58e848b8f9def598e58b806

data/README.md

@@ -1,17 +1,54 @@
-微信公众平台后台框架
-========
-## 如何安装:
-* ### 使用bundler
-	将`wei-backend`添加到`Gemfile`里：
+## 微信公众平台后台框架
+微信公众平台 后台框架，基于sinatra，使用DSL的思想帮助你以最快的**速度**开启微信公众平台开发. 
+
+## 仅需3步,一个文件创建一个微信后台程序
+1. 安装Gem
+
+		gem install 'wei-backend'
+
+1. 创建微信后台主程序**app.rb**, 内容如下：
 	
-		gem 'wei-backend'
+		require 'sinatra'
+		require 'wei-backend'
+		
+		on_text do
+			"你发送了如下内容: #{params[:Content]}!!"
+		end
+			
+		on_subscribe do
+			"感谢您的订阅"
+		end
+			
+		on_unsubscribe do
+			"欢迎您再次订阅"
+		end
+
+1. 启动	
+
+		ruby app.rb		
+
+## 与微信接口兼容情况：
 
-* ### 使用`gem`直接安装：
+* 现在可以处理的消息类型（被动接受用户消息类型）：
 
-		gem install wei-backend
+	| 消息类型 | 接口 |
+	| ------------ | ------------- |
+	| 文本消息 | on_text  |
+	| 订阅事件 | on_subscribe  |
+	| 取消订阅事件 | on_unsubscribe  |
+	| 用户被动分享地理位置 | on_location  |
+
+	后续还会加入消息类型支持
+
+* 可以发送的消息类型：
+
+	| 消息类型 | 格式 |
+	| ------------ | ------------- |
+	| 文本消息 | ruby 字符串  |
+	| 图文事件 | ruby hash值  |
 
 ## 如何使用
-* 创建一个文件，如app.js，写入如下内容：
+* 创建一个文件，如app.rb，写入如下内容：
 
 		require ‘sinatra’
 		require 'wei-backend'
@@ -53,8 +90,9 @@ EOF
 	```
 	
 ## 接口说明：
+各个接口只能定义一次，重复定义会覆盖之前定义的接口
 		
-1. ### on_text
+* ### on_text
 当用户向微信公众发送消息的时候，微信会POST一段XML到公众号的后台服务器，`on_text`方法中定义的代码会处理这个请求，这`on_text`方法中可以访问到的请求参数：
 
 	* `params[:ToUserName]`: 发送请求的用户
@@ -63,17 +101,27 @@ EOF
 	* `params[:MsgType]`: 消息类型，在这里是text
 	* `params[:Content]`: 消息内容
 
-1. ### on_event
-处理微信发送过来的event请求:
+* ### on_subscribe
+当用户关注时，处理消息的接口:
+
+	* `params[:ToUserName]`: 发送请求的用户
+	* `params[:FromUserName]`: 公众号用户
+	* `params[:CreateTime]`: 创建时间
+	* `params[:MsgType]`: 消息类型，在这里是event
+	* `params[:Event]`: 事件类型，_**subscribe**_
+
+* ### on_unsubscribe
+当用户取消关注时，处理消息的接口:
 
 	* `params[:ToUserName]`: 发送请求的用户
 	* `params[:FromUserName]`: 公众号用户
 	* `params[:CreateTime]`: 创建时间
 	* `params[:MsgType]`: 消息类型，在这里是event
-	* `params[:Event]`: 消息内容，如_**subscribe**_, _**unsubscribe**_
+	* `params[:Event]`: 事件类型，_**unsubscribe**_
+
 
 
-1. ### on_location
+* ### on_location
 当用户想微信公众号分享位置信息时，微信会POST相应的位置信息到公众号后台服务器		
 	* `params[:ToUserName]`: 发送请求的用户
 	* `params[:FromUserName]`: 公众号用户
@@ -81,4 +129,31 @@ EOF
 	* `params[:MsgType]`: 消息类型，在这里是location
 	* `params[:Latitude]`: 地理位置纬度
 	* `params[:Longitude]`: 地理位置经度				* `params[:Precision]`: 地理位置精度
-		 			
+		 			
+## 返回消息
+* 返回文本消息：
+
+		on_text do
+			"Received a text message: #{params[:Content]}!!, and send back a text message!"
+		end
+		
+* 返回图文消息
+
+		on_text do
+          [{
+               :title => '收到一个文本消息，返回两个图文消息',
+               :description => 'desc',
+               :picture_url => 'pic url',
+               :url => 'url'
+           },
+           {
+               :title => '这是第二个图文消息',
+               :description => 'desc1',
+               :picture_url => 'pic url1',
+               :url => 'url1'
+           }]
+		end
+	
+## Liscense
+
+© 2013 Wang Chao. This code is distributed under the MIT license.

data/examples/locations/Gemfile

@@ -0,0 +1,16 @@
+source 'http://rubygems.org'
+
+gem 'thin'
+gem 'hash_validator'
+gem 'wei-backend'
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-html-matchers'
+  gem 'rack-test'
+end
+
+group :development do
+  gem 'rerun'
+  gem 'shotgun'
+end

data/examples/locations/Gemfile.lock

@@ -0,0 +1,93 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capistrano (3.0.1)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 0.0.23)
+    daemons (1.1.9)
+    diff-lcs (1.2.5)
+    eventmachine (1.0.3)
+    ffi (1.9.3)
+    haml (4.0.4)
+      tilt
+    hash_validator (0.2.7)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.9)
+    json (1.8.1)
+    listen (1.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    mini_portile (0.5.2)
+    multi_xml (0.5.5)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.7.0)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rack (1.5.2)
+    rack-protection (1.5.1)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rerun (0.8.2)
+      listen (~> 1.0.3)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-html-matchers (0.4.3)
+      nokogiri (>= 1.4.4)
+      rspec (>= 2.0.0)
+    rspec-mocks (2.14.4)
+    shotgun (0.9)
+      rack (>= 1.0)
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sshkit (1.2.0)
+      net-scp (>= 1.1.2)
+      net-ssh
+      term-ansicolor
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thin (1.6.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 1.0.0)
+      rack (>= 1.0.0)
+    tilt (1.4.1)
+    tins (0.13.1)
+    wei-backend (0.0.2)
+      sinatra (~> 1.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano
+  haml
+  hash_validator
+  httparty
+  json
+  nokogiri
+  rack-test
+  rerun
+  rspec
+  rspec-html-matchers
+  shotgun
+  sinatra
+  thin
+  wei-backend

data/examples/locations/app.rb

@@ -0,0 +1,17 @@
+require 'sinatra'
+require 'wei-backend'
+
+on_location do
+  "You location:\n\t lat: #{params[:Latitude]} \n\t long: #{params[:Longitude]}"
+end
+
+on_subscribe do
+  "Please share your location information"
+end
+
+on_text do
+
+  #"hello world #{params[:Latitude]}"
+  [{:title=>"", :description=>"", :picturl=>"", :url=>""},{:title=>"", :description=>"", :picturl=>"", :url=>""}]
+end
+

data/examples/locations/config.ru

@@ -0,0 +1,12 @@
+require './app'
+
+ENV['RACK_ENV'] ||= development
+
+root_dir = File.dirname(__FILE__)
+
+set :environment, ENV['RACK_ENV'].to_sym
+set :root,        root_dir
+set :app_file,    File.join(root_dir, 'app.rb')
+disable :run
+
+run Sinatra::Application

data/examples/waiting_bus/Gemfile

@@ -0,0 +1,22 @@
+source 'http://rubygems.org'
+
+gem 'json'
+gem 'haml'
+gem 'sinatra'
+gem 'nokogiri'
+gem 'capistrano'
+gem 'httparty'
+gem 'thin'
+gem 'hash_validator'
+gem 'wei-backend'
+
+group :test do
+  gem 'rspec'
+  gem 'rspec-html-matchers'
+  gem 'rack-test'
+end
+
+group :development do
+  gem 'rerun'
+  gem 'shotgun'
+end

data/examples/waiting_bus/Gemfile.lock

@@ -0,0 +1,93 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capistrano (3.0.1)
+      i18n
+      rake (>= 10.0.0)
+      sshkit (>= 0.0.23)
+    daemons (1.1.9)
+    diff-lcs (1.2.5)
+    eventmachine (1.0.3)
+    ffi (1.9.3)
+    haml (4.0.4)
+      tilt
+    hash_validator (0.2.7)
+    httparty (0.12.0)
+      json (~> 1.8)
+      multi_xml (>= 0.5.2)
+    i18n (0.6.9)
+    json (1.8.1)
+    listen (1.0.3)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9)
+      rb-kqueue (>= 0.2)
+    mini_portile (0.5.2)
+    multi_xml (0.5.5)
+    net-scp (1.1.2)
+      net-ssh (>= 2.6.5)
+    net-ssh (2.7.0)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rack (1.5.2)
+    rack-protection (1.5.1)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.1.0)
+    rb-fsevent (0.9.3)
+    rb-inotify (0.9.2)
+      ffi (>= 0.5.0)
+    rb-kqueue (0.2.0)
+      ffi (>= 0.5.0)
+    rerun (0.8.2)
+      listen (~> 1.0.3)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.7)
+    rspec-expectations (2.14.4)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-html-matchers (0.4.3)
+      nokogiri (>= 1.4.4)
+      rspec (>= 2.0.0)
+    rspec-mocks (2.14.4)
+    shotgun (0.9)
+      rack (>= 1.0)
+    sinatra (1.4.4)
+      rack (~> 1.4)
+      rack-protection (~> 1.4)
+      tilt (~> 1.3, >= 1.3.4)
+    sshkit (1.2.0)
+      net-scp (>= 1.1.2)
+      net-ssh
+      term-ansicolor
+    term-ansicolor (1.2.2)
+      tins (~> 0.8)
+    thin (1.6.1)
+      daemons (>= 1.0.9)
+      eventmachine (>= 1.0.0)
+      rack (>= 1.0.0)
+    tilt (1.4.1)
+    tins (0.13.1)
+    wei-backend (0.0.2)
+      sinatra (~> 1.4.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capistrano
+  haml
+  hash_validator
+  httparty
+  json
+  nokogiri
+  rack-test
+  rerun
+  rspec
+  rspec-html-matchers
+  shotgun
+  sinatra
+  thin
+  wei-backend

data/lib/wei-backend/base.rb

@@ -40,31 +40,12 @@ module WeiBackend
       }
     end
 
-    def self.on_text &block
-      define_method(:handle_text_message, &block)
-    end
-
-    def self.on_event &block
-      define_method(:handle_event_message, &block)
-    end
-
-    def self.on_voice &block
-      define_method(:handle_voice_message, &block)
-    end
-
-    def self.on_location &block
-      define_method(:handle_location_message, &block)
-    end
-
-    def self.on_subscribe &block
-      define_method(:handle_subscribe_message, &block)
-    end
-
-    def self.on_unsubscribe &block
-      define_method(:handle_unsubscribe_message, &block)
+    %w(text event voice location subscribe unsubscribe).each do |type|
+      define_singleton_method(:"on_#{type}") do |&block|
+        define_method(:"handle_#{type}_message", &block)
+      end
     end
 
-
   end
 
   module Delegator

data/lib/wei-backend/version.rb

@@ -1,3 +1,3 @@
 module WeiBackend
-  VERSION = '0.0.4'
+  VERSION = '0.0.5'
 end

data/spec/spec_helper.rb

@@ -28,7 +28,7 @@ LOCATION_EVENT_REQUEST='<xml>
 
 SUBSCRIBE_EVENT_REQUEST='<xml>
 	<ToUserName><![CDATA[toUser]]></ToUserName>
-	<FromUserName><![CDATA[FromUser]]></FromUserName>
+	<FromUserName><![CDATA[fromUser]]></FromUserName>
 	<CreateTime>123456789</CreateTime>
 	<MsgType><![CDATA[event]]></MsgType>
 	<Event><![CDATA[subscribe]]></Event>

data/spec/wei_backend_spec.rb

@@ -29,8 +29,18 @@ describe 'app' do
 
   it 'should return news message when receive a text request message and user defined a multi-news' do
     WeiBackend::MessageDispatcher.on_text do
-      [{:title => 'title', :description => 'desc', :picture_url => 'pic url', :url => 'url'},
-      {:title => 'title1', :description => 'desc1', :picture_url => 'pic url1', :url => 'url1'}]
+          [{
+               :title => 'title',
+               :description => 'desc',
+               :picture_url => 'pic url',
+               :url => 'url'
+           },
+           {
+               :title => 'title1',
+               :description => 'desc1',
+               :picture_url => 'pic url1',
+               :url => 'url1'
+           }]
     end
 
     post '/', TEXT_MESSAGE_REQUEST, 'CONTENT_TYPE' => 'text/xml'
@@ -54,7 +64,7 @@ describe 'app' do
       'Thank you for subscribe!'
     end
 
-    post '/', LOCATION_EVENT_REQUEST, 'CONTENT_TYPE' => 'text/xml'
+    post '/', SUBSCRIBE_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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wei-backend
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - Wang Chao
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-10 00:00:00.000000000 Z
+date: 2013-12-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
@@ -76,6 +76,12 @@ files:
 - Gemfile
 - Gemfile.lock
 - README.md
+- examples/locations/Gemfile
+- examples/locations/Gemfile.lock
+- examples/locations/app.rb
+- examples/locations/config.ru
+- examples/waiting_bus/Gemfile
+- examples/waiting_bus/Gemfile.lock
 - examples/waiting_bus/Rakefile
 - examples/waiting_bus/ai_bang_client.rb
 - examples/waiting_bus/app.rb