wmp_sdk 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b418c33be5371b2cf93a1de0a7e60ee5aac5d12bf90a0da3d4a1b9e6852e7686
+  data.tar.gz: c731c5799783ccb173d06da526572b25a452b3ecdb839f96442240259f188fff
+SHA512:
+  metadata.gz: ce973ad623941fe021d64a01c23d43a107f82ab7ea200bdef992ee08d76888bc7198ee363dddd4289223189c26328f335d2f58c5879e53b080bd645c47a6efe8
+  data.tar.gz: 136a665b62d9d3c753a2c019b4a86bb71e136317c2f38d7949360fe8dfc0094d8d996d6fbf57a459b25c4a1592bee8f1be6d74c4e1a1df4ee048baea1ba8b2c7

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.idea
+*.gem

data/.rakeTasks

@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<Settings><!--This file was automatically generated by Ruby plugin.
+You are allowed to: 
+1. Remove rake task
+2. Add existing rake tasks
+To add existing rake tasks automatically delete this file and reload the project.
+--><RakeGroup description="" fullCmd="" taksId="rake" /></Settings>

data/.rspec

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

data/.ruby-version

@@ -0,0 +1 @@
+2.5.8

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.8
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at vincent4502237@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,8 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in wmp_sdk.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"
+gem 'faraday', '~> 1.0', '>= 1.0.1'

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    wmp_sdk (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.0.1)
+      multipart-post (>= 1.2, < 3)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  faraday (~> 1.0, >= 1.0.1)
+  rake (~> 12.0)
+  rspec (~> 3.0)
+  wmp_sdk!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 JiangYongKang
+
+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,51 @@
+# WmpSdk
+
+适用于微信小程序服务端的快速开发SDK
+
+## 如何安装
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'wmp_sdk'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install wmp_sdk
+
+## Usage
+
+```ruby
+WmpSdk.configure do |config|
+  config.app_id            = ''
+  config.secret            = ''
+  config.miniprogram_state = ''
+  config.token             = ''
+  config.encoding_aes_key  = ''
+end
+WmpSdk::Api.invoke_access_token
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/wmp_sdk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/wmp_sdk/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the WmpSdk project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/wmp_sdk/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "wmp_sdk"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/wmp_sdk/api.rb

@@ -0,0 +1,95 @@
+require 'faraday'
+require 'json'
+require 'wmp_sdk/error'
+
+module WmpSdk
+  class Api
+
+    # 登录凭证校验。通过 wx.login 接口获得临时登录凭证 code 后传到开发者服务器调用此接口完成登录流程。
+    def self.invoke_auth_session(code)
+      response = Faraday.get('https://api.weixin.qq.com/sns/jscode2session', {
+          appid:      WmpSdk.configuration.app_id,
+          secret:     WmpSdk.configuration.secret,
+          js_code:    code,
+          grant_type: :authorization_code,
+      })
+      raise WmpServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    # 获取小程序全局唯一后台接口调用凭据（access_token）。调用绝大多数后台接口时都需使用 access_token，开发者需要进行妥善保存。
+    def self.invoke_access_token
+      response = Faraday.get('https://api.weixin.qq.com/cgi-bin/token', {
+          grant_type: :client_credential,
+          appid:      WmpSdk.configuration.app_id,
+          secret:     WmpSdk.configuration.secret,
+      })
+      raise WmpServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    # 下发小程序和公众号统一的服务消息
+    def self.invoke_uniform_message(access_token, openid, mp_template_msg, weapp_template_msg = nil)
+      response = Faraday.post('https://api.weixin.qq.com/cgi-bin/message/wxopen/template/uniform_send', { access_token: access_token }) do |request|
+        request_body = {
+            touser:          openid,
+            mp_template_msg: mp_template_msg,
+        }
+        request_body.merge!(weapp_template_msg: weapp_template_msg) if weapp_template_msg
+        request.body = request_body.to_json
+      end
+      raise WmpServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    # 发送订阅消息
+    def self.invoke_subscribe_message_send(access_token, openid, template_id, page, data, miniprogram_state = 'formal', lang = 'zh_CN')
+      response = Faraday.post('https://api.weixin.qq.com/cgi-bin/message/subscribe/send', { access_token: access_token }) do |request|
+        request.body = {
+            touser:            openid,
+            template_id:       template_id,
+            page:              page,
+            data:              data,
+            miniprogram_state: miniprogram_state,
+            lang:              lang,
+        }.to_json
+      end
+      raise WmpServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    # 把媒体文件上传到微信服务器。目前仅支持图片。用于发送客服消息或被动回复用户消息。
+    def self.invoke_upload_temp_media(access_token, file_name)
+      connection = Faraday.new('https://api.weixin.qq.com') do |conn|
+        conn.request :multipart
+        conn.request :url_encoded
+        conn.adapter :net_http
+      end
+      file       = Faraday::FilePart.new Rails.root.join(file_name).to_s, 'image/jpg'
+      response   = connection.post("/cgi-bin/media/upload?access_token=#{access_token}&type=image", { media: file })
+      raise WmpServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    # 发送客服消息给用户
+    def self.send_customer_service_message(access_token, openid, message_type, options = {})
+      response = Faraday.post('https://api.weixin.qq.com/cgi-bin/message/custom/send', { access_token: access_token }) do |request|
+        request.body = {
+            touser:  openid,
+            msgtype: message_type,
+        }.merge!(options).to_json
+      end
+      raise WmpServerError, "Response Status: #{response.status}" unless response.success?
+      JSON.parse(response.body, symbolize_names: true)
+    end
+
+    # 消息推送验证
+    def self.validate_customer_service_message(signature, timestamp, nonce)
+      Digest::SHA1.hexdigest(
+          [WmpSdk.configuration.token, timestamp, nonce].sort.join
+      ) == signature
+    end
+
+
+  end
+end

data/lib/wmp_sdk/configuration.rb

@@ -0,0 +1,5 @@
+module WmpSdk
+  class Configuration
+    attr_accessor :app_id, :secret, :miniprogram_state, :token, :encoding_aes_key
+  end
+end

data/lib/wmp_sdk/version.rb

@@ -0,0 +1,3 @@
+module WmpSdk
+  VERSION = '0.1.1'
+end

data/lib/wmp_sdk.rb

@@ -0,0 +1,20 @@
+require 'wmp_sdk/version'
+require 'wmp_sdk/api'
+require 'wmp_sdk/configuration'
+
+module WmpSdk
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield configuration
+    end
+  end
+
+
+end

data/wmp_sdk.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/wmp_sdk/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'wmp_sdk'
+  spec.version = WmpSdk::VERSION
+  spec.authors = ['JiangYongKang']
+  spec.email   = ['vincent4502237@gmail.com']
+
+  spec.summary               = 'wechat miniprogram sdk for ruby'
+  spec.description           = 'a ruby program to facilitate accessing wechat miniprogram'
+  spec.homepage              = 'https://github.com/JiangYongKang/wmp_sdk'
+  spec.license               = 'MIT'
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata['homepage_uri']    = spec.homepage
+  spec.metadata['source_code_uri'] = 'https://github.com/JiangYongKang/wmp_sdk'
+  spec.metadata['changelog_uri']   = 'https://github.com/JiangYongKang/wmp_sdk'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: wmp_sdk
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- JiangYongKang
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-09-14 00:00:00.000000000 Z
+dependencies: []
+description: a ruby program to facilitate accessing wechat miniprogram
+email:
+- vincent4502237@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rakeTasks"
+- ".rspec"
+- ".ruby-version"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/wmp_sdk.rb
+- lib/wmp_sdk/api.rb
+- lib/wmp_sdk/configuration.rb
+- lib/wmp_sdk/version.rb
+- wmp_sdk.gemspec
+homepage: https://github.com/JiangYongKang/wmp_sdk
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/JiangYongKang/wmp_sdk
+  source_code_uri: https://github.com/JiangYongKang/wmp_sdk
+  changelog_uri: https://github.com/JiangYongKang/wmp_sdk
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6.2
+signing_key: 
+specification_version: 4
+summary: wechat miniprogram sdk for ruby
+test_files: []