weixin_rails_middleware 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 381fcd2eb890939d2b4cd3c6738aa2ef2ce38982
-  data.tar.gz: 1eaf214d92befdd0e3646eba489264526fabdf90
+  metadata.gz: f864df00b4c607bd3d9c96217d8a448ca8d4b9ff
+  data.tar.gz: cf2e9c7be77b62d6e7bdb87c70eaad6351e2b00d
 SHA512:
-  metadata.gz: 80698d8806763968e4c432b143c3229a67fd6740ff7b8b53596fe763d06cd668e5e34847151d5df6c04d485d460ed24eec3ddd8cf89ce7e326e81fb33a41cb50
-  data.tar.gz: 3b08680f1058874ec2f6e39798ad1cc05b5075abc998d6423398ef06afe098e40057068cafdfa9c657284793f589a16096779ed29ce2426bb4aad4645bf25d20
+  metadata.gz: ae8b8f0bd47219fe7876db2d728334d7c269320ab3b2a71a77ce1290f46baf3046ab765d2f3226ce1ce807e1ea8f5929536d688fac6fb8fd75cbfe451300a5a0
+  data.tar.gz: a674a9bfa8f46348b62aaa51cc15613544449f82ac40a5c8c725f3bf2e42b431e03f042c51d3a0ff4553e6a12efc0ecdf3180dd675f6e37f933af53a79776950

data/app/controllers/weixin_rails_middleware/weixin_controller.rb

@@ -1,8 +1,9 @@
 module WeixinRailsMiddleware
-  class WeixinController < ApplicationController
-    include WeixinMessageHelper
+  class WeixinController < ActionController::Base
+    include ReplyWeixinMessageHelper
+    include ConfigurationHelpers
 
-    skip_before_filter :verify_authenticity_token
+    skip_before_action :verify_authenticity_token
     before_action :check_weixin_params, only: [:index, :reply]
     before_action :set_weixin_public_account, :set_weixin_message, only: :reply
 
@@ -16,22 +17,20 @@ module WeixinRailsMiddleware
     protected
 
       def check_weixin_params
-        if check_weixin_token_valid?
-          if !is_hexdigest?
-            render text: "Forbidden", status: 403
-          end
+        if check_weixin_token_valid? && !is_hexdigest?
+          render text: "Forbidden", status: 403
         end
       end
 
       # check the token from Weixin Service is exist in local store.
       def check_weixin_token_valid?
-        if WeixinRailsMiddleware.config.token_string.blank?
+        if token_string.blank?
           if token_model_instance.blank?
             render text: "Forbidden", status: 403
             return false
           end
         else
-          if current_weixin_token != WeixinRailsMiddleware.config.token_string
+          if current_weixin_token != token_string
             render text: "Forbidden", status: 403
             return false
           end
@@ -42,26 +41,16 @@ module WeixinRailsMiddleware
       def is_hexdigest?
         signature = params[:signature] || ''
         timestamp = params[:timestamp] || ''
-        nonce     = params[:nonce] || ''
+        nonce     = params[:nonce]     || ''
         current_signature = Digest::SHA1.hexdigest([current_weixin_token, timestamp, nonce].sort.join)
         return true if current_signature == signature
         false
       end
 
-      def current_weixin_token
-        @weixin_token = params[:weixin_token]
-      end
-
-      def token_model_instance
-        token_model  = WeixinRailsMiddleware.config.token_model_class
-        token_column = WeixinRailsMiddleware.config.token_column
-        token_model_instance = token_model.where("#{token_column}" => current_weixin_token).first
-        token_model_instance
-      end
-
+      ## Callback
       # e.g. will generate +@weixin_public_account+
       def set_weixin_public_account
-        return nil if WeixinRailsMiddleware.config.token_string.present?
+        return nil if token_string.present?
         @weixin_public_account ||= token_model_instance
       end
 
@@ -70,14 +59,18 @@ module WeixinRailsMiddleware
         @weixin_message ||= current_weixin_message
       end
 
-      # take the weixin params
-      def current_weixin_params
-        request.body.read
+      def current_weixin_token
+        @weixin_token = params[:weixin_token]
+      end
+
+      def token_model_instance
+        token_model_instance = token_model_class.where("#{token_column}" => current_weixin_token).first
+        token_model_instance
       end
 
       # return a message class with current_weixin_params
       def current_weixin_message
-        Message.factory(current_weixin_params)
+        Message.factory(request.body.read)
       end
 
   end

data/lib/generators/templates/initializer.rb

@@ -2,19 +2,21 @@
 WeixinRailsMiddleware.configure do |config|
 
   ## NOTE:
-  ## if you config all them, it will use `token_string` default
+  ## If you config all them, it will use `token_string` default
   ##
-  # Th FIRST configure
-  # if you config `token_model`, it will use it to find_by_weixin_token
-  # you must config a column name, `weixin_token` default
-  # config.token_model  = "" # ActiveRecord subclass or other ORM subclass
+  # Th first configure is fit for your weixin public_account is saved in database.
+  # +token_model+ and +token_column+ must in the same table.
+  # +token_model+ The class name that to save your public_account
+  # +token_column+ You can config a column name Optional, but you must have a column `weixin_token` default.
+  # config.token_model  = ""
   # config.token_column = "weixin_token"
 
-  # OR the SECOND configure
-  # if you config `token_string`, so it will directly use it
+  # Or the other configure is fit for only one weixin public_account
+  # If you config `token_string`, so it will directly use it
   # config.token_string = "token string"
 
-  # router
+  # Router
+  # Default is "/", and recommend you use default directly.
   # config.engine_path = "/"
 
 end

data/lib/generators/templates/weixin_controller.rb

@@ -10,7 +10,6 @@ WeixinRailsMiddleware::WeixinController.class_eval do
 
     def response_text_message(options={})
       reply_text_message("Your Message: #{@weixin_message.Content}")
-
     end
 
     def response_location_message(options={})

data/lib/weixin_rails_middleware/configuration.rb

@@ -9,14 +9,36 @@ module WeixinRailsMiddleware
       @token_column = DEFAULT_TOKEN_COLUMN_NAME
     end
 
+  end
+
+  module ConfigurationHelpers
+    extend ActiveSupport::Concern
+
+    def engine_path
+      @engine_path ||= WeixinRailsMiddleware.config.engine_path
+    end
+
+    def token_string
+      @token_string ||= WeixinRailsMiddleware.config.token_string.to_s
+    end
+
+    def token_column
+      @token_column ||= WeixinRailsMiddleware.config.token_column
+    end
+
+    def token_model
+      @token_model ||= WeixinRailsMiddleware.config.token_model
+    end
+
+    def is_default_engine_path?
+      engine_path == DEFAULT_ENGINE_PATH # "/"
+    end
+
     def token_model_class
-      raise "You need to config `token_model` in config/initializers/weixin_rails_middleware.rb" if token_model.blank?
-      token_model_c = token_model.constantize
-      unless token_model_c.table_exists?
-        raise "You don't have #{token_model_c.table_name} table"
+      if token_model.blank?
+        raise "You need to config `token_model` in 'config/initializers/weixin_rails_middleware.rb'"
       end
-      token_model_c
+      @token_model_c ||= token_model.constantize
     end
-
   end
 end

data/lib/weixin_rails_middleware/engine.rb

@@ -1,5 +1,14 @@
 module WeixinRailsMiddleware
   class Engine < ::Rails::Engine
+    include ConfigurationHelpers
+
     isolate_namespace WeixinRailsMiddleware
+
+    config.after_initialize do
+      if token_model_class.present?
+        token_model_class.send(:include, WeixinServerUrl::InstanceMethods)
+      end
+    end
+
   end
-end
+end

data/lib/weixin_rails_middleware/{weixin_message_helper.rb → helpers/reply_weixin_message_helper.rb}

@@ -1,5 +1,5 @@
 module WeixinRailsMiddleware
-  module WeixinMessageHelper
+  module ReplyWeixinMessageHelper
 
     # e.g.
     # reply_text_message(@weixin_message.ToUserName, @weixin_message.FromUserName, "Your Message: #{@weixin_message.Content}")

data/lib/weixin_rails_middleware/{unique_token_helper.rb → helpers/unique_token_helper.rb}

@@ -1,5 +1,5 @@
 module WeixinRailsMiddleware
-  module UniqueToken
+  module UniqueTokenHelper
     def self.generate(options = {})
       # SecureRandom: hex, base64, random_bytes, urlsafe_base64, random_number, uuid
       generator_method_type = options.delete(:generator).try(:to_sym) || :hex
@@ -14,4 +14,4 @@ module WeixinRailsMiddleware
   end
 end
 
-WeiXinUniqueToken = WeixinRailsMiddleware::UniqueToken
+WeiXinUniqueToken = WeixinRailsMiddleware::UniqueTokenHelper

data/lib/weixin_rails_middleware/helpers/weixin_server_url.rb

@@ -0,0 +1,69 @@
+# TODO: added weixin_server_url for User
+# if config +token_model+, e.g. user = User.first; user.weixin_server_url
+# if config +token_string+, e.g. weixin_server_url
+# a public url looks like: weixin_server_url
+module WeixinRailsMiddleware
+  module WeixinServerUrl
+
+    module Base
+
+      private
+
+        def weixin_server_url_with_public_account(public_account)
+          base_host_url + current_token(public_account)
+        end
+
+        def weixin_server_url_without_public_account
+          base_host_url + token_string
+        end
+
+        def current_token(public_account)
+          if public_account.blank?
+            token_string
+          else
+            public_account.try(token_column)
+          end
+        end
+
+        def base_host_url
+          host_url = request.base_url
+          if is_default_engine_path? # "/"
+            "#{host_url}/weixin/"
+          else
+            "#{host_url}/#{engine_path}/weixin/"
+          end
+        end
+    end
+
+    module ViewHelpers
+      extend ActiveSupport::Concern
+      include ConfigurationHelpers
+      include Base
+      included do
+        def weixin_server_url(public_account=nil)
+          raise "You need pass a public_account instance." if token_string.blank? && public_account.blank?
+          if public_account.present?
+            weixin_server_url_with_public_account(public_account)
+          else
+            weixin_server_url_without_public_account(public_account)
+          end
+        end
+      end
+
+    end
+
+    module InstanceMethods
+      extend ActiveSupport::Concern
+      include ConfigurationHelpers
+      include Base
+      included do
+        def weixin_server_url
+          # base_host_url + self.send(token_column)
+          warn "Hi, this method is Pending, please use view helper: +weixin_server_url+ :)"
+        end
+      end
+    end
+  end
+end
+
+ActionView::Base.send :include, WeixinRailsMiddleware::WeixinServerUrl::ViewHelpers

data/lib/weixin_rails_middleware/{weixin_token_form_helper.rb → helpers/weixin_token_form_helper.rb}

@@ -10,11 +10,12 @@ module ActionView
           @options = {value: generate_weixin_token }.merge!(@options)
           super
         end
+
         private
 
-         def generate_weixin_token
-          @options.fetch("value"){value_before_type_cast(object)} || WeiXinUniqueToken.generate
-         end
+          def generate_weixin_token
+            @options.fetch("value"){value_before_type_cast(object)} || WeiXinUniqueToken.generate
+          end
       end
     end # end of Tags
 

data/lib/weixin_rails_middleware/{message.rb → models/message.rb}

@@ -27,7 +27,7 @@ module WeixinRailsMiddleware
       @source.MsgId.to_i
     end
 
-    def Message.factory(xml)
+    def self.factory(xml)
       hash = MultiXml.parse(xml)['xml']
       case hash['MsgType']
       when 'text'

data/lib/weixin_rails_middleware/{reply_message.rb → models/reply_message.rb}

@@ -9,10 +9,10 @@ module WeixinRailsMiddleware
     xml_name :xml
     #xml_convention :camelcase
 
-    xml_accessor :ToUserName, :cdata => true
+    xml_accessor :ToUserName, :cdata   => true
     xml_accessor :FromUserName, :cdata => true
-    xml_reader :CreateTime, :as => Integer
-    xml_reader :MsgType, :cdata => true
+    xml_reader   :CreateTime, :as => Integer
+    xml_reader   :MsgType, :cdata => true
 
     def initialize
       @CreateTime = Time.now.to_i
@@ -34,8 +34,8 @@ module WeixinRailsMiddleware
   class TextReplyMessage < ReplyMessage
     xml_accessor :Content, :cdata => true
     def initialize
-        super
-        @MsgType = 'text'
+      super
+      @MsgType = 'text'
     end
   end
 
@@ -43,7 +43,7 @@ module WeixinRailsMiddleware
     include ROXML
     xml_accessor :Title, :cdata => true
     xml_accessor :Description, :cdata => true
-    xml_accessor :MusicUrl, :cdata => true
+    xml_accessor :MusicUrl,   :cdata => true
     xml_accessor :HQMusicUrl, :cdata => true
   end
 
@@ -74,7 +74,7 @@ module WeixinRailsMiddleware
     xml_accessor :Title, :cdata => true
     xml_accessor :Description, :cdata => true
     xml_accessor :PicUrl, :cdata => true
-    xml_accessor :Url, :cdata => true
+    xml_accessor :Url,    :cdata => true
   end
 
   # <xml>
@@ -180,4 +180,4 @@ module WeixinRailsMiddleware
     end
   end
 
-end
+end

data/lib/weixin_rails_middleware/version.rb

@@ -1,3 +1,3 @@
 module WeixinRailsMiddleware
-  VERSION = "1.0.3"
+  VERSION = "1.0.4".freeze
 end

data/lib/weixin_rails_middleware.rb

@@ -1,11 +1,11 @@
-require "weixin_rails_middleware/engine"
 require "weixin_rails_middleware/configuration"
-require "weixin_rails_middleware/message"
-require "weixin_rails_middleware/reply_message"
-require "weixin_rails_middleware/weixin_message_helper"
-require "weixin_rails_middleware/weixin_token_form_helper"
-require "weixin_rails_middleware/unique_token_helper"
-require "weixin_rails_middleware/weixin_server_url"
+require "weixin_rails_middleware/engine"
+require "weixin_rails_middleware/models/message"
+require "weixin_rails_middleware/models/reply_message"
+require "weixin_rails_middleware/helpers/reply_weixin_message_helper"
+require "weixin_rails_middleware/helpers/weixin_token_form_helper"
+require "weixin_rails_middleware/helpers/unique_token_helper"
+require "weixin_rails_middleware/helpers/weixin_server_url"
 
 module WeixinRailsMiddleware
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weixin_rails_middleware
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - lanrion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-19 00:00:00.000000000 Z
+date: 2014-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -103,7 +103,6 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - Rakefile
-- app/controllers/weixin_rails_middleware/application_controller.rb
 - app/controllers/weixin_rails_middleware/weixin_controller.rb
 - config/routes.rb
 - lib/generators/templates/initializer.rb
@@ -113,13 +112,13 @@ files:
 - lib/weixin_rails_middleware.rb
 - lib/weixin_rails_middleware/configuration.rb
 - lib/weixin_rails_middleware/engine.rb
-- lib/weixin_rails_middleware/message.rb
-- lib/weixin_rails_middleware/reply_message.rb
-- lib/weixin_rails_middleware/unique_token_helper.rb
+- lib/weixin_rails_middleware/helpers/reply_weixin_message_helper.rb
+- lib/weixin_rails_middleware/helpers/unique_token_helper.rb
+- lib/weixin_rails_middleware/helpers/weixin_server_url.rb
+- lib/weixin_rails_middleware/helpers/weixin_token_form_helper.rb
+- lib/weixin_rails_middleware/models/message.rb
+- lib/weixin_rails_middleware/models/reply_message.rb
 - lib/weixin_rails_middleware/version.rb
-- lib/weixin_rails_middleware/weixin_message_helper.rb
-- lib/weixin_rails_middleware/weixin_server_url.rb
-- lib/weixin_rails_middleware/weixin_token_form_helper.rb
 homepage: http://github.com/lanrion/weixin_rails_middleware
 licenses: []
 metadata: {}

data/app/controllers/weixin_rails_middleware/application_controller.rb

@@ -1,4 +0,0 @@
-module WeixinRailsMiddleware
-  class ApplicationController < ActionController::Base
-  end
-end

data/lib/weixin_rails_middleware/weixin_server_url.rb

@@ -1,14 +0,0 @@
-module WeixinRailsMiddleware
-  module WeixinServerUrl
-    extend ActiveSupport::Concern
-
-    included do
-      def weixin_server_url
-        "http test"
-      end
-    end
-  end
-end
-
-
-