wechat 0.7.3 → 0.7.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f60b7afc101f3badd6661236b6df3747d24995ce
-  data.tar.gz: b1c7ef968ef8db8c843a4edf35a48a169b647bd7
+  metadata.gz: 6fb8761bd99cd1efecca27649bf0b95a0bb24bc1
+  data.tar.gz: 036cf5d32c2a355dbf81f0eb505b646e3397ec51
 SHA512:
-  metadata.gz: 3324275a6604f4cac101bd11ade6d4c405380432169febf634fb13b4d4fbbe5c548ce48d9f2faad1840e11272fda3699376cb3e944b4937750b057ed0b0df2ac
-  data.tar.gz: 14606aa8ff517eb6f1249e35cf7abb64862613cdb4ab748ae9f5baee805a3bb07e53c0bc55cd02c721c54ccbb3d7456223284dbcd261814b0533079704d6a677
+  metadata.gz: bf28762a242a5c33f8fcabe556464a6d50cd567d3a90fc5ff9475fac7d91e957226f93c9b759a088b20e862cd03854648f617d430df07a5b49626b6eec3f0967
+  data.tar.gz: 526982f68c795107123939e94dfb05201274666ddf5e2b574161b9e5034155c84eaaa0fad85df0013f8fbd12998fdde9c760f099cfe432cea08e660a137d4da4

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## v0.7.4 (released at 1/23/2016)
+
+* Add Redis store token/ticket support, close #76, #60
+* Rails 5 support without deprecate warning or other not necessory call. #82
+
 ## v0.7.3 (released at 1/19/2016)
 
 * Allow transfer_customer_service to specific account.

data/README-CN.md

@@ -55,6 +55,13 @@ rake db:migrate
 
 运行后会自动启用回调消息会话(session)记录，wechat gem会在Rails项目中生成两个文件，用户可以在*wechat_session*表中添加更多字段或者声明一些关联关系。使用已有的**hash_store**直接保存也是可以的，但对于PostgreSQL用户，使用[hstore](http://guides.rubyonrails.org/active_record_postgresql.html#hstore)或者json格式可能更佳，当然，最佳方案仍然是添加新字段记录数据。
 
+启用Redis存贮token和ticket:
+
+```console
+rails g wechat:redis_store
+```
+
+Redis存贮相比默认的文件存贮，可以允许Rails应用运行在多台服务器中，如果只有一台服务器，仍然推荐使用默认的文件存贮，另外命令行不会读取Redis存贮的Token或者Ticket。
 
 ## 配置
 

data/README.md

@@ -61,6 +61,14 @@ rake db:migrate
 
 Enable session record will generate two files in Rails folder,  User can add more column fields in *wechat_session* table and add declare to link to users table, it's also possible to store data directly in **hash_store**. if you are using PostgreSQL, using [hstore](http://guides.rubyonrails.org/active_record_postgresql.html#hstore)/json maybe better, but the best way is still add dedicate column to record the data, the Rails way.
 
+Using Redis to store wechat token and ticket:
+
+```console
+rails g wechat:redis_store
+```
+
+Redis store support Rails application running in multi-server, no need to enable it if your Rails application running in one server only, the wechat command won't read the token/ticket store in Redis.
+
 ## Configuration
 
 #### Configure for command line

data/lib/generators/wechat/redis_store_generator.rb

@@ -0,0 +1,16 @@
+module Wechat
+  module Generators
+    class RedisStoreGenerator < Rails::Generators::Base
+      desc 'Using redis as token/ticket store'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_wechat_redis_initializer
+        template 'config/initializers/wechat_redis_store.rb'
+      end
+
+      def add_redis_gem
+        gem 'redis'
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+module Wechat
+  def self.redis
+    # You can reuse existing redis connection and remove this method if require
+    @redis ||= Redis.new # more options see https://github.com/redis/redis-rb#getting-started
+  end
+
+  module Token
+    class AccessTokenBase
+      def read_token
+        JSON.parse(Wechat.redis.get('my_app_wechat_token'))
+      end
+
+      def write_token(token_hash)
+        Wechat.redis.set 'my_app_wechat_token', token_hash.to_json
+      end
+    end
+  end
+
+  module Ticket
+    class JsapiBase
+      def read_ticket
+        JSON.parse(Wechat.redis.get('my_app_wechat_ticket'))
+      end
+
+      def write_ticket(ticket_hash)
+        Wechat.redis.set 'my_app_wechat_ticket', ticket_hash.to_json
+      end
+    end
+  end
+end

data/lib/wechat/responder.rb

@@ -10,7 +10,7 @@ module Wechat
       # 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 unless defined?(:verify_authenticity_token)
+        skip_before_action :verify_authenticity_token if respond_to?(:verify_authenticity_token)
         before_action :verify_signature, only: [:show, :create]
       else
         skip_before_filter :verify_authenticity_token
@@ -209,8 +209,14 @@ module Wechat
         data = Hash.from_xml(content)
       end
 
-      HashWithIndifferentAccess.new_from_hash_copying_default(data.fetch('xml', {})).tap do |msg|
-        msg[:Event].downcase! if msg[:Event]
+      if Rails::VERSION::MAJOR >= 5
+        HashWithIndifferentAccess.new(data.fetch('xml', {})).tap do |msg|
+          msg[:Event].downcase! if msg[:Event]
+        end
+      else
+        HashWithIndifferentAccess.new_from_hash_copying_default(data.fetch('xml', {})).tap do |msg|
+          msg[:Event].downcase! if msg[:Event]
+        end
       end
     end
 

data/lib/wechat/ticket/corp_jsapi_ticket.rb

@@ -5,8 +5,8 @@ module Wechat
     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
+        write_ticket_to_store(data)
+        read_ticket_from_store
       end
     end
   end

data/lib/wechat/ticket/jsapi_base.rb

@@ -14,7 +14,7 @@ module Wechat
 
       def ticket
         # Possible two worker running, one worker refresh ticket, other unaware, so must read every time
-        read_ticket_from_file
+        read_ticket_from_store
         refresh if remain_life_seconds < @random_generator.rand(30..3 * 60)
         access_ticket
       end
@@ -43,17 +43,26 @@ module Wechat
 
       protected
 
-      def read_ticket_from_file
-        td = JSON.parse(File.read(jsapi_ticket_file))
+      def read_ticket_from_store
+        td = read_ticket
+        @ticket_life_in_seconds = td.fetch('ticket_expires_in').to_i
         @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
+        @access_ticket = td.fetch('ticket') # return access_ticket same time
+      rescue JSON::ParserError, Errno::ENOENT, KeyError, TypeError
         refresh
       end
 
-      def write_ticket_to_file(ticket_hash)
-        ticket_hash.merge!('got_ticket_at'.freeze => Time.now.to_i)
+      def write_ticket_to_store(ticket_hash)
+        ticket_hash['got_ticket_at'.freeze] = Time.now.to_i
+        ticket_hash['ticket_expires_in'.freeze] = ticket_hash.delete('expires_in')
+        write_ticket(ticket_hash)
+      end
+
+      def read_ticket
+        JSON.parse(File.read(jsapi_ticket_file))
+      end
+
+      def write_ticket(ticket_hash)
         File.write(jsapi_ticket_file, ticket_hash.to_json)
       end
 

data/lib/wechat/ticket/public_jsapi_ticket.rb

@@ -5,8 +5,8 @@ module Wechat
     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
+        write_ticket_to_store(data)
+        read_ticket_from_store
       end
     end
   end

data/lib/wechat/token/access_token_base.rb

@@ -13,24 +13,33 @@ module Wechat
 
       def token
         # Possible two worker running, one worker refresh token, other unaware, so must read every time
-        read_token_from_file
+        read_token_from_store
         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))
+      def read_token_from_store
+        td = read_token
+        @token_life_in_seconds = td.fetch('token_expires_in').to_i
         @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
+        @access_token = td.fetch('access_token') # return access_token same time
+      rescue JSON::ParserError, Errno::ENOENT, KeyError, TypeError
         refresh
       end
 
-      def write_token_to_file(token_hash)
-        token_hash.merge!('got_token_at'.freeze => Time.now.to_i)
+      def write_token_to_store(token_hash)
+        token_hash['got_token_at'.freeze] = Time.now.to_i
+        token_hash['token_expires_in'.freeze] = token_hash.delete('expires_in')
+        write_token(token_hash)
+      end
+
+      def read_token
+        JSON.parse(File.read(token_file))
+      end
+
+      def write_token(token_hash)
         File.write(token_file, token_hash.to_json)
       end
 

data/lib/wechat/token/corp_access_token.rb

@@ -5,8 +5,8 @@ module Wechat
     class CorpAccessToken < AccessTokenBase
       def refresh
         data = client.get('gettoken', params: { corpid: appid, corpsecret: secret })
-        write_token_to_file(data)
-        read_token_from_file
+        write_token_to_store(data)
+        read_token_from_store
       end
     end
   end

data/lib/wechat/token/public_access_token.rb

@@ -5,8 +5,8 @@ module Wechat
     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
+        write_token_to_store(data)
+        read_token_from_store
       end
     end
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.7.3
+  version: 0.7.4
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-19 00:00:00.000000000 Z
+date: 2016-01-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -136,9 +136,11 @@ files:
 - bin/wechat
 - lib/action_controller/wechat_responder.rb
 - lib/generators/wechat/install_generator.rb
+- lib/generators/wechat/redis_store_generator.rb
 - lib/generators/wechat/session_generator.rb
 - lib/generators/wechat/templates/app/controllers/wechats_controller.rb
 - lib/generators/wechat/templates/app/models/wechat_session.rb
+- lib/generators/wechat/templates/config/initializers/wechat_redis_store.rb
 - lib/generators/wechat/templates/config/wechat.yml
 - lib/generators/wechat/templates/db/migration.rb
 - lib/wechat.rb