wechat-validator 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2eb8f8ca2d42d8cde005149dd05c7d4ee67b9083
+  data.tar.gz: 32681763ef68e00239747c16c083e755ecb288ba
+SHA512:
+  metadata.gz: 65de9d152cd21a28ce08c0ea2c11f0d08f9bb2d5fbc7bd7932c1fc6c6f28ba0c51965ec807141dfd836b83778a76833743e51260312b59d2a6de4e75ae554504
+  data.tar.gz: 324f69a6cee1f88ca6c01152bdc118fc40e112c531fce36f97b8b1b4ee8fd1b32d4d9cdb620a42e36edddea170b72faf5ec5a6ea8b7041390d60cdeb7391fd03

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Topbit Du
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,4 @@
+# Wechat Validator 微信服务器验证器引擎
+
+The Wechat Server Validator Engine is an engine which handles the Wechat server validation requests.
+微信服务器验证引擎是一个处理微信服务器验证请求的引擎。

data/Rakefile

@@ -0,0 +1,24 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+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('lib/**/*.rb')
+end
+
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

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

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// 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.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

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

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * 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.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,2 @@
+class Wechat::Validator::ApplicationController < ActionController::Base
+end

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

@@ -0,0 +1,53 @@
+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: :forbidden, text: ''
+              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.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 : '')
+
+          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: ''
+            end
+            value.present?
+          end
+
+        end
+
+        module ClassMethods
+          # def method_name do end
+        end
+
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+class Wechat::Validator::ServerValidationsController < ::Wechat::Validator::ApplicationController
+
+  include ::Wechat::Validator::Concerns::SignatureChecker
+
+  def index
+
+    token = Rails.application.secrets.wechat_validation_token
+    check_signature token
+
+  end
+
+end

data/app/helpers/wechat/validator/application_helper.rb

@@ -0,0 +1,2 @@
+module Wechat::Validator::ApplicationHelper
+end

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

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Validator</title>
+  <%= stylesheet_link_tag    "validator/application", media: "all" %>
+  <%= javascript_include_tag "validator/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

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

data/lib/tasks/validator_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :validator do
+#   # Task goes here
+# end

data/lib/wechat/validator.rb

@@ -0,0 +1,6 @@
+require 'wechat/validator/engine'
+
+module Wechat
+  module Validator
+  end
+end

data/lib/wechat/validator/engine.rb

@@ -0,0 +1,21 @@
+module Wechat
+  module Validator
+
+    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
+
+  end
+end

data/lib/wechat/validator/version.rb

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: wechat-validator
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Topbit Du
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: wechat-validation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: The Wechat Validator engine handles the Wechat server validation requests.
+email:
+- topbit.du@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- 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/server_validations_controller.rb
+- app/helpers/wechat/validator/application_helper.rb
+- app/views/layouts/wechat/validator/application.html.erb
+- config/routes.rb
+- lib/tasks/validator_tasks.rake
+- lib/wechat/validator.rb
+- lib/wechat/validator/engine.rb
+- lib/wechat/validator/version.rb
+homepage: https://github.com/topbitdu/wechat-validator
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []