wechat 0.8.7 → 0.8.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d7ee715ed77e318662731915d4b04d1a3ddf57fd
-  data.tar.gz: 5fba117fd1a11174d5453b16e7bfb800d6ce1fad
+  metadata.gz: 58507c5f6484c8cc80d7f7acc44e5ddd5029832d
+  data.tar.gz: 1fa69b7599611a9a993a619fd5b4366463cec05d
 SHA512:
-  metadata.gz: 465dcca90573b199673602e8797ab078d27ff285b6639db1a923b377fafca9d98cf8244b78b33f07c07699d821c45639869fe97956943de38096779b8c215701
-  data.tar.gz: 5efd883e21fc35ed05a225b30a08f83af1927f3989c302fce72432ec4e8a4a93a09c64a703171c26885cc6dd74dd318f4824a6e2531fbe7b372f0adf02d6d68a
+  metadata.gz: 94d9d5c231c5807793a471603eb62f70901d210b5a5c68a8481b5a63a8c02493addb07c647e407f85b3a2b3f1276ef2a80c0367f5e5935af54295f63f2a5f55b
+  data.tar.gz: 1890b6e8396a777b4802a1d7677bddae375c0e2bebd8d01b661363e6ac02954b7ccf95ebba71d24fd992058e40c315e697badd53ba04729e10c77f8cbe24c212

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.8.8 (released at 5/18/2017)
+
+* Better support multiple account. by @xiewenwei #187
+* Allow load figaro via RAILS_ENV. by @goofansu #186
+
 ## v0.8.7 (released at 4/23/2017)
 
 * Support new wxa_get_wxacode API for miniapp.

data/lib/action_controller/wechat_responder.rb

@@ -2,46 +2,56 @@ module ActionController
   module WechatResponder
     def wechat_api(opts = {})
       include Wechat::ControllerApi
-      self.wechat_cfg_account = opts[:account].present? ? opts[:account].to_sym : :default
+      account = opts.delete(:account)
+      self.wechat_cfg_account = account ? account.to_sym : :default
       self.wechat_api_client = load_controller_wechat(wechat_cfg_account, opts)
     end
 
     def wechat_responder(opts = {})
       include Wechat::Responder
-      self.wechat_cfg_account = opts[:account].present? ? opts[:account].to_sym : :default
+      account = opts.delete(:account)
+      self.wechat_cfg_account = account ? account.to_sym : :default
       self.wechat_api_client = load_controller_wechat(wechat_cfg_account, opts)
     end
 
-    def wechat
-      self.wechat_api_client ||= load_controller_wechat(wechat_cfg_account)
+    def wechat(account = nil)
+      if account && account != wechat_cfg_account
+        Wechat.api(account)
+      else
+        self.wechat_api_client ||= load_controller_wechat(wechat_cfg_account)
+      end
     end
 
     private
 
     def load_controller_wechat(account, opts = {})
-      self.token = opts[:token] || Wechat.config(account).token
-      self.appid = opts[:appid] || Wechat.config(account).appid
-      self.corpid = opts[:corpid] || Wechat.config(account).corpid
-      self.agentid = opts[:agentid] || Wechat.config(account).agentid
-      self.encrypt_mode = opts[:encrypt_mode] || Wechat.config(account).encrypt_mode || corpid.present?
-      self.timeout = opts[:timeout] || 20
-      self.skip_verify_ssl = opts[:skip_verify_ssl]
-      self.encoding_aes_key = opts[:encoding_aes_key] || Wechat.config(account).encoding_aes_key
-      self.trusted_domain_fullname = opts[:trusted_domain_fullname] || Wechat.config(account).trusted_domain_fullname
-      Wechat.config(account).oauth2_cookie_duration ||= 1.hour
-      self.oauth2_cookie_duration = opts[:oauth2_cookie_duration] || Wechat.config(account).oauth2_cookie_duration.to_i.seconds
-
-      access_token = opts[:access_token] || Wechat.config(account).access_token
-      jsapi_ticket = opts[:jsapi_ticket] || Wechat.config(account).jsapi_ticket
-
-      return self.wechat_api_client = Wechat.api if account == :default && opts.empty?
+      cfg = Wechat.config(account)
+      self.token = opts[:token] || cfg.token
+      self.appid = opts[:appid] || cfg.appid
+      self.corpid = opts[:corpid] || cfg.corpid
+      self.agentid = opts[:agentid] || cfg.agentid
+      self.encrypt_mode = opts[:encrypt_mode] || cfg.encrypt_mode || corpid.present?
+      self.encoding_aes_key = opts[:encoding_aes_key] || cfg.encoding_aes_key
+      self.trusted_domain_fullname = opts[:trusted_domain_fullname] || cfg.trusted_domain_fullname
+      self.oauth2_cookie_duration = opts[:oauth2_cookie_duration] || cfg.oauth2_cookie_duration.to_i.seconds
+      self.timeout = opts[:timeout] || cfg.timeout
+      if opts.key?(:skip_verify_ssl)
+        self.skip_verify_ssl = opts[:skip_verify_ssl]
+      else
+        self.skip_verify_ssl = cfg.skip_verify_ssl
+      end
+
+      return Wechat.api if account == :default && opts.empty?
+
+      access_token = opts[:access_token] || cfg.access_token
+      jsapi_ticket = opts[:jsapi_ticket] || cfg.jsapi_ticket
 
       if corpid.present?
-        corpsecret = opts[:corpsecret] || Wechat.config(account).corpsecret
+        corpsecret = opts[:corpsecret] || cfg.corpsecret
         Wechat::CorpApi.new(corpid, corpsecret, access_token, \
                             agentid, timeout, skip_verify_ssl, jsapi_ticket)
       else
-        secret = opts[:secret] || Wechat.config(account).secret
+        secret = opts[:secret] || cfg.secret
         Wechat::Api.new(appid, secret, access_token, \
                         timeout, skip_verify_ssl, jsapi_ticket)
       end

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

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

data/lib/wechat/api_loader.rb

@@ -4,19 +4,15 @@ module Wechat
       account = options[:account] || :default
       c = ApiLoader.config(account)
 
-      token_file = options[:token_file] || c.access_token || '/var/tmp/wechat_access_token'
-      js_token_file = options[:js_token_file] || c.jsapi_ticket || '/var/tmp/wechat_jsapi_ticket'
+      token_file = options[:token_file] || c.access_token.presence || '/var/tmp/wechat_access_token'
+      js_token_file = options[:js_token_file] || c.jsapi_ticket.presence || '/var/tmp/wechat_jsapi_ticket'
 
       if c.appid && c.secret && token_file.present?
         Wechat::Api.new(c.appid, c.secret, token_file, c.timeout, c.skip_verify_ssl, js_token_file)
       elsif c.corpid && c.corpsecret && token_file.present?
         Wechat::CorpApi.new(c.corpid, c.corpsecret, token_file, c.agentid, c.timeout, c.skip_verify_ssl, js_token_file)
       else
-        puts <<-HELP
-Need create ~/.wechat.yml with wechat appid and secret
-or running at rails root folder so wechat can read config/wechat.yml
-HELP
-        exit 1
+        raise "Need create ~/.wechat.yml with wechat appid and secret or running at rails root folder so wechat can read config/wechat.yml"
       end
     end
 
@@ -50,6 +46,7 @@ HELP
       configs.each do |_, cfg|
         cfg[:timeout] ||= 20
         cfg[:have_session_class] = class_exists?('WechatSession')
+        cfg[:oauth2_cookie_duration] ||= 1.hour
       end
 
       # create config object using raw config data
@@ -69,11 +66,11 @@ HELP
         application_config_file = File.join(Dir.getwd, 'config/application.yml')
         home_config_file = File.join(Dir.home, '.wechat.yml')
         if File.exist?(rails_config_file)
+          rails_env = ENV['RAILS_ENV'] || 'development'
           if File.exist?(application_config_file) && !defined?(::Figaro)
             require 'figaro'
-            Figaro::Application.new(path: application_config_file).load
+            Figaro::Application.new(path: application_config_file, environment: rails_env).load
           end
-          rails_env = ENV['RAILS_ENV'] || 'development'
           config = resovle_config_file(rails_config_file, rails_env)
           if config.present? && (default = config[:default])  && (default['appid'] || default['corpid'])
             puts "Using rails project #{ENV['WECHAT_CONF_FILE'] || "config/wechat.yml"} #{rails_env} setting..."

data/lib/wechat/controller_api.rb

@@ -7,40 +7,50 @@ module Wechat
                     :skip_verify_ssl, :encoding_aes_key, :trusted_domain_fullname, :oauth2_cookie_duration
     end
 
-    def wechat
-      self.class.wechat # Make sure user can continue access wechat at instance level similar to class level
+    def wechat(account = nil)
+      # Make sure user can continue access wechat at instance level similar to class level
+      self.class.wechat(account)
     end
 
-    def wechat_oauth2(scope = 'snsapi_base', page_url = nil, &block)
-      appid = self.class.corpid || self.class.appid || lambda do
-        self.class.wechat # to initialize wechat_api_client at first time call wechat_oauth2
-        self.class.corpid || self.class.appid
-      end.call
+    def wechat_oauth2(scope = 'snsapi_base', page_url = nil, account = nil, &block)
+      # ensure wechat initialization
+      self.class.corpid || self.class.appid || self.class.wechat
+
+      api = wechat(account)
+      if account
+        config = Wechat.config(account)
+        appid = config.corpid || config.appid
+        is_crop_account = !!config.corpid
+      else
+        appid = self.class.corpid || self.class.appid
+        is_crop_account = !!self.class.corpid
+      end
+
       raise 'Can not get corpid or appid, so please configure it first to using wechat_oauth2' if appid.blank?
 
-      wechat.jsapi_ticket.ticket if wechat.jsapi_ticket.oauth2_state.nil?
+      api.jsapi_ticket.ticket if api.jsapi_ticket.oauth2_state.nil?
       oauth2_params = {
         appid: appid,
-        redirect_uri: page_url,
+        redirect_uri: page_url || generate_redirect_uri(account),
         scope: scope,
         response_type: 'code',
-        state: wechat.jsapi_ticket.oauth2_state
+        state: api.jsapi_ticket.oauth2_state
       }
 
       return generate_oauth2_url(oauth2_params) unless block_given?
-      self.class.corpid ? wechat_corp_oauth2(oauth2_params, &block) : wechat_public_oauth2(oauth2_params, &block)
+      is_crop_account ? wechat_corp_oauth2(oauth2_params, account, &block) : wechat_public_oauth2(oauth2_params, account, &block)
     end
 
     private
 
-    def wechat_public_oauth2(oauth2_params)
+    def wechat_public_oauth2(oauth2_params, account = nil)
       openid  = cookies.signed_or_encrypted[:we_openid]
       unionid = cookies.signed_or_encrypted[:we_unionid]
       we_token = cookies.signed_or_encrypted[:we_access_token]
       if openid.present?
         yield openid, { 'openid' => openid, 'unionid' => unionid, 'access_token' => we_token}
       elsif params[:code].present? && params[:state] == oauth2_params[:state]
-        access_info = wechat.web_access_token(params[:code])
+        access_info = wechat(account).web_access_token(params[:code])
         cookies.signed_or_encrypted[:we_openid] = { value: access_info['openid'], expires: self.class.oauth2_cookie_duration.from_now }
         cookies.signed_or_encrypted[:we_unionid] = { value: access_info['unionid'], expires: self.class.oauth2_cookie_duration.from_now }
         cookies.signed_or_encrypted[:we_access_token] = { value: access_info['access_token'], expires: self.class.oauth2_cookie_duration.from_now }
@@ -50,13 +60,13 @@ module Wechat
       end
     end
 
-    def wechat_corp_oauth2(oauth2_params)
+    def wechat_corp_oauth2(oauth2_params, account = nil)
       userid   = cookies.signed_or_encrypted[:we_userid]
       deviceid = cookies.signed_or_encrypted[:we_deviceid]
       if userid.present? && deviceid.present?
         yield userid, { 'UserId' => userid, 'DeviceId' => deviceid }
       elsif params[:code].present? && params[:state] == oauth2_params[:state]
-        userinfo = wechat.getuserinfo(params[:code])
+        userinfo = wechat(account).getuserinfo(params[:code])
         cookies.signed_or_encrypted[:we_userid] = { value: userinfo['UserId'], expires: self.class.oauth2_cookie_duration.from_now }
         cookies.signed_or_encrypted[:we_deviceid] = { value: userinfo['DeviceId'], expires: self.class.oauth2_cookie_duration.from_now }
         yield userinfo['UserId'], userinfo
@@ -65,13 +75,18 @@ module Wechat
       end
     end
 
-    def generate_oauth2_url(oauth2_params)
-      if oauth2_params[:redirect_uri].blank?
-        page_url = (td = self.class.trusted_domain_fullname) ? "#{td}#{request.original_fullpath}" : request.original_url
-        safe_query = request.query_parameters.reject { |k, _| %w(code state access_token).include? k }.to_query
-        oauth2_params[:redirect_uri] = page_url.sub(request.query_string, safe_query)
+    def generate_redirect_uri(account = nil)
+      domain_name = if account
+        Wechat.config(account).trusted_domain_fullname
+      else
+        self.class.trusted_domain_fullname
       end
+      page_url = domain_name ? "#{domain_name}#{request.original_fullpath}" : request.original_url
+      safe_query = request.query_parameters.reject { |k, _| %w(code state access_token).include? k }.to_query
+      page_url.sub(request.query_string, safe_query)
+    end
 
+    def generate_oauth2_url(oauth2_params)
       if oauth2_params[:scope] == 'snsapi_login'
         "https://open.weixin.qq.com/connect/qrconnect?#{oauth2_params.to_query}#wechat_redirect"
       else

data/lib/wechat/helpers.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 0.8.8
 platform: ruby
 authors:
 - Skinnyworm
@@ -31,7 +31,7 @@ cert_chain:
   R5k6Ma92sW8jupX4cqbSu9rntdVQkNRpoHIrfU0MZT0cKsg/D1zMteylxrO3KMsz
   SPQRv+nrI1J0zevFqb8010heoR8SDyUA0Mm3+Q==
   -----END CERTIFICATE-----
-date: 2017-04-23 00:00:00.000000000 Z
+date: 2017-05-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,28 +107,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '5'
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -206,7 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: DSL for wechat message handling and API