wechat-handler 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4f58d3fada36dad1133f0882822070b16de16e6e
+  data.tar.gz: eab5f5defb50d796139a000bde5e0253648e157b
+SHA512:
+  metadata.gz: e241748b05535822352f4c27fce061d73b321abdbf1e0c13ce6aa47b53176015b2029da6fbdd61f1797290d147bd6f64fd050ed34cccbeccc6fd884817190bab
+  data.tar.gz: ca08de2459ac04634d100f2e6b3417f3ec9598a4e2aaeca0fae19f193d7887c8859358a4c277535db3aa80291bd81a732a30700e77cfff00831d37b4c1002ef2

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,22 @@
+# Wechat Handler 微信回调处理引擎
+
+[![License](https://img.shields.io/badge/license-MIT-green.svg)](http://opensource.org/licenses/MIT)
+[![Gem Version](https://badge.fury.io/rb/wechat-handler.svg)](https://badge.fury.io/rb/wechat-handler)
+
+The Wechat Handler engine handles the Wechat event & message notifications. 微信回调处理引擎处理微信服务器发出的事件通知和消息通知。
+
+## Usage in Gemfile
+```ruby
+gem 'wechat-handler'
+```
+
+## Include the controller concern
+```ruby
+include ::Wechat::Handler::Concerns::Dispatcher
+
+def on_event(pairs)
+  { 'MsgType' => 'text', 'Content' => 'Aloha!' }
+end
+```
+
+The Dispatcher handles the ToUserName, the FromUserName, and the CreateTime automatically.

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    = 'Wecaht Handler'
+  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/handler/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/handler/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/handler/application_controller.rb

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

data/app/controllers/wechat/handler/concerns/dispatcher.rb

@@ -0,0 +1,153 @@
+module Wechat::Handler::Concerns::Dispatcher
+
+  extend ActiveSupport::Concern
+
+  self.included do |includer|
+
+    skip_before_filter :verify_authenticity_token
+
+    def create
+
+      signature         = params[:signature]
+      timestamp         = params[:timestamp]
+      nonce             = params[:nonce]
+      encrypt_type      = params[:encrypt_type] # aes
+      message_signature = params[:msg_signature]
+
+      xml_text            = nil
+      replying_encryption = 'raw'
+      request_body        = request.body.read
+      Rails.logger.warn '  >> The request.body is as the following:'
+      Rails.logger.warn request_body
+
+      if encrypt_type.blank? || 'raw'==encrypt_type
+
+        xml_text = request_body
+
+      elsif 'aes'==encrypt_type
+
+        replying_encryption = 'aes'
+
+        render text: 'sign_error' and return unless check_signature(signature, nonce, timestamp)
+        encoded_message = ::Wechat::Callback::XmlDocument.load(request_body)['Encrypt']
+        Rails.logger.info "The encoded_message is #{encoded_message.inspect}."
+        render text: 'msg_sign_error' and return unless check_message_signature(message_signature, encoded_message, nonce, timestamp)
+
+        message = ::Wechat::Callback::MessageDecryption.create encoded_message, Rails.application.secrets.wechat_encoding_aes_keys
+        random_bytes, xml_size, xml_text, app_id, padding_bytes = ::Wechat::Callback::SecureMessage.load message
+        Rails.logger.warn "  >> Wechat Callback >> Message Controller >> App ID of the Secure Message = #{app_id}."
+        Rails.logger.warn '  >> Wechat Callback >> Message Controller >> XML Text of the Secure Message ='
+        Rails.logger.warn xml_text
+        render text: 'app_id_error' and return unless check_app_id(app_id)
+
+      else
+
+        render text: "Encrypt type #{encrypt_type} is not suppored"
+        return
+
+      end
+
+      pairs = ::Wechat::Callback::XmlDocument.load xml_text
+      replying_pairs = { 'ToUserName' => pairs['FromUserName'], 'FromUserName' => pairs['ToUserName'], 'CreateTime' => Time.now.to_i }
+
+      if respond_to? :on_event
+        replied_pairs  = on_event pairs
+        replying_pairs = replying_pairs.merge! replied_pairs
+      else
+        Rails.logger.warn "The #{includer} does not have the #on_event method."
+      end
+
+      #replying_pairs    = {
+      #    'ToUserName'   => pairs['FromUserName'],
+      #    'FromUserName' => pairs['ToUserName'],
+      #    'CreateTime'   => Time.now.to_i,
+      #    'MsgType'      => 'text',
+      #    'Content'      => '是紫色的。'
+      #  }
+      replying_xml_text = ::Wechat::Callback::XmlDocument.create replying_pairs
+
+      if 'aes'==replying_encryption
+        random_bytes       = ::Wechat::Callback::RandomByteArray.create 16
+        plain_text         = ::Wechat::Callback::SecureMessage.create     random_bytes, replying_xml_text, wechat_app_id
+        encrypted          = ::Wechat::Callback::MessageEncryption.create plain_text,   wechat_encoding_aes_keys
+        replying_singature = ::Wechat::Callback::Signature.create         wechat_token, timestamp, nonce, encrypted
+        encrypted_replying_pairs = {
+            'Encrypt'      => encrypted,
+            'MsgSignature' => replying_singature,
+            'TimeStamp'    => timestamp,
+            'Nonce'        => nonce
+          }
+        replying_xml_text = ::Wechat::Callback::XmlDocument.create encrypted_replying_pairs
+
+        # debugging
+        debugging_pairs = ::Wechat::Callback::XmlDocument.load replying_xml_text
+        Rails.logger.warn '  >> Wechat Callback >> Message Controller >> Debugging Pairs ='
+        Rails.logger.warn debugging_pairs.inspect
+        debugging_encrypted_message = debugging_pairs['Encrypt']
+        debugging_decrypted_message = ::Wechat::Callback::MessageDecryption.create debugging_encrypted_message, wechat_encoding_aes_keys
+        Rails.logger.warn '  >> Wechat Callback >> Message Controller >> Debugging Decrypted Message ='
+        Rails.logger.warn debugging_decrypted_message
+        debugging_random_bytes, debugging_xml_size, debugging_xml_text, debugging_app_id, debugging_padding_bytes = ::Wechat::Callback::SecureMessage.load debugging_decrypted_message
+        Rails.logger.warn "  >> Wechat Callback >> Message Controller >> Debugging App ID of the Secure Message = #{debugging_app_id}."
+        Rails.logger.warn '  >> Wechat Callback >> Message Controller >> Debugging XML Text of the Secure Message ='
+        Rails.logger.warn debugging_xml_text
+
+      end
+      Rails.logger.warn '  >> The Replying XML Text is as the following:'
+      Rails.logger.warn replying_xml_text
+
+      render status: 200, xml: replying_xml_text
+
+    end
+
+    def check_parameter(name, value)
+      if value.blank?
+        Rails.logger.warn "The #{name} parameter is blank. Failed to validate URL by Wechat."
+        render text: ''
+      end
+      value.present?
+    end
+
+    def check_signature(signature, nonce, timestamp)
+      actual  = ::Wechat::Callback::Signature.create wechat_token, timestamp, nonce
+      matched = signature==actual
+      Rails.logger.warn "Actual signature is #{actual}, which does not equal to the given signature #{signature}." unless matched
+      matched
+    end
+
+    def check_message_signature(message_signature, encoded_message, nonce, timestamp)
+      actual  = ::Wechat::Callback::MessageSignature.create encoded_message, wechat_token, timestamp, nonce
+      matched = message_signature==actual
+      Rails.logger.warn "Actual message signature is #{actual}, which does not equal to the given message signature #{message_signature}." unless matched
+      matched
+    end
+
+    def check_app_id(app_id)
+      matched = wechat_app_id==app_id
+      Rails.logger.warn "Actual App ID is #{wechat_app_id}, which does not equal to the given App ID #{app_id}." unless matched
+      matched
+    end
+
+    def wechat_token
+      @token = @token||Rails.application.secrets.wechat_validation_token
+      Rails.logger.warn 'Please configure "wechat_validation_token" in the /config/secrets.yml file. Failed to validate URL by Wechat.' if @token.blank?
+      @token
+    end
+
+    def wechat_app_id
+      @app_id = @app_id||Rails.application.secrets.wechat_app_id
+      Rails.logger.warn 'Please configure "wechat_app_id" in the /config/secrets.yml file. Failed to validate URL by Wechat.' if @app_id.blank?
+      @app_id
+    end
+
+    def wechat_encoding_aes_keys
+      @encoding_aes_keys = @encoding_aes_keys||Rails.application.secrets.wechat_encoding_aes_keys
+      Rails.logger.warn 'Please configure "encoding_aes_keys" in the /config/secrets.yml file. Failed to validate URL by Wechat.' if @encoding_aes_keys.blank?
+      @encoding_aes_keys
+    end
+
+    private :check_parameter, :check_signature, :wechat_token
+
+  end
+
+end

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

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

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

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

data/config/routes.rb

@@ -0,0 +1,2 @@
+Wechat::Handler::Engine.routes.draw do
+end

data/lib/tasks/handler_tasks.rake

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

data/lib/wechat/handler.rb

@@ -0,0 +1,6 @@
+require 'wechat/handler/engine'
+
+module Wechat
+  module Handler
+  end
+end

data/lib/wechat/handler/engine.rb

@@ -0,0 +1,11 @@
+module Wechat
+  module Handler
+
+    class Engine < ::Rails::Engine
+
+      isolate_namespace Wechat::Handler
+
+    end
+
+  end
+end

data/lib/wechat/handler/version.rb

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

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: wechat-handler
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Topbit Du
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-29 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.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: wechat-validator
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: wechat-callback
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: Wechat Handler engine handles the Wechat event & message notifications.
+  微信回调处理引擎处理微信服务器发出的事件通知和消息通知。
+email:
+- topbit.du@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/wechat/handler/application.js
+- app/assets/stylesheets/wechat/handler/application.css
+- app/controllers/wechat/handler/application_controller.rb
+- app/controllers/wechat/handler/concerns/dispatcher.rb
+- app/helpers/wechat/handler/application_helper.rb
+- app/views/layouts/wechat/handler/application.html.erb
+- config/routes.rb
+- lib/tasks/handler_tasks.rake
+- lib/wechat/handler.rb
+- lib/wechat/handler/engine.rb
+- lib/wechat/handler/version.rb
+homepage: https://github.com/topbitdu/wechat-handler
+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: Wechat Handler Engine 微信回调处理引擎
+test_files: []