weixin_rails_middleware 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4561303d08506a46b5bfe5175b1fb2529e4e7052
-  data.tar.gz: 4e6aae5db8c81f3ed8ebe0817a1cb2b5e9b662d5
+  metadata.gz: 636d0f84432996fd76df3c15716065b775a77379
+  data.tar.gz: 6228287ca1e489b6370f95e1a5aa7b5161def9d1
 SHA512:
-  metadata.gz: b3f4e2a81e68d03db97d59771a8c95668455d166bb4a512d7fae4bffb2010d5f6fd1f98eef2b576bc90d04d5073e662b07566a54322a168e2d1b2adb30c9bc1d
-  data.tar.gz: a4b5e171495c7d0524302faed81a58535b58dc130d84e07d9c2c0590cc21889867f83f89803fcdae425a86a5eb0c7ef09df7a44fc41046ceca0aef7af6c46fa0
+  metadata.gz: 5f5e0d4d176122697db34adf00a75e228d820eddea54ca11adc881e7bf5c18f284d9ee8e77c628309776c17dc2db67256f61faf9c449075b22c1eb63ba3e8ce0
+  data.tar.gz: 8b462a16a5e24a00ba0d0dd3ee7f890d367bd216b85b847b57ab5697cfbd7d185e9fbe7868a61d52457cda788252b4cf275739108c2c013785aa17edfb09aa53

data/app/controllers/weixin_rails_middleware/weixin_controller.rb

@@ -1,15 +1,12 @@
 module WeixinRailsMiddleware
   class WeixinController < ActionController::Base
     include ReplyWeixinMessageHelper
-    include ConfigurationHelpers
-    include WeixinAuthorizeHelper
 
     skip_before_filter :verify_authenticity_token
-    before_filter :check_weixin_params, only: [:index, :reply]
+    before_filter :initialize_adapter, :check_weixin_legality, only: [:index, :reply]
     before_filter :set_weixin_public_account, :set_weixin_message, only: :reply
 
     def index
-      render text: params[:echostr]
     end
 
     def reply
@@ -17,16 +14,26 @@ module WeixinRailsMiddleware
 
     protected
 
+      def initialize_adapter
+        @weixin_adapter ||= Adapter::WexinAdapter.init_with(params)
+      end
+
+      def check_weixin_legality
+        check_result = @weixin_adapter.check_weixin_legality
+        valid = check_result.delete(:valid)
+        render check_result if action_name == "index"
+        return valid
+      end
+
       ## Callback
       # e.g. will generate +@weixin_public_account+
       def set_weixin_public_account
-        return nil if weixin_token_string.present?
-        @weixin_public_account ||= current_weixin_public_account
+        @weixin_public_account ||= @weixin_adapter.current_weixin_public_account
       end
 
       def set_weixin_message
-        # Get the current_message
-        @weixin_message ||= current_weixin_message
+        # Get the current weixin message
+        @weixin_message ||= Message.factory(request.body.read)
       end
 
   end

data/lib/generators/templates/install_weixin_rails_middleware.rb

@@ -7,7 +7,7 @@ WeixinRailsMiddleware.configure do |config|
   ## Config public_account_class if you SAVE public_account into database ##
   # Th first configure is fit for your weixin public_account is saved in database.
   # +public_account_class+ The class name that to save your public_account
-  # config.public_account_class = ""
+  # config.public_account_class = "PublicAccount"
 
   ## Here configure is for you DON'T WANT TO SAVE your public account into database ##
   # Or the other configure is fit for only one weixin public_account

data/lib/generators/templates/weixin_controller.rb

@@ -52,7 +52,7 @@ WeixinRailsMiddleware::WeixinController.class_eval do
       when "subscribe"   # 关注公众账号
         if @keyword.present?
           # 扫描带参数二维码事件: 1. 用户未关注时，进行关注后的事件推送
-          reply_text_message("扫描带参数二维码事件: 1. 用户未关注时，进行关注后的事件推送, keyword: #{@keyword}")
+          return reply_text_message("扫描带参数二维码事件: 1. 用户未关注时，进行关注后的事件推送, keyword: #{@keyword}")
         end
         reply_text_message("关注公众账号")
       when "unsubscribe" # 取消关注
@@ -78,7 +78,7 @@ WeixinRailsMiddleware::WeixinController.class_eval do
     # <Format><![CDATA[Format]]></Format>
     def response_voice_message(options={})
       @media_id = @weixin_message.MediaId # 可以调用多媒体文件下载接口拉取数据。
-      @format   = @weixin_message.format
+      @format   = @weixin_message.Format
       reply_text_message("回复语音信息: #{@keyword}")
     end
 
@@ -91,6 +91,7 @@ WeixinRailsMiddleware::WeixinController.class_eval do
       reply_text_message("回复视频信息")
     end
 
+    # @weixin_message 在rails 3时如果调用不存在的方法，会出现错误。rails 4好像没有问题。
     def set_keyword
       @keyword = @weixin_message.Content    || # 文本消息
                  @weixin_message.EventKey   || # 事件推送

data/lib/weixin_rails_middleware.rb

@@ -4,7 +4,7 @@ require "weixin_rails_middleware/models/message"
 require "weixin_rails_middleware/models/reply_message"
 require "weixin_rails_middleware/helpers/reply_weixin_message_helper"
 require "weixin_rails_middleware/helpers/unique_token_helper"
-require "weixin_rails_middleware/helpers/weixin_authorize_helper"
+require "weixin_rails_middleware/adapter"
 require "weixin_rails_middleware/helpers/auto_generate_weixin_token_secret_key"
 
 module WeixinRailsMiddleware

data/lib/weixin_rails_middleware/adapter.rb

@@ -0,0 +1,3 @@
+require "weixin_rails_middleware/adapter/weixin_adapter"
+require "weixin_rails_middleware/adapter/multiple_public_account"
+require "weixin_rails_middleware/adapter/single_public_account"

data/lib/weixin_rails_middleware/adapter/multiple_public_account.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+module WeixinRailsMiddleware
+  module Adapter
+    class MultiplePublicAccount < WexinAdapter
+
+      def check_weixin_legality
+        return render_authorize_result(404) if !is_weixin_secret_key_valid?
+        super
+      end
+
+      # check the token from Weixin Service is exist in local store.
+      def is_weixin_secret_key_valid?
+        current_weixin_public_account.present?
+      end
+
+      def current_weixin_token
+        current_weixin_public_account.try(DEFAULT_TOKEN_COLUMN_NAME)
+      end
+
+      def current_weixin_public_account
+        self.class.token_model_class.where("#{DEFAULT_WEIXIN_SECRET_KEY}" => weixin_secret_key).first
+      end
+
+      def error_msg
+        "#{__FILE__}:#{__LINE__}: RecordNotFound - Couldn't find #{self.class.token_model} with weixin_secret_key=#{weixin_secret_key}"
+      end
+
+    end
+  end
+end

data/lib/weixin_rails_middleware/adapter/single_public_account.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+module WeixinRailsMiddleware
+  module Adapter
+    class SinglePublicAccount < WexinAdapter
+
+      def check_weixin_legality
+        return render_authorize_result if !is_weixin_secret_key_valid?
+        super
+      end
+
+      def is_weixin_secret_key_valid?
+        weixin_secret_key == self.class.weixin_secret_string
+      end
+
+      def current_weixin_token
+        self.class.weixin_token_string
+      end
+
+      def current_weixin_public_account
+        nil
+      end
+
+      def error_msg
+        "#{__FILE__}:#{__LINE__}: Weixin secret string NotMatch."
+      end
+
+    end
+  end
+end

data/lib/weixin_rails_middleware/adapter/weixin_adapter.rb

@@ -0,0 +1,74 @@
+# encoding: utf-8
+module WeixinRailsMiddleware
+  module Adapter
+    class WexinAdapter
+      extend ConfigurationHelpers
+
+      attr_accessor :signature, :timestamp, :nonce, :echostr
+      attr_accessor :weixin_secret_key
+
+      def initialize(weixin_params)
+        @weixin_secret_key = weixin_params[:weixin_secret_key]
+        # 以下参数为什么加空字符串默认值的原因:
+        # SB微信偶尔会再重新发一次get请求，但是不会带上signature,timestamp,nonce的参数
+        # 一个预防措施吧。
+        @signature = weixin_params[:signature] || ''
+        @timestamp = weixin_params[:timestamp] || ''
+        @nonce     = weixin_params[:nonce]     || ''
+        @echostr   = weixin_params[:echostr]   || ''
+      end
+
+      def self.init_with(weixin_params)
+        if weixin_token_string.present?
+          SinglePublicAccount.new(weixin_params)
+        else
+          MultiplePublicAccount.new(weixin_params)
+        end
+      end
+
+      def check_weixin_legality
+        return render_authorize_result(403, self.class.error_msg) if !is_signature_valid?
+        render_authorize_result(200, echostr, true)
+      end
+
+      def is_signature_valid?
+        sort_params = [current_weixin_token, timestamp, nonce].sort.join
+        current_signature = Digest::SHA1.hexdigest(sort_params)
+        return true if current_signature == signature
+        false
+      end
+
+      def current_weixin_public_account
+        raise NotImplementedError, "Subclasses must implement current_weixin_public_account method"
+      end
+
+      def current_weixin_token
+        raise NotImplementedError, "Subclasses must implement current_weixin_token method"
+      end
+
+      def is_weixin_secret_key_valid?
+        raise NotImplementedError, "Subclasses must implement is_weixin_secret_key_valid? method"
+      end
+
+      class << self
+        def error_msg
+          "#{__FILE__}:#{__LINE__}: Weixin signature NotMatch"
+        end
+      end
+
+      private
+
+        # render weixin server authorize results
+        def render_authorize_result(status=403, text=nil, valid=false)
+          text = text || error_msg
+          Rails.logger.error(text) if status != 200
+          {text: text, status: status, valid: valid}
+        end
+
+        def error_msg
+          self.class.error_msg
+        end
+
+    end
+  end
+end

data/lib/weixin_rails_middleware/configuration.rb

@@ -15,9 +15,8 @@ module WeixinRailsMiddleware
   end
 
   class Configuration
-    attr_accessor :public_account_class, :weixin_token_string
-    attr_accessor :weixin_secret_string
-
+    attr_accessor :public_account_class
+    attr_accessor :weixin_secret_string, :weixin_token_string
   end
 
   module ConfigurationHelpers

data/lib/weixin_rails_middleware/engine.rb

@@ -1,6 +1,5 @@
 module WeixinRailsMiddleware
   class Engine < ::Rails::Engine
-    include ConfigurationHelpers
 
     isolate_namespace WeixinRailsMiddleware
     engine_name :weixin_engine

data/lib/weixin_rails_middleware/helpers/auto_generate_weixin_token_secret_key.rb

@@ -5,7 +5,6 @@ module WeixinRailsMiddleware
     included do
 
       before_create do
-        # TODO: refactor
         self.weixin_secret_key = generate_weixin_secret_key
         self.weixin_token      = WeiXinUniqueToken.generate
       end
@@ -13,8 +12,8 @@ module WeixinRailsMiddleware
 
     private
 
-    def generate_weixin_secret_key
-      WeiXinUniqueToken.generate(generator: :urlsafe_base64, size: 32).downcase
-    end
+      def generate_weixin_secret_key
+        WeiXinUniqueToken.generate(generator: :urlsafe_base64, size: 32).downcase
+      end
   end
 end

data/lib/weixin_rails_middleware/helpers/unique_token_helper.rb

@@ -5,11 +5,8 @@ module WeixinRailsMiddleware
       generator_method_type = options.delete(:generator).try(:to_sym) || :hex
       generator_method      = SecureRandom.method(generator_method_type)
       token_size            = options.delete(:size).try(:to_i) || 12
-      if generator_method_type != :uuid
-        generator_method.call(token_size)
-      else
-        generator_method.call()
-      end
+      return generator_method.call if generator_method_type == :uuid
+      generator_method.call(token_size)
     end
   end
 end

data/lib/weixin_rails_middleware/models/message.rb

@@ -1,4 +1,4 @@
-# -*- encoding : utf-8 -*-
+# encoding: utf-8
 # ref: https://github.com/wolfg1969/rack-weixin/lib/weixin/model.rb
 require 'roxml'
 require 'multi_xml'

data/lib/weixin_rails_middleware/models/reply_message.rb

@@ -1,4 +1,4 @@
-# -*- encoding : utf-8 -*-
+# encoding: utf-8
 # ref: https://github.com/wolfg1969/rack-weixin/lib/weixin/model.rb
 require 'roxml'
 
@@ -7,7 +7,6 @@ module WeixinRailsMiddleware
   class ReplyMessage
     include ROXML
     xml_name :xml
-    #xml_convention :camelcase
 
     xml_accessor :ToUserName, :cdata   => true
     xml_accessor :FromUserName, :cdata => true

data/lib/weixin_rails_middleware/version.rb

@@ -1,3 +1,3 @@
 module WeixinRailsMiddleware
-  VERSION = "1.2.1"
+  VERSION = "1.2.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weixin_rails_middleware
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - lanrion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-01 00:00:00.000000000 Z
+date: 2014-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -111,12 +111,15 @@ files:
 - lib/generators/weixin_rails_middleware/install_generator.rb
 - lib/generators/weixin_rails_middleware/migration_generator.rb
 - lib/weixin_rails_middleware.rb
+- lib/weixin_rails_middleware/adapter.rb
+- lib/weixin_rails_middleware/adapter/multiple_public_account.rb
+- lib/weixin_rails_middleware/adapter/single_public_account.rb
+- lib/weixin_rails_middleware/adapter/weixin_adapter.rb
 - lib/weixin_rails_middleware/configuration.rb
 - lib/weixin_rails_middleware/engine.rb
 - lib/weixin_rails_middleware/helpers/auto_generate_weixin_token_secret_key.rb
 - lib/weixin_rails_middleware/helpers/reply_weixin_message_helper.rb
 - lib/weixin_rails_middleware/helpers/unique_token_helper.rb
-- lib/weixin_rails_middleware/helpers/weixin_authorize_helper.rb
 - lib/weixin_rails_middleware/models/message.rb
 - lib/weixin_rails_middleware/models/reply_message.rb
 - lib/weixin_rails_middleware/version.rb

data/lib/weixin_rails_middleware/helpers/weixin_authorize_helper.rb

@@ -1,74 +0,0 @@
-module WeixinRailsMiddleware
-  module WeixinAuthorizeHelper
-    extend ActiveSupport::Concern
-
-    protected
-
-      def check_weixin_params
-
-        # if config weixin token string
-        if weixin_token_string.present?
-          if !is_weixin_secret_string_valid?
-            puts "WeixinSecretStringNotMatch"
-            render text: "WeixinSecretStringNotMatch", status: 403
-            return false
-          end
-        # if use database to store public_account
-        else
-          if !is_weixin_secret_key_valid?
-            puts "RecordNotFound"
-            render text: "RecordNotFound - Couldn't find #{token_model} with weixin_secret_key=#{current_weixin_secret_key} ", status: 404
-            return false
-          end
-        end
-
-        if !is_signature_valid?
-          puts "WeixinSignatureNotMatch"
-          render text: "WeixinSignatureNotMatch", status: 403
-          return false
-        end
-        true
-      end
-
-      # check the token from Weixin Service is exist in local store.
-      def is_weixin_secret_key_valid?
-        if weixin_token_string.blank?
-          current_weixin_public_account.present?
-        end
-      end
-
-      def is_weixin_secret_string_valid?
-        current_weixin_secret_key == weixin_secret_string
-      end
-
-      def is_signature_valid?
-        signature   = params[:signature] || ''
-        timestamp   = params[:timestamp] || ''
-        nonce       = params[:nonce]     || ''
-        sort_params = [current_weixin_token, timestamp, nonce].sort.join
-        current_signature = Digest::SHA1.hexdigest(sort_params)
-        return true if current_signature == signature
-        false
-      end
-
-      def current_weixin_secret_key
-        @weixin_secret_key = params[:weixin_secret_key]
-      end
-
-      def current_weixin_token
-        return weixin_token_string if weixin_token_string.present?
-        current_weixin_public_account.try(DEFAULT_TOKEN_COLUMN_NAME)
-      end
-
-      def current_weixin_public_account
-        @current_weixin_public_account = token_model_class.where("#{DEFAULT_WEIXIN_SECRET_KEY}" => current_weixin_secret_key).first
-      end
-
-      # return a message class with current_weixin_params
-      def current_weixin_message
-        Message.factory(request.body.read)
-      end
-
-  end
-end
-