wx_miniprogram 0.1.4 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e158aeba888940eef54a56e502610e335c3ad3c4ba28ae063a5fd769496eed84
-  data.tar.gz: a25e74d78c5e61d9c1c4de6070ca723953daebc75b8bfc400225130c1b42646b
+  metadata.gz: c356e172674e2672f56a637df09cd77b4f4e7a87c8c160c27d68247f8cbc4d56
+  data.tar.gz: 331c23f52f62e114ab829646fea2403513e10b33945633ba28474065b0b7e91e
 SHA512:
-  metadata.gz: 895464d8c2de4d59c8a40fbc972b50fe0b482944f9730447d7a056def2fb0fb90c4705ca1908ce9a298780caa15bb6cec22e06280a320c6db5d67a7163dbce0b
-  data.tar.gz: bc40e9eed51b450c44da10b548638f0f52a7522470563d6c5cdf7f17329f758a1446819eecf34737fa490a532dd630dddcea95b973e90e83cd926754ffd1564f
+  metadata.gz: 3012e61fdcc4fe72620edcade49e39186bc09ee4c27b84df4c43ad6c9f02ef9f995eef60f21aad43154cae4eb651204cffd0f9b4f12661d26c3784dc56366842
+  data.tar.gz: c6fc6777ef716da1e6ce80bceb3a8c9b76de70fbeb1794d0112b97d01f1e682074779df911d9db383eb47a5687732564ae67f8b37bc62b4dd5007db562cfe2e6

data/README.md

@@ -2,13 +2,15 @@
 
 Ruby微信小程序服务端API
 
-DONE：接口调用凭据、openApi管理、小程序登陆、用户信息
+DONE：接口调用凭据、openApi管理、小程序登陆、用户信息、小程序码与小程序链接
 
-TODO: 小程序码与小程序连接、小程序客服、消息相关、小程序安全、数据分析、硬件设备、直播、运维中心、插件管理...等
+TODO: 小程序客服、消息相关、小程序安全、数据分析、硬件设备、直播、运维中心、插件管理...等
 
 ## Installation
 
+```shell
 gem install wx_miniprogram
+```
 
 ## Usage
 
@@ -16,19 +18,14 @@ gem install wx_miniprogram
 
 ```ruby
 client = WxMiniprogram::Client.new("appid", "secret")
-
-# Token
 # 获取Token
 client.get_access_token!
 # 获取稳定版Token
 client.get_stable_access_token!
 # 刷新Token
 client.refresh_access_token!
-
-# 用户信息
 # 获取插件用户openpid
 client.get_plugin_open_pid("openid")
-
 # 检查加密信息
 client.check_encrypted_data("encoded_str")
 
@@ -37,7 +34,7 @@ client.check_encrypted_data("encoded_str")
 ```
 ## Test
 
-Set environment variables WX_APPID and WX_SECRET and run tests.
+TODO
 
 设置环境变量 WX_APPID 和 WX_SECRET
 

data/lib/wx_miniprogram/client.rb

@@ -9,7 +9,6 @@ module WxMiniprogram
     include Login
     include UserInfo
 
-
     def initialize(appid, secret)
       @url = "https://api.weixin.qq.com/"
       @appid = appid
@@ -25,40 +24,42 @@ module WxMiniprogram
 
     def method_missing(method, *args)
       method_str = method.to_s
-      unless method_str.end_with? "!"
+      if !method_str.end_with? "!"
         origin_method = (method_str + "!").to_sym
         if self.respond_to? origin_method
           begin
             send(origin_method, args)
           rescue ApiError => e
-            puts "[debug]: #{e}" if @debug
+            $stderr.puts "[debug]: #{e}" if @debug
             false
           end
         else
           raise Error, "undefined method #{method.to_s}"
         end
-      else
-        unless self.respond_to? method
-          raise Error, "undefined method #{method.to_s}"
-        end
+      elif !self.respond_to?(method)
+        raise Error, "undefined method #{method.to_s}"
       end
     end
 
+    def respond_to_missing?(method, include_private=false)
+      return (self.respond_to? (method.to_s + "!").to_sym) || super
+    end
+
     private
-    def get(path, body: nil, query: nil, need_access_token: false)
+    def get(path, body: nil, query: nil, need_access_token: true)
       need_access_token && valid
       resp = request(path, body: body, query: query, method: "get")
       if !resp["errcode"].nil? && resp["errcode"] != 0
-        raise ApiError, resp["errmsg"]
+        raise ApiError, resp.to_s
       end
       resp
     end
 
-    def post(path, body: nil, query: nil, need_access_token: false)
+    def post(path, body: nil, query: nil, need_access_token: true)
       need_access_token && valid
       resp = request(path, body: body, query: query, method: "post")
       if !resp["errcode"].nil? && resp["errcode"] != 0
-        raise ApiError, resp["errmsg"]
+        raise ApiError, resp.to_s
       end
       resp
     end

data/lib/wx_miniprogram/login.rb

@@ -8,7 +8,9 @@ module WxMiniprogram
         :secret       => @secret,
         :js_code      => js_code,
         :grant_type   => "authorization_code",
-      })
+      },
+        need_access_token: false
+      )
     end
 
     def check_session_key!(openid, session_key)
@@ -16,7 +18,7 @@ module WxMiniprogram
         :access_token => @access_token,
         :openid       => openid,
         :signature    => hmac_sha256(session_key, ""),
-        :sigmethod    => "hmac_sha256"
+        :sig_method    => "hmac_sha256"
       })
     end
 
@@ -26,7 +28,7 @@ module WxMiniprogram
       }, body: {
         :openid => openid,
         :signature    => hmac_sha256(session_key, ""),
-        :sigmethod    => "hmac_sha256"
+        :sig_method    => "hmac_sha256"
       })
     end
 

data/lib/wx_miniprogram/open_api.rb

@@ -5,24 +5,27 @@ module WxMiniprogram
     def clear_quota!
       post("cgi-bin/clear_quota",
             body: {:appid => @appid},
-            query: {:access_token => @access_token}, need_access_token: true
-      )
+            query: {:access_token => @access_token})
     end
 
-    def get_api_quota
+    def get_api_quota!(cgi_path)
       post("cgi-bin/openapi/quota/get",
-            query: {:access_token => @access_token}, need_access_token: true)
+            query: {:access_token => @access_token},
+            body: {:cgi_path => cgi_path}
+      )
     end
 
-    def get_rid_info(rid)
+    def get_rid_info!(rid)
       post("cgi-bin/openapi/rid/get",
             body: {:rid => rid},
-            query: {:access_token => @access_token}, need_access_token: true)
+            query: {:access_token => @access_token})
     end
 
-    def clear_quota_by_app_secret(appid, appsecret)
+    def clear_quota_by_app_secret!(appid, appsecret)
       post("cgi-bin/clear_quota/v2",
-            body: {:appid => appid, :appsecret => appsecret})
+            body: {:appid => appid, :appsecret => appsecret},
+            need_access_token: false
+      )
     end
   end
 end

data/lib/wx_miniprogram/qrcode.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  module QRCode
+
+    # 必填 path: 扫码进入的小程序页面路径
+    # 非必填 {width: number, auto_color: boolean, line_color: {r: "", g: "", b: ""}}
+    def get_qrcode!(path, width=nil, auto_color=false, line_color=nil)
+      body = {}
+      body[:width] = width unless width.nil?
+      body[:auto_color] = auto_color if auto_color
+      body[:line_color] = line_color unless line_color.nil?
+      post("wxa/getwxacode",
+        query: {:access_token => @access_token},
+        body: body
+      )
+    end
+
+    # 必填 scene
+    # 非必填 {page: string, check_path: boolean, env_version: string, width: number,
+    # auto_color: boolean, line_color: {r: string, g: string, b: string}, is_hyaline: boolean}
+    def get_unlimited_qrcode!(scene, path=nil, check_path=nil, env_version=nil, width=nil, auto_color=nil, line_color=nil, is_hyaline=nil)
+      body = {}
+      body[:path] = path unless path.nil?
+      body[:check_path] = check_path unless check_path.nil?
+      body[:env_version] = env_version unless env_version.nil?
+      body[:width] = width unless width.nil?
+      body[:auto_color] = auto_color unless auto_color.nil?
+      body[:line_color] = line_color unless line_color.nil?
+      body[:is_hyaline] = is_hyaline unless is_hyaline.nil?
+      post("wxa/getwxacodeunlimit",
+        query: {:access_token => @access_token},
+        body: body
+      )
+    end
+
+    def create_qrcode!(path, width=430)
+      post("cgi-bin/wxaapp/createwxaqrcode",
+        query: {:access_token => @access_token, :path => path},
+        body: {:width => width}
+      )
+    end
+
+  end
+end

data/lib/wx_miniprogram/token.rb

@@ -3,11 +3,14 @@
 module WxMiniprogram
   module Token
     def get_access_token!
-      resp = get("cgi-bin/token", query: {
-        :grant_type => "client_credential",
-        :appid      => @appid,
-        :secret     => @secret
-      })
+      resp = get("cgi-bin/token",
+        query: {
+          :grant_type => "client_credential",
+          :appid      => @appid,
+          :secret     => @secret
+        },
+        need_access_token: false
+      )
       unless resp["access_token"].nil?
         @access_token = resp["access_token"]
         @expire = resp["expires_in"] + Time.now.to_i
@@ -16,12 +19,15 @@ module WxMiniprogram
     end
 
     def get_stable_access_token!(force_refresh=false)
-      resp = post("cgi-bin/stable_token", body: {
-        :grant_type     => "client_credential",
-        :appid          => @appid,
-        :secret         => @secret,
-        :force_refresh  => force_refresh
-      })
+      resp = post("cgi-bin/stable_token",
+        body: {
+          :grant_type     => "client_credential",
+          :appid          => @appid,
+          :secret         => @secret,
+          :force_refresh  => force_refresh
+        },
+        need_access_token: false
+      )
       unless resp["access_token"].nil?
         @access_token = resp["access_token"]
         @expire = resp["expires_in"] + Time.now.to_i

data/lib/wx_miniprogram/url.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  module UrlScheme
+    def generate_nfc_scheme!(model_id, jump_wxa={}, sn=nil)
+      body = {:jump_wxa => jump_wxa, :model_id => model_id}
+      body[:sn] = sn unless sn.nil?
+      post("wxa/generatenfcscheme",
+        query: {:access_token => @access_token},
+        body: body
+      )
+    end
+
+    def generate_scheme!(jump_wxa={}, expire_time=nil, expire_type=nil, expire_interval=nil)
+      body = {:jump_wxa => jump_wxa}
+      body[:expire_time] = expire_time unless expire_time.nil?
+      body[:expire_type] = expire_type unless expire_type.nil?
+      body[:expire_interval] = expire_interval unless expire_interval.nil?
+      post("wxa/generatescheme",
+        query: {:access_token => @access_token},
+        body: body
+      )
+    end
+
+    def query_scheme!(scheme=nil, query_type=nil)
+      body = {}
+      body[:scheme] = scheme unless scheme.nil?
+      body[:query_type] = query_type unless query_type.nil?
+      post("wxa/queryscheme",
+        query: {:access_token => @access_token},
+        body: body
+      )
+
+    end
+
+  end
+end

data/lib/wx_miniprogram/url_link.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  module UrlLink
+    def generate_url_link!(path=nil, query=nil, expire_type=nil, expire_time=nil, expire_interval=nil, cloud_base=nil, env_version=nil)
+      body = {}
+      local_variables.each do |var_sym|
+        v = binding.local_variable_get(var_sym)
+        body[var_sym] = v if !v.nil? && var_sym != :body
+      end
+      post("wxa/generate_urllink",
+        query: {:access_token => @access_token},
+        body: body
+      )
+    end
+
+    def query_url_link!(url_link=nil, query_type=nil)
+      body = {}
+      body[:url_link] = url_link unless url_link.nil?
+      body[:query_type] = query_type unless query_type.nil?
+      post("wxa/query_urllink",
+        query: {:access_token => @access_token},
+        body: body
+      )
+    end
+
+    def generate_short_link!(page_url, page_title=nil, is_permanent=nil)
+      body = {:page_url => page_url}
+      body[:page_title] = page_title unless page_title.nil?
+      body[:is_permanent] = is_permanent unless is_permanent.nil?
+      post("wxa/genwxashortlink",
+        query: {:access_token => @access_token},
+        body: body
+      )
+    end
+  end
+end

data/lib/wx_miniprogram/user_info.rb

@@ -19,10 +19,14 @@ module WxMiniprogram
       })
     end
 
-    def get_paid_unionid!(options)
+    def get_paid_unionid!(transaction_id=nil, mch_id=nil, out_trade_no=nil)
+      body = {}
+      body[:transaction_id] = transaction_id unless transaction_id.nil?
+      body[:mch_id] = mch_id unless mch_id.nil?
+      body[:out_trade_no] = out_trade_no unless out_trade_no.nil?
       get("wxa/getpaidunionid", query: {
         :access_token => @access_token
-      }, body: options)
+      }, body: body)
     end
 
     def get_user_encryptKey!(openid, session_key)

data/lib/wx_miniprogram/util.rb

@@ -2,7 +2,7 @@
 
 module WxMiniprogram
   module Util
-    def hmac_sha256(data, key)
+    def hmac_sha256(key, data)
       OpenSSL::HMAC.hexdigest("SHA256", key, data)
     end
   end

data/lib/wx_miniprogram/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module WxMiniprogram
-  VERSION = "0.1.4"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wx_miniprogram
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.6
 platform: ruby
 authors:
 - ranjiayu
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-03 00:00:00.000000000 Z
+date: 2024-07-04 00:00:00.000000000 Z
 dependencies: []
 description: wechat mini-program api client
 email:
@@ -17,7 +17,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".rspec"
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -26,7 +25,10 @@ files:
 - lib/wx_miniprogram/client.rb
 - lib/wx_miniprogram/login.rb
 - lib/wx_miniprogram/open_api.rb
+- lib/wx_miniprogram/qrcode.rb
 - lib/wx_miniprogram/token.rb
+- lib/wx_miniprogram/url.rb
+- lib/wx_miniprogram/url_link.rb
 - lib/wx_miniprogram/user_info.rb
 - lib/wx_miniprogram/util.rb
 - lib/wx_miniprogram/version.rb

data/.rspec

@@ -1,3 +0,0 @@
---format documentation
---color
---require spec_helper