capistrano-dingtalk 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2e7395106c59bc7d87e3b8dd8460d5a758dd9ccf
+  data.tar.gz: 7bfc5f252e97152991c26fe79cfab99ff0e21a5b
+SHA512:
+  metadata.gz: 5145836e12ac43075d6b5499cfddfe0f45ec004984e0586d22575074bf79fe7ec0b95116fa32ac49e814052743c023d3de577d29f8de79acc0683aaaecefd8ff
+  data.tar.gz: 7d394b88541a8ba591e2a53ef7de4f86afacb51ac095c00a4bdd2590f20fde5c42de905efc9fb3bc680d7042a7800edfd0dd91c5179bfbaf8bf2c9be7993f146

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.14.6

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 atpking@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 [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 capistrano-dingtalk.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 atpking
+
+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 @@
+# Capistrano::Dingtalk
+
+send msg to ding talk webhook rebot when capistrano works.
+
+## Requirements
+
+- Capistrano >= 3.5.0
+- Ruby >= 2.0
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'capistrano-dingtalk'
+```
+
+Require the library in your application's Capfile:
+
+ ```ruby
+ require 'capistrano/dingtalk'
+ ```
+
+## configuration
+
+1. get dingtalk webhook url.
+2. add config to `config/deploy.rb` or the stages files.
+
+```ruby
+set :dingtalk_info, {
+  category: "text"  # option, selection:  text, markdown, default is text
+  url: 'https://oapi.dingtalk.com/robot/send?access_token=abcedf012345678' # change to your url
+  at_mobiles: [], # option
+  at_all: false # option
+}
+```
+
+if you have any question, contact me by Wechat (name: atpking).
+
+## Thanks
+
+Thanks to project `slackistrano` which could send msg to `slack.com`
+
+## 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]/capistrano-dingtalk. 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](http://opensource.org/licenses/MIT).

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 "capistrano/dingtalk"
+
+# 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/capistrano-dingtalk.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'capistrano/dingtalk/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "capistrano-dingtalk"
+  spec.version       = Capistrano::Dingtalk::VERSION
+  spec.authors       = ["atpking"]
+  spec.email         = ["atpking@gmail.com"]
+
+  spec.summary       = "ding talk capistrano plugin"
+  spec.description   = "ding talk capistrano plugin, sending message to ding talk custom webhook rebot"
+  spec.homepage      = "https://github.com/jicheng1014/capistrano-dingtalk"
+  spec.license       = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |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", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+
+  spec.add_dependency "capistrano", ">= 3.5.0"
+  spec.add_dependency "rest-client", ">= 2.0"
+end

data/lib/capistrano/dingtalk.rb

@@ -0,0 +1,50 @@
+require 'rest-client'
+require_relative "dingtalk/version"
+require_relative "dingtalk/messaging/base"
+require_relative "dingtalk/messaging/text"
+require_relative "dingtalk/messaging/markdown"
+require 'forwardable'
+
+load File.expand_path("../tasks/dingtalk.rake", __FILE__)
+
+module Capistrano
+  class Dingtalk
+    extend Forwardable
+    def_delegators :env, :fetch, :run_locally
+
+    attr_reader :message
+    def initialize(env)
+      @env = env
+      @config = fetch(:dingtalk_info, {})
+      # TODO: supports more message categories
+      klass = message_klass
+      @message = klass.new @config
+    end
+
+    def run(action)
+      local = self
+      run_locally do
+        info "begin to send action #{action} to Dingtalk"
+        json = local.message.build_msg_json(action)
+        local.send(:send_msg_to_ding_talk, json)
+      end
+    end
+
+    def send_msg_to_ding_talk(json)
+      url = @config[:url]
+      RestClient.post(url, json, content_type: :json, accept: :json)
+    end
+
+    def message_klass
+      category = @config[:category] || 'text'
+      klass = Object
+      case category
+      when 'text'
+        klass = ::Capistrano::Dingtalk::Messaging::Text
+      when 'markdown'
+        klass = ::Capistrano::Dingtalk::Messaging::Markdown
+      end
+      klass
+    end
+  end
+end

data/lib/capistrano/dingtalk/messaging/base.rb

@@ -0,0 +1,57 @@
+require 'forwardable'
+require 'json'
+require_relative 'helpers'
+
+module Capistrano::Dingtalk::Messaging
+  class Base
+    include Helpers
+    extend Forwardable
+    def_delegators :env, :fetch
+
+    def initialize(info)
+      @info = info || {}
+    end
+
+    def message_for_updating
+      "#{deployer} has started deploying branch #{branch} of #{application} to #{stage}"
+    end
+
+    def message_for_reverting
+      "#{deployer} has started rolling back branch #{branch} of #{application} to #{stage}"
+    end
+
+    def message_for_updated
+      "#{deployer} has finished deploying branch #{branch} of #{application} to #{stage}"
+    end
+
+    def message_for_reverted
+      "#{deployer} has finished rolling back branch of #{application} to #{stage}"
+    end
+
+    def message_for_failed
+      "#{deployer} has failed to #{deploying? ? 'deploy' : 'rollback'} branch #{branch} of #{application} to #{stage}"
+    end
+
+    ################################################################################
+
+    def message_for(action)
+      method = "message_for_#{action}"
+      respond_to?(method) && send(method)
+    end
+
+    def build_at_dict
+      at = {}
+      at["at"] = @info[:at_all]
+      at["atMobiles"] = @info[:at_mobiles]
+      at
+    end
+
+    def build_hash(action)
+      # implements on children
+    end
+
+    def build_msg_json(action)
+      build_hash(action).merge(build_at_dict).to_json
+    end
+  end
+end

data/lib/capistrano/dingtalk/messaging/helpers.rb

@@ -0,0 +1,32 @@
+module Capistrano::Dingtalk::Messaging
+  module Helpers
+    def username
+      'cap-dingtalk-bot'
+    end
+
+    def deployer
+      ENV['USER'] || ENV['USERNAME']
+    end
+
+    def branch
+      fetch(:branch)
+    end
+
+    def application
+      fetch(:application)
+    end
+
+    def stage(default = 'an unknown stage')
+      fetch(:stage, default)
+    end
+
+    #
+    # Return the elapsed running time as a string.
+    #
+    # Examples: 21-18:26:30, 15:28:37, 01:14
+    #
+    def elapsed_time
+      `ps -p #{$PROCESS_ID} -o etime=`.strip
+    end
+  end
+end

data/lib/capistrano/dingtalk/messaging/markdown.rb

@@ -0,0 +1,35 @@
+require_relative 'base'
+
+module Capistrano::Dingtalk::Messaging
+  class Markdown < Base
+    def initialize(info)
+      @info = info || {}
+    end
+
+    def markdown_load(action)
+      "
+      ### #{application}
+      action: #{action}
+      deployer: `#{deployer}`
+      branch: `#{branch}`
+      stage: `#{stage}`"
+    end
+
+    ################################################################################
+
+    def markdown(action)
+      method = "message_for_#{action}"
+      respond_to?(method) && send(method)
+    end
+
+    def build_hash(action)
+      {
+        msgtype: "markdown",
+        markdown: {
+          title: message_for(action),
+          text: markdown_load(action)
+        }
+      }
+    end
+  end
+end

data/lib/capistrano/dingtalk/messaging/text.rb

@@ -0,0 +1,14 @@
+require_relative 'base'
+
+module Capistrano::Dingtalk::Messaging
+  class Text < Base
+    def build_hash(action)
+      {
+        msgtype: "text",
+        text: {
+          content: message_for(action)
+        }
+      }
+    end
+  end
+end

data/lib/capistrano/dingtalk/version.rb

@@ -0,0 +1,5 @@
+module Capistrano
+  class Dingtalk
+    VERSION = "0.1.0".freeze
+  end
+end

data/lib/capistrano/tasks/dingtalk.rake

@@ -0,0 +1,39 @@
+namespace :dingtalk do
+  namespace :deploy do
+    desc 'Notify about updating deploy'
+    task :updating do
+      Capistrano::Dingtalk.new(self).run(:updating)
+    end
+
+    desc 'Notify about reverting deploy'
+    task :reverting do
+      Capistrano::Dingtalk.new(self).run(:reverting)
+    end
+
+    desc 'Notify about updated deploy'
+    task :updated do
+      Capistrano::Dingtalk.new(self).run(:updated)
+    end
+
+    desc 'Notify about reverted deploy'
+    task :reverted do
+      Capistrano::Dingtalk.new(self).run(:reverted)
+    end
+
+    desc 'Notify about failed deploy'
+    task :failed do
+      Capistrano::Dingtalk.new(self).run(:failed)
+    end
+
+    desc 'Test dingtalk integration'
+    task test: %i[updating updated reverting reverted failed] do
+      # all tasks run as dependencies
+    end
+  end
+end
+
+before 'deploy:updating',           'dingtalk:deploy:updating'
+before 'deploy:reverting',          'dingtalk:deploy:reverting'
+after  'deploy:finishing',          'dingtalk:deploy:updated'
+after  'deploy:finishing_rollback', 'dingtalk:deploy:reverted'
+after  'deploy:failed',             'dingtalk:deploy:failed'

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: capistrano-dingtalk
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- atpking
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: capistrano
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: ding talk capistrano plugin, sending message to ding talk custom webhook
+  rebot
+email:
+- atpking@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- capistrano-dingtalk.gemspec
+- lib/capistrano/dingtalk.rb
+- lib/capistrano/dingtalk/messaging/base.rb
+- lib/capistrano/dingtalk/messaging/helpers.rb
+- lib/capistrano/dingtalk/messaging/markdown.rb
+- lib/capistrano/dingtalk/messaging/text.rb
+- lib/capistrano/dingtalk/version.rb
+- lib/capistrano/tasks/dingtalk.rake
+homepage: https://github.com/jicheng1014/capistrano-dingtalk
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: ding talk capistrano plugin
+test_files: []