weixin_authorize_905 1.6.5

data/lib/weixin_authorize/api/mass.rb

@@ -0,0 +1,80 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Mass
+
+      MSG_TYPE = ["mpnews", "image", "text", "voice", "mpvideo"].freeze
+
+      # media_info= {"media_id" media_id}
+      # https://api.weixin.qq.com/cgi-bin/message/mass/sendall?access_token=ACCESS_TOKEN
+      def mass_with_group(group_id, media_info, msgtype="mpnews", is_to_all=false)
+        group_option = {filter: {group_id: group_id, is_to_all: is_to_all}}
+        media = generate_media(msgtype, media_info, group_option)
+
+        mass_url = "#{mass_base_url}/sendall"
+        http_post(mass_url, media)
+      end
+
+      # https://api.weixin.qq.com/cgi-bin/message/mass/send?access_token=ACCESS_TOKEN
+      # if mpvideo,
+      # media_info= {"media_id" => media_id, "title" => "title", "description" => "description"}
+      def mass_with_openids(openids, media_info, msgtype="mpnews")
+        openid_option = {touser: openids}
+        media = generate_media(msgtype, media_info, openid_option)
+        mass_url = "#{mass_base_url}/send"
+        http_post(mass_url, media)
+      end
+
+      # 请注意，只有已经发送成功的消息才能删除删除消息只是将消息的图文详情页失效，已经收到的用户，还是能在其本地看到消息卡片。
+       # 另外，删除群发消息只能删除图文消息和视频消息，其他类型的消息一经发送，无法删除。
+      def mass_delete_with_msgid(msg_id)
+        mass_url = "#{mass_base_url}/delete"
+        http_post(mass_url, {msg_id: msg_id})
+      end
+
+      # 预览接口【订阅号与服务号认证后均可用】
+      def mass_preview(openid, media_info, msg_type="mpnews")
+        openid_option = {touser: openid}
+        media = generate_media(msg_type, media_info, openid_option)
+        mass_url = "#{mass_base_url}/preview"
+        http_post(mass_url, media)
+      end
+
+      # 查询群发消息发送状态【订阅号与服务号认证后均可用】
+      def mass_get_status(msg_id)
+        mass_url = "#{mass_base_url}/get"
+        http_post(mass_url, {"msg_id" => msg_id})
+      end
+
+      private
+
+        def mass_base_url
+          "/message/mass"
+        end
+
+        def generate_media(msg_type, media_info, option)
+          msg_type = msg_type.to_s
+          if not MSG_TYPE.include?(msg_type)
+            raise MediaTypeException, "#{msg_type} is a invalid msg_type"
+          end
+          {
+            msg_type  => convert_media_info(msg_type, media_info),
+            "msgtype" => msg_type
+          }.merge(option)
+        end
+
+        # 如果用户填写的media信息，是字符串，则转换来符合的数据结构，如果 是hash，则直接使用用户的结构。
+        def convert_media_info(msg_type, media_info)
+          if media_info.is_a?(String)
+            if msg_type == "text"
+              return {content: media_info}
+            else
+              return {media_id: media_info}
+            end
+          end
+          media_info
+        end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/media.rb

@@ -0,0 +1,149 @@
+# encoding: utf-8
+
+module WeixinAuthorize
+  module Api
+    module Media
+      # 上传多媒体文件
+      # http请求方式: POST/FORM
+      # http://file.api.weixin.qq.com/cgi-bin/media/upload?access_token=ACCESS_TOKEN&type=TYPE
+      # 支持传路径或者文件类型
+      def upload_media(media, media_type)
+        file = process_file(media)
+        upload_media_url = "#{media_base_url}/upload"
+        http_post(upload_media_url, {media: file}, {type: media_type}, "file")
+      end
+
+      # 目前仅仅把下载链接返回给第三方开发者，由第三方开发者处理下载
+      def download_media_url(media_id)
+        download_media_url = WeixinAuthorize.endpoint_url("file", "#{media_base_url}/get")
+        params = URI.encode_www_form("access_token" => get_access_token,
+                                     "media_id"     => media_id)
+        download_media_url += "?#{params}"
+        download_media_url
+      end
+
+      # 上传图文消息素材, 主要用于群发消息接口
+      # {
+      #    "articles": [
+      #      {
+      #        "thumb_media_id":"mwvBelOXCFZiq2OsIU-p",
+      #        "author":"xxx",
+      #        "title":"Happy Day",
+      #        "content_source_url":"www.qq.com",
+      #        "content":"content",
+      #        "digest":"digest"
+      #      },
+      #      {
+      #        "thumb_media_id":"mwvBelOXCFZiq2OsIU-p",
+      #        "author":"xxx",
+      #        "title":"Happy Day",
+      #        "content_source_url":"www.qq.com",
+      #        "content":"content",
+      #        "digest":"digest"
+      #      }
+      #    ]
+      # }
+      # Option: author, content_source_url
+      def upload_mass_news(news=[])
+        upload_news_url = "#{media_base_url}/uploadnews"
+        http_post(upload_news_url, {articles: news})
+      end
+
+      # media_id: 需通过基础支持中的上传下载多媒体文件来得到
+      # https://file.api.weixin.qq.com/cgi-bin/media/uploadvideo?access_token=ACCESS_TOKEN
+
+      # return:
+      # {
+      #   "type":"video",
+      #   "media_id":"IhdaAQXuvJtGzwwc0abfXnzeezfO0NgPK6AQYShD8RQYMTtfzbLdBIQkQziv2XJc",
+      #   "created_at":1398848981
+      # }
+      def upload_mass_video(media_id, title="", desc="")
+        video_msg = {
+          "media_id"    => media_id,
+          "title"       => title,
+          "description" => desc
+        }
+
+        http_post("#{media_base_url}/uploadvideo", video_msg)
+      end
+
+      # 上传图文消息内的图片获取URL
+      # https://api.weixin.qq.com/cgi-bin/media/uploadimg?access_token=ACCESS_TOKEN
+      #
+      # return:
+      # {
+      #   "url":  "http://mmbiz.qpic.cn/mmbiz/gLO17UPS6FS2xsypf378iaNhWacZ1G1UplZYWEYfwvuU6Ont96b1roYs CNFwaRrSaKTPCUdBK9DgEHicsKwWCBRQ/0"
+      # }
+      def upload_image(image)
+        file = process_file(image)
+        upload_image_url = "#{media_base_url}/uploadimg"
+        http_post(upload_image_url, {media: file}, {type: 'image'}, 'file')
+      end
+
+      private
+
+        def media_base_url
+          "/media"
+        end
+
+        def process_file(media)
+          return media if media.is_a?(File) && jpep?(media)
+
+          media_url = media
+          uploader  = WeixinUploader.new
+
+          if http?(media_url) # remote
+            uploader.download!(media_url.to_s)
+          else # local
+            media_file = media.is_a?(File) ? media : File.new(media_url)
+            uploader.cache!(media_file)
+          end
+          file = process_media(uploader)
+          CarrierWave.clean_cached_files! # clear last one day cache
+          file
+        end
+
+        def process_media(uploader)
+          uploader = covert(uploader)
+          uploader.file.to_file
+        end
+
+        # JUST ONLY FOR JPG IMAGE
+        def covert(uploader)
+          # image process
+          unless (uploader.file.content_type =~ /image/).nil?
+            if !jpep?(uploader.file)
+              require "mini_magick"
+              # covert to jpeg
+              image = MiniMagick::Image.open(uploader.path)
+              image.format("jpg")
+              uploader.cache!(File.open(image.path))
+              image.destroy! # remove /tmp from MinMagick generate
+            end
+          end
+          uploader
+        end
+
+        def http?(uri)
+          return false if !uri.is_a?(String)
+          uri = URI.parse(uri)
+          uri.scheme =~ /^https?$/
+        end
+
+        def jpep?(file)
+          content_type = if file.respond_to?(:content_type)
+              file.content_type
+            else
+              content_type(file.path)
+            end
+          !(content_type =~ /jpeg/).nil?
+        end
+
+        def content_type(media_path)
+          MIME::Types.type_for(media_path).first.content_type
+        end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/menu.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Menu
+
+      # 自定义菜单查询接口
+      # https://api.weixin.qq.com/cgi-bin/menu/get?access_token=ACCESS_TOKEN
+      def menu
+        get_menu_url = "#{menu_base_url}/get"
+        http_get(get_menu_url)
+      end
+
+      # 自定义菜单删除接口
+      # https://api.weixin.qq.com/cgi-bin/menu/delete?access_token=ACCESS_TOKEN
+      def delete_menu
+        delete_menu_url = "#{menu_base_url}/delete"
+        http_get(delete_menu_url)
+      end
+
+      # 自定义菜单创建接口
+      # https://api.weixin.qq.com/cgi-bin/menu/create?access_token=ACCESS_TOKEN
+      def create_menu(menu)
+        menu = JSON.load(menu) if menu.is_a?(String)
+        create_menu_url = "#{menu_base_url}/create"
+        http_post(create_menu_url, menu)
+      end
+
+      private
+
+        def menu_base_url
+          "/menu"
+        end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/oauth.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Oauth
+
+      # 网站应用微信登录授权URL
+      # 文档：http://t.cn/RyZVWEY
+      def qrcode_authorize_url(redirect_uri, scope="snsapi_login", state="web_wx_login")
+        uri = encode_url(redirect_uri)
+        WeixinAuthorize.open_endpoint("/connect/qrconnect?appid=#{app_id}&redirect_uri=#{uri}&response_type=code&scope=#{scope}&state=#{state}#wechat_redirect")
+      end
+
+      # 应用授权作用域: scope
+      # snsapi_base （不弹出授权页面，直接跳转，只能获取用户openid），
+      # snsapi_userinfo （弹出授权页面，可通过openid拿到昵称、性别、所在地。并且，即使在未关注的情况下，只要用户授权，也能获取其信息）
+      # default is snsapi_base
+      # state 重定向后会带上state参数，开发者可以填写a-zA-Z0-9的参数值
+
+      # 如果用户点击同意授权，页面将跳转至 redirect_uri/?code=CODE&state=STATE。若用户禁止授权，则重定向后不会带上code参数，仅会带上state参数redirect_uri?state=STATE
+      def authorize_url(redirect_uri, scope="snsapi_base", state="weixin")
+        uri = encode_url(redirect_uri)
+        WeixinAuthorize.open_endpoint("/connect/oauth2/authorize?appid=#{app_id}&redirect_uri=#{uri}&response_type=code&scope=#{scope}&state=#{state}#wechat_redirect")
+      end
+
+      # 首先请注意，这里通过code换取的网页授权access_token,与基础支持中的access_token不同。公众号可通过下述接口来获取网页授权access_token。如果网页授权的作用域为snsapi_base，则本步骤中获取到网页授权access_token的同时，也获取到了openid，snsapi_base式的网页授权流程即到此为止。
+
+      # 微信通过请求 #authorize_url 方法后，会返回一个code到redirect_uri中
+      def get_oauth_access_token(code)
+        WeixinAuthorize.http_get_without_token("/sns/oauth2/access_token?appid=#{app_id}&secret=#{app_secret}&code=#{code}&grant_type=authorization_code", {}, "api")
+      end
+
+      # refresh_token: 填写通过access_token获取到的refresh_token参数
+      def refresh_oauth2_token(refresh_token)
+        WeixinAuthorize.http_get_without_token("/sns/oauth2/refresh_token?appid=#{app_id}&grant_type=refresh_token&refresh_token=#{refresh_token}", {}, "api")
+      end
+
+      # 如果网页授权作用域为snsapi_userinfo，则此时开发者可以通过access_token和openid拉取用户信息了。
+      def get_oauth_userinfo(openid, oauth_token, lang="zh_CN")
+        WeixinAuthorize.http_get_without_token("/sns/userinfo?access_token=#{oauth_token}&openid=#{openid}&lang=#{lang}", {}, "api")
+      end
+
+      private
+
+        def encode_url(uri)
+          ERB::Util.url_encode(uri)
+        end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/qrcode.rb

@@ -0,0 +1,62 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Qrcode
+    # http://mp.weixin.qq.com/wiki/index.php?title=生成带参数的二维码
+
+      # 临时二维码
+      def create_qr_scene(scene_id, expire_seconds=1800)
+        qrcode_infos = {action_name: "QR_SCENE", expire_seconds: expire_seconds}
+        qrcode_infos.merge!(action_info(scene_id))
+        http_post(qrcode_base_url, qrcode_infos)
+      end
+
+      # 临时字符串参数二维码
+      def create_qr_str_scene(options, expire_seconds=1800)
+        scene_str = options[:scene_str]
+        qrcode_infos = {action_name: "QR_STR_SCENE", expire_seconds: expire_seconds}
+        qrcode_infos.merge!(action_info(nil, scene_str))
+        http_post(qrcode_base_url, qrcode_infos)
+      end
+
+
+      # 永久二维码
+      # options: scene_id, scene_str
+      def create_qr_limit_scene(options)
+        scene_id = options[:scene_id]
+        qrcode_infos = {action_name: "QR_LIMIT_SCENE"}
+        qrcode_infos.merge!(action_info(scene_id))
+        http_post(qrcode_base_url, qrcode_infos)
+      end
+
+      # 为永久的字符串参数值
+      # options: scene_str
+      def create_qr_limit_str_scene(options)
+        scene_str = options[:scene_str]
+        qrcode_infos = {action_name: "QR_LIMIT_STR_SCENE"}
+        qrcode_infos.merge!(action_info(nil, scene_str))
+        http_post(qrcode_base_url, qrcode_infos)
+      end
+
+
+      # 通过ticket换取二维码, 直接访问即可显示！
+      def qr_code_url(ticket)
+        WeixinAuthorize.mp_endpoint("/showqrcode?ticket=#{ticket}")
+      end
+
+      private
+
+        def qrcode_base_url
+          "/qrcode/create"
+        end
+
+        def action_info(scene_id, scene_str=nil)
+          scene_info = {}
+          scene_info[:scene_id] = scene_id if !scene_id.nil?
+          scene_info[:scene_str] = scene_str if !scene_str.nil?
+          {action_info: {scene: scene_info}}
+        end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/template.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Template
+
+      # 设置所属行业
+      # 需要选择公众账号服务所处的2个行业，每月可更改1次所选行业；
+      # 初始化行业时，传入两个，每月更改时，传入一个即可。
+      def set_template_industry(industry_id1, industry_id2="")
+        industries = {industry_id1: industry_id1}
+        if industry_id2 != ""
+          industries.merge!({industry_id2: industry_id2})
+        end
+        http_post("/template/api_set_industry", industries)
+      end
+
+      # 获得模板ID
+      # code: 模板库中模板的编号，有“TM**”和“OPENTMTM**”等形式
+      def add_template(code)
+        http_post("/template/api_add_template", template_id_short: code)
+      end
+
+      # 发送模板消息
+      def send_template_msg(touser, template_id, url, topcolor, data)
+        msg = {
+          touser: touser, template_id: template_id,
+          url: url, topcolor: topcolor, data: data
+        }
+        http_post("/message/template/send", msg)
+      end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/user.rb

@@ -0,0 +1,69 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module User
+
+      # 获取用户基本信息
+      # https://api.weixin.qq.com/cgi-bin/user/info?access_token=ACCESS_TOKEN&openid=OPENID&lang=zh_CN
+      # lang: zh_CN, zh_TW, en
+      def user(openid, lang="zh_CN")
+        user_info_url = "#{user_base_url}/info"
+        http_get(user_info_url, {openid: openid, lang: lang})
+      end
+
+      # 批量获取用户基本信息
+      # https://api.weixin.qq.com/cgi-bin/user/info/batchget?access_token=ACCESS_TOKEN
+      # POST数据格式：JSON
+      # POST数据例子：
+        # {
+        #   "user_list": [
+        #     {
+        #       "openid": "otvxTs4dckWG7imySrJd6jSi0CWE",
+        #       "lang": "zh-CN"
+        #     },
+        #     {
+        #       "openid": "otvxTs_JZ6SEiP0imdhpi50fuSZg",
+        #       "lang": "zh-CN"
+        #     }
+        #   ]
+        # }
+      def users(user_list)
+        user_info_batchget_url = "#{user_base_url}/info/batchget"
+        post_body = user_list
+        http_post(user_info_batchget_url, post_body)
+      end
+
+      # 获取关注者列表
+      # https://api.weixin.qq.com/cgi-bin/user/get?access_token=ACCESS_TOKEN&next_openid=NEXT_OPENID
+      def followers(next_openid="")
+        followers_url = "#{user_base_url}/get"
+        http_get(followers_url, {next_openid: next_openid})
+      end
+
+      # 设置备注名
+      # http请求方式: POST（请使用https协议）
+      # https://api.weixin.qq.com/cgi-bin/user/info/updateremark?access_token=ACCESS_TOKEN
+      # POST数据格式：JSON
+      # POST数据例子：
+      # {
+      #   "openid":"oDF3iY9ffA-hqb2vVvbr7qxf6A0Q",
+      #   "remark":"pangzi"
+      # }
+      def update_remark(openid, remark)
+        update_url = "/user/info/updateremark"
+        post_body = {
+          openid: openid,
+          remark: remark
+        }
+        http_post(update_url, post_body)
+      end
+
+      private
+
+        def user_base_url
+          "/user"
+        end
+
+    end
+  end
+end