weixin_authorize 1.1.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 46bd1a765537e643f77dd3b7a112160131f031e5
-  data.tar.gz: 40e96c73ebc3123b461986e673e504dc530e42c6
+  metadata.gz: 194d7f3905340f75447ec9401d845af02eedf8a8
+  data.tar.gz: 448c9b7656d7100801514abf18f5213456f28b01
 SHA512:
-  metadata.gz: 72fe71c1509bcdaa2d8d5f58f325f03df41f1d996c6ce008a6bbafeb38ebe8b4261f2745fc0832cd7f49cffa4607168a14af5e5e9edea30f31cca43f414963a9
-  data.tar.gz: 67f3c7642241afd83736d5702c93e3f5be1d4dbccaa13c2a78b59f985de0629f09f723ef70404952ee4b6a8dcadfe0853869637be519dcdc496943983ec16aa9
+  metadata.gz: aa2e813b5c406da0bf28e9987db44318ab369fc41401b3e12158cdce540f04d8e827f5cf777123a40a3c6a6ab246749aa6143c55e859f1ba2dee8d4c51665737
+  data.tar.gz: e7eac68aec0577c93f10dd5e1634d9a58d5bca61d667c6fcfbbe5dd50975e5d7e6aa5b15d3085ec42bcb1ba122da9d13327c701196d230f3a6b10c71b99d78ea

data/Gemfile

@@ -7,4 +7,5 @@ group :development, :test do
   # For debugger
   gem "pry-rails", "~> 0.3.2"
   gem "pry-debugger", "~> 0.2.2"
+  gem "redis-namespace"
 end

data/README.md

@@ -1,5 +1,9 @@
 # WeixinAuthorize
 
+[![Gem Version](https://badge.fury.io/rb/weixin_authorize.png)](http://badge.fury.io/rb/weixin_authorize)
+
+Support using [Redis](http://redis.io) to store `access_token`
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -24,18 +28,51 @@ Or install it yourself as:
 
 ```ruby
 
-$client ||= WeixinAuthorize.configure do |config|
-  config.app_id     = ENV["APPID"]
-  config.app_secret = ENV["APPSECRET"]
-  config.expired_at = Time.now.to_i
-end
+$client ||= WeixinAuthorize::Client.new(ENV["APPID"], ENV["APPSECRET"])
+```
 
-# Or
+### Option: use [Redis](http://redis.io) to store your access_token (Recommend)
 
-$client ||= WeixinAuthorize::Client.new(ENV["APPID"], ENV["APPSECRET"])
+  **If you don't use Redis, it will send a request to get a new access_token everytime!**
+
+* Added `redis-namespace` to you `Gemfile`
+
+```ruby
+# Adds a Redis::Namespace class which can be used to namespace calls to Redis. This is useful when using a single instance of Redis with multiple, different applications.
+# http://github.com/resque/redis-namespace
+gem "redis-namespace", "~> 1.4.1"
+
+```
+
+* Create file in: `config/initializers/weixin_authorize.rb`
+
+```ruby
+
+# don't forget change namespace
+namespace = "app_name_weixin:weixin_authorize"
+redis = Redis.new(:host => "127.0.0.1", :port => "6379", :db => 15)
+
+# cleanup keys in the current namespace when restart server everytime.
+exist_keys = redis.keys("#{namespace}:*")
+exist_keys.each{|key|redis.del(key)}
+
+# Give a special namespace as prefix for Redis key, when your have more than one project used weixin_authorize, this config will make them work fine.
+redis = Redis::Namespace.new("#{namespace}", :redis => redis)
+
+WeixinAuthorize.configure do |config|
+  config.redis = redis
+end
 
 ```
 
+* You can also specify the `key`, but it is optionly.
+
+  ```ruby
+
+  $client ||= WeixinAuthorize::Client.new(ENV["APPID"], ENV["APPSECRET"], "your_store_key")
+  ```
+  **Note:** `your_store_key` should be unique for every account!
+
 ### 获取用户管理信息
 
 * [获取用户基本信息](http://mp.weixin.qq.com/wiki/index.php?title=获取用户基本信息)
@@ -46,7 +83,6 @@ $client ||= WeixinAuthorize::Client.new(ENV["APPID"], ENV["APPSECRET"])
 
   `followers = $client.followers`
 
-
 ### [分组管理接口](http://mp.weixin.qq.com/wiki/index.php?title=分组管理接口)
 
 * 创建分组:
@@ -119,9 +155,6 @@ export OPENID="your weixin openid"
 ```
 Last, you have to **open a new terminal tag (Reload bash_profile)** , and run `rspec .`
 
-## 多用户微信营销平台的对接
-
-> 对于多用户微信营销平台的对接，需要把每次的expired_at, access_token保存在Redis中,每次使用，则可以从Redis中获取expired_at和access_token, 即 `@client = WeixinAuthorize::Client.new(appid, appsecret, expired_at, access_token)`, 获取access_token，则仍然是：`@client.get_access_token`来获取.
 
 ## Contributing
 

data/lib/weixin_authorize/client.rb

@@ -1,4 +1,6 @@
 # encoding: utf-8
+require "redis"
+require 'digest'
 module WeixinAuthorize
 
   class Client
@@ -8,40 +10,62 @@ module WeixinAuthorize
     include Api::Groups
 
     attr_accessor :app_id, :app_secret, :expired_at # Time.now + expires_in
-    attr_accessor :access_token
+    attr_accessor :access_token, :redis_key
 
     # 对于多用户微信营销平台的对接，需要把每次的expired_at, access_token保存在Redis中
     # 每次使用，则可以从Redis中获取expired_at和access_token，即
-    # @client = WeixinAuthorize::Client.new(appid, appsecret, expired_at, access_token)
+    # @client = WeixinAuthorize::Client.new(appid, appsecret)
+    # 如果使用存在多个公众账号，请使用 务必传递: redis_key
     # 获取access_token，则仍然是：@client.get_access_token 来获取
-    def initialize(app_id="", app_secret="", expired_at=nil, access_token=nil)
-      @app_id       = app_id
-      @app_secret   = app_secret
-      @expired_at   = (expired_at.to_i || Time.now.to_i)
-      @access_token = access_token
-      yield self if block_given?
+    def initialize(app_id, app_secret, redis_key=nil)
+      @app_id     = app_id
+      @app_secret = app_secret
+      @expired_at = Time.now.to_i
+      @redis_key  = security_redis_key((redis_key || "weixin_" + app_id))
     end
 
     # return token
     def get_access_token
-      # 如果当前token过期时间小于现在的时间，则重新获取一次
       authenticate if token_expired?
+      if !is_weixin_redis_blank?
+        self.access_token = weixin_redis.hget(redis_key, "access_token")
+        self.expired_at   = weixin_redis.hget(redis_key, "expired_at")
+      end
       @access_token
     end
 
     # authenticate access_token
     def authenticate
-      hash_infos        = http_get_without_token("/token", authenticate_options)
-      self.access_token = hash_infos["access_token"]
-      self.expired_at   = Time.now.to_i + hash_infos["expires_in"]
+      if is_weixin_redis_blank?
+        http_get_access_token
+      else
+        authenticate_with_redis
+      end
     end
 
     def token_expired?
-      @expired_at <= Time.now.to_i
+      if is_weixin_redis_blank?
+        # 如果当前token过期时间小于现在的时间，则重新获取一次
+        @expired_at <= Time.now.to_i
+      else
+        weixin_redis.hvals(redis_key).empty?
+      end
     end
 
     private
 
+      def authenticate_with_redis
+        http_get_access_token
+        weixin_redis.hmset(redis_key, :access_token, access_token, :expired_at, expired_at)
+        weixin_redis.expireat(redis_key, expired_at.to_i-10) # 提前10秒超时
+      end
+
+      def http_get_access_token
+        hash_infos        = http_get_without_token("/token", authenticate_options)
+        self.access_token = hash_infos["access_token"]
+        self.expired_at   = Time.now.to_i + hash_infos["expires_in"]
+      end
+
       def authenticate_options
         {grant_type: "client_credential", appid: app_id, secret: app_secret}
       end
@@ -79,5 +103,18 @@ module WeixinAuthorize
         "http://file.api.weixin.qq.com/cgi-bin"
       end
 
+      def weixin_redis
+        return nil if WeixinAuthorize.config.nil?
+        @redis ||= WeixinAuthorize.config.redis
+      end
+
+      def is_weixin_redis_blank?
+        weixin_redis.nil?
+      end
+
+      def security_redis_key(key)
+        Digest::MD5.hexdigest(key.to_s).upcase
+      end
+
   end
 end

data/lib/weixin_authorize/config.rb

@@ -0,0 +1,15 @@
+module WeixinAuthorize
+
+  class << self
+
+    attr_accessor :config
+
+    def configure
+      yield self.config ||= Config.new
+    end
+  end
+
+  class Config
+    attr_accessor :redis
+  end
+end

data/lib/weixin_authorize/version.rb

@@ -1,3 +1,3 @@
 module WeixinAuthorize
-  VERSION = "1.1.0"
+  VERSION = "1.5.0"
 end

data/lib/weixin_authorize.rb

@@ -1,6 +1,6 @@
 require "rest-client"
 require "multi_json"
-require "weixin_authorize/version"
+require "weixin_authorize/config"
 require "weixin_authorize/api/user"
 require "weixin_authorize/api/menu"
 require "weixin_authorize/api/custom"
@@ -9,15 +9,4 @@ require "weixin_authorize/client"
 
 module WeixinAuthorize
 
-  # @client ||= WeixinAuthorize.configure do |config|
-  #               config.app_id     = "app_id-xxxxxxx"
-  #               config.app_secret = "app_secret-xxxxxxx"
-  #             end
-  #
-  class << self
-    def configure(&block)
-      Client.new(&block)
-    end
-  end
-
 end

data/spec/spec_helper.rb

@@ -16,14 +16,17 @@
 require "rspec"
 require "weixin_authorize"
 require "multi_json"
+require "redis"
+require "redis-namespace"
 
 require "pry-rails"
 
-# $client ||= WeixinAuthorize.configure do |config|
-#   config.app_id     = ENV["APPID"]
-#   config.app_secret = ENV["APPSECRET"]
-#   config.expired_at = Time.now.to_i
-# end
+redis = Redis.new(:host => "127.0.0.1",:port => "6379")
+
+redis_with_ns = Redis::Namespace.new("weixin_#{Time.now.to_i}:weixin_authorize", :redis => redis)
+WeixinAuthorize.configure do |config|
+  config.redis = redis_with_ns
+end
 
 $client = WeixinAuthorize::Client.new(ENV["APPID"], ENV["APPSECRET"])
 

data/weixin_authorize.gemspec

@@ -20,6 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "rest-client", ">= 1.6.7"
   spec.add_dependency "multi_json", "~> 1.9.0"
+  spec.add_dependency "redis", "~> 3.0.7"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weixin_authorize
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.5.0
 platform: ruby
 authors:
 - lanrion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-20 00:00:00.000000000 Z
+date: 2014-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -38,6 +38,20 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 1.9.0
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.7
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -99,6 +113,7 @@ files:
 - lib/weixin_authorize/api/menu.rb
 - lib/weixin_authorize/api/user.rb
 - lib/weixin_authorize/client.rb
+- lib/weixin_authorize/config.rb
 - lib/weixin_authorize/version.rb
 - spec/1_fetch_access_token_spec.rb
 - spec/api/custom_spec.rb