wechat 0.6.8 → 0.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: eda1d074591c670445ef8e73291eb2131e0a595c
-  data.tar.gz: 576db68d3550ab9ac86c392e2ca6757184e0b114
+  metadata.gz: 0dc6d264f5abaaa4f22369e54e341f95ee9d5f50
+  data.tar.gz: 52284eb6380ee4969955c512cf95a3fda69e4784
 SHA512:
-  metadata.gz: 70af013d27c8a9a144012c564da1d02927d865fcc64837d1bfb371f525503527d830ac80cb53a512927980e717780a8e88d31f15853a4210eb70780d5a7c716e
-  data.tar.gz: c38169bac4eca6015b9be377d95b3b4ae44511ed3df80ae379d76d3b23077e44867da3c98a15437fb447b6a99757479a4e501cc393e2e87bfda8b5279eb4e9e8
+  metadata.gz: 479c18b6cdc4d889a159a81fa9dc9256e83ae6c9543d8f8cc1e42c92cba3618639219287a0b372b3a7ddb56a0c0bae365dc8761a0f0a737839ed090ae0be6026
+  data.tar.gz: 64ad4d1f5204fae608786226f07c00761645f4c381d2359235b480bd8cbf6190f5475c2901527d03c9bbb8bece37e359fb4940d15f104fec26708e3d04c9c21c

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 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.
+
 ## v0.6.8 (released at 12/25/2015)
 
 * Support Rails 5.0.0.beta1.

data/lib/wechat/api.rb

@@ -1,7 +1,7 @@
 require 'wechat/api_base'
 require 'wechat/client'
-require 'wechat/access_token'
-require 'wechat/jsapi_ticket'
+require 'wechat/token/public_access_token'
+require 'wechat/ticket/public_jsapi_ticket'
 
 module Wechat
   class Api < ApiBase
@@ -10,8 +10,8 @@ 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 = AccessToken.new(@client, appid, secret, token_file)
-      @jsapi_ticket = JsapiTicket.new(@client, @access_token, jsapi_ticket_file)
+      @access_token = Token::PublicAccessToken.new(@client, appid, secret, token_file)
+      @jsapi_ticket = Ticket::PublicJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
     end
 
     def groups

data/lib/wechat/client.rb

@@ -22,7 +22,9 @@ module Wechat
       end
     end
 
-    def request(path, header = {}, &block)
+    private
+
+    def request(path, header = {}, &_block)
       url = "#{header.delete(:base) || base}#{path}"
       as = header.delete(:as)
       header.merge!(accept: :json)
@@ -35,8 +37,8 @@ module Wechat
         case data['errcode']
         when 0 # for request didn't expect results
           data
-        # 42001: access_token超时
-        # 40014: 不合法的access_token
+        # 42001: access_token timeout
+        # 40014: invalid access_token
         # 40001, invalid credential, access_token is invalid or not latest hint
         # 48001, api unauthorized hint, for qrcode creation # 71
         when 42001, 40014, 40001, 48001
@@ -47,8 +49,6 @@ module Wechat
       end
     end
 
-    private
-
     def parse_response(response, as)
       content_type = response.headers[:content_type]
       parse_as = {

data/lib/wechat/corp_api.rb

@@ -1,19 +1,10 @@
 require 'wechat/api_base'
 require 'wechat/client'
-require 'wechat/access_token'
-require 'wechat/corp_jsapi_ticket'
+require 'wechat/token/corp_access_token'
+require 'wechat/ticket/corp_jsapi_ticket'
 require 'cgi'
 
 module Wechat
-  class CorpAccessToken < AccessToken
-    def refresh
-      data = client.get('gettoken', params: { corpid: appid, corpsecret: secret })
-      data.merge!(created_at: Time.now.to_i)
-      File.write(token_file, data.to_json) if valid_token(data)
-      @token_data = data
-    end
-  end
-
   class CorpApi < ApiBase
     attr_reader :agentid
 
@@ -21,9 +12,9 @@ module Wechat
 
     def initialize(appid, secret, token_file, agentid, timeout, skip_verify_ssl, jsapi_ticket_file)
       @client = Client.new(API_BASE, timeout, skip_verify_ssl)
-      @access_token = CorpAccessToken.new(@client, appid, secret, token_file)
+      @access_token = Token::CorpAccessToken.new(@client, appid, secret, token_file)
       @agentid = agentid
-      @jsapi_ticket = CorpJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
+      @jsapi_ticket = Ticket::CorpJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
     end
 
     def agent_list
@@ -99,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)

data/lib/wechat/ticket/corp_jsapi_ticket.rb

@@ -0,0 +1,13 @@
+require 'wechat/ticket/jsapi_base'
+
+module Wechat
+  module Ticket
+    class CorpJsapiTicket < JsapiBase
+      def refresh
+        data = client.get('get_jsapi_ticket', params: { access_token: access_token.token })
+        write_ticket_to_file(data)
+        read_ticket_from_file
+      end
+    end
+  end
+end

data/lib/wechat/ticket/jsapi_base.rb

@@ -0,0 +1,65 @@
+require 'digest/sha1'
+
+module Wechat
+  module Ticket
+    class JsapiBase
+      attr_reader :client, :access_token, :jsapi_ticket_file, :access_ticket, :ticket_life_in_seconds, :got_ticket_at
+
+      def initialize(client, access_token, jsapi_ticket_file)
+        @client = client
+        @access_token = access_token
+        @jsapi_ticket_file = jsapi_ticket_file
+        @random_generator = Random.new
+      end
+
+      def ticket
+        # Possible two worker running, one worker refresh ticket, other unaware, so must read every time
+        read_ticket_from_file
+        refresh if remain_life_seconds < @random_generator.rand(30..3 * 60)
+        access_ticket
+      end
+
+      # Obtain the wechat jssdk config signature parameter and return below hash
+      #  params = {
+      #    noncestr: noncestr,
+      #    timestamp: timestamp,
+      #    jsapi_ticket: ticket,
+      #    url: url,
+      #    signature: signature
+      #  }
+      def signature(url)
+        params = {
+          noncestr: SecureRandom.base64(16),
+          timestamp: Time.now.to_i,
+          jsapi_ticket: ticket,
+          url: url
+        }
+        pairs = params.keys.sort.map do |key|
+          "#{key}=#{params[key]}"
+        end
+        result = Digest::SHA1.hexdigest pairs.join('&')
+        params.merge(signature: result)
+      end
+
+      protected
+
+      def read_ticket_from_file
+        td = JSON.parse(File.read(jsapi_ticket_file))
+        @got_ticket_at = td.fetch('got_ticket_at').to_i
+        @ticket_life_in_seconds = td.fetch('expires_in').to_i
+        @access_ticket = td.fetch('ticket')
+      rescue JSON::ParserError, Errno::ENOENT, KeyError
+        refresh
+      end
+
+      def write_ticket_to_file(ticket_hash)
+        ticket_hash.merge!('got_ticket_at'.freeze => Time.now.to_i)
+        File.write(jsapi_ticket_file, ticket_hash.to_json)
+      end
+
+      def remain_life_seconds
+        ticket_life_in_seconds - (Time.now.to_i - got_ticket_at)
+      end
+    end
+  end
+end

data/lib/wechat/ticket/public_jsapi_ticket.rb

@@ -0,0 +1,13 @@
+require 'wechat/ticket/jsapi_base'
+
+module Wechat
+  module Ticket
+    class PublicJsapiTicket < JsapiBase
+      def refresh
+        data = client.get('ticket/getticket', params: { access_token: access_token.token, type: 'jsapi' })
+        write_ticket_to_file(data)
+        read_ticket_from_file
+      end
+    end
+  end
+end

data/lib/wechat/token/access_token_base.rb

@@ -0,0 +1,42 @@
+module Wechat
+  module Token
+    class AccessTokenBase
+      attr_reader :client, :appid, :secret, :token_file, :access_token, :token_life_in_seconds, :got_token_at
+
+      def initialize(client, appid, secret, token_file)
+        @appid = appid
+        @secret = secret
+        @client = client
+        @token_file = token_file
+        @random_generator = Random.new
+      end
+
+      def token
+        # Possible two worker running, one worker refresh token, other unaware, so must read every time
+        read_token_from_file
+        refresh if remain_life_seconds < @random_generator.rand(30..3 * 60)
+        access_token
+      end
+
+      protected
+
+      def read_token_from_file
+        td = JSON.parse(File.read(token_file))
+        @got_token_at = td.fetch('got_token_at').to_i
+        @token_life_in_seconds = td.fetch('expires_in').to_i
+        @access_token = td.fetch('access_token')
+      rescue JSON::ParserError, Errno::ENOENT, KeyError
+        refresh
+      end
+
+      def write_token_to_file(token_hash)
+        token_hash.merge!('got_token_at'.freeze => Time.now.to_i)
+        File.write(token_file, token_hash.to_json)
+      end
+
+      def remain_life_seconds
+        token_life_in_seconds - (Time.now.to_i - got_token_at)
+      end
+    end
+  end
+end

data/lib/wechat/token/corp_access_token.rb

@@ -0,0 +1,13 @@
+require 'wechat/token/access_token_base'
+
+module Wechat
+  module Token
+    class CorpAccessToken < AccessTokenBase
+      def refresh
+        data = client.get('gettoken', params: { corpid: appid, corpsecret: secret })
+        write_token_to_file(data)
+        read_token_from_file
+      end
+    end
+  end
+end

data/lib/wechat/token/public_access_token.rb

@@ -0,0 +1,13 @@
+require 'wechat/token/access_token_base'
+
+module Wechat
+  module Token
+    class PublicAccessToken < AccessTokenBase
+      def refresh
+        data = client.get('token', params: { grant_type: 'client_credential', appid: appid, secret: secret })
+        write_token_to_file(data)
+        read_token_from_file
+      end
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.6.8
+  version: 0.6.9
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-25 00:00:00.000000000 Z
+date: 2016-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -119,19 +119,21 @@ files:
 - lib/generators/wechat/templates/app/controllers/wechats_controller.rb
 - lib/generators/wechat/templates/config/wechat.yml
 - lib/wechat.rb
-- lib/wechat/access_token.rb
 - lib/wechat/api.rb
 - lib/wechat/api_base.rb
 - lib/wechat/api_loader.rb
 - lib/wechat/cipher.rb
 - lib/wechat/client.rb
 - lib/wechat/corp_api.rb
-- lib/wechat/corp_jsapi_ticket.rb
-- lib/wechat/jsapi_base.rb
-- lib/wechat/jsapi_ticket.rb
 - lib/wechat/message.rb
 - lib/wechat/responder.rb
 - lib/wechat/signature.rb
+- lib/wechat/ticket/corp_jsapi_ticket.rb
+- lib/wechat/ticket/jsapi_base.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
 homepage: https://github.com/Eric-Guo/wechat
 licenses:
 - MIT

data/lib/wechat/access_token.rb

@@ -1,39 +0,0 @@
-module Wechat
-  class AccessToken
-    attr_reader :client, :appid, :secret, :token_file, :token_data
-
-    def initialize(client, appid, secret, token_file)
-      @appid = appid
-      @secret = secret
-      @client = client
-      @token_file = token_file
-    end
-
-    def token
-      begin
-        @token_data ||= JSON.parse(File.read(token_file))
-        created_at = token_data['created_at'].to_i
-        expires_in = token_data['expires_in'].to_i
-        fail 'token_data may be expired' if Time.now.to_i - created_at >= expires_in - 3 * 60
-      rescue
-        refresh
-      end
-      valid_token(@token_data)
-    end
-
-    def refresh
-      data = client.get('token', params: { grant_type: 'client_credential', appid: appid, secret: secret })
-      data.merge!('created_at'.freeze => Time.now.to_i)
-      File.write(token_file, data.to_json) if valid_token(data)
-      @token_data = data
-    end
-
-    private
-
-    def valid_token(token_data)
-      access_token = token_data['access_token']
-      fail "Response didn't have access_token" if access_token.blank?
-      access_token
-    end
-  end
-end

data/lib/wechat/corp_jsapi_ticket.rb

@@ -1,13 +0,0 @@
-require 'wechat/jsapi_base'
-
-module Wechat
-  class CorpJsapiTicket < JsapiBase
-    # refresh jsapi ticket
-    def refresh
-      data = client.get('get_jsapi_ticket', params: { access_token: access_token.token })
-      data.merge!('created_at'.freeze => Time.now.to_i)
-      File.open(jsapi_ticket_file, 'w') { |f| f.write(data.to_json) } if valid_ticket(data)
-      @jsapi_ticket_data = data
-    end
-  end
-end

data/lib/wechat/jsapi_base.rb

@@ -1,67 +0,0 @@
-# coding: utf-8
-require 'digest/sha1'
-
-module Wechat
-  class JsapiBase
-    attr_reader :client, :access_token, :jsapi_ticket_file, :jsapi_ticket_data
-
-    def initialize(client, access_token, jsapi_ticket_file)
-      @client = client
-      @access_token = access_token
-      @jsapi_ticket_file = jsapi_ticket_file
-    end
-
-    #  获取微信 jssdk 签名所需的 jsapi_ticket, 返回具有如下结构的 hash:
-    #  {
-    #    "errcode":0,
-    #    "errmsg":"ok",
-    #    "ticket":"bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA",
-    #    "expires_in":7200
-    #  }
-    def ticket
-      begin
-        @jsapi_ticket_data ||= JSON.parse(File.read(jsapi_ticket_file))
-        created_at = jsapi_ticket_data['created_at'].to_i
-        expires_in = jsapi_ticket_data['expires_in'].to_i
-        if Time.now.to_i - created_at >= expires_in - 3 * 60
-          fail 'jsapi_ticket may be expired'
-        end
-      rescue
-        refresh
-      end
-      valid_ticket(@jsapi_ticket_data)
-    end
-
-    # 获取 jssdk 签名及注册所需其他参数, 返回具有如下结构的 hash:
-    #  params = {
-    #    noncestr: noncestr,
-    #    timestamp: timestamp,
-    #    jsapi_ticket: ticket,
-    #    url: url,
-    #    signature: signature
-    #  }
-    def signature(url)
-      timestamp = Time.now.to_i
-      noncestr = SecureRandom.base64(16)
-      params = {
-        noncestr: noncestr,
-        timestamp: timestamp,
-        jsapi_ticket: ticket,
-        url: url
-      }
-      pairs = params.keys.sort.map do |key|
-        "#{key}=#{params[key]}"
-      end
-      result = Digest::SHA1.hexdigest pairs.join('&')
-      params.merge(signature: result)
-    end
-
-    protected
-
-    def valid_ticket(jsapi_ticket_data)
-      ticket = jsapi_ticket_data['ticket'] || jsapi_ticket_data[:ticket]
-      fail "Response didn't have ticket" if ticket.blank?
-      ticket
-    end
-  end
-end

data/lib/wechat/jsapi_ticket.rb

@@ -1,13 +0,0 @@
-require 'wechat/jsapi_base'
-
-module Wechat
-  class JsapiTicket < JsapiBase
-    # refresh jsapi ticket
-    def refresh
-      data = client.get('ticket/getticket', params: { access_token: access_token.token, type: 'jsapi' })
-      data.merge!('created_at'.freeze => Time.now.to_i)
-      File.open(jsapi_ticket_file, 'w') { |f| f.write(data.to_json) } if valid_ticket(data)
-      @jsapi_ticket_data = data
-    end
-  end
-end