Module: WeixinAuthorize

Defined in:: lib/weixin_authorize.rb,
lib/weixin_authorize/client.rb,
lib/weixin_authorize/config.rb,
lib/weixin_authorize/version.rb,
lib/weixin_authorize/api/mass.rb,
lib/weixin_authorize/api/menu.rb,
lib/weixin_authorize/api/user.rb,
lib/weixin_authorize/api/media.rb,
lib/weixin_authorize/api/oauth.rb,
lib/weixin_authorize/api/custom.rb,
lib/weixin_authorize/api/groups.rb,
lib/weixin_authorize/api/qrcode.rb,
lib/weixin_authorize/token/store.rb,
lib/weixin_authorize/api/template.rb,
lib/weixin_authorize/api/data_cube.rb,
lib/weixin_authorize/js_ticket/store.rb,
lib/weixin_authorize/token/redis_store.rb,
lib/weixin_authorize/handler/exceptions.rb,
lib/weixin_authorize/token/object_store.rb,
lib/weixin_authorize/handler/global_code.rb,
lib/weixin_authorize/js_ticket/redis_store.rb,
lib/weixin_authorize/handler/result_handler.rb,
lib/weixin_authorize/js_ticket/object_store.rb,
lib/weixin_authorize/carrierwave/weixin_uploader.rb

Defined Under Namespace

Modules: Api, JsTicket, Token Classes: Client, Config, MediaTypeException, ResultHandler, ValidAccessTokenException, WeixinUploader

Constant Summary collapse

OK_MSG =

"ok".freeze

OK_CODE =

0.freeze

GRANT_TYPE =

"client_credential".freeze

CUSTOM_ENDPOINT = 用于标记endpoint可以直接使用url作为完整请求API

"custom_endpoint".freeze

VERSION =

"1.6.5"

GLOBAL_CODES =

{
  -1    => "系统繁忙",
  0     => "请求成功",
  40001 => "获取access_token时AppSecret错误，或者access_token无效",
  40002 => "不合法的凭证类型",
  40003 => "不合法的OpenID",
  40004 => "不合法的媒体文件类型",
  40005 => "不合法的文件类型",
  40006 => "不合法的文件大小",
  40007 => "不合法的媒体文件id",
  40008 => "不合法的消息类型",
  40009 => "不合法的图片文件大小",
  40010 => "不合法的语音文件大小",
  40011 => "不合法的视频文件大小",
  40012 => "不合法的缩略图文件大小",
  40013 => "不合法的APPID",
  40014 => "不合法的access_token",
  40015 => "不合法的菜单类型",
  40016 => "不合法的按钮个数",
  40017 => "不合法的按钮个数",
  40018 => "不合法的按钮名字长度",
  40019 => "不合法的按钮KEY长度",
  40020 => "不合法的按钮URL长度",
  40021 => "不合法的菜单版本号",
  40022 => "不合法的子菜单级数",
  40023 => "不合法的子菜单按钮个数",
  40024 => "不合法的子菜单按钮类型",
  40025 => "不合法的子菜单按钮名字长度",
  40026 => "不合法的子菜单按钮KEY长度",
  40027 => "不合法的子菜单按钮URL长度",
  40028 => "不合法的自定义菜单使用用户",
  40029 => "不合法的oauth_code",
  40030 => "不合法的refresh_token",
  40031 => "不合法的openid列表",
  40032 => "不合法的openid列表长度",
  40033 => "不合法的请求字符，不能包含xxxx格式的字符",
  40035 => "不合法的参数",
  40038 => "不合法的请求格式",
  40039 => "不合法的URL长度",
  40050 => "不合法的分组id",
  40051 => "分组名字不合法",
  41001 => "缺少access_token参数",
  41002 => "缺少appid参数",
  41003 => "缺少refresh_token参数",
  41004 => "缺少secret参数",
  41005 => "缺少多媒体文件数据",
  41006 => "缺少media_id参数",
  41007 => "缺少子菜单数据",
  41008 => "缺少oauth code",
  41009 => "缺少openid",
  42001 => "access_token超时",
  42002 => "refresh_token超时",
  42003 => "oauth_code超时",
  43001 => "需要GET请求",
  43002 => "需要POST请求",
  43003 => "需要HTTPS请求",
  43004 => "需要接收者关注",
  43005 => "需要好友关系",
  44001 => "多媒体文件为空",
  44002 => "POST的数据包为空",
  44003 => "图文消息内容为空",
  44004 => "文本消息内容为空",
  45001 => "多媒体文件大小超过限制",
  45002 => "消息内容超过限制",
  45003 => "标题字段超过限制",
  45004 => "描述字段超过限制",
  45005 => "链接字段超过限制",
  45006 => "图片链接字段超过限制",
  45007 => "语音播放时间超过限制",
  45008 => "图文消息超过限制",
  45009 => "接口调用超过限制",
  45010 => "创建菜单个数超过限制",
  45015 => "回复时间超过限制",
  45016 => "系统分组，不允许修改",
  45017 => "分组名字过长",
  45018 => "分组数量超过上限",
  46001 => "不存在媒体数据",
  46002 => "不存在的菜单版本",
  46003 => "不存在的菜单数据",
  46004 => "不存在的用户",
  47001 => "解析JSON/XML内容错误",
  48001 => "api功能未授权",
  50001 => "用户未授权该api",
  50002 => "用户受限，可能是违规后接口被封禁",
  61451 => "参数错误(invalid parameter)",
  61452 => "无效客服账号(invalid kf_account)",
  61453 => "客服帐号已存在(kf_account exsited)",
  61454 => "客服帐号名长度超过限制(仅允许10个英文字符，不包括@及@后的公众号的微信号)(invalid kf_acount length)",
  61455 => "客服帐号名包含非法字符(仅允许英文+数字)(illegal character in kf_account)",
  61456 => "客服帐号个数超过限制(10个客服账号)(kf_account count exceeded)",
  61457 => "无效头像文件类型(invalid file type)",
  61450 => "系统错误(system error)",
  61500 => "日期格式错误",
  61501 => "日期范围错误",
  9001001 => "POST数据参数不合法",
  9001002 => "远端服务不可用",
  9001003 => "Ticket不合法",
  9001004 => "获取摇周边用户信息失败",
  9001005 => "获取商户信息失败",
  9001006 => "获取OpenID失败",
  9001007 => "上传文件缺失",
  9001008 => "上传素材的文件类型不合法",
  9001009 => "上传素材的文件尺寸不合法",
  9001010 => "上传失败",
  9001020 => "帐号不合法",
  9001021 => "已有设备激活率低于50%，不能新增设备",
  9001022 => "设备申请数不合法，必须为大于0的数字",
  9001023 => "已存在审核中的设备ID申请",
  9001024 => "一次查询设备ID数量不能超过50",
  9001025 => "设备ID不合法",
  9001026 => "页面ID不合法",
  9001027 => "页面参数不合法",
  9001028 => "一次删除页面ID数量不能超过10",
  9001029 => "页面已应用在设备中，请先解除应用关系再删除",
  9001030 => "一次查询页面ID数量不能超过50",
  9001031 => "时间区间不合法",
  9001032 => "保存设备与页面的绑定关系参数错误",
  9001033 => "门店ID不合法",
  9001034 => "设备备注信息过长",
  9001035 => "设备申请参数不合法",
  9001036 => "查询起始值begin不合法"
}

Class Attribute Summary collapse

.config ⇒ Object

Returns the value of attribute config.

Class Method Summary collapse

Class Attribute Details

.config ⇒ `Object`

Returns the value of attribute config.



5
6
7

# File 'lib/weixin_authorize/config.rb', line 5

def config
  @config
end

Class Method Details

.api_endpoint ⇒ `Object`



75
76
77

# File 'lib/weixin_authorize.rb', line 75

def api_endpoint
  "https://api.weixin.qq.com"
end

.calculate_expire(expires_in) ⇒ `Object`



91
92
93

# File 'lib/weixin_authorize.rb', line 91

def calculate_expire(expires_in)
  Time.now.to_i + expires_in.to_i - key_expired.to_i
end

.configure {|self.config ||= Config.new| ... } ⇒ `Object`

Yields:

(self.config ||= Config.new)



7
8
9

# File 'lib/weixin_authorize/config.rb', line 7

def configure
  yield self.config ||= Config.new
end

.endpoint_url(endpoint, url) ⇒ `Object`

# File 'lib/weixin_authorize.rb', line 65

def endpoint_url(endpoint, url)
  # 此处为了应对第三方开发者如果自助对接接口时，URL不规范的情况下，可以直接使用URL当为endpoint
  return url if endpoint == CUSTOM_ENDPOINT
  send("#{endpoint}_endpoint") + url
end

.file_endpoint ⇒ `Object`



79
80
81

# File 'lib/weixin_authorize.rb', line 79

def file_endpoint
  "http://file.api.weixin.qq.com/cgi-bin"
end

.http_get_without_token(url, url_params = {}, endpoint = "plain") ⇒ `Object`

# File 'lib/weixin_authorize.rb', line 39

def http_get_without_token(url, url_params={}, endpoint="plain")
  get_api_url = endpoint_url(endpoint, url)
  load_json(resource(get_api_url).get(params: url_params))
end

.http_post_without_token(url, post_body = {}, url_params = {}, endpoint = "plain") ⇒ `Object`

# File 'lib/weixin_authorize.rb', line 44

def http_post_without_token(url, post_body={}, url_params={}, endpoint="plain")
  post_api_url = endpoint_url(endpoint, url)
  # to json if invoke "plain"
  if endpoint == "plain" || endpoint == CUSTOM_ENDPOINT
    post_body = JSON.dump(post_body)
  end
  load_json(resource(post_api_url).post(post_body, params: url_params))
end

.key_expired ⇒ `Object`



16
17
18

# File 'lib/weixin_authorize/config.rb', line 16

def key_expired
  config.key_expired || 100
end

.load_json(string) ⇒ `Object`

return hash

# File 'lib/weixin_authorize.rb', line 58

def load_json(string)
  result_hash = JSON.parse(string.force_encoding("UTF-8").gsub(/[\u0011-\u001F]/, ""))
  code   = result_hash.delete("errcode")
  en_msg = result_hash.delete("errmsg")
  ResultHandler.new(code, en_msg, result_hash)
end

.mp_endpoint(url) ⇒ `Object`



83
84
85

# File 'lib/weixin_authorize.rb', line 83

def mp_endpoint(url)
  "https://mp.weixin.qq.com/cgi-bin#{url}"
end

.open_endpoint(url) ⇒ `Object`



87
88
89

# File 'lib/weixin_authorize.rb', line 87

def open_endpoint(url)
  "https://open.weixin.qq.com#{url}"
end

.plain_endpoint ⇒ `Object`



71
72
73

# File 'lib/weixin_authorize.rb', line 71

def plain_endpoint
  "#{api_endpoint}/cgi-bin"
end

.resource(url) ⇒ `Object`



53
54
55

# File 'lib/weixin_authorize.rb', line 53

def resource(url)
  RestClient::Resource.new(url, rest_client_options)
end

.rest_client_options ⇒ `Object`

可选配置: RestClient timeout, etc. key 必须是符号如果出现 RestClient::SSLCertificateNotVerified Exception: SSL_connect returned=1 errno=0 state=SSLv3 read server certificate B: certificate verify failed 这个错，除了改 verify_ssl: true，请参考：www.extendi.it/blog/2015/5/23/47-sslv3-read-server-certificate-b-certificate-verify-failed

# File 'lib/weixin_authorize/config.rb', line 24

def rest_client_options
  if config.nil?
    return {timeout: 5, open_timeout: 5, verify_ssl: true}
  end
  config.rest_client_options
end

.weixin_redis ⇒ `Object`

# File 'lib/weixin_authorize/config.rb', line 11

def weixin_redis
  return nil if config.nil?
  @redis ||= config.redis
end

Module: WeixinAuthorize

Defined Under Namespace

Constant Summary collapse

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.config ⇒ Object

Class Method Details

.api_endpoint ⇒ Object

.calculate_expire(expires_in) ⇒ Object

.configure {|self.config ||= Config.new| ... } ⇒ Object

.endpoint_url(endpoint, url) ⇒ Object

.file_endpoint ⇒ Object

.http_get_without_token(url, url_params = {}, endpoint = "plain") ⇒ Object

.http_post_without_token(url, post_body = {}, url_params = {}, endpoint = "plain") ⇒ Object

.key_expired ⇒ Object

.load_json(string) ⇒ Object

.mp_endpoint(url) ⇒ Object

.open_endpoint(url) ⇒ Object

.plain_endpoint ⇒ Object

.resource(url) ⇒ Object

.rest_client_options ⇒ Object

.weixin_redis ⇒ Object