sinatra-wechat 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f3056a6b2bb8a22c428fd91e3ed597dd54063374
-  data.tar.gz: a50373853d8165e3aa3e8ee10caf6a7aa747d0fa
+  metadata.gz: 9f5f6095ebdc047a6f9b4ab8e1c18deb9eb5da15
+  data.tar.gz: b1404892968fb949f40caee255de6e2f6a88355a
 SHA512:
-  metadata.gz: 336bfb4a2f8f5fd8dcc5c14555bbd0c24170dcbe5bb57906f733bddf61254343f4fbfe4ecc33b9e8f76f3b7b935beea2e664876234c00fcc607cf5a94057d7a0
-  data.tar.gz: 3264fb34bdbdd9bd3bb479fc0ebc5cf0793771655f5dbe29cef37e111e463e15132c761b625ee3b5236fb86a0d41f8a86a09b3d7bef6e50c866a19d29b7eea6c
+  metadata.gz: 2cc6dc338939d72ce8115828813fae4e2ccca02652eb026397b435e016fdeeb02a830717dfff0be80ef707d857f21d99bb5b1acb6f1284d8e1bff8ed353e4714
+  data.tar.gz: 5266b028367585f2b96f290e8cd0177ba0aa73be2b987642ae60e284a44d7fecfe3268442511d4876a659ce0cfec33c56e7ac823b5e07a9b07ded6f15dc67753

data/README.md

@@ -1,7 +1,9 @@
 # Sinatra Wechat extension
 [![Build Status](https://travis-ci.org/luj1985/sinatra-wechat.svg?branch=master)](https://travis-ci.org/luj1985/sinatra-wechat)
+[![Gem Version](https://badge.fury.io/rb/sinatra-wechat.svg)](http://badge.fury.io/rb/sinatra-wechat)
+[![Coverage Status](https://coveralls.io/repos/luj1985/sinatra-wechat/badge.png)](https://coveralls.io/r/luj1985/sinatra-wechat)
 
-This extension is used to support [Tencent Wechat](https://mp.weixin.qq.com/) development mode.
+This extension is used to support [Tencent Wechat](https://mp.weixin.qq.com/) rapid development.
 
 ## Installation
 
@@ -9,17 +11,15 @@ This extension is used to support [Tencent Wechat](https://mp.weixin.qq.com/) de
 
 # Usage
 
-> use `disable :message_validation` to prevent message validation, otherwise need to add signature to the URL.
+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`
 
 ```ruby
 # app.rb
 require 'sinatra'
 require 'sinatra/wechat'
 
-disable :message_validation
-set :wechat_token, 'test-token'
-
-wechat('/') {
+wechat('/', :wechat_token => 'test-token', :message_validation => false) {
   text(:content => %r{\d+}) {
   	content_type 'application/xml'
   	erb :hello, :locals => request[:wechat_values]
@@ -37,13 +37,12 @@ __END__
 </xml>
 ```
 
-start server:
-```sheel
+start web server:
+```shell
 $ ruby app.rb
 ```
 
-Test via [cURL](http://curl.haxx.se):
-
+validate it via [cURL](http://curl.haxx.se):
 ```shell
 $ curl -X POST --data '<xml>
 <ToUserName>tousername</ToUserName>

data/examples/wechat_example.rb

@@ -2,9 +2,6 @@ require 'sinatra'
 require 'sinatra/wechat'
 require 'nokogiri'
 
-disable :message_validation
-set :wechat_token, 'test-token'
-
 location_event_reply = proc {
   content_type 'application/xml'
   values = request[:wechat_values]
@@ -20,7 +17,7 @@ location_event_reply = proc {
   builder.to_xml
 }
 
-wechat('/wechat') {
+wechat('/wechat', :wechat_token => 'test-token', :message_validation => false) {
   location {
     instance_eval &location_event_reply
   }

data/lib/sinatra/version.rb

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

data/lib/sinatra/wechat.rb

@@ -6,6 +6,7 @@ module Sinatra
   module Wechat
     module EndpointActions
       class WechatDispatcher < ::BlankSlate
+        attr_reader :wechat_token, :verfiy_message
         def initialize
           super
           @message_handlers = {}
@@ -34,18 +35,18 @@ module Sinatra
         end
       end
 
-      def wechat(endpoint = '/', &block)
+      def wechat(endpoint = '/', wechat_token: '', message_validation: true, &block)
         dispatcher = WechatDispatcher.new
         dispatcher.instance_eval &block
 
         get endpoint do
-          halt 403 unless validate_messages
+          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
+          halt 403 unless validate_messages(wechat_token) if message_validation
 
           body = request.body.read || ""
           halt 501 if body.empty?
@@ -69,14 +70,10 @@ module Sinatra
 
     def self.registered(app)
       app.extend(Wechat::EndpointActions)
-
       app.helpers do
-        enable :message_validation
-
-        def validate_messages
-          token = settings.wechat_token || ""
+        def validate_messages token
           raw = [token, params[:timestamp], params[:nonce]].compact.sort.join
-          settings.message_validation ? Digest::SHA1.hexdigest(raw) == params[:signature] : true
+          Digest::SHA1.hexdigest(raw) == params[:signature]
         end
       end
       # expose to classic style

data/sinatra-wechat.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |spec|
   spec.homepage           = "https://github.com/luj1985/sinatra-wechat"
   spec.license            = "MIT"
 
-  spec.files              = `git ls-files -z`.split("\x0") - %w[.gitignore .travis.yml]
+  spec.files              = `git ls-files -z`.split("\x0") - %w[.gitignore .travis.yml .coveralls.yml]
   spec.executables        = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files         = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths      = ["lib"]

data/spec/spec_helper.rb

@@ -1,10 +1,10 @@
+require 'coveralls'
+Coveralls.wear!
+
 require 'rack/test'
 require 'rspec'
 
 require 'sinatra'
 require 'sinatra/wechat'
 
-require 'coveralls'
-Coveralls.wear!
-
 set :environment, :test

data/spec/wechat_spec.rb

@@ -4,13 +4,11 @@ describe Sinatra::Wechat do
   include Rack::Test::Methods
 
   it "GET should have message verification" do
-
     def app
-      @instance = Sinatra.new do
-        set :wechat_token, 'test-token'
+      instance = Sinatra.new do
         register Sinatra::Wechat
       end
-      @instance.wechat { }
+      instance.wechat(:wechat_token => 'test-token') { }
     end
 
     get '/'
@@ -22,19 +20,26 @@ describe Sinatra::Wechat do
               :echostr => 'echo string'}
     expect(last_response.status).to eq(200)
     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
 
-    @instance.disable :message_validation
     get '/'
     expect(last_response.status).to eq(200)
   end
 
   it "POST should have message verification" do
     def app
-      @instance = Sinatra.new do
-        set :wechat_token, 'test-token'
+      instance = Sinatra.new do
         register Sinatra::Wechat
       end
-      @instance.wechat { 
+      instance.wechat(:wechat_token => 'test-token') {
         text { 'text response' }
       }
     end
@@ -59,11 +64,10 @@ describe Sinatra::Wechat do
 
   it "can switch wechat endpoint" do
     def app
-      @instance = Sinatra.new do
-        set :wechat_token, 'test-token'
+      instance = Sinatra.new do
         register Sinatra::Wechat
       end
-      @instance.wechat('/wechat') {
+      instance.wechat('/wechat', :wechat_token => 'test-token') {
         image { 'relocated response' }
       }
     end
@@ -90,11 +94,10 @@ describe Sinatra::Wechat do
 
   it "should accept wechat message push" do
     def app
-      @instance = Sinatra.new do
-        set :wechat_token, 'test-token'
+      instance = Sinatra.new do
         register Sinatra::Wechat
       end
-      @instance.wechat {
+      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' }
@@ -191,11 +194,10 @@ describe Sinatra::Wechat do
 
   it "should accept complex match" do
     def app
-      @instance = Sinatra.new do
-        set :wechat_token, 'test-token'
+      instance = Sinatra.new do
         register Sinatra::Wechat
       end
-      @instance.wechat {
+      instance.wechat(:wechat_token => 'test-token') {
         future(lambda {|vs| vs[:to_user_name] == 'test' }, :content => %r{future}, :create_time => '1348831860') {
           'complex match'
         }
@@ -229,12 +231,11 @@ describe Sinatra::Wechat do
   end
 
   it "should raise error when invalid condition set" do
-    @instance = Sinatra.new do
-      set :wechat_token, 'test-token'
+    instance = Sinatra.new do
       register Sinatra::Wechat
     end
     expect {
-      @instance.wechat {
+      instance.wechat(:wechat_token => 'test-token') {
         future('invalid condition') { 'complex match' }
       }
     }.to raise_exception
@@ -242,20 +243,22 @@ describe Sinatra::Wechat do
 
   it "can have multiple endpoint" do
     def app
-      @instance = Sinatra.new do
-        set :wechat_token, 'test-token'
+      instance = Sinatra.new do
         register Sinatra::Wechat
       end
-      @instance.wechat('/wechat1') {
+      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') {
+      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
 
     post '/wechat1?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
@@ -270,13 +273,20 @@ describe Sinatra::Wechat do
     expect(last_response.body).to eq('matched location range')
 
 
-    post '/wechat2?timestamp=201407191804&nonce=nonce&signature=9a91a1cea1cb60b87a9abb29dae06dce14721258', <<-EOF
-      <xml>
-      <MsgType>text</MsgType>
-      </xml>
-    EOF
+    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.body).to eq('this is another wechat endpoint')
 
+    get '/wechat3?echostr=return'
+    expect(last_response).to be_ok
+    expect(last_response.body).to eq('return')
+
+    post '/wechat3', '<xml><MsgType>text</MsgType></xml>'
+    expect(last_response.body).to eq('disable message validation')
+
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-wechat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Lu, Jun
@@ -129,7 +129,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".coveralls.yml"
 - Gemfile
 - LICENSE
 - README.md

data/.coveralls.yml

@@ -1 +0,0 @@
-service_name: travis-ci