wechat 0.16.2 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bc8214345aa67e306a93fb57034de6f8ecc898c630e5abb56f29424b8a360110
-  data.tar.gz: 7152a97b68aada44c5be152e57dbe55233efabe58124c9d36c73b560b213c51e
+  metadata.gz: 0d792d78d777375dc558251f8977ee4897e0854cff6276e207e1337c8884d066
+  data.tar.gz: d92848e26cd42299997cfa0c700b9c961bf0e89ad6b9992cc088905e5968eabc
 SHA512:
-  metadata.gz: aed67b12d96ee44e7ab75b8f3fe2bf5170379efd9b94e2d6fab8a92a4a5f99d477ea032a2d1826b3ddc73b195a42ca0f2f72d6a92d27632eb2de0be8c593d62d
-  data.tar.gz: 7c00e2715896186abfee532190aae993a766fc0a583f41545c62856a4d70554a6a365312a4d0d6e5eeba3e7259f6d552203e0079a70df73ed21677c924a63aa7
+  metadata.gz: dccc900747140ca19c627856b39f7066bdf7ee9cbc34217780b942d703064b645c69a9ca855f0ea79d070a2886f940ba94f1c10230372732454ec3cc6b382ac1
+  data.tar.gz: 968546dfcea050c3154179358eb93b24a1afdcffe8a46d5aea9af6cef1497f4a981b9028df84108c7677a180f53fc1687f2b6616613abaf203223ae01932cd1e

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## v0.17.1 (released at 2023-07-28)
+
+* Add Record based token support. by @CoolDrinELiu #315
+* Add api shortlink.generate support. by @wikimo #316
+* Add new api & Compatible with WeCom. by @leepood #317
+
+## v0.17.0 yarked
+
 ## v0.16.2 (released at 2022-12-09)
 
 * Drop support ruby 2.6 and allow ruby 3.2 will released psych v5.0.0. by @iuhoay #314

data/README-CN.md

@@ -89,6 +89,14 @@ rake db:migrate
 
 appid/corpid 以及 secret 的配置请阅读下一节
 
+#### 数据配置模式
+需要保证传入的 `record` 属性中包含 `access_token`, `token_expires_in`, `got_token_at`。
+```ruby
+def client
+  @client ||= Wechat::Api.new(app_id, app_secret, token_file, network_setting, jsapi_ticket_file, record)
+end
+```
+
 #### 命令行程序的配置
 
 要使用命令行程序，需要在 home 目录中创建一个 `~/.wechat.yml`，包含以下内容。其中 `access_token` 是存放 access_token 的文件位置。

data/README.md

@@ -97,6 +97,14 @@ URL address for wechat created by running `rails g wechat:install` is `http://yo
 
 How to setup appid/corpid and secret see below section.
 
+#### Configure wechat by record-based mode
+Make sure the `record` attributes include `access_token`, `token_expires_in`, `got_token_at`.
+```ruby
+def client
+  @client ||= Wechat::Api.new(app_id, app_secret, token_file, network_setting, jsapi_ticket_file, record)
+end
+```
+
 #### Configure for command line
 
 To use standalone `wechat` command, you need to create configuration file `~/.wechat.yml` and include content below  for public account. The `access_token` will be written to file `/var/tmp/wechat_access_token`.

data/bin/wechat

@@ -236,6 +236,12 @@ class App < Thor
       puts wechat_api.wxa_generate_urllink(body_hash)
     end
 
+    desc 'wxa_generate_shortlink [PATH]', '获取小程序 Short Link'
+    def wxa_generate_shortlink(url, title = '', is_permanent = false)
+      body_hash = { page_url: url, page_title: title, is_permanent: is_permanent}
+      puts wechat_api.wxa_generate_shortlink(body_hash)
+    end
+
     desc 'media_uploadnews [MPNEWS_YAML_PATH]', '上传图文消息素材'
     def media_uploadnews(mpnews_yaml_path)
       mpnew = Wechat::ApiLoader.load_yaml(File.read(mpnews_yaml_path))

data/lib/wechat/api.rb

@@ -2,10 +2,10 @@
 
 module Wechat
   class Api < ApiBase
-    def initialize(appid, secret, token_file, network_setting, jsapi_ticket_file)
+    def initialize(appid, secret, token_file, network_setting, jsapi_ticket_file, record = nil)
       super()
       @client = HttpClient.new(Wechat::Api::API_BASE, network_setting)
-      @access_token = Token::PublicAccessToken.new(@client, appid, secret, token_file)
+      @access_token = Token::PublicAccessToken.new(@client, appid, secret, token_file, record)
       @jsapi_ticket = Ticket::PublicJsapiTicket.new(@client, @access_token, jsapi_ticket_file)
       @qcloud = nil
     end

data/lib/wechat/concern/common.rb

@@ -88,6 +88,11 @@ module Wechat
         post 'message/mass/get', JSON.generate(msg_id: msg_id)
       end
 
+      def wxa_get_user_phone_number(code)
+        # https://developers.weixin.qq.com/miniprogram/dev/OpenApiDoc/user-info/phone-number/getPhoneNumber.html
+        post 'business/getuserphonenumber', JSON.generate(code: code), base: Wechat::Api::WXA_BASE
+      end
+
       def wxa_get_wxacode(path, width = 430)
         post 'getwxacode', JSON.generate(path: path, width: width), base: Wechat::Api::WXA_BASE
       end
@@ -109,6 +114,10 @@ module Wechat
         post 'generate_urllink', JSON.generate(body_hash), base: Wechat::Api::WXA_BASE
       end
 
+      def wxa_generate_shortlink(body_hash)
+        post 'genwxashortlink', JSON.generate(body_hash), base: Wechat::Api::WXA_BASE
+      end
+
       def menu
         get 'menu/get'
       end

data/lib/wechat/corp_api.rb

@@ -13,6 +13,11 @@ module Wechat
       @qcloud = nil
     end
 
+    def get_externalcontact(external_userid, cursor = nil)
+      # https://developer.work.weixin.qq.com/document/path/92114
+      get 'externalcontact/get', params: { external_userid: external_userid, cursor: cursor }
+    end
+
     def agent_list
       get 'agent/list'
     end

data/lib/wechat/helpers.rb

@@ -27,9 +27,12 @@ module Wechat
       page_url = page_url.split('#').first
       js_hash = api.jsapi_ticket.signature(page_url)
 
+      # Field `beta` please check https://developer.work.weixin.qq.com/document/path/90514#%E6%AD%A5%E9%AA%A4%E4%BA%8C%EF%BC%9A%E9%80%9A%E8%BF%87config%E6%8E%A5%E5%8F%A3%E6%B3%A8%E5%85%A5%E6%9D%83%E9%99%90%E9%AA%8C%E8%AF%81%E9%85%8D%E7%BD%AE
+
       config_js = <<~WECHAT_CONFIG_JS
         wx.config({
-          debug: #{config_options[:debug]},
+          beta: #{config_options[:beta] || false},
+          debug: #{config_options[:debug] || false},
           appId: "#{app_id}",
           timestamp: "#{js_hash[:timestamp]}",
           nonceStr: "#{js_hash[:noncestr]}",

data/lib/wechat/token/access_token_base.rb

@@ -3,13 +3,14 @@
 module Wechat
   module Token
     class AccessTokenBase
-      attr_reader :client, :appid, :secret, :token_file, :access_token, :token_life_in_seconds, :got_token_at
+      attr_reader :client, :appid, :secret, :token_file, :access_token, :token_life_in_seconds, :got_token_at, :record
 
-      def initialize(client, appid, secret, token_file)
+      def initialize(client, appid, secret, token_file, record = nil)
         @appid = appid
         @secret = secret
         @client = client
         @token_file = token_file
+        @record = record
         @random_generator = Random.new
       end
 
@@ -40,16 +41,57 @@ module Wechat
       end
 
       def read_token
-        JSON.parse(File.read(token_file))
+        if record_based_token?
+          throw_error_if_missing_attributes!
+
+          {
+            'access_token' => record.access_token,
+            'got_token_at' => record.got_token_at,
+            'token_expires_in' => record.token_expires_in
+          }
+        else
+          JSON.parse(File.read(token_file))
+        end
       end
 
       def write_token(token_hash)
-        File.write(token_file, token_hash.to_json)
+        if record_based_token?
+          write_token_to_record(token_hash)
+        else
+          File.write(token_file, token_hash.to_json)
+        end
       end
 
       def remain_life_seconds
         token_life_in_seconds - (Time.now.to_i - got_token_at)
       end
+
+      private
+
+      def record_based_token?
+        record.present?
+      end
+
+      def write_token_to_record(token_hash)
+        throw_error_if_missing_attributes!
+
+        record.access_token = token_hash['access_token']
+        record.token_expires_in = token_hash['token_expires_in']
+        record.got_token_at = Time.now
+        record.save || record.save(validate: false)
+      end
+
+      def missing_necessary_attributes?
+        return true unless record.respond_to?(:access_token)
+        return true unless record.respond_to?(:token_expires_in)
+        return true unless record.respond_to?(:got_token_at)
+
+        false
+      end
+
+      def throw_error_if_missing_attributes!
+        raise "Missing attributes #access_token or #token_expires_in or #got_token_at in #{record.class.name}" if missing_necessary_attributes?
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wechat
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.17.1
 platform: ruby
 authors:
 - Skinnyworm
@@ -36,7 +36,7 @@ cert_chain:
   HjK18j09PoL9vWMUtyez2xpxlRDA+bEkF74AEVwMYozjP8VNM1ERTG+8kROuQjGV
   aWhGk3yVuHjmlBvfDpPqmux3ulWXnvHulcYiPxETh/m3PUfIKMTHydjAz88=
   -----END CERTIFICATE-----
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-07-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -162,42 +162,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: rspec-mocks
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.2
+        version: '3.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '='
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.2
+        version: '3.12'
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: '1.5'
 description: API, command and message handling for WeChat in Rails
 email: eric.guocz@gmail.com
 executables:
@@ -257,8 +257,8 @@ licenses:
 metadata:
   bug_tracker_uri: https://github.com/Eric-Guo/wechat/issues
   changelog_uri: https://github.com/Eric-Guo/wechat/releases
-  documentation_uri: https://github.com/Eric-Guo/wechat/tree/v0.16.2#readme
-  source_code_uri: https://github.com/Eric-Guo/wechat/tree/v0.16.2
+  documentation_uri: https://github.com/Eric-Guo/wechat/tree/v0.17.1#readme
+  source_code_uri: https://github.com/Eric-Guo/wechat/tree/v0.17.1
   rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
@@ -273,9 +273,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.11
+      version: 3.1.6
 requirements: []
-rubygems_version: 3.3.26
+rubygems_version: 3.4.17
 signing_key:
 specification_version: 4
 summary: DSL for wechat message handling and API