ci-notify 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 837ab6195028f94fe1050adc690c806e5f625a62
+  data.tar.gz: 95ce881d376a9ba73e86ca96f0507f5bd4898fe0
+SHA512:
+  metadata.gz: bf8ccc6dbb60c1623f81354793a6141a162e3e6ae0c5e986d25fe284546555b34504aeef8d637ca0fa398550528a994f76e86dbeed228063d660881d50b00a6f
+  data.tar.gz: 709a1d267a039d4e0e6bb96b750272abdf74afaf7b88ddfc6ff16887cdb43b2cee246fd4b47a62719b69a66ff54956989979938d5c5ba00a25b3a089a6178917

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-gemset

@@ -0,0 +1 @@
+ci-notify

data/.ruby-version

@@ -0,0 +1 @@
+2.3.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,47 @@
+# ci-notify
+
+With the advent of Jenkinsfile and the pipeline, I ran into the problem that
+IRC-notifications were not supported (yet). Since I wanted to migrate to the
+new way, I created a little script to provide me those notifications.
+
+Before long, I wanted to share this between projects. You won't guess what
+happened next...
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ci-notify'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ci-notify
+
+## Usage
+
+```bash
+IRC_CHANNEL="foo" DRY_RUN=true ci-notify SUCCESS
+```
+
+## 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.
+

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 "ci/notify"
+
+# 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

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/ci-notify.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ci/notify/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ci-notify"
+  spec.version       = Ci::Notify::VERSION
+  spec.authors       = ["Matthias Viehweger"]
+  spec.email         = ["kronn@kronn.de"]
+
+  spec.summary       = %q{Send a short notification from Jenkins to IRC}
+  spec.description   = %q{With the new Jenkinsfile-approach, I wanted a small script to send notifications to IRC. Since most of the information comes from env-vars supplied by Jenkins, this is a very generic script. Packaging this a gem enables proper dependency management.}
+  spec.homepage      = "https://git.lanpartei.de/kronn/ci-notify"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "shout-bot"
+  spec.add_dependency "string-irc"
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/exe/ci-notify

@@ -0,0 +1,88 @@
+#!/usr/bin/env ruby
+
+# require "ci/notify"
+
+@dry_run    = ENV["DRY_RUN"] || false
+@branch     = ENV["BRANCH_NAME"]
+@build_url  = ENV["BUILD_URL"]
+@result     = ARGV[0]
+
+@job_name   = ENV["JOB_NAME"] || "CI-job"
+@job_number = ENV["BUILD_NUMBER"]
+@bot_name   = %w[ Jenkline Pipekins ].sample
+
+unless @dry_run
+  @irc_server = ENV["IRC_SERVER"] || "chat.freenode.net"
+  @irc_port   = ENV["IRC_PORT"] || 6667
+  @irc_channel= ENV.fetch("IRC_CHANNEL")
+end
+
+@job_name = @job_name.split("/")[0] if @branch && @job_name.gsub("%2F", "/").include?(@branch)
+
+@local_echo = Object.new
+def @local_echo.say(message)
+  puts "IRC: " + message
+end
+
+def irc
+  if @dry_run
+    yield @local_echo
+  else
+    begin
+      require "shout-bot"
+      ShoutBot.new(@irc_server, @irc_port, @bot_name) do |irc|
+        irc.channel = @irc_channel
+        yield irc
+      end
+    rescue Errno::ENETUNREACH => e
+      yield @local_echo
+
+      $stderr.puts "Error: #{e.class}"
+      $stderr.puts "       #{e.message}"
+    end
+  end
+end
+
+# only really needed in dry-run
+module BoldString
+  refine String do
+    def bold
+      self
+    end
+  end
+end
+using BoldString
+
+def color(string, color)
+  return string if @dry_run
+
+  require "string-irc"
+  StringIrc.new(string).send(color)
+end
+
+irc do |channel|
+  branch_info = "for #{color(@branch, :purple)}" if @branch
+  job_info    = "##{@job_number}" if @job_number
+  build_url   = "(#{@build_url})" if @build_url
+
+  if @result && @result != "null"
+    result_color = case @result
+                   when "SUCCESS"  then :green
+                   when "UNSTABLE" then :yellow
+                   when "FAILURE"  then :red
+                   else                 :white
+                   end
+    result_info = "with #{color(@result, result_color).bold}"
+  end
+
+  message = [
+    @job_name,
+    job_info,
+    "completed",
+    branch_info,
+    result_info,
+    build_url,
+  ].compact.join(" ")
+
+  channel.say message
+end

data/lib/ci/notify.rb

@@ -0,0 +1,7 @@
+require "ci/notify/version"
+
+module Ci
+  module Notify
+    # Your code goes here...
+  end
+end

data/lib/ci/notify/version.rb

@@ -0,0 +1,5 @@
+module Ci
+  module Notify
+    VERSION = "0.1.0"
+  end
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ci-notify
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Matthias Viehweger
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: shout-bot
+  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: string-irc
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: With the new Jenkinsfile-approach, I wanted a small script to send notifications
+  to IRC. Since most of the information comes from env-vars supplied by Jenkins, this
+  is a very generic script. Packaging this a gem enables proper dependency management.
+email:
+- kronn@kronn.de
+executables:
+- ci-notify
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ci-notify.gemspec
+- exe/ci-notify
+- lib/ci/notify.rb
+- lib/ci/notify/version.rb
+homepage: https://git.lanpartei.de/kronn/ci-notify
+licenses: []
+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.4
+signing_key: 
+specification_version: 4
+summary: Send a short notification from Jenkins to IRC
+test_files: []