wx_ext 0.1.6 → 0.1.8

data/lib/wx_ext/api/menu.rb

@@ -10,40 +10,39 @@ module WxExt
     # User api of weixin.
     #
     # @author FuShengYang
-    module Menu
-      class << self
-
-        # Create menu via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Hash] menu_hash
-        # @return [Hash] Json based hash.
-        def create_menu(access_token, menu_hash)
-          url = 'https://api.weixin.qq.com/cgi-bin/menu/create'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, menu_hash.to_json)
-        end
+  module Menu
+      # Create menu via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Hash] menu_hash
+      # @return [Hash] Json based hash.
+      def create_menu(access_token, menu_hash)
+        url = 'https://api.weixin.qq.com/cgi-bin/menu/create'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, menu_hash.to_json)
+      end
 
-        # Get menus via get.
-        #
-        # @param [Enumerable<String>] access_token
-        # @return [Hash] Json based hash.
-        def menus(access_token)
-          url = 'https://api.weixin.qq.com/cgi-bin/menu/get'\
-                "?access_token=#{access_token}"
-          Helper.http_get(url, { accept: :json })
-        end
+      # Get menus via get.
+      #
+      # @param [Enumerable<String>] access_token
+      # @return [Hash] Json based hash.
+      def menus(access_token)
+        url = 'https://api.weixin.qq.com/cgi-bin/menu/get'\
+              "?access_token=#{access_token}"
+        Helper.http_get(url, { accept: :json })
+      end
 
-        # Del menu via get.
-        #
-        # @param [Enumerable<String>] access_token
-        # @return [Hash] Json based hash.
-        def del_menu(access_token)
-          url = 'https://api.weixin.qq.com/cgi-bin/menu/delete'\
-                "?access_token=#{access_token}"
-          Helper.http_get(url, { accept: :json })
-        end
+      # Del menu via get.
+      #
+      # @param [Enumerable<String>] access_token
+      # @return [Hash] Json based hash.
+      def del_menu(access_token)
+        url = 'https://api.weixin.qq.com/cgi-bin/menu/delete'\
+              "?access_token=#{access_token}"
+        Helper.http_get(url, { accept: :json })
       end
+
+      extend self
     end
   end
 end

data/lib/wx_ext/api/msg.rb

@@ -10,42 +10,41 @@ module WxExt
     # User api of weixin.
     #
     # @author FuShengYang
-    module Qrcode
-      class << self
-
-        # Create ticket via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Hash] ticket_hash
-        # @return [Hash] Json based hash.
-        def create_ticket(access_token, ticket_hash)
-          url = 'https://api.weixin.qq.com/cgi-bin/qrcode/create'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, ticket_hash.to_json)
-        end
+  module Qrcode
+      # Create ticket via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Hash] ticket_hash
+      # @return [Hash] Json based hash.
+      def create_ticket(access_token, ticket_hash)
+        url = 'https://api.weixin.qq.com/cgi-bin/qrcode/create'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, ticket_hash.to_json)
+      end
 
-        # Get the qrcode via ticket.
-        #
-        # @param [Enumerable<String>] ticket
-        # @return [Hash] Json based hash.
-        def get_qrcode_by_ticket(ticket)
-          url = 'https://mp.weixin.qq.com/cgi-bin/showqrcode'\
-                "?ticket=#{ticket}"
-          Helper.http_get url
-        end
+      # Get the qrcode via ticket.
+      #
+      # @param [Enumerable<String>] ticket
+      # @return [Hash] Json based hash.
+      def get_qrcode_by_ticket(ticket)
+        url = 'https://mp.weixin.qq.com/cgi-bin/showqrcode'\
+              "?ticket=#{ticket}"
+        Helper.http_get url
+      end
 
-        # Long url to short url via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Enumerable<String>] action
-        # @param [Enumerable<String>] long_url
-        # @return [Hash] Json based hash.
-        def long_url_2_short(access_token, action='long2short', long_url)
-          url = 'https://api.weixin.qq.com/cgi-bin/shorturl'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, { action: action, long_url: long_url }.to_json)
-        end
+      # Long url to short url via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Enumerable<String>] action
+      # @param [Enumerable<String>] long_url
+      # @return [Hash] Json based hash.
+      def long_url_2_short(access_token, action='long2short', long_url)
+        url = 'https://api.weixin.qq.com/cgi-bin/shorturl'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, { action: action, long_url: long_url }.to_json)
       end
+
+      extend self
     end
   end
 end

data/lib/wx_ext/api/qrcode.rb

@@ -11,15 +11,15 @@ module WxExt
     #
     # @author FuShengYang
     module Msg
-      class << self
-        # Check the signature before send msg.
-        #
-        # @return [Boolean] Check the signature true or false.
-        def check_signature(signature, timestamp, nonce, token)
-          array = [token, timestamp, nonce].sort
-          signature == Digest::SHA1.hexdigest(array.join) ? true : false
-        end
+      # Check the signature before send msg.
+      #
+      # @return [Boolean] Check the signature true or false.
+      def check_signature(signature, timestamp, nonce, token)
+        array = [token, timestamp, nonce].sort
+        signature == Digest::SHA1.hexdigest(array.join) ? true : false
       end
+
+      extend self
     end
   end
 end

data/lib/wx_ext/api/semantic.rb

@@ -11,19 +11,18 @@ module WxExt
     #
     # @author FuShengYang
     module Semantic
-      class << self
-
-        # Create semantic search via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Hash] semantic_hash
-        # @return [Hash] Json based hash.
-        def semantic_search(access_token, semantic_hash)
-          url = 'https://api.weixin.qq.com/semantic/semproxy/search'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, semantic_hash.to_json)
-        end
+      # Create semantic search via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Hash] semantic_hash
+      # @return [Hash] Json based hash.
+      def semantic_search(access_token, semantic_hash)
+        url = 'https://api.weixin.qq.com/semantic/semproxy/search'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, semantic_hash.to_json)
       end
+
+      extend self
     end
   end
 end

data/lib/wx_ext/api/template_msg.rb

@@ -11,42 +11,41 @@ module WxExt
     #
     # @author FuShengYang
     module TemplateMsg
-      class << self
-
-        # Set the industry via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Enumerable<String>] industry_id1
-        # @param [Enumerable<String>] industry_id2
-        # @return [Hash] Json based hash.
-        def set_industry(access_token, industry_id1, industry_id2)
-          url = 'https://api.weixin.qq.com/cgi-bin/template/api_set_industry'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, { industry_id1: industry_id1, industry_id2: industry_id2 }.to_json)
-        end
+      # Set the industry via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Enumerable<String>] industry_id1
+      # @param [Enumerable<String>] industry_id2
+      # @return [Hash] Json based hash.
+      def set_industry(access_token, industry_id1, industry_id2)
+        url = 'https://api.weixin.qq.com/cgi-bin/template/api_set_industry'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, { industry_id1: industry_id1, industry_id2: industry_id2 }.to_json)
+      end
 
-        # Get the template ID via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Enumerable<String>] template_id_short
-        # @return [Hash] Json based hash.
-        def get_template_id(access_token, template_id_short)
-          url = 'https://api.weixin.qq.com/cgi-bin/template/api_add_template'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, { template_id_short: template_id_short })
-        end
+      # Get the template ID via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Enumerable<String>] template_id_short
+      # @return [Hash] Json based hash.
+      def get_template_id(access_token, template_id_short)
+        url = 'https://api.weixin.qq.com/cgi-bin/template/api_add_template'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, { template_id_short: template_id_short })
+      end
 
-        # Send the template msg via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Hash] template_msg_hash
-        # @return [Hash] Json based hash.
-        def send_template_msg(access_token, template_msg_hash)
-          url = 'https://api.weixin.qq.com/cgi-bin/message/template/send'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, template_msg_hash.to_json)
-        end
+      # Send the template msg via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Hash] template_msg_hash
+      # @return [Hash] Json based hash.
+      def send_template_msg(access_token, template_msg_hash)
+        url = 'https://api.weixin.qq.com/cgi-bin/message/template/send'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, template_msg_hash.to_json)
       end
+
+      extend self
     end
   end
 end

data/lib/wx_ext/api/user/group.rb

@@ -15,63 +15,63 @@ module WxExt
       #
       # @author FuShengYang
       module Group
-        class << self
-          # Create user group via post.
-          #
-          # @param [Enumerable<String>] access_token
-          # @param [Enumerable<String>] group_name
-          # @return [Hash] A json parse hash.
-          def create_group(access_token, group_name)
-            url = 'https://api.weixin.qq.com/cgi-bin/groups/create'\
-                  "?access_token=#{access_token}"
-            Helper.http_post(url, { group: { name: group_name } }.to_json)
-          end
+        # Create user group via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] group_name
+        # @return [Hash] A json parse hash.
+        def create_group(access_token, group_name)
+          url = 'https://api.weixin.qq.com/cgi-bin/groups/create'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, { group: { name: group_name } }.to_json)
+        end
 
-          # Get all groups via get.
-          #
-          # @param [Enumerable<String>] access_token
-          # @return [Hash] A json parse hash.
-          def groups(access_token)
-            url = 'https://api.weixin.qq.com/cgi-bin/groups/get'\
-                  "?access_token=#{access_token}"
-            Helper.http_get(url, { accept: :json }.to_json)
-          end
+        # Get all groups via get.
+        #
+        # @param [Enumerable<String>] access_token
+        # @return [Hash] A json parse hash.
+        def groups(access_token)
+          url = 'https://api.weixin.qq.com/cgi-bin/groups/get'\
+                "?access_token=#{access_token}"
+          Helper.http_get(url, { accept: :json }.to_json)
+        end
 
-          # Get user of group via post.
-          #
-          # @param [Enumerable<String>] access_token
-          # @param [Enumerable<String>] openid
-          # @return [Hash] A json parse hash.
-          def user_of_group(access_token, openid)
-            url = 'https://api.weixin.qq.com/cgi-bin/groups/getid'\
-                  "?access_token=#{access_token}"
-            Helper.http_post(url, { openid: openid }.to_json)
-          end
+        # Get user of group via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] openid
+        # @return [Hash] A json parse hash.
+        def user_of_group(access_token, openid)
+          url = 'https://api.weixin.qq.com/cgi-bin/groups/getid'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, { openid: openid }.to_json)
+        end
 
-          # Update user group name via post.
-          #
-          # @param [Enumerable<String>] access_token
-          # @param [Enumerable<String>] id
-          # @param [Enumerable<String>] name
-          # @return [Hash] A json parse hash.
-          def update_group_name(access_token, id, name)
-            url = 'https://api.weixin.qq.com/cgi-bin/groups/update'\
-                  "?access_token=#{access_token}"
-            Helper.http_post(url, { group: { id: id, name: name } }.to_json)
-          end
+        # Update user group name via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] id
+        # @param [Enumerable<String>] name
+        # @return [Hash] A json parse hash.
+        def update_group_name(access_token, id, name)
+          url = 'https://api.weixin.qq.com/cgi-bin/groups/update'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, { group: { id: id, name: name } }.to_json)
+        end
 
-          # Move user group via post.
-          #
-          # @param [Enumerable<String>] access_token
-          # @param [Enumerable<String>] openid
-          # @param [Enumerable<String>] to_groupid
-          # @return [Hash] A json parse hash.
-          def mv_user_group(access_token, openid, to_groupid)
-            url = 'https://api.weixin.qq.com/cgi-bin/groups/members/update'\
-                  "?access_token=#{access_token}"
-            Helper.http_post(url, { openid: openid, to_groupid: to_groupid }.to_json)
-          end
+        # Move user group via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] openid
+        # @param [Enumerable<String>] to_groupid
+        # @return [Hash] A json parse hash.
+        def mv_user_group(access_token, openid, to_groupid)
+          url = 'https://api.weixin.qq.com/cgi-bin/groups/members/update'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, { openid: openid, to_groupid: to_groupid }.to_json)
         end
+
+        extend self
       end
     end
   end

data/lib/wx_ext/api/user.rb

@@ -11,92 +11,91 @@ module WxExt
     #
     # @author FuShengYang
     module User
-      class << self
-
-        # Change the remark of user via post.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Enumerable<String>] openid
-        # @param [Enumerable<String>] remark
-        # @return [Hash] Json based hash.
-        def change_remark(access_token, openid, remark)
-          url = 'https://api.weixin.qq.com/cgi-bin/user/info/updateremark'\
-                "?access_token=#{access_token}"
-          Helper.http_post(url, { openid: openid, remark: remark }.to_json)
-        end
+      # Change the remark of user via post.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Enumerable<String>] openid
+      # @param [Enumerable<String>] remark
+      # @return [Hash] Json based hash.
+      def change_remark(access_token, openid, remark)
+        url = 'https://api.weixin.qq.com/cgi-bin/user/info/updateremark'\
+              "?access_token=#{access_token}"
+        Helper.http_post(url, { openid: openid, remark: remark }.to_json)
+      end
 
-        # Get the user base info.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Enumerable<String>] openid
-        # @param [Enumerable<String>] lang
-        # @return [Hash] Json based hash.
-        def get_user_base_info(access_token, openid, lang='zh_CN')
-          url = 'https://api.weixin.qq.com/cgi-bin/user/info'\
-                "?access_token=#{access_token}&openid=#{openid}&lang=#{lang}"
-          Helper.http_get(url, { accept: :json })
-        end
+      # Get the user base info.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Enumerable<String>] openid
+      # @param [Enumerable<String>] lang
+      # @return [Hash] Json based hash.
+      def get_user_base_info(access_token, openid, lang='zh_CN')
+        url = 'https://api.weixin.qq.com/cgi-bin/user/info'\
+              "?access_token=#{access_token}&openid=#{openid}&lang=#{lang}"
+        Helper.http_get(url, { accept: :json })
+      end
 
-        # Get user list of weixin.
-        #
-        # @param [Enumerable<String>] access_token
-        # @param [Enumerable<String>] next_openid
-        # @return [Hash] Json based hash.
-        def user_list(access_token, next_openid=nil)
-          url = 'https://api.weixin.qq.com/cgi-bin/user/get'\
-                "?access_token=#{access_token}"
-          url += "&next_openid=#{next_openid}" if next_openid
-          Helper.http_get(url, { accept: :json })
-        end
+      # Get user list of weixin.
+      #
+      # @param [Enumerable<String>] access_token
+      # @param [Enumerable<String>] next_openid
+      # @return [Hash] Json based hash.
+      def user_list(access_token, next_openid=nil)
+        url = 'https://api.weixin.qq.com/cgi-bin/user/get'\
+              "?access_token=#{access_token}"
+        url += "&next_openid=#{next_openid}" if next_openid
+        Helper.http_get(url, { accept: :json })
+      end
 
-        # Get oauth2 token with code.
-        #
-        # @param [Enumerable<String>] app_id
-        # @param [Enumerable<String>] app_secret
-        # @param [Enumerable<String>] code
-        # @param [Enumerable<String>] grant_type
-        # @return [Hash] Json based hash.
-        def get_oauth2_token_with_code(app_id, app_secret, code, grant_type='authorization_code')
-          url = 'https://api.weixin.qq.com/sns/oauth2/access_token'\
-                "?appid=#{app_id}&secret=#{app_secret}&code=CODE&grant_type=#{grant_type}"
-          Helper.http_get(url, { accept: :json })
-        end
+      # Get oauth2 token with code.
+      #
+      # @param [Enumerable<String>] app_id
+      # @param [Enumerable<String>] app_secret
+      # @param [Enumerable<String>] code
+      # @param [Enumerable<String>] grant_type
+      # @return [Hash] Json based hash.
+      def get_oauth2_token_with_code(app_id, app_secret, code, grant_type='authorization_code')
+        url = 'https://api.weixin.qq.com/sns/oauth2/access_token'\
+              "?appid=#{app_id}&secret=#{app_secret}&code=CODE&grant_type=#{grant_type}"
+        Helper.http_get(url, { accept: :json })
+      end
 
-        # Refresh oauth2 token.
-        #
-        # @param [Enumerable<String>] app_id
-        # @param [Enumerable<String>] refresh_token
-        # @param [Enumerable<String>] grant_type
-        # @return [Hash] Json based hash.
-        def refresh_oauth2_token(app_id, refresh_token, grant_type='refresh_token')
-          url = 'https://api.weixin.qq.com/sns/oauth2/refresh_token'\
-                "?appid=#{app_id}&grant_type=#{grant_type}&refresh_token=#{refresh_token}"
-          Helper.http_get(url, { accept: :json })
-        end
+      # Refresh oauth2 token.
+      #
+      # @param [Enumerable<String>] app_id
+      # @param [Enumerable<String>] refresh_token
+      # @param [Enumerable<String>] grant_type
+      # @return [Hash] Json based hash.
+      def refresh_oauth2_token(app_id, refresh_token, grant_type='refresh_token')
+        url = 'https://api.weixin.qq.com/sns/oauth2/refresh_token'\
+              "?appid=#{app_id}&grant_type=#{grant_type}&refresh_token=#{refresh_token}"
+        Helper.http_get(url, { accept: :json })
+      end
 
-        # Get user info with snsapi_userinfo.
-        #
-        # @param [Enumerable<String>] oauth2_token
-        # @param [Enumerable<String>] openid
-        # @param [Enumerable<String>] lang
-        # @return [Hash] Json based hash.
-        def get_user_info_with_snsapi_userinfo(oauth2_token, openid, lang)
-          url = 'https://api.weixin.qq.com/sns/userinfo'\
-                "?access_token=#{oauth2_token}&#{openid}=OPENID&lang=#{lang}"
-          Helper.http_get(url, { accept: :json })
-        end
+      # Get user info with snsapi_userinfo.
+      #
+      # @param [Enumerable<String>] oauth2_token
+      # @param [Enumerable<String>] openid
+      # @param [Enumerable<String>] lang
+      # @return [Hash] Json based hash.
+      def get_user_info_with_snsapi_userinfo(oauth2_token, openid, lang)
+        url = 'https://api.weixin.qq.com/sns/userinfo'\
+              "?access_token=#{oauth2_token}&#{openid}=OPENID&lang=#{lang}"
+        Helper.http_get(url, { accept: :json })
+      end
 
-        # Check the oauth2_token.
-        #
-        # @param [Enumerable<String>] openid
-        # @param [Enumerable<String>] oauth2_token
-        # @return [Hash] Json based hash.
-        def check_oauth2_token(openid, oauth2_token)
-          url = 'https://api.weixin.qq.com/sns/auth'\
-                "?access_token=#{oauth2_token}&openid=#{openid}"
-          Helper.http_get(url, { accept: :json })
-        end
+      # Check the oauth2_token.
+      #
+      # @param [Enumerable<String>] openid
+      # @param [Enumerable<String>] oauth2_token
+      # @return [Hash] Json based hash.
+      def check_oauth2_token(openid, oauth2_token)
+        url = 'https://api.weixin.qq.com/sns/auth'\
+              "?access_token=#{oauth2_token}&openid=#{openid}"
+        Helper.http_get(url, { accept: :json })
       end
+
+      extend self
     end
   end
 end

data/lib/wx_ext/helper.rb

@@ -8,27 +8,27 @@ module WxExt
   #
   # @author FuShengYang
   module Helper
-    class << self
-      # Http get helper of this gem, always return a hash.
-      #
-      # @param [Enumerable<String>] url
-      # @param [Hash] headers
-      # @return [Hash] A json parse hash.
-      def http_get(url, headers = {})
-        res = RestClient.get url, headers
-        JSON.parse res
-      end
+    # Http get helper of this gem, always return a hash.
+    #
+    # @param [Enumerable<String>] url
+    # @param [Hash] headers
+    # @return [Hash] A json parse hash.
+    def http_get(url, headers = {})
+      res = RestClient.get url, headers
+      JSON.parse res
+    end
 
-      # Http post helper of this gem, always return a hash.
-      #
-      # @param [Enumerable<String>] url
-      # @param [Hash] params
-      # @param [Hash] headers
-      # @return [Hash] A json parse hash.
-      def http_post(url, params, headers = {})
-        res = RestClient.post url, params, headers
-        JSON.parse res
-      end
+    # Http post helper of this gem, always return a hash.
+    #
+    # @param [Enumerable<String>] url
+    # @param [Hash] params
+    # @param [Hash] headers
+    # @return [Hash] A json parse hash.
+    def http_post(url, params, headers = {})
+      res = RestClient.post url, params, headers
+      JSON.parse res
     end
+
+    extend self
   end
 end

data/lib/wx_ext/version.rb

@@ -1,4 +1,4 @@
 # encoding: UTF-8
 module WxExt
-  VERSION = '0.1.6'
+  VERSION = '0.1.8'
 end