Added config support for per responder controller

Author: huhao98

README.md

@@ -4,47 +4,198 @@ Wechat Rails
 [![Build Status](https://travis-ci.org/skinnyworm/omniauth-wechat-oauth2.svg)](https://travis-ci.org/skinnyworm/wechat-rails) [![Code Climate](https://codeclimate.com/github/skinnyworm/wechat-rails.png)](https://codeclimate.com/github/skinnyworm/wechat-rails) [![Code Coverage](https://codeclimate.com/github/skinnyworm/wechat-rails/coverage.png)](https://codeclimate.com/github/skinnyworm/wechat-rails) [![Gem Version](https://badge.fury.io/rb/wechat-rails.png)](http://badge.fury.io/rb/wechat-rails)
 
 
-Wechat MP platform provides following services for developers to use
+Wechat-rails 可以帮助开发者方便地在Rails环境中集成微信公众平台提供的所有服务，目前微信公众平台提供了以下几种类型的服务。
 
-- API service (user query, media retrieval and sending custom messages)
-- Messaging service (repspond to messages sent by user)
-- OAuth 2.0
+- ##### 微信公众平台基本API, 无需Web环境。
+- ##### 消息处理机制, 需运行在Web环境中。
+- ##### OAuth 2.0认证机制
 
-Wechat-rails gem helps developer to easily use the API service and Messaging service in rails app. For oauth2 integeration, you can consider [omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2).
+Wechat-rails gem 包含了一个命令行程序可以调用各种无需web环境的API。同时它也提供了Rails Controller的responder DSL, 可以帮助开发者方便地在Rails应用中集成微信的消息处理机制。如果你的App还需要集成微信OAuth2.0, 你可以考虑[omniauth-wechat-oauth2](https://github.com/skinnyworm/omniauth-wechat-oauth2), 这个gem可以方便地和devise集成提供完整的用户认证.
 
-You need to get a wechat API key at: http://mp.weixin.qq.com
+在使用这个Gem前，你需要获得微信API的appid, secret, token。具体情况可以参见http://mp.weixin.qq.com
 
-## Installation
+## 安装
 
-Add to your `Gemfile`:
+Using `gem install` or add to your app's `Gemfile`:
+
+```
+gem install "wechat-rails"
+```
+
+```
+gem "wechat-rails", git:"https://github.com/skinnyworm/wechat-rails"
+```
+
+
+## 配置
+
+#### 命令行程序的配置
+
+要使用命令行程序，你需要在你的home目录中创建一个`~/.wechat.yml`，包含以下内容。其中`access_token`是存放access_token的文件位置。
+
+```
+appid: "my_appid"
+secret: "my_secret"
+access_token: "/var/tmp/wechat_access_token"
+```
+
+#### Rails 全局配置
+Rails环境中, 你可以在config中创建wechat.yml, 为每个rails environment创建不同的配置。
+
+```
+default: &default
+  appid: "app_id"
+  secret: "app_secret"
+  token:  "app_token"
+  access_token: "/var/tmp/wechat_access_token"
+
+production: 
+  appid: <%= ENV['WECHAT_APPID'] %>
+  secret: <%= ENV['WECHAT_APP_SECRET'] %>
+  token:   <%= ENV['WECHAT_TOKEN'] %>
+  access_token:  <%= ENV['WECHAT_ACCESS_TOKEN'] %>
+
+staging: 
+  <<: *default
+
+development: 
+  <<: *default
+
+test: 
+  <<: *default
+```
+
+#### Rails 为每个Responder配置不同的appid和secret
+在个别情况下，你的app可能需要处理来自多个公众账号的消息，这时你可以配置多个responder controller。
 
 ```ruby
-gem "wechat-rails"
+class WechatFirstController < ApplicationController
+   wechat_responder appid: "app1", secret: "secret1", token: "token1", access_token: Rails.root.join("tmp/access_token1")
+   
+   on :text, with:"help", respond: "help content"
+end
+```
+    
+## 使用命令行
+
+```
+$ wechat
+Wechat commands:
+  wechat custom_image [OPENID, IMAGE_PATH]                 # 发送图片客服消息
+  wechat custom_music [OPENID, THUMBNAIL_PATH, MUSIC_URL]  # 发送音乐客服消息
+  wechat custom_news [OPENID, NEWS_YAML_FILE]              # 发送图文客服消息
+  wechat custom_text [OPENID, TEXT_MESSAGE]                # 发送文字客服消息
+  wechat custom_video [OPENID, VIDEO_PATH]                 # 发送视频客服消息
+  wechat custom_voice [OPENID, VOICE_PATH]                 # 发送语音客服消息
+  wechat help [COMMAND]                                    # Describe available commands or one specific command
+  wechat media [MEDIA_ID, PATH]                            # 媒体下载
+  wechat media_create [MEDIA_ID, PATH]                     # 媒体上传
+  wechat menu                                              # 当前菜单
+  wechat menu_create [MENU_YAML]                           # 创建菜单
+  wechat menu_delete                                       # 删除菜单
+  wechat user [OPEN_ID]                                    # 查找关注者
+  wechat users                                             # 关注者列表
+
 ```
 
-Then `bundle install`.
+### 使用场景
+以下是几种典型场景的使用方法
 
-### Setup Environment
-For development environment, you need to export some environment variables before you can use the commandline utilities.
+#####获取所有用户的OPENID
 
 ```
-export WECHAT_APPID=<app id>
-export WECHAT_SECRET=<app secret>
-export WECHAT_ACCESS_TOKEN=<储存access_token文件的位置, eg. /var/tmp/access_token>
-export TOKEN=<Token可由开发者任意填写,用作生成签名,在配置接口时使用>
+$ wechat users
+
+{"total"=>4, "count"=>4, "data"=>{"openid"=>["oCfEht9***********", "oCfEhtwqa***********", "oCfEht9oMCqGo***********", "oCfEht_81H5o2***********"]}, "next_openid"=>"oCfEht_81H5o2***********"}
+
 ```
-For production environment, consult your service configuration for how to expose your environment variables.
 
-## Command line utilities
-Once the gem was installed, you should have a command line utility for invoking all the api methods.
+#####获取用户的信息
 
-## Controller DSL
-To set up a rails controlelr for reponding user message is easy. Following is an example
+```
+$ wechat user "oCfEht9***********"
+
+{"subscribe"=>1, "openid"=>"oCfEht9***********", "nickname"=>"Nickname", "sex"=>1, "language"=>"zh_CN", "city"=>"徐汇", "province"=>"上海", "country"=>"中国", "headimgurl"=>"http://wx.qlogo.cn/mmopen/ajNVdqHZLLBd0SG8NjV3UpXZuiaGGPDcaKHebTKiaTyof*********/0", "subscribe_time"=>1395715239}
+
+```
+
+#####获取用户的信息
+
+```
+$ wechat user "oCfEht9***********"
+
+{"subscribe"=>1, "openid"=>"oCfEht9***********", "nickname"=>"Nickname", "sex"=>1, "language"=>"zh_CN", "city"=>"徐汇", "province"=>"上海", "country"=>"中国", "headimgurl"=>"http://wx.qlogo.cn/mmopen/ajNVdqHZLLBd0SG8NjV3UpXZuiaGGPDcaKHebTKiaTyof*********/0", "subscribe_time"=>1395715239}
+```
+
+##### 获取当前菜单
+```
+$ wechat menu
+
+{"menu"=>{"button"=>[{"type"=>"view", "name"=>"保护的", "url"=>"http://***/protected", "sub_button"=>[]}, {"type"=>"view", "name"=>"公开的", "url"=>"http://***", "sub_button"=>[]}]}}
+
+```
+
+##### 创建菜单
+创建菜单需要一个定义菜单内容的yaml文件，比如
+menu.yaml
+
+```
+button:
+  -
+    type: "view"
+    name: "保护的"
+    url: "http://***/protected"
+  -
+    type: "view"
+    name: "公开的"
+    url: "http://***"
+    
+```
+
+然后执行命令行
+
+```
+$ wechat menu_create menu.yaml
+
+```
+
+##### 发送客服图文消息
+需定义一个图文消息内容的yaml文件，比如
+articles.yaml
+
+```
+articles:
+ -
+  title: "习近平在布鲁日欧洲学院演讲"
+  description: "新华网比利时布鲁日4月1日电 国家主席习近平1日在比利时布鲁日欧洲学院发表重要演讲"
+  url: "http://news.sina.com.cn/c/2014-04-01/232629843387.shtml"
+  pic_url: "http://i3.sinaimg.cn/dy/c/2014-04-01/1396366518_bYays1.jpg"
+```
+
+然后执行命令行
+
+```
+$ wechat custom_news oCfEht9oM*********** articles.yml 
+
+```
+
+
+
+## Rails Responder Controller DSL
+
+为了在Rails app中响应用户的消息，开发者需要创建一个wechat responder controller. 首先在router中定义
+
+```ruby
+  resource :wechat, only:[:show, :create]
+
+```
+
+然后创建Controller class, 例如
 
 ```ruby
 
 class WechatsController < ApplicationController
-  wechat_rails
+  wechat_responder
 
   # 默认的文字信息responder
   on :text do |request, content|
@@ -76,7 +227,7 @@ class WechatsController < ApplicationController
 
   # 处理视频信息
   on :video do |request|
-    nickname = Wechat.api.user(request[:FromUserName])["nickname"] #呼叫 api 获得发送者的nickname
+    nickname = wechat.user(request[:FromUserName])["nickname"] #调用 api 获得发送者的nickname
     request.reply.video(request[:MediaId], title: "回声", description: "#{nickname}发来的视频请求") #直接视频返回给用户
   end
 
@@ -86,13 +237,37 @@ class WechatsController < ApplicationController
   end
 
   # 当无任何responder处理用户信息时,使用这个responder处理
-  on :fallback do |request|
-    request.reply.text "fallback"
-  end
-  
+  on :fallback, respond: "fallback message"  
+end
+
+```
+
+在controller中使用`wechat_responder`引入Responder DSL, 之后可以用
+
+```
+on <message_type> do |message|
+ message.reply.text "some text"
 end
 
 ```
+来响应用户信息。
 
+目前支持的message_type有如下几种
+
+- :text 响应文字消息,可以用`:with`参数来匹配文本内容 `on(:text, with:'help'){|message, content| ...}`
+- :image 响应图片消息
+- :voice 响应语音消息
+- :video 响应视频消息
+- :location 响应地理位置消息
+- :link 响应链接消息
+- :event 响应事件消息, 可以用`:with`参数来匹配事件类型
+- :fallback 默认响应，当收到的消息无法被其他responder响应时，会使用这个responder.
+
+## Message DSL
+
+Wechat-rails 的核心是一个Message DSL,帮助开发者构建各种类型的消息，包括主动推送的和被动响应的。
+....
+
+  
 
 

VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

bin/wechat

@@ -14,17 +14,21 @@ require 'fileutils'
 class App < Thor                                                 
   class Helper
     def self.with(options)
-      appid =  ENV["WECHAT_APPID"]
-      secret = ENV["WECHAT_SECRET"]
-      token_file = options[:toke_file] ||  ENV["WECHAT_ACCESS_TOKEN"]
+      config_file = File.join(Dir.home, ".wechat.yml")
+      config = YAML.load(File.new(config_file).read) if File.exist?(config_file)
+
+      config ||= {}
+      appid =  config["appid"]
+      secret = config["secret"]
+      token_file = options[:toke_file] ||  config["access_token"] || "/var/tmp/wechat_access_token"
 
       if (appid.nil? || secret.nil? || token_file.nil?)
       puts <<-HELP
-You need set wechat appid and secret in environment variables.
+You need create ~/.wechat.yml with wechat appid and secret. For example:
 
-  export WECHAT_APPID=<appid>
-  export WECHAT_SECRET=<secret>
-  export WECHAT_ACCESS_TOKEN=<file location for storing access token>
+  appid: <wechat appid>
+  secret: <wechat secret>
+  access_toke: "/var/tmp/wechat_access_token"
 
 HELP
       exit 1
@@ -56,7 +60,7 @@ HELP
     puts "Menu deleted" if Helper.with(options).menu_delete
   end
 
-  desc "menu_create [MENU_YAML]", "删除菜单"
+  desc "menu_create [MENU_YAML]", "创建菜单"
   def menu_create(menu_yaml)
     menu = YAML.load(File.new(menu_yaml).read)
     puts "Menu created" if Helper.with(options).menu_create(menu)

lib/wechat-rails.rb

@@ -17,23 +17,34 @@ def initialize(errcode, errmsg)
   attr_reader :config
 
   def self.config
-    @config ||= OpenStruct.new(
-      app_id: ENV["WECHAT_APPID"],
-      secret: ENV["WECHAT_SECRET"],
-      token: ENV["WECHAT_TOKEN"],
-      access_token: ENV["WECHAT_ACCESS_TOKEN"]
-    )
+    @config ||= begin
+      if defined? Rails
+        config_file = Rails.root.join("config/wechat.yml")
+        config = YAML.load(ERB.new(File.new(config_file).read).result)[Rails.env] if (File.exist?(config_file))
+      end
+
+      config ||= {appid: ENV["WECHAT_APPID"], secret: ENV["WECHAT_SECRET"], token: ENV["WECHAT_TOKEN"], access_token: ENV["WECHAT_ACCESS_TOKEN"]}
+      config[:access_token] ||= Rails.root.join("tmp/access_token").to_s
+      OpenStruct.new(config)
+    end
   end
 
   def self.api
-    @api ||= Wechat::Api.new(self.config.app_id, self.config.secret, self.config.access_token)
+    @api ||= Wechat::Api.new(self.config.appid, self.config.secret, self.config.access_token)
   end
 end
 
 if defined? ActionController::Base
   class ActionController::Base
-    def self.wechat_rails
+    def self.wechat_responder opts={}
       self.send(:include, Wechat::Responder)
+      if (opts.empty?)
+        self.wechat = Wechat.api
+        self.token = Wechat.config.token
+      else
+        self.wechat = Wechat::Api.new(opts[:appid], opts[:secret], opts[:access_token])
+        self.token = opts[:token]
+      end
     end
   end
 end

lib/wechat/api.rb

@@ -2,14 +2,14 @@
 require 'wechat/access_token'
 
 class Wechat::Api
-  attr_reader :app_id, :secret, :access_token, :client
+  attr_reader :access_token, :client
 
   API_BASE = "https://api.weixin.qq.com/cgi-bin/"
   FILE_BASE = "http://file.api.weixin.qq.com/cgi-bin/"
 
-  def initialize app_id, secret, token_file
+  def initialize appid, secret, token_file
     @client = Wechat::Client.new(API_BASE)
-    @access_token = Wechat::AccessToken.new(@client, app_id, secret, token_file)
+    @access_token = Wechat::AccessToken.new(@client, appid, secret, token_file)
   end
 
   def users

lib/wechat/responder.rb

@@ -5,10 +5,13 @@ module Responder
     included do 
       self.skip_before_filter :verify_authenticity_token
       self.before_filter :verify_signature, only: [:show, :create]
+      #delegate :wehcat, to: :class
     end
 
     module ClassMethods
 
+      attr_accessor :wechat, :token
+
       def on message_type, with: nil, respond: nil, &block
         raise "Unknow message type" unless message_type.in? [:text, :image, :voice, :video, :location, :link, :event, :fallback]
         config=respond.nil? ? {} : {:respond=>respond}
@@ -91,7 +94,7 @@ def create
 
     private
     def verify_signature
-      array = [Wechat.config.token, params[:timestamp], params[:nonce]].compact.sort
+      array = [self.class.token, params[:timestamp], params[:nonce]].compact.sort
       render :text => "Forbidden", :status => 403 if params[:signature] != Digest::SHA1.hexdigest(array.join)
     end
   end