weixin_rails_middleware 1.2.2 → 1.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 636d0f84432996fd76df3c15716065b775a77379
-  data.tar.gz: 6228287ca1e489b6370f95e1a5aa7b5161def9d1
+  metadata.gz: c8b512a640cd72d5b60a38fc9ecd29cc36c045c1
+  data.tar.gz: e9ce1f55233f8fa3e7c9ab84276001eac83d6d8b
 SHA512:
-  metadata.gz: 5f5e0d4d176122697db34adf00a75e228d820eddea54ca11adc881e7bf5c18f284d9ee8e77c628309776c17dc2db67256f61faf9c449075b22c1eb63ba3e8ce0
-  data.tar.gz: 8b462a16a5e24a00ba0d0dd3ee7f890d367bd216b85b847b57ab5697cfbd7d185e9fbe7868a61d52457cda788252b4cf275739108c2c013785aa17edfb09aa53
+  metadata.gz: e95b2b9e4c0668bef289e2f2dd1b9f5b125e11725bf0fcdfcca423f433a1f204319ac829a1438a4f0dd813142fdc81ce7ad92b4d7088f06c252834473f89ee20
+  data.tar.gz: e750d71896700712fd8609987f33086155f1bd46d204b8763ca91e971f5b569cbae972f82b171ca5e033634c48e3f32e465bf55bcad53c2d13446360b6599399

data/app/controllers/weixin_rails_middleware/weixin_controller.rb

@@ -5,6 +5,7 @@ module WeixinRailsMiddleware
     skip_before_filter :verify_authenticity_token
     before_filter :initialize_adapter, :check_weixin_legality, only: [:index, :reply]
     before_filter :set_weixin_public_account, :set_weixin_message, only: :reply
+    before_filter :set_keyword, only: :reply
 
     def index
     end
@@ -15,7 +16,7 @@ module WeixinRailsMiddleware
     protected
 
       def initialize_adapter
-        @weixin_adapter ||= Adapter::WexinAdapter.init_with(params)
+        @weixin_adapter ||= WexinAdapter.init_with(params)
       end
 
       def check_weixin_legality
@@ -36,5 +37,16 @@ module WeixinRailsMiddleware
         @weixin_message ||= Message.factory(request.body.read)
       end
 
+      def set_keyword
+        @keyword = @weixin_message.Content    || # 文本消息
+                   @weixin_message.EventKey   || # 事件推送
+                   @weixin_message.Recognition # 接收语音识别结果
+      end
+
+      # http://apidock.com/rails/ActionController/Base/default_url_options
+      def default_url_options(options={})
+        { weichat_id: @weixin_message.FromUserName }
+      end
+
   end
 end

data/config/routes.rb

@@ -1,4 +1,4 @@
 WeixinRailsMiddleware::Engine.routes.draw do
-  get  'weixin/:weixin_secret_key', to: 'weixin#index', as: :weixin_index
+  get  'weixin/:weixin_secret_key', to: 'weixin#index', as: :weixin_server
   post 'weixin/:weixin_secret_key', to: 'weixin#reply', as: :weixin_reply
 end

data/lib/generators/templates/weixin_controller.rb

@@ -1,10 +1,8 @@
 # encoding: utf-8
-# 1: get weixin xml params
-# @weixin_message
-# 2: public_account_class instance if you setup, otherwise return nil
-# @weixin_public_account
+# 1, @weixin_message: 获取微信所有参数.
+# 2, @weixin_public_account: 如果配置了public_account_class选项,则会返回当前实例,否则返回nil.
+# 3, @keyword: 目前微信只有这三种情况存在关键字: 文本消息, 事件推送, 接收语音识别结果
 WeixinRailsMiddleware::WeixinController.class_eval do
-  before_filter :set_keyword, only: :reply
 
   def reply
     render xml: send("response_#{@weixin_message.MsgType}_message", {})
@@ -31,9 +29,9 @@ WeixinRailsMiddleware::WeixinController.class_eval do
     # <PicUrl><![CDATA[this is a url]]></PicUrl>
     # <MediaId><![CDATA[media_id]]></MediaId>
     def response_image_message(options={})
-      @pic_url  = @weixin_message.PicUrl
       @media_id = @weixin_message.MediaId # 可以调用多媒体文件下载接口拉取数据。
-      reply_text_message("回复图片信息")
+      @pic_url  = @weixin_message.PicUrl  # 也可以直接通过此链接下载图片, 建议使用carrierwave.
+      reply_image_message(generate_image(@media_id))
     end
 
     # <Title><![CDATA[公众平台官网链接]]></Title>
@@ -46,40 +44,14 @@ WeixinRailsMiddleware::WeixinController.class_eval do
       reply_text_message("回复链接信息")
     end
 
-    def response_event_message(options={})
-      event_type = @weixin_message.Event
-      case event_type
-      when "subscribe"   # 关注公众账号
-        if @keyword.present?
-          # 扫描带参数二维码事件: 1. 用户未关注时，进行关注后的事件推送
-          return reply_text_message("扫描带参数二维码事件: 1. 用户未关注时，进行关注后的事件推送, keyword: #{@keyword}")
-        end
-        reply_text_message("关注公众账号")
-      when "unsubscribe" # 取消关注
-        reply_text_message("取消关注")
-      when "SCAN"        # 扫描带参数二维码事件: 2用户已关注时的事件推送
-        reply_text_message("扫描带参数二维码事件: 2用户已关注时的事件推送, keyword: #{@keyword}")
-      when "LOCATION"    # 上报地理位置事件
-        @lat = @weixin_message.Latitude
-        @lgt = @weixin_message.Longitude
-        @precision = @weixin_message.Precision
-        reply_text_message("Your Location: #{@lat}, #{@lgt}, #{@precision}")
-      when "CLICK"       # 点击菜单拉取消息时的事件推送
-        reply_text_message("你点击了: #{@keyword}")
-      when "VIEW"        # 点击菜单跳转链接时的事件推送
-        reply_text_message("你点击了: #{@keyword}")
-      else
-        reply_text_message("处理无法识别的事件")
-      end
-
-    end
-
     # <MediaId><![CDATA[media_id]]></MediaId>
     # <Format><![CDATA[Format]]></Format>
     def response_voice_message(options={})
       @media_id = @weixin_message.MediaId # 可以调用多媒体文件下载接口拉取数据。
       @format   = @weixin_message.Format
-      reply_text_message("回复语音信息: #{@keyword}")
+      # 如果开启了语音翻译功能，@keyword则为翻译的结果
+      # reply_text_message("回复语音信息: #{@keyword}")
+      reply_voice_message(generate_voice(@media_id))
     end
 
     # <MediaId><![CDATA[media_id]]></MediaId>
@@ -91,15 +63,47 @@ 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   || # 事件推送
-                 @weixin_message.Recognition # 接收语音识别结果
+    def response_event_message(options={})
+      event_type = @weixin_message.Event
+      send("reply_#{event_type.downcase}_event")
     end
 
-    # http://apidock.com/rails/ActionController/Base/default_url_options
-    def default_url_options(options={})
-      { weichat_id: @weixin_message.FromUserName }
-    end
+    private
+
+      # 关注公众账号
+      def reply_subscribe_event
+        if @keyword.present?
+          # 扫描带参数二维码事件: 1. 用户未关注时，进行关注后的事件推送
+          return reply_text_message("扫描带参数二维码事件: 1. 用户未关注时，进行关注后的事件推送, keyword: #{@keyword}")
+        end
+        reply_text_message("关注公众账号")
+      end
+
+      # 取消关注
+      def reply_unsubscribe_event
+        Rails.logger.info("取消关注")
+      end
+
+      # 扫描带参数二维码事件: 2. 用户已关注时的事件推送
+      def reply_scan_event
+        reply_text_message("扫描带参数二维码事件: 2. 用户已关注时的事件推送, keyword: #{@keyword}")
+      end
+
+      def reply_location_event # 上报地理位置事件
+        @lat = @weixin_message.Latitude
+        @lgt = @weixin_message.Longitude
+        @precision = @weixin_message.Precision
+        reply_text_message("Your Location: #{@lat}, #{@lgt}, #{@precision}")
+      end
+
+      # 点击菜单拉取消息时的事件推送
+      def reply_click_event
+        reply_text_message("你点击了: #{@keyword}")
+      end
+
+      # 点击菜单跳转链接时的事件推送
+      def reply_view_event
+        Rails.logger.info("你点击了: #{@keyword}")
+      end
+
 end

data/lib/weixin_rails_middleware.rb

@@ -4,11 +4,14 @@ 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/adapter"
 require "weixin_rails_middleware/helpers/auto_generate_weixin_token_secret_key"
 
 module WeixinRailsMiddleware
 
+  autoload(:WexinAdapter, "weixin_rails_middleware/adapter/weixin_adapter")
+  autoload(:SinglePublicAccount, "weixin_rails_middleware/adapter/single_public_account")
+  autoload(:MultiplePublicAccount, "weixin_rails_middleware/adapter/multiple_public_account")
+
   DEFAULT_TOKEN_COLUMN_NAME = "weixin_token".freeze
   DEFAULT_WEIXIN_SECRET_KEY = "weixin_secret_key".freeze
 

data/lib/weixin_rails_middleware/adapter/multiple_public_account.rb

@@ -1,30 +1,28 @@
 # encoding: utf-8
 module WeixinRailsMiddleware
-  module Adapter
-    class MultiplePublicAccount < WexinAdapter
+  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 check_weixin_legality
+      return render_authorize_result(404) if !is_weixin_secret_key_valid?
+      super
+    end
 
-      def current_weixin_token
-        current_weixin_public_account.try(DEFAULT_TOKEN_COLUMN_NAME)
-      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_public_account
-        self.class.token_model_class.where("#{DEFAULT_WEIXIN_SECRET_KEY}" => weixin_secret_key).first
-      end
+    def current_weixin_token
+      current_weixin_public_account.try(DEFAULT_TOKEN_COLUMN_NAME)
+    end
 
-      def error_msg
-        "#{__FILE__}:#{__LINE__}: RecordNotFound - Couldn't find #{self.class.token_model} with weixin_secret_key=#{weixin_secret_key}"
-      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

data/lib/weixin_rails_middleware/adapter/single_public_account.rb

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

data/lib/weixin_rails_middleware/adapter/weixin_adapter.rb

@@ -1,74 +1,72 @@
 # encoding: utf-8
 module WeixinRailsMiddleware
-  module Adapter
-    class WexinAdapter
-      extend ConfigurationHelpers
+  class WexinAdapter
+    extend ConfigurationHelpers
 
-      attr_accessor :signature, :timestamp, :nonce, :echostr
-      attr_accessor :weixin_secret_key
+    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 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
+    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 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 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_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 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
+    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
+    class << self
+      def error_msg
+        "#{__FILE__}:#{__LINE__}: Weixin signature NotMatch"
       end
+    end
 
-      private
+    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
+      # 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
+      def error_msg
+        self.class.error_msg
+      end
 
-    end
   end
 end

data/lib/weixin_rails_middleware/helpers/reply_weixin_message_helper.rb

@@ -51,13 +51,25 @@ module WeixinRailsMiddleware
 
     def generate_video(media_id, desc, title)
       video = Video.new
-      video.MediaId     = media_id
+      video.MediaId = media_id
+      video.Title   = title
       video.Description = desc
-      video.Title = title
-      vodeo
+      video
     end
 
-    def replay_video_message(from=nil, to=nil, video)
+    # <xml>
+    # <ToUserName><![CDATA[toUser]]></ToUserName>
+    # <FromUserName><![CDATA[fromUser]]></FromUserName>
+    # <CreateTime>12345678</CreateTime>
+    # <MsgType><![CDATA[video]]></MsgType>
+    # <Video>
+    # <MediaId><![CDATA[media_id]]></MediaId>
+    # <Title><![CDATA[title]]></Title>
+    # <Description><![CDATA[description]]></Description>
+    # </Video>
+    # </xml>
+
+    def reply_video_message(from=nil, to=nil, video)
       message = VideoReplyMessage.new
       message.FromUserName = from || @weixin_message.ToUserName
       message.ToUserName   = to   || @weixin_message.FromUserName

data/lib/weixin_rails_middleware/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weixin_rails_middleware
 version: !ruby/object:Gem::Version
-  version: 1.2.2
+  version: 1.2.3
 platform: ruby
 authors:
 - lanrion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -52,20 +52,6 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '3.1'
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.9.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: 1.9.0
 - !ruby/object:Gem::Dependency
   name: multi_xml
   requirement: !ruby/object:Gem::Requirement
@@ -111,7 +97,6 @@ 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

data/lib/weixin_rails_middleware/adapter.rb

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