wx_opendata 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1699ef3c57e9e4189e2c371b5c47905e9d331321
+  data.tar.gz: 42749163d3b371025c129d23fb7a93b6e787ab55
+SHA512:
+  metadata.gz: 063d446971c3127d3ff93fff01dac39902c75700eac5d0b031a560009fc35681bff4f297d2e1c75d373906d3c85a4d11ba55c1e0d816b77e474feb2a381e3981
+  data.tar.gz: 402202ff4258eae20d649c66e47e779b036c79ac3c61a38fc1902cd073dd0fcfde5ef9f15b9a1d760c87a4f6e5a03375a043a01431ecbb8d19e384023bbe3214

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/wx_opendata/service.rb

@@ -0,0 +1,137 @@
+require 'rest_client'
+require 'mime/types'
+require 'json'
+
+module WxOpendata
+  BASE_URL = 'https://api.weixin.qq.com/'.freeze
+  class Service
+    attr_accessor :content_type
+
+    # 发送模板消息
+    def send_template_message(token, params)
+      raise InvalidParametersError unless params[:touser] && params[:template_id] && params[:form_id]
+      url = "cgi-bin/message/wxopen/template/send?access_token=#{token}"
+      touser = params[:touser]
+      template_id = params[:template_id]
+      form_id = params[:form_id]
+      page = params[:page] || 'pages/index/main'
+      data = params[:data] || { keyword1: { value: 'Test Message Template' } }
+      emphasis_keyword = params[:emphasis_keyword] || "keyword1.DATA"
+      p = { touser: touser, template_id: template_id, form_id: form_id, page: page, data: data, emphasis_keyword: emphasis_keyword }
+      jsondata = post(url, p)
+      begin
+        raise ErrCodeError, 'template_id不正确' if jsondata['errcode'] == 40037
+        raise ErrCodeError, 'form_id不正确，或者过期' if jsondata['errcode'] == 41028
+        raise ErrCodeError, 'form_id已被使用' if jsondata['errcode'] == 41029
+        raise ErrCodeError, 'page不正确' if jsondata['errcode'] == 41030
+        raise ErrCodeError, '接口调用超过限额（目前默认每个帐号日调用限额为100万）' if jsondata['errcode'] == 45009
+        jsondata['errcode'] == 0
+      rescue ErrCodeError => e
+        p "#{e.class}: #{e.message}"
+      end
+    end
+
+    # 检查一段文本是否含有违法违规内容
+    def msg_sec_check(token, content)
+      url = "wxa/msg_sec_check?access_token=#{token}"
+      p = { content: content }
+      jsondata = post(url, p)
+      return true if jsondata['errcode'] == 0
+      return false if jsondata['errcode'] == 87014
+    end
+
+    # 校验一张图片是否含有违法违规内容
+    def img_sec_check
+    end
+    
+    # 创建被分享动态消息的 activity_id
+    def create_activity_id(token)
+      url = "cgi-bin/message/wxopen/activityid/create?access_token=#{token}"
+      jsondata = get(url)
+      raise ServiceNotAvailableError if jsondata['errcode'] != 0
+      jsondata['activity_id']
+    end
+
+    # 获取小程序二维码，适用于需要的码数量较少的业务场景
+    def create_wx_aqrcode(token, params = {})
+      url = "cgi-bin/wxaapp/createwxaqrcode?access_token=#{token}"
+      path = params[:path] || 'pages/index/main'
+      width = params[:width] || 430
+      p = { path: path, width: width }
+      data = post(url, p)
+      raise InvalidCredentialError if data['errcode'] == 45029
+      tmpfile(data)
+    end
+
+    # 获取小程序码，适用于需要的码数量较少的业务场景
+    def get_wx_acode(token, params = {})
+      url = "wxa/getwxacode?access_token=#{token}"
+      path = params[:path] || 'pages/index/main'
+      width = params[:width] || 430
+      auto_color = params[:auto_color] || false
+      line_color = params[:line_color] || {"r": 0,"g": 0,"b": 0}
+      is_hyaline = params[:is_hyaline] || true
+      p = { path: path, width: width, auto_color: auto_color, line_color: line_color, is_hyaline: is_hyaline }
+      data = post(url, p)
+      raise InvalidCredentialError if data['errcode'] == 45029
+      tmpfile(data)
+    end
+    
+    # 获取小程序码，适用于需要的码数量极多的业务场景。通过该接口生成的小程序码，永久有效，数量暂无限制。
+    def get_wx_acode_unlimit(token, params = {})
+      url = "wxa/getwxacodeunlimit?access_token=#{token}"
+      scene = params[:scene] || 'api'
+      page = params[:page] || 'pages/index/main'
+      width = params[:width] || 430
+      auto_color = params[:auto_color] || false
+      line_color = params[:line_color] || {"r": 0,"g": 0,"b": 0}
+      is_hyaline = params[:is_hyaline] || true
+      p = { scene: scene, page: page, width: width, auto_color: auto_color, line_color: line_color, is_hyaline: is_hyaline }
+      data = post(url, p)
+      raise InvalidCredentialError if data['errcode'] == 45009 || data['errcode'] == 41030
+      tmpfile(data)
+    end
+
+    # 下发小程序和公众号统一的服务消息
+    def send_uniform_message
+    end
+    
+
+    protected
+    def get(url)
+      url = BASE_URL + url
+      resp = RestClient.get url
+      format_result(resp)
+    end
+
+    def post(url, params)
+      url = BASE_URL + url
+      resp = RestClient.post url, params.to_json, {accept: :json}
+      format_result(resp)
+    end
+
+    def format_result(resp)
+      @content_type = resp.headers[:content_type]
+      if resp.headers[:content_type].include? "application/json".freeze
+        JSON.parse resp.body
+      else
+        resp.body
+      end
+    end
+
+    def current_req_type
+      @content_type
+    end
+
+    def tmpfile(data)
+      tmpname = (Time.now.to_i + rand(1000...9999)).to_s
+      ext = '.' + MIME::Types[current_req_type].first.extensions.first 
+      f = Tempfile.new([tmpname, ext], Dir.tmpdir)
+      # f.binmode
+      f.write(data)
+      f.flush
+      f.path
+    end
+
+  end
+end

data/lib/wx_opendata/token.rb

@@ -0,0 +1,59 @@
+module WxOpendata
+  
+  WX_ACCESS_TOKEN = 'https://api.weixin.qq.com/cgi-bin/token'.freeze
+
+  class Token
+    attr_reader :appid, :secret, :token_file, :access_token, :token_expires_in, :store_token_at
+
+    def initialize(appid, appsecret, token_file)
+      @appid = appid
+      @appsecret = appsecret
+      @token_file = token_file
+      @random_generator = Random.new
+    end
+
+    def token
+      read_token_from_cache
+      refresh_token if remain_seconds < @random_generator.rand(30..3 * 60)
+      access_token
+    end
+
+    protected
+
+    def refresh_token
+      url = "#{WX_ACCESS_TOKEN}?grant_type=client_credential&appid=#{@appid}&secret=#{@appsecret}"
+      resp = RestClient.get url
+      store_token_to_cache(resp.body)
+      read_token_from_cache
+    end
+
+    def read_token_from_cache
+      token = read_token
+      @token_expires_in = token.fetch('expires_in').to_i
+      @store_token_at = token.fetch('store_token_at').to_i
+      @access_token = token.fetch('access_token')
+    rescue JSON::ParserError, Errno::ENOENT, KeyError, TypeError => e
+      refresh_token
+    end
+
+    def store_token_to_cache(token)
+      token_hash = JSON.parse token
+      raise InvalidCredentialError unless token_hash['access_token']
+      token_hash['store_token_at'.freeze] = Time.now.to_i
+      write_token(token_hash.to_json)
+    end
+
+    def write_token(token)
+      File.write(token_file, token)
+    end
+
+    def read_token
+      JSON.parse File.read(token_file)
+    end
+
+    def remain_seconds
+      token_expires_in - (Time.now.to_i - store_token_at.to_i)
+    end
+
+  end
+end

data/lib/wx_opendata/version.rb

@@ -0,0 +1,3 @@
+module WxOpendata
+  VERSION = "0.1.1"
+end

data/lib/wx_opendata.rb

@@ -0,0 +1,14 @@
+require "wx_opendata/version"
+require 'wx_opendata/service'
+require 'wx_opendata/token'
+
+module WxOpendata
+  class AccessTokenExpiredError < StandardError; end
+  class InvalidCredentialError < StandardError; end
+  class ServiceNotAvailableError < StandardError; end
+  class InvalidParametersError < StandardError; end
+  class ErrCodeError < StandardError; end
+
+  class<< self
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+require "bundler/setup"
+require "wx_opendata"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/wx_opendata_spec.rb

@@ -0,0 +1,66 @@
+require "spec_helper"
+appid = ''
+appsecret = ''
+token_file = '/tmp/weapp_access_token'
+tk = WxOpendata::Token.new(appid, appsecret, token_file)
+service = WxOpendata::Service.new
+
+RSpec.describe WxOpendata do
+  it "1. should return corrent length access_token" do
+    token = tk.token
+    expect(token.size).to be > 120
+  end
+
+  it "2. should return activity id" do
+    token = tk.token
+    activity_id = service.create_activity_id(token)
+    expect(activity_id.size).to be > 10
+  end
+
+  it '3.1 should return get_wx_acode_unlimit pic path' do
+    token = tk.token
+    pic = service.get_wx_acode_unlimit(token, { width: 100, scene: 'uid=12345678' })
+    expect(pic).to include('/var')
+  end
+
+  it '3.2 should return get_wx_acode pic path' do
+    token = tk.token
+    pic = service.get_wx_acode(token)
+    expect(pic).to include('/var')
+  end
+  
+  it '3.3 should return create_wx_aqrcode pic path' do
+    token = tk.token
+    pic = service.create_wx_aqrcode(token)
+    expect(pic).to include('/var')
+  end
+
+  it '4. should return ok if content is: Mot最棒' do
+    token = tk.token
+    isOk = service.msg_sec_check(token, "Mot最棒")
+    expect(isOk).to eq(true)
+  end
+  it '5.1 should return risky content if content is: 特3456书yuuo莞6543李zxcz蒜7782法fgnv级' do
+    token = tk.token
+    isOk = service.msg_sec_check(token, "特3456书yuuo莞6543李zxcz蒜7782法fgnv级")
+    expect(isOk).to eq(false)
+  end
+
+  it '5.2 should return risky content if content is: 完2347全dfji试3726测asad感3847知qwez到' do
+    token = tk.token
+    isOk = service.msg_sec_check(token, "完2347全dfji试3726测asad感3847知qwez到")
+    expect(isOk).to eq(false)
+  end
+
+  # it '6. send message template to user and should return ok' do
+  #   isOk = service.send_template_message(token, {
+  #     touser: '',
+  #     template_id: '',
+  #     form_id: '',
+  #     data: {
+  #     },
+  #     emphasis_keyword: ''
+  #   })
+  #   expect(isOk).to eq(true)
+  # end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: wx_opendata
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Mot_Wu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This is a gem for weapp open data API.小程序开放数据API
+email:
+- motevans412@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/wx_opendata.rb
+- lib/wx_opendata/service.rb
+- lib/wx_opendata/token.rb
+- lib/wx_opendata/version.rb
+- spec/spec_helper.rb
+- spec/wx_opendata_spec.rb
+homepage: https://github.com/mozillo/wx_opendata
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.12
+signing_key: 
+specification_version: 4
+summary: This is a gem for weapp open data API.小程序开放数据API
+test_files:
+- spec/spec_helper.rb
+- spec/wx_opendata_spec.rb