wechat 0.7.5 → 0.7.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51c5c439ece595c22e3382f948a56643c49fe613
-  data.tar.gz: 79f38b3fb01e9ffe6b6ef25beb214ff7976ce3f6
+  metadata.gz: bfc807dea051fded9c082a6bdbf4778433b2bbce
+  data.tar.gz: 55e132829fc449ed8fd9ec591ee05710386037bb
 SHA512:
-  metadata.gz: 22bc4cf0506b8a59f4f13c3bf209dff2e723693e40abb8472e3abf1578c3f155c133ed7f5861998e8f7a371250fbfdb726124ccb5c7e9950b5a8137a1766d65a
-  data.tar.gz: 1f8c0f29f74dd3ce86c6829a0f4bc594241ce70b0353946b886425332cf8d97c86bc531915d8d2c9b819438ac39d6bca76665001fd264971954f8e563d52cbf8
+  metadata.gz: f4b26ce081c96d50de0e02340a6745f3cdff6334dfbdc7a521f74ee06136521ccbd42e7cf0ae2e52ba71e9dc73384e287de0c76486a95a8f0c12c4cbc3d98437
+  data.tar.gz: 2d6867ec622f4ae9748072eeeac18a19536579d8b74a1c56d3e59ebdf886b85a0de5dd694376fd2a0db7ca2b16542109f9eee5a6ad41d978e5dab3b903e3737a

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.7.6 (released at 3/05/2016)
+
+* Support wechat public account conditional menu. #95
+
 ## v0.7.5 (released at 2/21/2016)
 
 * New wechat_config_js to simplify the Wechat jsapi config.

data/README-CN.md

@@ -225,8 +225,11 @@ Wechat commands:
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
   wechat menu                                              # 当前菜单
+  wechat menu_addconditional [CONDITIONAL_MENU_YAML_PATH]  # 创建个性化菜单  
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
+  wechat menu_delconditional [MENU_ID]                     # 删除个性化菜单  
   wechat menu_delete                                       # 删除菜单
+  wechat menu_trymatch [USER_ID]                           # 测试个性化菜单匹配结果  
   wechat oauth2_url [REDIRECT_URI]                         # 生成OAuth2.0验证URL
   wechat qrcode_create_limit_scene [SCENE_ID_OR_STR]       # 请求永久二维码
   wechat qrcode_create_scene [SCENE_ID, EXPIRE_SECONDS]    # 请求临时二维码
@@ -326,8 +329,9 @@ $ wechat menu
 ```
 
 ##### 创建菜单
-创建菜单需要一个定义菜单内容的yaml文件，比如
-menu.yaml
+
+
+通过运行`rails g wechat:menu`可以生成一个定义菜单内容的yaml文件,菜单可以包含下列内容：
 
 ```
 button:
@@ -363,13 +367,14 @@ button:
   url:  "http://blog.cloud-mes.com/"
 ```
 
-然后执行命令行，需确保设置，权限管理中有对此应用的管理权限，否则会报[60011](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%85%A8%E5%B1%80%E8%BF%94%E5%9B%9E%E7%A0%81%E8%AF%B4%E6%98%8E)错。
+下列命令行将上传自定义菜单：
 
 ```
 $ wechat menu_create menu.yaml
-
 ```
 
+需确保设置，权限管理中有对此应用的管理权限，否则会报[60011](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%85%A8%E5%B1%80%E8%BF%94%E5%9B%9E%E7%A0%81%E8%AF%B4%E6%98%8E)错。
+
 ##### 发送客服图文消息
 需定义一个图文消息内容的yaml文件，比如
 articles.yaml
@@ -572,9 +577,10 @@ end
 - :text 响应文字消息,可以用`:with`参数来匹配文本内容 `on(:text, with:'help'){|message, content| ...}`
 - :image 响应图片消息
 - :voice 响应语音消息
+- :shortvideo 响应短视频消息
 - :video 响应视频消息
 - :link 响应链接消息
-- :event 响应事件消息, 可以用`:with`参数来匹配事件类型
+- :event 响应事件消息, 可以用`:with`参数来匹配事件类型，同文字消息类似，支持正则表达式匹配
 - :click 虚拟响应事件消息, 微信传入:event，但gem内部会单独处理
 - :view 虚拟响应事件消息, 微信传入:event，但gem内部会单独处理
 - :scan  虚拟响应事件消息

data/README.md

@@ -240,8 +240,11 @@ Wechat commands:
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
   wechat menu                                              # 当前菜单
+  wechat menu_addconditional [CONDITIONAL_MENU_YAML_PATH]  # 创建个性化菜单  
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
+  wechat menu_delconditional [MENU_ID]                     # 删除个性化菜单  
   wechat menu_delete                                       # 删除菜单
+  wechat menu_trymatch [USER_ID]                           # 测试个性化菜单匹配结果  
   wechat oauth2_url [REDIRECT_URI]                         # 生成OAuth2.0验证URL
   wechat qrcode_create_limit_scene [SCENE_ID_OR_STR]       # 请求永久二维码
   wechat qrcode_create_scene [SCENE_ID, EXPIRE_SECONDS]    # 请求临时二维码
@@ -341,7 +344,7 @@ $ wechat menu
 
 ##### Menu create
 
-menu content for a wechat application can be defined as a yaml files, like `menu.yaml`
+Running command `rails g wechat:menu` to generate a menu defination yaml file:
 
 ```
 button:
@@ -377,12 +380,14 @@ button:
   url:  "http://blog.cloud-mes.com/"
 ```
 
-Caution: make sure you having management privilege for those application below running below command, other will got [60011](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%85%A8%E5%B1%80%E8%BF%94%E5%9B%9E%E7%A0%81%E8%AF%B4%E6%98%8E) error.
+Running below command to upload the menu:
 
 ```
 $ wechat menu_create menu.yaml
 ```
 
+Caution: make sure you having management privilege for those application， otherwise will got [60011](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%85%A8%E5%B1%80%E8%BF%94%E5%9B%9E%E7%A0%81%E8%AF%B4%E6%98%8E) error.
+
 ##### Sent custom news
 
 
@@ -586,9 +591,10 @@ Below is current supported message_type:
 - :text  text message, using `:with` to match text content like `on(:text, with:'help'){|message, content| ...}`
 - :image image message
 - :voice voice message
+- :shortvideo shortvideo message
 - :video video message
 - :link  link message
-- :event event message, using `:with` to match particular event
+- :event event message, using `:with` to match particular event, support regular expression match similr to text message.
 - :click virtual event message, wechat still sent event message，but gems will mapping to menu click event.
 - :view  virtual view message, wechat still sent event message，but gems will mapping to menu view page event.
 - :scan  virtual scan message, wechat still sent event message, but gems will mapping on scan event

data/bin/wechat

@@ -320,6 +320,23 @@ class App < Thor
     puts 'Menu created' if wechat_api.menu_create(menu)
   end
 
+  desc 'menu_addconditional [CONDITIONAL_MENU_YAML_PATH]', '创建个性化菜单'
+  def menu_addconditional(conditional_menu_yaml_path)
+    conditional_menu = YAML.load(File.read(conditional_menu_yaml_path))
+    add_result = wechat_api.menu_addconditional(conditional_menu)
+    puts "Conditional menu created: #{add_result}" if add_result
+  end
+
+  desc 'menu_trymatch [USER_ID]', '测试个性化菜单匹配结果'
+  def menu_trymatch(user_id)
+    puts wechat_api.menu_trymatch(user_id)
+  end
+
+  desc 'menu_delconditional [MENU_ID]', '删除个性化菜单'
+  def menu_delconditional(menuid)
+    puts wechat_api.menu_delconditional(menuid)
+  end
+
   desc 'media [MEDIA_ID, PATH]', '媒体下载'
   def media(media_id, path)
     tmp_file = wechat_api.media(media_id)

data/lib/generators/wechat/menu_generator.rb

@@ -0,0 +1,21 @@
+module Wechat
+  module Generators
+    class MenuGenerator < Rails::Generators::Base
+      desc 'Generate wechat menu'
+      source_root File.expand_path('../templates', __FILE__)
+      class_option :conditional, desc: 'Generate conditional menu', type: :boolean, default: false
+
+      def copy_menu
+        if options.conditional?
+          template 'config/wechat_menu_android.yml'
+        else
+          template 'config/wechat_menu.yml'
+        end
+      end
+
+      def show_readme
+        readme 'MENU_README' if behavior == :invoke
+      end
+    end
+  end
+end

data/lib/generators/wechat/templates/MENU_README

@@ -0,0 +1,3 @@
+Run `wechat menu_create config\wechat_menu.yml` to uploading the default menu.
+Run `rails g wechat:menu --conditional` to generate one example of conditional menu.
+Run `wechat menu_addconditional config\wechat_menu_conditional.yml` to uploading the conditional menu.

data/lib/generators/wechat/templates/app/controllers/wechats_controller.rb

@@ -3,121 +3,10 @@ class WechatsController < ApplicationController
 <% else -%>
 class WechatsController < ActionController::Base
 <% end -%>
+  # For details on the DSL available within this file, see https://github.com/Eric-Guo/wechat#rails-responder-controller-dsl
   wechat_responder
 
-  # default text responder when no other match
   on :text do |request, content|
     request.reply.text "echo: #{content}" # Just echo
   end
-
-  # When receive 'help', will trigger this responder
-  on :text, with: 'help' do |request|
-    request.reply.text 'help content'
-  end
-
-  # When receive '<n>news', will match and will got count as <n> as parameter
-  on :text, with: /^(\d+) news$/ do |request, count|
-    # Wechat article can only contain max 10 items, large than 10 will dropped.
-    news = (1..count.to_i).each_with_object([]) { |n, memo| memo << { title: 'News title', content: "No. #{n} news content" } }
-    request.reply.news(news) do |article, n, index| # article is return object
-      article.item title: "#{index} #{n[:title]}", description: n[:content], pic_url: 'http://www.baidu.com/img/bdlogo.gif', url: 'http://www.baidu.com/'
-    end
-  end
-
-  on :event, with: 'subscribe' do |request|
-    request.reply.text "#{request[:FromUserName]} subscribe now"
-  end
-
-  # When unsubscribe user scan qrcode qrscene_xxxxxx to subscribe in public account
-  # notice user will subscribe public account at same time, so wechat won't trigger subscribe event any more
-  on :scan, with: 'qrscene_xxxxxx' do |request, ticket|
-    request.reply.text "Unsubscribe user #{request[:FromUserName]} Ticket #{ticket}"
-  end
-
-  # When subscribe user scan scene_id in public account
-  on :scan, with: 'scene_id' do |request, ticket|
-    request.reply.text "Subscribe user #{request[:FromUserName]} Ticket #{ticket}"
-  end
-
-  # When no any on :scan responder can match subscribe user scaned scene_id
-  on :event, with: 'scan' do |request|
-    if request[:EventKey].present?
-      request.reply.text "event scan got EventKey #{request[:EventKey]} Ticket #{request[:Ticket]}"
-    end
-  end
-
-  # When enterprise user press menu BINDING_QR_CODE and success to scan bar code
-  on :scan, with: 'BINDING_QR_CODE' do |request, scan_result, scan_type|
-    request.reply.text "User #{request[:FromUserName]} ScanResult #{scan_result} ScanType #{scan_type}"
-  end
-
-  # Except QR code, wechat can also scan CODE_39 bar code in enterprise account
-  on :scan, with: 'BINDING_BARCODE' do |message, scan_result|
-    if scan_result.start_with? 'CODE_39,'
-      message.reply.text "User: #{message[:FromUserName]} scan barcode, result is #{scan_result.split(',')[1]}"
-    end
-  end
-
-  # When user click the menu button
-  on :click, with: 'BOOK_LUNCH' do |request, key|
-    request.reply.text "User: #{request[:FromUserName]} click #{key}"
-  end
-
-  # When user view URL in the menu button
-  on :view, with: 'http://wechat.somewhere.com/view_url' do |request, view|
-    request.reply.text "#{request[:FromUserName]} view #{view}"
-  end
-
-  # When user sent the imsage
-  on :image do |request|
-    request.reply.image(request[:MediaId]) # Echo the sent image to user
-  end
-
-  # When user sent the voice
-  on :voice do |request|
-    request.reply.voice(request[:MediaId]) # Echo the sent voice to user
-  end
-
-  # When user sent the video
-  on :video do |request|
-    nickname = wechat.user(request[:FromUserName])['nickname'] # Call wechat api to get sender nickname
-    request.reply.video(request[:MediaId], title: 'Echo', description: "Got #{nickname} sent video") # Echo the sent video to user
-  end
-
-  # When user sent location
-  on :location do |request|
-    request.reply.text("Latitude: #{message[:Latitude]} Longitude: #{message[:Longitude]} Precision: #{message[:Precision]}")
-  end
-
-  on :event, with: 'unsubscribe' do |request|
-    request.reply.success # user can not receive this message
-  end
-
-  # When user enter the app / agent app
-  on :event, with: 'enter_agent' do |request|
-    request.reply.text "#{request[:FromUserName]} enter agent app now"
-  end
-
-  # When batch job create/update user (incremental) finished.
-  on :batch_job, with: 'sync_user' do |request, batch_job|
-    request.reply.text "sync_user job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
-  end
-
-  # When batch job replace user (full sync) finished.
-  on :batch_job, with: 'replace_user' do |request, batch_job|
-    request.reply.text "replace_user job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
-  end
-
-  # When batch job invent user finished.
-  on :batch_job, with: 'invite_user' do |request, batch_job|
-    request.reply.text "invite_user job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
-  end
-
-  # When batch job replace department (full sync) finished.
-  on :batch_job, with: 'replace_party' do |request, batch_job|
-    request.reply.text "replace_party job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
-  end
-
-  # Any not match above will fail to below
-  on :fallback, respond: 'fallback message'
 end

data/lib/generators/wechat/templates/app/models/wechat_session.rb

@@ -10,7 +10,7 @@ class WechatSession < ActiveRecord::Base
   end
 
   # called by wechat gems after response Techent server at controller#create
-  def save_session(response_message)
+  def save_session(_response_message)
     touch unless new_record? # Always refresh updated_at even no change
     save!
   end

data/lib/generators/wechat/templates/config/wechat_menu.yml

@@ -0,0 +1,6 @@
+# More option see https://github.com/Eric-Guo/wechat#menu-create
+button:
+ -
+  type: "view"
+  name: "Testing"
+  url:  "http://xxxxx.proxy.qqbrowser.cc"

data/lib/generators/wechat/templates/config/wechat_menu_android.yml

@@ -0,0 +1,15 @@
+button:
+ -
+  type: "view"
+  name: "Testing Android"
+  url:  "http://xxxxx.proxy.qqbrowser.cc"
+
+# More match rule see http://mp.weixin.qq.com/wiki/0/c48ccd12b69ae023159b4bfaa7c39c20.html
+matchrule:
+#  group_id: 2
+#  sex: 1
+#  country: 中国
+#  province: 上海
+#  city: 杨浦
+  client_platform_type: 1
+#  language: zh_CN

data/lib/wechat/api.rb

@@ -5,8 +5,8 @@ require 'wechat/ticket/public_jsapi_ticket'
 
 module Wechat
   class Api < ApiBase
-    API_BASE = 'https://api.weixin.qq.com/cgi-bin/'
-    OAUTH2_BASE = 'https://api.weixin.qq.com/sns/oauth2/'
+    API_BASE = 'https://api.weixin.qq.com/cgi-bin/'.freeze
+    OAUTH2_BASE = 'https://api.weixin.qq.com/sns/oauth2/'.freeze
 
     def initialize(appid, secret, token_file, timeout, skip_verify_ssl, jsapi_ticket_file)
       @client = Client.new(API_BASE, timeout, skip_verify_ssl)
@@ -85,6 +85,19 @@ module Wechat
       post 'menu/create', JSON.generate(menu)
     end
 
+    def menu_addconditional(menu)
+      # Wechat not accept 7bit escaped json(eg \uxxxx), must using UTF-8, possible security vulnerability?
+      post 'menu/addconditional', JSON.generate(menu)
+    end
+
+    def menu_trymatch(user_id)
+      post 'menu/trymatch', JSON.generate(user_id: user_id)
+    end
+
+    def menu_delconditional(menuid)
+      post 'menu/delconditional', JSON.generate(menuid: menuid)
+    end
+
     def material(media_id)
       get 'material/get', params: { media_id: media_id }, as: :file
     end

data/lib/wechat/api_base.rb

@@ -2,7 +2,7 @@ module Wechat
   class ApiBase
     attr_reader :access_token, :client, :jsapi_ticket
 
-    MP_BASE = 'https://mp.weixin.qq.com/cgi-bin/'
+    MP_BASE = 'https://mp.weixin.qq.com/cgi-bin/'.freeze
 
     def callbackip
       get 'getcallbackip'

data/lib/wechat/cipher.rb

@@ -7,7 +7,7 @@ module Wechat
     extend ActiveSupport::Concern
 
     BLOCK_SIZE = 32
-    CIPHER = 'AES-256-CBC'
+    CIPHER = 'AES-256-CBC'.freeze
 
     def encrypt(plain, encoding_aes_key)
       cipher = OpenSSL::Cipher.new(CIPHER)

data/lib/wechat/corp_api.rb

@@ -8,7 +8,7 @@ module Wechat
   class CorpApi < ApiBase
     attr_reader :agentid
 
-    API_BASE = 'https://qyapi.weixin.qq.com/cgi-bin/'
+    API_BASE = 'https://qyapi.weixin.qq.com/cgi-bin/'.freeze
 
     def initialize(appid, secret, token_file, agentid, timeout, skip_verify_ssl, jsapi_ticket_file)
       @client = Client.new(API_BASE, timeout, skip_verify_ssl)

data/lib/wechat/message.rb

@@ -143,9 +143,9 @@ module Wechat
       'MediaId' => 'media_id',
       'ThumbMediaId' => 'thumb_media_id',
       'TemplateId' => 'template_id'
-    }
+    }.freeze
 
-    TO_JSON_ALLOWED = %w(touser msgtype content image voice video music news articles template agentid)
+    TO_JSON_ALLOWED = %w(touser msgtype content image voice video music news articles template agentid).freeze
 
     def to_json
       json_hash = deep_recursive(message_hash) do |key, value|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-21 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,12 +136,16 @@ files:
 - bin/wechat
 - lib/action_controller/wechat_responder.rb
 - lib/generators/wechat/install_generator.rb
+- lib/generators/wechat/menu_generator.rb
 - lib/generators/wechat/redis_store_generator.rb
 - lib/generators/wechat/session_generator.rb
+- lib/generators/wechat/templates/MENU_README
 - lib/generators/wechat/templates/app/controllers/wechats_controller.rb
 - lib/generators/wechat/templates/app/models/wechat_session.rb
 - lib/generators/wechat/templates/config/initializers/wechat_redis_store.rb
 - lib/generators/wechat/templates/config/wechat.yml
+- lib/generators/wechat/templates/config/wechat_menu.yml
+- lib/generators/wechat/templates/config/wechat_menu_android.yml
 - lib/generators/wechat/templates/db/migration.rb
 - lib/wechat.rb
 - lib/wechat/api.rb