buildkite-ding 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 704d8ccdd7cdea341d1c67dda5a4d371ef805516
+  data.tar.gz: 8f422b3b6dd28b88ef12879f8cb26287db535380
+SHA512:
+  metadata.gz: c80d45408703bf8a8a91bd6f2494c9f7bd1581ddb54995240bf1d5a2c372358bf8b9d4d33c473af9e754bb8b12457872c99671aa3f5efcfa02be50b133811339
+  data.tar.gz: a248fc7ffbc85f3a1aeea06b58e908262352691886363eca4fe0d40e30e0a553f1a597f65ee4b3bc011eadc8d5624288e48dbfd077c4c75068f56d05f3dd7d7f

data/bin/buildkite-ding

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+require 'buildkite-ding'
+require 'daemons'
+
+BuildkiteDing.load_config
+
+Daemons.run_proc('buildkite-ding') do
+  BuildkiteDing.run_client
+end

data/lib/buildkite_ding.rb

@@ -0,0 +1,103 @@
+require 'ptools' # Used to find appropriate play command
+# require 'win32-file' # Required for File.which on Windows
+require 'buildkit'
+require 'json'
+require 'date'
+
+CONFIG_PATH = "#{ENV['HOME']}/.bkdingrc".freeze
+DATA_PATH = File.join(File.dirname(File.expand_path(__FILE__)), '../data')
+
+BUILD_EVENTS = {
+  'running' => {
+    'action' => 'ding once!',
+    'sound' => 'w_1'
+  },
+  'passed' => {
+    'action' => 'ding twice!!',
+    'sound' => 'w_2'
+  },
+  'failed' => {
+    'action' => 'lots of dings!!!!!',
+    'sound' => 'w_many'
+  }
+}.freeze
+
+# Goes 'ding' when your builds fail. or pass. or start.
+#
+# To run without daemon/binary:
+# BuildkiteDing.run
+#
+class BuildkiteDing
+  def self.run # Alternative to starting with the bin
+    BuildkiteDing.load_config
+    BuildkiteDing.run_client
+  end
+
+  def self.load_config
+    if File.exist?(CONFIG_PATH)
+      @config = JSON.parse(File.read(CONFIG_PATH), symbolize_names: true)
+      puts "Loaded configuration from #{CONFIG_PATH}"
+    else
+      BuildkiteDing.generate_config
+    end
+  end
+
+  def self.generate_config
+    @config = {}
+    puts "No .bkdingrc file detected in #{CONFIG_PATH}
+          Please provide a Buildkite API access token with read_builds scope:
+          ( Generate at https://buildkite.com/user/api-access-tokens/new )"
+    @config[:buildkite_api_token] = STDIN.gets.chomp
+    File.open(CONFIG_PATH, 'w') do |f|
+      f.write(JSON.pretty_generate(@config))
+    end
+  end
+
+  def self.run_client
+    @client = Buildkit.new(token: @config[:buildkite_api_token])
+    @tracked_builds = {} # Simple hash tracking build id and state
+    @last_check = Time.now.utc
+    loop do
+      puts 'Checking builds...'
+      BuildkiteDing.check_builds
+      @last_check = Time.now.utc
+      sleep(5)
+    end
+  end
+
+  def self.check_builds
+    new_builds = @client.builds(created_from: @last_check.iso8601) +
+                 @client.builds(finished_from: @last_check.iso8601)
+    new_builds.each do |b|
+      if @tracked_builds.key?(b['id']) && @tracked_builds[b['id']] == b['state']
+        next
+      end
+      BuildkiteDing.interogate_build(b)
+    end
+  end
+
+  def self.interogate_build(build)
+    puts "Build is new or updated: #{build['message']}"
+    @tracked_builds[build['id']] = build['state']
+    return unless BUILD_EVENTS.key? build['state']
+    print "Build #{build['state']} - "
+    BuildkiteDing.take_action(BUILD_EVENTS[build['state']])
+  end
+
+  def self.take_action(action)
+    puts action['action']
+    BuildkiteDing.play_sound(action['sound'])
+  end
+
+  def self.play_sound(sound) # Sound name standard is class_numberofdings
+    puts 'Finding play command...'
+    if File.which('afplay') # Included in MacOS
+      puts 'Found afplay (this is probably MacOS)'
+      puts "Playing #{DATA_PATH}/#{sound}.mp3"
+      system "afplay #{DATA_PATH}/#{sound}.mp3"
+    elsif File.which('play') # Sox package?
+      puts 'Found play (this is presumably Linux)'
+      system "play #{DATA_PATH}/#{sound}.mp3"
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: buildkite-ding
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Effy Elden
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-11-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: daemons
+  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: ptools
+  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: buildkit
+  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'
+description: |-
+  Ultra simple audible alerts for Buildkite build events,
+                       inspired by the ambiance of Melbourne
+email: dev@effy.is
+executables:
+- buildkite-ding
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/buildkite-ding
+- data/w_1.mp3
+- data/w_2.mp3
+- data/w_many.mp3
+- lib/buildkite_ding.rb
+homepage: https://github.com/ineffyble/buildkite-ding
+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.4.8
+signing_key: 
+specification_version: 4
+summary: Simple audible alerts for Buildkite build events
+test_files: []