wechat-validator 0.3.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 544b1d0748f4dd1814c1000a2f6bba67eb75d395
-  data.tar.gz: c29c808358598ca9d7edc6e9062b530a22b50337
+  metadata.gz: 9e9283ec864182a64ebcfdb830e867177d1544f1
+  data.tar.gz: 4189ecacf67257f45c2b4622fef9515800bdb408
 SHA512:
-  metadata.gz: 405b0d2eab7d21cf3434b1770ccef44bdfe1c3e950834d198cafd473189a233442dbffe05332070c8f0d46e844f7977c8a3d5368c41374ef2896f49a93a03438
-  data.tar.gz: 6a5aa6da41e11bb1f2f7659c9c08949cfa3215ee87bfc594e82541dc1a0ea8e3fe2d71dfe2d30940da5a098f1e51ab6554ea75d4310a470f4566568f024abca7
+  metadata.gz: 58119aca68cebfdc5c9e1ef7ab238c05a59b40caccfa18bb1daaa3c99e2179143957c437c82700e80a5b33a392bf27c7616e8ab398dbf40f22b0626dad14ea8a
+  data.tar.gz: 044a8aa4563581fee9227e1ae2ad5cadb0a319143c38bb9ccffb35f8c32bc947ad833ddbcdb65f12df814acb6a7c72fd1c54379518283dd54f1886f982ef1087

data/README.md

@@ -1,16 +1,25 @@
 # Wechat Validator 微信服务器验证器引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/wechat-validator/frames)
 [![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)
+[![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/wechat-validator.svg)](https://gemnasium.com/github.com/topbitdu/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)请求的引擎。
 
+
+
 ## Recent Update
+
 Check out the [Road Map](ROADMAP.md) to find out what's the next.
 Check out the [Change Log](CHANGELOG.md) to find out what's new.
 
+
+
 ## Usage
+
 In the application's /config/routes.rb file, add the following line:
 ```ruby
 mount Wechat::Validator::Engine, at: '/wechat-validator'

data/Rakefile

@@ -10,7 +10,7 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title    = 'Validator'
   rdoc.options << '--line-numbers'
-  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('README.md')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
 
@@ -20,5 +20,5 @@ load 'rails/tasks/statistics.rake'
 
 
 
-Bundler::GemHelper.install_tasks
+require 'bundler/gem_tasks'
 

data/app/assets/config/wechat-validator_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/wechat/validator .js
+//= link_directory ../stylesheets/wechat/validator .css

data/app/assets/javascripts/wechat/validator/application.js

@@ -5,7 +5,7 @@
 // or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
 //
 // It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
-// compiled file.
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
 //
 // Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
 // about supported directives.

data/app/assets/stylesheets/wechat/validator/application.css

@@ -6,9 +6,9 @@
  * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
  *
  * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any styles
- * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
- * file per style scope.
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
  *
  *= require_self
  */

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

@@ -1,2 +1,6 @@
+##
+# Application controller 是模块内所有控制器的基类。
+
 class Wechat::Validator::ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
 end

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

@@ -1,8 +1,11 @@
+##
+# Signature Validator 是微信签名验证的领域逻辑关注点。
+
 module Wechat::Validator::Concerns::SignatureValidator
 
   extend ActiveSupport::Concern
 
-  self.included do |includer|
+  included do |includer|
 
     def validate_signature(token)
 
@@ -22,7 +25,7 @@ module Wechat::Validator::Concerns::SignatureValidator
       return unless validate_parameter 'signature', signature
       return unless validate_parameter 'echo',      echo
 
-      actual_signature  = Wechat::Validation::Signature.create nonce, timestamp, token # ::Wechat::Validation.sign nonce, timestamp, token
+      actual_signature  = Wechat::Validation::Signature.create 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}."
 
@@ -45,7 +48,6 @@ module Wechat::Validator::Concerns::SignatureValidator
   end
 
   module ClassMethods
-    # def method_name do end
   end
 
 end

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

@@ -1,11 +1,11 @@
 class Wechat::Validator::ServerValidationsController < ::Wechat::Validator::ApplicationController
 
-  include ::Wechat::Validator::Concerns::SignatureChecker
+  include ::Wechat::Validator::Concerns::SignatureValidator
 
   def index
 
     token = Rails.application.secrets.wechat_validation_token
-    check_signature token
+    validate_signature token
 
   end
 
@@ -13,4 +13,4 @@ class Wechat::Validator::ServerValidationsController < ::Wechat::Validator::Appl
     render text: ''
   end
 
-end
+end

data/app/jobs/wechat/validator/application_job.rb

@@ -0,0 +1,5 @@
+##
+# Application job 是模块内所有异步任务的基类。
+
+class Wechat::Validator::ApplicationJob < ActiveJob::Base
+end

data/app/mailers/wechat/validator/application_mailer.rb

@@ -0,0 +1,7 @@
+##
+# Application mailer 是模块内所有电子邮件发送类的基类。
+
+class Wechat::Validator::ApplicationMailer < ActionMailer::Base
+  default from: 'from@example.com'
+  layout 'mailer'
+end

data/app/models/wechat/validator/application_record.rb

@@ -0,0 +1,6 @@
+##
+# Application record 是模块内所有模型的抽象基类。
+
+class Wechat::Validator::ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/app/views/layouts/wechat/validator/application.html.erb

@@ -1,8 +1,8 @@
 <!DOCTYPE html>
 <html>
 <head>
-  <title>Validator</title>
-  <%= stylesheet_link_tag    "validator/application", media: "all" %>
+  <title>Wechat Validator</title>
+  <%= stylesheet_link_tag "wechat/validator/application", media: "all" %>
   <%= csrf_meta_tags %>
 </head>
 <body>

data/lib/wechat/validator/engine.rb

@@ -3,16 +3,6 @@ module Wechat
 
     class Engine < ::Rails::Engine
 
-      config.autoload_paths += %W(
-        #{config.root}/lib
-        #{config.root}/app/controllers/wechat/validator/concerns
-      )
-
-      config.eager_load_paths += %W(
-        #{config.root}/lib
-        #{config.root}/app/controllers/wechat/validator/concerns
-      )
-
       isolate_namespace Wechat::Validator
 
     end

data/lib/wechat/validator/version.rb

@@ -1,5 +1,5 @@
 module Wechat
   module Validator
-    VERSION = '0.3.1'.freeze
+    VERSION = '0.3.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wechat-validator
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-29 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -28,16 +28,22 @@ dependencies:
   name: wechat-validation
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.1
 description: The Wechat Validator engine handles the Wechat server validation requests.
   微信验证器引擎处理微信服务器的验证请求。
 email:
@@ -49,13 +55,16 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/config/wechat-validator_manifest.js
 - app/assets/javascripts/wechat/validator/application.js
 - app/assets/stylesheets/wechat/validator/application.css
 - app/controllers/wechat/validator/application_controller.rb
-- app/controllers/wechat/validator/concerns/signature_checker.rb
 - app/controllers/wechat/validator/concerns/signature_validator.rb
 - app/controllers/wechat/validator/server_validations_controller.rb
 - app/helpers/wechat/validator/application_helper.rb
+- app/jobs/wechat/validator/application_job.rb
+- app/mailers/wechat/validator/application_mailer.rb
+- app/models/wechat/validator/application_record.rb
 - app/views/layouts/wechat/validator/application.html.erb
 - config/routes.rb
 - lib/tasks/validator_tasks.rake

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

@@ -1,62 +0,0 @@
-module Wechat
-  module Validator
-    module Concerns
-
-      module SignatureChecker
-
-        extend ActiveSupport::Concern
-
-        self.included do |includer|
-
-          def check_signature(token)
-
-            if token.blank?
-              Rails.logger.warn 'Token is required to validate URL by Wechat.'
-              render status: :bad_request, text: 'The token parameter is required.'
-              return
-            end
-
-            timestamp = params[:timestamp]
-            nonce     = params[:nonce]
-            signature = params[:signature]
-            echo      = params[:echostr]
-
-            return unless check_parameter 'timestamp', timestamp
-            return unless check_parameter 'nonce',     nonce
-            return unless check_parameter 'signature', signature
-            return unless check_parameter 'echo',      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: :bad_request, 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: "The #{name} parameter is required."
-            end
-            value.present?
-          end
-
-          deprecate check_signature: :'Wechat::Validator::Concerns::SignatureValidator.validate_signature', deprecator: ActiveSupport::Deprecation.new('1.0', 'wechat-validator')
-          deprecate check_parameter: :'Wechat::Validator::Concerns::SignatureValidator.validate_parameter', deprecator: ActiveSupport::Deprecation.new('1.0', 'wechat-validator')
-
-        end
-
-        module ClassMethods
-          # def method_name do end
-        end
-
-      end
-
-    end
-  end
-end