wx_miniprogram 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 064db8150b4061181cd1038c2cfd978cf0060c184935d3ed7e8b0ee1778e9dc9
+  data.tar.gz: 7904e1b8be6c13a33e622b0b573bdfc62877e472aacc2d6af989fcff9c58222c
+SHA512:
+  metadata.gz: e80780210e4800a5447656731144a6190720c3ef080fb3ed8c1eeee7d7cba1941bcc304a2d4910a6e198112b8b1bb13bf77c58ebd9b525398ccf9df5aafe3ccb
+  data.tar.gz: 769e0613135d2c601ef317c97d906cd81c769769ff4ba767c8369b8974a842ce0c79c42085742c240f8f2c5311d43e3a07fa1aaa23abaf27cc7f8d706a04f656

data/.rspec

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 ranjiayu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# WxMiniprogram
+
+Ruby微信小程序服务端API
+
+## Installation
+
+
+
+## Usage
+
+所有接口方法以!结尾的方法调用失败抛出ApiError异常。正常方法成功返回Response Hash实例，失败返回false。
+
+```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")
+
+# 支付后获取 Unionid
+client.get_paid_unionid({
+  :openid         => "openid",
+  :transaction_id => "transaction_id",
+  :mch_id         => "mch_id",
+  :out_trade_no   => "out_trade_no"
+})
+
+...
+
+```
+## Test
+
+Set environment variables WX_APPID and WX_SECRET and run tests.
+
+设置环境变量 WX_APPID 和 WX_SECRET
+
+```shell
+rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ranjiayu/wx_miniprogram.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/wx_miniprogram/api_error.rb

@@ -0,0 +1,9 @@
+module WxMiniprogram
+  class ApiError < StandardError
+
+  end
+
+  class Error < StandardError
+
+  end
+end

data/lib/wx_miniprogram/client.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  class Client
+    attr_accessor :debug
+    include Util
+    include Token
+    include OpenApi
+    include Login
+    include UserInfo
+
+
+    def initialize(appid, secret)
+      @url = "https://api.weixin.qq.com/"
+      @appid = appid
+      @secret = secret
+      @access_token = ""
+      @expire = nil
+      @debug = false
+    end
+
+    def refresh_token!
+      get_access_token!
+    end
+
+    def method_missing(method, *args)
+      method_str = method.to_s
+      unless 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
+            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
+      end
+    end
+
+    private
+    def get(path, body: nil, query: nil, need_access_token: false)
+      need_access_token && valid
+      resp = request(path, body: body, query: query, method: "get")
+      if !resp["errcode"].nil? && resp["errcode"] != 0
+        raise ApiError, resp["errmsg"]
+      end
+      resp
+    end
+
+    def post(path, body: nil, query: nil, need_access_token: false)
+      need_access_token && valid
+      resp = request(path, body: body, query: query, method: "post")
+      if !resp["errcode"].nil? && resp["errcode"] != 0
+        raise ApiError, resp["errmsg"]
+      end
+      resp
+    end
+
+    # This method is from [gist-api-ruby](https://github.com/gistplatform/gist-api-ruby)
+    def request(path, body: nil, query: nil, method: "get")
+      unless query.nil?
+        path += "?#{URI::encode_www_form(query)}"
+      end
+      @uri = URI(@url + path)
+      request = send("http_#{method}").new(@uri.request_uri, {
+        "Content-Type" => "application/json"
+      })
+      request.body = body.to_json unless body.nil?
+      http = Net::HTTP.new(@uri.host, @uri.port)
+      http.use_ssl = true
+      http.read_timeout = 5
+      response = http.request(request)
+      raise ApiError, response.body unless response.is_a?(Net::HTTPSuccess)
+      json_response = JSON.parse(response.body)
+      return json_response
+    end
+
+    def http_get
+      Net::HTTP::Get
+    end
+
+    def http_post
+      Net::HTTP::Post
+    end
+
+    def http_patch
+      Net::HTTP::Patch
+    end
+
+    def http_delete
+      Net::HTTP::Delete
+    end
+
+    def valid
+      if @access_token.empty?
+        raise ApiError, "You must invoke 'get_access_token' method at first"
+      end
+    end
+
+  end
+end

data/lib/wx_miniprogram/login.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  module Login
+    def code2session!(js_code)
+      get("sns/jscode2session", query: {
+        :appid        => @appid,
+        :secret       => @secret,
+        :js_code      => js_code,
+        :grant_type   => "authorization_code",
+      })
+    end
+
+    def check_session_key!(openid, session_key)
+      get("wxa/checksession", query: {
+        :access_token => @access_token,
+        :openid       => openid,
+        :signature    => hmac_sha256(session_key, ""),
+        :sigmethod    => "hmac_sha256"
+      })
+    end
+
+    def reset_user_session_key!(openid, session_key)
+      get("wxa/resetusersessionkey", query: {
+        :access_token => @access_token
+      }, body: {
+        :openid => openid,
+        :signature    => hmac_sha256(session_key, ""),
+        :sigmethod    => "hmac_sha256"
+      })
+    end
+
+  end
+end

data/lib/wx_miniprogram/open_api.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  module OpenApi
+    def clear_quota!
+      post("cgi-bin/clear_quota",
+            body: {:appid => @appid},
+            query: {:access_token => @access_token}, need_access_token: true
+      )
+    end
+
+    def get_api_quota
+      post("cgi-bin/openapi/quota/get",
+            query: {:access_token => @access_token}, need_access_token: true)
+    end
+
+    def get_rid_info(rid)
+      post("cgi-bin/openapi/rid/get",
+            body: {:rid => rid},
+            query: {:access_token => @access_token}, need_access_token: true)
+    end
+
+    def clear_quota_by_app_secret(appid, appsecret)
+      post("cgi-bin/clear_quota/v2",
+            body: {:appid => appid, :appsecret => appsecret})
+    end
+  end
+end

data/lib/wx_miniprogram/token.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  module Token
+    def get_access_token!
+      resp = get("cgi-bin/token", query: {
+        :grant_type => "client_credential",
+        :appid      => @appid,
+        :secret     => @secret
+      })
+      unless resp["access_token"].nil?
+        @access_token = resp["access_token"]
+        @expire = resp["expires_in"] + Time.now.to_i
+      end
+      resp
+    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
+      })
+      unless resp["access_token"].nil?
+        @access_token = resp["access_token"]
+        @expire = resp["expires_in"] + Time.now.to_i
+      end
+      resp
+    end
+
+    def expire
+      @expire
+    end
+
+    def expired?
+      Time.now.to_i >= @expire
+    end
+
+  end
+end

data/lib/wx_miniprogram/user_info.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module WxMiniprogram
+  module UserInfo
+
+    def get_plugin_open_pid!(code)
+      post("wxa/getpluginopenpid", query: {
+        :access_token => @access_token
+      }, body: {
+        :code => code
+      })
+    end
+
+    def check_encrypted_data!(str)
+      post("wxa/business/checkencryptedmsg", query: {
+        :access_token => @access_token
+      }, body: {
+        :encrypted_msg_hash => str
+      })
+    end
+
+    def get_paid_unionid!(options)
+      get("wxa/getpaidunionid", query: {
+        :access_token => @access_token
+      }, body: options)
+    end
+
+    def get_user_encryptKey!(openid, session_key)
+      get("wxa/business", query: {
+        :access_token => @access_token,
+        :openid       => openid,
+        :signature    => hmac_sha256(session_key, ""),
+        :sig_method   => "hmac_sha256"
+      })
+    end
+
+    def get_phone_number!(code, openid)
+      post("wxa/business/getuserphonenumber", query: {
+        :access_token => @access_token
+      }, body: {
+        :code   => code,
+        :openid => openid
+      })
+    end
+
+  end
+end

data/lib/wx_miniprogram/util.rb

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

data/lib/wx_miniprogram/version.rb

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

data/lib/wx_miniprogram.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+require_relative "wx_miniprogram/version"
+require_relative "wx_miniprogram/api_error"
+require_relative "wx_miniprogram/util"
+require_relative "wx_miniprogram/token"
+require_relative "wx_miniprogram/open_api"
+require_relative "wx_miniprogram/user_info"
+require_relative "wx_miniprogram/login"
+require_relative "wx_miniprogram/client"
+require "net/http"
+require "openssl"
+require "json"
+
+module WxMiniprogram
+
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: wx_miniprogram
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- ranjiayu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2024-07-03 00:00:00.000000000 Z
+dependencies: []
+description: wechat mini-program api client
+email:
+- ranjiayu@outlook.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/wx_miniprogram.rb
+- lib/wx_miniprogram/api_error.rb
+- lib/wx_miniprogram/client.rb
+- lib/wx_miniprogram/login.rb
+- lib/wx_miniprogram/open_api.rb
+- lib/wx_miniprogram/token.rb
+- lib/wx_miniprogram/user_info.rb
+- lib/wx_miniprogram/util.rb
+- lib/wx_miniprogram/version.rb
+homepage: https://ranjiayu.github.io
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://ranjiayu.github.io
+  source_code_uri: https://github.com/ranjiayu/wx_miniprogram_api
+  changelog_uri: https://github.com/ranjiayu/wx_miniprogram_api/CHANGELOG
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key: 
+specification_version: 4
+summary: wechat mini-program api client
+test_files: []