wechat 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3e0f3e13da7012b66a0db4454a02588e18b197b0
-  data.tar.gz: 8f20da9e9e385f3a47f07fdd74857b6be7065ac8
+  metadata.gz: 7a76622259e3d0a5ea26bab1dfb80463a0bc6587
+  data.tar.gz: 1e2fbf216e23989e7ff3151be9942e552b427199
 SHA512:
-  metadata.gz: c248645bc11c2b0973cb2a05a0db3ba0611de7173c2077632884be5097706b7906b7ae48c81e3d5094d628b7850278dc9f64d4851ee976fb8ac4e1ce0fbc70ff
-  data.tar.gz: fc0758f38f48240b64a74b475802259b98df2606952b2c6fbd7addb89b8dee177243789e5acd83adf76c8e8795864905610821ff6b71e6311a3badd157dd8586
+  metadata.gz: 8b5a068b1a5f3846335d693121e47c227bfe8a272f2d44e056d3354b0e873e696ae1588e32f7518aef1fb5e2be8ddafa8d9b271a7690724d526ebf6bde0c4bba
+  data.tar.gz: e9ee9effb1a9373b914e023f27b1b82afd5ca688382fa5237fca88b2908a2a582fab995ff40aa4b6fc1dc5748dfe13858bc2c2c65d7dd9a3eeefeb1314904b22

data.tar.gz.sig

@@ -1,2 +1,2 @@
-[�w�C�Nn��8��&�&���'����,�X�T�e��ڂ)R�r�$��/8�
-�`��
+|0�����g&�v�UkY���������NF��	�,����V67&��
��,��$�'�fo�����ߔ�p�XY�-k�n�.J�!�G+�rv��HD�QP*
+G�}a>�$��S��4�՚e��Iք�A�3�Ph��i2M��n3}.��1g&NK��:ö�?��U'[���Af�:mJ}i�<��v��c��^x��`�;�����5L���~v+>{.ǡ�:�uWb
'[X,���_��Gj��z�W��B��'

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## v0.8.5 (released at 3/14/2017)
+
+* Support mass send API #176
+* Support new media_hq API
+* Support new createwxaqrcode API for miniapp
+* Fix wechat_responder not proper injected in rails 5 API #165
+* parse response support XML return, by @zhangbin #167
+* WeChat only allow 8 article per one news, by @kikyous #175
+* Store token at cookies, by @jstdoit #174
+
 ## v0.8.4 (released at 1/12/2017)
 
 # Support Ruby 2.4.0 

data/README-CN.md

@@ -289,7 +289,7 @@ wechat gems 内部不会检查权限。但因公众号类型不同，和微信
 
 ```
 $ wechat
-Wechat commands:
+Wechat Public Account commands:
   wechat callbackip                                        # 获取微信服务器IP地址
   wechat custom_image [OPENID, IMAGE_PATH]                 # 发送图片客服消息
   wechat custom_music [OPENID, THUMBNAIL_PATH, MUSIC_URL]  # 发送音乐客服消息
@@ -308,14 +308,19 @@ Wechat commands:
   wechat material_delete [MEDIA_ID]                        # 删除永久素材
   wechat material_list [TYPE, OFFSET, COUNT]               # 获取永久素材列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
+  wechat media_hq [MEDIA_ID, PATH]                         # 高清音频下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
   wechat media_uploadimg [IMAGE_PATH]                      # 上传图文消息内的图片
+  wechat media_uploadnews [MPNEWS_YAML_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 message_mass_delete [MSG_ID]                      # 删除群发消息
+  wechat message_mass_get [MSG_ID]                         # 查询群发消息发送状态
+  wechat message_mass_preview [WX_NAME, MPNEWS_MEDIA_ID]   # 预览图文消息素材
   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下载二维码
@@ -339,7 +344,7 @@ Wechat commands:
 #### 企业号命令行
 ```
 $ wechat
-Wechat commands:
+Wechat Enterprise Account commands:
   wechat agent [AGENT_ID]                                  # 获取企业号应用详情
   wechat agent_list                                        # 获取应用概况列表
   wechat batch_job_result [JOB_ID]                         # 获取异步任务结果
@@ -580,7 +585,7 @@ class WechatsController < ActionController::Base
 
   # 当请求的文字信息内容为'<n>条新闻'时, 使用这个responder处理, 并将n作为第二个参数
   on :text, with: /^(\d+)条新闻$/ do |request, count|
-    # 微信最多显示10条新闻，大于10条将只取前10条
+    # 微信最多显示8条新闻，大于8条将只取前8条
     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/'
@@ -687,6 +692,12 @@ class WechatsController < ActionController::Base
     request.reply.text "job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
   end
 
+  # 事件推送群发结果
+  on :event, with: 'masssendjobfinish' do |request|
+    # https://mp.weixin.qq.com/wiki?action=doc&id=mp1481187827_i0l21&t=0.03571905015619936#8
+    request.reply.success # request is XML result hash.
+  end
+
   # 当无任何responder处理用户信息时,使用这个responder处理
   on :fallback, respond: 'fallback message'
 end

data/README.md

@@ -304,7 +304,7 @@ Feel safe if you can not read Chinese in the comments, it's kept there in order
 
 ```
 $ wechat
-Wechat commands:
+Wechat Public Account commands:
   wechat callbackip                                        # 获取微信服务器IP地址
   wechat custom_image [OPENID, IMAGE_PATH]                 # 发送图片客服消息
   wechat custom_music [OPENID, THUMBNAIL_PATH, MUSIC_URL]  # 发送音乐客服消息
@@ -323,14 +323,19 @@ Wechat commands:
   wechat material_delete [MEDIA_ID]                        # 删除永久素材
   wechat material_list [TYPE, OFFSET, COUNT]               # 获取永久素材列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
+  wechat media_hq [MEDIA_ID, PATH]                         # 高清音频下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
   wechat media_uploadimg [IMAGE_PATH]                      # 上传图文消息内的图片
+  wechat media_uploadnews [MPNEWS_YAML_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 message_mass_delete [MSG_ID]                      # 删除群发消息
+  wechat message_mass_get [MSG_ID]                         # 查询群发消息发送状态
+  wechat message_mass_preview [WX_NAME, MPNEWS_MEDIA_ID]   # 预览图文消息素材
   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下载二维码
@@ -354,7 +359,7 @@ Wechat commands:
 #### Enterprise account command line
 ```
 $ wechat
-Wechat commands:
+Wechat Enterprise Account commands:
   wechat agent [AGENT_ID]                                  # 获取企业号应用详情
   wechat agent_list                                        # 获取应用概况列表
   wechat batch_job_result [JOB_ID]                         # 获取异步任务结果
@@ -594,7 +599,7 @@ class WechatsController < ActionController::Base
 
   # When receive '<n>news', will match and will get 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 be dropped.
+    # Wechat article can only contain max 8 items, large than 8 will be 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/'
@@ -700,6 +705,12 @@ class WechatsController < ActionController::Base
     request.reply.text "replace_party job #{batch_job[:JobId]} finished, return code #{batch_job[:ErrCode]}, return message #{batch_job[:ErrMsg]}"
   end
 
+  # mass sent job finish result notification
+  on :event, with: 'masssendjobfinish' do |request|
+    # https://mp.weixin.qq.com/wiki?action=doc&id=mp1481187827_i0l21&t=0.03571905015619936#8
+    request.reply.success # request is XML result hash.
+  end
+
   # If no match above will fallback to below
   on :fallback, respond: 'fallback message'
 end

data/bin/wechat

@@ -16,7 +16,6 @@ require 'wechat/api_loader'
 require 'cgi'
 
 class App < Thor
-  package_name 'Wechat'
   class_option :account, aliases: '-a', default: :default, desc: 'Name of Wechat account configuration.'
 
   attr_reader :wechat_api_client
@@ -42,6 +41,7 @@ class App < Thor
   in_corp_api_cmd = Wechat::ApiLoader.with(options).is_a?(Wechat::CorpApi)
 
   if in_corp_api_cmd
+    package_name 'Wechat Enterprise Account'
     desc 'department_create [NAME, PARENT_ID]', '创建部门'
     method_option :parentid, aliases: '-p', desc: '父亲部门id。根部门id为1'
     def department_create(name)
@@ -198,6 +198,28 @@ class App < Thor
       puts wechat_api.message_send openid, text_message
     end
   else
+    package_name 'Wechat Public Account'
+    desc 'media_uploadnews [MPNEWS_YAML_PATH]', '上传图文消息素材'
+    def media_uploadnews(mpnews_yaml_path)
+      mpnew = YAML.load(File.read(mpnews_yaml_path))
+      puts wechat_api.media_uploadnews(Wechat::Message.new(MsgType: 'uploadnews').mpnews(mpnew[:articles]))
+    end
+
+    desc 'message_mass_delete [MSG_ID]', '删除群发消息'
+    def message_mass_delete(msg_id)
+      puts wechat_api.message_mass_delete(msg_id)
+    end
+
+    desc 'message_mass_preview [WX_NAME, MPNEWS_MEDIA_ID]', '预览图文消息素材'
+    def message_mass_preview(wx_name, mpnews_media_id)
+      puts wechat_api.message_mass_preview(Wechat::Message.to(towxname: wx_name).ref_mpnews(mpnews_media_id))
+    end
+
+    desc 'message_mass_get [MSG_ID]', '查询群发消息发送状态'
+    def message_mass_get(msg_id)
+      puts wechat_api.message_mass_get(msg_id)
+    end
+
     desc 'group_create [GROUP_NAME]', '创建分组'
     def group_create(group_name)
       puts wechat_api.group_create(group_name)
@@ -309,6 +331,13 @@ class App < Thor
     puts 'File downloaded'
   end
 
+  desc 'media_hq [MEDIA_ID, PATH]', '高清音频媒体下载'
+  def media_hq(media_id, path)
+    tmp_file = wechat_api.media_hq(media_id)
+    FileUtils.mv(tmp_file.path, path)
+    puts 'File downloaded'
+  end
+
   desc 'media_create [MEDIA_TYPE, PATH]', '媒体上传'
   def media_create(type, path)
     puts wechat_api.media_create(type, path)

data/lib/action_controller/wechat_responder.rb

@@ -52,7 +52,8 @@ module ActionController
     class << Base
       include WechatResponder
     end
-  elsif defined? API
+  end
+  if defined? API
     class << API
       include WechatResponder
     end

data/lib/wechat/api.rb

@@ -75,6 +75,26 @@ module Wechat
       post 'shorturl', JSON.generate(action: 'long2short', long_url: long_url)
     end
 
+    def message_mass_sendall(message)
+      post 'message/mass/sendall', message.to_json
+    end
+
+    def message_mass_delete(msg_id)
+      post 'message/mass/delete', JSON.generate(msg_id: msg_id)
+    end
+
+    def message_mass_preview(message)
+      post 'message/mass/preview', message.to_json
+    end
+
+    def message_mass_get(msg_id)
+      post 'message/mass/get', JSON.generate(msg_id: msg_id)
+    end
+
+    def wxa_create_qrcode(path, width = 430)
+      post 'wxaapp/createwxaqrcode', JSON.generate(path: path, width: width)
+    end
+
     def menu
       get 'menu/get'
     end

data/lib/wechat/api_base.rb

@@ -16,6 +16,10 @@ module Wechat
       get 'media/get', params: { media_id: media_id }, as: :file
     end
 
+    def media_hq(media_id)
+      get 'media/get/jssdk', params: { media_id: media_id }, as: :file
+    end
+
     def media_create(type, file)
       post_file 'media/upload', file, params: { type: type }
     end
@@ -24,6 +28,10 @@ module Wechat
       post_file 'media/uploadimg', file
     end
 
+    def media_uploadnews(mpnews_message)
+      post 'media/uploadnews', mpnews_message.to_json
+    end
+
     protected
 
     def get(path, headers = {})

data/lib/wechat/controller_api.rb

@@ -36,12 +36,14 @@ module Wechat
     def wechat_public_oauth2(oauth2_params)
       openid  = cookies.signed_or_encrypted[:we_openid]
       unionid = cookies.signed_or_encrypted[:we_unionid]
+      we_token = cookies.signed_or_encrypted[:we_access_token]
       if openid.present?
-        yield openid, { 'openid' => openid, 'unionid' => unionid }
+        yield openid, { 'openid' => openid, 'unionid' => unionid, 'access_token' => we_token}
       elsif params[:code].present? && params[:state] == oauth2_params[:state]
         access_info = wechat.web_access_token(params[:code])
         cookies.signed_or_encrypted[:we_openid] = { value: access_info['openid'], expires: self.class.oauth2_cookie_duration.from_now }
         cookies.signed_or_encrypted[:we_unionid] = { value: access_info['unionid'], expires: self.class.oauth2_cookie_duration.from_now }
+        cookies.signed_or_encrypted[:we_access_token] = { value: access_info['access_token'], expires: self.class.oauth2_cookie_duration.from_now }
         yield access_info['openid'], access_info
       else
         redirect_to generate_oauth2_url(oauth2_params)

data/lib/wechat/http_client.rb

@@ -42,7 +42,7 @@ module Wechat
     def request(path, header = {}, &_block)
       url_base = header.delete(:base) || base
       as = header.delete(:as)
-      header['Accept'] = 'application/json'
+      header['Accept'] ||= 'application/json'
       response = yield("#{url_base}#{path}", header)
 
       raise "Request not OK, response status #{response.status}" if response.status != 200

data/lib/wechat/message.rb

@@ -5,8 +5,22 @@ module Wechat
         new(message_hash)
       end
 
-      def to(to_user)
-        new(ToUserName: to_user, CreateTime: Time.now.to_i)
+      def to(to_users = '', towxname: nil, send_ignore_reprint: 0)
+        if towxname.present?
+          new(ToWxName: towxname, CreateTime: Time.now.to_i)
+        elsif send_ignore_reprint == 1
+          new(ToUserName: to_users, CreateTime: Time.now.to_i, send_ignore_reprint: send_ignore_reprint)
+        else
+          new(ToUserName: to_users, CreateTime: Time.now.to_i)
+        end
+      end
+
+      def to_mass(tag_id: nil, send_ignore_reprint: 0)
+        if tag_id
+          new(filter: { is_to_all: false, tag_id: tag_id }, send_ignore_reprint: send_ignore_reprint)
+        else
+          new(filter: { is_to_all: true }, send_ignore_reprint: send_ignore_reprint)
+        end
       end
     end
 
@@ -16,12 +30,21 @@ module Wechat
       def initialize
         @items = []
       end
+    end
 
+    class NewsArticleBuilder < ArticleBuilder
       def item(title: 'title', description: nil, pic_url: nil, url: nil)
         items << { Title: title, Description: description, PicUrl: pic_url, Url: url }.reject { |_k, v| v.nil? }
       end
     end
 
+    class MpNewsArticleBuilder < ArticleBuilder
+      def item(thumb_media_id:, title:, content:, author: nil, content_source_url: nil, digest: nil, show_cover_pic: '0')
+        items << { Thumb_Media_ID: thumb_media_id, Author: author, Title: title, ContentSourceUrl: content_source_url,
+                   Content: content, Digest: digest, ShowCoverPic: show_cover_pic }.reject { |_k, v| v.nil? }
+      end
+    end
+
     attr_reader :message_hash
 
     def initialize(message_hash)
@@ -117,8 +140,8 @@ module Wechat
 
     def news(collection, &_block)
       if block_given?
-        article = ArticleBuilder.new
-        collection.take(10).each_with_index { |item, index| yield(article, item, index) }
+        article = NewsArticleBuilder.new
+        collection.take(8).each_with_index { |item, index| yield(article, item, index) }
         items = article.items
       else
         items = collection.collect do |item|
@@ -130,6 +153,24 @@ module Wechat
              Articles: items.collect { |item| camelize_hash_keys(item) })
     end
 
+    def mpnews(collection, &_block)
+      if block_given?
+        article = MpNewsArticleBuilder.new
+        collection.take(8).each_with_index { |item, index| yield(article, item, index) }
+        items = article.items
+      else
+        items = collection.collect do |item|
+          camelize_hash_keys(item.symbolize_keys.slice(:thumb_media_id, :title, :content, :author, :content_source_url, :digest, :show_cover_pic).reject { |_k, v| v.nil? })
+        end
+      end
+
+      update(MsgType: 'mpnews', Articles: items.collect { |item| camelize_hash_keys(item) })
+    end
+
+    def ref_mpnews(media_id)
+      update(MsgType: 'ref_mpnews', MpNews: { MediaId: media_id })
+    end
+
     def template(opts = {})
       template_fields = opts.symbolize_keys.slice(:template_id, :topcolor, :url, :data)
       update(MsgType: 'template', Template: template_fields)
@@ -144,12 +185,16 @@ module Wechat
 
     TO_JSON_KEY_MAP = {
       'ToUserName' => 'touser',
+      'ToWxName' => 'towxname',
       'MediaId' => 'media_id',
+      'MpNews' => 'mpnews',
       'ThumbMediaId' => 'thumb_media_id',
-      'TemplateId' => 'template_id'
+      'TemplateId' => 'template_id',
+      'ContentSourceUrl' => 'content_source_url',
+      'ShowCoverPic' => 'show_cover_pic'
     }.freeze
 
-    TO_JSON_ALLOWED = %w(touser msgtype content image voice video file music news articles template agentid).freeze
+    TO_JSON_ALLOWED = %w(touser msgtype content image voice video file music news articles template agentid filter send_ignore_reprint mpnews towxname).freeze
 
     def to_json
       keep_camel_case_key = message_hash[:MsgType] == 'template'
@@ -164,6 +209,11 @@ module Wechat
         json_hash['text'] = { 'content' => json_hash.delete('content') }
       when 'news'
         json_hash['news'] = { 'articles' => json_hash.delete('articles') }
+      when 'mpnews'
+        json_hash = { 'articles' => json_hash['articles'] }
+      when 'ref_mpnews'
+        json_hash['msgtype'] = 'mpnews'
+        json_hash.delete('articles')
       when 'template'
         json_hash = { 'touser' => json_hash['touser'] }.merge!(json_hash['template'])
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Skinnyworm
@@ -31,7 +31,7 @@ cert_chain:
   R5k6Ma92sW8jupX4cqbSu9rntdVQkNRpoHIrfU0MZT0cKsg/D1zMteylxrO3KMsz
   SPQRv+nrI1J0zevFqb8010heoR8SDyUA0Mm3+Q==
   -----END CERTIFICATE-----
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 2.6.10
 signing_key: 
 specification_version: 4
 summary: DSL for wechat message handling and API