wechat-api 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 719b629d7118b6d301d4aefe2f7672165dd911bf
-  data.tar.gz: ef220a300a12fde99086b07d82146dec8778b28c
+SHA256:
+  metadata.gz: 3af5535d32a85e57f6ed8f517cb17cbd0e8941e42610bc467a0cdb4a4936f411
+  data.tar.gz: 5de42166d01da0ea3047cc53f87864e85c4454a753b351f62d2c5d4ee64d0871
 SHA512:
-  metadata.gz: 1cfb62e73ee7d3b47ae830f98a3cfbe28ce65883b8cc33e2ebc49a13d363bdb0f25459d498508c1a307836871bfd890f8cd5096be42045ed7f16c3e335d7f44a
-  data.tar.gz: 95e2407f7f8e3d0273424754ef9d7a2f1008ce1ea5055397878bcdf39b8ff78e82b5f2e57113a6bee31051c7e751a22d8ab32a638d944df488bc21b73cf310cb
+  metadata.gz: d77173f5c03d1bf1bf345a947238b5fa6966de3f67a8ff596670c904b1c9e726856d160be9c30a6c14f8e1ec4e21297a357fdf6fc080bb48b496f9a86db36758
+  data.tar.gz: 608d72719242789c965ae36b3f875806ddfc7d719fc54f4060c6a9b0d9a77ba424ddae1d4713731aafa88bf1dc0da8b1a491274c2834f63f2e41bc0c826fc3ee

data/.gitignore

@@ -1,2 +1,3 @@
 Gemfile.lock
 pkg
+.DS_Store

data/Gemfile

@@ -1,9 +1,3 @@
-source 'http://ruby.taobao.org'
+source 'https://rubygems.org'
 # Specify your gem's dependencies in ucpaas.gemspec
 gemspec
-
-group :development do
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'rspec-its'
-end

data/README.md

@@ -4,8 +4,7 @@ https://github.com/lazing/wechat-api
 
 用于微信 api 调用（非服务端推送信息）的处理。
 
-[![Circle CI](https://circleci.com/gh/lazing/wechat-api.svg?style=svg)](https://circleci.com/gh/lazing/wechat-api)
-[![Gem Version](https://badge.fury.io/rb/wechat-api.svg)](http://badge.fury.io/rb/ucpaas)
+[![Gem Version](https://badge.fury.io/rb/wechat-api.svg)](http://badge.fury.io/rb/wechat-api)
 
 常见的应用场景如：
 * 获取关注用户
@@ -21,6 +20,12 @@ https://github.com/lazing/wechat-api
 * 不够简单，特别是用于多账号管理的时候
 * 微信 api 更新频繁，需要易于使用新功能
 
+## 主要功能清单
+* 支持微信服务号和订阅号API
+* 支持微信js_ticket获取
+* 支持微信红包API
+* 支持微信企业号主动调用API
+
 ## 使用方式
 
 ````ruby
@@ -30,15 +35,25 @@ gem 'wechat-api'
 ````ruby
 require 'wechat-api'
 
-client = Wechat::Api::Client.new 'appid', 'appsecret'
+api = Wechat::Api::Client.new 'appid', 'appsecret'
 
-client.get 'user/info', nextopenid: 'xxx'
+api.get 'user/info', nextopenid: 'xxx'
 # 当使用 get 方式时，hash 参数将做个 query params 附在请求后
 
-client.post 'user/info/updateremark', openid；'xxxx', remark: '我是注释'
+api.post 'user/info/updateremark', openid；'xxxx', remark: '我是注释'
 # 当使用 post 方法时，hash 参数将转换为 json，因此可以支持嵌套的结构
 ````
 
+微信企业号主动调用API
+
+````ruby
+require 'wechat-api'
+
+qy = Wechat::Qy::Client.new 'corpid', 'corpsecret'
+qy.text_send 'agentid', 'message', touser: 'UserId1|UserId2' #提供的预定义方法
+qy.post 'api/uri', { key: :value} #未提供预定义方法时调用
+````
+
 ## 一些预定义方法
 
 预定义接口方法可以方便使用。
@@ -47,13 +62,13 @@ client.post 'user/info/updateremark', openid；'xxxx', remark: '我是注释'
 
 ````ruby
 # 创建固定二维码
-client.create_qrcode(scene_str)
+api.create_qrcode(scene_str)
 
 # 创建临时二维码
-client.create_qrcode_temp(scene_id)
+api.create_qrcode_temp(scene_id)
 
 # 发送模板消息
-client.send_template(template_id, openid, url, data = {})
+api.send_template(template_id, openid, url, data = {})
 ````
 
 以上接口返回微信文档定义的 json 数据转换后的ruby的 hash 对象

data/lib/wechat-api.rb

@@ -1 +1,2 @@
 require 'wechat/api'
+require 'wechat/qy'

data/lib/wechat/api.rb

@@ -4,5 +4,18 @@ require 'wechat/api/client'
 module Wechat
   #
   module Api
+    class Error < StandardError; end
+    
+    def self.client(appid = 'origin_id')
+      var = "@_client_#{appid}"
+      if instance_variable_defined?(var)
+        instance_variable_get(var)
+      elsif block_given?
+        c = yield(Client)
+        instance_variable_set var, c
+      else
+        raise Error, :not_initialized
+      end
+    end
   end
 end

data/lib/wechat/api/client.rb

@@ -2,6 +2,7 @@ require 'multi_json'
 require 'wechat/api/message'
 require 'wechat/api/user'
 require 'wechat/api/util'
+require 'wechat/api/js_ticket'
 require 'faraday'
 require 'logger'
 
@@ -18,12 +19,13 @@ module Wechat
 
       API_BASE = 'https://api.weixin.qq.com/cgi-bin/'
 
-      attr_reader :app_id, :secret
-      attr_accessor :logger
+      attr_reader :app_id, :secret, :ticket
+      attr_accessor :logger, :site
 
       def initialize(app_id, secret)
         @app_id, @secret = app_id, secret
         @logger = Logger.new(STDOUT)
+        @ticket = JsTicket.new self
         @token_file = File.join('/tmp', "wechat-api-#{app_id}")
       end
 
@@ -37,12 +39,13 @@ module Wechat
       end
 
       def refresh
-        url = format('%stoken', API_BASE)
+        url = format('%stoken', base_url)
         resp = connection.get(url, token_params)
         response = MultiJson.load(resp.body)
         return handle_error(response) if response['errcode']
+
         @access_token = response['access_token']
-        File.open(@token_file, 'w') { |f| f.write(resp.body) } if token
+        File.open(@token_file, 'w') { |f| f.write(resp.body) } if @access_token
         @access_token
       end
 
@@ -72,9 +75,11 @@ module Wechat
       end
 
       def with_access_token(uri, params, tried = 2)
-        url = format('%s%s', API_BASE, uri)
+        url = format('%s%s', base_url, uri)
         begin
           resp = yield(url, params.merge(access_token: access_token))
+          raise ResponseError, resp unless resp.success?
+
           response = MultiJson.load(resp.body)
           handle_error(response)
         rescue AccessTokenExpiredError => e
@@ -86,6 +91,10 @@ module Wechat
 
       private
 
+      def base_url
+        site || API_BASE
+      end
+
       def debug_request
         response = yield
         logger.debug { response }
@@ -97,9 +106,9 @@ module Wechat
         when 0, nil
           response
         when 40_001, 42_001, 40_014
-          fail AccessTokenExpiredError, response
+          raise AccessTokenExpiredError, response
         else
-          fail ResponseError, response
+          raise ResponseError, response
         end
       end
 

data/lib/wechat/api/js_ticket.rb

@@ -0,0 +1,22 @@
+module Wechat
+  module Api
+
+    class JsTicket
+      attr_reader :client, :ticket, :expires_at
+      def initialize(client)
+        @client = client
+      end
+
+      def refresh
+        js = client.js_ticket
+        @ticket = js[:ticket]
+        @expires_at = DateTime.now + Rational(js[:expires_in].to_i, 3600*24)
+        self
+      end
+
+      def expired?
+        expires_at.nil? || DateTime.now > expires_at
+      end
+    end
+  end
+end

data/lib/wechat/api/util.rb

@@ -1,3 +1,6 @@
+require 'securerandom'
+require 'digest/sha1'
+
 module Wechat
   module Api
     #
@@ -27,6 +30,28 @@ module Wechat
 
         post 'qrcode/create', params
       end
+
+      def js_ticket
+        res = get 'ticket/getticket', type: :jsapi
+        res['ticket']
+      end
+
+      def sign(params)
+        str = params.to_a.sort.map { |p| p.join('=') }.join('&')
+        logger.debug { "to_sign: #{str}" }
+        Digest::SHA1.hexdigest str
+      end
+
+      def js_config(url: nil)
+        r = ticket.tap { |j| j.refresh if j.expired? }.ticket
+        nonce = SecureRandom.hex
+        timestamp = Time.now.to_i
+        signature = sign(noncestr: nonce, timestamp: timestamp, jsapi_ticket: r, url: url)
+        {
+          appId: app_id, timestamp: timestamp, nonceStr: nonce,
+          signature: signature
+        }.tap { |hash| logger.debug { "js_config: #{hash}, url: #{url}" } }
+      end
     end
   end
 end

data/lib/wechat/api/version.rb

@@ -2,6 +2,6 @@
 module Wechat
   #
   module Api
-    VERSION = '0.1.1'
+    VERSION = '0.4.0'.freeze
   end
 end

data/lib/wechat/qy.rb

@@ -0,0 +1,10 @@
+module Wechat
+  #
+  module Qy
+  end
+end
+
+require 'wechat/qy/client'
+require 'wechat/qy/message'
+
+::Wechat::Qy::Client.send :include, ::Wechat::Qy::Message

data/lib/wechat/qy/client.rb

@@ -0,0 +1,117 @@
+require 'multi_json'
+require 'faraday'
+require 'logger'
+
+module Wechat
+  module Qy
+    #
+    class ResponseError < StandardError; end
+    class AccessTokenExpiredError < ResponseError; end
+    #
+    class Client
+
+      API_BASE = 'https://qyapi.weixin.qq.com/cgi-bin/'
+
+      attr_reader :corp_id, :corp_secret
+      attr_accessor :logger
+
+      def initialize(corp_id, corp_secret)
+        @corp_id, @corp_secret = corp_id, corp_secret
+        @logger = Logger.new(STDOUT)
+        @token_file = File.join('/tmp', "wechat-api-#{corp_id}")
+      end
+
+      def access_token
+        @access_token ||= begin
+          token = MultiJson.load(File.read(@token_file))
+          token['access_token']
+        rescue
+          refresh
+        end
+      end
+
+      def refresh
+        url = format('%sgettoken', API_BASE)
+        resp = connection.get(url, token_params)
+        response = MultiJson.load(resp.body)
+        return handle_error(response) if response['errcode']
+        @access_token = response['access_token']
+        File.open(@token_file, 'w') { |f| f.write(resp.body) } if @access_token
+        @access_token
+      end
+
+      def get(uri, params = {})
+        with_access_token(uri, params) do |url, params_with_token|
+          debug_request do
+            connection.get do |req|
+              req.url url, params_with_token
+              req.headers[:accept] = 'application/json'
+              req.headers[:content_type] = 'application/json'
+            end
+          end
+        end
+      end
+
+      def post(uri, data = {})
+        with_access_token(uri, {}) do |url, params|
+          logger.debug { [:data, data] }
+          debug_request do
+            connection.post do |req|
+              req.url url, params
+              req.headers[:accept] = 'application/json'
+              req.headers[:content_type] = 'application/json'
+              req.body = MultiJson.dump(data)
+            end
+          end
+        end
+      end
+
+      def with_access_token(uri, params, tried = 2)
+        url = format('%s%s', API_BASE, uri)
+        begin
+          resp = yield(url, params.merge(access_token: access_token))
+          response = MultiJson.load(resp.body)
+          handle_error(response)
+        rescue AccessTokenExpiredError => e
+          refresh
+          retry unless (tried -= 1).zero?
+          raise e
+        end
+      end
+
+      private
+
+      def debug_request
+        response = yield
+        logger.debug { response }
+        response
+      end
+
+      def handle_error(response)
+        case response['errcode']
+        when 0, nil
+          response
+        when 40_001, 42_001, 40_014
+          fail AccessTokenExpiredError, response
+        else
+          fail ResponseError, response
+        end
+      end
+
+      def token_params
+        {
+          corpid: corp_id,
+          corpsecret: corp_secret
+        }
+      end
+
+      def connection
+        @connection ||= begin
+          Faraday.new do |faraday|
+            faraday.adapter Faraday.default_adapter
+          end
+        end
+      end
+    end
+  end
+end

data/lib/wechat/qy/message.rb

@@ -0,0 +1,16 @@
+module Wechat
+  module Qy
+    module Message
+      # text_send('appid', 'hello', touser: 'User1|User2')
+      def text_send(agent_id, content, data = {})
+        params = {
+          msgtype: :text,
+          agentid: agent_id,
+          safe: 0,
+          text: { content: content }
+        }.merge(data)
+        post 'message/send', params
+      end
+    end
+  end
+end

data/spec/wechat/api/js_ticket_spec.rb

@@ -0,0 +1,18 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+RSpec.describe Wechat::Api::JsTicket do
+
+  let(:client) { double(:client) }
+  subject do
+    Wechat::Api::JsTicket.new client
+  end
+
+  it :refresh do
+    allow(client).to receive(:js_ticket).and_return(expires_in: 7200, ticket: 'bxLdikRXVbTPdHSM05e5u5sUoXNKd8-41ZO3MhKoyN5OfkWITDGgnr2fwJ0m9E8NYzWKVZvdVtaUgWvsdshFKA')
+    subject.refresh
+    expect(subject.ticket).not_to be_nil
+    should_not be_expired
+    expect(subject.expires_at).to be_a(Date)
+  end
+
+end

data/spec/wechat/api/util_spec.rb

@@ -0,0 +1,19 @@
+require File.expand_path('../../../spec_helper', __FILE__)
+
+RSpec.describe Wechat::Api::Util do
+  subject { Wechat::Api::Client.new('APPID', 'APPSECRET') }
+
+  before do
+    subject.logger.level = Logger::DEBUG
+  end
+
+  it :js_config do
+    allow(SecureRandom).to receive(:hex).and_return('Wm3WZYTPz0wzccnW')
+    allow_any_instance_of(Time).to receive(:to_i).and_return(1414587457)
+    allow(subject).to receive(:js_ticket).and_return(expires_in: 7200, ticket: 'sM4AOVdWfPE4DxkXGEs8VMCPGGVi4C3VM0P37wVUCFvkVAy_90u5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcHKP7qg')
+    js = subject.js_config(url: 'http://mp.weixin.qq.com?params=value')
+    expect(js).not_to be_nil
+    expect(js).to include(signature: '0f9de62fce790f9a083d5c99e95740ceb90c27ed')
+    expect(js).to have_key :appId
+  end
+end

data/wechat-api.gemspec

@@ -13,15 +13,18 @@ Gem::Specification.new do |spec|
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "faraday", "~> 0.9"
-  spec.add_runtime_dependency "multi_json", "~> 1.2"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "webmock", "~> 1.18"
+  spec.add_runtime_dependency 'faraday', '~> 1.0'
+  spec.add_runtime_dependency 'multi_json', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.0'
+  spec.add_development_dependency 'guard', '~> 2.0'
+  spec.add_development_dependency 'guard-rspec', '~> 4.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its', '~> 1.0'
+  spec.add_development_dependency 'webmock', '~> 3.0'
+  
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wechat-api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryan Wong
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-09-25 00:00:00.000000000 Z
+date: 2021-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,70 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,21 +108,35 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.18'
-description: 
+        version: '3.0'
+description:
 email:
 - lazing@gmail.com
 executables: []
@@ -117,7 +145,6 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".travis.yml"
 - Gemfile
 - Guardfile
 - README.md
@@ -125,18 +152,24 @@ files:
 - lib/wechat-api.rb
 - lib/wechat/api.rb
 - lib/wechat/api/client.rb
+- lib/wechat/api/js_ticket.rb
 - lib/wechat/api/message.rb
 - lib/wechat/api/user.rb
 - lib/wechat/api/util.rb
 - lib/wechat/api/version.rb
+- lib/wechat/qy.rb
+- lib/wechat/qy/client.rb
+- lib/wechat/qy/message.rb
 - spec/spec_helper.rb
 - spec/wechat/api/client_spec.rb
+- spec/wechat/api/js_ticket_spec.rb
+- spec/wechat/api/util_spec.rb
 - wechat-api.gemspec
 homepage: https://github.com/lazing/wechat-api
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -151,12 +184,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.0.6
+signing_key:
 specification_version: 4
 summary: Wechat API wrapper
 test_files:
 - spec/spec_helper.rb
 - spec/wechat/api/client_spec.rb
-has_rdoc: 
+- spec/wechat/api/js_ticket_spec.rb
+- spec/wechat/api/util_spec.rb

data/.travis.yml

@@ -1,5 +0,0 @@
-language: ruby
-rvm:
-  - ruby-head
-  - 2.1.0
-  - 1.9.3