wechat 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ff11a10da8e6a405f646702fc63e4b72e778ace
-  data.tar.gz: 5269fd75b8a4044d6b140fdb197f3dd8381fc868
+  metadata.gz: 26688ce4d31dd3c7df24fce05a5c722f255251a8
+  data.tar.gz: 8c504cbd4bd2b95eeadbafc51d99771777a6e23b
 SHA512:
-  metadata.gz: 03775bee616b1c070efefaff727330ea8ce3411232ea3dffb3f8da2cd21d309b1aa8e86a07831711f198da5dbb5460bc71fa831900eba27c29ac291badad7548
-  data.tar.gz: 6e1001ea2b328e4c69fd6960bb8c7b50a0b178950c2c922ed482b37eacabdcc5c0b4cf7ec213490a80de6530695d79b428becf61d72c33f462dfc22586145433
+  metadata.gz: 7505d3220b2a8adfcd2b8883bdbbc76d2ed1ef65893e88e73deaf05219e484ade74d5822b6b8a10dcd0e26cb9b9f46ad0bb37a2acad4635ce9d53bd21c3080e3
+  data.tar.gz: acfe7dae6763e066bdceef9d97f5d91ea517ab33b3213f7b0278fba847def719b0df768eb967879e06119ae8e891910f00ec3c6a49b63ecf93fc458892210a34

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v0.5.0 (released at 9/25/2015)
+
+* Only relay on activesupport on run time, so will greatly improve wechat cli startup time
+* Add rails generator support `rails g wechat:install`
+* Add batch job support for enterprise account like batch create user/department, both API, callback responder and CLI
+* Add material management API and CLI
+* Add tag API and CLI for enterprise account
+* Add QR code scene function for public account
+
 ## v0.4.2 (released at 9/7/2015)
 
 * Fix wrong number of arguments at Wechat::Responder.on by using arity #47

data/README.md

@@ -28,6 +28,20 @@ Or add to your app's `Gemfile`:
 gem 'wechat'
 ```
 
+Run the following command to install it:
+
+```console
+bundle install
+```
+
+Run the generator:
+
+```console
+rails generate wechat:install
+```
+
+运行`rails g wechat:install`后会自动生成wechat.yml配置，还有wechat controller及相关路由配置到当前Rails项目。
+
 
 ## 配置
 
@@ -46,7 +60,7 @@ Windows或者使用企业号，需要存放在`C:/Users/[user_name]/`下，其
 ```
 corpid: "my_appid"
 corpsecret: "my_secret"
-agentid: "1" # 企业应用的id，整型。可在应用的设置页面查看
+agentid: 1 # 企业应用的id，整型。可在应用的设置页面查看
 access_token: "C:/Users/[user_name]/wechat_access_token"
 ```
 
@@ -81,7 +95,7 @@ test:
 default: &default
   corpid: "corpid"
   corpsecret: "corpsecret"
-  agentid:  "1"
+  agentid:  1
   access_token: "C:/Users/[user_name]/wechat_access_token"
   token:    ""
   encoding_aes_key:  ""
@@ -108,7 +122,7 @@ test:
 
 ##### 配置跳过SSL认证
 
-Wechat服务器有报道曾出现[RestClient::SSLCertificateNotVerified](http://qydev.weixin.qq.com/qa/index.php?qa=11037)错误，此时可以选择关闭SSL验证（skip_verify_ssl）。
+Wechat服务器有报道曾出现[RestClient::SSLCertificateNotVerified](http://qydev.weixin.qq.com/qa/index.php?qa=11037)错误，此时可以选择关闭SSL验证。`skip_verify_ssl: true`
 
 #### 为每个Responder配置不同的appid和secret
 
@@ -139,6 +153,12 @@ wechat gems 内部不会检查权限。但因公众号类型不同，和微信
 ```
 $ wechat
 Wechat commands:
+  wechat agent [AGENT_ID]                                  # 获取企业号应用详情
+  wechat agent_list                                        # 获取应用概况列表
+  wechat batch_job_result [JOB_ID]                         # 获取异步任务结果
+  wechat batch_replaceparty [BATCH_PARTY_CSV_MEDIA_ID]     # 全量覆盖部门
+  wechat batch_replaceuser [BATCH_USER_CSV_MEDIA_ID]       # 全量覆盖成员
+  wechat batch_syncuser [SYNC_USER_CSV_MEDIA_ID]           # 增量更新成员
   wechat callbackip                                        # 获取微信服务器IP地址
   wechat custom_image [OPENID, IMAGE_PATH]                 # 发送图片客服消息
   wechat custom_music [OPENID, THUMBNAIL_PATH, MUSIC_URL]  # 发送音乐客服消息
@@ -148,6 +168,7 @@ Wechat commands:
   wechat custom_voice [OPENID, VOICE_PATH]                 # 发送语音客服消息
   wechat department [DEPARTMENT_ID]                        # 获取部门列表
   wechat department_create [NAME, PARENT_ID]               # 创建部门
+  wechat department_delete [DEPARTMENT_ID]                 # 删除部门
   wechat group_create [GROUP_NAME]                         # 创建分组
   wechat group_delete [GROUP_ID]                           # 删除分组
   wechat group_update [GROUP_ID, NEW_GROUP_NAME]           # 修改分组名
@@ -155,19 +176,35 @@ Wechat commands:
   wechat invite_user [USER_ID]                             # 邀请成员关注
   wechat material [MEDIA_ID, PATH]                         # 永久媒体下载
   wechat material_add [MEDIA_TYPE, PATH]                   # 永久媒体上传
-  wechat material_count                                    # 获取素材总数
+  wechat material_count                                    # 获取永久素材总数
   wechat material_delete [MEDIA_ID]                        # 删除永久素材
+  wechat material_list [TYPE, OFFSET, COUNT]               # 获取永久素材列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
   wechat menu                                              # 当前菜单
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
   wechat menu_delete                                       # 删除菜单
   wechat message_send [OPENID, TEXT_MESSAGE]               # 发送文字消息(仅企业号)
+  wechat qrcode_create_limit_scene [SCENE_ID_OR_STR]       # 请求永久二维码
+  wechat qrcode_create_scene [SCENE_ID, EXPIRE_SECONDS]    # 请求临时二维码
+  wechat qrcode_download [TICKET, QR_CODE_PIC_PATH]        # 通过ticket下载二维码
+  wechat tag [TAG_ID]                                      # 获取标签成员
+  wechat tag_add_department [TAG_ID, PARTY_IDS]            # 增加标签部门
+  wechat tag_add_user [TAG_ID, USER_IDS]                   # 增加标签成员
+  wechat tag_create [TAGNAME, TAG_ID]                      # 创建标签
+  wechat tag_del_user [TAG_ID, USER_IDS]                   # 删除标签成员  
+  wechat tag_del_department [TAG_ID, PARTY_IDS]            # 删除标签部门
+  wechat tag_delete [TAG_ID]                               # 删除标签
+  wechat tag_update [TAG_ID, TAGNAME]                      # 更新标签名字
+  wechat tags                                              # 获取标签列表
   wechat template_message [OPENID, TEMPLATE_YAML_PATH]     # 模板消息接口
   wechat user [OPEN_ID]                                    # 获取用户基本信息
   wechat user_change_group [OPEN_ID, TO_GROUP_ID]          # 移动用户分组
   wechat user_delete [USER_ID]                             # 删除成员
   wechat user_group [OPEN_ID]                              # 查询用户所在分组
+  wechat user_list [DEPARTMENT_ID]                         # 获取部门成员详情
+  wechat user_simplelist [DEPARTMENT_ID]                   # 获取部门成员
+  wechat user_update_remark [OPEN_ID, REMARK]              # 设置备注名
   wechat users                                             # 关注者列表
 ```
 
@@ -221,20 +258,14 @@ button:
     type: "scancode_waitmsg"
     name: "绑定用餐二维码"
     key: "BINDING_QR_CODE"
-    sub_button:
-     -
    -
     type: "click"
     name: "预订午餐"
     key:  "BOOK_LUNCH"
-    sub_button:
-     -
    -
     type: "click"
     name: "预订晚餐"
     key:  "BOOK_DINNER"
-    sub_button:
-     -
  -
   name: "查询"
   sub_button:
@@ -242,19 +273,14 @@ button:
     type: "click"
     name: "进出记录"
     key:  "BADGE_IN_OUT"
-    sub_button:
-     -
    -
     type: "click"
     name: "年假余额"
     key:  "ANNUAL_LEAVE"
-    sub_button:
-     -
  -
   type: "view"
   name: "关于"
   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)错。
@@ -316,7 +342,6 @@ template:
 
 ```
 $ wechat template_message oCfEht9oM*********** template.yml
-
 ```
 
 ## Rails Responder Controller DSL
@@ -325,7 +350,6 @@ $ wechat template_message oCfEht9oM*********** template.yml
 
 ```ruby
   resource :wechat, only:[:show, :create]
-
 ```
 
 然后创建Controller class, 例如
@@ -340,16 +364,16 @@ class WechatsController < ApplicationController
   end
 
   # 当请求的文字信息内容为'help'时, 使用这个responder处理
-  on :text, with:"help" do |request, help|
-    request.reply.text "help content" #回复帮助信息
+  on :text, with: 'help' do |request|
+    request.reply.text 'help content' #回复帮助信息
   end
 
   # 当请求的文字信息内容为'<n>条新闻'时, 使用这个responder处理, 并将n作为第二个参数
   on :text, with: /^(\d+)条新闻$/ do |request, count|
     # 微信最多显示10条新闻，大于10条将只取前10条
-    news = (1..count.to_i).each_with_object([]) { |n, memo| memo << {title: "新闻标题", content: "第#{n}条新闻的内容#{n.hash}"} }
+    news = (1..count.to_i).each_with_object([]) { |n, memo| memo << { title: '新闻标题', content: "第#{n}条新闻的内容#{n.hash}" } }
     request.reply.news(news) do |article, n, index| # 回复"articles"
-      article.item title: "#{index} #{n[:title]}", description: n[:content], pic_url: "http://www.baidu.com/img/bdlogo.gif", url:"http://www.baidu.com/"
+      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
 
@@ -377,8 +401,8 @@ class WechatsController < ApplicationController
 
   # 处理视频信息
   on :video do |request|
-    nickname = wechat.user(request[:FromUserName])["nickname"] #调用 api 获得发送者的nickname
-    request.reply.video(request[:MediaId], title: "回声", description: "#{nickname}发来的视频请求") #直接视频返回给用户
+    nickname = wechat.user(request[:FromUserName])['nickname'] #调用 api 获得发送者的nickname
+    request.reply.video(request[:MediaId], title: '回声', description: "#{nickname}发来的视频请求") #直接视频返回给用户
   end
 
   # 处理地理位置信息
@@ -393,13 +417,37 @@ class WechatsController < ApplicationController
 
   # 当用户取消关注订阅
   on :event, with: 'unsubscribe' do |request|
-    request.reply.text "#{request[:FromUserName]}无法收到这条消息。"
+    request.reply.text "#{request[:FromUserName]} can not receive this message"
+  end
+
+  # 成员进入应用的事件推送
+  on :event, with: 'enter_agent' do |request|
+    request.reply.text "#{request[:FromUserName]} enter agent app now"
+  end
+
+  # 当异步任务增量更新成员完成时推送
+  on :event, 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|
+    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|
+    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|
+    request.reply.text "job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
   end
 
   # 当无任何responder处理用户信息时,使用这个responder处理
-  on :fallback, respond: "fallback message"  
+  on :fallback, respond: 'fallback message'
 end
-
 ```
 
 在controller中使用`wechat_responder`引入Responder DSL, 之后可以用
@@ -444,4 +492,5 @@ Wechat 的核心是一个Message DSL,帮助开发者构建各种类型的消息
   
 ## 已知问题
 
-企业号接受菜单消息时，Wechat腾讯服务器无法解析部分域名，请使用IP绑定回调URL，用户的普通消息目前不受影响。
+* 企业号接受菜单消息时，Wechat腾讯服务器无法解析部分域名，请使用IP绑定回调URL，用户的普通消息目前不受影响。
+* 企业号全量覆盖成员使用的csv通讯录格式，直接将下载的模板导入[是不工作的](http://qydev.weixin.qq.com/qa/index.php?qa=13978)，必须使用Excel打开，然后另存为csv格式才会变成合法格式。

data/bin/wechat

@@ -45,7 +45,7 @@ HELP
       home_config_file = File.join(Dir.home, '.wechat.yml')
 
       if File.exist?(rails_config_file)
-        config = YAML.load(ERB.new(File.new(rails_config_file).read).result)['default']
+        config = YAML.load(ERB.new(File.read(rails_config_file)).result)['default']
         if config.present? && (config['appid'] || config['corpid'])
           puts 'Using rails project config/wechat.yml default setting...'
         else
@@ -68,6 +68,13 @@ HELP
     puts Helper.with(options).callbackip
   end
 
+  desc 'qrcode_download [TICKET, QR_CODE_PIC_PATH]', '通过ticket下载二维码'
+  def qrcode_download(ticket, qr_code_pic_path)
+    tmp_file = Helper.with(options).qrcode(ticket)
+    FileUtils.mv(tmp_file.path, qr_code_pic_path)
+    puts 'File downloaded'
+  end
+
   desc 'groups', '所有用户分组列表'
   def groups
     puts Helper.with(options).groups
@@ -95,9 +102,121 @@ HELP
     puts Helper.with(options).department_create(name, api_opts[:parentid] || '1')
   end
 
+  desc 'department_delete [DEPARTMENT_ID]', '删除部门'
+  def department_delete(departmentid)
+    puts Helper.with(options).department_delete(departmentid)
+  end
+
   desc 'department [DEPARTMENT_ID]', '获取部门列表'
-  def department(departmentid)
-    puts Helper.with(options).department(departmentid)
+  def department(departmentid = 0)
+    r = Helper.with(options).department(departmentid)
+    puts "errcode: #{r['errcode']} errmsg: #{r['errmsg']}"
+    puts 'Or# pid  id name'
+    r['department'].sort_by { |d| d['order'].to_i + d['parentid'].to_i * 1000 } .each do |i|
+      puts format('%3d %3d %3d %s', i['order'], i['parentid'], i['id'], i['name'])
+    end
+  end
+
+  desc 'user_simplelist [DEPARTMENT_ID]', '获取部门成员'
+  method_option :fetch_child, aliases: '-c', desc: '是否递归获取子部门下面的成员', default: 1
+  method_option :status, aliases: '-s', desc: '0 获取全部成员，1 获取已关注成员列表，2 获取禁用成员列表，4 获取未关注成员列表。status可叠加', default: 0
+  def user_simplelist(departmentid = 0)
+    api_opts = options.slice(:fetch_child, :status)
+
+    r = Helper.with(options).user_simplelist(departmentid, api_opts[:fetch_child], api_opts[:status])
+    puts "errcode: #{r['errcode']} errmsg: #{r['errmsg']}"
+    puts " userid Name #{' ' * 20} department_ids"
+    r['userlist'].sort_by { |d| d['userid'] } .each do |i|
+      puts format('%7s %-25s %-14s', i['userid'], i['name'], i['department'])
+    end
+  end
+
+  desc 'user_list [DEPARTMENT_ID]', '获取部门成员详情'
+  method_option :fetch_child, aliases: '-c', desc: '是否递归获取子部门下面的成员', default: 0
+  method_option :status, aliases: '-s', desc: '0 获取全部成员，1 获取已关注成员列表，2 获取禁用成员列表，4 获取未关注成员列表。status可叠加', default: 0
+  def user_list(departmentid = 0)
+    api_opts = options.slice(:fetch_child, :status)
+
+    r = Helper.with(options).user_list(departmentid, api_opts[:fetch_child], api_opts[:status])
+    puts "errcode: #{r['errcode']} errmsg: #{r['errmsg']}"
+    puts " userid Name #{' ' * 15} department_ids position mobile #{' ' * 5}gender email #{' ' * 10}weixinid   status extattr"
+    r['userlist'].sort_by { |d| d['userid'] } .each do |i|
+      puts format('%7s %-20s %-14s %-8s %-11s %-6s %-15s %-15s %-6s %s',
+                  i['userid'], i['name'], i['department'], i['position'], i['mobile'],
+                  i['gender'], i['email'], i['weixinid'], i['status'], i['extattr'])
+    end
+  end
+
+  desc 'tag_create [TAGNAME, TAG_ID]', '创建标签'
+  method_option :tagid, aliases: '-id', desc: '整型，指定此参数时新增的标签会生成对应的标签id，不指定时则以目前最大的id自增'
+  def tag_create(name)
+    api_opts = options.slice(:tagid)
+    puts Helper.with(options).tag_create(name, api_opts[:tagid])
+  end
+
+  desc 'tag_update [TAG_ID, TAGNAME]', '更新标签名字'
+  def tag_update(tagid, tagname)
+    puts Helper.with(options).tag_update(tagid, tagname)
+  end
+
+  desc 'tag_delete [TAG_ID]', '删除标签'
+  def tag_delete(tagid)
+    puts Helper.with(options).tag_delete(tagid)
+  end
+
+  desc 'tags', '获取标签列表'
+  def tags
+    puts Helper.with(options).tags
+  end
+
+  desc 'tag [TAG_ID]', '获取标签成员'
+  def tag(tagid)
+    puts Helper.with(options).tag(tagid)
+  end
+
+  desc 'tag_add_user [TAG_ID, USER_IDS]', '增加标签成员'
+  def tag_add_user(tagid, userids)
+    puts Helper.with(options).tag_add_user(tagid, userids.split(','))
+  end
+
+  desc 'tag_add_department [TAG_ID, PARTY_IDS]', '增加标签部门'
+  def tag_add_department(tagid, partyids)
+    puts Helper.with(options).tag_add_user(tagid, nil, partyids.split(','))
+  end
+
+  desc 'tag_del_user [TAG_ID, USER_IDS]', '删除标签成员'
+  def tag_del_user(tagid, userids)
+    puts Helper.with(options).tag_del_user(tagid, userids.split(','))
+  end
+
+  desc 'tag_del_department [TAG_ID, PARTY_IDS]', '删除标签部门'
+  def tag_del_department(tagid, partyids)
+    puts Helper.with(options).tag_del_user(tagid, nil, partyids.split(','))
+  end
+
+  desc 'agent_list', '获取应用概况列表'
+  def agent_list
+    r = Helper.with(options).agent_list
+    puts "errcode: #{r['errcode']} errmsg: #{r['errmsg']}"
+    puts 'ag# name        square_logo_url round_logo_url'
+    r['agentlist'].sort_by { |d| d['agentid'] } .each do |i|
+      puts format('%3d %s %s %s', i['agentid'], i['name'], i['square_logo_url'], i['round_logo_url'])
+    end
+  end
+
+  desc 'agent [AGENT_ID]', '获取企业号应用详情'
+  def agent(agentid)
+    r = Helper.with(options).agent(agentid)
+    puts "agentid: #{r['agentid']} errcode: #{r['errcode']} errmsg: #{r['errmsg']}"
+    puts "name: #{r['name']}"
+    puts "description: #{r['description']}"
+    puts "  square_logo_url: #{r['square_logo_url']}"
+    puts "   round_logo_url: #{r['round_logo_url']}"
+    puts "allow_userinfos: #{r['allow_userinfos']}"
+    puts "allow_partys: #{r['allow_partys']}"
+    puts "allow_tags: #{r['allow_tags']}"
+    puts "close: #{r['close']} redirect_domain: #{r['redirect_domain']}"
+    puts "report_location_flag: #{r['report_location_flag']} isreportuser: #{r['isreportuser']} isreportenter: #{r['isreportenter']}"
   end
 
   desc 'users', '关注者列表'
@@ -120,6 +239,26 @@ HELP
     puts Helper.with(options).user_delete(userid)
   end
 
+  desc 'batch_job_result [JOB_ID]', '获取异步任务结果'
+  def batch_job_result(job_id)
+    puts Helper.with(options).batch_job_result(job_id)
+  end
+
+  desc 'batch_replaceparty [BATCH_PARTY_CSV_MEDIA_ID]', '全量覆盖部门'
+  def batch_replaceparty(batch_party_csv_media_id)
+    puts Helper.with(options).batch_replaceparty(batch_party_csv_media_id)
+  end
+
+  desc 'batch_syncuser [SYNC_USER_CSV_MEDIA_ID]', '增量更新成员'
+  def batch_syncuser(sync_user_csv_media_id)
+    puts Helper.with(options).batch_syncuser(sync_user_csv_media_id)
+  end
+
+  desc 'batch_replaceuser [BATCH_USER_CSV_MEDIA_ID]', '全量覆盖成员'
+  def batch_replaceuser(batch_user_csv_media_id)
+    puts Helper.with(options).batch_replaceuser(batch_user_csv_media_id)
+  end
+
   desc 'user_group [OPEN_ID]', '查询用户所在分组'
   def user_group(openid)
     puts Helper.with(options).user_group(openid)
@@ -130,6 +269,21 @@ HELP
     puts Helper.with(options).user_change_group(openid, to_groupid)
   end
 
+  desc 'user_update_remark [OPEN_ID, REMARK]', '设置备注名'
+  def user_update_remark(openid, remark)
+    puts Helper.with(options).user_update_remark(openid, remark)
+  end
+
+  desc 'qrcode_create_scene [SCENE_ID, EXPIRE_SECONDS]', '请求临时二维码'
+  def qrcode_create_scene(scene_id, expire_seconds = 604800)
+    puts Helper.with(options).qrcode_create_scene(scene_id, expire_seconds)
+  end
+
+  desc 'qrcode_create_limit_scene [SCENE_ID_OR_STR]', '请求永久二维码'
+  def qrcode_create_limit_scene(scene_id_or_str)
+    puts Helper.with(options).qrcode_create_limit_scene(scene_id_or_str)
+  end
+
   desc 'menu', '当前菜单'
   def menu
     puts Helper.with(options).menu
@@ -142,7 +296,7 @@ HELP
 
   desc 'menu_create [MENU_YAML_PATH]', '创建菜单'
   def menu_create(menu_yaml_path)
-    menu = YAML.load(File.new(menu_yaml_path).read)
+    menu = YAML.load(File.read(menu_yaml_path))
     puts 'Menu created' if Helper.with(options).menu_create(menu)
   end
 
@@ -177,11 +331,24 @@ HELP
     puts Helper.with(options).material_delete(media_id)
   end
 
-  desc 'material_count', '获取素材总数'
+  desc 'material_count', '获取永久素材总数'
   def material_count
     puts Helper.with(options).material_count
   end
 
+  desc 'material_list [TYPE, OFFSET, COUNT]', '获取永久素材列表'
+  def material_list(type, offset, count)
+    r = Helper.with(options).material_list(type, offset, count)
+    if %w(image voice video file).include?(type)
+      puts "errcode: #{r['errcode']} errmsg: #{r['errmsg']} total_count: #{r['total_count']} item_count: #{r['item_count']}"
+      r['itemlist'].each do |i|
+        puts "#{i['media_id']} #{i['filename']} #{Time.at(i['update_time'].to_i)}"
+      end
+    else
+      puts r
+    end
+  end
+
   desc 'message_send [OPENID, TEXT_MESSAGE]', '发送文字消息(仅企业号)'
   def message_send(openid, text_message)
     puts Helper.with(options).message_send openid, text_message
@@ -237,13 +404,13 @@ HELP
 
   desc 'custom_news [OPENID, NEWS_YAML_PATH]', '发送图文客服消息'
   def custom_news(openid, news_yaml_path)
-    articles = YAML.load(File.new(news_yaml_path).read)
+    articles = YAML.load(File.read(news_yaml_path))
     puts Helper.with(options).custom_message_send Wechat::Message.to(openid).news(articles['articles'])
   end
 
   desc 'template_message [OPENID, TEMPLATE_YAML_PATH]', '模板消息接口'
   def template_message(openid, template_yaml_path)
-    template = YAML.load(File.new(template_yaml_path).read)
+    template = YAML.load(File.read(template_yaml_path))
     puts Helper.with(options).template_message_send Wechat::Message.to(openid).template(template['template'])
   end
 end

data/lib/generators/wechat/install_generator.rb

@@ -0,0 +1,20 @@
+module Wechat
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      desc 'Install Wechat support files'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_config
+        template 'config/wechat.yml'
+      end
+
+      def add_wechat_route
+        route 'resource :wechat, only: [:show, :create]'
+      end
+
+      def copy_wechat_controller
+        template 'app/controllers/wechats_controller.rb'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,91 @@
+class WechatsController < ApplicationController
+  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
+
+  # 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|
+    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|
+    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 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("#{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
+
+  # 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 :event, 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|
+    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|
+    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|
+    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/config/wechat.yml

@@ -0,0 +1,27 @@
+default: &default
+  corpid: "corpid"
+  corpsecret: "corpsecret"
+  agentid:  1
+# Or if using public account, only need above two line
+#  appid: "my_appid"
+#  secret: "my_secret"
+  token:    "token"
+  access_token: "C:/Users/[username]/wechat_access_token"
+  encoding_aes_key:  "encoding_aes_key"
+
+production:
+  corpid:     <%%= ENV['WECHAT_CORPID'] %>
+  corpsecret: <%%= ENV['WECHAT_CORPSECRET'] %>
+  agentid:    <%%= ENV['WECHAT_AGENTID'] %>
+# Or if using public account, only need above two line
+#  appid:      <%= ENV['WECHAT_APPID'] %>
+#  secret:     <%= ENV['WECHAT_APP_SECRET'] %>
+  token:      <%%= ENV['WECHAT_TOKEN'] %>
+  access_token:  <%%= ENV['WECHAT_ACCESS_TOKEN'] %>
+  encoding_aes_key:  <%%= ENV['WECHAT_ENCODING_AES_KEY'] %>
+
+development:
+  <<: *default
+
+test:
+  <<: *default

data/lib/wechat/api.rb

@@ -18,7 +18,7 @@ module Wechat
     end
 
     def groups
-      get('groups/get')
+      get 'groups/get'
     end
 
     def group_create(group_name)
@@ -39,7 +39,7 @@ module Wechat
     end
 
     def user(openid)
-      get('user/info', params: { openid: openid })
+      get 'user/info', params: { openid: openid }
     end
 
     def user_group(openid)
@@ -50,17 +50,38 @@ module Wechat
       post 'groups/members/update', JSON.generate(openid: openid, to_groupid: to_groupid)
     end
 
+    def user_update_remark(openid, remark)
+      post 'user/info/updateremark', JSON.generate(openid: openid, remark: remark)
+    end
+
+    def qrcode_create_scene(scene_id, expire_seconds = 604800)
+      post 'qrcode/create', JSON.generate(expire_seconds: expire_seconds,
+                                          action_name: 'QR_SCENE',
+                                          action_info: { scene: { scene_id: scene_id } })
+    end
+
+    def qrcode_create_limit_scene(scene_id_or_str)
+      case scene_id_or_str
+      when Fixnum
+        post 'qrcode/create', JSON.generate(action_name: 'QR_LIMIT_SCENE',
+                                            action_info: { scene: { scene_id: scene_id_or_str } })
+      else
+        post 'qrcode/create', JSON.generate(action_name: 'QR_LIMIT_STR_SCENE',
+                                            action_info: { scene: { scene_str: scene_id_or_str } })
+      end
+    end
+
     def menu
-      get('menu/get')
+      get 'menu/get'
     end
 
     def menu_delete
-      get('menu/delete')
+      get 'menu/delete'
     end
 
     def menu_create(menu)
       # 微信不接受7bit escaped json(eg \uxxxx), 中文必须UTF-8编码, 这可能是个安全漏洞
-      post('menu/create', JSON.generate(menu))
+      post 'menu/create', JSON.generate(menu)
     end
 
     def media(media_id)
@@ -79,6 +100,10 @@ module Wechat
       get 'material/get_materialcount'
     end
 
+    def material_list(type, offset, count)
+      post 'material/batchget_material', JSON.generate(type: type, offset: offset, count: count)
+    end
+
     def material_add(type, file)
       post 'material/add_material', { upload: { media: file } }, params: { type: type }, base: FILE_BASE
     end

data/lib/wechat/api_base.rb

@@ -1,9 +1,17 @@
+require 'cgi'
+
 module Wechat
   class ApiBase
     attr_reader :access_token, :client
 
+    MP_BASE = 'https://mp.weixin.qq.com/cgi-bin/'
+
     def callbackip
-      get('getcallbackip')
+      get 'getcallbackip'
+    end
+
+    def qrcode(ticket)
+      client.get 'showqrcode', ticket: CGI.escape(ticket), base: MP_BASE, as: :file
     end
 
     protected

data/lib/wechat/corp_api.rb

@@ -23,8 +23,16 @@ module Wechat
       @agentid = agentid
     end
 
+    def agent_list
+      get 'agent/list'
+    end
+
+    def agent(agentid)
+      get 'agent/get', params: { agentid: agentid }
+    end
+
     def user(userid)
-      get('user/get', params: { userid: userid })
+      get 'user/get', params: { userid: userid }
     end
 
     def invite_user(userid)
@@ -32,27 +40,83 @@ module Wechat
     end
 
     def user_auth_success(userid)
-      get('user/authsucc', params: { userid: userid })
+      get 'user/authsucc', params: { userid: userid }
     end
 
     def user_delete(userid)
-      get('user/delete', params: { userid: userid })
+      get 'user/delete', params: { userid: userid }
+    end
+
+    def batch_job_result(jobid)
+      get 'batch/getresult', params: { jobid: jobid }
+    end
+
+    def batch_replaceparty(media_id)
+      post 'batch/replaceparty', JSON.generate(media_id: media_id)
+    end
+
+    def batch_syncuser(media_id)
+      post 'batch/syncuser', JSON.generate(media_id: media_id)
+    end
+
+    def batch_replaceuser(media_id)
+      post 'batch/replaceuser', JSON.generate(media_id: media_id)
     end
 
     def department_create(name, parentid)
-      post('department/create', JSON.generate(name: name, parentid: parentid))
+      post 'department/create', JSON.generate(name: name, parentid: parentid)
+    end
+
+    def department_delete(departmentid)
+      get 'department/delete', params: { id: departmentid }
     end
 
     def department(departmentid = 1)
-      get('department/list', params: { id: departmentid })
+      get 'department/list', params: { id: departmentid }
+    end
+
+    def user_simplelist(departmentid, fetch_child = 0, status = 0)
+      get 'user/simplelist', params: { departmentid: departmentid, fetch_child: fetch_child, status: status }
+    end
+
+    def user_list(departmentid, fetch_child = 0, status = 0)
+      get 'user/list', params: { departmentid: departmentid, fetch_child: fetch_child, status: status }
+    end
+
+    def tag_create(tagname, tagid = nil)
+      post 'tag/create', JSON.generate(tagname: tagname, tagid: tagid)
+    end
+
+    def tag_update(tagid, tagname)
+      post 'tag/update', JSON.generate(tagid: tagid, tagname: tagname)
+    end
+
+    def tag_delete(tagid)
+      get 'tag/delete', params: { tagid: tagid }
+    end
+
+    def tags
+      get 'tag/list'
+    end
+
+    def tag(tagid)
+      get 'tag/get', params: { tagid: tagid }
+    end
+
+    def tag_add_user(tagid, userids = nil, departmentids = nil)
+      post 'tag/addtagusers', JSON.generate(tagid: tagid, userlist: userids, partylist: departmentids)
+    end
+
+    def tag_del_user(tagid, userids = nil, departmentids = nil)
+      post 'tag/deltagusers', JSON.generate(tagid: tagid, userlist: userids, partylist: departmentids)
     end
 
     def menu
-      get('menu/get', params: { agentid: agentid })
+      get 'menu/get', params: { agentid: agentid }
     end
 
     def menu_delete
-      get('menu/delete', params: { agentid: agentid })
+      get 'menu/delete', params: { agentid: agentid }
     end
 
     def menu_create(menu)
@@ -68,6 +132,10 @@ module Wechat
       get 'material/get_count', params: { agentid: agentid }
     end
 
+    def material_list(type, offset, count)
+      post 'material/batchget', JSON.generate(type: type, agentid: agentid, offset: offset, count: count)
+    end
+
     def media_create(type, file)
       post 'media/upload', { upload: { media: file } }, params: { type: type }
     end

data/lib/wechat/responder.rb

@@ -25,30 +25,33 @@ module Wechat
           config.merge!(with: with) if with.present?
         end
 
-        responders(message_type) << config
+        user_defined_responders(message_type) << config
         config
       end
 
-      def responders(type)
+      def user_defined_responders(type)
         @responders ||= {}
         @responders[type] ||= []
       end
 
-      def responder_for(message, &block)
+      def responder_for(message)
         message_type = message[:MsgType].to_sym
-        responders = responders(message_type)
+        responders = user_defined_responders(message_type)
 
         case message_type
         when :text
           yield(* match_responders(responders, message[:Content]))
-
         when :event
           if 'click' == message[:Event]
             yield(* match_responders(responders, message[:EventKey]))
           elsif %w(scancode_push scancode_waitmsg).include? message[:Event]
-            yield(* match_responders(responders, event_key: message[:EventKey],
+            yield(* match_responders(responders, event: 'scancode',
+                                                 event_key: message[:EventKey],
                                                  scan_type: message[:ScanCodeInfo][:ScanType],
                                                  scan_result: message[:ScanCodeInfo][:ScanResult]))
+          elsif 'batch_job_result' == message[:Event]
+            yield(* match_responders(responders, event: 'batch_job',
+                                                 batch_job: message[:BatchJob]))
           else
             yield(* match_responders(responders, message[:Event]))
           end
@@ -71,7 +74,9 @@ 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
+            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
@@ -133,7 +138,7 @@ module Wechat
 
     def run_responder(request)
       self.class.responder_for(request) do |responder, *args|
-        responder ||= self.class.responders(:fallback).first
+        responder ||= self.class.user_defined_responders(:fallback).first
 
         next if responder.nil?
         case

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-07 00:00:00.000000000 Z
+date: 2015-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,6 +67,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.3'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: API and message handling for WeChat in Rails
 email: eric.guocz@gmail.com
 executables:
@@ -80,6 +94,9 @@ files:
 - Rakefile
 - bin/wechat
 - lib/action_controller/wechat_responder.rb
+- lib/generators/wechat/install_generator.rb
+- lib/generators/wechat/templates/app/controllers/wechats_controller.rb
+- lib/generators/wechat/templates/config/wechat.yml
 - lib/wechat.rb
 - lib/wechat/access_token.rb
 - lib/wechat/api.rb