mini_program 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 04f5a8d75c16656473df0c93306b9d83833c272037d7fb60e894756eed9f4b1c
+  data.tar.gz: '0868870f615a9e08047465024b8293be7af4080d64fa4b1d7313ea7b56926e4a'
+SHA512:
+  metadata.gz: ee4c68f56483b9acdbee602db221033ea503738ddd63409288b864d130ea37ca23a291fc2392a3f146ea0c5991236e8acd0f1f48a4f05ae8f817ef4f5792e100
+  data.tar.gz: e1ec32db171b7e4fe2168ac715668e9f6ed9e3704e276c7a61b7e6dbc30a6b30858bec73acf83c406459ef32c85382954c89e6e2efdf29ce40c86fae733d3a86

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 ian
+
+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,143 @@
+# MiniProgram
+Short description and motivation.
+
+## 开始
+
+1. 添加`gem` 
+```ruby
+gem 'mini_program'
+```
+
+2. 执行 bundle 
+```bash
+$ bundle
+```
+
+3. 生成`initializer`文件，需要將里边的内容修改成你自己的小程序的配置
+```bash
+$ rails g mini_program:install
+```
+
+4. 如果需要订阅消息，使用如下命令生成订阅消息的配置
+```bash
+$ rails g mini_program:msg_config
+```
+
+## 使用
+
+#### 授权登录(获取openid)
+```ruby
+mp = MiniProgram::Client.new
+
+# code 是在小程序端调用 wx.login 拿到的
+result = mp.login(code)
+if result.success?
+  open_id = result.data[:openid]
+  session_key = result.data[:session_key]
+end
+```
+
+#### 获取手机号
+```ruby
+mp = MiniProgram::Client.new 
+
+# 小程序端 wx.login 拿到的 code
+code = "041PuvGa1rysrB0noDJa1n7RBv2PuvGe"
+
+# encrypted_data 和 iv 都是小程序端 getPhoneNum 获取到的参数
+encrypted_data = "3G/+Fh6kCBaQszXFTxz3h3HFSbu0UuVW/4aLbz8WGzrKfmbGpvnxYHAa4QrKXJvHpB++3ogOYoU6iiG+1HW18Lkt9qEJE9GyRw5OnuXSjTnUIPSRROT3sxeAYnT1kf4ngTAfrD3f4TFtLXkRIrrc1MzSqx/LV8iXA8Lu5Y+7kZx26eulz3yVrlXDH3BOIX6zcGOeprsK5XzDx2ltmf3j5w=="
+iv = "5tiyfVEHNVgHN4n8lzDrUA=="
+
+result = mp.get_phone_num(code: code, encrypted_data: encrypted_data, iv: iv)
+
+if result.success?
+  phone_num = result[:phone_num]
+end
+
+```
+
+#### 发送订阅消息
+```ruby
+
+# 订阅消息配置 ，具体模板配置请参考小程序后台模板配置
+# 
+# config/subscribe_msg.yml
+# 
+# progress:
+#   template_id: YQ0cmL_ugsXwPaA2Pl75IMo_qtoc1n6CtT1orIeX4_o
+#   page: "/pages/index/index"
+#   data:
+#     thing2:
+#     value: "%{title}"
+#   phrase4:
+#     value: "%{state}"
+#   thing1:
+#     value: "%{detail}"
+
+msg = MiniProgram::Msg.new(:progress, {
+  title: "测试",
+  state: "已完成",
+  detail: "测试已完成"
+})
+
+# send_to 的参数可以是 openid(字符串)，或者是带有 open_id 方法的对象，返回 MiniProgram::ServiceResult
+result msg.send_to("ogT7J5YddGnll-ippRvJq62Nv5W0")
+
+# or
+user = User.first
+user.open_id # => ogT7J5YddGnll-ippRvJq62Nv5W0
+result = msg.send_to(user)
+
+if result.success?
+  puts "发送成功"
+end
+
+```
+
+#### 获取`access-token`
+```ruby
+mp = MiniProgram::Client.new
+
+# 缓存在 redis 中，缓存时间为 1.5 小时，微信官方`access-token`过期时间是 2小时
+result = mp.get_access_token
+if result.success?
+  access_token = result[:access_token]
+end
+
+# 传入 fresh: true 可以不使用缓存，直接调用微信api获取到 token，默认为 false
+result = mp.access_token fresh:true
+```
+
+#### MiniProgram::ServiceResult 类
+```ruby
+# success 默认为 false
+result = MiniProgram::ServiceResult.new(success: true, data: {data1: 1})
+
+## 处理结果(成功)
+if result.success?
+  # do something...
+end
+
+# or
+result.on_success do |result|
+  # do something...
+end
+
+## 处理结果(失败)
+if result.failure?
+  # do something...
+end
+
+result.on_failure do |result|
+  # do something...
+end
+
+
+
+```
+
+## Contributing
+Contribution directions go here.
+
+## 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,13 @@
+require "bundler/setup"
+
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/generators/mini_program/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate install Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/mini_program/install/install_generator.rb

@@ -0,0 +1,24 @@
+class MiniProgram::InstallGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+  def create_initializer_file
+    # copy_file "initializer.rb", "config/initializers/mini_program.rb"
+    appid = if Object.const_defined? "WechatPayment"
+              WechatPayment.sub_appid || WechatPayment.appid || "your appid"
+            else
+              "your appid"
+            end
+
+    app_secret = if Object.const_defined? "WechatPayment"
+                   WechatPayment.sub_app_secret || WechatPayment.app_secret || "your app secret"
+                 else
+                   "your app_secret"
+                 end
+    create_file "config/initializers/mini_program.rb", <<~INITIALIZER
+
+MiniProgram.setup do |config|
+  config.appid = "#{appid}"
+  config.app_secret = "#{app_secret}"
+end
+    INITIALIZER
+  end
+end

data/lib/generators/mini_program/install/templates/initializer.rb

@@ -0,0 +1,5 @@
+
+MiniProgram.setup do |config|
+  config.appid = "your appid"
+  config.app_secret = "your appsecret"
+end

data/lib/generators/mini_program/msg_config/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Explain the generator
+
+Example:
+    bin/rails generate msg_config Thing
+
+    This will create:
+        what/will/it/create

data/lib/generators/mini_program/msg_config/msg_config_generator.rb

@@ -0,0 +1,7 @@
+class MiniProgram::MsgConfigGenerator < Rails::Generators::Base
+  source_root File.expand_path('templates', __dir__)
+
+  def create_subscribe_msg_config_file
+    copy_file "subscribe_msg.yml", "config/subscribe_msg.yml"
+  end
+end

data/lib/generators/mini_program/msg_config/templates/subscribe_msg.yml

@@ -0,0 +1,11 @@
+---
+progress:
+  template_id: YQ0cmL_ugsXwPaA2Pl75IMo_qtoc1n6CtT1orIeX4_o
+  page: "/pages/index/index"
+  data:
+    thing2:
+      value: "%{title}"
+    phrase4:
+      value: "%{state}"
+    thing1:
+      value: "%{detail}"

data/lib/mini_program.rb

@@ -0,0 +1,16 @@
+require "mini_program/version"
+require "mini_program/railtie"
+require "mini_program/client"
+require "mini_program/msg"
+require "r_logger"
+require "service_result"
+require "redis"
+
+module MiniProgram
+  # Your code goes here...
+  mattr_accessor :appid, :app_secret
+
+  def self.setup
+    yield self if block_given?
+  end
+end

data/lib/mini_program/client.rb

@@ -0,0 +1,201 @@
+module MiniProgram
+  class Client
+    attr_reader :appid, :app_secret
+
+    def initialize(appid: config.appid, app_secret: config.app_secret)
+      @appid = appid
+      @app_secret = app_secret
+
+      if appid == 'your appid'
+        warn "\e[33m" + "*" * 80 + "\e[0m"
+        warn "\e[33m警告: 请将 config/initializer/mini_program.rb 中的 appid 修改成你实际的appid\e[0m"
+        warn "\e[33m" + "*" * 80 + "\e[0m"
+      end
+
+      if app_secret == 'your app_secret'
+        warn "\e[33m" + "*" * 80 + "\e[0m"
+        warn "\e[33m警告: 请将 config/initializer/mini_program.rb 中的 app_secret 修改成你实际的app_secret\e[0m"
+        warn "\e[33m" + "*" * 80 + "\e[0m"
+      end
+    end
+
+    def get_access_token(fresh: false)
+      access_token = redis.get("mp-#{appid}-access-token")
+      if access_token.present? && !fresh
+        return MiniProgram::ServiceResult.new(success: true, data: {access_token: access_token})
+      end
+
+      result = request_access_token
+      if result.success?
+        redis.setex "mp-#{appid}-access-token",  1.5.hours.to_i, access_token
+      end
+
+      yield result if block_given?
+
+      result
+    end
+
+    # 调用微信 api 获取 access_token
+    #
+    # @return MiniProgram::ServiceResult
+    def request_access_token
+      api = "https://api.weixin.qq.com/cgi-bin/token"
+      params = {
+        appid: appid,
+        secret: app_secret,
+        grant_type: :client_credential
+      }
+
+      response = get(api, params)
+
+      result = JSON.parse(response)
+
+      if result["errcode"].present?
+        logger.error <<~ERROR
+        Get access token failed.
+        api: #{api} 
+        error: #{result}
+        ERROR
+        return MiniProgram::ServiceResult.new(success: false, errors: result, message: result["errmsg"])
+      end
+
+      MiniProgram::ServiceResult.new(success: true, data: result)
+    end
+
+    # 调用微信授权登录 api
+    #
+    #
+    def login(code)
+      api = "https://api.weixin.qq.com/sns/jscode2session"
+      params = {
+        appid: appid,
+        secret: app_secret,
+        js_code: code,
+        grant_type: :authorization_code
+      }
+
+      response = get(api, params)
+
+      result = JSON.parse(response)
+
+      if result["errcode"]
+        logger.error <<~ERROR
+        Get session key failed.
+        api: #{api}
+        result: #{result}
+        ERROR
+        return MiniProgram::ServiceResult.new(errors: result, message: result["errmsg"])
+      end
+
+      MiniProgram::ServiceResult.new(success: true, data: result)
+    end
+
+    # 发送订阅消息
+    # @param [MiniProgram::Msg] msg
+    # @param [String] to 用户的open id
+    def send_msg(msg, to: )
+      open_id = to.try(:open_id) || to
+
+      payload = msg.as_json.merge!(touser: open_id)
+
+      # 获取 access_token
+      get_token_result = get_access_token
+      if get_token_result.failure?
+        return get_token_result
+      end
+
+      api = "https://api.weixin.qq.com/cgi-bin/message/subscribe/send?access_token=#{get_token_result["access_token"]}"
+      result = post(api, payload)
+
+      msg_logger.info {"{params: #{payload}, response: #{result}}"}
+      MiniProgram::ServiceResult.new(success: true, data: result)
+    end
+
+    # 获取用户手机号
+    def get_phone_num(code:, encrypted_data:, iv:)
+      login_result = login(code)
+      return login_result if login_result.failure?
+
+      open_id = login_result.data[:openid]
+      session_key = login_result.data[:session_key]
+
+      data = decrypt_phone_data(encrypted_data, iv, session_key)
+
+      phone_num = JSON.parse(data)["phoneNumber"]
+
+      MiniProgram::ServiceResult.new(
+        success: true,
+        data: {
+          open_id: open_id,
+          phone_num: phone_num
+      })
+    end
+
+    def config
+      appid, app_secret = if MiniProgram.appid && MiniProgram.app_secret
+                            [MiniProgram.appid, MiniProgram.app_secret]
+
+                          # 如果有挂载 WechatPayment 的 engine 时，使用里边的小程序配置
+                          elsif Object.const_defined? "WechatPayment"
+                            [WechatPayment.sub_appid || WechatPayment.appid, WechatPayment.sub_app_secret || WechatPayment.app_secret]
+                          else
+                            [nil, nil]
+                          end
+
+      Struct.new(:appid, :app_secret).new(appid, app_secret)
+    end
+
+    private
+
+    def get(api, payload = {})
+      uri = URI(api)
+
+      if payload.present?
+        uri.query = URI.encode_www_form(payload)
+      end
+
+      Net::HTTP.get(uri)
+    end
+
+    def post(api, payload = {}, options = {})
+      uri = URI(api)
+
+      req = Net::HTTP::Post.new(uri)
+      req["Content-Type"] = "application/json"
+      options = {
+        use_ssl: true
+      }.merge(options)
+
+      res = Net::HTTP.start(uri.host, uri.port, **options) do |http|
+        http.request(req, payload.to_json)
+      end
+
+      JSON.parse(res.body)
+    end
+
+    def decrypt_phone_data(encrypted_data, iv, session_key)
+      aes = OpenSSL::Cipher::AES.new "128-CBC"
+      aes.decrypt
+      aes.key = Base64::decode64(session_key)
+      aes.iv = Base64.decode64(iv)
+      aes.update(Base64::decode64(encrypted_data)) + aes.final
+    end
+
+    def logger
+      @logger ||= MiniProgram::RLogger.make("mini_program")
+    end
+
+    def redis
+      @redis ||= Redis.current
+    end
+
+    def access_token_store_key
+      "mp-#{appid}-access-token"
+    end
+
+    def msg_logger
+      @msg_logger ||= MiniProgram::RLogger.make("wx_msg")
+    end
+
+  end
+end

data/lib/mini_program/msg.rb

@@ -0,0 +1,30 @@
+
+module MiniProgram
+  class Msg
+    attr_reader :msg_config, :type, :data
+    def initialize(type, data)
+      @type = type
+      @data = data
+    end
+
+    def as_json
+      {
+        template_id: config[:template_id],
+        data: JSON.parse(config[:data].to_json % data),
+        page: config[:page],
+      }
+    end
+
+    def send_to(open_id)
+      mini_program.send_msg(self, to: open_id)
+    end
+
+    def mini_program
+      @mini_program ||= MiniProgram::Client.new
+    end
+
+    def config
+      @config ||= YAML.load_file(Rails.root.join("config/subscribe_msg.yml")).with_indifferent_access[type]
+    end
+  end
+end

data/lib/mini_program/railtie.rb

@@ -0,0 +1,4 @@
+module MiniProgram
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/mini_program/version.rb

@@ -0,0 +1,3 @@
+module MiniProgram
+  VERSION = '0.1.0'
+end

data/lib/r_logger.rb

@@ -0,0 +1,36 @@
+module MiniProgram
+  class RLogger
+    def initialize
+      raise Exceptions::InitializeDenied.new("please use 'ILogger.make' instead of 'ILogger.new'")
+    end
+
+    class << self
+      def make(log_file)
+        @logger ||= {}
+
+        log_file_name = if log_file.class.in? [String, Symbol]
+                          log_file_name = log_file.to_sym
+
+                          unless log_file_name.to_s.end_with? ".log"
+                            log_file_name = "#{log_file_name}.log"
+                          end
+
+                          "#{root_path}/#{log_file_name}"
+                        elsif log_file.respond_to? :to_path
+                          log_file.to_path
+                        else
+                          raise Exceptions::UnsupportdParamType.new("log file parameter only support 'File' or 'String' Type.")
+                        end
+
+        # 如果已经存在日志对象，则返回已有的日志对象
+        @logger[log_file_name] ||= ::Logger.new(log_file_name)
+      end
+
+      def root_path
+        @root ||= "#{Rails.root}/log"
+      end
+    end
+
+
+  end
+end

data/lib/service_result.rb

@@ -0,0 +1,49 @@
+module MiniProgram
+  class ServiceResult
+    attr_accessor :success,
+                  :errors,
+                  :data,
+                  :message,
+                  :message_type
+
+    delegate :[], :[]=, to: :data
+
+    def initialize(success: false,
+                   errors: nil,
+                   message: nil,
+                   message_type: nil,
+                   data: {})
+      self.success = success
+      self.data = (data.presence || {}).with_indifferent_access
+      self.errors = errors.is_a?(Enumerable) ? errors : [errors]
+      self.message = message
+      self.message_type = message_type
+    end
+
+    alias success? :success
+
+    def failure?
+      !success?
+    end
+
+    def on_success
+      yield(self) if success?
+      self
+    end
+
+    def on_failure
+      yield(self) if failure?
+      self
+    end
+
+    def get_message_type
+      if message_type.present?
+        message_type.to_sym
+      elsif success?
+        :notice
+      else
+        :error
+      end
+    end
+  end
+end

data/lib/tasks/mini_program_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :mini_program do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: mini_program
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- ian
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2021-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.4
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 登录授权，发送订阅消息
+email:
+- ianlynxk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/generators/mini_program/install/USAGE
+- lib/generators/mini_program/install/install_generator.rb
+- lib/generators/mini_program/install/templates/initializer.rb
+- lib/generators/mini_program/msg_config/USAGE
+- lib/generators/mini_program/msg_config/msg_config_generator.rb
+- lib/generators/mini_program/msg_config/templates/subscribe_msg.yml
+- lib/mini_program.rb
+- lib/mini_program/client.rb
+- lib/mini_program/msg.rb
+- lib/mini_program/railtie.rb
+- lib/mini_program/version.rb
+- lib/r_logger.rb
+- lib/service_result.rb
+- lib/tasks/mini_program_tasks.rake
+homepage: https://github.com/otorain
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/otorain
+  source_code_uri: https://github.com/otorain/mini_program
+  changelog_uri: https://github.com/otorain/mini_program/CHANGELOG.md
+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: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: 小程序api开发工具
+test_files: []