qy_wechat_api 1.0.0.beta1

data/lib/qy_wechat_api/api/message.rb

@@ -0,0 +1,123 @@
+# encoding: utf-8
+
+module QyWechatApi
+  module Api
+    class Message < Base
+
+      # 发送文本
+      def send_text(users, parties, tags, agent_id, content, safe=0)
+        params = common_params("text", agent_id, users, parties, tags, safe)
+        params.merge!({text: {content: content}})
+        http_post("send", params)
+      end
+
+      # 发送图片
+      def send_image(users, parties, tags, agent_id, media_id, safe=0)
+        params = common_params("image", agent_id, users, parties, tags, safe)
+        params.merge!({image: {media_id: media_id}})
+        http_post("send", params)
+      end
+
+      # 发送语音
+      def send_voice(users, parties, tags, agent_id, media_id, safe=0)
+        params = common_params("voice", agent_id, users, parties, tags, safe)
+        params.merge!({voice: {media_id: media_id}})
+        http_post("send", params)
+      end
+
+      # 发送视频
+      # media_options: {title: "title", description: "Description"}
+      def send_video(users, parties, tags, agent_id, media_id, media_options={}, safe=0)
+        params = common_params("video", agent_id, users, parties, tags, safe)
+        params.merge!({
+          video: {
+            media_id: media_id,
+            title: media_options["title"],
+            description: media_options["description"],
+          }
+        })
+        http_post("send", params)
+      end
+
+      # 文件信息
+      def send_file(users, parties, tags, agent_id, media_id, safe=0)
+        params = common_params("file", agent_id, users, parties, tags, safe)
+        params.merge!({file: {media_id: media_id}})
+        http_post("send", params)
+      end
+
+      # news消息
+      # "articles":[
+      #    {
+      #        "title": "Title",
+      #        "description": "Description",
+      #        "url": "URL",
+      #        "picurl": "PIC_URL"
+      #    },
+      #    {
+      #        "title": "Title",
+      #        "description": "Description",
+      #        "url": "URL",
+      #        "picurl": "PIC_URL"
+      #    }
+      #  ]
+      def send_news(users, parties, tags, agent_id, articles, safe=0)
+        params = common_params("news", agent_id, users, parties, tags, safe)
+        params.merge!({news: {articles: articles}})
+        http_post("send", params)
+      end
+
+      # mpnews
+      # articles":[
+      #            {
+      #                "title": "Title",
+      #                "thumb_media_id": "id",
+      #                "author": "Author",
+      #                "content_source_url": "URL",
+      #                "content": "Content",
+      #                "digest": "Digest description",
+      #                "show_cover_pic": "0"
+      #            },
+      #            {
+      #                "title": "Title",
+      #                "thumb_media_id": "id",
+      #                "author": "Author",
+      #                "content_source_url": "URL",
+      #                "content": "Content",
+      #                "digest": "Digest description",
+      #                "show_cover_pic": "0"
+      #            }
+      #        ]
+      def send_mpnews(users, parties, tags, agent_id, articles, safe=0)
+        params = common_params("mpnews", agent_id, users, parties, tags, safe)
+        params.merge!({mpnews: {articles: articles}})
+        http_post("send", params)
+      end
+
+      private
+
+        def base_url
+          "/message"
+        end
+
+        # 通用函数
+        def common_params(msg_type, agent_id, users=[], parties=[], tags=[], safe=0)
+          params = {
+            touser: join(users),
+            toparty: join(parties),
+            msgtype: msg_type,
+            agentid: agent_id,
+            totag: join(tags)
+          }
+          params.merge!({safe: safe}) if msg_type != "news"
+          params
+        end
+
+        def join(array, split="|")
+          return array if array.is_a?(String)
+          array.join(split)
+        end
+
+    end
+  end
+end

data/lib/qy_wechat_api/api/oauth.rb

@@ -0,0 +1,27 @@
+# encoding: utf-8
+module QyWechatApi
+  module Api
+    class Oauth < Base
+
+      # appid 是 企业的CorpID
+      # redirect_uri  是 授权后重定向的回调链接地址，请使用urlencode对链接进行处理
+      # response_type 是 返回类型，此时固定为：code
+      # scope 是 应用授权作用域，此时固定为：snsapi_base
+      # state 否 重定向后会带上state参数，企业可以填写a-zA-Z0-9的参数值
+      # #wechat_redirect 是微信终端使用此参数判断是否需要带上身份信息
+      # https://open.weixin.qq.com/connect/oauth2/authorize?appid=CORPID&redirect_uri=REDIRECT_URI&response_type=code&scope=SCOPE&state=STATE#wechat_redirect
+      def authorize_url(redirect_uri, state="qy_wechat")
+        require "erb"
+        redirect_uri = ERB::Util.url_encode(redirect_uri)
+        QyWechatApi.open_endpoint("/connect/oauth2/authorize?appid=#{corp_id}&redirect_uri=#{redirect_uri}&response_type=code&scope=snsapi_base&state=#{state}#wechat_redirect")
+      end
+
+      # 根据code获取成员信息
+      # https://qyapi.weixin.qq.com/cgi-bin/user/getuserinfo?access_token=ACCESS_TOKEN&code=CODE&agentid=AGENTID
+      def get_user_info(code, agent_id)
+        http_get("user/getuserinfo", {code: code, agentid: agent_id})
+      end
+
+    end
+  end
+end

data/lib/qy_wechat_api/api/tag.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+module QyWechatApi
+  module Api
+    class Tag < Base
+
+      def create(name)
+        http_post("create", {tagname: name})
+      end
+
+      # tagid 是 标签ID
+      # tagname 是
+      def update(id, name)
+        http_post("update", {tagid: id, tagname: name})
+      end
+
+      def delete(id)
+        http_get("delete", {tagid: id})
+      end
+
+      def get(id)
+        http_get("get", {tagid: id})
+      end
+
+      # tagid 是 标签ID
+      # userlist  是 企业员工ID列表
+      def add_tag_users(id, user_ids)
+        raise "企业员工ID列表 必须为数组" if !user_ids.is_a?(Array)
+        http_post("addtagusers", {tagid: id, userlist: user_ids})
+      end
+
+      # tagid 是 标签ID
+      # userlist  是 企业员工ID列表
+      def delete_tag_users(id, user_ids)
+        raise "企业员工ID列表 必须为数组" if !user_ids.is_a?(Array)
+        http_post("deltagusers", {tagid: id, userlist: user_ids})
+      end
+
+      def list
+        http_get("list")
+      end
+
+      private
+
+        def base_url
+          "/tag"
+        end
+
+    end
+  end
+end

data/lib/qy_wechat_api/api/user.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module QyWechatApi
+  module Api
+    class User < Base
+
+      # userid  是 员工UserID。对应管理端的帐号，企业内必须唯一。长度为1~64个字符
+      # name  是 成员名称。长度为1~64个字符
+      # department  否 成员所属部门id列表。注意，每个部门的直属员工上限为1000个
+      # position  否 职位信息。长度为0~64个字符
+      # mobile  否 手机号码。企业内必须唯一，mobile/weixinid/email三者不能同时为空
+      # gender  否 性别。gender=0表示男，=1表示女。默认gender=0
+      # tel 否 办公电话。长度为0~64个字符
+      # email 否 邮箱。长度为0~64个字符。企业内必须唯一
+      # weixinid  否 微信号。企业内必须唯一
+      # extattr 否 扩展属性。扩展属性需要在WEB管理端创建后才生效，否则忽略未知属性的赋值
+      def create(user_id, name, options={})
+        user = {userid: user_id}
+        user[:name] = name
+        user.merge!(options)
+        http_post("create", user)
+      end
+
+      def update(user_id, options={})
+        user = {userid: user_id}
+        user.merge!(options)
+        http_post("update", user)
+      end
+
+      def delete(id)
+        http_get("get", {userid: id})
+      end
+
+      def get(id)
+        http_get("get", {userid: id})
+      end
+
+      # department_id 是 获取的部门id
+      # fetch_child 否 1/0：是否递归获取子部门下面的成员
+      # status  否 0获取全部员工，1获取已关注成员列表，2获取禁用成员列表，4获取未关注成员列表。status可叠加
+      def simple_list(department_id, fetch_child=nil, status=nil)
+        params = {department_id: department_id}
+        params[:fetch_child] = fetch_child if not fetch_child.nil?
+        params[:status] = status if not status.nil?
+        http_get("simplelist", params)
+      end
+
+      private
+
+        def base_url
+          "/user"
+        end
+
+    end
+  end
+end

data/lib/qy_wechat_api/carrierwave/qy_wechat_api_uploader.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+module QyWechatApi
+  class QyWechatApiUploader < CarrierWave::Uploader::Base
+  end
+end

data/lib/qy_wechat_api/client.rb

@@ -0,0 +1,64 @@
+# encoding: utf-8
+
+module QyWechatApi
+  class Client
+    attr_accessor :corp_id, :group_secret, :expired_at # Time.now + expires_in
+    attr_accessor :access_token, :redis_key, :storage
+
+    def initialize(corp_id, group_secret, redis_key=nil)
+      @corp_id      = corp_id
+      @group_secret = group_secret
+      @redis_key    = security_redis_key((redis_key || "qy_" + group_secret))
+      @storage      = Storage.init_with(self)
+    end
+
+    # return token
+    def get_access_token
+      @storage.access_token
+    end
+
+    # 检查appid和app_secret是否有效。
+    def is_valid?
+      @storage.valid?
+    end
+
+    # 管理部门API
+    def department
+      Api::Department.new(get_access_token)
+    end
+
+    # 管理成员API
+    def user
+      Api::User.new(get_access_token)
+    end
+
+    # 管理标签API
+    def tag
+      Api::Tag.new(get_access_token)
+    end
+
+    # 管理多媒体文件API
+    def media
+      Api::Media.new(get_access_token)
+    end
+
+    def message
+      Api::Message.new(get_access_token)
+    end
+
+    def menu
+      Api::Menu.new(get_access_token)
+    end
+
+    def oauth
+      Api::Oauth.new(get_access_token, corp_id)
+    end
+
+    private
+
+      def security_redis_key(key)
+        Digest::MD5.hexdigest(key.to_s).upcase
+      end
+
+  end
+end

data/lib/qy_wechat_api/config.rb

@@ -0,0 +1,20 @@
+module QyWechatApi
+
+  class << self
+
+    attr_accessor :config
+
+    def configure
+      yield self.config ||= Config.new
+    end
+
+    def weixin_redis
+      return nil if QyWechatApi.config.nil?
+      @redis ||= QyWechatApi.config.redis
+    end
+  end
+
+  class Config
+    attr_accessor :redis
+  end
+end

data/lib/qy_wechat_api/handler.rb

@@ -0,0 +1,3 @@
+require "qy_wechat_api/handler/errors"
+require "qy_wechat_api/handler/global_code"
+require "qy_wechat_api/handler/result_handler"

data/lib/qy_wechat_api/handler/errors.rb

@@ -0,0 +1,5 @@
+module QyWechatApi
+  module Errors
+    class ValidAccessTokenException < RuntimeError;end
+  end
+end

data/lib/qy_wechat_api/handler/global_code.rb

@@ -0,0 +1,156 @@
+# encoding: utf-8
+module QyWechatApi
+  GLOBAL_CODES = {
+    -1    => "系统繁忙",
+    0     => "请求成功",
+    40001 => "获取access_token时Secret错误，或者access_token无效",
+    40002 => "不合法的凭证类型",
+    40003 => "不合法的UserID",
+    40004 => "不合法的媒体文件类型",
+    40005 => "不合法的文件类型",
+    40006 => "不合法的文件大小",
+    40007 => "不合法的媒体文件id",
+    40008 => "不合法的消息类型",
+    40013 => "不合法的corpid",
+    40014 => "不合法的access_token",
+    40015 => "不合法的菜单类型",
+    40016 => "不合法的按钮个数",
+    40017 => "不合法的按钮类型",
+    40018 => "不合法的按钮名字长度",
+    40019 => "不合法的按钮KEY长度",
+    40020 => "不合法的按钮URL长度",
+    40021 => "不合法的菜单版本号",
+    40022 => "不合法的子菜单级数",
+    40023 => "不合法的子菜单按钮个数",
+    40024 => "不合法的子菜单按钮类型",
+    40025 => "不合法的子菜单按钮名字长度",
+    40026 => "不合法的子菜单按钮KEY长度",
+    40027 => "不合法的子菜单按钮URL长度",
+    40028 => "不合法的自定义菜单使用员工",
+    40029 => "不合法的oauth_code",
+    40031 => "不合法的UserID列表",
+    40032 => "不合法的UserID列表长度",
+    40033 => "不合法的请求字符，不能包含xxxx格式的字符",
+    40035 => "不合法的参数",
+    40038 => "不合法的请求格式",
+    40039 => "不合法的URL长度",
+    40040 => "不合法的插件token",
+    40041 => "不合法的插件id",
+    40042 => "不合法的插件会话",
+    40048 => "url中包含不合法domain",
+    40054 => "不合法的子菜单url域名",
+    40055 => "不合法的按钮url域名",
+    40056 => "不合法的agentid",
+    40057 => "不合法的callbackurl",
+    40058 => "不合法的红包参数",
+    40059 => "不合法的上报地理位置标志位",
+    40060 => "设置上报地理位置标志位时没有设置callbackurl",
+    40061 => "设置应用头像失败",
+    40062 => "不合法的应用模式",
+    40063 => "红包参数为空",
+    40064 => "管理组名字已存在",
+    40065 => "不合法的管理组名字长度",
+    40066 => "不合法的部门列表",
+    40067 => "标题长度不合法",
+    40068 => "不合法的标签ID",
+    40069 => "不合法的标签ID列表",
+    40070 => "列表中所有标签（用户）ID都不合法",
+    40071 => "不合法的标签名字，标签名字已经存在",
+    40072 => "不合法的标签名字长度",
+    40073 => "不合法的openid",
+    40074 => "news消息不支持指定为高保密消息",
+    41001 => "缺少access_token参数",
+    41002 => "缺少corpid参数",
+    41003 => "缺少refresh_token参数",
+    41004 => "缺少secret参数",
+    41005 => "缺少多媒体文件数据",
+    41006 => "缺少media_id参数",
+    41007 => "缺少子菜单数据",
+    41008 => "缺少oauth code",
+    41009 => "缺少UserID",
+    41010 => "缺少url",
+    41011 => "缺少agentid",
+    41012 => "缺少应用头像mediaid",
+    41013 => "缺少应用名字",
+    41014 => "缺少应用描述",
+    41015 => "缺少Content",
+    41016 => "缺少标题",
+    41017 => "缺少标签ID",
+    41018 => "缺少标签名字",
+    42001 => "access_token超时",
+    42002 => "refresh_token超时",
+    42003 => "oauth_code超时",
+    42004 => "插件token超时",
+    43001 => "需要GET请求",
+    43002 => "需要POST请求",
+    43003 => "需要HTTPS",
+    43004 => "需要接收者关注",
+    43005 => "需要好友关系",
+    43006 => "需要订阅",
+    43007 => "需要授权",
+    43008 => "需要支付授权",
+    43009 => "需要员工已关注",
+    43010 => "需要处于回调模式",
+    43011 => "需要企业授权",
+    44001 => "多媒体文件为空",
+    44002 => "POST的数据包为空",
+    44003 => "图文消息内容为空",
+    44004 => "文本消息内容为空",
+    45001 => "多媒体文件大小超过限制",
+    45002 => "消息内容超过限制",
+    45003 => "标题字段超过限制",
+    45004 => "描述字段超过限制",
+    45005 => "链接字段超过限制",
+    45006 => "图片链接字段超过限制",
+    45007 => "语音播放时间超过限制",
+    45008 => "图文消息超过限制",
+    45009 => "接口调用超过限制",
+    45010 => "创建菜单个数超过限制",
+    45015 => "回复时间超过限制",
+    45016 => "系统分组，不允许修改",
+    45017 => "分组名字过长",
+    45018 => "分组数量超过上限",
+    45024 => "账号数量超过上限",
+    46001 => "不存在媒体数据",
+    46002 => "不存在的菜单版本",
+    46003 => "不存在的菜单数据",
+    46004 => "不存在的员工",
+    47001 => "解析JSON/XML内容错误",
+    48002 => "Api禁用",
+    50001 => "redirect_uri未授权",
+    50002 => "员工不在权限范围",
+    50003 => "应用已停用",
+    50004 => "员工状态不正确（未关注状态）",
+    50005 => "企业已禁用",
+    60001 => "部门长度不符合限制",
+    60002 => "部门层级深度超过限制",
+    60003 => "部门不存在",
+    60004 => "父亲部门不存在",
+    60005 => "不允许删除有成员的部门",
+    60006 => "不允许删除有子部门的部门",
+    60007 => "不允许删除根部门",
+    60008 => "部门名称已存在",
+    60009 => "部门名称含有非法字符",
+    60010 => "部门存在循环关系",
+    60011 => "管理员权限不足，（user/department/agent）无权限",
+    60012 => "不允许删除默认应用",
+    60013 => "不允许关闭应用",
+    60014 => "不允许开启应用",
+    60015 => "不允许修改默认应用可见范围",
+    60016 => "不允许删除存在成员的标签",
+    60017 => "不允许设置企业",
+    60102 => "UserID已存在",
+    60103 => "手机号码不合法",
+    60104 => "手机号码已存在",
+    60105 => "邮箱不合法",
+    60106 => "邮箱已存在",
+    60107 => "微信号不合法",
+    60108 => "微信号已存在",
+    60109 => "QQ号已存在",
+    60110 => "部门个数超出限制",
+    60111 => "UserID不存在",
+    60112 => "成员姓名不合法",
+    60113 => "身份认证信息（微信号/手机/邮箱）不能同时为空",
+    60114 => "性别不合法"
+  } unless defined?(GLOBAL_CODES)
+end