sinatra-wechat 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9f5f6095ebdc047a6f9b4ab8e1c18deb9eb5da15
-  data.tar.gz: b1404892968fb949f40caee255de6e2f6a88355a
+  metadata.gz: 86233c3037ef8bd2e6d48fa0d321aa6a4279e41f
+  data.tar.gz: 2d2eb697ffa61f47e149a4718c0b21b4dbdb7212
 SHA512:
-  metadata.gz: 2cc6dc338939d72ce8115828813fae4e2ccca02652eb026397b435e016fdeeb02a830717dfff0be80ef707d857f21d99bb5b1acb6f1284d8e1bff8ed353e4714
-  data.tar.gz: 5266b028367585f2b96f290e8cd0177ba0aa73be2b987642ae60e284a44d7fecfe3268442511d4876a659ce0cfec33c56e7ac823b5e07a9b07ded6f15dc67753
+  metadata.gz: 97f9ff1ed899844dd1aef81127b765b8b14e783b132e77e594facc8864fdd2a90f2261aaf50f39c9edf75ee147108ad62edfc45d0a2ddce63e73e3be97e47a26
+  data.tar.gz: fe24ff24774e0c9d15c3efc4eb7e284d9704ab6fa5e73f38a65ada3ec45cba63c18b3c6856990b71f654b3aea7ac3c02e9dc7f6212e42ea9fa044fbde3bf1776

data/README.md

@@ -12,14 +12,14 @@ This extension is used to support [Tencent Wechat](https://mp.weixin.qq.com/) ra
 # Usage
 
 Below code implement a simple wechat robot, reply text `你好` when message sent by end user contains number `%r{\d+}`.
-> use `:message_validation => false` to disable wechat message validation, otherwise need to append signature to the URL. The default value of `:message_validation` is `true`
+> use `:validate_msg => false` to disable wechat message validation, otherwise need to append signature to the URL. The default value of `:validate_msg` is `true`
 
 ```ruby
 # app.rb
 require 'sinatra'
 require 'sinatra/wechat'
 
-wechat('/', :wechat_token => 'test-token', :message_validation => false) {
+wechat('/', :wechat_token => 'test-token', :validate_msg => false) {
   text(:content => %r{\d+}) {
   	content_type 'application/xml'
   	erb :hello, :locals => request[:wechat_values]

data/examples/wechat_example.rb

@@ -17,7 +17,7 @@ location_event_reply = proc {
   builder.to_xml
 }
 
-wechat('/wechat', :wechat_token => 'test-token', :message_validation => false) {
+wechat('/wechat', :wechat_token => 'test-token', :validate_msg => false) {
   location {
     instance_eval &location_event_reply
   }

data/lib/sinatra/version.rb

@@ -1,5 +1,5 @@
 module Sinatra
   module Wechat
-    VERSION = "0.0.2"
+    VERSION = "0.1.0"
   end
 end

data/lib/sinatra/wechat.rb

@@ -1,65 +1,65 @@
-require 'sinatra/base'
-require 'blankslate'
-require 'nokogiri'
+['sinatra/base', 'blankslate', 'nokogiri'].each { |m| require m }
 
 module Sinatra
   module Wechat
-    module EndpointActions
-      class WechatDispatcher < ::BlankSlate
-        attr_reader :wechat_token, :verfiy_message
-        def initialize
-          super
+    module Endpoint
+      # Work as a Ruby Builder, treat every Wechat 'MsgType' as method name
+      # the method arguments are the Wechat message it self
+      class DispatcherBuilder < ::BlankSlate
+        def initialize(&block)
           @message_handlers = {}
+          instance_eval(&block) if block_given?
         end
 
-        def method_missing(sym, *args, &block)
+        # resp_blk is used to generate HTTP response, need to eval in Sinatra context
+        def method_missing(sym, *args, &resp_blk)
           @message_handlers[sym] ||= []
-          matchers = args.collect do |v|
-            if v.respond_to?(:call) then lambda { |values| v.call(values) }
+          matchers = args.collect do |arg|
+            if arg.respond_to?(:call) then lambda &arg
             # for named parameters
-            elsif v.respond_to?(:all?) then lambda { |values| v.all? { |k,v| v === values[k]} }
+            elsif arg.respond_to?(:all?) then lambda { |values| arg.all? { |k,v| v === values[k]} }
             else raise TypeError, "\"#{v} (#{v.class})\" is not an acceptable condition"
-            end 
+            end
           end
-          matcher = lambda do |values| 
-            matchers.all? {|m| m.call(values)}
-          end
-          @message_handlers[sym] << [ matcher, block ]
+          matcher = lambda { |values| matchers.all? { |m| m.call(values) } }
+          @message_handlers[sym] << [ matcher, resp_blk ]
         end
 
-        def route!(values)
-          type = values[:msg_type].to_sym
-          handlers = @message_handlers[type] || []
-          _, handler = handlers.find { |m, _| m.call(values) }
-          handler
+        def dispatch!(values)
+          return nil unless msg_type = values[:msg_type]
+          handlers = @message_handlers[msg_type.to_sym] || []
+          handlers.find { |m, _| m.call(values) }
         end
       end
 
-      def wechat(endpoint = '/', wechat_token: '', message_validation: true, &block)
-        dispatcher = WechatDispatcher.new
-        dispatcher.instance_eval &block
+      def wechat(endpoint = '/', wechat_token: '', validate_msg: true, &block)
+        before endpoint do
+          if validate_msg then
+            raw = [wechat_token, params[:timestamp], params[:nonce]].compact.sort.join
+            halt 403 unless Digest::SHA1.hexdigest(raw) == params[:signature]
+          end
+        end
 
         get endpoint do
-          halt 403 unless validate_messages(wechat_token) if message_validation
           content_type 'text/plain'
           params[:echostr]
         end
 
-        post endpoint do
-          halt 403 unless validate_messages(wechat_token) if message_validation
+        dispatcher = DispatcherBuilder.new(&block)
 
+        post endpoint do
           body = request.body.read || ""
-          halt 501 if body.empty?
+          halt 400 if body.empty?  # bad request, cannot handle this kind of message
 
-          doc = Nokogiri::XML(body).root
-          values = doc.element_children.each_with_object(Hash.new) do |e, v|
+          xmldoc = Nokogiri::XML(body).root
+          values = xmldoc.element_children.each_with_object(Hash.new) do |e, v|
             name = e.name.gsub(/(.)([A-Z])/,'\1_\2').downcase
             # rename 'Location_X' to 'location__x' then to 'location_x'
             name = name.gsub(/(_{2,})/,'_')
             v[name.to_sym] = e.content
           end
-          handler = dispatcher.route!(values)
-          halt 501 unless handler
+          _, handler = dispatcher.dispatch!(values)
+          halt 404 unless handler
 
           request[:wechat_values] = values
           instance_eval(&handler)
@@ -68,18 +68,11 @@ module Sinatra
       end
     end
 
-    def self.registered(app)
-      app.extend(Wechat::EndpointActions)
-      app.helpers do
-        def validate_messages token
-          raw = [token, params[:timestamp], params[:nonce]].compact.sort.join
-          Digest::SHA1.hexdigest(raw) == params[:signature]
-        end
-      end
-      # expose to classic style
-      Delegator.delegate(:wechat)
+    def self.registered(application)
+      application.extend(Wechat::Endpoint)
+      Sinatra::Delegator.delegate(:wechat) # expose wechat method to classic style
     end
   end
 
-  register Wechat
+  register Sinatra::Wechat
 end

data/sinatra-wechat.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors            = ["Lu, Jun"]
   spec.email              = ["luj1985@gmail.com"]
   spec.summary            = "Sinatra extension for Tencent Wechat"
-  spec.description        = "Provide Extensible Sinatra API to support Wechat development mode"
+  spec.description        = "Provide extensible Sinatra API to support rapid Wechat development"
   spec.homepage           = "https://github.com/luj1985/sinatra-wechat"
   spec.license            = "MIT"
 

data/spec/spec_helper.rb

@@ -8,3 +8,7 @@ require 'sinatra'
 require 'sinatra/wechat'
 
 set :environment, :test
+
+RSpec.configure do |conf|
+  conf.include Rack::Test::Methods
+end

data/spec/wechat_spec.rb

@@ -1,48 +1,36 @@
-require File.expand_path '../spec_helper.rb', __FILE__
+require_relative 'spec_helper'
 
 describe Sinatra::Wechat do
-  include Rack::Test::Methods
 
-  it "GET should have message verification" do
-    def app
-      instance = Sinatra.new do
-        register Sinatra::Wechat
-      end
-      instance.wechat(:wechat_token => 'test-token') { }
-    end
+  let (:app) { Sinatra.new { register Sinatra::Wechat } }
+
+  it "should have message validation on GET method" do
+    app.wechat(:wechat_token => 'test-token')
 
     get '/'
     expect(last_response.status).to eq(403)
 
-    get '/', {:timestamp => '201407191804', 
-              :nonce => 'nonce', 
-              :signature => '9a91a1cea1cb60b87a9abb29dae06dce14721258',
-              :echostr => 'echo string'}
-    expect(last_response.status).to eq(200)
+    get '/', {
+      :timestamp => '201407191804', 
+      :nonce => 'nonce', 
+      :signature => '9a91a1cea1cb60b87a9abb29dae06dce14721258',
+      :echostr => 'echo string'
+    }
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('echo string')
   end
 
   it "Can disable message validation" do
-    def app
-      instance = Sinatra.new do
-        register Sinatra::Wechat
-      end
-      instance.wechat(:message_validation => false) { }
-    end
+    app.wechat(:validate_msg => false)
 
-    get '/'
-    expect(last_response.status).to eq(200)
+    get '/', { :echostr => 'echo' }
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('echo')
   end
 
-  it "POST should have message verification" do
-    def app
-      instance = Sinatra.new do
-        register Sinatra::Wechat
-      end
-      instance.wechat(:wechat_token => 'test-token') {
-        text { 'text response' }
-      }
-    end
+  it "should have message validation on POST method" do
+    app.wechat(:wechat_token => 'test-token') { text { 'text response' } }
+
     post '/'
     expect(last_response.status).to eq(403)
 
@@ -58,19 +46,13 @@ describe Sinatra::Wechat do
     EOF
 
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', body
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('text response')
   end
 
   it "can switch wechat endpoint" do
-    def app
-      instance = Sinatra.new do
-        register Sinatra::Wechat
-      end
-      instance.wechat('/wechat', :wechat_token => 'test-token') {
-        image { 'relocated response' }
-      }
-    end
+    app.wechat('/wechat', :wechat_token => 'test-token') { image { 'relocated response' } }
+
     body = <<-EOF
       <xml>
       <ToUserName><![CDATA[toUser]]></ToUserName>
@@ -87,30 +69,25 @@ describe Sinatra::Wechat do
     expect(last_response.status).to eq(404)
 
     post '/wechat?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', body
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('relocated response')
     
   end
 
   it "should accept wechat message push" do
-    def app
-      instance = Sinatra.new do
-        register Sinatra::Wechat
-      end
-      instance.wechat(:wechat_token => 'test-token') {
-        text(:content => %r{regex match}) { 'regex match' }
-        text(lambda {|values| values[:content] == 'function match'}) { 'function match' }
-        text { 'default match' }
-        voice {
-          values = request[:wechat_values]
-          values[:msg_id]
-        }
-        location {
-          values = request[:wechat_values]
-          values[:label]
-        }
+    app.wechat(:wechat_token => 'test-token') {
+      text(:content => %r{regex match}) { 'regex match' }
+      text(lambda {|values| values[:content] == 'function match'}) { 'function match' }
+      text { 'default match' }
+      voice {
+        values = request[:wechat_values]
+        values[:msg_id]
+      }
+      location {
+        values = request[:wechat_values]
+        values[:label]
       }
-    end
+    }
 
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
       <xml>
@@ -122,10 +99,9 @@ describe Sinatra::Wechat do
       <MsgId>1234567890123456</MsgId>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('regex match')
 
-
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
       <xml>
       <ToUserName>tousername</ToUserName>
@@ -136,10 +112,9 @@ describe Sinatra::Wechat do
       <MsgId>1234567890123456</MsgId>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('function match')
 
-
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
       <xml>
       <ToUserName>tousername</ToUserName>
@@ -150,10 +125,9 @@ describe Sinatra::Wechat do
       <MsgId>1234567890123456</MsgId>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('default match')
 
-
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
       <xml>
       <ToUserName><![CDATA[toUser]]></ToUserName>
@@ -165,7 +139,7 @@ describe Sinatra::Wechat do
       <MsgId>1234567890123456</MsgId>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('1234567890123456')
 
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
@@ -181,7 +155,7 @@ describe Sinatra::Wechat do
       <MsgId>1234567890123456</MsgId>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('位置信息')
 
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
@@ -189,21 +163,16 @@ describe Sinatra::Wechat do
       <MsgType>unknown</MsgType>
       </xml>
     EOF
-    expect(last_response.status).to eq(501)
+    expect(last_response.status).to eq(404)
   end
 
   it "should accept complex match" do
-    def app
-      instance = Sinatra.new do
-        register Sinatra::Wechat
-      end
-      instance.wechat(:wechat_token => 'test-token') {
-        future(lambda {|vs| vs[:to_user_name] == 'test' }, :content => %r{future}, :create_time => '1348831860') {
-          'complex match'
-        }
-        range(:to_user_name => 'tesa'..'testz') { 'range match' }
+    app.wechat(:wechat_token => 'test-token') {
+      future(lambda {|vs| vs[:to_user_name] == 'test' }, :content => %r{future}, :create_time => '1348831860') {
+        'complex match'
       }
-    end
+      range(:to_user_name => 'tesa'..'testz') { 'range match' }
+    }
 
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
       <xml>
@@ -215,51 +184,41 @@ describe Sinatra::Wechat do
       <MsgId>1234567890123456</MsgId>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('complex match')
 
-
-
     post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
       <xml>
       <ToUserName>test</ToUserName>
       <MsgType>range</MsgType>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('range match')
   end
 
   it "should raise error when invalid condition set" do
-    instance = Sinatra.new do
-      register Sinatra::Wechat
-    end
     expect {
-      instance.wechat(:wechat_token => 'test-token') {
+      app.wechat(:wechat_token => 'test-token') {
         future('invalid condition') { 'complex match' }
       }
     }.to raise_exception
   end
 
   it "can have multiple endpoint" do
-    def app
-      instance = Sinatra.new do
-        register Sinatra::Wechat
+    app.wechat('/wechat1', :wechat_token => 'test-token') {
+      selector = lambda do |values|
+        x = values[:location_x].to_f
+        20 < x && x < 30
       end
-      instance.wechat('/wechat1', :wechat_token => 'test-token') {
-        selector = lambda do |values|
-          x = values[:location_x].to_f
-          20 < x && x < 30
-        end
-        location(selector) { 'matched location range' }
-      }
-      instance.wechat('/wechat2', :wechat_token => 'test') {
-        text { 'this is another wechat endpoint' }
-      }
-      instance.wechat('/wechat3', :wechat_token => 'unknown', :message_validation => false) {
-        text { 'disable message validation' }
-      }
-    end
+      location(selector) { 'matched location range' }
+    }
+    app.wechat('/wechat2', :wechat_token => 'test') {
+      text { 'this is another wechat endpoint' }
+    }
+    app.wechat('/wechat3', :wechat_token => 'unknown', :validate_msg => false) {
+      text { 'disable message validation' }
+    }
 
     post '/wechat1?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
       <xml>
@@ -269,16 +228,14 @@ describe Sinatra::Wechat do
       <Scale>20</Scale>
       </xml>
     EOF
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('matched location range')
 
-
     post '/wechat2?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', '<xml><MsgType>text</MsgType></xml>'
     expect(last_response.status).to eq(403)
 
-
     post '/wechat2?timestamp=201407191804&nonce=nonce&signature=8149d14c72f418819b1eaab851aeab2c308f15cc', '<xml><MsgType>text</MsgType></xml>'
-    expect(last_response.status).to eq(200)
+    expect(last_response).to be_ok
     expect(last_response.body).to eq('this is another wechat endpoint')
 
     get '/wechat3?echostr=return'
@@ -287,6 +244,16 @@ describe Sinatra::Wechat do
 
     post '/wechat3', '<xml><MsgType>text</MsgType></xml>'
     expect(last_response.body).to eq('disable message validation')
+  end
+
+  it "can handle bad formatted xml" do
+    app.wechat(:wechat_token => 'test-token') { text { 'bare' } }
 
+    post '/?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
+      <xml>
+      <invalid>message</invalid>>
+      </xml>
+    EOF
+    expect(last_response.status).to eq(404)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-wechat
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Lu, Jun
@@ -122,7 +122,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Provide Extensible Sinatra API to support Wechat development mode
+description: Provide extensible Sinatra API to support rapid Wechat development
 email:
 - luj1985@gmail.com
 executables: []