shixian-weixin_authorize 1.6.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ddd647e674ab2c8f834c42540dee573fb95c5c333e0d19d8e9aa18ac2fb1a0c4
+  data.tar.gz: e8cbff4304ee920df15650f45f1bfa56c36bb4c043ec9c5eff2517afd43fb6a8
+SHA512:
+  metadata.gz: bb8604f9768539c9518f156a07e349e7e90052e555c0c83d6eb80bf3331a82e20c3266a70ec2047e6f9128f6be96682e26ecf28c3787ffaad14ef358109db595
+  data.tar.gz: 680c307d76fe3c5c0faf6232ac43ba66afc197fe9c734da1bada9a76e4727f0830ed2826c43556dcc59b4b769557823e7e4dd9c5acedc1d5a8956639f2c79464

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-pro
+repo_token: aAaaYkiZrS6MHUIbKFdM1b5EnevvVZ4MQ

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation --color spec --drb
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+bundler_args: --without development
+rvm:
+  - 2.0.0
+script:
+  - bundle exec rspec spec
+services:
+  - redis
+addons:
+  code_climate:
+    repo_token: c91fecbbd9e414e7cc3ad7a7d99207145de0ac65a3368de09e8c19295343d399

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+group :test, :development do
+  gem "rspec"
+  gem 'redis-namespace'
+  gem 'simplecov', '~> 0.7.1', :require => false
+  gem "codeclimate-test-reporter", require: nil
+  gem 'coveralls', require: false
+  # For debugger
+  gem "pry-rails"
+
+  gem "pry-byebug"
+end
+
+# Specify your gem's dependencies in weixin_authorize.gemspec
+gemspec
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 lanrion
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# WeixinAuthorize
+
+[![Gem Version](https://badge.fury.io/rb/weixin_authorize.png)](http://badge.fury.io/rb/weixin_authorize)
+[![Build Status](https://secure.travis-ci.org/lanrion/weixin_authorize.png?branch=master)](http://travis-ci.org/lanrion/weixin_authorize)
+[![Code Climate](https://codeclimate.com/github/lanrion/weixin_authorize.png)](https://codeclimate.com/github/lanrion/weixin_authorize)
+[![Coverage Status](https://codeclimate.com/github/lanrion/weixin_authorize/coverage.png)](https://codeclimate.com/github/lanrion/weixin_authorize)
+
+Support using [Redis](http://redis.io) to store `access_token`
+
+[Wiki](https://github.com/lanrion/weixin_authorize/wiki)
+
+[Getting-Started](https://github.com/lanrion/weixin_authorize/wiki/Getting-Started)
+
+[JS SDK](https://github.com/lanrion/weixin_authorize/wiki/js-sdk)
+
+## 已经完成API
+
+* 客服消息
+* 模板消息
+* 用户分组管理
+* 用户信息管理
+* Oauth 2授权
+* 二维码生成
+* 自定义菜单
+* 群发消息
+* 多媒体管理
+* JS SDK（ticket支持缓存）
+
+## V2.0开发中： 
+https://github.com/lanrion/weixin_authorize/milestones/v2.0-dev
+
+1. 重构API实现，调用方式
+2. 对token，ticket的管理，提供第三方开发灵活者自助化
+3. 尝试RestClient的弃用，选择更高效的HTTP client包
+4. 支持更多的异常处理机制
+
+注意：查看Wiki或者源代码时，请切换对应的版本来查看。Master处于不断更新完善分支。
+
+## How to test
+
+Go to https://github.com/lanrion/weixin_authorize/issues/2, apply a weixin sandbox test account and follow this account
+
+https://github.com/lanrion/weixin_authorize/blob/master/spec/spec_helper.rb
+
+change your infos: 
+
+```ruby
+ENV["APPID"]="wxe371e0960de5426a"
+ENV["APPSECRET"]="572b93d3d20aea242692a804243a141b"
+ENV["OPENID"]="oEEoyuEasxionjR5HygmEOQGwRcw"
+```
+
+then run `rspec .`
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## 捐赠支持
+
+  如果你觉得我的gem对你有帮助，欢迎打赏支持，:smile:
+
+  ![](https://raw.githubusercontent.com/lanrion/my_config/master/imagex/donation_me.png)

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/weixin_authorize/api/custom.rb

@@ -0,0 +1,124 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Custom
+
+      # 发送文本消息
+      # {
+      #     "touser":"OPENID",
+      #     "msgtype":"text",
+      #     "text":
+      #     {
+      #        "content":"Hello World"
+      #     }
+      # }
+      def send_text_custom(to_user, content)
+        message = default_options(to_user).merge({text: {content: content}})
+        http_post(custom_base_url, message)
+      end
+
+      # 发送图片消息
+      # {
+      #     "touser":"OPENID",
+      #     "msgtype":"image",
+      #     "image":
+      #     {
+      #       "media_id":"MEDIA_ID"
+      #     }
+      # }
+      def send_image_custom(to_user, media_id)
+        message = default_options(to_user, "image").merge({image: {media_id: media_id}})
+        http_post(custom_base_url, message)
+      end
+
+      # 发送语音消息
+      # {
+      #     "touser":"OPENID",
+      #     "msgtype":"voice",
+      #     "voice":
+      #     {
+      #       "media_id":"MEDIA_ID"
+      #     }
+      # }
+      def send_voice_custom(to_user, media_id)
+        message = default_options(to_user, "voice").merge({voice: {media_id: media_id}})
+        http_post(custom_base_url, message)
+      end
+
+      # 发送视频消息
+      # {
+      #     "touser":"OPENID",
+      #     "msgtype":"video",
+      #     "video":
+      #     {
+      #       "media_id":"MEDIA_ID"
+      #     }
+      # }
+      def send_video_custom(to_user, media_id, options={})
+        video_options = {media_id: media_id}.merge(options)
+        message = default_options(to_user, "video").merge({video: video_options})
+        http_post(custom_base_url, message)
+      end
+
+      # 发送音乐消息
+      # {
+      #     "touser":"OPENID",
+      #     "msgtype":"music",
+      #     "music":
+      #     {
+      #      "title":"MUSIC_TITLE",
+      #     "description":"MUSIC_DESCRIPTION",
+      #      "musicurl":"MUSIC_URL",
+      #     "hqmusicurl":"HQ_MUSIC_URL",
+      #      "thumb_media_id":"THUMB_MEDIA_ID"
+      #     }
+      # }
+      def send_music_custom(to_user, media_id, musicurl, hqmusicurl, options={})
+        music_options = { thumb_media_id: media_id,
+                          musicurl: musicurl,
+                          hqmusicurl: hqmusicurl
+                        }.merge(options)
+        message = default_options(to_user, "music").merge({music: music_options})
+        http_post(custom_base_url, message)
+      end
+
+      # 发送图文消息
+      # {
+      #     "touser":"OPENID",
+      #     "msgtype":"news",
+      #      "news":{
+      #        "articles": [
+      #         {
+      #             "title":"Happy Day",
+      #             "description":"Is Really A Happy Day",
+      #             "url":"URL",
+      #             "picurl":"PIC_URL"
+      #         },
+      #         {
+      #             "title":"Happy Day",
+      #             "description":"Is Really A Happy Day",
+      #             "url":"URL",
+      #             "picurl":"PIC_URL"
+      #         }
+      #         ]
+      #    }
+      # }
+      def send_news_custom(to_user, articles=[])
+        message = default_options(to_user, "news").merge({news: {articles: articles}})
+        http_post(custom_base_url, message)
+      end
+
+      private
+
+        # https://api.weixin.qq.com/cgi-bin/message/custom/send?access_token=ACCESS_TOKEN
+        def custom_base_url
+          "/message/custom/send"
+        end
+
+        def default_options(to_user, msgtype="text")
+          {touser: to_user, msgtype: msgtype}
+        end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/data_cube.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module DataCube
+
+    end
+  end
+end

data/lib/weixin_authorize/api/groups.rb

@@ -0,0 +1,49 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Groups
+
+      # 创建分组
+      # https://api.weixin.qq.com/cgi-bin/groups/create?access_token=ACCESS_TOKEN
+      def create_group(group_name)
+        create_url = "#{group_base_url}/create"
+        http_post(create_url, {group: {name: group_name}})
+      end
+
+      # 查询所有分组
+      # https://api.weixin.qq.com/cgi-bin/groups/get?access_token=ACCESS_TOKEN
+      def groups
+        groups_url = "#{group_base_url}/get"
+        http_get(groups_url)
+      end
+
+      # 查询用户所在分组
+      # https://api.weixin.qq.com/cgi-bin/groups/getid?access_token=ACCESS_TOKEN
+      def get_group_for(openid)
+        group_url = "#{group_base_url}/getid"
+        http_post(group_url, {openid: openid})
+      end
+
+      # 修改分组名
+      # https://api.weixin.qq.com/cgi-bin/groups/update?access_token=ACCESS_TOKEN
+      def update_group_name(group_id, new_group_name)
+        group_url = "#{group_base_url}/update"
+        http_post(group_url, {group: {id: group_id, name: new_group_name}})
+      end
+
+      # 移动用户分组
+      # https://api.weixin.qq.com/cgi-bin/groups/members/update?access_token=ACCESS_TOKEN
+      def update_group_for_openid(openid, to_groupid)
+        group_url = "#{group_base_url}/members/update"
+        http_post(group_url, {openid: openid, to_groupid: to_groupid})
+      end
+
+      private
+
+        def group_base_url
+          "/groups"
+        end
+
+    end
+  end
+end

data/lib/weixin_authorize/api/mass.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Mass
+
+      MSG_TYPE = ["mpnews", "image", "text", "voice", "mpvideo"]
+
+      # 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.to_s, "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, msgtype="mpnews")
+        openid_option = {"touser" => openid}
+        media = generate_media(msgtype, 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(msgtype, media_info, option)
+          msgtype = msgtype.to_s
+          raise "#{msgtype} is a valid msgtype" if not MSG_TYPE.include?(msgtype)
+          {
+            msgtype   => convert_media_info(msgtype, media_info),
+            "msgtype" => msgtype
+          }.merge(option)
+        end
+
+        # 如果用户填写的media信息，是字符串，则转换来符合的数据结构，如果 是hash，则直接使用用户的结构。
+        def convert_media_info(msgtype, media_info)
+          if media_info.is_a?(String)
+            if msgtype == "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,136 @@
+# 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
+
+      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,38 @@
+# encoding: utf-8
+module WeixinAuthorize
+  module Api
+    module Oauth
+
+      # 应用授权作用域: 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")
+        require "erb"
+        redirect_uri = ERB::Util.url_encode(redirect_uri)
+        WeixinAuthorize.open_endpoint("/connect/oauth2/authorize?appid=#{app_id}&redirect_uri=#{redirect_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
+
+    end
+  end
+end