Module: BlsmMpWx

Defined in:
lib/blsm-mp-wx.rb,
lib/blsm-mp-wx/version.rb,
lib/blsm-mp-wx/model/vd_mp_wx.rb,
lib/blsm-mp-wx/model/vd_mp_msg.rb,
lib/blsm-mp-wx/model/active_record.rb

Defined Under Namespace

Classes: BaseRecord, VdMpMsg, VdMpWx

Constant Summary collapse

ERROR_CODES =
{
    404 => {code: 404, msg: '未知的公众号,如有疑问,请联系[email protected]'}
}
VERSION =
"0.3.2"

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.APP_IDObject

Returns the value of attribute APP_ID.



23
24
25
# File 'lib/blsm-mp-wx.rb', line 23

def APP_ID
  @APP_ID
end

.APP_ID_2Object

Returns the value of attribute APP_ID_2.



24
25
26
# File 'lib/blsm-mp-wx.rb', line 24

def APP_ID_2
  @APP_ID_2
end

Class Method Details

.access_token(app_id = nil) ⇒ Object

根据app_id获取access_token 系统会根据当前的access_token即过期时间,自动更新并返回开发者无需关心这里的access_token怎么更新

Parameters

  • app_id -公众号的appid



33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
# File 'lib/blsm-mp-wx.rb', line 33

def access_token(app_id=nil)
  app_id ||= self.APP_ID
  app = VdMpWx.where(app_id: app_id).first
  return nil unless app
  return app.access_token unless app.access_token_expired? #没有过期,直接返回

  response = Faraday.new(:url => 'https://api.weixin.qq.com').get do |req|
    req.url '/cgi-bin/token'
    req.params[:appid] = app.app_id
    req.params[:secret] = app.app_secret
    req.params[:grant_type] = 'client_credential'
  end

  json_obj = parse_json(response.body)
  return nil unless json_obj
  return nil unless json_obj.has_key?('access_token')

  access_token = json_obj['access_token']
  app.save_access_token(access_token, json_obj['expires_in'])

  access_token
end

.all_openid(app_id = nil, next_openid = '', returned_openids = []) ⇒ Object



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/blsm-mp-wx.rb', line 317

def all_openid(app_id=nil, next_openid='', returned_openids = [])
  app_id ||= self.APP_ID
  p "getting openid... next_openid:#{next_openid}"

  begin
    conn = Faraday.new(:url => 'https://api.weixin.qq.com')
    response = conn.get do |req|
      req.url '/cgi-bin/user/get'
      req.headers['Content-Type'] = 'application/json'
      req.params[:access_token] = access_token(app_id)
      req.params[:next_openid] = next_openid
    end
    response_body = response.body
    p response_body
    jobject = JSON.parse(response_body)

    if jobject
      if jobject['data'] && jobject['data']['openid']
        p "total:#{jobject['total']},count:#{jobject['count']}"
        returned_openids += jobject['data']['openid']
      end

      if jobject['next_openid'].to_s != ''
        return all_openid(jobject['next_openid'], returned_openids)
      end
    end

    if !jobject || jobject['next_openid'].to_s ==''
      return returned_openids
    end
  rescue Exception => e
    puts e
  end
  returned_openids
end

.batchget_material(app_id, type, offset, count = 20) ⇒ Object

批量获取公众号的素材列表

Parameters
  • app_id

  • type 素材类型:voice、video、image、news

  • offset

  • count



294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/blsm-mp-wx.rb', line 294

def batchget_material(app_id, type, offset, count=20)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  return nil unless access_token
  response = Faraday.new(:url => 'https://api.weixin.qq.com').post do |req|
    req.url '/cgi-bin/material/batchget_material'
    req.headers['Content-Type'] = 'application/json'
    data = {
        type: type,
        offset: offset,
        count: count
    }
    req.params[:access_token] = access_token
    req.body = data.to_json
  end

  json_obj = parse_json(response.body)
  return nil unless json_obj
  return nil unless json_obj.has_key?('total_count')
  json_obj.inject({}) { |memo, (key, v)| memo[key.to_s.to_sym]=v; memo }
end

.create_msg(app_id, openid, content, msg_name, template_msg = true) ⇒ Object

创建消息,存储到消息队列中

Parameters

  • app_id - 公众号的唯一标识

  • openid - 发送给用户的openid

  • content - 消息内容

  • msg_name - 消息种类:new_order(新订单通知)、balance(结算通知)、score_change(积分变动通知)、order(订单通知)、todo(待处理)、split_order(分单)、custom(普通消息)

new_order => content: {touser:'openid',order_id:''} 系统自动优先使用模板消息发送通知
balance   => content: {touser:'openid',clearing_id} 系统自动优先使用模板消息发送通知
score_change => content: {touser:'',change:5,total:25,content:'邀请他人。。。。'}


220
221
222
223
224
225
226
227
228
229
230
231
232
233
# File 'lib/blsm-mp-wx.rb', line 220

def create_msg(app_id, openid, content, msg_name, template_msg=true)
  app_id ||= self.APP_ID
  return nil unless openid
  return nil unless content[:touser]==openid
  # return nil unless MP_MSG_TYPES.include?(msg_name)
  VdMpMsg.create({
                     app_id: app_id,
                     openid: openid,
                     content: content.to_json,
                     msg_name: msg_name,
                     template_msg: template_msg,
                     status: 'none'
                 })
end

.create_msg!(app_id, openid, content, msg_name, template_msg = true) ⇒ Object



236
237
238
239
240
241
242
243
244
245
246
# File 'lib/blsm-mp-wx.rb', line 236

def create_msg!(app_id, openid, content, msg_name, template_msg=true)
  app_id ||= self.APP_ID
  VdMpMsg.create!({
                      app_id: app_id,
                      openid: openid,
                      content: content.to_json,
                      msg_name: msg_name,
                      template_msg: template_msg,
                      status: 'none'
                  })
end

.gen_forever_qr_ticket(app_id = nil, scene_id) ⇒ Object

生成永久二维码ticket



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
# File 'lib/blsm-mp-wx.rb', line 173

def gen_forever_qr_ticket(app_id=nil, scene_id)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  return nil unless access_token

  response = Faraday.new(:url => 'https://api.weixin.qq.com').post do |req|
    req.url '/cgi-bin/qrcode/create'
    req.params[:access_token] = access_token
    req.body="{\"action_name\": \"QR_LIMIT_SCENE\", \"action_info\": {\"scene\": {\"scene_id\": #{scene_id}}}}"
  end

  json_obj = parse_json(response.body)
  return nil unless json_obj
  return nil unless json_obj.has_key?('ticket')

  json_obj['ticket']
end

.gen_short_url(app_id = nil, long_url) ⇒ Object

长链接转短连接



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
# File 'lib/blsm-mp-wx.rb', line 192

def gen_short_url(app_id=nil, long_url)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  return nil unless access_token

  response = Faraday.new(:url => 'https://api.weixin.qq.com').post do |req|
    req.url '/cgi-bin/shorturl'
    req.headers['Content-Type'] = 'application/json'
    req.params[:long_url] = long_url
    req.params[:access_token] = access_token
    req.body = "{\"action\":\"long2short\",\"long_url\":\"#{long_url}\"}"
  end

  json_obj = parse_json(response.body)
  return nil unless json_obj
  return nil unless json_obj.has_key?('short_url')
  json_obj['short_url']
end

.gen_wx_user_info(app_id = nil, openid) ⇒ Object

获取用户的基本信息(包括UnionID机制)



153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
# File 'lib/blsm-mp-wx.rb', line 153

def (app_id=nil, openid)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  return nil unless access_token

  response = Faraday.new(:url => 'https://api.weixin.qq.com').get do |req|
    req.url '/cgi-bin/user/info'
    req.params[:openid] = openid
    req.params[:access_token] = access_token
  end

  json_obj = parse_json(response.body)
  puts "#{json_obj}"
  return nil unless json_obj
  return json_obj.inject({}) { |memo, (key, v)| memo[key.to_s.to_sym]=v; memo } if json_obj.has_key?('openid')

  nil
end

.get_material(app_id, media_id) ⇒ Object

根据media_id来获取永久素材

Parameters
  • app_id

  • media_id 要获取的素材的media_id



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
# File 'lib/blsm-mp-wx.rb', line 272

def get_material(app_id, media_id)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  return nil unless access_token
  response = Faraday.new(:url => 'https://api.weixin.qq.com').post do |req|
    req.url '/cgi-bin/material/get_material'
    req.headers['Content-Type'] = 'application/json'
    req.params[:access_token] = access_token
    req.body= {media_id: media_id}.to_json
  end
  body = response.body
  json_obj = parse_json(body)
  return body unless json_obj
  json_obj.inject({}) { |memo, (key, v)| memo[key.to_s.to_sym]=v; memo }
end

.get_material_count(app_id, type) ⇒ Object

批量获取公众号的素材列表

Parameters
  • app_id

  • type 素材类型:voice、video、image、news



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
# File 'lib/blsm-mp-wx.rb', line 252

def get_material_count(app_id, type)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  return nil unless access_token
  response = Faraday.new(:url => 'https://api.weixin.qq.com').post do |req|
    req.url '/cgi-bin/material/get_materialcount'
    req.headers['Content-Type'] = 'application/json'
    req.params[:access_token] = access_token
  end

  json_obj = parse_json(response.body)
  return nil unless json_obj
  return nil unless json_obj.has_key?("#{type}_count")
  json_obj["#{type}_count"].to_i
end

.js_api_sign_package(app_id = nil, url) ⇒ Object

JSAPI签名package



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
# File 'lib/blsm-mp-wx.rb', line 134

def js_api_sign_package(app_id=nil, url)
  app_id ||= self.APP_ID
  ticket = js_api_ticket(app_id)
  timestamp = Time.new.to_i
  nonce_str = Digest::MD5.hexdigest(Time.new.to_i.to_s + Random.rand(99999).to_s)
  string = "jsapi_ticket=#{ticket}&noncestr=#{nonce_str}&timestamp=#{timestamp}&url=#{url}"
  signature = Digest::SHA1.hexdigest(string)
  {
      appId: app_id,
      nonceStr: nonce_str,
      timestamp: timestamp,
      url: url,
      signature: signature,
      rawString: string
  }
end

.js_api_ticket(app_id = nil) ⇒ Object

获取jsapi全局唯一票据



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
# File 'lib/blsm-mp-wx.rb', line 57

def js_api_ticket(app_id=nil)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  app = VdMpWx.where(app_id: app_id).first

  return nil unless access_token
  return nil unless app
  return app.js_api_ticket unless app.js_api_ticket_expired? #没有过期,直接返回

  response = Faraday.new(:url => 'https://api.weixin.qq.com').get do |req|
    req.url '/cgi-bin/ticket/getticket'
    req.params[:access_token] = access_token
    req.params[:type] = 'jsapi'
  end

  json_obj = parse_json(response.body)
  return nil unless json_obj
  return nil unless json_obj.has_key?('ticket')

  ticket = json_obj['ticket']
  app.save_js_api_ticket(ticket, json_obj['expires_in'])

  ticket
end

.send_msg(app_id = nil, openid, msg) ⇒ Object

发送普通消息文本消息:{

"touser":"OPENID",
"msgtype":"text",
"text":
{
      "content":"Hello World"
}

} 图文消息:{ “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"
      }
  ]
}

}



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
# File 'lib/blsm-mp-wx.rb', line 114

def send_msg(app_id=nil, openid, msg)
  app_id ||= self.APP_ID
  access_token = access_token(app_id)
  return nil unless access_token
  return nil unless openid
  return nil unless msg[:touser]==openid

  response = Faraday.new(:url => 'https://api.weixin.qq.com').post do |req|
    req.url '/cgi-bin/message/custom/send'
    req.params[:access_token] = access_token
    req.headers['Content-Type'] = 'application/json'
    req.body = msg.to_json
  end

  json_obj = parse_json(response.body)
  return nil unless json_obj
  json_obj['errcode']==0
end