wechat_work_webhook 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +10 -0
- data/CODE_OF_CONDUCT.md +74 -0
- data/Gemfile +6 -0
- data/LICENSE.txt +21 -0
- data/README.md +65 -0
- data/Rakefile +2 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/lib/wechat_work_webhook.rb +79 -0
- data/wechat_work_webhook.gemspec +32 -0
- metadata +73 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: c2cd394e63470f88f97ba8746caaece7e60fd375059303276bd9a396af6aeca5
|
4
|
+
data.tar.gz: 35a6de5d0b8796e5c58f03021af7b4da40d6c7a2c1365cbda58851a92e5d174e
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 43e107cc5240e14d394ebe0468ef8cc90562ef164829b2512de30f432aa59da0aee34dd7b36f086c0c302947971934d822245f3f531c02614418de74a889c779
|
7
|
+
data.tar.gz: b67f3208d40c94c9cc6f77855b56cddf465c4d078ac9d05d072dcbd109de951c1396a53b51748b7b7ae4090d243bb04057d3dc08454d8bfce3db6b82a3257341
|
data/.gitignore
ADDED
data/CODE_OF_CONDUCT.md
ADDED
@@ -0,0 +1,74 @@
|
|
1
|
+
# Contributor Covenant Code of Conduct
|
2
|
+
|
3
|
+
## Our Pledge
|
4
|
+
|
5
|
+
In the interest of fostering an open and welcoming environment, we as
|
6
|
+
contributors and maintainers pledge to making participation in our project and
|
7
|
+
our community a harassment-free experience for everyone, regardless of age, body
|
8
|
+
size, disability, ethnicity, gender identity and expression, level of experience,
|
9
|
+
nationality, personal appearance, race, religion, or sexual identity and
|
10
|
+
orientation.
|
11
|
+
|
12
|
+
## Our Standards
|
13
|
+
|
14
|
+
Examples of behavior that contributes to creating a positive environment
|
15
|
+
include:
|
16
|
+
|
17
|
+
* Using welcoming and inclusive language
|
18
|
+
* Being respectful of differing viewpoints and experiences
|
19
|
+
* Gracefully accepting constructive criticism
|
20
|
+
* Focusing on what is best for the community
|
21
|
+
* Showing empathy towards other community members
|
22
|
+
|
23
|
+
Examples of unacceptable behavior by participants include:
|
24
|
+
|
25
|
+
* The use of sexualized language or imagery and unwelcome sexual attention or
|
26
|
+
advances
|
27
|
+
* Trolling, insulting/derogatory comments, and personal or political attacks
|
28
|
+
* Public or private harassment
|
29
|
+
* Publishing others' private information, such as a physical or electronic
|
30
|
+
address, without explicit permission
|
31
|
+
* Other conduct which could reasonably be considered inappropriate in a
|
32
|
+
professional setting
|
33
|
+
|
34
|
+
## Our Responsibilities
|
35
|
+
|
36
|
+
Project maintainers are responsible for clarifying the standards of acceptable
|
37
|
+
behavior and are expected to take appropriate and fair corrective action in
|
38
|
+
response to any instances of unacceptable behavior.
|
39
|
+
|
40
|
+
Project maintainers have the right and responsibility to remove, edit, or
|
41
|
+
reject comments, commits, code, wiki edits, issues, and other contributions
|
42
|
+
that are not aligned to this Code of Conduct, or to ban temporarily or
|
43
|
+
permanently any contributor for other behaviors that they deem inappropriate,
|
44
|
+
threatening, offensive, or harmful.
|
45
|
+
|
46
|
+
## Scope
|
47
|
+
|
48
|
+
This Code of Conduct applies both within project spaces and in public spaces
|
49
|
+
when an individual is representing the project or its community. Examples of
|
50
|
+
representing a project or community include using an official project e-mail
|
51
|
+
address, posting via an official social media account, or acting as an appointed
|
52
|
+
representative at an online or offline event. Representation of a project may be
|
53
|
+
further defined and clarified by project maintainers.
|
54
|
+
|
55
|
+
## Enforcement
|
56
|
+
|
57
|
+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
|
58
|
+
reported by contacting the project team at TODO: Write your email address. All
|
59
|
+
complaints will be reviewed and investigated and will result in a response that
|
60
|
+
is deemed necessary and appropriate to the circumstances. The project team is
|
61
|
+
obligated to maintain confidentiality with regard to the reporter of an incident.
|
62
|
+
Further details of specific enforcement policies may be posted separately.
|
63
|
+
|
64
|
+
Project maintainers who do not follow or enforce the Code of Conduct in good
|
65
|
+
faith may face temporary or permanent repercussions as determined by other
|
66
|
+
members of the project's leadership.
|
67
|
+
|
68
|
+
## Attribution
|
69
|
+
|
70
|
+
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
|
71
|
+
available at [https://contributor-covenant.org/version/1/4][version]
|
72
|
+
|
73
|
+
[homepage]: https://contributor-covenant.org
|
74
|
+
[version]: https://contributor-covenant.org/version/1/4/
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2020 TODO: Write your name
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,65 @@
|
|
1
|
+
# WechatWorkWebhook
|
2
|
+
|
3
|
+
企业微信群机器人Webhook Ruby 客户端. 支持文本消息, markdown, 图片, 图文, 文件 消息 ( https://work.weixin.qq.com/api/doc/90000/90136/91770 ).
|
4
|
+
|
5
|
+
A wechat work webhook Ruby client which support text, markdown, image, news, file message ( https://work.weixin.qq.com/api/doc/90000/90136/91770 ).
|
6
|
+
|
7
|
+
## Installation
|
8
|
+
|
9
|
+
Add this line to your application's Gemfile:
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
gem 'wechat_work_webhook'
|
13
|
+
```
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle install
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install wechat_work_webhook
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
```ruby
|
26
|
+
require 'wechat_work_webhook'
|
27
|
+
|
28
|
+
wechat = WechatWorkWebhook.new('WEBHOOK_URL')
|
29
|
+
|
30
|
+
wechat.text('test', ['@all'])
|
31
|
+
|
32
|
+
wechat.markdown('实时新增用户反馈<font color=\"warning\">132例</font>,请相关同事注意。')
|
33
|
+
|
34
|
+
wechat.news([{
|
35
|
+
"title" => "中秋节礼品领取",
|
36
|
+
"description" => "今年中秋节公司有豪礼相送",
|
37
|
+
"url" => "URL",
|
38
|
+
"picurl" => "http://res.mail.qq.com/node/ww/wwopenmng/images/independent/doc/test_pic_msg1.png"
|
39
|
+
}])
|
40
|
+
|
41
|
+
wechat.image('test.png')
|
42
|
+
|
43
|
+
wechat.media(wechat.upload_media('test.csv')['media_id'])
|
44
|
+
|
45
|
+
wechat.file('test.csv')
|
46
|
+
```
|
47
|
+
|
48
|
+
## Development
|
49
|
+
|
50
|
+
After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
|
51
|
+
|
52
|
+
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).
|
53
|
+
|
54
|
+
## Contributing
|
55
|
+
|
56
|
+
Bug reports and pull requests are welcome on GitHub at https://github.com/mqzhang/wechat_work_webhook_rb. 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/mqzhang/wechat_work_webhook_rb/blob/master/CODE_OF_CONDUCT.md).
|
57
|
+
|
58
|
+
|
59
|
+
## License
|
60
|
+
|
61
|
+
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
|
62
|
+
|
63
|
+
## Code of Conduct
|
64
|
+
|
65
|
+
Everyone interacting in the WechatWorkWebhook project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/mqzhang/wechat_work_webhook_rb/blob/master/CODE_OF_CONDUCT.md).
|
data/Rakefile
ADDED
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "wechat_work_webhook"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start(__FILE__)
|
data/bin/setup
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
# https://work.weixin.qq.com/api/doc/90000/90136/91770
|
2
|
+
require 'httparty'
|
3
|
+
require 'base64'
|
4
|
+
require 'digest/md5'
|
5
|
+
|
6
|
+
class WechatWorkWebhook
|
7
|
+
VERSION = "0.1.0"
|
8
|
+
class Error < StandardError; end
|
9
|
+
|
10
|
+
def initialize(webhook_url)
|
11
|
+
@webhook_url = webhook_url
|
12
|
+
end
|
13
|
+
|
14
|
+
def text(text, mentioned_list = [], mentioned_mobile_list = [])
|
15
|
+
data = {
|
16
|
+
"msgtype" => "text",
|
17
|
+
"text" => {
|
18
|
+
"content" => text,
|
19
|
+
"mentioned_list" => mentioned_list,
|
20
|
+
"mentioned_mobile_list" => mentioned_mobile_list
|
21
|
+
}
|
22
|
+
}
|
23
|
+
HTTParty.post(@webhook_url, body: data.to_json).parsed_response
|
24
|
+
end
|
25
|
+
|
26
|
+
def markdown(markdown)
|
27
|
+
data = {
|
28
|
+
"msgtype" => "markdown",
|
29
|
+
"markdown" => {
|
30
|
+
"content" => markdown
|
31
|
+
}
|
32
|
+
}
|
33
|
+
HTTParty.post(@webhook_url, body: data.to_json).parsed_response
|
34
|
+
end
|
35
|
+
|
36
|
+
def news(articles)
|
37
|
+
data = {
|
38
|
+
"msgtype" => "news",
|
39
|
+
"news" => {
|
40
|
+
"articles" => articles
|
41
|
+
}
|
42
|
+
}
|
43
|
+
HTTParty.post(@webhook_url, body: data.to_json).parsed_response
|
44
|
+
end
|
45
|
+
|
46
|
+
def image(image_path)
|
47
|
+
image_base64 = Base64.strict_encode64(File.read(image_path))
|
48
|
+
image_md5 = Digest::MD5.hexdigest(File.read(image_path))
|
49
|
+
|
50
|
+
data = {
|
51
|
+
"msgtype": "image",
|
52
|
+
"image": {
|
53
|
+
"base64": image_base64,
|
54
|
+
"md5": image_md5
|
55
|
+
}
|
56
|
+
}
|
57
|
+
HTTParty.post(@webhook_url, body: data.to_json).parsed_response
|
58
|
+
end
|
59
|
+
|
60
|
+
def media(media_id)
|
61
|
+
data = {
|
62
|
+
"msgtype" => "file",
|
63
|
+
"file" => {
|
64
|
+
"media_id" => media_id
|
65
|
+
}
|
66
|
+
}
|
67
|
+
HTTParty.post(@webhook_url, body: data.to_json).parsed_response
|
68
|
+
end
|
69
|
+
|
70
|
+
def upload_media(file_path)
|
71
|
+
upload_url = @webhook_url.sub('send', 'upload_media') + '&type=file'
|
72
|
+
HTTParty.post(upload_url, body: { media: File.open(file_path)}).parsed_response
|
73
|
+
end
|
74
|
+
|
75
|
+
def file(file_path)
|
76
|
+
media_id = upload_media(file_path)['media_id']
|
77
|
+
media(media_id)
|
78
|
+
end
|
79
|
+
end
|
@@ -0,0 +1,32 @@
|
|
1
|
+
require_relative 'lib/wechat_work_webhook.rb'
|
2
|
+
|
3
|
+
Gem::Specification.new do |spec|
|
4
|
+
spec.name = "wechat_work_webhook"
|
5
|
+
spec.version = WechatWorkWebhook::VERSION
|
6
|
+
spec.authors = ["mqzhang"]
|
7
|
+
spec.email = ["zmingqian@qq.com"]
|
8
|
+
|
9
|
+
spec.summary = %q{企业微信群机器人Webhook Ruby 客户端. A wechat work webhook Ruby client.}
|
10
|
+
spec.description = %q{企业微信群机器人Webhook Ruby 客户端. 支持文本消息, markdown, 图片, 图文, 文件 消息 ( https://work.weixin.qq.com/api/doc/90000/90136/91770 ). A wechat work webhook Ruby client which support text, markdown, image, news, file message ( https://work.weixin.qq.com/api/doc/90000/90136/91770 ).}
|
11
|
+
spec.homepage = "https://github.com/mqzhang/wechat_work_webhook_rb"
|
12
|
+
spec.license = "MIT"
|
13
|
+
|
14
|
+
spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
|
15
|
+
|
16
|
+
spec.metadata["allowed_push_host"] = "https://rubygems.org/"
|
17
|
+
|
18
|
+
spec.metadata["homepage_uri"] = spec.homepage
|
19
|
+
spec.metadata["source_code_uri"] = "https://github.com/mqzhang/wechat_work_webhook_rb"
|
20
|
+
spec.metadata["changelog_uri"] = "https://github.com/mqzhang/wechat_work_webhook_rb"
|
21
|
+
|
22
|
+
# Specify which files should be added to the gem when it is released.
|
23
|
+
# The `git ls-files -z` loads the files in the RubyGem that have been added into git.
|
24
|
+
spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
|
25
|
+
`git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
|
26
|
+
end
|
27
|
+
spec.bindir = "exe"
|
28
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
29
|
+
spec.require_paths = ["lib"]
|
30
|
+
|
31
|
+
spec.add_dependency('httparty')
|
32
|
+
end
|
metadata
ADDED
@@ -0,0 +1,73 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: wechat_work_webhook
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- mqzhang
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-08-02 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: httparty
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
description: 企业微信群机器人Webhook Ruby 客户端. 支持文本消息, markdown, 图片, 图文, 文件 消息 ( https://work.weixin.qq.com/api/doc/90000/90136/91770
|
28
|
+
). A wechat work webhook Ruby client which support text, markdown, image, news,
|
29
|
+
file message ( https://work.weixin.qq.com/api/doc/90000/90136/91770 ).
|
30
|
+
email:
|
31
|
+
- zmingqian@qq.com
|
32
|
+
executables: []
|
33
|
+
extensions: []
|
34
|
+
extra_rdoc_files: []
|
35
|
+
files:
|
36
|
+
- ".gitignore"
|
37
|
+
- CODE_OF_CONDUCT.md
|
38
|
+
- Gemfile
|
39
|
+
- LICENSE.txt
|
40
|
+
- README.md
|
41
|
+
- Rakefile
|
42
|
+
- bin/console
|
43
|
+
- bin/setup
|
44
|
+
- lib/wechat_work_webhook.rb
|
45
|
+
- wechat_work_webhook.gemspec
|
46
|
+
homepage: https://github.com/mqzhang/wechat_work_webhook_rb
|
47
|
+
licenses:
|
48
|
+
- MIT
|
49
|
+
metadata:
|
50
|
+
allowed_push_host: https://rubygems.org/
|
51
|
+
homepage_uri: https://github.com/mqzhang/wechat_work_webhook_rb
|
52
|
+
source_code_uri: https://github.com/mqzhang/wechat_work_webhook_rb
|
53
|
+
changelog_uri: https://github.com/mqzhang/wechat_work_webhook_rb
|
54
|
+
post_install_message:
|
55
|
+
rdoc_options: []
|
56
|
+
require_paths:
|
57
|
+
- lib
|
58
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
59
|
+
requirements:
|
60
|
+
- - ">="
|
61
|
+
- !ruby/object:Gem::Version
|
62
|
+
version: 2.3.0
|
63
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - ">="
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '0'
|
68
|
+
requirements: []
|
69
|
+
rubygems_version: 3.1.3
|
70
|
+
signing_key:
|
71
|
+
specification_version: 4
|
72
|
+
summary: 企业微信群机器人Webhook Ruby 客户端. A wechat work webhook Ruby client.
|
73
|
+
test_files: []
|