wechat_public_api 0.1.4 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 98dfee4a07d505f15fb5e2b6c8e34d9210f050ee
-  data.tar.gz: 9866e3df655cb9cdc1e39a7d8ed33922b012bc9f
+  metadata.gz: 8a3c096dfbdce45f98fc5f76ea0681506702410a
+  data.tar.gz: bdee8fb5d9c08e57c44c724e2a263006a0373bcc
 SHA512:
-  metadata.gz: 912aa2de176603be919d491a4453561abb531b9aa937cbd77b417d7104337594a9af642a0dce0ad3711b14a1035606494a384b441c3290fb3221c97597dd6094
-  data.tar.gz: 7bd5188cc0c6e69832326a5428e3be01afebe1059df2f32738636b4df79880484471409020794c26c4fa8efbcd274a63df0f92097b2f1962152f24bae11d1aef
+  metadata.gz: 8d9a56c7272421292cde50c5b703b8bcaa4fc109bb514eb86759e762dc43b9c2abee65cc8fb5ef06d9fcc7c99cf1a74402d466ae72df8576c69477e0805b4e0d
+  data.tar.gz: 67511e46afa3b5fdf425a759b33b5db9864e5f2fb33ceb6fcec8b628a2f7802e439ede3c4e332a5fde1948816848e2486fcfcd4f1f11b315a8f991502ea08597

data/README.md

@@ -20,170 +20,14 @@ gem 'wechat_public_api'
 
     $ gem install wechat_public_api
 
-## 三行代码获得 access_token
+## 0.1.4 版本文档
 
-```ruby
-WechatPublicApi.app_id = 'appid'
-WechatPublicApi.app_secret = 'secret'
-access_token = WechatPublicApi::AccessToken.get() # access_token
-```
-## API文档
-
-### WechatPublicApi模块配置，开启你的新项目
-
-**参数说明**
-
-* @param <String> app_id      # 公众号后台->开发->基本配置提供的AppID
-* @param <String> app_secret  # 公众号后台->开发->基本配置提供的AppSecret
-* @param <Boolearn> access_token_cache # 默认false，用于标识是否使用redis缓存查询到的access_token
-
-使用`WechatPublicApi`模块封装的方法之前，需要配置 app_id、app_secret和access_token_cache（可选），具体如下：
-
-```ruby
-WechatPublicApi.app_id = 'wx440415e4c3b4b8f9'
-WechatPublicApi.app_secret = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-access_token = WechatPublicApi::AccessToken.get() # access_token
-```
-
-**注意：** access_token_cache是一个布尔值，用于判断是否需要缓存access_token_cache，默认可不填，即默认不缓存access_token，如需缓存，请依照下方代码设置参数：
-
-```ruby
-WechatPublicApi.access_token_cache = true
-```
-
-### API功能概览
-
-* 菜单栏操作
-	* 创建菜单栏：`WechatPublicApi::Menu.create(post_data)`
-	* 查询菜单栏：`WechatPublicApi::Menu.query()`
-	* 删除菜单栏：`WechatPublicApi::Menu.delete()`
-* 客服消息管理
-	* 发送文字消息：`WechatPublicApi::Kf.text_message(openid, content)`
-	* 发送图片消息：`WechatPublicApi::Kf.image_message(openid, media_id)`
-	* 发送图文消息：`WechatPublicApi::Kf.mpnews_message(openid, media_id)`
-	* 发送图文消息（点击跳转外链）: `WechatPublicApi::Kf.news_message(openid, articles)`
-	* 发送语音消息：`WechatPublicApi::Kf.voice_message(openid, media_id)`
-* 模板消息管理
-	* 获取模板列表：`WechatPublicApi::Tp.get_all()`
-	* 删除模板：`WechatPublicApi::Tp.delete(templet_id)`
-	* 发送普通模板消息（不跳转小程序）`WechatPublicApi::Tp.general_message(openid, templet_id, url, data)`
-	* 发送跳转小程序的模板消息：`WechatPublicApi::Tp.miniprogram_message(openid, templet_id, url, appid, pagepath, data)`
-* 用户管理
-  * 获取用户基本信息: `WechatPublicApi::User.get_userinfo(openid)`
-* 帐号管理
-  * 获取临时带参二维码: `WechatPublicApi::Account.qrscene(sceneid)`
-  * 获取永久带参二维码: `WechatPublicApi::Account.qrsrtscene(sceneid)`
-  * 保存带参二维码到本地： `WechatPublicApi::Account.save_qrcode(path, *filename)`
-  * 生成短链接：`WechatPublicApi::Account.shorturl(longurl)`
-* 素材管理
-  * 获得临时图片素材的 media_id： `WechatPublicApi::Material.upload_image_media(file_path)`
-  * 获得永久图片素材的 media_id： `WechatPublicApi::Material.upload_image_material(file_path)`
-* 消息加密解密
-  * 加密： `WechatPublicApi::Aes.encrypt(aes_key, text, app_id)`
-  * 解密： `WechatPublicApi::Aes.decrypt(key, dicrypted_string)`
-
-### 菜单栏操作API
+[0.1.4 版本文档][1]
+[1]:https://github.com/Diyilou/wechat_public_api/blob/master/doc/0.1.4.md "版本：0.1.4"
 
-1. 自定义菜单查询
+## 两行代码获得 access_token
 
 ```ruby
-# no params
-# @return
-# {
-#   "menu": {
-#       "button": [
-#       {
-#        "type": "view",
-#        "name": "",
-#        "url": "",
-#        "sub_button": []
-#       },
-#       {
-#        "type": "click",
-#        "name": "",
-#        "key": "menu_3",
-#        "sub_button": []
-#       }
-#     ]
-#   }
-# }
-#
-menu_list = WechatPublicApi::Menu.query()
+wechat_api = WechatPublicApi.new appid: 'xx', app_secret: 'xx', access_token_cache: true
+access_token = wechat_api.get_access_token
 ```
-
-2. 自定义菜单创建
-
-```ruby
-###
-# create wechat public menu
-# @param <json> post_data
-#
-# =>  post_data example
-# {
-# 	  "button": [
-#     {
-#  		 "type": "view",
-#  		 "name": "",
-#  		 "url": "",
-#  		 "sub_button": []
-#  	  },
-#     {
-#  		 "type": "click",
-#  		 "name": "",
-#  		 "key": "menu_3",
-#  		 "sub_button": []
-#  	  }
-#   ]
-# }
-#
-# if success
-# @return <JSON> {"errcode"=>0, "errmsg"=>"ok"}
-# if failed
-# @return <JSON> {"errcode"=>40166, "errmsg"=>"...."}
-#
-status = WechatPublicApi::Menu.create(post_data)
-```
-
-3. 自定义菜单删除
-
-```ruby
-# @return <JSON> {"errcode"=>0, "errmsg"=>"ok"}
-status = WechatPublicApi::Menu.delete()
-```
-
-菜单栏操作API主要包含以上三个方法，接下来看一个完整示例：
-
-```ruby
-# 创建菜单栏 -> 查询菜单栏列表
-# 初始化配置
-WechatPublicApi.app_id = 'wx440415e4c3b4b8f9'
-WechatPublicApi.app_secret = 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
-# 创建菜单栏
-post_data = {
-	  "button": [
-    {
- 		 "type": "view",
- 		 "name": "",
- 		 "url": "",
- 		 "sub_button": []
- 	  },
-    {
- 		 "type": "click",
- 		 "name": "",
- 		 "key": "menu_3",
- 		 "sub_button": []
- 	  }
-  ]
-}
-status = WechatPublicApi::Menu.create(post_data)
-if status.errcode.to_i == 0 && status.errmsg == 'ok'
-  # 返回菜单栏列表
-  menu_list = WechatPublicApi::Menu.query()
-end
-```
-
-**注意：** 菜单栏创建和查询的方法包含了查询access_token
-
-### 客服消息管理API
-
-待更新... 可参考源代码，注释比较详细

data/lib/wechat_public_api/access_token.rb

@@ -5,43 +5,41 @@
 # Wechat number: zmx119966
 ####################################################
 
-module WechatPublicApi
+class WechatPublicApi
   module AccessToken
-    class << self
-
-      ###
-      # 获取 access_token
-      # 判断access_token_cache，决定是否需要缓存数据
-      # @return <string> nil or access_token
-      def get()
-        appid = WechatPublicApi.app_id
-        secret = WechatPublicApi.app_secret
-        access_token_cache = WechatPublicApi.access_token_cache
-
-        unless access_token_cache
-          response = HTTParty.get("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=#{appid}&secret=#{secret}").body
-          response_body = (JSON.parse response)
-
-          # 抛出异常
-          throw response_body['errmsg']  unless response_body['access_token']
-
-          return response_body['access_token']
-        end
-
-        _cache_key = "#{appid}_access_token"
-        _cached_access_token = $redis.get _cache_key
-        if _cached_access_token == nil or _cached_access_token == ''
-          response = HTTParty.get("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=#{appid}&secret=#{secret}").body
-          response_body = (JSON.parse response)
-
-          # 抛出异常
-          throw response_body['errmsg']  unless response_body['access_token']
-
-          _cached_access_token = response_body['access_token']
-          $redis.set _cache_key, _cached_access_token, ex: 2.minutes
-        end
-        _cached_access_token
+
+    ###
+    # 获取 access_token
+    # 判断access_token_cache，决定是否需要缓存数据
+    # @return <string> nil or access_token
+    def get_access_token()
+      appid = @app_id
+      secret = @app_secret
+      access_token_cache = @access_token_cache
+
+      unless access_token_cache
+        response = HTTParty.get("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=#{appid}&secret=#{secret}").body
+        response_body = (JSON.parse response)
+
+        # 抛出异常
+        throw response_body['errmsg']  unless response_body['access_token']
+
+        return response_body['access_token']
+      end
+
+      _cache_key = "#{appid}_access_token"
+      _cached_access_token = $redis.get _cache_key
+      if _cached_access_token == nil or _cached_access_token == ''
+        response = HTTParty.get("https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=#{appid}&secret=#{secret}").body
+        response_body = (JSON.parse response)
+
+        # 抛出异常
+        throw response_body['errmsg']  unless response_body['access_token']
+
+        _cached_access_token = response_body['access_token']
+        $redis.set _cache_key, _cached_access_token, ex: 2.minutes
       end
+      _cached_access_token
     end
   end
 end

data/lib/wechat_public_api/account.rb

@@ -5,115 +5,108 @@
 # Wechat number: zmx119966
 ####################################################
 
-require "wechat_public_api/access_token"
-
-module WechatPublicApi
+class WechatPublicApi
   module Account
-    class << self
+    ###
+    # 获取临时场景带惨二维码，30天有效
+    # @param <int> sceneid -- 场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
+    # @return <string> url -- 二维码网址
+    #
+    def get_qrscene(sceneid)
+      access_token = get_access_token()
 
-      ###
-      # 获取临时场景带惨二维码，30天有效
-      # @param <int> sceneid -- 场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
-      # @return <string> url -- 二维码网址
-      #
-      def qrscene(sceneid)
-        access_token = AccessToken.get()
+      # 获取ticket
+      uri = URI.parse("https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=#{access_token}")
+      post_data = {
+          'expire_seconds' => 2592000,
+          'action_name' => 'QR_SCENE',
+          'action_info' => {'scene' => {'scene_id' => sceneid}}}
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Post.new("/cgi-bin/qrcode/create?access_token=#{access_token}")
+      request.add_field('Content-Type', 'application/json')
+      request.body = post_data.to_json
+      response = http.request(request)
+      content = JSON.parse(response.body)
+      ticket = content['ticket']
 
-        # 获取ticket
-        uri = URI.parse("https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=#{access_token}")
-        post_data = {
-            'expire_seconds' => 2592000,
-            'action_name' => 'QR_SCENE',
-            'action_info' => {'scene' => {'scene_id' => sceneid}}}
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        request = Net::HTTP::Post.new("/cgi-bin/qrcode/create?access_token=#{access_token}")
-        request.add_field('Content-Type', 'application/json')
-        request.body = post_data.to_json
-        response = http.request(request)
-        content = JSON.parse(response.body)
-        ticket = content['ticket']
+      # 通过ticket换取二维码
+      "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=#{ticket}"
+    end
 
-        # 通过ticket换取二维码
-        url = 'https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=' + ticket
-        url
-      end
+    ###
+    # 获取永久二维码
+    # @param <int> sceneid -- 场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
+    # @return <string> url -- 二维码网址
+    #
+    def get_qrsrtscene(sceneid)
+      access_token = get_access_token()
 
-      ###
-      # 获取永久二维码
-      # @param <int> sceneid -- 场景值ID，临时二维码时为32位非0整型，永久二维码时最大值为100000（目前参数只支持1--100000）
-      # @return <string> url -- 二维码网址
-      #
-      def qrsrtscene(sceneid)
-        access_token = AccessToken.get()
+      # 获取ticket
+      uri = URI.parse("https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=#{access_token}")
+      post_data = {
+          'action_name' => 'QR_LIMIT_STR_SCENE',
+          'action_info' => {'scene' => {'scene_id' => sceneid}}}
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Post.new("/cgi-bin/qrcode/create?access_token=#{access_token}")
+      request.add_field('Content-Type', 'application/json')
+      request.body = post_data.to_json
+      response = http.request(request)
+      content = JSON.parse(response.body)
+      ticket = content['ticket']
 
-        # 获取ticket
-        uri = URI.parse("https://api.weixin.qq.com/cgi-bin/qrcode/create?access_token=#{access_token}")
-        post_data = {
-            'action_name' => 'QR_LIMIT_STR_SCENE',
-            'action_info' => {'scene' => {'scene_id' => sceneid}}}
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        request = Net::HTTP::Post.new("/cgi-bin/qrcode/create?access_token=#{access_token}")
-        request.add_field('Content-Type', 'application/json')
-        request.body = post_data.to_json
-        response = http.request(request)
-        content = JSON.parse(response.body)
-        ticket = content['ticket']
+      # 通过ticket换取二维码
+      "https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=#{ticket}"
+    end
 
-        # 通过ticket换取二维码
-        url = 'https://mp.weixin.qq.com/cgi-bin/showqrcode?ticket=' + ticket
-        url
+    ###
+    # 保存带参数二维码到指定位置
+    # @param <string> path -- 例如： "#{Rails.root}/public/qrcode"
+    # @param <string> filename -- 文件名，可选参数，默认不填写则使用时间戳+随机数的方式命名
+    #
+    # @return <string> path -- 二维码的保存路径
+    def save_qrcode(path, *filename)
+      # 判断是否需要新建文件
+      unless File.exist?(path)
+        FileUtils.makedirs(path)
       end
 
-      ###
-      # 保存带参数二维码到指定位置
-      # @param <string> path -- 例如： "#{Rails.root}/public/qrcode"
-      # @param <string> filename -- 文件名，可选参数，默认不填写则使用时间戳+随机数的方式命名
-      #
-      # @return <string> path -- 二维码的保存路径
-      def save_qrcode(path, *filename)
-        # 判断是否需要新建文件
-        unless File.exist?(path)
-          FileUtils.makedirs(path)
-        end
-
-        if filename
-          path = "#{path}/#{filename}"
-        else
-          path = "#{path}/#{Time.now.to_i.to_s}_#{rand 1000.9999}"
-        end
-
-        File.open(path, 'wb') do |f|
-          f.write(HTTParty.get(url).body)
-        end
+      if filename
+        path = "#{path}/#{filename}"
+      else
+        path = "#{path}/#{Time.now.to_i.to_s}_#{rand 1000.9999}"
+      end
 
-        path
+      File.open(path, 'wb') do |f|
+        f.write(HTTParty.get(url).body)
       end
 
-      ###
-      # @param <string> longurl -- 需要被压缩的url
-      #
-      # @return <json> shorturl -- 返回短链接 {"errcode":0,"errmsg":"ok","short_url":"http:\/\/w.url.cn\/s\/AvCo6Ih"}
-      # if false
-      # @return {"errcode":40013,"errmsg":"invalid appid"}
-      #
-      def shorturl(longurl)
-        access_token = AccessToken.get()
-        uri = URI.parse("https://api.weixin.qq.com/cgi-bin/shorturl?access_token=#{access_token}")
-        post_data = {action: "long2short", long_url: longurl}
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true
-        http.verify_mode = OpenSSL::SSL::VERIFY_NONE
-        request = Net::HTTP::Post.new("/cgi-bin/shorturl?access_token=#{access_token}")
-        request.add_field('Content-Type', 'application/json')
-        request.body = post_data.to_json
-        response = http.request(request)
+      path
+    end
 
-        JSON.parse(response.body)
-      end
+    ###
+    # @param <string> longurl -- 需要被压缩的url
+    #
+    # @return <json> shorturl -- 返回短链接 {"errcode":0,"errmsg":"ok","short_url":"http:\/\/w.url.cn\/s\/AvCo6Ih"}
+    # if false
+    # @return {"errcode":40013,"errmsg":"invalid appid"}
+    #
+    def get_shorturl(longurl)
+      access_token = get_access_token()
+      uri = URI.parse("https://api.weixin.qq.com/cgi-bin/shorturl?access_token=#{access_token}")
+      post_data = {action: "long2short", long_url: longurl}
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      request = Net::HTTP::Post.new("/cgi-bin/shorturl?access_token=#{access_token}")
+      request.add_field('Content-Type', 'application/json')
+      request.body = post_data.to_json
+      response = http.request(request)
+
+      JSON.parse(response.body)
     end
   end
 end

data/lib/wechat_public_api/aes.rb

@@ -5,40 +5,37 @@
 # Wechat number: zmx119966
 ####################################################
 
-require "wechat_public_api/access_token"
-module WechatPublicApi
+class WechatPublicApi
   module Aes
-    class << self
-
-      # 解密
-      def decrypt(key, dicrypted_string)
-        cipher = OpenSSL::Cipher::AES.new(256, :CBC)
-        cipher.decrypt
-        cipher.key = key
-        cipher.iv = '0000000000000000'
-        cipher.padding = 0
-        cipher.update(dicrypted_string) << cipher.final
-      end
+    # 解密
+    def decrypt(key, dicrypted_string)
+      cipher = OpenSSL::Cipher::AES.new(256, :CBC)
+      cipher.decrypt
+      cipher.key = key
+      cipher.iv = '0000000000000000'
+      cipher.padding = 0
+      cipher.update(dicrypted_string) << cipher.final
+    end
 
-      # 加密
-      def encrypt(aes_key, text, app_id)
-        text    = text.force_encoding("ASCII-8BIT")
-        random  = SecureRandom.hex(8)
-        msg_len = [text.length].pack("N")
-        text    = "#{random}#{msg_len}#{text}#{app_id}"
-        text    = WxAuth.encode(text)
-        text    = handle_cipher(:encrypt, aes_key, text)
-        Base64.encode64(text)
-      end
+    # 加密
+    def encrypt(aes_key, text, app_id)
+      text    = text.force_encoding("ASCII-8BIT")
+      random  = SecureRandom.hex(8)
+      msg_len = [text.length].pack("N")
+      text    = "#{random}#{msg_len}#{text}#{app_id}"
+      text    = WxAuth.encode(text)
+      text    = handle_cipher(:encrypt, aes_key, text)
+      Base64.encode64(text)
+    end
 
-      def handle_cipher(action, aes_key, text)
-        cipher = OpenSSL::Cipher.new('AES-256-CBC')
-        cipher.send(action)
-        cipher.padding = 0
-        cipher.key = aes_key
-        cipher.iv  = aes_key[0...16]
-        cipher.update(text) + cipher.final
-      end
+    private
+    def handle_cipher(action, aes_key, text)
+      cipher = OpenSSL::Cipher.new('AES-256-CBC')
+      cipher.send(action)
+      cipher.padding = 0
+      cipher.key = aes_key
+      cipher.iv  = aes_key[0...16]
+      cipher.update(text) + cipher.final
     end
   end
 end