wechat-handler 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 40924815f5ce2a04783e1dc07d38029c5e8c2f24
-  data.tar.gz: b682066dbc4b3d50f1cd1a04eac5e5e71dace983
+  metadata.gz: 03e9e87d39249ad23c59ced49203f4e496988312
+  data.tar.gz: f08549b67f63f3b0f0166b8352c7d34a7c4926eb
 SHA512:
-  metadata.gz: 020d1584e552b658c372692250c3d3e0becb60983771e81e91bdde775bed5d4c832e7114196880dc1eee3ebf45dbef51cc6e6a7541bd41a2092b96b36530858c
-  data.tar.gz: bb26f6032ffe83cd628c7202e8e17f67f2536c550c58db7cb3331a6b4b2f0955ea0f73cc68950c82c93bc382823c2072b21f2b23aa982468a9c47d0e95dfe28b
+  metadata.gz: 35a59ad8dbdc65d41fe4cecedd5a9ca7fc1df4309764a09e165f4570c7c0af26a986cfbf0d2d3c46ad4368b0ed5be552761d02e4683e5f3e245b8e6dafd32461
+  data.tar.gz: 54323309fd7ff1f30af8f7d227ae80fcbe0a65807f0402b61bbfd84180ce240ce0b040d6b6a3f77d2abb179ef43bf805f6c37837f0f1ad094d5c3535596f4fa6

data/README.md

@@ -1,19 +1,24 @@
 # Wechat Handler 微信回调处理引擎
 
+[![Documentation](http://img.shields.io/badge/docs-rdoc.info-blue.svg)](http://www.rubydoc.info/gems/wechat-handler/frames)
 [![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)
+[![Dependency Status](https://gemnasium.com/badges/github.com/topbitdu/wechat-handler.svg)](https://gemnasium.com/github.com/topbitdu/wechat-handler)
 
 The Wechat Handler engine handles the Wechat event & message notifications. 微信回调处理引擎处理微信服务器发出的事件通知和消息通知。
 
 
 
 ## 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 Gemfile
+
 ```ruby
 gem 'wechat-handler'
 ```
@@ -21,6 +26,7 @@ gem 'wechat-handler'
 
 
 ## Include the controller concern
+
 ```ruby
 include Wechat::Handler::Concerns::Dispatcher
 

data/Rakefile

@@ -10,7 +10,7 @@ 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('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-handler_manifest.js

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

data/app/assets/javascripts/wechat/handler/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/handler/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/handler/application_controller.rb

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

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

@@ -1,8 +1,11 @@
+##
+# Dispatcher 是分发微信回调消息的关注点。
+
 module Wechat::Handler::Concerns::Dispatcher
 
   extend ActiveSupport::Concern
 
-  self.included do |includer|
+  included do |includer|
 
     skip_before_filter :verify_authenticity_token
 
@@ -33,8 +36,8 @@ module Wechat::Handler::Concerns::Dispatcher
         Rails.logger.info "The encoded_message is #{encoded_message.inspect}."
         render status: :bad_request, 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
+        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
@@ -47,7 +50,7 @@ module Wechat::Handler::Concerns::Dispatcher
 
       end
 
-      pairs = ::Wechat::Callback::XmlDocument.load xml_text
+      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
@@ -57,30 +60,30 @@ module Wechat::Handler::Concerns::Dispatcher
         Rails.logger.warn "The #{includer} does not have the #on_event method."
       end
 
-      replying_xml_text = ::Wechat::Callback::XmlDocument.create replying_pairs
+      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
+        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
+        replying_xml_text = Wechat::Callback::XmlDocument.create encrypted_replying_pairs
 
         # debugging
-        debugging_pairs = ::Wechat::Callback::XmlDocument.load replying_xml_text
+        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
+        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
+        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
@@ -102,14 +105,14 @@ module Wechat::Handler::Concerns::Dispatcher
     end
 
     def check_signature(signature, nonce, timestamp)
-      actual  = ::Wechat::Callback::Signature.create wechat_token, timestamp, nonce
+      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
+      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

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

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

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

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

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

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

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

@@ -2,14 +2,14 @@
 <html>
 <head>
   <title>Wechat Handler</title>
-  <%= stylesheet_link_tag    "handler/application", media: "all" %>
+  <%= stylesheet_link_tag 'wechat/handler/application', media: "all" %>
   <%= csrf_meta_tags %>
 </head>
 <body>
 
 <%= yield %>
 
-<%= javascript_include_tag 'handler/application' %>
+<%= javascript_include_tag 'wechat/handler/application' %>
 
 </body>
 </html>

data/lib/wechat/handler/version.rb

@@ -1,5 +1,5 @@
 module Wechat
   module Handler
-    VERSION = '0.1.1'.freeze
+    VERSION = '0.1.2'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wechat-handler
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.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
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !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
@@ -77,11 +63,15 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/config/wechat-handler_manifest.js
 - 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/jobs/wechat/handler/application_job.rb
+- app/mailers/wechat/handler/application_mailer.rb
+- app/models/wechat/handler/application_record.rb
 - app/views/layouts/wechat/handler/application.html.erb
 - config/routes.rb
 - lib/tasks/handler_tasks.rake