qywechat-notifier 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 68563940ee548620b221f26b8aa537982418cf062a6271ed8cacccb06ba73f07
+  data.tar.gz: '024985d77aa5efe3a0d93e5a831662f0bcd08bad00dbf5d2981c7e9d0e9dbfb1'
+SHA512:
+  metadata.gz: 3a13d0b05f11967f791a2aa013a7324871d0884e8d49cd3a1b230cdd89d7fbae6ec8f5e65f57fe91fc47462ed392b835cde7d35b79bc6ca50f259f1fde77a6be
+  data.tar.gz: fab808dd730c420445c5f96243fbd6e8575f944a265cd43ec9ee1c57100383b963e2e587329c476b6c03148a8c2725c9b8d0361bdd201fbbfa702ebf81613c69

data/.gitignore

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

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 chen1125he@163.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 [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in qywechat-notifier.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    qywechat-notifier (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  qywechat-notifier!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 yunyi
+
+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,106 @@
+# Qywechat::Notifier
+
+为你的 Rails 应用添加企业微信异常监控。
+
+## Installation
+
+Add this line to your Rails application's Gemfile:
+
+```ruby
+gem 'qywechat-notifier', github: 'dao42/qywechat-notifier'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+### 创建群聊会话
+
+系统提供了 Rake 命令，帮助快速创建一个会话
+
+```bash
+$ rails create_groupchat
+```
+
+请按照引导创建群聊，创建成功后系统会发送一条消息，初始至少需要一位群主和一位群员。后续可手动去企业微信APP中添加其他成员。
+
+记录好 CHATID。
+
+### 配置
+
+创建配置文件，并修改配置项。
+
+```ruby
+# config/initializers/qywechat_notifier.rb
+Qywechat::Notifier.configure do |config|
+  config.corpid = 'yourcorpid'
+  config.corpsecret = 'yourcorpsecret'
+  config.chatid = 'yourchatid'
+end
+```
+
+各参数配置的含义:
+
+CORPID: 参见[说明](https://work.weixin.qq.com/api/doc#90000/90135/90665)
+
+CORPSECRET: 参见[说明](https://work.weixin.qq.com/api/doc#90000/90135/90665)
+
+CHATID: 上面用 Rake 命令创建的群聊ID，参见[说明](https://work.weixin.qq.com/api/doc#90000/90135/90245)
+
+### 配置 exception_notification，启用插件
+
+```ruby
+# config/initializers/exception_notification.rb
+require 'exception_notification/rails'
+require 'exception_notification/sidekiq'
+
+ExceptionNotification.configure do |config|
+  ...
+  ...
+  config.add_notifier :qy_wechat, {}
+end
+```
+
+### 完成
+
+到此，所有 Rails 应用异常都可以发送到群聊之中了。
+
+## 定制异常内容
+
+额外异常内容，可写入 `request.env['exception_notifier.exception_data']` 中，如：
+
+```ruby
+# app/controllers/application_controller.rb
+class ApplicationController < ActionController::Base
+
+  # 增加以下内容
+  before_action :prepare_exception_notifier
+
+  private
+  def prepare_exception_notifier
+    request.env['exception_notifier.exception_data'] = {
+      current_user: current_user&.id
+    }
+  end
+end
+```
+
+## Development
+
+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.
+
+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]/qywechat-notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Qywechat::Notifier project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/qywechat-notifier/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "qywechat/notifier"
+
+# 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/exception_notifier/qy_wechat_notifier.rb

@@ -0,0 +1,50 @@
+require 'qywechat/notifier'
+
+module ExceptionNotifier
+  class QyWechatNotifier < BaseNotifier
+    def initialize(options)
+      super
+    end
+
+    def call(exception, options={})
+      env = options[:env]
+
+      if env.present?
+        # 这里是外部请求导致的异常
+        request = ActionDispatch::Request.new(env)
+        request_items = {
+          url: request.original_url,
+          http_method: request.method,
+          ip_address: request.remote_ip,
+          parameters: request.filtered_parameters,
+          timestamp: Time.current.strftime('%Y-%m-%d %H:%M:%S')
+        }
+
+        message = <<-EOF
+Exception>>> #{exception.class.to_s}: #{exception.message.inspect}
+URL>>> #{request_items[:http_method]}: #{request_items[:url]}( from: #{request_items[:ip_address]} )
+PARAM>>> #{request_items[:parameters]}
+Agent>>> #{request.filtered_env['HTTP_USER_AGENT']}
+Data>>> #{env && env['exception_notifier.exception_data']}
+------------
+Backtrace( 5 below )>>>\n
+#{exception.backtrace[0..4].join("\n")}
+        EOF
+
+        Qywechat::Notifier::QyAPI.api_message.send_groupchat(message)
+      else
+        # 内部异常, 例如 sidekiq 任务
+        message = <<-EOF
+Exception>>> #{exception.class.to_s}: #{exception.message.inspect}
+OPTIONS>>> \n
+#{options.to_yaml}
+------------
+Backtrace( 5 below )>>>\n
+#{exception.backtrace[0..4].join("\n")}
+        EOF
+
+        Qywechat::Notifier::QyAPI.api_message.send_groupchat(message)
+      end
+    end
+  end
+end

data/lib/qywechat/notifier/qy_api/api/message.rb

@@ -0,0 +1,20 @@
+module Qywechat::Notifier::QyAPI
+  module API
+    class Message
+      attr_reader :client
+
+      def initialize
+        @client = Client.new
+      end
+
+      def send_groupchat(message)
+        client.post('/cgi-bin/appchat/send', params: { access_token: Qywechat::Notifier::QyAPI.api_token.get_access_token }, json: {
+          chatid: Qywechat::Notifier::QyAPI.chatid,
+          msgtype: 'text',
+          text: { content: message },
+          safe: 0
+        })
+      end
+    end
+  end
+end

data/lib/qywechat/notifier/qy_api/api/token.rb

@@ -0,0 +1,24 @@
+module Qywechat::Notifier::QyAPI
+  module API
+    class Token
+      attr_reader :client
+
+      def initialize
+        @client = Client.new
+      end
+
+      def get_access_token
+        Rails.cache.fetch('exception_notifier::qy_wechat_notifier', expires_in: 6800.seconds) do
+          refresh_access_token
+        end
+      end
+
+      private
+
+      def refresh_access_token
+        res = client.get('/cgi-bin/gettoken', params: { corpid: Qywechat::Notifier::QyAPI.corpid, corpsecret: Qywechat::Notifier::QyAPI.corpsecret })
+        res["access_token"]
+      end
+    end
+  end
+end

data/lib/qywechat/notifier/qy_api/client.rb

@@ -0,0 +1,110 @@
+module Qywechat
+  module Notifier
+    module QyAPI
+      class Client
+        SERVER_SCHEME = 'https'.freeze
+        SERVER_HOST = 'qyapi.weixin.qq.com'.freeze
+
+        def get(path, options = {})
+          request(:get, path, options)
+        end
+
+        def post(path, options = {})
+          request(:post, path, options)
+        end
+
+        private
+
+        def request(verb, path, options = {})
+          uri = uri_for(path)
+          options = options.with_indifferent_access
+
+          options['headers'] ||= {}
+          if options['headers']['Content-Type'].blank?
+            options['headers']['Content-Type'] = 'application/json'
+          end
+
+          begin
+            response = HTTP.request(verb, uri, options)
+          rescue HTTP::Error => ex
+            raise Errors::HttpError, ex.message
+          end
+
+          unless response.status.success?
+            raise Errors::APIError.new(nil, response.to_s)
+          end
+
+          parse_response(response) do |parse_as, result|
+            case parse_as
+            when :json
+              break result if result[:errcode].blank? || result[:errcode].zero?
+              raise Errors::APIError.new(result[:errcode], result[:errmsg])
+            else
+              result
+            end
+          end
+        end
+
+        def uri_for(path)
+          uri_options = {
+            scheme: SERVER_SCHEME,
+            host: SERVER_HOST,
+            path: path
+          }
+          Addressable::URI.new(uri_options)
+        end
+
+        def parse_response(response)
+          content_type = response.headers[:content_type]
+          parse_as = {
+            %r{^application\/json} => :json,
+            %r{^image\/.*} => :file,
+            %r{^text\/html} => :xml,
+            %r{^text\/plain} => :plain
+          }.each_with_object([]) { |match, memo| memo << match[1] if content_type =~ match[0] }.first || :plain
+
+          if parse_as == :plain
+            result = ActiveSupport::JSON.decode(response.body.to_s).with_indifferent_access rescue nil
+            if result
+              return yield(:json, result)
+            else
+              return yield(:plain, response.body)
+            end
+          end
+
+          case parse_as
+          when :json
+            result = ActiveSupport::JSON.decode(response.body.to_s).with_indifferent_access
+          when :file
+            if %r{^image\/.*}.match?(response.headers[:content_type])
+              extension =
+                case response.headers['content-type']
+                when 'image/gif'  then '.gif'
+                when 'image/jpeg' then '.jpg'
+                when 'image/png'  then '.png'
+                end
+            else
+              extension = ''
+            end
+
+            begin
+              file = Tempfile.new(['wxapi-file-', extension])
+              file.binmode
+              file.write(response.body)
+            ensure
+              file&.close
+            end
+
+            result = file
+          when :xml
+            result = Hash.from_xml(response.body.to_s)
+          else
+            result = response.body
+          end
+
+          yield(parse_as, result)
+        end
+      end
+    end
+  end
+end

data/lib/qywechat/notifier/qy_api/errors.rb

@@ -0,0 +1,21 @@
+module Qywechat::Notifier::QyAPI
+  module Errors
+    # 通用异常
+    Error = Class.new(StandardError)
+
+    # HTTP 异常，比如请求超时等
+    HttpError = Class.new(Error)
+
+    # API 异常，比如返回失败状态码
+    class APIError < Error
+      attr_reader :errcode, :errmsg
+
+      def initialize(errcode, errmsg)
+        @errcode = errcode
+        @errmsg = errmsg
+
+        super(format('[%s]: %s', @errcode, @errmsg))
+      end
+    end
+  end
+end

data/lib/qywechat/notifier/qy_api.rb

@@ -0,0 +1,20 @@
+require 'qywechat/notifier/qy_api/client'
+require 'qywechat/notifier/qy_api/errors'
+require 'qywechat/notifier/qy_api/api/message'
+require 'qywechat/notifier/qy_api/api/token'
+
+module Qywechat
+  module Notifier
+    module QyAPI
+      def self.api_token
+        @api_token ||= QyAPI::API::Token.new
+      end
+
+      def self.api_message
+        @api_message ||= QyAPI::API::Message.new
+      end
+
+      mattr_accessor :corpid, :chatid, :corpsecret
+    end
+  end
+end

data/lib/qywechat/notifier/version.rb

@@ -0,0 +1,5 @@
+module Qywechat
+  module Notifier
+    VERSION = "0.1.0"
+  end
+end

data/lib/qywechat/notifier.rb

@@ -0,0 +1,12 @@
+require 'qywechat/notifier/qy_api'
+require "qywechat/notifier/version"
+
+module Qywechat
+  module Notifier
+    def self.configure
+      yield Qywechat::Notifier::QyAPI
+    end
+
+    class Error < StandardError; end
+  end
+end

data/lib/qywechat/railtie.rb

@@ -0,0 +1,5 @@
+class Qywechat::Railtie < Rails::Railtie
+  rake_tasks do
+    load 'tasks/create_groupchat.rake'
+  end
+end

data/lib/qywechat-notifier.rb

@@ -0,0 +1,3 @@
+require 'qywechat/notifier'
+require 'exception_notifier/qy_wechat_notifier'
+require 'qywechat/railtie'

data/lib/tasks/create_groupchat.rake

@@ -0,0 +1,24 @@
+require 'qywechat/notifier'
+
+task create_groupchat: :environment do
+  raise '请先填写群 ID' unless Qywechat::Notifier::QyAPI.chatid.present?
+  puts('请输入群聊名:')
+  name = STDIN.gets().gsub(/\r\n|\n/, '')
+  raise '群聊名不能为空' unless name.present?
+  puts('请输入群主名:')
+  owner = STDIN.gets().gsub(/\r\n|\n/, '')
+  raise '群主名不能为空' unless owner.present?
+  puts('请输入一个群员名(额外的群员可在新创建的群内直接添加):')
+  username = STDIN.gets().gsub(/\r\n|\n/, '')
+  raise '群员名不能为空' unless username.present?
+  userlist = [owner, username]
+
+  client = Qywechat::Notifier::QyAPI::Client.new
+  client.post('/cgi-bin/appchat/create', params: { access_token: Qywechat::Notifier::QyAPI.api_token.get_access_token }, json: {
+    chatid: Qywechat::Notifier::QyAPI.chatid,
+    name: name,
+    owner: owner,
+    userlist: userlist
+  })
+  Qywechat::Notifier::QyAPI.api_message.send_groupchat('create groupchat ok')
+end

data/qywechat-notifier.gemspec

@@ -0,0 +1,27 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "qywechat/notifier/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "qywechat-notifier"
+  spec.version       = Qywechat::Notifier::VERSION
+  spec.authors       = ["yunyi"]
+  spec.email         = ["chen1125he@163.com"]
+
+  spec.summary       = %q{qywechat exception notifier}
+  spec.homepage      = "https://github.com/80percent/qywechat-notifier"
+  spec.license       = "MIT"
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: qywechat-notifier
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- yunyi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 
+email:
+- chen1125he@163.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/exception_notifier/qy_wechat_notifier.rb
+- lib/qywechat-notifier.rb
+- lib/qywechat/notifier.rb
+- lib/qywechat/notifier/qy_api.rb
+- lib/qywechat/notifier/qy_api/api/message.rb
+- lib/qywechat/notifier/qy_api/api/token.rb
+- lib/qywechat/notifier/qy_api/client.rb
+- lib/qywechat/notifier/qy_api/errors.rb
+- lib/qywechat/notifier/version.rb
+- lib/qywechat/railtie.rb
+- lib/tasks/create_groupchat.rake
+- qywechat-notifier.gemspec
+homepage: https://github.com/80percent/qywechat-notifier
+licenses:
+- MIT
+metadata: {}
+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.0.3
+signing_key: 
+specification_version: 4
+summary: qywechat exception notifier
+test_files: []