wechat 0.7.1 → 0.7.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24f3a19bb36361d788567cdb400d5a6247753de4
-  data.tar.gz: eee12cc2791847bb3a0568d57829b348785d10c8
+  metadata.gz: bbc60307e8e7d73cfc58fde18740ea50e931399e
+  data.tar.gz: 0c56939175b6f0ee07b8b0bd380ac1fa17cd12a4
 SHA512:
-  metadata.gz: 742d6ed1dbad1e243aea4fce5e289838aee163f858da65d818c82638069e0ecb5a1afd94cb7a9b2689f30867aa4a6c18a8389fe7bdca8e81cae988fedf6dc04e
-  data.tar.gz: 8e0f78fedb6bc0cd798d1f8debbab117e3fa8ac642e5c42504d6e2226656b4813fd4ab3685b7092473ebc3ad0964ed416ee5db2b141742b0c70a3839477982a0
+  metadata.gz: 726d952d12a6722bd1920c53fa1061e00de1b54b88cf3ed6275411652057e44158be477902be28188efdfad04c20c913c904b564fe94cf357a82533ba9248ed5
+  data.tar.gz: 7b97b70b821def7858e908976712f8baec1f30014749ee94cb91eacfeeeb279b35d67da253c0fe06f3894cb19f55473ead516e35e5d68f5fd50c928584ea1b8a

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## v0.7.2 (released at 1/18/2016)
+
+* Optional session support by @zfben #81, #88, #91
+* Replace after_wechat_response with Rails Nofications facility, by @zfben, original issue is #79
+* New user_batchget API. #89
+* Support Rails 3.2 again after support Rails 5.0. by @guange2015 #87 
+* Fetch setting from RAILS_ENV first, then fetch default. by @kikyous #85
+* Warning not support on :scan with regular expression, reason see #84 
+
 ## v0.7.1 (released at 1/11/2016)
 
 * Fix after using http, upload file function break. #78
@@ -10,6 +19,12 @@
 
 * Using [http](https://github.com/httprb/http) instead of rest-client for performance reason. (not support upload file yet)
 
+## v0.6.10 (released at 1/17/2016)
+
+* Support Rails 3.2 again after support Rails 5.0. by @guange2015 #87 
+* Fetch setting from RAILS_ENV first, then fetch default. by @kikyous #85
+* Warning not support on :scan with regular expression. by @kikyous #84 
+
 ## v0.6.9 (released at 1/6/2016)
 
 * Fix token refresh bug on multi worker. #76

data/README-CN.md

@@ -9,6 +9,7 @@ WeChat gem 可以帮助开发者方便地在Rails环境中集成微信[公众平
 - [回调消息](http://qydev.weixin.qq.com/wiki/index.php?title=%E6%8E%A5%E6%94%B6%E6%B6%88%E6%81%AF%E4%B8%8E%E4%BA%8B%E4%BB%B6)（必须运行Web服务器）
 - [微信JS-SDK](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%BE%AE%E4%BF%A1JS%E6%8E%A5%E5%8F%A3) config接口注入权限验证
 - OAuth 2.0认证机制
+- 回调消息会话(session)记录机制（可选）
 
 命令行工具`wechat`可以调用各种无需web环境的API。同时也提供了Rails Controller的responder DSL, 可以帮助开发者方便地在Rails应用中集成微信的消息处理，包括主动推送的和被动响应的消息。
 
@@ -45,6 +46,15 @@ rails generate wechat:install
 
 运行`rails g wechat:install`后会自动生成wechat.yml配置，还有wechat controller及相关路由配置到当前Rails项目。
 
+启用session会话记录:
+
+```console
+rails g wechat:session
+rake db:migrate
+```
+
+运行后会自动启用回调消息会话(session)记录，wechat gem会在Rails项目中生成两个文件，用户可以在*wechat_session*表中添加更多字段或者声明一些关联关系。使用已有的**hash_store**直接保存也是可以的，但对于PostgreSQL用户，使用[hstore](http://guides.rubyonrails.org/active_record_postgresql.html#hstore)或者json格式可能更佳，当然，最佳方案仍然是添加新字段记录数据。
+
 
 ## 配置
 
@@ -202,6 +212,7 @@ Wechat commands:
   wechat qrcode_download [TICKET, QR_CODE_PIC_PATH]        # 通过ticket下载二维码
   wechat template_message [OPENID, TEMPLATE_YAML_PATH]     # 模板消息接口
   wechat user [OPEN_ID]                                    # 获取用户基本信息
+  wechat user_batchget [OPEN_ID_LIST]                      # 批量获取用户基本信息  
   wechat user_change_group [OPEN_ID, TO_GROUP_ID]          # 移动用户分组
   wechat user_group [OPEN_ID]                              # 查询用户所在分组
   wechat user_update_remark [OPEN_ID, REMARK]              # 设置备注名
@@ -522,13 +533,6 @@ class WechatsController < ActionController::Base
 
   # 当无任何responder处理用户信息时,使用这个responder处理
   on :fallback, respond: 'fallback message'
-
-  # 如果你要在微信回复后增加一些操作，可以用 after_wechat_response(req, res)
-  # private
-  #
-  # def after_wechat_response(req, res)
-  #   WechatLog.create req: req, res: res
-  # end
 end
 ```
 
@@ -570,6 +574,20 @@ end
 
 注意设置了[多客服消息转发](http://dkf.qq.com/)后，不能再添加`默认文字信息responder`，否则文字消息将得不到转发。
 
+### 通知
+
+现支持以下通知：
+
+* `wechat.responder.after_create` data 包含 request<Wechat::Message> 和 response<Wechat::Message>
+
+使用示例：
+
+```ruby
+ActiveSupport::Notifications.subscribe('wechat.responder.after_create') do |name, started, finished, unique_id, data|
+  WechatLog.create request: data[:request], response: data[:response]
+end
+```
+
 ## 已知问题
 
 * 企业号接受菜单消息时，Wechat腾讯服务器无法解析部分域名，请使用IP绑定回调URL，用户的普通消息目前不受影响。

data/README.md

@@ -13,6 +13,7 @@ WeChat gem trying to helping Rails developer to integrated [enterprise account](
 - [Receiving message](http://qydev.weixin.qq.com/wiki/index.php?title=%E6%8E%A5%E6%94%B6%E6%B6%88%E6%81%AF%E4%B8%8E%E4%BA%8B%E4%BB%B6)（You must running on rails server to receiving message）
 - [Wechat JS-SDK](http://qydev.weixin.qq.com/wiki/index.php?title=%E5%BE%AE%E4%BF%A1JS%E6%8E%A5%E5%8F%A3) config signature
 - OAuth 2.0 authentication
+- Record session when received message from user (Optional)
 
 
 `wechat` command share the same API in console, so you can interactive with wechat server quickly, without starting up web environment/code.
@@ -51,12 +52,20 @@ rails generate wechat:install
 
 `rails g wechat:install` will generated the initial `wechat.yml` configuration, example wechat controller and corresponding routes.
 
+Enable session record:
+
+```console
+rails g wechat:session
+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.
 
 ## Configuration
 
 #### Configure for command line
 
-You can using `wechat` command solely, you need created configure file `~/.wechat.yml` and including below content for public account. the access_token will be write as a file.
+To using `wechat` command solely, needs created configure file `~/.wechat.yml` and including below content for public account. the access_token will be write as a file.
 
 ```
 appid: "my_appid"
@@ -216,6 +225,7 @@ Wechat commands:
   wechat qrcode_download [TICKET, QR_CODE_PIC_PATH]        # 通过ticket下载二维码
   wechat template_message [OPENID, TEMPLATE_YAML_PATH]     # 模板消息接口
   wechat user [OPEN_ID]                                    # 获取用户基本信息
+  wechat user_batchget [OPEN_ID_LIST]                      # 批量获取用户基本信息  
   wechat user_change_group [OPEN_ID, TO_GROUP_ID]          # 移动用户分组
   wechat user_group [OPEN_ID]                              # 查询用户所在分组
   wechat user_update_remark [OPEN_ID, REMARK]              # 设置备注名
@@ -418,7 +428,6 @@ So the ActionController should defined like below:
 ```ruby
 class WechatsController < ActionController::Base
   wechat_responder
-  wechat_responder
 
   # default text responder when no other match
   on :text do |request, content|
@@ -535,13 +544,6 @@ class WechatsController < ActionController::Base
 
   # Any not match above will fail to below
   on :fallback, respond: 'fallback message'
-
-  # If you need do something after response, you should add after_wechat_response(req, res)
-  # private
-  #
-  # def after_wechat_response(req, res)
-  #   WechatLog.create req: req, res: res
-  # end
 end
 ```
 
@@ -584,6 +586,17 @@ end
 
 Caution: do not setting default text responder if you want to using [multiply human customer service](http://dkf.qq.com/), other will lead text message can not transfer.
 
+### Notifications
+
+* `wechat.responder.after_create` data include request<Wechat::Message> and response<Wechat::Message>.
+
+Example:
+
+```ruby
+ActiveSupport::Notifications.subscribe('wechat.responder.after_create') do |name, started, finished, unique_id, data|
+  WechatLog.create request: data[:request], response: data[:response]
+end
+```
 
 ## Known Issue
 

data/bin/wechat

@@ -267,6 +267,11 @@ class App < Thor
       puts wechat_api.users
     end
 
+    desc 'user_batchget [OPEN_ID_LIST]', '批量获取用户基本信息'
+    def user_batchget(openidlist)
+      puts wechat_api.user_batchget(openidlist.split(','))
+    end
+
     desc 'qrcode_create_scene [SCENE_ID, EXPIRE_SECONDS]', '请求临时二维码'
     def qrcode_create_scene(scene_id, expire_seconds = 604800)
       puts wechat_api.qrcode_create_scene(scene_id, expire_seconds)

data/lib/generators/wechat/session_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators/active_record'
+
+module Wechat
+  module Generators
+    class SessionGenerator < Rails::Generators::Base
+      include ::Rails::Generators::Migration
+
+      desc 'Enable wechat session support'
+      source_root File.expand_path('../templates', __FILE__)
+
+      def copy_wechat_sessions_migration
+        migration_template 'db/migration.rb', 'db/migrate/create_wechat_sessions.rb'
+      end
+
+      def copy_wechat_session_model
+        template 'app/models/wechat_session.rb'
+      end
+
+      private
+
+      def self.next_migration_number(dirname)
+        ::ActiveRecord::Generators::Base.next_migration_number(dirname)
+      end
+    end
+  end
+end

data/lib/generators/wechat/templates/app/models/wechat_session.rb

@@ -0,0 +1,17 @@
+# Used by wechat gems, do not rename WechatSession to other name,
+# Feel free to inherit from other class like ActiveModel::Model
+class WechatSession < ActiveRecord::Base
+  validates :openid, presence: true, uniqueness: true
+  serialize :hash_store, Hash
+
+  # called by wechat gems when user request session
+  def self.find_or_initialize_session(request_message)
+    find_or_initialize_by(openid: request_message[:from_user_name])
+  end
+
+  # called by wechat gems after response Techent server at controller#create
+  def save_session(response_message)
+    touch unless new_record? # Always refresh updated_at even no change
+    save!
+  end
+end

data/lib/generators/wechat/templates/db/migration.rb

@@ -0,0 +1,10 @@
+class CreateWechatSessions < ActiveRecord::Migration
+  def change
+    create_table :wechat_sessions do |t|
+      t.string :openid, null: false
+      t.string :hash_store
+      t.timestamps null: false
+    end
+    add_index :wechat_sessions, :openid, unique: true
+  end
+end

data/lib/wechat/api.rb

@@ -39,6 +39,10 @@ module Wechat
       get 'user/info', params: { openid: openid }
     end
 
+    def user_batchget(openids, lang = 'zh-CN')
+      post 'user/info/batchget', JSON.generate(user_list: openids.collect { |v| { openid: v, lang: lang } })
+    end
+
     def user_group(openid)
       post 'groups/getid', JSON.generate(openid: openid)
     end

data/lib/wechat/api_loader.rb

@@ -24,6 +24,8 @@ HELP
     def self.config
       return @config unless @config.nil?
       @config ||= loading_config!
+      @config.have_session_table = class_exists?('WechatSession') && WechatSession.table_exists?
+      @config
     end
 
     private
@@ -48,9 +50,10 @@ HELP
         rails_config_file = File.join(Dir.getwd, 'config/wechat.yml')
         home_config_file = File.join(Dir.home, '.wechat.yml')
         if File.exist?(rails_config_file)
-          config = YAML.load(ERB.new(File.read(rails_config_file)).result)['default']
+          rails_env = ENV['RAILS_ENV'] || 'default'
+          config = YAML.load(ERB.new(File.read(rails_config_file)).result)[rails_env]
           if config.present? && (config['appid'] || config['corpid'])
-            puts 'Using rails project config/wechat.yml default setting...'
+            puts "Using rails project config/wechat.yml #{rails_env} setting..."
             return config
           end
         end
@@ -74,5 +77,11 @@ HELP
         encoding_aes_key: ENV['WECHAT_ENCODING_AES_KEY'],
         jsapi_ticket: ENV['WECHAT_JSAPI_TICKET'] }
     end
+
+    def self.class_exists?(class_name)
+      return Module.const_get(class_name).present?
+    rescue NameError
+      return false
+    end
   end
 end

data/lib/wechat/message.rb

@@ -36,10 +36,22 @@ module Wechat
       Message.new(
         ToUserName: message_hash[:FromUserName],
         FromUserName: message_hash[:ToUserName],
-        CreateTime: Time.now.to_i
+        CreateTime: Time.now.to_i,
+        WechatSession: session
       )
     end
 
+    def session
+      return nil unless Wechat.config.have_session_table
+      @message_hash[:WechatSession] ||= WechatSession.find_or_initialize_session(underscore_hash_keys(message_hash))
+    end
+
+    def save_session
+      ws = message_hash.delete(:WechatSession)
+      ws.try(:save_session, underscore_hash_keys(message_hash))
+      @message_hash[:WechatSession] = ws
+    end
+
     def as(type)
       case type
       when :text
@@ -116,7 +128,10 @@ module Wechat
     end
 
     def to_xml
-      message_hash.to_xml(root: 'xml', children: 'item', skip_instruct: true, skip_types: true)
+      ws = message_hash.delete(:WechatSession)
+      xml = message_hash.to_xml(root: 'xml', children: 'item', skip_instruct: true, skip_types: true)
+      @message_hash[:WechatSession] = ws
+      xml
     end
 
     TO_JSON_KEY_MAP = {
@@ -177,7 +192,7 @@ module Wechat
           value = value.collect { |item| item.is_a?(Hash) ? deep_recursive(item, &block) : item }
         end
 
-        key, value = yield(key, value)
+        key, value = yield(key, value) unless key == :WechatSession
         memo.merge!(key => value)
       end
     end

data/lib/wechat/responder.rb

@@ -8,7 +8,7 @@ module Wechat
 
     included do
       # Rails 5 remove before_filter and skip_before_filter
-      if defined?(:skip_before_action)
+      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)
         before_action :verify_signature, only: [:show, :create]
@@ -29,7 +29,13 @@ module Wechat
         if with.present?
           fail 'Only text, event, click, view, scan and batch_job can having :with parameters' unless [:text, :event, :click, :view, :scan, :batch_job].include?(message_type)
           config.merge!(with: with)
-          self.known_scan_key_lists = with if message_type == :scan
+          if message_type == :scan
+            if with.is_a?(String)
+              self.known_scan_key_lists = with
+            else
+              fail 'on :scan only support string in parameter with, detail see https://github.com/Eric-Guo/wechat/issues/84'
+            end
+          end
         else
           fail 'Message type click, view, scan and batch_job must specify :with parameters' if [:click, :view, :scan, :batch_job].include?(message_type)
         end
@@ -41,11 +47,14 @@ module Wechat
           user_defined_view_responders(with) << config
         when :batch_job
           user_defined_batch_job_responders(with) << config
+        when :scan
+          user_defined_scan_responders << config
         when :location
           user_defined_location_responders << config
         else
           user_defined_responders(message_type) << config
         end
+
         config
       end
 
@@ -64,6 +73,10 @@ module Wechat
         @batch_job_responders[with] ||= []
       end
 
+      def user_defined_scan_responders
+        @scan_responders ||= []
+      end
+
       def user_defined_location_responders
         @location_responders ||= []
       end
@@ -87,8 +100,8 @@ module Wechat
             yield(* user_defined_view_responders(message[:EventKey]), message[:EventKey])
           elsif 'click' == message[:Event]
             yield(* match_responders(responders, message[:EventKey]))
-          elsif known_scan_key_lists.include?(message[:EventKey])
-            yield(* known_scan_with_match_responders(user_defined_responders(:scan), message))
+          elsif known_scan_key_lists.include?(message[:EventKey]) && %w(scan subscribe scancode_push scancode_waitmsg).include?(message[:Event])
+            yield(* known_scan_with_match_responders(user_defined_scan_responders, message))
           elsif 'batch_job_result' == message[:Event]
             yield(* user_defined_batch_job_responders(message[:BatchJob][:JobType]), message[:BatchJob])
           elsif 'location' == message[:Event]
@@ -156,16 +169,18 @@ module Wechat
     end
 
     def create
-      request = Wechat::Message.from_hash(post_xml)
-      response = run_responder(request)
+      request_msg = Wechat::Message.from_hash(post_xml)
+      response_msg = run_responder(request_msg)
 
-      if response.respond_to? :to_xml
-        render plain: process_response(response)
+      if response_msg.respond_to? :to_xml
+        render plain: process_response(response_msg)
       else
         render nothing: true, status: 200, content_type: 'text/html'
       end
 
-      after_wechat_response(request, response) if respond_to?(:after_wechat_response)
+      response_msg.save_session if response_msg.is_a?(Wechat::Message) && Wechat.config.have_session_table
+
+      ActiveSupport::Notifications.instrument 'wechat.responder.after_create', request: request_msg, response: response_msg
     end
 
     private

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.7.2
 platform: ruby
 authors:
 - Skinnyworm
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-10 00:00:00.000000000 Z
+date: 2016-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -107,7 +107,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-description: API and message handling for WeChat in Rails
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API, command and message handling for WeChat in Rails
 email: eric.guocz@gmail.com
 executables:
 - wechat
@@ -122,8 +136,11 @@ files:
 - bin/wechat
 - lib/action_controller/wechat_responder.rb
 - lib/generators/wechat/install_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/wechat.yml
+- lib/generators/wechat/templates/db/migration.rb
 - lib/wechat.rb
 - lib/wechat/api.rb
 - lib/wechat/api_base.rb