wechat 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b383f8c031c63e1314dc28869389f1f69e0bad4f1dd7821bc1a0169fdf28905
-  data.tar.gz: 9f62ed282adbd93ab022974ac5650e70349768480613ba429c7f528d6805a7ff
+  metadata.gz: 390ca71e91a479909b212f09bc2260abbbe17e1d0ac85475952721f3cf7e70d4
+  data.tar.gz: 48e3da1f67e2f6362908b3d0e47e01881bfd122aafcaa50066c64e2a63ad2801
 SHA512:
-  metadata.gz: 55258c585033c225b36962c9520642ca72c5e84ef75be0b14d0243f0f4dfa973b97760dcc3ef8a1c69ac1c3dd2074b46ffe90b393c016ca26757369f463897b5
-  data.tar.gz: bcfc4f5ae3f3e135f7254705b9deb28ac7fada1401b77301a1a37beba2e0bd32d3fa7d8ea09c73399715d7b90d259ce81ef547d587b624ae4ad55d9c3ab9f64c
+  metadata.gz: '0298c6dfc1d93e2723a5b4521150dc6f0d7753d7518db290297459a7db6d085ac0c175810a33cf8ea18b6f59c78862a4bb7b9a2d9366ca40978026449762959b'
+  data.tar.gz: 5e16496298bdd8495209e3542345e1faa9c5cc4f476b7d6a5452753fcd505db0ac3ee01cbc8c058effb004c776219701d9a7e9a643d1924ea597572c9a339063

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v0.11.1 (released at 03/01/2019)
+
+* Let Message support markdown, text included; allow textcard btntxt to be omitted by @hophacker #251
+* Enterprise account add checkin api by @hophacker #254
+* Suggest use secret to differentiate different acces_tokens and tickets in Enterprise account by @hophacker #255
+
+
 ## v0.11.0 (released at 01/22/2019)
 
 * Support Ruby 2.6.0 official

data/README-CN.md

@@ -3,13 +3,13 @@ WeChat [![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://rubygems.or
 
 [![Join the chat](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Eric-Guo/wechat?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
-WeChat gem 可以帮助开发者方便地在Rails环境中集成微信[公众平台](https://mp.weixin.qq.com/)和[企业平台](https://qy.weixin.qq.com)提供的服务，包括：
+WeChat gem帮助开发者方便地在Rails环境中集成[微信公众平台](https://mp.weixin.qq.com/)和[企业微信](https://qy.weixin.qq.com)，包括功能：
 
-- 微信公众/企业平台[主动消息](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%B6%88%E6%81%AF)API（命令行和Web环境都可以使用）
-- [回调消息](http://qydev.weixin.qq.com/wiki/index.php?title=%E6%8E%A5%E6%94%B6%E6%B6%88%E6%81%AF%E4%B8%8E%E4%BA%8B%E4%BB%B6)（必须运行Web服务器）
+- 微信公众平台/企业微信[发送消息](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%B6%88%E6%81%AF)API（命令行和Web环境都可以使用）
+- [接收消息](http://qydev.weixin.qq.com/wiki/index.php?title=%E6%8E%A5%E6%94%B6%E6%B6%88%E6%81%AF%E4%B8%8E%E4%BA%8B%E4%BB%B6)（必须运行Web服务器）
 - [微信JS-SDK](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%BE%AE%E4%BF%A1JS%E6%8E%A5%E5%8F%A3) config接口注入权限验证
 - OAuth 2.0认证机制
-- 回调消息会话(session)记录机制（可选）
+- 接收消息会话(session)记录机制（可选）
 
 命令行工具`wechat`可以调用各种无需web环境的API。同时也提供了Rails Controller的responder DSL, 可以帮助开发者方便地在Rails应用中集成微信的消息处理，包括主动推送的和被动响应的消息。
 
@@ -107,7 +107,7 @@ access_token: "C:/Users/[user_name]/wechat_access_token"
 #### Rails 全局配置
 Rails应用程序中，需要将配置文件放在`config/wechat.yml`，可以为不同environment创建不同的配置。
 
-公众号配置示例：
+微信公众平台配置示例：
 
 ```
 default: &default
@@ -133,7 +133,7 @@ test:
   <<: *default
 ```
 
-公众号可选安全模式（加密模式），通过添加如下配置可开启加密模式。
+微信公众平台可选安全模式（加密模式），通过添加如下配置可开启加密模式。
 
 ```
 default: &default
@@ -141,7 +141,7 @@ default: &default
   encoding_aes_key:  "my_encoding_aes_key"
 ```
 
-企业号配置下必须使用加密模式，其中token和encoding_aes_key可以从企业号管理界面的应用中心->某个应用->模式选择，选择回调模式后获得。
+企业微信配置下必须使用加密模式，其中token和encoding_aes_key可以从企业号管理界面的应用中心->某个应用->模式选择，选择回调模式后获得。
 
 ```
 default: &default
@@ -192,6 +192,19 @@ test:
  #  secret: "my_secret"
 ```
 
+支持 微信公众平台/企业微信 多账号的注意点(例如，增加账号`wx2`):
+
+* 配置文件可增加多个微信公众平台(企业微信)配置，用法类似Rails中`config/database.yml`多数据库配置的处理。`development`, `test`, `production`是默认账号的配置段，要想增加账号`wx2`，你需要增加配置段`wx2_development`, `wx2_test`, `wx2_production`。
+
+* 声明账号`wx2`的`wechat_responder`:
+  ```ruby
+  wechat_responder account: :wx2
+  ```
+
+* `Wechat.api(:wx2)` 表示使用账号`wx2`的Wechat api，而`Wechat.api`或`Wechat.api(:default)`则表示默认账号的wechat api。
+
+* 在wechat命令行中，通过增加可选参数`-a, [--account=ACCOUNT]`来表示使用其他账号，例如`wechat users -a wx2`表示列举`wx2`这个账号的粉丝列表
+
 进一步的多账号支持参见[PR 150](https://github.com/Eric-Guo/wechat/pull/150)。
 
 #### 数据库微信账户配置
@@ -298,7 +311,7 @@ class CartController < ActionController::Base
 end
 ```
 
-企业号可使用如下代码取得企业用户的相关信息。
+企业微信可使用如下代码取得企业用户的相关信息。
 
 ```ruby
 class WechatsController < ActionController::Base
@@ -326,9 +339,9 @@ wechat gems 内部不会检查权限。但因公众号类型不同，和微信
 
 ## 使用命令行
 
-根据企业号和公众号配置不同，wechat提供了的命令行命令。
+根据企业微信和微信公众平台配置不同，wechat提供了的命令行命令。
 
-#### 公众号命令行
+#### 微信公众平台命令行
 
 ```
 $ wechat
@@ -385,11 +398,11 @@ Wechat Public Account commands:
   wechat wxacode_download [WXA_CODE_PIC_PATH, PATH, WIDTH]      # 下载小程序码
 ```
 
-#### 企业号命令行
+#### 企业微信命令行
 ```
 $ wechat
 Wechat Enterprise Account commands:
-  wechat agent [AGENT_ID]                                       # 获取企业号应用详情
+  wechat agent [AGENT_ID]                                       # 获取企业微信应用详情
   wechat agent_list                                             # 获取应用概况列表
   wechat batch_job_result [JOB_ID]                              # 获取异步任务结果
   wechat batch_replaceparty [BATCH_PARTY_CSV_MEDIA_ID]          # 全量覆盖部门
@@ -595,7 +608,7 @@ wechat.template_message_send Wechat::Message.to(openid).template(template['templ
 
 ## wechat_api - Rails Controller Wechat API
 
-虽然用户可以随时通过`Wechat.api`在任意代码中访问wechat的API功能，但是更推荐的做法是仅在controller中，通过引入`wechat_api`，使用`wechat`调用API功能，不仅因为这样是支持多个微信公众号的必然要求，而且也避免了在模型层内过多引入微信相关代码。
+虽然用户可以随时通过`Wechat.api`在任意代码中访问wechat的API功能，但是更推荐的做法是仅在controller中，通过引入`wechat_api`，使用`wechat`调用API功能，不仅因为这样是支持多个微信公众平台账号的必然要求，而且也避免了在模型层内过多引入微信相关代码。
 
 ```ruby
 class WechatReportsController < ApplicationController
@@ -650,12 +663,12 @@ class WechatsController < ActionController::Base
     request.reply.text "User #{request[:FromUserName]} subscribe now"
   end
 
-  # 公众号收到未关注用户扫描qrscene_xxxxxx二维码时。注意此次扫描事件将不再引发上条的用户加关注事件
+  # 公众平台收到未关注用户扫描qrscene_xxxxxx二维码时。注意此次扫描事件将不再引发上条的用户加关注事件
   on :scan, with: 'qrscene_xxxxxx' do |request, ticket|
     request.reply.text "Unsubscribe user #{request[:FromUserName]} Ticket #{ticket}"
   end
 
-  # 公众号收到已关注用户扫描创建二维码的scene_id事件时
+  # 公众平台收到已关注用户扫描创建二维码的scene_id事件时
   on :scan, with: 'scene_id' do |request, ticket|
     request.reply.text "Subscribe user #{request[:FromUserName]} Ticket #{ticket}"
   end
@@ -667,12 +680,12 @@ class WechatsController < ActionController::Base
     end
   end
 
-  # 企业号收到EventKey 为二维码扫描结果事件时
+  # 企业微信收到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码扫描结果事件时
+  # 企业微信收到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]}"
@@ -812,6 +825,6 @@ end
 
 ## 已知问题
 
-* 企业号接受菜单消息时，Wechat腾讯服务器无法解析部分域名，请使用IP绑定回调URL，用户的普通消息目前不受影响。
-* 企业号全量覆盖成员使用的csv通讯录格式，直接将下载的模板导入[是不工作的](http://qydev.weixin.qq.com/qa/index.php?qa=13978)，必须使用Excel打开，然后另存为csv格式才会变成合法格式。
+* 企业微信接受菜单消息时，Wechat腾讯服务器无法解析部分域名，请使用IP绑定回调URL，用户的普通消息目前不受影响。
+* 企业微信全量覆盖成员使用的csv通讯录格式，直接将下载的模板导入[是不工作的](http://qydev.weixin.qq.com/qa/index.php?qa=13978)，必须使用Excel打开，然后另存为csv格式才会变成合法格式。
 * 如果使用nginx+unicron部署方案，并且使用了https，必须设置`trusted_domain_fullname`为https，否则会导致JS-SDK签名失效。

data/README.md

@@ -5,28 +5,28 @@ WeChat [![Gem Version](https://badge.fury.io/rb/wechat.svg)](https://rubygems.or
 
 [中文文档 Chinese document](/README-CN.md)
 
-[Wechat](http://www.wechat.com/) is a free messaging and calling app developed by [Tencent](http://tencent.com/en-us/index.shtml), after linking billion people, Wechat had become [an application platform](https://uxdesign.cc/wechat-the-invincible-app-a-key-to-business-success-in-china-8e9a920deb26?source=wechat_gem).
+[Wechat](http://www.wechat.com/) is a Chinese multi-purpose messaging, social media and mobile payment app developed by Tencent. It was first released in 2011, and by 2018 it was one of the world's largest standalone mobile apps by monthly active users, with over 1 billion monthly active users (902 million daily active users). (According to [wiki](https://en.wikipedia.org/wiki/WeChat))
 
-WeChat gem tries to help Rails developer to integrate [enterprise account](https://qy.weixin.qq.com) / [public account](https://mp.weixin.qq.com/) easily. Features below are ready and there is no need to write adapter code for talking to wechat server directly.
+WeChat gem helps Rails developers integrate [WeChat Official Accounts Platform](https://mp.weixin.qq.com/) and [Wechat Enterprise](https://qy.weixin.qq.com) easily, including features:
 
-- [Sending message](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%B6%88%E6%81%AF) API（Can access via console or in rails）
-- [Receiving message](http://qydev.weixin.qq.com/wiki/index.php?title=%E6%8E%A5%E6%94%B6%E6%B6%88%E6%81%AF%E4%B8%8E%E4%BA%8B%E4%BB%B6)（You must run on rails server to receiving message）
+- [Sending message](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%8F%91%E9%80%81%E6%B6%88%E6%81%AF) API（can be both accessed via console or rails server）
+- [Receiving message](http://qydev.weixin.qq.com/wiki/index.php?title=%E6%8E%A5%E6%94%B6%E6%B6%88%E6%81%AF%E4%B8%8E%E4%BA%8B%E4%BB%B6)（rails server is required to be running）
 - [Wechat JS-SDK](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%BE%AE%E4%BF%A1JS%E6%8E%A5%E5%8F%A3) config signature
 - OAuth 2.0 authentication
 - Record session when receiving message from user (Optional)
 
 
-`wechat` command shares the same API in console, so you can interactive with wechat server quickly, without starting up web environment/code.
+`wechat` command shares the same API in console, so you can interact with wechat server quickly without starting up web environment/code.
 
-A responder DSL can be used in Rails controller, giving an event based interface to handle messages sent by end user from wechat server.
+A responder DSL can be used in Rails controller, which gives an event based interface to handle messages sent by end users.
 
-Wechat provides OAuth2.0 authentication method `wechat_oauth2`, possibly the easiest way, for the users who prefer using devise style authorization gems, [omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2) can be a good option.
+If Wechat OAuth 2.0 is required by your app, [omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2) is recommended in order to apply [devise authentication](https://github.com/plataformatec/devise).
 
-There is official [weui](https://github.com/weui/weui), corresponding Rails gem called [weui-rails](https://github.com/Eric-Guo/weui-rails) is available, if you prefer following the same UI design as wechat.
+If tencent's [weui](https://github.com/weui/weui) UI style is adoped in your project, gem [weui-rails](https://github.com/Eric-Guo/weui-rails) is available for you.
 
-For web page only wechat application, please use [`wechat_api`](#wechat_api---rails-controller-wechat-api), which only contains web feature compare with traditional message type [`wechat_responder`](#wechat_responder---rails-responder-controller-dsl).
+For web page only wechat application, please use [`wechat_api`](#wechat_api---rails-controller-wechat-api), which only contains web features, compared with traditional message type [`wechat_responder`](#wechat_responder---rails-responder-controller-dsl).
 
-There is a more complete [wechat-starter](https://github.com/goofansu/wechat-starter) demo available, which even includes the payment SDK feature.
+There is a more complete [wechat-starter](https://github.com/goofansu/wechat-starter) demo available, which futher includes the payment SDK feature.
 
 ## Installation
 
@@ -54,7 +54,7 @@ Run the generator:
 rails generate wechat:install
 ```
 
-`rails g wechat:install` will generated the initial `wechat.yml` configuration file, including an sample wechat controller and corresponding routes.
+`rails g wechat:install` will generate the initial `wechat.yml` configuration file, including an sample wechat controller and corresponding routes.
 
 Enable session record:
 
@@ -63,7 +63,7 @@ rails g wechat:session
 rake db:migrate
 ```
 
-Enabling session will generate two files in Rails folder, you can add more columns to *wechat_session* table and add declaration to link to users table, it's also possible to store data directly in **hash_store**. if you are using PostgreSQL, using [hstore](http://guides.rubyonrails.org/active_record_postgresql.html#hstore)/json maybe better, but the best way is still to add a dedicate column to record the data, the Rails way.
+Enabling session will generate two files in Rails folder, you can add more columns to *wechat_session* table and add declaration to link to users table, it's also possible to store data directly in **hash_store**. If you are using PostgreSQL, using [hstore](http://guides.rubyonrails.org/active_record_postgresql.html#hstore)/json maybe better, but the best way is to add a dedicated column to record the data (the Rails way).
 
 Using Redis to store wechat token and ticket:
 
@@ -71,7 +71,8 @@ Using Redis to store wechat token and ticket:
 rails g wechat:redis_store
 ```
 
-Redis store supports Rails application running in multi-server, no need to enable it if your Rails application is running on one server only, the wechat command won't read the token/ticket stored in Redis.
+
+Redis storage supports Rails application running in multiple servers. It is recommended to use default file storage if there is only one single server. Besides that, `wechat` command won't read token/ticket stored in Redis.
 
 Enable database wechat configurations:
 
@@ -94,7 +95,7 @@ How to setup appid/corpid and secret see below section.
 
 #### Configure for command line
 
-To use `wechat` command solely, you need to create configuration file `~/.wechat.yml` and include content below  for public account. The access_token will be written to a file.
+To use standalone `wechat` command, you need to create configuration file `~/.wechat.yml` and include content below  for public account. The `access_token` will be written to file `/var/tmp/wechat_access_token`.
 
 ```
 appid: "my_appid"
@@ -205,7 +206,21 @@ test:
  #  secret: "my_secret"
 ```
 
-For multiple accounts details reference [PR 150](https://github.com/Eric-Guo/wechat/pull/150)
+Notes about supporting multiple accounts of `WeChat Official Accounts Platform` / `WeChat Enterprise` (for example, adding account `wx2`):
+
+* Configuration for multiple accounts is similar to multi-database configuration in `config/database.yml`,
+   where `development`, `test`, `production` segments are the default configuration, one needs to add `wx2_development`, `wx2_test`, `wx2_production` in order to add additional account named `wx2`.
+
+* Declaration of additional `wechat_responder`:
+  ```ruby
+  wechat_responder account: :wx2
+  ```
+
+* Use `Wechat.api` or `Wechat.api(:default)` to represent the default wechat api. Use `Wechat.api(:wx2)` to call for wechat api of account `wx2`.
+
+* When using `Wechat command line`, one can switch to another wechat account by adding optional parameters `-a ACCOUNT [--account=ACCOUNT]`.
+
+For details about supporting multiple accounts, please check [PR 150](https://github.com/Eric-Guo/wechat/pull/150)
 
 For wechat mini program, can specified by the item `type`:
 

data/lib/generators/wechat/templates/config/initializers/wechat_redis_store.rb

@@ -17,7 +17,7 @@ module Wechat
       private
 
       def redis_key
-        "my_app_wechat_token_#{self.appid}"
+        "my_app_wechat_token_#{self.secret}"
       end
     end
   end
@@ -35,7 +35,7 @@ module Wechat
       private
 
       def redis_key
-        "my_app_wechat_ticket_#{self.access_token.appid}"
+        "my_app_wechat_ticket_#{self.access_token.secret}"
       end
     end
   end

data/lib/wechat/corp_api.rb

@@ -24,6 +24,15 @@ module Wechat
       get 'agent/get', params: { agentid: agentid }
     end
 
+    def checkin(useridlist, starttime = Time.now.beginning_of_day, endtime = Time.now.end_of_day, opencheckindatatype = 3)
+      post 'checkin/getcheckindata', JSON.generate(
+        opencheckindatatype: opencheckindatatype,
+        starttime: starttime.to_i,
+        endtime: endtime.to_i,
+        useridlist: useridlist
+      )
+    end
+
     def user(userid)
       get 'user/get', params: { userid: userid }
     end

data/lib/wechat/message.rb

@@ -104,12 +104,19 @@ module Wechat
       update(MsgType: 'text', Content: content)
     end
 
-    def textcard(title, description, url, btntxt)
-      update(MsgType: 'textcard', TextCard: {
+    def textcard(title, description, url, btntxt = nil)
+      data = {
         title: title,
         description: description,
-        url: url,
-        btntxt: btntxt
+        url: url
+      }
+      data[:btntxt] = btntxt if btntxt.present?
+      update(MsgType: 'textcard', TextCard: data)
+    end
+
+    def markdown(content)
+      update(MsgType: 'markdown', Markdown: {
+        content: content
       })
     end
 
@@ -197,6 +204,7 @@ module Wechat
 
     TO_JSON_KEY_MAP = {
       'TextCard'         => 'textcard',
+      'Markdown'         => 'markdown',
       'ToUserName'       => 'touser',
       'ToWxName'         => 'towxname',
       'MediaId'          => 'media_id',
@@ -208,7 +216,7 @@ module Wechat
       'ShowCoverPic'     => 'show_cover_pic'
     }.freeze
 
-    TO_JSON_ALLOWED = %w[touser msgtype content image voice video file textcard
+    TO_JSON_ALLOWED = %w[touser msgtype content image voice video file textcard markdown
                          music news articles template agentid filter
                          send_ignore_reprint mpnews towxname].freeze
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Skinnyworm
@@ -35,7 +35,7 @@ cert_chain:
   ivoox98/nhOs6bHcSFPsxXdxUihcCfCzj+zcaHNEqpvTI/36Bnl2XW6dUJNaFQDc
   oWOyq5ZkxqnYrYXactjW0+vcPv6WHoHXmjv4dF7iFp8r0mvK
   -----END CERTIFICATE-----
-date: 2019-01-22 00:00:00.000000000 Z
+date: 2019-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -137,16 +137,16 @@ dependencies:
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.3.13
 description: API, command and message handling for WeChat in Rails
 email: eric.guocz@gmail.com
 executables: