wechat-validator 0.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2eb8f8ca2d42d8cde005149dd05c7d4ee67b9083
-  data.tar.gz: 32681763ef68e00239747c16c083e755ecb288ba
+  metadata.gz: 52c70d489e2f730f37e5156c281389eefdd482b3
+  data.tar.gz: 07faf1150db584263433821e3e2165cd310027dd
 SHA512:
-  metadata.gz: 65de9d152cd21a28ce08c0ea2c11f0d08f9bb2d5fbc7bd7932c1fc6c6f28ba0c51965ec807141dfd836b83778a76833743e51260312b59d2a6de4e75ae554504
-  data.tar.gz: 324f69a6cee1f88ca6c01152bdc118fc40e112c531fce36f97b8b1b4ee8fd1b32d4d9cdb620a42e36edddea170b72faf5ec5a6ea8b7041390d60cdeb7391fd03
+  metadata.gz: e9c4b0d7f70157b86b2b5b368d9127078cc61446e5573f3ab78c5d79f69ce82e2528fba2465ebafce166f643fa2098a0fc03f062439744018e1b878091f1efaf
+  data.tar.gz: 61208f0bca87d65209c8a68f5b42e1536d3c9ae2f846db89f4040a3fa2f360a064b2bf73fce9b789404e43d0266a1d1805e805505058cce9baf0c4c7b3226512

data/README.md

@@ -1,4 +1,21 @@
 # Wechat Validator 微信服务器验证器引擎
 
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/wechat-validator.svg)](https://badge.fury.io/rb/wechat-validator)
+
 The Wechat Server Validator Engine is an engine which handles the Wechat server validation requests.
-微信服务器验证引擎是一个处理微信服务器验证请求的引擎。
+微信服务器验证引擎是一个处理[微信服务器验证](http://mp.weixin.qq.com/wiki/8/f9a0b8382e0b77d87b3bcc1ce6fbc104.html#.E7.AC.AC.E4.BA.8C.E6.AD.A5.EF.BC.9A.E9.AA.8C.E8.AF.81.E6.9C.8D.E5.8A.A1.E5.99.A8.E5.9C.B0.E5.9D.80.E7.9A.84.E6.9C.89.E6.95.88.E6.80.A7)请求的引擎。
+
+## Usage
+In the application's /config/routes.rb file, add the following line:
+```ruby
+mount Wechat::Validator::Engine, at: '/wechat-validator'
+```
+
+In the application's /config/secrets.yml file, add the following line for the development, test, and production categories. The wechat_validation_token should be identical with the [token configured](http://mp.weixin.qq.com/wiki/8/f9a0b8382e0b77d87b3bcc1ce6fbc104.html#.E7.AC.AC.E4.B8.80.E6.AD.A5.EF.BC.9A.E5.A1.AB.E5.86.99.E6.9C.8D.E5.8A.A1.E5.99.A8.E9.85.8D.E7.BD.AE).
+```yaml
+wechat_validation_token: {Your Wechat Validation Token}
+```
+
+Configure the following URL in the [Wechat](http://mp.weixin.qq.com/wiki/8/f9a0b8382e0b77d87b3bcc1ce6fbc104.html#.E7.AC.AC.E4.B8.80.E6.AD.A5.EF.BC.9A.E5.A1.AB.E5.86.99.E6.9C.8D.E5.8A.A1.E5.99.A8.E9.85.8D.E7.BD.AE):
+http://{your.domain.name}/wechat-validator/server_validations

data/app/controllers/wechat/validator/concerns/signature_checker.rb

@@ -12,7 +12,7 @@ module Wechat
 
             if token.blank?
               Rails.logger.warn 'Token is required to validate URL by Wechat.'
-              render status: :forbidden, text: ''
+              render status: :forbidden, text: 'The token parameter is required.'
               return
             end
 
@@ -26,16 +26,22 @@ module Wechat
             return unless check_parameter 'signature', signature
             return unless check_parameter 'echo',      echo
 
-            actual_signature = ::Wechat::Validation.sign nonce, timestamp, token
-            Rails.logger.warn "Actual signature is #{actual_signature}, which #{signature==actual_signature ? 'equals' : 'does not equal'} to the given signature #{signature}."
-            render text: (signature==actual_signature ? echo : '')
+            actual_signature  = ::Wechat::Validation::Signature.create nonce, timestamp, token # ::Wechat::Validation.sign nonce, timestamp, token
+            signature_matched = signature==actual_signature
+            Rails.logger.warn "Actual signature is #{actual_signature}, which #{signature_matched ? 'equals' : 'does not equal'} to the given signature #{signature}."
+
+            if signature_matched
+              render text: echo
+            else
+              render status: :forbidden, text: "The signature parameter '#{signature}' and the generated parameter '#{actual_signature}' is not matched."
+            end
 
           end
 
           def check_parameter(name, value)
             if value.blank?
               Rails.logger.warn "The #{name} parameter is blank. Failed to validate URL by Wechat."
-              render status: :bad_request, text: ''
+              render status: :bad_request, text: "The #{name} parameter is required."
             end
             value.present?
           end

data/app/controllers/wechat/validator/server_validations_controller.rb

@@ -9,4 +9,8 @@ class Wechat::Validator::ServerValidationsController < ::Wechat::Validator::Appl
 
   end
 
+  def create
+    render text: ''
+  end
+
 end

data/config/routes.rb

@@ -1,9 +1,5 @@
 Wechat::Validator::Engine.routes.draw do
 
-  #scope module: 'wechat/validator' do
-  #  resources :server_validations, only: :index
-  #end
-
-  resources :server_validations, only: :index
+  resources :server_validations, only: [ :index, :create ]
 
 end

data/lib/wechat/validator/version.rb

@@ -1,5 +1,5 @@
 module Wechat
   module Validator
-    VERSION = '0.1'.freeze
+    VERSION = '0.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wechat-validator
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: '0.2'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-15 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,15 +30,16 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 description: The Wechat Validator engine handles the Wechat server validation requests.
+  微信验证器引擎处理微信服务器的验证请求。
 email:
 - topbit.du@gmail.com
 executables: []
@@ -83,6 +84,5 @@ rubyforge_project:
 rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
-summary: The Wechat Validator engine includes a concern and a controller to handle
-  the Wechat server validation request.
+summary: Wechat Validator Engine 微信验证器引擎
 test_files: []