wechat 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e8ac0d453ab3b09ebc953fc377d87e3e4faaa691
-  data.tar.gz: db19e37a02a7361aed18294bc10782f276af4bb3
+  metadata.gz: f1a9041e7d411063724f87e3a8393a120542e1bf
+  data.tar.gz: 1dfa35792fa8f41f9872b00e645196115658308c
 SHA512:
-  metadata.gz: c7ed1bc6f07ded18760833ecfc8a19f5daba4ccb8ad0d6e1ed0ce484ef58ae08558c097c37aae5b014101400786d3b76c9a572ef2ce21c3cc56a8c9a3cf71224
-  data.tar.gz: 205d9c379adec3226e9fa51600ead4905a259133ff724eb49a56d7dec18b14304232a1e75aa92553e4c7048f83837295b2c1ce65c37b2789c40ca1f4fa5e21e3
+  metadata.gz: 14df5df5f86412bbb4076095903884c26a8a7942927d3afa5bdb34d2b0d4c65ff330f41fed0bdf38f970f80893117429efd48e531b6a8f9f566b169314cbfc3d
+  data.tar.gz: 7daf46b7df72eb76dc8508a6bbc6f575acd44e2beb214d9c81d6cb51bf551591ec0c1a172d942e89e0b65fe92fc5bd713454ccd7a4b93add0a40059500a9fc36

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.3.0 (released at 8/30/2015)
+
+* New user group management API
+* Allow transfer to customer service on fallback. #42
+* Read and write access_token properly using file locking, #43
+
 ## v0.2.0 (released at 8/27/2015)
 
 * Add wechat enterprise account support

data/README.md

@@ -136,18 +136,24 @@ $ wechat
 Wechat commands:
   wechat custom_image [OPENID, IMAGE_PATH]                 # 发送图片客服消息
   wechat custom_music [OPENID, THUMBNAIL_PATH, MUSIC_URL]  # 发送音乐客服消息
-  wechat custom_news [OPENID, NEWS_YAML_FILE]              # 发送图文客服消息
+  wechat custom_news [OPENID, NEWS_YAML_PATH]              # 发送图文客服消息
   wechat custom_text [OPENID, TEXT_MESSAGE]                # 发送文字客服消息
   wechat custom_video [OPENID, VIDEO_PATH]                 # 发送视频客服消息
   wechat custom_voice [OPENID, VOICE_PATH]                 # 发送语音客服消息
+  wechat group_create [GROUP_NAME]                         # 创建分组
+  wechat group_delete [GROUP_ID]                           # 删除分组
+  wechat group_update [GROUP_ID, NEW_GROUP_NAME]           # 修改分组名
+  wechat groups                                            # 所有用户分组列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
-  wechat media_create [MEDIA_ID, PATH]                     # 媒体上传
+  wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
   wechat menu                                              # 当前菜单
-  wechat menu_create [MENU_YAML]                           # 创建菜单
+  wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
   wechat menu_delete                                       # 删除菜单
   wechat message_send [OPENID, TEXT_MESSAGE]               # 发送文字消息(仅企业号)
-  wechat template_message [OPENID, TEMPLATE_YAML_FILE]     # 模板消息接口
+  wechat template_message [OPENID, TEMPLATE_YAML_PATH]     # 模板消息接口
   wechat user [OPEN_ID]                                    # 查找关注者
+  wechat user_change_group [OPEN_ID, TO_GROUP_ID]          # 移动用户分组
+  wechat user_group [OPEN_ID]                              # 查询用户所在分组
   wechat users                                             # 关注者列表
 ```
 
@@ -237,7 +243,7 @@ button:
 
 ```
 
-然后执行命令行
+然后执行命令行，需确保设置，权限管理中有对此应用的管理权限，否则会报[60011](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%85%A8%E5%B1%80%E8%BF%94%E5%9B%9E%E7%A0%81%E8%AF%B4%E6%98%8E)错。
 
 ```
 $ wechat menu_create menu.yaml
@@ -311,11 +317,10 @@ $ wechat template_message oCfEht9oM*********** template.yml
 然后创建Controller class, 例如
 
 ```ruby
-
 class WechatsController < ApplicationController
   wechat_responder
   
-  # 默认的文字信息responder
+  # 默认文字信息responder
   on :text do |request, content|
     request.reply.text "echo: #{content}" #Just echo
   end
@@ -396,10 +401,25 @@ end
 - :event 响应事件消息, 可以用`:with`参数来匹配事件类型
 - :fallback 默认响应，当收到的消息无法被其他responder响应时，会使用这个responder.
 
+### 多客服消息转发
+
+```ruby
+class WechatsController < ApplicationController
+  # 当无任何responder处理用户信息时，转发至客服处理。
+  on :fallback, respond: nil do |message|
+	message.reply.transfer_customer_service
+  end 
+end
+```
+
+注意设置了[多客服消息转发](http://dkf.qq.com/)后，不能再添加`默认文字信息responder`，否则文字消息将得不到转发。
+
 ## Message DSL
 
 Wechat 的核心是一个Message DSL,帮助开发者构建各种类型的消息，包括主动推送的和被动响应的。
 ....
 
   
+## 已知问题
 
+企业号接受菜单消息时，Wechat腾讯服务器无法解析部分域名，请使用IP绑定回调URL，用户的普通消息目前不受影响。

data/bin/wechat

@@ -37,8 +37,6 @@ HELP
       end
     end
 
-    private
-
     def self.loading_config
       config = {}
 
@@ -64,6 +62,26 @@ HELP
   package_name 'Wechat'
   option :toke_file, aliases: '-t', desc: 'File to store access token'
 
+  desc 'groups', '所有用户分组列表'
+  def groups
+    puts Helper.with(options).groups
+  end
+
+  desc 'group_create [GROUP_NAME]', '创建分组'
+  def group_create(group_name)
+    puts Helper.with(options).group_create(group_name)
+  end
+
+  desc 'group_update [GROUP_ID, NEW_GROUP_NAME]', '修改分组名'
+  def group_update(groupid, new_group_name)
+    puts Helper.with(options).group_update(groupid, new_group_name)
+  end
+
+  desc 'group_delete [GROUP_ID]', '删除分组'
+  def group_delete(groupid)
+    puts Helper.with(options).group_delete(groupid)
+  end
+
   desc 'users', '关注者列表'
   def users
     puts Helper.with(options).users
@@ -74,6 +92,16 @@ HELP
     puts Helper.with(options).user(open_id)
   end
 
+  desc 'user_group [OPEN_ID]', '查询用户所在分组'
+  def user_group(openid)
+    puts Helper.with(options).user_group(openid)
+  end
+
+  desc 'user_change_group [OPEN_ID, TO_GROUP_ID]', '移动用户分组'
+  def user_change_group(openid, to_groupid)
+    puts Helper.with(options).user_change_group(openid, to_groupid)
+  end
+
   desc 'menu', '当前菜单'
   def menu
     puts Helper.with(options).menu

data/lib/wechat/access_token.rb

@@ -11,7 +11,7 @@ module Wechat
 
     def token
       begin
-        @token_data ||= JSON.parse(File.read(token_file))
+        @token_data ||= JSON.parse(File.read(token_file, open_args: File::LOCK_SH))
         created_at = token_data['created_at'].to_i
         expires_in = token_data['expires_in'].to_i
         if Time.now.to_i - created_at >= expires_in - 3 * 60
@@ -26,7 +26,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)
-      File.open(token_file, 'w') { |f| f.write(data.to_json) } if valid_token(data)
+      File.write(token_file, data.to_json) if valid_token(data)
       @token_data = data
     end
 

data/lib/wechat/api.rb

@@ -15,6 +15,22 @@ class Wechat::Api
     @jsapi_ticket = Wechat::JsapiTicket.new(@client, @access_token, jsapi_ticket_file)
   end
 
+  def groups
+    get('groups/get')
+  end
+
+  def group_create(group_name)
+    post 'groups/create', JSON.generate(group: { name: group_name })
+  end
+
+  def group_update(groupid, new_group_name)
+    post 'groups/update', JSON.generate(group: { id: groupid, name: new_group_name })
+  end
+
+  def group_delete(groupid)
+    post 'groups/delete', JSON.generate(group: { id: groupid })
+  end
+
   def users(nextid = nil)
     params = { params: { next_openid: nextid } } if nextid.present?
     get('user/get', params || {})
@@ -24,6 +40,14 @@ class Wechat::Api
     get('user/info', params: { openid: openid })
   end
 
+  def user_group(openid)
+    post 'groups/getid', JSON.generate(openid: openid)
+  end
+
+  def user_change_group(openid, to_groupid)
+    post 'groups/members/update', JSON.generate(openid: openid, to_groupid: to_groupid)
+  end
+
   def menu
     get('menu/get')
   end

data/lib/wechat/jsapi_ticket.rb

@@ -49,7 +49,7 @@ module Wechat
     #  }
     def signature(url)
       timestamp = Time.now.to_i
-      noncestr = generate_noncestr
+      noncestr = SecureRandom.base64(16)
       params = {
         noncestr: noncestr,
         timestamp: timestamp,
@@ -70,17 +70,5 @@ module Wechat
       raise "Response didn't have ticket" if  ticket.blank?
       ticket
     end
-
-    # 生成随机字符串
-    # @param  Integer length 长度, 默认为16
-    # @return String
-    def generate_noncestr(length = 16)
-      chars = 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789'
-      str = ''
-      1.upto(length) do |i|
-        str += chars[rand(chars.length)]
-      end
-      str
-    end
   end
 end

data/lib/wechat/message.rb

@@ -49,8 +49,9 @@ module Wechat
         Wechat.api.media(message_hash[:MediaId])
 
       when :location
-        message_hash.slice(:Location_X, :Location_Y, :Scale, :Label).inject({}) { |results, value|
-          results[value[0].to_s.underscore.to_sym] = value[1]; results }
+        message_hash.slice(:Location_X, :Location_Y, :Scale, :Label).each_with_object({}) do |value, results|
+          results[value[0].to_s.underscore.to_sym] = value[1]
+        end
       else
         raise "Don't know how to parse message as #{type}"
       end
@@ -68,6 +69,10 @@ module Wechat
       update(MsgType: 'text', Content: content)
     end
 
+    def transfer_customer_service
+      update(MsgType: 'transfer_customer_service')
+    end
+
     def image(media_id)
       update(MsgType: 'image', Image: { MediaId: media_id })
     end

data/lib/wechat/responder.rb

@@ -56,20 +56,19 @@ module Wechat
       private
 
       def match_responders(responders, value)
-        matched = responders.inject({ scoped: nil, general: nil }) do |matched, responder|
+        matched = responders.each_with_object({}) do |responder, memo|
           condition = responder[:with]
 
           if condition.nil?
-            matched[:general] ||= [responder, value]
-            next matched
+            memo[:general] ||= [responder, value]
+            next
           end
 
           if condition.is_a? Regexp
-            matched[:scoped] ||= [responder] + $LAST_MATCH_INFO.captures if value =~ condition
+            memo[:scoped] ||= [responder] + $LAST_MATCH_INFO.captures if value =~ condition
           else
-            matched[:scoped] ||= [responder, value] if value == condition
+            memo[:scoped] ||= [responder, value] if value == condition
           end
-          matched
         end
         matched[:scoped] || matched[:general]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-26 00:00:00.000000000 Z
+date: 2015-08-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails