wechat 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7f55b06f42f4f81535e3eac7cb4030d7850758e
-  data.tar.gz: 5b8992563a4e96c2e084a2f371601445678a3a8c
+  metadata.gz: 24f3a19bb36361d788567cdb400d5a6247753de4
+  data.tar.gz: eee12cc2791847bb3a0568d57829b348785d10c8
 SHA512:
-  metadata.gz: 602388ebebfda0bba1b5bc2f7cf7601cb313255acdc658902bd3bab5785c52aa23139bdd9bb503d787175012691cccebf0aa17e0637e2aa84f6e251321c43cdb
-  data.tar.gz: 3700915a52962394b839d77d8b3d6478cdb1df903f5d026910f9bd330755353396c5ae572e199da9f5a8e31bbfe492a0aa4f022bcbc8b7dac50d6f6b268df62f
+  metadata.gz: 742d6ed1dbad1e243aea4fce5e289838aee163f858da65d818c82638069e0ecb5a1afd94cb7a9b2689f30867aa4a6c18a8389fe7bdca8e81cae988fedf6dc04e
+  data.tar.gz: 8e0f78fedb6bc0cd798d1f8debbab117e3fa8ac642e5c42504d6e2226656b4813fd4ab3685b7092473ebc3ad0964ed416ee5db2b141742b0c70a3839477982a0

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
+## v0.7.1 (released at 1/11/2016)
+
+* Fix after using http, upload file function break. #78
+* Add callback function after_wechat_response support. by @zfben #79
+* Should using department_id instead of departmentid at enterprise api: user_simplelist/user_list.
+
 ## v0.7.0 (released at 1/1/2016)
 
-* Using [http](https://github.com/httprb/http) instead of rest-client for performance reason.
+* Using [http](https://github.com/httprb/http) instead of rest-client for performance reason. (not support upload file yet)
+
+## v0.6.9 (released at 1/6/2016)
+
 * Fix token refresh bug on multi worker. #76
 * Rewrite the token relative code to add more storage support in future.
 

data/README-CN.md

@@ -79,16 +79,16 @@ default: &default
   token:  "app_token"
   access_token: "/var/tmp/wechat_access_token"
 
-production: 
+production:
   appid: <%= ENV['WECHAT_APPID'] %>
   secret: <%= ENV['WECHAT_APP_SECRET'] %>
   token:   <%= ENV['WECHAT_TOKEN'] %>
   access_token:  <%= ENV['WECHAT_ACCESS_TOKEN'] %>
 
-development: 
+development:
   <<: *default
 
-test: 
+test:
   <<: *default
 ```
 
@@ -149,11 +149,11 @@ Wechat服务器有报道曾出现[RestClient::SSLCertificateNotVerified](http://
 ```ruby
 class WechatFirstController < ActionController::Base
    wechat_responder appid: "app1", secret: "secret1", token: "token1", access_token: Rails.root.join("tmp/access_token1")
-   
+
    on :text, with:"help", respond: "help content"
 end
 ```
-    
+
 #### jssdk 支持
 
 jssdk 使用前需通过config接口注入权限验证配置, 所需参数可以通过 signature 方法获取:
@@ -354,7 +354,7 @@ articles:
 然后执行命令行
 
 ```
-$ wechat custom_news oCfEht9oM*********** articles.yml 
+$ wechat custom_news oCfEht9oM*********** articles.yml
 
 ```
 
@@ -368,7 +368,7 @@ template:
   url: "http://weixin.qq.com/download"
   topcolor: "#FF0000"
   data:
-    first: 
+    first:
       value: "你好，你已报名成功"
       color: "#0A0A0A"      
     keynote1:
@@ -405,7 +405,7 @@ $ wechat template_message oCfEht9oM*********** template.yml
 ```ruby
 class WechatsController < ActionController::Base
   wechat_responder
-  
+
   # 默认文字信息responder
   on :text do |request, content|
     request.reply.text "echo: #{content}" #Just echo
@@ -522,6 +522,13 @@ class WechatsController < ActionController::Base
 
   # 当无任何responder处理用户信息时,使用这个responder处理
   on :fallback, respond: 'fallback message'
+
+  # 如果你要在微信回复后增加一些操作，可以用 after_wechat_response(req, res)
+  # private
+  #
+  # def after_wechat_response(req, res)
+  #   WechatLog.create req: req, res: res
+  # end
 end
 ```
 
@@ -557,7 +564,7 @@ class WechatsController < ActionController::Base
   # 当无任何responder处理用户信息时，转发至客服处理。
   on :fallback do |message|
 	message.reply.transfer_customer_service
-  end 
+  end
 end
 ```
 

data/README.md

@@ -17,7 +17,7 @@ WeChat gem trying to helping Rails developer to integrated [enterprise account](
 
 `wechat` command share the same API in console, so you can interactive with wechat server quickly, without starting up web environment/code.
 
-A responder DSL can used in Rails controller, so giving a event based interface to handler message sent by end user from wechat server. 
+A responder DSL can used in Rails controller, so giving a event based interface to handler message sent by end user from wechat server.
 
 Wechat provide OAuth2.0 as authentication service and possible to intergrated with devise/other authorization gems, [omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2) is a good start
 
@@ -88,16 +88,16 @@ default: &default
   token:  "app_token"
   access_token: "/var/tmp/wechat_access_token"
 
-production: 
+production:
   appid: <%= ENV['WECHAT_APPID'] %>
   secret: <%= ENV['WECHAT_APP_SECRET'] %>
   token:   <%= ENV['WECHAT_TOKEN'] %>
   access_token:  <%= ENV['WECHAT_ACCESS_TOKEN'] %>
 
-development: 
+development:
   <<: *default
 
-test: 
+test:
   <<: *default
 ```
 
@@ -161,11 +161,11 @@ Rare case, you may want to hosting more than one wechat enterprise/public accoun
 ```ruby
 class WechatFirstController < ActionController::Base
    wechat_responder appid: "app1", secret: "secret1", token: "token1", access_token: Rails.root.join("tmp/access_token1")
-   
+
    on :text, with:"help", respond: "help content"
 end
 ```
-    
+
 #### JS-SDK helper
 
 JS-SDK enable you control wechat behavior in your web page, but need inject a config with signature methods first, you can obtain those signature hash via below
@@ -182,7 +182,7 @@ wechat gems won't handle any privilege exception. (except token time out, but it
 
 The available API is different between public account and enterprise account, so wechat gems provide different set of command.
 
-Feel safe if you can not read Chinese in the comments, it's keep there in order to copy & find in official document more easier. 
+Feel safe if you can not read Chinese in the comments, it's keep there in order to copy & find in official document more easier.
 
 #### Public account command line
 
@@ -367,7 +367,7 @@ articles:
 After that, can running command:
 
 ```
-$ wechat custom_news oCfEht9oM*********** articles.yml 
+$ wechat custom_news oCfEht9oM*********** articles.yml
 
 ```
 
@@ -381,7 +381,7 @@ template:
   url: "http://weixin.qq.com/download"
   topcolor: "#FF0000"
   data:
-    first: 
+    first:
       value: "Hello, you successfully registed"
       color: "#0A0A0A"      
     keynote1:
@@ -535,10 +535,17 @@ class WechatsController < ActionController::Base
 
   # Any not match above will fail to below
   on :fallback, respond: 'fallback message'
+
+  # If you need do something after response, you should add after_wechat_response(req, res)
+  # private
+  #
+  # def after_wechat_response(req, res)
+  #   WechatLog.create req: req, res: res
+  # end
 end
 ```
 
-So the importent statement is only `wechat_responder`, all other is just a DSL: 
+So the importent statement is only `wechat_responder`, all other is just a DSL:
 
 ```
 on <message_type> do |message|
@@ -571,13 +578,13 @@ class WechatsController < ActionController::Base
   # When no other responder can handle incoming message, will transfer to human customer service.
   on :fallback do |message|
     message.reply.transfer_customer_service
-  end 
+  end
 end
 ```
 
 Caution: do not setting default text responder if you want to using [multiply human customer service](http://dkf.qq.com/), other will lead text message can not transfer.
 
-  
+
 ## Known Issue
 
 * Sometime, enterprise account can not receive the menu message due to Tencent server can not resolved the DNS, so using IP as a callback URL more stable, but it's never happen for user sent text message.

data/bin/wechat

@@ -173,8 +173,7 @@ class App < Thor
 
     desc 'upload_replaceparty [BATCH_PARTY_CSV_PATH]', '上传文件方式全量覆盖部门'
     def upload_replaceparty(batch_party_csv_path)
-      file = File.new(batch_party_csv_path)
-      media_id = wechat_api.media_create('file', file)['media_id']
+      media_id = wechat_api.media_create('file', batch_party_csv_path)['media_id']
       job_id = wechat_api.batch_replaceparty(media_id)['jobid']
       puts "running job_id: #{job_id}"
       puts wechat_api.batch_job_result(job_id)
@@ -192,8 +191,7 @@ class App < Thor
 
     desc 'upload_replaceuser [BATCH_USER_CSV_PATH]', '上传文件方式全量覆盖成员'
     def upload_replaceuser(batch_user_csv_path)
-      file = File.new(batch_user_csv_path)
-      media_id = wechat_api.media_create('file', file)['media_id']
+      media_id = wechat_api.media_create('file', batch_user_csv_path)['media_id']
       job_id = wechat_api.batch_replaceuser(media_id)['jobid']
       puts "running job_id: #{job_id}"
       puts wechat_api.batch_job_result(job_id)
@@ -321,8 +319,7 @@ class App < Thor
 
   desc 'media_create [MEDIA_TYPE, PATH]', '媒体上传'
   def media_create(type, path)
-    file = File.new(path)
-    puts wechat_api.media_create(type, file)
+    puts wechat_api.media_create(type, path)
   end
 
   desc 'material [MEDIA_ID, PATH]', '永久媒体下载'
@@ -334,8 +331,7 @@ class App < Thor
 
   desc 'material_add [MEDIA_TYPE, PATH]', '永久媒体上传'
   def material_add(type, path)
-    file = File.new(path)
-    puts wechat_api.material_add(type, file)
+    puts wechat_api.material_add(type, path)
   end
 
   desc 'material_delete [MEDIA_ID]', '删除永久素材'
@@ -370,19 +366,15 @@ class App < Thor
 
   desc 'custom_image [OPENID, IMAGE_PATH]', '发送图片客服消息'
   def custom_image(openid, image_path)
-    file = File.new(image_path)
     api = wechat_api
-
-    media_id = api.media_create('image', file)['media_id']
+    media_id = api.media_create('image', image_path)['media_id']
     puts api.custom_message_send Wechat::Message.to(openid).image(media_id)
   end
 
   desc 'custom_voice [OPENID, VOICE_PATH]', '发送语音客服消息'
   def custom_voice(openid, voice_path)
-    file = File.new(voice_path)
     api = wechat_api
-
-    media_id = api.media_create('voice', file)['media_id']
+    media_id = api.media_create('voice', voice_path)['media_id']
     puts api.custom_message_send Wechat::Message.to(openid).voice(media_id)
   end
 
@@ -390,11 +382,9 @@ class App < Thor
   method_option :title, aliases: '-h', desc: '视频标题'
   method_option :description, aliases: '-d', desc: '视频描述'
   def custom_video(openid, video_path)
-    file = File.new(video_path)
     api = wechat_api
-
     api_opts = options.slice(:title, :description)
-    media_id = api.media_create('video', file)['media_id']
+    media_id = api.media_create('video', video_path)['media_id']
     puts api.custom_message_send Wechat::Message.to(openid).video(media_id, api_opts)
   end
 
@@ -403,11 +393,9 @@ class App < Thor
   method_option :description, aliases: '-d', desc: '音乐描述'
   method_option :HQ_music_url, aliases: '-u', desc: '高质量音乐URL链接'
   def custom_music(openid, thumbnail_path, music_url)
-    file = File.new(thumbnail_path)
     api = wechat_api
-
     api_opts = options.slice(:title, :description, :HQ_music_url)
-    thumb_media_id = api.media_create('thumb', file)['thumb_media_id']
+    thumb_media_id = api.media_create('thumb', thumbnail_path)['thumb_media_id']
     puts api.custom_message_send Wechat::Message.to(openid).music(thumb_media_id, music_url, api_opts)
   end
 

data/lib/wechat/api.rb

@@ -1,7 +1,7 @@
 require 'wechat/api_base'
 require 'wechat/client'
 require 'wechat/token/public_access_token'
-require 'wechat/ticket/jsapi_ticket'
+require 'wechat/ticket/public_jsapi_ticket'
 
 module Wechat
   class Api < ApiBase
@@ -11,7 +11,7 @@ module Wechat
     def initialize(appid, secret, token_file, timeout, skip_verify_ssl, jsapi_ticket_file)
       @client = Client.new(API_BASE, timeout, skip_verify_ssl)
       @access_token = Token::PublicAccessToken.new(@client, appid, secret, token_file)
-      @jsapi_ticket = Ticket::JsapiTicket.new(@client, @access_token, jsapi_ticket_file)
+      @jsapi_ticket = Ticket::PublicJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
     end
 
     def groups
@@ -94,7 +94,7 @@ module Wechat
     end
 
     def material_add(type, file)
-      post 'material/add_material', { upload: { media: file } }, params: { type: type }
+      post_file 'material/add_material', file, params: { type: type }
     end
 
     def material_delete(media_id)

data/lib/wechat/api_base.rb

@@ -17,7 +17,7 @@ module Wechat
     end
 
     def media_create(type, file)
-      post 'media/upload', { upload: { media: file } }, params: { type: type }
+      post_file 'media/upload', file, params: { type: type }
     end
 
     protected
@@ -34,6 +34,12 @@ module Wechat
       end
     end
 
+    def post_file(path, file, headers = {})
+      with_access_token(headers[:params]) do |params|
+        client.post_file path, file, headers.merge(params: params)
+      end
+    end
+
     def with_access_token(params = {}, tries = 2)
       params ||= {}
       yield(params.merge(access_token: access_token.token))

data/lib/wechat/client.rb

@@ -25,12 +25,23 @@ module Wechat
       end
     end
 
+    def post_file(path, file, post_header = {})
+      request(path, post_header) do |url, header|
+        params = header.delete(:params)
+        HTTP.headers(header)
+          .post(url, params: params,
+                     form: { media: HTTP::FormData::File.new(file),
+                             hack: 'X' }, # Existing here for http-form_data 1.0.1 handle single param improperly
+                     ssl_context: ssl_context)
+      end
+    end
+
     private
 
     def request(path, header = {}, &_block)
       url = "#{header.delete(:base) || base}#{path}"
       as = header.delete(:as)
-      header.merge!(accept: :json)
+      header.merge!('Accept' => 'application/json')
       response = yield(url, header)
 
       fail "Request not OK, response status #{response.status}" if response.status != 200

data/lib/wechat/corp_api.rb

@@ -90,12 +90,12 @@ module Wechat
       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 }
+    def user_simplelist(department_id, fetch_child = 0, status = 0)
+      get 'user/simplelist', params: { department_id: department_id, 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 }
+    def user_list(department_id, fetch_child = 0, status = 0)
+      get 'user/list', params: { department_id: department_id, fetch_child: fetch_child, status: status }
     end
 
     def tag_create(tagname, tagid = nil)
@@ -152,7 +152,7 @@ module Wechat
     end
 
     def material_add(type, file)
-      post 'material/add_material', { upload: { media: file } }, params: { type: type, agentid: agentid }
+      post_file 'material/add_material', file, params: { type: type, agentid: agentid }
     end
 
     def material_delete(media_id)

data/lib/wechat/responder.rb

@@ -164,6 +164,8 @@ module Wechat
       else
         render nothing: true, status: 200, content_type: 'text/html'
       end
+
+      after_wechat_response(request, response) if respond_to?(:after_wechat_response)
     end
 
     private

data/lib/wechat/ticket/{jsapi_ticket.rb → public_jsapi_ticket.rb}

@@ -2,8 +2,7 @@ require 'wechat/ticket/jsapi_base'
 
 module Wechat
   module Ticket
-    class JsapiTicket < JsapiBase
-      # refresh jsapi ticket
+    class PublicJsapiTicket < JsapiBase
       def refresh
         data = client.get('ticket/getticket', params: { access_token: access_token.token, type: 'jsapi' })
         write_ticket_to_file(data)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-01 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,7 +136,7 @@ files:
 - lib/wechat/signature.rb
 - lib/wechat/ticket/corp_jsapi_ticket.rb
 - lib/wechat/ticket/jsapi_base.rb
-- lib/wechat/ticket/jsapi_ticket.rb
+- lib/wechat/ticket/public_jsapi_ticket.rb
 - lib/wechat/token/access_token_base.rb
 - lib/wechat/token/corp_access_token.rb
 - lib/wechat/token/public_access_token.rb
@@ -144,13 +144,7 @@ homepage: https://github.com/Eric-Guo/wechat
 licenses:
 - MIT
 metadata: {}
-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' `.
-  *****************************
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib