rack-weixin 0.0.3.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+source 'http://ruby.taobao.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,44 @@
+PATH
+  remote: .
+  specs:
+    rack-weixin (0.0.3.1)
+      multi_xml (>= 0.5.2)
+      rack
+      roxml
+
+GEM
+  remote: http://rubygems.org/
+  remote: http://ruby.taobao.org/
+  specs:
+    activesupport (3.2.12)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    diff-lcs (1.1.3)
+    i18n (0.6.2)
+    multi_json (1.6.1)
+    multi_xml (0.5.3)
+    nokogiri (1.5.6)
+    rack (1.5.2)
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rake (10.0.3)
+    roxml (3.3.1)
+      activesupport (>= 2.3.0)
+      nokogiri (>= 1.3.3)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.12.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rack-test
+  rack-weixin!
+  rake
+  rspec (>= 2.0.0)

data/README.md

@@ -0,0 +1,87 @@
+微信公众平台 开放消息接口 Rack Middlware
+========================================
+
+* 验证微信请求 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 'weixin/middleware'
+require 'weixin/model'
+
+use Weixin::Middleware, 'your api token', '/your_app_root' 
+
+configure do
+    set :wx_id, 'your_weixin_account'
+end
+
+helpers do
+
+    def create_message(from, to, type, content, flag=0)
+        msg = Weixin::TextReplyMessage.new
+        msg.ToUserName = to
+        msg.FromUserName = from
+        msg.Content = content
+        msg.to_xml
+    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 "message: #{request.env[Weixin::Middleware::WEIXIN_MSG_RAW]}"
+
+    from = message.FromUserName
+    if message.class == Weixin::TextMessage
+        content = message.Content
+        if content == 'Hello2BizUser'
+            reply_msg_content = "感谢关注！#{reply_msg_content}"
+        end
+    end
+
+    create_message(settings.wx_id, from, 'text', reply_msg_content)
+end
+```
+
+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.

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+desc 'Run all the tests'
+task :default => [:test]
+
+desc "Run all the tests"
+task :test do
+    sh "rspec -Ilib/*:spec spec"
+end
+

data/lib/weixin/middleware.rb

@@ -0,0 +1,62 @@
+# -*- encoding : utf-8 -*-
+require 'digest/sha1'
+
+module Weixin
+
+    class Middleware
+
+        POST_BODY       = 'rack.input'.freeze
+        WEIXIN_MSG      = 'weixin.msg'.freeze
+        WEIXIN_MSG_RAW  = 'weixin.msg.raw'.freeze
+
+        def initialize(app, app_token, path)
+            @app = app
+            @app_token = app_token
+            @path = path
+        end
+
+        def call(env)
+            dup._call(env)
+        end
+
+        def _call(env)
+            if @path == env['PATH_INFO'].to_s && ['GET', 'POST'].include?(env['REQUEST_METHOD'])
+
+                @req = Rack::Request.new(env)
+                return invalid_request! unless request_is_valid?
+                return [
+                    200, 
+                    { 'Content-type' => 'text/plain', 'Content-length' => @req.params['echostr'].length.to_s }, 
+                    [ @req.params['echostr'] ]
+                ] if @req.get?
+
+                raw_msg = env[POST_BODY].read
+                begin
+                    env.update WEIXIN_MSG => Weixin::Message.factory(raw_msg), WEIXIN_MSG_RAW => env[POST_BODY]
+                    @app.call(env)
+                rescue Exception => e
+                    return [500, { 'Content-typ' => 'text/html' }, ["Message parsing error: #{e.to_s}"]]
+                end
+            else
+                @app.call(env)
+            end
+
+        end
+
+        def invalid_request!
+            [401, { 'Content-type' => 'text/html', 'Content-Length' => '0'}, []]
+        end
+
+        def request_is_valid?
+            begin
+                param_array = [@app_token, @req.params['timestamp'], @req.params['nonce']]
+                sign = Digest::SHA1.hexdigest( param_array.sort.join )
+                sign == @req.params['signature'] ? true : false
+            rescue
+                false
+            end
+        end
+    end
+
+end
+

data/lib/weixin/model.rb

@@ -0,0 +1,146 @@
+# -*- encoding : utf-8 -*-
+require 'roxml'
+require 'multi_xml'
+require 'ostruct'
+
+module Weixin
+
+    class Message
+
+        def initialize(hash)
+            @source = OpenStruct.new(hash) 
+        end
+
+        def method_missing(method, *args, &block)
+            @source.send(method, *args, &block)
+        end
+
+        def CreateTime
+            @source.CreateTime.to_i
+        end
+
+        def MsgId
+            @source.MsgId.to_i
+        end
+
+        def Message.factory(xml)
+            hash = MultiXml.parse(xml)['xml']
+            case hash['MsgType']
+            when 'text'
+                TextMessage.new(hash)
+            when 'image'
+                ImageMessage.new(hash)
+            when 'location'
+                LocationMessage.new(hash)
+            when 'link'
+                LinkMessage.new(hash)
+            when 'event'
+                EventMessage.new(hash)
+            else
+                raise ArgumentError, 'Unknown Message'
+            end
+        end
+
+    end
+
+    TextMessage = Class.new(Message)
+    ImageMessage = Class.new(Message)
+    LinkMessage = Class.new(Message)
+
+    class LocationMessage < Message
+
+        def Location_X
+            @source.Location_X.to_f
+        end
+
+        def Location_Y
+            @source.Location_Y.to_f
+        end
+
+        def Scale
+            @source.Scale.to_i
+        end
+    end
+
+    class EventMessage < Message
+        
+        def Latitude
+            @source.Latitude.to_f
+        end
+
+        def Longitude
+            @source.Longitude.to_f
+        end
+
+        def Precision
+            @source.Precision.to_f
+        end
+    end
+
+    class ReplyMessage
+        include ROXML
+        xml_name :xml
+        #xml_convention :camelcase
+
+        xml_accessor :ToUserName, :cdata => true
+        xml_accessor :FromUserName, :cdata => true
+        xml_reader :CreateTime, :as => Integer
+        xml_reader :MsgType, :cdata => true
+        xml_accessor :FuncFlag, :as => Integer
+
+        def initialize
+            @CreateTime = Time.now.to_i
+            @FuncFlag = 0
+        end
+
+        def to_xml
+           super.to_xml(:encoding => 'UTF-8', :indent => 0, :save_with => 0)
+        end
+    end
+
+    class TextReplyMessage < ReplyMessage
+        xml_accessor :Content, :cdata => true
+
+        def initialize
+            super
+            @MsgType = 'text'
+        end
+    end
+
+    class Music
+        include ROXML
+
+        xml_accessor :Title, :cdata => true
+        xml_accessor :Description, :cdata => true
+        xml_accessor :MusicUrl, :cdata => true
+        xml_accessor :HQMusicUrl, :cdata => true
+    end
+
+    class MusicReplyMessage < ReplyMessage
+        xml_accessor :Music, :as => Music
+
+        def initialize
+            super
+            @MsgType = 'music'
+        end
+    end
+
+    class Item
+        include ROXML
+
+        xml_accessor :Title, :cdata => true
+        xml_accessor :Description, :cdata => true
+        xml_accessor :PicUrl, :cdata => true
+        xml_accessor :Url, :cdata => true
+    end
+
+    class NewsReplyMessage < ReplyMessage
+        xml_accessor :ArticleCount, :as => Integer
+        xml_accessor :Articles, :as => [Item], :in => 'Articles', :from => 'Item'
+
+        def initialize
+            super
+            @MsgType = 'news'
+        end
+    end
+end

data/lib/weixin/version.rb

@@ -0,0 +1,3 @@
+module Weixin
+    VERSION = "0.0.3.1"
+end

data/rack-weixin.gemspec

@@ -0,0 +1,27 @@
+$:.push File.expand_path("../lib", __FILE__)  
+require "weixin/version"
+
+Gem::Specification.new do |s|
+
+    s.name = 'rack-weixin'
+    s.version = Weixin::VERSION 
+
+    s.description = 'Rack middleware for Weixin apps: message validation/parser/generator'
+    s.summary = 'Rack middleware for Weixin apps'
+
+    s.authors = ['wolfg1969']
+    s.email = 'wolfg1969@gmail.com'
+
+    s.files = `git ls-files`.split("\n")
+    s.test_files = s.files.select {|path| path =~ /^spec\/.*_spec\.rb/}
+
+    s.add_dependency 'rack'
+    s.add_dependency 'multi_xml', '>= 0.5.2'
+    s.add_dependency 'roxml'
+    s.add_development_dependency 'rake'
+    s.add_development_dependency 'rack-test'
+    s.add_development_dependency 'rspec', '>= 2.0.0'
+
+    s.homepage = 'https://github.com/wolfg1969/rack-weixin'
+    s.require_paths = %w[lib]
+end

data/spec/model_spec.rb

@@ -0,0 +1,104 @@
+# -*- encoding : utf-8 -*-
+require 'rspec'
+require 'weixin/model'
+
+describe 'weixin/model' do
+
+    context 'Weixin:Message' do
+        it 'is a text message' do
+            msg = Weixin::Message.factory(%(
+            <xml>
+                <ToUserName><![CDATA[to]]></ToUserName>
+                <FromUserName><![CDATA[from]]></FromUserName>
+                <CreateTime>1360391199</CreateTime>
+                <MsgType><![CDATA[text]]></MsgType>
+                <Content><![CDATA[Hello2BizUser]]></Content>
+                <MsgId>5842835709471227904</MsgId>
+            </xml>
+            ))
+            msg.class.should == Weixin::TextMessage
+            msg.MsgType.should == 'text'
+            msg.ToUserName.should == 'to'
+            msg.FromUserName.should == 'from'
+            msg.CreateTime.should == 1360391199
+            msg.Content.should == 'Hello2BizUser'
+            msg.MsgId.should == 5842835709471227904
+        end
+
+        it 'is a image message' do
+            msg = Weixin::Message.factory(%(
+            <xml>
+                <ToUserName><![CDATA[to]]></ToUserName>
+                <FromUserName><![CDATA[from]]></FromUserName>
+                <CreateTime>1360391199</CreateTime>
+                <MsgType><![CDATA[image]]></MsgType>
+                <PicUrl><![CDATA[http://mmsns.qpic.cn/mmsns/Leiaa5NQF4FOTOSo3hXrEsGsodU2jHcWZiaInTxmTh6GaCIJ8hBHicIDA/0]]></PicUrl>
+                <MsgId>5842835709471227904</MsgId>
+            </xml>
+            ))
+            msg.class.should == Weixin::ImageMessage
+            msg.MsgType.should == 'image'
+            msg.ToUserName.should == 'to'
+            msg.FromUserName.should == 'from'
+            msg.CreateTime.should == 1360391199
+            msg.MsgId.should == 5842835709471227904
+            msg.PicUrl.should_not nil
+        end
+
+        it 'is a location message' do
+            msg = Weixin::Message.factory(%(
+            <xml>
+                <ToUserName><![CDATA[to]]></ToUserName>
+                <FromUserName><![CDATA[from]]></FromUserName>
+                <CreateTime>1360391199</CreateTime>
+                <MsgType><![CDATA[location]]></MsgType>
+                <Location_X>69.866013</Location_X>
+                <Location_Y>136.269449</Location_Y>
+                <Scale>15</Scale>
+                <Label><![CDATA[somewhere]]></Label>
+                <MsgId>5842835709471227904</MsgId>
+            </xml>
+            ))
+            msg.class.should == Weixin::LocationMessage
+            msg.MsgType.should == 'location'
+            msg.ToUserName.should == 'to'
+            msg.FromUserName.should == 'from'
+            msg.CreateTime.should == 1360391199
+            msg.MsgId.should == 5842835709471227904
+            msg.Label.should_not nil
+            msg.Scale.should == 15
+            msg.Location_X.should == 69.866013
+            msg.Location_Y.should == 136.269449
+        end
+
+    end
+
+    context 'Weixin::ReplyMessage' do
+
+        it 'is a text reply message' do
+            msg = Weixin::TextReplyMessage.new
+            msg.ToUserName = 'to'
+            msg.FromUserName = 'from'
+            msg.Content = 'blah'
+            msg.MsgType.should == 'text'
+        end
+
+        it 'is a news reply message' do
+            msg = Weixin::NewsReplyMessage.new
+            msg.ToUserName = 'to'
+            msg.FromUserName = 'from'
+            item1 = Weixin::Item.new
+            item1.Title = 'title1'
+            item1.Description = 'blah'
+            item2 = Weixin::Item.new
+            item2.Title = 'title2'
+            item2.Description = 'blah blah'
+            msg.Articles = [item1, item2]
+            msg.ArticleCount = 2
+            msg.MsgType.should == 'news'
+            #puts msg.to_xml
+        end
+
+    end
+
+end

data/spec/rack_middleware_spec.rb

@@ -0,0 +1,55 @@
+# -*- encoding : utf-8 -*-
+require 'rspec'
+require 'rack'
+require 'rack/test'
+require 'rack/mock'
+require 'digest/sha1'
+require 'weixin/middleware'
+
+describe "Weixin::Middleware" do
+
+    include Rack::Test::Methods
+
+    before(:all) do
+        @app = lambda { |env| [200, { 'Content-Type' => 'text/plain' }, ['hello']] }
+        @app_token = 'mytoken'
+        @context_path = '/'
+    end
+
+    def middleware()
+        Weixin::Middleware.new @app, @app_token, @context_path
+    end
+
+    def mock_env(echostr, token = @app_token, path = '/')
+        timestamp = Time.now.to_i.to_s
+        nonce = '123456'
+        param_array = [token, timestamp, nonce]
+        sign = Digest::SHA1.hexdigest( param_array.sort.join )
+        url = "#{path}?echostr=#{echostr}&timestamp=#{timestamp}&nonce=#{nonce}&signature=#{sign}"
+        Rack::MockRequest.env_for(url)
+    end
+
+    it 'does not match the path info' do
+        app = middleware
+        echostr = '123'
+        status, headers, body = app.call mock_env(echostr, @app_token, '/not_weixin_app')
+        status.should eq(200)
+        body.should_not == [echostr]
+    end
+
+    it 'is valid weixin request' do
+        app = middleware
+        echostr = '123'
+        status, headers, body = app.call mock_env(echostr)
+        status.should eq(200)
+        body.should == [echostr]
+    end
+
+    it 'is invalid weixin request' do
+        app = middleware
+        status, headers, body = app.call mock_env('123', 'wrong_token')
+        status.should eq(401)
+        body.should == []
+    end
+
+end

metadata

@@ -0,0 +1,159 @@
+--- !ruby/object:Gem::Specification
+name: rack-weixin
+version: !ruby/object:Gem::Version
+  version: 0.0.3.1
+  prerelease: 
+platform: ruby
+authors:
+- wolfg1969
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: multi_xml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.5.2
+- !ruby/object:Gem::Dependency
+  name: roxml
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+description: ! 'Rack middleware for Weixin apps: message validation/parser/generator'
+email: wolfg1969@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/weixin/middleware.rb
+- lib/weixin/model.rb
+- lib/weixin/version.rb
+- rack-weixin.gemspec
+- spec/model_spec.rb
+- spec/rack_middleware_spec.rb
+homepage: https://github.com/wolfg1969/rack-weixin
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -95414285
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -95414285
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack middleware for Weixin apps
+test_files:
+- spec/model_spec.rb
+- spec/rack_middleware_spec.rb