wechat 0.7.6 → 0.7.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bfc807dea051fded9c082a6bdbf4778433b2bbce
-  data.tar.gz: 55e132829fc449ed8fd9ec591ee05710386037bb
+  metadata.gz: 1227afa2c59a9657b91eda79d71e05c582dfd13c
+  data.tar.gz: 1ed732c34360e25275a35fa5ddbc62f9fe945e4c
 SHA512:
-  metadata.gz: f4b26ce081c96d50de0e02340a6745f3cdff6334dfbdc7a521f74ee06136521ccbd42e7cf0ae2e52ba71e9dc73384e287de0c76486a95a8f0c12c4cbc3d98437
-  data.tar.gz: 2d6867ec622f4ae9748072eeeac18a19536579d8b74a1c56d3e59ebdf886b85a0de5dd694376fd2a0db7ca2b16542109f9eee5a6ad41d978e5dab3b903e3737a
+  metadata.gz: 358ebfbe074a0a0f631c2966b4cb8f0d3357d37fa8c6a0e67c87863d1b98030bcd625de8cdbbd36cac923e1378ed395599e8199659c8ccf41065085e7d05e57d
+  data.tar.gz: 95d512581d896582438b0a3c30d9994defaa485118ecf7c5fe90a0ad473ff4508f070aea1153abbabc2ce36bf3c8ad3a521319b9cf92b4cb98c2ed48999f9bc4

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## v0.7.7 (released at 3/18/2016)
+
+* New wechat_oauth2, only support enterprise account still.
+* fix 'skip_before_action :verify_authenticity_token' bug for v5.0.0.beta3 by @vkill #97
+* Support Rails 3.2 again after support Rails 5.0, by @guange2015 #96
+
 ## v0.7.6 (released at 3/05/2016)
 
 * Support wechat public account conditional menu. #95

data/README-CN.md

@@ -13,7 +13,7 @@ WeChat gem 可以帮助开发者方便地在Rails环境中集成微信[公众平
 
 命令行工具`wechat`可以调用各种无需web环境的API。同时也提供了Rails Controller的responder DSL, 可以帮助开发者方便地在Rails应用中集成微信的消息处理，包括主动推送的和被动响应的消息。
 
-如果您的App还需要集成微信OAuth2.0, 您可以考虑[omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2), 以便和devise集成，提供完整的用户认证。
+如果您的App还需要集成微信OAuth2.0, 除了简便的`wechat_oauth2`指令，也可以考虑[omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2), 以便和devise集成，提供完整的用户认证。
 
 如果您对如何制作微信网页UI没有灵感，可以参考官方的[weui](https://github.com/weui/weui)，针对Rails的Gem是[weui-rails](https://github.com/Eric-Guo/weui-rails)。
 
@@ -192,6 +192,26 @@ end
 
 在开发模式下，由于程序往往通过微信调试工具的服务器端调试工具反向代理被访问，此时需要配置`trusted_domain_fullname`以便wechat gem可以使用正确的域名做JS-SDK的权限签名。
 
+#### OAuth2.0验证接口支持
+
+目前企业号可以使用如下代码直接取得用户企业号userid：
+
+```ruby
+class WechatsController < ActionController::Base
+  layout 'wechat'
+  wechat_responder
+  def apply_new
+    wechat_oauth2 do |userid|
+      @current_user = User.find_by(wechat_userid: userid)
+      @apply = Apply.new
+      @apply.user_id = @current_user.id
+    end
+  end
+end
+```
+
+`wechat_oauth2`封装了OAuth2.0验证接口和cookie处理逻辑，用户仅需提供业务代码块即可，userid就是微信成员UserID。
+
 ## 关于接口权限
 
 wechat gems 内部不会检查权限。但因公众号类型不同，和微信服务器端通讯时，可能会被拒绝，详细权限控制可参考[官方文档](http://mp.weixin.qq.com/wiki/7/2d301d4b757dedc333b9a9854b457b47.html)。
@@ -230,7 +250,6 @@ Wechat commands:
   wechat menu_delconditional [MENU_ID]                     # 删除个性化菜单  
   wechat menu_delete                                       # 删除菜单
   wechat menu_trymatch [USER_ID]                           # 测试个性化菜单匹配结果  
-  wechat oauth2_url [REDIRECT_URI]                         # 生成OAuth2.0验证URL
   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下载二维码
@@ -277,7 +296,6 @@ Wechat commands:
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
   wechat menu_delete                                       # 删除菜单
   wechat message_send [OPENID, TEXT_MESSAGE]               # 发送文字消息
-  wechat oauth2_url [REDIRECT_URI]                         # 生成OAuth2.0验证URL
   wechat qrcode_download [TICKET, QR_CODE_PIC_PATH]        # 通过ticket下载二维码
   wechat tag [TAG_ID]                                      # 获取标签成员
   wechat tag_add_department [TAG_ID, PARTY_IDS]            # 增加标签部门

data/README.md

@@ -20,7 +20,7 @@ WeChat gem trying to helping Rails developer to integrated [enterprise account](
 
 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
+Wechat provide OAuth2.0 authentication method `wechat_oauth2`, possible the easiest way, for the user perfer using devise style authorization gems, [omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2) can be a good option.
 
 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.
 
@@ -205,6 +205,27 @@ JS-SDK enable you control Wechat App behavior in html, by inject a config signat
 
 Configure the `trusted_domain_fullname` if you are in development mode and app running behind a reverse proxy server, otherwise wechat gem can not get the correct url to be signature later.
 
+#### OAuth2.0 authentication
+
+For enterprise account, user can using userid directly by provide a block in wechat_oauth2:
+
+```ruby
+class WechatsController < ActionController::Base
+  layout 'wechat'
+  wechat_responder
+  def apply_new
+    wechat_oauth2 do |userid|
+      @current_user = User.find_by(wechat_userid: userid)
+      @apply = Apply.new
+      @apply.user_id = @current_user.id
+    end
+  end
+end
+```
+
+`wechat_oauth2` already implement the necessory OAuth2.0 and cookie logic, userid available as a member UserID for the whole block.
+
+
 ## The API privilege
 
 wechat gems won't handle any privilege exception. (except token time out, but it's not important to you as it's auto retry/recovery in gems internally), but Tencent will control a lot of privilege based on your public account type and certification, more info, please reference [official document](http://mp.weixin.qq.com/wiki/7/2d301d4b757dedc333b9a9854b457b47.html).
@@ -245,7 +266,6 @@ Wechat commands:
   wechat menu_delconditional [MENU_ID]                     # 删除个性化菜单  
   wechat menu_delete                                       # 删除菜单
   wechat menu_trymatch [USER_ID]                           # 测试个性化菜单匹配结果  
-  wechat oauth2_url [REDIRECT_URI]                         # 生成OAuth2.0验证URL
   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下载二维码
@@ -292,7 +312,6 @@ Wechat commands:
   wechat menu_create [MENU_YAML_PATH]                      # 创建菜单
   wechat menu_delete                                       # 删除菜单
   wechat message_send [OPENID, TEXT_MESSAGE]               # 发送文字消息
-  wechat oauth2_url [REDIRECT_URI]                         # 生成OAuth2.0验证URL
   wechat qrcode_download [TICKET, QR_CODE_PIC_PATH]        # 通过ticket下载二维码
   wechat tag [TAG_ID]                                      # 获取标签成员
   wechat tag_add_department [TAG_ID, PARTY_IDS]            # 增加标签部门

data/bin/wechat

@@ -293,12 +293,6 @@ class App < Thor
     puts wechat_api.user(open_id)
   end
 
-  desc 'oauth2_url [REDIRECT_URI]', '生成OAuth2.0验证URL'
-  def oauth2_url(redirect_uri)
-    appid = Wechat.config.corpid || Wechat.config.appid
-    puts wechat_api.oauth2_url(redirect_uri, appid)
-  end
-
   desc 'user_update_remark [OPEN_ID, REMARK]', '设置备注名'
   def user_update_remark(openid, remark)
     puts wechat_api.user_update_remark(openid, remark)

data/lib/wechat/corp_api.rb

@@ -34,6 +34,8 @@ module Wechat
     end
 
     def oauth2_url(redirect_uri, appid)
+      ActiveSupport::Deprecation.warn('oauth2_url is deprecated. use wechat_oauth2 instead.')
+
       redirect_uri = CGI.escape(redirect_uri)
       "https://open.weixin.qq.com/connect/oauth2/authorize?appid=#{appid}&redirect_uri=#{redirect_uri}&response_type=code&scope=snsapi_base#wechat_redirect"
     end

data/lib/wechat/responder.rb

@@ -9,8 +9,15 @@ module Wechat
     included do
       # Rails 5 remove before_filter and skip_before_filter
       if respond_to?(:skip_before_action)
-        # Rails 5 API mode won't define verify_authenticity_token
-        skip_before_action :verify_authenticity_token if respond_to?(:verify_authenticity_token)
+        if respond_to?(:verify_authenticity_token)
+          skip_before_action :verify_authenticity_token
+        else
+          # Rails 5 API mode won't define verify_authenticity_token
+          # https://github.com/rails/rails/blob/v5.0.0.beta3/actionpack/lib/abstract_controller/callbacks.rb#L66
+          # https://github.com/rails/rails/blob/v5.0.0.beta3/activesupport/lib/active_support/callbacks.rb#L640
+          skip_before_action :verify_authenticity_token, raise: false
+        end
+
         before_action :verify_signature, only: [:show, :create]
       else
         skip_before_filter :verify_authenticity_token
@@ -159,12 +166,47 @@ module 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))
-        render plain: echostr
+        if Rails::VERSION::MAJOR >= 4
+          render plain: echostr
+        else
+          render text: echostr
+        end
       else
-        render plain: params[:echostr]
+        if Rails::VERSION::MAJOR >= 4
+          render plain: params[:echostr]
+        else
+          render text: params[:echostr]
+        end
       end
     end
 
@@ -173,7 +215,11 @@ module Wechat
       response_msg = run_responder(request_msg)
 
       if response_msg.respond_to? :to_xml
-        render plain: process_response(response_msg)
+        if Rails::VERSION::MAJOR >= 4
+          render plain: process_response(response_msg)
+        else
+          render text: process_response(response_msg)
+        end
       else
         render nothing: true, status: 200, content_type: 'text/html'
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.7.6
+  version: 0.7.7
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-03-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport