wechat 0.7.7 → 0.7.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1227afa2c59a9657b91eda79d71e05c582dfd13c
-  data.tar.gz: 1ed732c34360e25275a35fa5ddbc62f9fe945e4c
+  metadata.gz: 53ffffaf24d8d96f29551c79c5de7ffa1829a918
+  data.tar.gz: d98f374eda600f2c61a1ce1dfcbe408663538b08
 SHA512:
-  metadata.gz: 358ebfbe074a0a0f631c2966b4cb8f0d3357d37fa8c6a0e67c87863d1b98030bcd625de8cdbbd36cac923e1378ed395599e8199659c8ccf41065085e7d05e57d
-  data.tar.gz: 95d512581d896582438b0a3c30d9994defaa485118ecf7c5fe90a0ad473ff4508f070aea1153abbabc2ce36bf3c8ad3a521319b9cf92b4cb98c2ed48999f9bc4
+  metadata.gz: f3a9d2da9c57c99b535c5f1f29a36f796100f23997386cfe922415df30aeb5d32e0e0634e99f6e5cf58e3ba2d1bf8b0e6a47bccdc4d3e1eb2db84d48fff9af61
+  data.tar.gz: f8913573a84ca830f21b14be23d446b336ef4daa010ec2501185dd3da102cc98244ef3e6ddc74d72b7b9781ce452e7065f8614b86690c62148742a564c771563

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Changelog
 
+## v0.7.8 (released at 3/31/2016)
+
+* New wechat_api, similar to wechat_responder, but without messange handle DSL, support web page only wechat application
+* New media_uploadimg API.
+* New file type of Message.
+* Improved multi account support per different controller.
+
 ## v0.7.7 (released at 3/18/2016)
 
 * New wechat_oauth2, only support enterprise account still.

data/README-CN.md

@@ -17,6 +17,8 @@ WeChat gem 可以帮助开发者方便地在Rails环境中集成微信[公众平
 
 如果您对如何制作微信网页UI没有灵感，可以参考官方的[weui](https://github.com/weui/weui)，针对Rails的Gem是[weui-rails](https://github.com/Eric-Guo/weui-rails)。
 
+主页型应用请使用[`wechat_api`](#wechat_api---rails-controller-wechat-api)，传统消息型应用请使用[`wechat_responder`](#wechat_responder---rails-responder-controller-dsl)。
+
 如果您想从一个稍微完整一些的示例开始微信开发，可以参考[wechat-starter](https://github.com/goofansu/wechat-starter)，这个示例甚至包括了微信支付的内容。
 
 ## 安装
@@ -164,7 +166,7 @@ Wechat服务器有报道曾出现[RestClient::SSLCertificateNotVerified](http://
 
 #### 为每个Responder配置不同的appid和secret
 
-在个别情况下，单个Rails应用可能需要处理来自多个账号的消息，此时可以配置多个responder controller。
+有些情况下，单个Rails应用可能需要处理来自多个微信公众号的消息，您可以通过在`wechat_responder`和`wechat_api`后配置多个相关参数来支持多账号。
 
 ```ruby
 class WechatFirstController < ActionController::Base
@@ -244,6 +246,7 @@ Wechat commands:
   wechat material_list [TYPE, OFFSET, COUNT]               # 获取永久素材列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
+  wechat media_uploadimg [IMAGE_PATH]                      # 上传图文消息内的图片
   wechat menu                                              # 当前菜单
   wechat menu_addconditional [CONDITIONAL_MENU_YAML_PATH]  # 创建个性化菜单  
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
@@ -292,6 +295,7 @@ Wechat commands:
   wechat material_list [TYPE, OFFSET, COUNT]               # 获取永久素材列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
+  wechat media_uploadimg [IMAGE_PATH]                      # 上传图文消息内的图片
   wechat menu                                              # 当前菜单
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
   wechat menu_delete                                       # 删除菜单
@@ -447,7 +451,22 @@ template:
 $ wechat template_message oCfEht9oM*********** template.yml
 ```
 
-## Rails Responder Controller DSL
+## wechat_api - Rails Controller Wechat API
+
+虽然用户可以随时通过`Wechat.api`在任意代码中访问wechat的API功能，但是更推荐的做法是仅在controller中，通过引入`wechat_api`，使用`wechat`调用API功能，不仅因为这样是支持多个微信公众号的必然要求，而且也避免了在模型层内过多引入微信相关代码。
+
+```ruby
+class WechatReportsController < ApplicationController
+  wechat_api
+  layout 'wechat'
+
+  def index
+    @lots = Lot.with_preloading.wip_lot
+  end
+end
+```
+
+## wechat_responder - Rails Responder Controller DSL
 
 为了在Rails app中响应用户的消息，开发者需要创建一个wechat responder controller. 首先在router中定义
 

data/README.md

@@ -24,6 +24,8 @@ Wechat provide OAuth2.0 authentication method `wechat_oauth2`, possible the easi
 
 There is official [weui](https://github.com/weui/weui), which corresponding Rails gems called [weui-rails](https://github.com/Eric-Guo/weui-rails) available, if you prefer following the same UI design as wechat.
 
+For web page only wechat application, using [`wechat_api`](#wechat_api---rails-controller-wechat-api), which only contain web feature compare 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, even include the payment SDK feature.
 
 ## Installation
@@ -177,7 +179,7 @@ SSL Certification can also be corrupted by some reason in China, [it's reported]
 
 #### Configure individual responder with different appid
 
-Rare case, you may want to hosting more than one wechat enterprise/public account in one Rails application, so you can given those configuration info when calling `wechat_responder`
+Sometime, you may want to hosting more than one enterprise/public wechat account in one Rails application, so you can given those configuration info when calling `wechat_responder` or `wechat_api`
 
 ```ruby
 class WechatFirstController < ActionController::Base
@@ -260,6 +262,7 @@ Wechat commands:
   wechat material_list [TYPE, OFFSET, COUNT]               # 获取永久素材列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
+  wechat media_uploadimg [IMAGE_PATH]                      # 上传图文消息内的图片
   wechat menu                                              # 当前菜单
   wechat menu_addconditional [CONDITIONAL_MENU_YAML_PATH]  # 创建个性化菜单  
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
@@ -308,6 +311,7 @@ Wechat commands:
   wechat material_list [TYPE, OFFSET, COUNT]               # 获取永久素材列表
   wechat media [MEDIA_ID, PATH]                            # 媒体下载
   wechat media_create [MEDIA_TYPE, PATH]                   # 媒体上传
+  wechat media_uploadimg [IMAGE_PATH]                      # 上传图文消息内的图片
   wechat menu                                              # 当前菜单
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
   wechat menu_delete                                       # 删除菜单
@@ -462,7 +466,22 @@ After that, can running command:
 $ wechat template_message oCfEht9oM*********** template.yml
 ```
 
-## Rails Responder Controller DSL
+## wechat_api - Rails Controller Wechat API
+
+Although user can always access all wechat feature via Wechat.api, but it's much more recommand to using `wechat` directly in controller. It's not only mandatory require if you plan to support multi-account, also help to seperate the wechat specific logic from the model layer.
+
+```ruby
+class WechatReportsController < ApplicationController
+  wechat_api
+  layout 'wechat'
+
+  def index
+    @lots = Lot.with_preloading.wip_lot
+  end
+end
+```
+
+## wechat_responder - Rails Responder Controller DSL
 
 In order to responding the message user sent, Rails developer need create a wechat responder controller and defined the routing in `routes.rb`
 

data/bin/wechat

@@ -343,6 +343,11 @@ class App < Thor
     puts wechat_api.media_create(type, path)
   end
 
+  desc 'media_uploadimg [IMAGE_PATH]', '上传图文消息内的图片'
+  def media_uploadimg(image_path)
+    puts wechat_api.media_uploadimg(image_path)
+  end
+
   desc 'material [MEDIA_ID, PATH]', '永久媒体下载'
   def material(media_id, path)
     tmp_file = wechat_api.material(media_id)

data/lib/action_controller/wechat_responder.rb

@@ -1,22 +1,36 @@
 module ActionController
   module WechatResponder
+    def wechat_api(opts = {})
+      include Wechat::ControllerApi
+      self.wechat = load_controller_wechat(opts)
+    end
+
     def wechat_responder(opts = {})
       include Wechat::Responder
+      self.wechat = load_controller_wechat(opts)
+    end
 
+    private_class_method
+
+    def load_controller_wechat(opts = {})
+      self.token = opts[:token] || Wechat.config.token
+      self.appid = opts[:appid] || Wechat.config.appid
       self.corpid = opts[:corpid] || Wechat.config.corpid
       self.agentid = opts[:agentid] || Wechat.config.agentid
       self.encrypt_mode = opts[:encrypt_mode] || Wechat.config.encrypt_mode || corpid.present?
       self.timeout = opts[:timeout] || 20
       self.skip_verify_ssl = opts[:skip_verify_ssl]
-      self.token = opts[:token] || Wechat.config.token
       self.encoding_aes_key = opts[:encoding_aes_key] || Wechat.config.encoding_aes_key
       self.trusted_domain_fullname = opts[:trusted_domain_fullname] || Wechat.config.trusted_domain_fullname
 
       return self.wechat = Wechat.api if opts.empty?
-      return self.wechat = Wechat::CorpApi.new(corpid, opts[:corpsecret], opts[:access_token], \
-                                               agentid, timeout, skip_verify_ssl, opts[:jsapi_ticket]) if corpid.present?
-      self.wechat = Wechat::Api.new(opts[:appid], opts[:secret], opts[:access_token], \
-                                    timeout, skip_verify_ssl, opts[:jsapi_ticket])
+      if corpid.present?
+        Wechat::CorpApi.new(corpid, opts[:corpsecret], opts[:access_token], \
+                            agentid, timeout, skip_verify_ssl, opts[:jsapi_ticket])
+      else
+        Wechat::Api.new(appid, opts[:secret], opts[:access_token], \
+                        timeout, skip_verify_ssl, opts[:jsapi_ticket])
+      end
     end
   end
 

data/lib/wechat.rb

@@ -8,6 +8,7 @@ module Wechat
   autoload :Message, 'wechat/message'
   autoload :Responder, 'wechat/responder'
   autoload :Cipher, 'wechat/cipher'
+  autoload :ControllerApi, 'wechat/controller_api'
 
   class AccessTokenExpiredError < StandardError; end
   class ResponseError < StandardError

data/lib/wechat/api_base.rb

@@ -20,6 +20,10 @@ module Wechat
       post_file 'media/upload', file, params: { type: type }
     end
 
+    def media_uploadimg(file)
+      post_file 'media/uploadimg', file
+    end
+
     protected
 
     def get(path, headers = {})

data/lib/wechat/api_loader.rb

@@ -27,7 +27,7 @@ HELP
       @config
     end
 
-    private
+    private_class_method
 
     def self.loading_config!
       config ||= config_from_file || config_from_environment

data/lib/wechat/client.rb

@@ -41,10 +41,10 @@ module Wechat
     def request(path, header = {}, &_block)
       url = "#{header.delete(:base) || base}#{path}"
       as = header.delete(:as)
-      header.merge!('Accept' => 'application/json')
+      header['Accept'] = 'application/json'
       response = yield(url, header)
 
-      fail "Request not OK, response status #{response.status}" if response.status != 200
+      raise "Request not OK, response status #{response.status}" if response.status != 200
       parse_response(response, as || :json) do |parse_as, data|
         break data unless parse_as == :json && data['errcode'].present?
 
@@ -56,9 +56,9 @@ module Wechat
         # 40001, invalid credential, access_token is invalid or not latest hint
         # 48001, api unauthorized hint, for qrcode creation # 71
         when 42001, 40014, 40001, 48001
-          fail AccessTokenExpiredError
+          raise AccessTokenExpiredError
         else
-          fail ResponseError.new(data['errcode'], data['errmsg'])
+          raise ResponseError.new(data['errcode'], data['errmsg'])
         end
       end
     end

data/lib/wechat/controller_api.rb

@@ -0,0 +1,40 @@
+module Wechat
+  module ControllerApi
+    extend ActiveSupport::Concern
+
+    module ClassMethods
+      attr_accessor :wechat, :token, :appid, :corpid, :agentid, :encrypt_mode, :timeout, :skip_verify_ssl, :encoding_aes_key, :trusted_domain_fullname
+    end
+
+    def wechat
+      self.class.wechat # Make sure user can continue access wechat at instance level similar to class level
+    end
+
+    def wechat_oauth2(scope = 'snsapi_base', page_url = nil)
+      appid = self.class.corpid || self.class.appid
+      page_url ||= if self.class.trusted_domain_fullname
+                     "#{self.class.trusted_domain_fullname}#{request.original_fullpath}"
+                   else
+                     request.original_url
+                   end
+      redirect_uri = CGI.escape(page_url)
+      oauth2_url = "https://open.weixin.qq.com/connect/oauth2/authorize?appid=#{appid}&redirect_uri=#{redirect_uri}&response_type=code&scope=#{scope}#wechat_redirect"
+
+      return oauth2_url unless block_given?
+      raise 'Currently wechat_oauth2 only support enterprise account.' unless self.class.corpid
+      if cookies.signed_or_encrypted[:we_deviceid].blank? && params[:code].blank?
+        redirect_to oauth2_url
+      elsif cookies.signed_or_encrypted[:we_deviceid].blank? && params[:code].present?
+        userinfo = wechat.getuserinfo(params[:code])
+        cookies.signed_or_encrypted[:we_userid] = { value: userinfo['UserId'], expires: 1.hour.from_now }
+        cookies.signed_or_encrypted[:we_deviceid] = { value: userinfo['DeviceId'], expires: 1.hour.from_now }
+        cookies.signed_or_encrypted[:we_openid] = { value: userinfo['OpenId'], expires: 1.hour.from_now }
+        yield userinfo['UserId'], userinfo
+      else
+        yield cookies.signed_or_encrypted[:we_userid], { 'UserId' => cookies.signed_or_encrypted[:we_userid],
+                                                         'DeviceId' => cookies.signed_or_encrypted[:we_deviceid],
+                                                         'OpenId' => cookies.signed_or_encrypted[:we_openid] }
+      end
+    end
+  end
+end

data/lib/wechat/helpers.rb

@@ -1,16 +1,16 @@
 module Wechat
   module Helpers
     def wechat_config_js(config_options = {})
-      page_url = if Wechat.config.trusted_domain_fullname
-                   "#{Wechat.config.trusted_domain_fullname}#{controller.request.original_fullpath}"
+      page_url = if controller.class.trusted_domain_fullname
+                   "#{controller.class.trusted_domain_fullname}#{controller.request.original_fullpath}"
                  else
                    controller.request.original_url
                  end
-      js_hash = Wechat.api.jsapi_ticket.signature(page_url)
+      js_hash = controller.wechat.jsapi_ticket.signature(page_url)
       config_js = <<-WECHAT_CONFIG_JS
 wx.config({
   debug: #{config_options[:debug]},
-  appId: "#{Wechat.config.corpid || Wechat.config.appid}",
+  appId: "#{controller.class.corpid || controller.class.appid}",
   timestamp: "#{js_hash[:timestamp]}",
   nonceStr: "#{js_hash[:noncestr]}",
   signature: "#{js_hash[:signature]}",

data/lib/wechat/message.rb

@@ -65,7 +65,7 @@ module Wechat
           results[value[0].to_s.underscore.to_sym] = value[1]
         end
       else
-        fail "Don't know how to parse message as #{type}"
+        raise "Don't know how to parse message as #{type}"
       end
     end
 
@@ -106,6 +106,10 @@ module Wechat
       update(MsgType: 'video', Video: video_fields)
     end
 
+    def file(media_id)
+      update(MsgType: 'file', File: { MediaId: media_id })
+    end
+
     def music(thumb_media_id, music_url, opts = {})
       music_fields = camelize_hash_keys(opts.slice(:title, :description, :HQ_music_url).merge(music_url: music_url, thumb_media_id: thumb_media_id))
       update(MsgType: 'music', Music: music_fields)
@@ -145,7 +149,7 @@ module Wechat
       'TemplateId' => 'template_id'
     }.freeze
 
-    TO_JSON_ALLOWED = %w(touser msgtype content image voice video music news articles template agentid).freeze
+    TO_JSON_ALLOWED = %w(touser msgtype content image voice video file music news articles template agentid).freeze
 
     def to_json
       json_hash = deep_recursive(message_hash) do |key, value|

data/lib/wechat/responder.rb

@@ -4,6 +4,7 @@ require 'wechat/signature'
 module Wechat
   module Responder
     extend ActiveSupport::Concern
+    include Wechat::ControllerApi
     include Cipher
 
     included do
@@ -26,25 +27,23 @@ module Wechat
     end
 
     module ClassMethods
-      attr_accessor :wechat, :token, :corpid, :agentid, :encrypt_mode, :timeout, :skip_verify_ssl, :encoding_aes_key, :trusted_domain_fullname
-
       def on(message_type, with: nil, respond: nil, &block)
-        fail 'Unknow message type' unless [:text, :image, :voice, :video, :shortvideo, :link, :event, :click, :view, :scan, :batch_job, :location, :fallback].include?(message_type)
+        raise 'Unknow message type' unless [:text, :image, :voice, :video, :shortvideo, :link, :event, :click, :view, :scan, :batch_job, :location, :fallback].include?(message_type)
         config = respond.nil? ? {} : { respond: respond }
-        config.merge!(proc: block) if block_given?
+        config[:proc] = block if block_given?
 
         if with.present?
-          fail 'Only text, event, click, view, scan and batch_job can having :with parameters' unless [:text, :event, :click, :view, :scan, :batch_job].include?(message_type)
-          config.merge!(with: with)
+          raise 'Only text, event, click, view, scan and batch_job can having :with parameters' unless [:text, :event, :click, :view, :scan, :batch_job].include?(message_type)
+          config[:with] = with
           if message_type == :scan
             if with.is_a?(String)
               self.known_scan_key_lists = with
             else
-              fail 'on :scan only support string in parameter with, detail see https://github.com/Eric-Guo/wechat/issues/84'
+              raise 'on :scan only support string in parameter with, detail see https://github.com/Eric-Guo/wechat/issues/84'
             end
           end
         else
-          fail 'Message type click, view, scan and batch_job must specify :with parameters' if [:click, :view, :scan, :batch_job].include?(message_type)
+          raise 'Message type click, view, scan and batch_job must specify :with parameters' if [:click, :view, :scan, :batch_job].include?(message_type)
         end
 
         case message_type
@@ -162,37 +161,6 @@ module Wechat
       end
     end
 
-    def wechat
-      self.class.wechat # Make sure user can continue access wechat at instance level similar to class level
-    end
-
-    def wechat_oauth2(scope = 'snsapi_base', page_url = nil)
-      appid = self.class.corpid || self.class.appid
-      page_url ||= if self.class.trusted_domain_fullname
-                     "#{self.class.trusted_domain_fullname}#{request.original_fullpath}"
-                   else
-                     request.original_url
-                   end
-      redirect_uri = CGI.escape(page_url)
-      oauth2_url = "https://open.weixin.qq.com/connect/oauth2/authorize?appid=#{appid}&redirect_uri=#{redirect_uri}&response_type=code&scope=#{scope}#wechat_redirect"
-
-      return oauth2_url unless block_given?
-      raise 'Currently wechat_oauth2 only support enterprise account.' unless self.class.corpid
-      if cookies.signed_or_encrypted[:we_deviceid].blank? && params[:code].blank?
-        redirect_to oauth2_url
-      elsif cookies.signed_or_encrypted[:we_deviceid].blank? && params[:code].present?
-        userinfo = Wechat.api.getuserinfo(params[:code])
-        cookies.signed_or_encrypted[:we_userid] = { value: userinfo['UserId'], expires: 1.hour.from_now }
-        cookies.signed_or_encrypted[:we_deviceid] = { value: userinfo['DeviceId'], expires: 1.hour.from_now }
-        cookies.signed_or_encrypted[:we_openid] = { value: userinfo['OpenId'], expires: 1.hour.from_now }
-        yield userinfo['UserId'], userinfo
-      else
-        yield cookies.signed_or_encrypted[:we_userid], { 'UserId' => cookies.signed_or_encrypted[:we_userid],
-                                                         'DeviceId' => cookies.signed_or_encrypted[:we_deviceid],
-                                                         'OpenId' => cookies.signed_or_encrypted[:we_openid] }
-      end
-    end
-
     def show
       if self.class.corpid.present?
         echostr, _corp_id = unpack(decrypt(Base64.decode64(params[:echostr]), self.class.encoding_aes_key))
@@ -242,9 +210,9 @@ module Wechat
       msg_encrypt = nil unless self.class.corpid.present?
 
       render plain: 'Forbidden', status: 403 if signature != Signature.hexdigest(self.class.token,
-                                                                                params[:timestamp],
-                                                                                params[:nonce],
-                                                                                msg_encrypt)
+                                                                                 params[:timestamp],
+                                                                                 params[:nonce],
+                                                                                 msg_encrypt)
     end
 
     def post_xml
@@ -285,11 +253,7 @@ module Wechat
     end
 
     def process_response(response)
-      if response[:MsgType] == 'success'
-        msg = 'success'
-      else
-        msg = response.to_xml
-      end
+      msg = response[:MsgType] == 'success' ? 'success' : response.to_xml
 
       if self.class.encrypt_mode
         encrypt = Base64.strict_encode64(encrypt(pack(msg, @app_id), self.class.encoding_aes_key))

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.7.7
+  version: 0.7.8
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-18 00:00:00.000000000 Z
+date: 2016-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -153,6 +153,7 @@ files:
 - lib/wechat/api_loader.rb
 - lib/wechat/cipher.rb
 - lib/wechat/client.rb
+- lib/wechat/controller_api.rb
 - lib/wechat/corp_api.rb
 - lib/wechat/helpers.rb
 - lib/wechat/message.rb