wechat 0.5.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 26688ce4d31dd3c7df24fce05a5c722f255251a8
-  data.tar.gz: 8c504cbd4bd2b95eeadbafc51d99771777a6e23b
+  metadata.gz: 5c3c86998923262ea14fc33f0118b074d736b4d6
+  data.tar.gz: d0eae32ca05d72b784f1950bfd2da4f4ba6eac52
 SHA512:
-  metadata.gz: 7505d3220b2a8adfcd2b8883bdbbc76d2ed1ef65893e88e73deaf05219e484ade74d5822b6b8a10dcd0e26cb9b9f46ad0bb37a2acad4635ce9d53bd21c3080e3
-  data.tar.gz: acfe7dae6763e066bdceef9d97f5d91ea517ab33b3213f7b0278fba847def719b0df768eb967879e06119ae8e891910f00ec3c6a49b63ecf93fc458892210a34
+  metadata.gz: f9b65631598a034c1c9dd037f95e96f84d8b52e7559f2f85df610b53ba4f184530191e334a3e25409f523c4b108d9054dcdb90ca91e9675db7a756a30ba67703
+  data.tar.gz: a7f897913b4fb244a4de5d9ee8fcf40ae369ca3a302e4a5ba0e483bc99ab7ef932d53098c92f2c892e5c99cd20390439884b7dab7a0d838eec6832a398290360

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 # Changelog
 
+## v0.6.0 (released at 10/08/2015)
+
+### Scan and Batch job are BREAK CHANGE!
+
+* Scan 2D barcode using new syntax `on :scan, with: 'BINDING_QR_CODE' ` instead of `on :event, with: 'BINDING_QR_CODE' ` in previous version #55
+  Which will fix can not using `on :event, with: "scan" ` problem
+* Batch job using new syntax `on :batch_job, with: 'replace_user' `
+instead of previous `on :event, with: 'replace_user' `. 
+* Click menu support new syntax `on :click, with: 'BOOK_LUNCH' `, but `on :event, with: 'BOOK_LUNCH' ` still supported. perfer `on :click` because it running faster and more nature expression.
+* Wechat::Responder using Hash for new :client and :batch_job event, avoid time consuming Array match responder
+* Fix refresh token not working problem under ruby 2.0.0 #54
+* New department_update, user_batchdelete, convert_to_openid API
+
 ## v0.5.0 (released at 9/25/2015)
 
 * Only relay on activesupport on run time, so will greatly improve wechat cli startup time

data/README.md

@@ -1,7 +1,9 @@
 WeChat
 ======
 
-[![Build Status](https://travis-ci.org/Eric-Guo/wechat.svg)](https://travis-ci.org/Eric-Guo/wechat) [![Code Climate](https://codeclimate.com/github/Eric-Guo/wechat.png)](https://codeclimate.com/github/Eric-Guo/wechat) [![Code Coverage](https://codeclimate.com/github/Eric-Guo/wechat/coverage.png)](https://codeclimate.com/github/Eric-Guo/wechat) [![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://badge.fury.io/for/rb/wechat)
+[![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://badge.fury.io/for/rb/wechat) [![Build Status](https://travis-ci.org/Eric-Guo/wechat.svg)](https://travis-ci.org/Eric-Guo/wechat) [![Code Climate](https://codeclimate.com/github/Eric-Guo/wechat.png)](https://codeclimate.com/github/Eric-Guo/wechat) [![Code Coverage](https://codeclimate.com/github/Eric-Guo/wechat/coverage.png)](https://codeclimate.com/github/Eric-Guo/wechat)
+
+[![Issue Stats](http://issuestats.com/github/Eric-Guo/wechat/badge/issue)](http://issuestats.com/github/Eric-Guo/wechat) [![PR Stats](http://issuestats.com/github/Eric-Guo/wechat/badge/pr)](http://issuestats.com/github/Eric-Guo/wechat)
 
 
 WeChat gem 可以帮助开发者方便地在Rails环境中集成微信[公众平台](https://mp.weixin.qq.com/)和[企业平台](https://qy.weixin.qq.com)提供的服务，包括：
@@ -160,6 +162,7 @@ Wechat commands:
   wechat batch_replaceuser [BATCH_USER_CSV_MEDIA_ID]       # 全量覆盖成员
   wechat batch_syncuser [SYNC_USER_CSV_MEDIA_ID]           # 增量更新成员
   wechat callbackip                                        # 获取微信服务器IP地址
+  wechat convert_to_openid [USER_ID]                       # userid转换成openid
   wechat custom_image [OPENID, IMAGE_PATH]                 # 发送图片客服消息
   wechat custom_music [OPENID, THUMBNAIL_PATH, MUSIC_URL]  # 发送音乐客服消息
   wechat custom_news [OPENID, NEWS_YAML_PATH]              # 发送图文客服消息
@@ -169,6 +172,7 @@ Wechat commands:
   wechat department [DEPARTMENT_ID]                        # 获取部门列表
   wechat department_create [NAME, PARENT_ID]               # 创建部门
   wechat department_delete [DEPARTMENT_ID]                 # 删除部门
+  wechat department_update [DEPARTMENT_ID, NAME]           # 更新部门  
   wechat group_create [GROUP_NAME]                         # 创建分组
   wechat group_delete [GROUP_ID]                           # 删除分组
   wechat group_update [GROUP_ID, NEW_GROUP_NAME]           # 修改分组名
@@ -199,6 +203,7 @@ Wechat commands:
   wechat tags                                              # 获取标签列表
   wechat template_message [OPENID, TEMPLATE_YAML_PATH]     # 模板消息接口
   wechat user [OPEN_ID]                                    # 获取用户基本信息
+  wechat user_batchdelete [USER_ID_LIST]                   # 批量删除成员  
   wechat user_change_group [OPEN_ID, TO_GROUP_ID]          # 移动用户分组
   wechat user_delete [USER_ID]                             # 删除成员
   wechat user_group [OPEN_ID]                              # 查询用户所在分组
@@ -377,18 +382,38 @@ class WechatsController < ApplicationController
     end
   end
 
-  # 当收到EventKey 为二维码扫描结果事件时
-  on :event, with: 'BINDING_QR_CODE' do |request, scan_result, scan_type|
+  # 当用户加关注
+  on :event, with: 'subscribe' do |request|
+    request.reply.text "User #{request[:FromUserName]} subscribe now"
+  end
+
+  # 公众号收到未关注用户扫描qrscene_xxxxxx二维码时。注意此次扫描事件将不再引发上条的用户加关注事件
+  on :scan, with: 'qrscene_xxxxxx' do |request, ticket|
+    request.reply.text "Unsubscribe user #{request[:FromUserName]} Ticket #{ticket}"
+  end
+
+  # 公众号收到已关注用户扫描创建二维码的scene_id事件时
+  on :scan, with: 'scene_id' do |request, ticket|
+    request.reply.text "Subscribe user #{request[:FromUserName]} Ticket #{ticket}"
+  end
+
+  # 企业号收到EventKey 为二维码扫描结果事件时
+  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
 
-  # 当收到EventKey 为CODE 39码扫描结果事件时
-  on :event, with: 'BINDING_BARCODE' do |message, scan_result|
+  # 企业号收到EventKey 为CODE 39码扫描结果事件时
+  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
 
+  # 当用户点击菜单时
+  on :click, with: 'BOOK_LUNCH' do |request, key|
+    request.reply.text "User: #{request[:FromUserName]} click #{key}"
+  end
+
   # 处理图片信息
   on :image do |request|
     request.reply.image(request[:MediaId]) #直接将图片返回给用户
@@ -410,11 +435,6 @@ class WechatsController < ApplicationController
     request.reply.text("#{request[:Location_X]}, #{request[:Location_Y]}") #回复地理位置
   end
 
-  # 当用户加关注
-  on :event, with: 'subscribe' do |request|
-    request.reply.text "#{request[:FromUserName]} subscribe now"
-  end
-
   # 当用户取消关注订阅
   on :event, with: 'unsubscribe' do |request|
     request.reply.text "#{request[:FromUserName]} can not receive this message"
@@ -426,22 +446,22 @@ class WechatsController < ApplicationController
   end
 
   # 当异步任务增量更新成员完成时推送
-  on :event, with: 'sync_user' do |request, batch_job|
+  on :batch_job, with: 'sync_user' do |request, batch_job|
     request.reply.text "job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
   end
 
   # 当异步任务全量覆盖成员完成时推送
-  on :event, with: 'replace_user' do |request, batch_job|
+  on :batch_job, with: 'replace_user' do |request, batch_job|
     request.reply.text "job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
   end
 
   # 当异步任务邀请成员关注完成时推送
-  on :event, with: 'invite_user' do |request, batch_job|
+  on :batch_job, with: 'invite_user' do |request, batch_job|
     request.reply.text "job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
   end
 
   # 当异步任务全量覆盖部门完成时推送
-  on :event, with: 'replace_party' do |request, batch_job|
+  on :batch_job, with: 'replace_party' do |request, batch_job|
     request.reply.text "job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
   end
 
@@ -456,8 +476,8 @@ end
 on <message_type> do |message|
  message.reply.text "some text"
 end
-
 ```
+
 来响应用户信息。
 
 目前支持的message_type有如下几种
@@ -469,6 +489,9 @@ end
 - :location 响应地理位置消息
 - :link 响应链接消息
 - :event 响应事件消息, 可以用`:with`参数来匹配事件类型
+- :click 虚拟响应事件消息, 微信仍然传入:event，但gem内部会单独处理
+- :scan  虚拟响应事件消息
+- :batch_job  虚拟响应事件消息
 - :fallback 默认响应，当收到的消息无法被其他responder响应时，会使用这个responder.
 
 ### 多客服消息转发

data/bin/wechat

@@ -107,6 +107,14 @@ HELP
     puts Helper.with(options).department_delete(departmentid)
   end
 
+  desc 'department_update [DEPARTMENT_ID, NAME]', '更新部门'
+  method_option :parentid, aliases: '-p', desc: '父亲部门id。根部门id为1', default: nil
+  method_option :order, aliases: '-o', desc: '在父部门中的次序值。order值小的排序靠前。', default: nil
+  def department_update(departmentid, name)
+    api_opts = options.slice(:parentid, :order)
+    puts Helper.with(options).department_update(departmentid, name, api_opts[:parentid], api_opts[:order])
+  end
+
   desc 'department [DEPARTMENT_ID]', '获取部门列表'
   def department(departmentid = 0)
     r = Helper.with(options).department(departmentid)
@@ -229,6 +237,11 @@ HELP
     puts Helper.with(options).user(open_id)
   end
 
+  desc 'convert_to_openid [USER_ID]', 'userid转换成openid'
+  def convert_to_openid(userid)
+    puts Helper.with(options).convert_to_openid(userid)
+  end
+
   desc 'invite_user [USER_ID]', '邀请成员关注'
   def invite_user(userid)
     puts Helper.with(options).invite_user(userid)
@@ -239,6 +252,11 @@ HELP
     puts Helper.with(options).user_delete(userid)
   end
 
+  desc 'user_batchdelete [USER_ID_LIST]', '批量删除成员'
+  def user_batchdelete(useridlist)
+    puts Helper.with(options).user_batchdelete(useridlist.split(','))
+  end
+
   desc 'batch_job_result [JOB_ID]', '获取异步任务结果'
   def batch_job_result(job_id)
     puts Helper.with(options).batch_job_result(job_id)

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

@@ -20,18 +20,38 @@ class WechatsController < ApplicationController
     end
   end
 
-  # When user press menu BINDING_QR_CODE and success to scan bar code
-  on :event, with: 'BINDING_QR_CODE' do |request, scan_result, scan_type|
+  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 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
-  on :event, with: 'BINDING_BARCODE' do |message, scan_result|
+  # 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 sent the imsage
   on :image do |request|
     request.reply.image(request[:MediaId]) # Echo the sent image to user
@@ -53,10 +73,6 @@ class WechatsController < ApplicationController
     request.reply.text("#{request[:Location_X]}, #{request[:Location_Y]}") # replay the GPS location
   end
 
-  on :event, with: 'subscribe' do |request|
-    request.reply.text "#{request[:FromUserName]} subscribe now"
-  end
-
   on :event, with: 'unsubscribe' do |request|
     request.reply.text "#{request[:FromUserName]} can not receive this message"
   end
@@ -67,22 +83,22 @@ class WechatsController < ApplicationController
   end
 
   # When batch job create/update user (incremental) finished.
-  on :event, with: 'sync_user' do |request, batch_job|
+  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 :event, with: 'replace_user' do |request, batch_job|
+  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 :event, with: 'invite_user' do |request, batch_job|
+  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 :event, with: 'replace_party' do |request, batch_job|
+  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
 

data/lib/wechat/access_token.rb

@@ -23,7 +23,7 @@ module Wechat
 
     def refresh
       data = client.get('token', params: { grant_type: 'client_credential', appid: appid, secret: secret })
-      data.merge!(created_at: Time.now.to_i)
+      data.merge!('created_at'.freeze => Time.now.to_i)
       File.write(token_file, data.to_json) if valid_token(data)
       @token_data = data
     end

data/lib/wechat/corp_api.rb

@@ -35,6 +35,10 @@ module Wechat
       get 'user/get', params: { userid: userid }
     end
 
+    def convert_to_openid(userid)
+      post 'user/convert_to_openid', JSON.generate(userid: userid, agentid: agentid)
+    end
+
     def invite_user(userid)
       post 'invite/send', JSON.generate(userid: userid)
     end
@@ -47,6 +51,10 @@ module Wechat
       get 'user/delete', params: { userid: userid }
     end
 
+    def user_batchdelete(useridlist)
+      post 'user/batchdelete', JSON.generate(useridlist: useridlist)
+    end
+
     def batch_job_result(jobid)
       get 'batch/getresult', params: { jobid: jobid }
     end
@@ -71,6 +79,10 @@ module Wechat
       get 'department/delete', params: { id: departmentid }
     end
 
+    def department_update(departmentid, name = nil, parentid = nil, order = nil)
+      post 'department/update', JSON.generate({ id: departmentid, name: name, parentid: parentid, order: order }.reject { |_k, v| v.nil? })
+    end
+
     def department(departmentid = 1)
       get 'department/list', params: { id: departmentid }
     end

data/lib/wechat/jsapi_ticket.rb

@@ -1,3 +1,4 @@
+# coding: utf-8
 require 'digest/sha1'
 
 module Wechat
@@ -34,7 +35,7 @@ module Wechat
     # 刷新 jsapi_ticket
     def refresh
       data = client.get('ticket/getticket', params: { access_token: access_token.token, type: 'jsapi' })
-      data.merge!(created_at: Time.now.to_i)
+      data.merge!('created_at'.freeze => Time.now.to_i)
       File.open(jsapi_ticket_file, 'w') { |f| f.write(data.to_json) } if valid_ticket(data)
       @jsapi_ticket_data = data
     end

data/lib/wechat/responder.rb

@@ -15,20 +15,39 @@ module Wechat
       attr_accessor :wechat, :token, :corpid, :agentid, :encrypt_mode, :skip_verify_ssl, :encoding_aes_key
 
       def on(message_type, with: nil, respond: nil, &block)
-        fail 'Unknow message type' unless [:text, :image, :voice, :video, :location, :link, :event, :fallback].include?(message_type)
+        fail 'Unknow message type' unless [:text, :image, :voice, :video, :location, :link, :event, :click, :scan, :batch_job, :fallback].include?(message_type)
         config = respond.nil? ? {} : { respond: respond }
         config.merge!(proc: block) if block_given?
 
-        if with.present? && ![:text, :event].include?(message_type)
-          fail 'Only text and event message can take :with parameters'
+        if with.present?
+          fail 'Only text, event, click, scan and batch_job can having :with parameters' unless [:text, :event, :click, :scan, :batch_job].include?(message_type)
+          config.merge!(with: with)
+          self.known_scan_key_lists = with if message_type == :scan
         else
-          config.merge!(with: with) if with.present?
+          fail 'Message type click, scan and batch_job must specify :with parameters' if [:click, :scan, :batch_job].include?(message_type)
         end
 
-        user_defined_responders(message_type) << config
+        case message_type
+        when :click
+          user_defined_click_responders(with) << config
+        when :batch_job
+          user_defined_batch_job_responders(with) << config
+        else
+          user_defined_responders(message_type) << config
+        end
         config
       end
 
+      def user_defined_click_responders(with)
+        @click_responders ||= {}
+        @click_responders[with] ||= []
+      end
+
+      def user_defined_batch_job_responders(with)
+        @batch_job_responders ||= {}
+        @batch_job_responders[with] ||= []
+      end
+
       def user_defined_responders(type)
         @responders ||= {}
         @responders[type] ||= []
@@ -42,16 +61,14 @@ module Wechat
         when :text
           yield(* match_responders(responders, message[:Content]))
         when :event
-          if 'click' == message[:Event]
+          if 'click' == message[:Event] && !user_defined_click_responders(message[:EventKey]).empty?
+            yield(* user_defined_click_responders(message[:EventKey]), message[:EventKey])
+          elsif 'click' == message[:Event]
             yield(* match_responders(responders, message[:EventKey]))
-          elsif %w(scancode_push scancode_waitmsg).include? message[:Event]
-            yield(* match_responders(responders, event: 'scancode',
-                                                 event_key: message[:EventKey],
-                                                 scan_type: message[:ScanCodeInfo][:ScanType],
-                                                 scan_result: message[:ScanCodeInfo][:ScanResult]))
+          elsif known_scan_key_lists.include?(message[:EventKey])
+            yield(* known_scan_with_match_responders(user_defined_responders(:scan), message))
           elsif 'batch_job_result' == message[:Event]
-            yield(* match_responders(responders, event: 'batch_job',
-                                                 batch_job: message[:BatchJob]))
+            yield(* user_defined_batch_job_responders(message[:BatchJob][:JobType]), message[:BatchJob])
           else
             yield(* match_responders(responders, message[:Event]))
           end
@@ -73,16 +90,32 @@ module Wechat
 
           if condition.is_a? Regexp
             memo[:scoped] ||= [responder] + $LAST_MATCH_INFO.captures if value =~ condition
-          elsif value.is_a? Hash
-            memo[:scoped] ||= [responder, value[:scan_result], value[:scan_type]] if value[:event_key] == condition && value[:event] == 'scancode'
-            memo[:scoped] ||= [responder, value[:batch_job]] if value[:event] == 'batch_job' &&
-                                                                %w(sync_user replace_user invite_user replace_party).include?(condition.downcase)
           else
             memo[:scoped] ||= [responder, value] if value == condition
           end
         end
         matched[:scoped] || matched[:general]
       end
+
+      def known_scan_with_match_responders(responders, message)
+        matched = responders.each_with_object({}) do |responder, memo|
+          if %w(scan subscribe).include?(message[:Event]) && message[:EventKey] == responder[:with]
+            memo[:scaned] ||= [responder, message[:Ticket]]
+          elsif %w(scancode_push scancode_waitmsg).include?(message[:Event]) && message[:EventKey] == responder[:with]
+            memo[:scaned] ||= [responder, message[:ScanCodeInfo][:ScanResult], message[:ScanCodeInfo][:ScanType]]
+          end
+        end
+        matched[:scaned]
+      end
+
+      def known_scan_key_lists
+        @known_scan_key_lists ||= []
+      end
+
+      def known_scan_key_lists=(qrscene_value)
+        @known_scan_key_lists ||= []
+        @known_scan_key_lists << qrscene_value
+      end
     end
 
     def wechat

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2015-10-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -112,7 +112,13 @@ homepage: https://github.com/Eric-Guo/wechat
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |-
+  *****WECHAT BREAK CHANGE*****
+  1. Scan 2D barcode using new syntax `on :scan, with: 'BINDING_QR_CODE' `
+  instead of previous `on :event, with: 'BINDING_QR_CODE' `.
+  2. Batch job using new syntax `on :batch_job, with: 'replace_user' `
+  instead of previous `on :event, with: 'replace_user' `.
+  *****************************
 rdoc_options: []
 require_paths:
 - lib