wx_ext 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b09d3e31cfa73aba2eb5b058c17163dc97a25ffa
-  data.tar.gz: 11d8bb8534f855c0154099411f46d43181ed1cd2
+  metadata.gz: 203fdbfdf2af62627187c6032990c5197801c986
+  data.tar.gz: d5b91a0de4da6424b4a7eb3dce028b3ddcc83b2c
 SHA512:
-  metadata.gz: 7b458d4545f22d2f7679e0640887c367483446765c688a5745faebf50cb4e089faf5b7765facef32251d087dae2683b5c1c21e5850be7144aedf00e124de81c5
-  data.tar.gz: 936ae911d89043aa9ab3765e238ead59b58b7004867b6a58f6c9f60c944f2780f9550167560b74416899a7ea496108ef39c639528f3b164e031ff4082800abb7
+  metadata.gz: 5321d5ffd737870b445b26493bbfe6c64c440d41a05b9af6224d99264896993fcc861ff6aa191942a9428a910421e5ed5ac0b7955cc93e4a18fb20235a93f00f
+  data.tar.gz: 0185ceab9c0dc273315275f3a88d9c596698e3c274ce55066b85f27f78b0c0447f58ed0e594e70034a72aa11e0e7ed4a6321af85525b5d545fadb9c1fcf23e1c

data/README.md

@@ -24,6 +24,10 @@ And then execute:
 2. rspec spec/wx_ext/weixin_spec.rb
 3. rspec spec/wx_ext/sougou_weixin_spec.rb
 
+## yard
+
+`yardoc lib/*.rb lib/wx_ext/*.rb lib/wx_ext/api/*.rb lib/wx_ext/api/user/*.rb`
+
 ## Contributing
 
 1. Fork it ( https://github.com/FlowerWrong/wx_ext/fork )

data/lib/wx_ext/api/base.rb

@@ -1,37 +1,42 @@
 # encoding: UTF-8
 
-require 'digest'
 require 'rest_client'
-require 'json'
-require 'wx_ext/helper'
 
 module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
   module Api
-
-    # 微信扩展接口, 模拟登陆微信公众平台
+    # User api of weixin.
+    #
     # @author FuShengYang
     module Base
       class << self
-        # Get the access_token for other apis.
-        # http://mp.weixin.qq.com/wiki/11/0e4b294685f817b95cbed85ba5e82b8f.html
+        # Get the access_token for other apis via get.
         #
-        # @param [String] appid
-        # @param [String] secret
-        # @param [String] grant_type, default is 'client_credential'
-        # @return [Hash] {"access_token":"ACCESS_TOKEN","expires_in":7200}
+        # @param [Enumerable<String>] appid
+        # @param [Enumerable<String>] secret
+        # @param [Enumerable<String>] grant_type
+        # @return [Hash] "access_token":"ACCESS_TOKEN","expires_in":7200
         def get_access_token(appid, secret, grant_type = 'client_credential')
           url = 'https://api.weixin.qq.com/cgi-bin/token'\
                 "?grant_type=#{grant_type}&appid=#{appid}&secret=#{secret}"
           Helper.http_get(url, { accept: :json })
         end
 
-        # { "ip_list":["127.0.0.1","127.0.0.1"] }
+        # Get weixin server ips.
+        #
+        # @param [Enumerable<String>] access_token
+        # @return [Hash] A json parse hash.
         def get_weixin_ips(access_token)
           url = 'https://api.weixin.qq.com/cgi-bin/getcallbackip'\
                 "?access_token=#{access_token}"
           Helper.http_get(url, { accept: :json })
         end
 
+        # Get weixin error_code and msg map.
+        #
+        # @return [Hash] A json parse hash.
         def code_msg
           {
             -1 => '系统繁忙，此时请开发者稍候再试',
@@ -130,18 +135,22 @@ module WxExt
         end
 
         # Upload media to weixin.
-        # http://mp.weixin.qq.com/wiki/10/78b15308b053286e2a66b33f0f0f5fb6.html
         #
-        # @param [String] access_token
-        # @param [String] type, 媒体文件类型，分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb）
-        # @param [String] media, form-data中媒体文件标识，有filename、filelength、content-type等信息
-        # @return [Hash] {"type":"TYPE","media_id":"MEDIA_ID","created_at":123456789}
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] type 媒体文件类型，分别有图片（image）、语音（voice）、视频（video）和缩略图（thumb）
+        # @param [File] media form-data中媒体文件标识，有filename、filelength、content-type等信息
+        # @return [Hash] "type":"TYPE","media_id":"MEDIA_ID","created_at":123456789
         def upload_media(access_token, type, media)
           url = 'http://file.api.weixin.qq.com/cgi-bin/media/upload'\
                 "?access_token=#{access_token}&type=#{type}"
           Helper.http_post(url, {file: media})
         end
 
+        # Download media from weixin.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] media_id
+        # @return [Image] Download img.
         def download_media(access_token, media_id)
           url = 'http://file.api.weixin.qq.com/cgi-bin/media/get'\
                 "?access_token=#{access_token}&media_id=#{media_id}"

data/lib/wx_ext/api/customer_service.rb

@@ -0,0 +1,33 @@
+# encoding: UTF-8
+
+module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
+  module Api
+    # User api of weixin.
+    #
+    # @author FuShengYang
+    module CustomerService
+      class << self
+        # Reply msg via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] to_user_openid
+        # @param [Enumerable<String>] msg_type
+        # @param [Hash] msg_hash
+        # @return [Hash] Json based hash.
+        def reply_msg(access_token, to_user_openid, msg_type, msg_hash)
+          url = 'https://api.weixin.qq.com/cgi-bin/message/custom/send'\
+                "?access_token=#{access_token}"
+          msg_hash = {
+            :touser => to_user_openid,
+            :msgtype => msg_type,
+            "#{msg_type}".to_sym => msg_hash
+          }
+          Helper.http_post(url, msg_hash.to_json)
+        end
+      end
+    end
+  end
+end

data/lib/wx_ext/api/js.rb

@@ -1,21 +1,32 @@
 # encoding: UTF-8
 
 require 'digest'
-require 'rest_client'
-require 'json'
 
 module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
   module Api
-
-    # 微信扩展接口, 模拟登陆微信公众平台
+    # User api of weixin.
+    #
     # @author FuShengYang
     module Js
       class << self
+        # Get js api ticket.
+        #
+        # @param [Enumerable<String>] access_token
+        # @return [Hash] Json based hash.
         def get_jsapi_ticket(access_token)
           url = "https://api.weixin.qq.com/cgi-bin/ticket/getticket?access_token=#{access_token}&type=jsapi"
           Helper.http_get(url, { accept: :json })
         end
 
+        # Get js api config hash.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Enumerable<String>] url
+        # @param [Enumerable<String>] app_id
+        # @return [Hash] Json based hash.
         def get_jsapi_config(access_token, url, app_id)
           config_hash = {}
           jsapi_ticket_hash = get_jsapi_ticket(access_token)
@@ -37,10 +48,16 @@ module WxExt
 
         private
 
+        # Set the noncestr of 16 byte.
+        #
+        # @return [String] 16 byte str.
         def set_noncestr
           [*'a'..'z',*'0'..'9',*'A'..'Z'].sample(16).join
         end
 
+        # Set the timestamp.
+        #
+        # @return [String] timestamp str.
         def set_timestamp
           Time.now.to_i.to_s
         end

data/lib/wx_ext/api/mass.rb

@@ -0,0 +1,81 @@
+# encoding: UTF-8
+
+module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
+  module Api
+    # User api of weixin.
+    #
+    # @author FuShengYang
+    module Mass
+      class << self
+        # Upload news to weixin server via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Hash] news_hash
+        # @return [Hash] Json based hash.
+        def upload_news(access_token, news_hash)
+          url = 'https://api.weixin.qq.com/cgi-bin/media/uploadnews'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, news_hash.to_json)
+        end
+
+        # Mass to users by filter group via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Hash] filter_hash
+        # @return [Hash] Json based hash.
+        def mass_by_filter_group(access_token, filter_hash)
+          url = 'https://api.weixin.qq.com/cgi-bin/message/mass/sendall'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, filter_hash.to_json)
+        end
+
+        # Mass to users by openid via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Hash] openid_hash
+        # @return [Hash] Json based hash.
+        def mass_by_openid(access_token, openid_hash)
+          url = 'https://api.weixin.qq.com/cgi-bin/message/mass/send'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, openid_hash.to_json)
+        end
+
+        # Del mass via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [String] msg_id
+        # @return [Hash] Json based hash.
+        def del_mass(access_token, msg_id)
+          url = 'https://api.weixin.qq.com/cgi-bin/message/mass/delete'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, { msg_id: msg_id }.to_json)
+        end
+
+        # Preview mass via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [Hash] preview_hash
+        # @return [Hash] Json based hash.
+        def preview_mass(access_token, preview_hash)
+          url = 'https://api.weixin.qq.com/cgi-bin/message/mass/preview'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, preview_hash.to_json)
+        end
+
+        # Get mass status via post.
+        #
+        # @param [Enumerable<String>] access_token
+        # @param [String] msg_id
+        # @return [Hash] Json based hash.
+        def get_mass_status(access_token, msg_id)
+          url = 'https://api.weixin.qq.com/cgi-bin/message/mass/get'\
+                "?access_token=#{access_token}"
+          Helper.http_post(url, { msg_id: msg_id }.to_json)
+        end
+      end
+    end
+  end
+end

data/lib/wx_ext/api/menu.rb

@@ -1,25 +1,41 @@
 # encoding: UTF-8
 
 module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
   module Api
-
-    # 微信扩展接口, 模拟登陆微信公众平台
+    # 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)
+          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
 
+        # 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}"

data/lib/wx_ext/api/msg.rb

@@ -1,18 +1,47 @@
 # encoding: UTF-8
 
-require 'digest'
-
 module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
   module Api
-
-    # 微信扩展接口, 模拟登陆微信公众平台
+    # User api of weixin.
+    #
     # @author FuShengYang
-    module Msg
+    module Qrcode
       class << self
 
-        def check_signature(signature, timestamp, nonce, token)
-          array = [token, timestamp, nonce].sort
-          signature == Digest::SHA1.hexdigest(array.join) ? true : false
+        # 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
+
+        # 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
       end
     end

data/lib/wx_ext/api/qrcode.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+
+module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
+  module Api
+    # User api of weixin.
+    #
+    # @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
+      end
+    end
+  end
+end

data/lib/wx_ext/api/semantic.rb

@@ -0,0 +1,27 @@
+# encoding: UTF-8
+
+module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
+  module Api
+    # User api of weixin.
+    #
+    # @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
+      end
+    end
+  end
+end

data/lib/wx_ext/api/template_msg.rb

@@ -0,0 +1,50 @@
+# encoding: UTF-8
+
+module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
+  module Api
+    # User api of weixin.
+    #
+    # @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
+
+        # 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
+      end
+    end
+  end
+end

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

@@ -1,43 +1,73 @@
 # encoding: UTF-8
 
-require 'rest_client'
-
 module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
   module Api
-
-    # 微信扩展接口, 模拟登陆微信公众平台
+    # User api of weixin.
+    #
     # @author FuShengYang
     module User
+      # User group api of weixin.
+      #
+      # @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
 
+          # 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 })
+            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 })
+            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 } })
+            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 })
+            Helper.http_post(url, { openid: openid, to_groupid: to_groupid }.to_json)
           end
         end
       end

data/lib/wx_ext/api/user.rb

@@ -1,41 +1,94 @@
 # encoding: UTF-8
 
-require 'digest'
-require 'rest_client'
-require 'json'
-require 'wx_ext/api/user/group'
-
 module WxExt
+  # Weixin api
+  #
+  # @author FuShengYang
   module Api
-
-    # 微信扩展接口, 模拟登陆微信公众平台
+    # User api of weixin.
+    #
     # @author FuShengYang
     module User
       class << self
-        def change_remark(access_token, openid, remark) end
 
-        def get_user_base_info(access_token, openid, lang) 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
 
-        def user_list(access_token, next_openid) 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)
+          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
 
+        # 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
 
+        # 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}"

data/lib/wx_ext/api.rb

@@ -1,11 +1,12 @@
 # encoding: UTF-8
 
-#require 'wx_ext/api/qrcode'
-#require 'wx_ext/api/media'
-#require 'wx_ext/api/oauth'
-
 require 'wx_ext/api/base'
+require 'wx_ext/api/customer_service'
 require 'wx_ext/api/js'
+require 'wx_ext/api/mass'
+require 'wx_ext/api/menu'
 require 'wx_ext/api/msg'
+require 'wx_ext/api/qrcode'
+require 'wx_ext/api/semantic'
+require 'wx_ext/api/template_msg'
 require 'wx_ext/api/user'
-require 'wx_ext/api/menu'

data/lib/wx_ext/helper.rb

@@ -4,15 +4,27 @@ require 'rest_client'
 require 'json'
 
 module WxExt
-
+  # WxExt Helper like get and post short method.
+  #
   # @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 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

data/lib/wx_ext/sougou_weixin.rb

@@ -6,9 +6,16 @@ require 'json'
 require 'open-uri'
 
 module WxExt
-  #  微信扩展接口, 从搜狗微信抓取微信文章
+  # Spider post from http://weixin.sogou.com
+  #
   # @author FuShengYang
   class SougouWeixin
+    # Spider posts from sougou, only one page.
+    #
+    # @param [Enumerable<String>] openid
+    # @param [Integer] page_index
+    # @param [Enumerable<String>] date_last
+    # @return [Hash] A spider posts hash with total_pages etc.
     def self.spider_posts_from_sougou(openid, page_index = 1, date_last = (Time.now - 3600 * 24 * 10).strftime("%Y-%m-%d"))
       json_url = "http://weixin.sogou.com/gzhjs?&openid=#{openid}&page=#{page_index}"
       res = RestClient.get json_url
@@ -75,6 +82,11 @@ module WxExt
       }
     end
 
+    # Spider posts from sougou, last date.
+    #
+    # @param [Enumerable<String>] openid
+    # @param [Enumerable<String>] date_last
+    # @return [Hash] A spider posts hash with total_pages etc.
     def self.spider_posts_later_date(openid, date_last = (Time.now - 3600 * 24 * 10).strftime("%Y-%m-%d"))
       spider_posts_first_page_hash = spider_posts_from_sougou(openid, 1, date_last)
       total_pages = spider_posts_first_page_hash[:total_pages].to_i
@@ -88,9 +100,9 @@ module WxExt
         end
       end
       {
-          total_items: spider_posts_first_page_hash[:total_items],
-          total_pages: total_pages,
-          spider_posts: spider_posts.uniq
+        total_items: spider_posts_first_page_hash[:total_items],
+        total_pages: total_pages,
+        spider_posts: spider_posts.uniq
       }
     end
   end

data/lib/wx_ext/version.rb

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

data/lib/wx_ext/wei_xin.rb

@@ -6,11 +6,13 @@ require 'json'
 require 'nokogiri'
 
 module WxExt
-  # 微信扩展接口, 模拟登陆微信公众平台
+  # weixin extention of mp.weixin.qq.com
+  #
   # @author FuShengYang
   class WeiXin
     attr_accessor :account, :password, :home_url, :token, :user_name, \
-    :ticket_id, :ticket, :cookies, :operation_seq
+                  :ticket_id, :ticket, :cookies, :operation_seq
+
     def initialize(account, password)
       @account = account
       @password = password
@@ -25,7 +27,7 @@ module WxExt
 
     # 模拟登陆微信公众平台, 初始化 access_token, cookies
     #
-    # @return [Hash] 使用用户名和密码登陆微信公众平台获取access_token, 过期时间是7200s
+    # @return [Hash] Hash with login status and msg.
     def login
       password = Digest::MD5.hexdigest @password
       login_headers = {
@@ -45,11 +47,11 @@ module WxExt
         status: 0,
         msg: 'ok'
       }
-      # {"base_resp"=>{"ret"=>0, "err_msg"=>"ok"}, "redirect_url"=>"/cgi-bin/home?t=home/index&lang=zh_CN&token=1869497342"}
-      # {"base_resp":{"ret":-8,"err_msg":"need verify code"}}
-      # {"base_resp":{"ret":-23,"err_msg":"acct\/password error"}}
-      # {"base_resp":{"ret":-21,"err_msg":"user not exist"}}
-      # https://mp.weixin.qq.com/cgi-bin/verifycode?username=tuodan@thecampus.cc&r=1415774604450
+
+      # 0: "ok", "redirect_url": ""
+      # -8: "need verify code"
+      # -23: "acct\/password error"
+      # -21: "user not exist"
       res_hash = JSON.parse res.to_s
       sta = res_hash['base_resp']['ret'].to_s
       if sta == '0'
@@ -79,10 +81,12 @@ module WxExt
       return_hash
     end
 
-    # 初始化 ticket, cookies, operation_seq, user_name 等等信息
+    # Init ticket, cookies, operation_seq, user_name etc.
+    #
+    # @return [Boolean] Init ticket, cookies, operation_seq, user_name true or false.
     def init
       msg_send_url = 'https://mp.weixin.qq.com/cgi-bin/masssendpage'\
-      "?t=mass/send&token=#{@token}&lang=zh_CN"
+                     "?t=mass/send&token=#{@token}&lang=zh_CN"
       msg_send_page = RestClient.get msg_send_url, cookies: @cookies
       @cookies = @cookies.merge msg_send_page.cookies
 
@@ -98,36 +102,46 @@ module WxExt
       end
     end
 
-    # 上传图片素材到素材中心
+    # Upload file to file.weixin.qq.com
+    #
+    # @param [File] file
+    # @param [String] file_name
+    # @param [String] folder
+    # @return [Hash] A json parse hash.
     def upload_file(file, file_name, folder = '/cgi-bin/uploads')
       upload_url = 'https://mp.weixin.qq.com/cgi-bin/filetransfer'\
-      '?action=upload_material&f=json&writetype=doublewrite'\
-      "&groupid=1&ticket_id=#{@ticket_id}"\
-      "&ticket=#{@ticket}&token=#{@token}&lang=zh_CN"
-      response = RestClient.post upload_url, file: file, \
-      Filename: file_name, \
-      folder: folder
+                   '?action=upload_material&f=json&writetype=doublewrite'\
+                   "&groupid=1&ticket_id=#{@ticket_id}"\
+                   "&ticket=#{@ticket}&token=#{@token}&lang=zh_CN"
+      response = RestClient.post upload_url, file: file,
+                                             Filename: file_name,
+                                             folder: folder
       JSON.parse response.to_s
     end
 
-    # 发送单条图文消息到素材中心
+    # Upload single news to mp.weixin.qq.com
+    #
+    # @param [Hash] single_msg_params
+    # @return [Hash] A json parse hash.
     def upload_single_msg(single_msg_params)
       post_single_msg_uri = 'cgi-bin/operate_appmsg'\
-      '?t=ajax-response&sub=create&type=10&token'\
-      "=#{@token}&lang=zh_CN"
+                            '?t=ajax-response&sub=create&type=10&token'\
+                            "=#{@token}&lang=zh_CN"
       headers = {
         referer: 'https://mp.weixin.qq.com/cgi-bin/appmsg?t=media/appmsg_edit'\
-        '&action=edit&type=10&isMul=0&isNew=1&lang=zh_CN'\
-        "&token=#{@token}"
+                 '&action=edit&type=10&isMul=0&isNew=1&lang=zh_CN'\
+                 "&token=#{@token}"
       }
       resource = RestClient::Resource.new(@home_url, headers: headers,
       cookies: @cookies)
       res = resource[post_single_msg_uri].post single_msg_params
-      # {"ret":"0", "msg":"OK"}
       JSON.parse res.to_s
     end
 
-    # 发送多图文到素材中心
+    # Upload multi news to mp.weixin.qq.com
+    #
+    # @param [Hash] msg_params
+    # @return [Hash] A json parse hash.
     def upload_multi_msg(msg_params)
       uri = 'cgi-bin/operate_appmsg?t=ajax-response&sub=create&type=10'\
       "&token=#{@token}&lang=zh_CN"
@@ -139,11 +153,13 @@ module WxExt
       resource = RestClient::Resource.new(@home_url, headers: headers,
       cookies: @cookies)
       post_msg_res = resource[uri].post msg_params
-      # {"ret":"0", "msg":"OK"}
       JSON.parse post_msg_res.to_s
     end
 
-    # 图文预览功能
+    # Preview broadcast news to user.
+    #
+    # @param [Hash] msg_params_with_name
+    # @return [Hash] A json parse hash.
     def preview_msg(msg_params_with_name)
       uri = 'cgi-bin/operate_appmsg?sub=preview&t=ajax-appmsg-preview'\
       "&type=10&token=#{@token}&lang=zh_CN"
@@ -155,39 +171,48 @@ module WxExt
       cookies: @cookies)
 
       res = resource[uri].post msg_params_with_name
-      # {"ret":"0", "msg":"preview send success!", "appMsgId":"201796045", "fakeid":""}
+      # "ret":"0", "msg":"preview send success!", "appMsgId":"201796045", "fakeid":""
       JSON.parse res.to_s
     end
 
-    # 群发图文消息
+    # Broadcast news to mp.weixin.qq.com.
+    #
+    # @param [Hash] msg_params
+    # @return [Hash] A json parse hash.
     def broadcast_msg(msg_params)
       uri = "cgi-bin/masssend?t=ajax-response&token=#{@token}&lang=zh_CN"
       headers = {
         referer: 'https://mp.weixin.qq.com/cgi-bin/masssendpage'\
-        "?t=mass/send&token=#{token}&lang=zh_CN",
+                 "?t=mass/send&token=#{token}&lang=zh_CN",
         host: 'mp.weixin.qq.com'
       }
       resource = RestClient::Resource.new(@home_url, headers: headers,
-      cookies: @cookies)
+                                                     cookies: @cookies)
       post_msg_res = resource[uri].post msg_params
-      # {"ret":"0", "msg":"OK"}
       JSON.parse post_msg_res.to_s
     end
 
-    # 获取所有的图文列表
+    # Get all news.
+    #
+    # @param [Integer] msg_begin
+    # @param [Integer] msg_count
+    # @return [Hash] A json parse hash.
     def get_app_msg_list(msg_begin = 0, msg_count = 10)
       url = 'https://mp.weixin.qq.com/cgi-bin/appmsg?type=10&action=list'\
-      "&begin=#{msg_begin}&count=#{msg_count}&f=json&token=#{@token}"\
-      "&lang=zh_CN&token=#{@token}&lang=zh_CN&f=json&ajax=1"\
-      "&random=#{rand}"
+            "&begin=#{msg_begin}&count=#{msg_count}&f=json&token=#{@token}"\
+            "&lang=zh_CN&token=#{@token}&lang=zh_CN&f=json&ajax=1"\
+            "&random=#{rand}"
       msg_json = RestClient.get url, cookies: @cookies
       JSON.parse msg_json.to_s
     end
 
-    # 轮训新消息条数
+    # Get new coming msgs from user.
+    #
+    # @param [String] last_msg_id
+    # @return [Hash] A json parse hash.
     def get_new_msg_num(last_msg_id)
       uri = 'cgi-bin/getnewmsgnum?f=json&t=ajax-getmsgnum'\
-      "&lastmsgid=#{last_msg_id}&token=#{@token}&lang=zh_CN"
+            "&lastmsgid=#{last_msg_id}&token=#{@token}&lang=zh_CN"
       post_params = {
         ajax: 1,
         f: 'json',
@@ -197,18 +222,21 @@ module WxExt
       }
       post_headers = {
         referer: 'https://mp.weixin.qq.com/cgi-bin/message?t=message/list'\
-        "&count=20&day=7&token=#{@token}&lang=zh_CN"
+                 "&count=20&day=7&token=#{@token}&lang=zh_CN"
       }
       resource = RestClient::Resource.new(@home_url, headers: post_headers,
-      cookies: @cookies)
+                                                     cookies: @cookies)
       res = resource[uri].post post_params
       JSON.parse res.to_s
     end
 
-    # 获取联系人信息
+    # Get user info.
+    #
+    # @param [String] fakeid
+    # @return [Hash] A json parse hash.
     def get_contact_info(fakeid)
       uri = 'cgi-bin/getcontactinfo?t=ajax-getcontactinfo'\
-      "&lang=zh_CN&fakeid=#{fakeid}"
+            "&lang=zh_CN&fakeid=#{fakeid}"
       post_params = {
         ajax: 1,
         f: 'json',
@@ -218,28 +246,32 @@ module WxExt
       }
       post_headers = {
         referer: 'https://mp.weixin.qq.com/cgi-bin/contactmanage?t=user/index'\
-        "&pagesize=10&pageidx=0&type=0&token=#{@token}&lang=zh_CN"
+                 "&pagesize=10&pageidx=0&type=0&token=#{@token}&lang=zh_CN"
       }
       resource = RestClient::Resource.new(@home_url, headers: post_headers,
-      cookies: @cookies)
+                                                     cookies: @cookies)
       res = resource[uri].post post_params
       JSON.parse res.to_s
     end
 
-    # 获取国家列表
+    # Get country list.
+    #
+    # @return [Hash] A json parse hash.
     def get_country_list
       url = 'https://mp.weixin.qq.com/cgi-bin/getregions'\
-      "?t=setting/ajax-getregions&id=0&token=#{@token}&lang=zh_CN"\
-      "&token=#{@token}&lang=zh_CN&f=json&ajax=1&random=#{rand}"
+            "?t=setting/ajax-getregions&id=0&token=#{@token}&lang=zh_CN"\
+            "&token=#{@token}&lang=zh_CN&f=json&ajax=1&random=#{rand}"
       resource = RestClient::Resource.new(url, cookies: @cookies)
       res = resource.get
       JSON.parse res.to_s
     end
 
-    # 获取每日可推送消息数
+    # Get this weixin can broadcast news count.
+    #
+    # @return [Integer] day msg count.
     def get_day_msg_count
       url = 'https://mp.weixin.qq.com/cgi-bin/masssendpage'\
-      "?t=mass/send&token=#{@token}&lang=zh_CN"
+            "?t=mass/send&token=#{@token}&lang=zh_CN"
       res = RestClient.get(url, cookies: @cookies)
       day_msg_count = 0
       reg = /.*mass_send_left\s*:\s*can_verify_apply\s*\?\s*\'(\d*)\'\*/
@@ -247,11 +279,19 @@ module WxExt
       day_msg_count.to_i
     end
 
-    # 获取 total_count, count, day, frommsgid, can_search_msg, offset, action=search, keyword, last_msg_id, filterivrmsg=0/1 和 msg_items
+    # Get msg items.
+    #
+    # @param [Integer] count
+    # @param [Integer] day
+    # @param [Integer] filterivrmsg
+    # @param [String] action
+    # @param [String] keyword
+    # @param [String] offset
+    # @return [Hash] A json parse hash.
     def get_msg_items(count = 20, day = 7, filterivrmsg = 1, action='', keyword='', frommsgid='', offset='')
       url = 'https://mp.weixin.qq.com/cgi-bin/message?t=message/list'\
-      "&action=#{action}&keyword=#{keyword}&frommsgid=#{frommsgid}&offset=#{offset}&count=#{count}"\
-      "&day=#{day}filterivrmsg=#{filterivrmsg}&token=#{@token}&lang=zh_CN"
+            "&action=#{action}&keyword=#{keyword}&frommsgid=#{frommsgid}&offset=#{offset}&count=#{count}"\
+            "&day=#{day}filterivrmsg=#{filterivrmsg}&token=#{@token}&lang=zh_CN"
       resource = RestClient::Resource.new(url, cookies: @cookies)
       res = resource.get
       reg = /.*total_count\s*:\s*(\d*).*latest_msg_id\s*:\s*\'(\d*)\'.*list\s*:\s*\((.*)\)\.msg_item,.*filterivrmsg\s*:\s*\"(\d*)\".*/m
@@ -279,7 +319,9 @@ module WxExt
       return_hash
     end
 
-    # 获取粉丝数目
+    # Get fans count.
+    #
+    # @return [Hash] Fans count with friends_list, group_list etc.
     def get_fans_count
       url = 'https://mp.weixin.qq.com/cgi-bin/contactmanage?t=user/index'\
       "&pagesize=10&pageidx=0&type=0&token=#{ @token }&lang=zh_CN"
@@ -304,12 +346,15 @@ module WxExt
       return_hash
     end
 
-    # {"base_resp":{"ret":10706,"err_msg":"customer block"}} 48小时内的才行
-    # {"base_resp":{"ret":0,"err_msg":"ok"}}
-    # 快速回复
+    # Quick reply to user.
+    #
+    # @param [String] content
+    # @param [String] quickreplyid
+    # @param [String] tofakeid
+    # @return [Hash] A json parse hash.
     def quick_reply(content, quickreplyid, tofakeid)
       post_uri = 'cgi-bin/singlesend'\
-      "?t=ajax-response&f=json&token=#{ @token }&lang=zh_CN"
+                 "?t=ajax-response&f=json&token=#{ @token }&lang=zh_CN"
       params = {
         ajax: 1,
         content: content,
@@ -325,17 +370,20 @@ module WxExt
       }
       headers = {
         referer: 'https://mp.weixin.qq.com/cgi-bin/message'\
-        "?t=message/list&count=20&day=7&token=#{ @token }&lang=zh_CN"
+                 "?t=message/list&count=20&day=7&token=#{ @token }&lang=zh_CN"
       }
       resource = RestClient::Resource.new(@home_url, headers: headers,
-      cookies: @cookies)
+                                                     cookies: @cookies)
       res = resource[post_uri].post params
+      #
+      # 10706: "customer block": "48小时内的才行"
       JSON.parse res.to_s
     end
 
-    # https://mp.weixin.qq.com/cgi-bin/setstarmessage?t=ajax-setstarmessage&token=1664040225&lang=zh_CN
-    # { "ret":0, "msg":"sys ok"}
-    # 收藏消息
+    # Collect msg of user.
+    #
+    # @param [String] msgid
+    # @return [Hash] A json parse hash.
     def collect_msg(msgid)
       uri = "cgi-bin/setstarmessage?t=ajax-setstarmessage&token=#{ @token }&lang=zh_CN"
       params = {
@@ -349,15 +397,18 @@ module WxExt
       }
       headers = {
         referer: 'https://mp.weixin.qq.com/cgi-bin/message'\
-        "?t=message/list&token=#{ @token }&count=20&day=7"
+                 "?t=message/list&token=#{ @token }&count=20&day=7"
       }
       resource = RestClient::Resource.new(@home_url, headers: headers,
-      cookies: @cookies)
+                                                     cookies: @cookies)
       res = resource[uri].post params
       JSON.parse res.to_s
     end
 
-    # 取消收藏消息
+    # Un collect msg of user.
+    #
+    # @param [String] msgid
+    # @return [Hash] A json parse hash.
     def un_collect_msg(msgid)
       uri = "cgi-bin/setstarmessage?t=ajax-setstarmessage&token=#{ @token }&lang=zh_CN"
       params = {
@@ -371,12 +422,11 @@ module WxExt
       }
       headers = {
         referer: 'https://mp.weixin.qq.com/cgi-bin/message'\
-        "?t=message/list&token=#{ @token }&count=20&day=7"
+                 "?t=message/list&token=#{ @token }&count=20&day=7"
       }
       resource = RestClient::Resource.new(@home_url, headers: headers,
-      cookies: @cookies)
+                                                     cookies: @cookies)
       res = resource[uri].post params
-      # { "ret":0, "msg":"sys ok"}
       JSON.parse res.to_s
     end
   end

data/lib/wx_ext.rb

@@ -5,17 +5,30 @@ require 'wx_ext/sougou_weixin'
 require 'wx_ext/wei_xin'
 require 'wx_ext/api'
 
-# 微信扩展接口和基本接口
+# Weixin extention, sougou spider and weixin api.
+#
 # @author FuShengYang
 module WxExt
+
+  # Return the root path of this gem.
+  #
+  # @return [String] Path of the gem's root.
   def self.root
     File.dirname __dir__
   end
 
+
+  # Return the lib path of this gem.
+  #
+  # @return [String] Path of the gem's lib.
   def self.lib
     File.join root, 'lib'
   end
 
+
+  # Return the spec path of this gem.
+  #
+  # @return [String] Path of the gem's spec.
   def self.spec
     File.join root, 'spec'
   end

data/spec/wx_ext/api/customer_service_spec.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe WxExt::Api::CustomerService do
+end

data/spec/wx_ext/api/mass_spec.rb

@@ -0,0 +1,5 @@
+# encoding: UTF-8
+require 'spec_helper'
+
+describe WxExt::Api::Mass do
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wx_ext
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors:
 - flowerwrong
@@ -109,9 +109,14 @@ files:
 - lib/wx_ext.rb
 - lib/wx_ext/api.rb
 - lib/wx_ext/api/base.rb
+- lib/wx_ext/api/customer_service.rb
 - lib/wx_ext/api/js.rb
+- lib/wx_ext/api/mass.rb
 - lib/wx_ext/api/menu.rb
 - lib/wx_ext/api/msg.rb
+- lib/wx_ext/api/qrcode.rb
+- lib/wx_ext/api/semantic.rb
+- lib/wx_ext/api/template_msg.rb
 - lib/wx_ext/api/user.rb
 - lib/wx_ext/api/user/group.rb
 - lib/wx_ext/helper.rb
@@ -121,9 +126,13 @@ files:
 - spec/spec_helper.rb
 - spec/test.png
 - spec/wx_ext/api/base_spec.rb
+- spec/wx_ext/api/customer_service_spec.rb
 - spec/wx_ext/api/js_spec.rb
+- spec/wx_ext/api/mass_spec.rb
 - spec/wx_ext/api/menu_spec.rb
 - spec/wx_ext/api/msg_spec.rb
+- spec/wx_ext/api/semantic_spec.rb
+- spec/wx_ext/api/template_msg_spec.rb
 - spec/wx_ext/api/user/group_spec.rb
 - spec/wx_ext/api/user_spec.rb
 - spec/wx_ext/sougou_weixin_spec.rb
@@ -157,9 +166,13 @@ test_files:
 - spec/spec_helper.rb
 - spec/test.png
 - spec/wx_ext/api/base_spec.rb
+- spec/wx_ext/api/customer_service_spec.rb
 - spec/wx_ext/api/js_spec.rb
+- spec/wx_ext/api/mass_spec.rb
 - spec/wx_ext/api/menu_spec.rb
 - spec/wx_ext/api/msg_spec.rb
+- spec/wx_ext/api/semantic_spec.rb
+- spec/wx_ext/api/template_msg_spec.rb
 - spec/wx_ext/api/user/group_spec.rb
 - spec/wx_ext/api/user_spec.rb
 - spec/wx_ext/sougou_weixin_spec.rb