samson_hipchat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b607259d6768010582ed642548e566eb14e56766
+  data.tar.gz: d5bd36c6105fdf7379f37ff33307af64df16ddfc
+SHA512:
+  metadata.gz: 268a569dfad68045f253bb8228b6d17ed90f76d774770402bef2d4cc1a9e81f3cdb06e2a6043d6bdc1b8e77fe7c2e51c8809d5e8bc05f1abff53e39f19556747
+  data.tar.gz: ddd08358daca564d06cea498c532aeea93ef3d61edd8e8d478cdb1a8b28b7e759be19bce58cdf290f04f7545b1d3cf99108a63014dc81cbf9abdf0b6c1bfb88b

data/app/decorators/stage_decorator.rb

@@ -0,0 +1,50 @@
+Stage.class_eval do
+
+  cattr_reader(:hipchat_rooms_cache_key) { 'hipchat-rooms-list' }
+
+  has_many :hipchat_rooms
+  accepts_nested_attributes_for :hipchat_rooms, allow_destroy: true, reject_if: :no_room_name?
+  validate :room_exists?
+  before_save :update_room_id
+
+  def send_hipchat_notifications?
+    hipchat_rooms.any?
+  end
+
+  def room_name
+    hipchat_rooms.first.try(:name)
+  end
+
+  def no_room_name?(hipchat_attrs)
+    hipchat_attrs['name'].blank?
+  end
+
+  def update_room_id
+    if room_for(room_name)
+      self.hipchat_rooms.first.room_id = room_for(room_name)['id']
+    end
+  end
+
+  def room_exists?
+    if room_name
+      errors.add(:hipchat_rooms_name, "was not found. Create the room first.") unless room_for(room_name)
+    end
+  end
+
+  def hipchat
+    client = HipChat::Client.new(hipchat_rooms.first.try(:token), :api_version => 'v2')
+    client
+  end
+
+  def room_for(name)
+    return nil unless name
+
+    Rails.cache.fetch(hipchat_rooms_cache_key, expires_in: 5.minutes) do
+      begin
+        hipchat[name].get_room
+      rescue HipChat::UnknownRoom
+        nil
+      end
+    end
+  end
+end

data/app/models/hipchat_notification.rb

@@ -0,0 +1,82 @@
+class HipchatNotification
+
+  def initialize(deploy)
+    @deploy = deploy
+    @stage = deploy.stage
+  end
+
+  def deliver
+    message = Message.new(@deploy)
+    begin
+      hipchat[@stage.hipchat_rooms.first.name].send message.from, message.to_s, **message.style
+    rescue HipChat::UnknownRoom => e
+      Rails.logger.error("Room did not existed")
+    rescue HipChat::Unauthorized => e
+      Rails.logger.error("Invalid token to post to room")
+    rescue HipChat::UnknownResponseCode => e
+      Rails.logger.error("Could not deliver hipchat message: #{e.message}")
+    end
+  end
+
+  class Message
+    delegate :project, :stage, :user, to: :@deploy
+    delegate :project_deploy_url, to: 'AppRoutes.url_helpers'
+
+    def initialize(deploy)
+      @deploy = deploy
+      @stage = deploy.stage
+      @project = @stage.project
+      @user = @deploy.user
+      @changeset = @deploy.changeset
+    end
+
+    def style
+      {:color => color}
+    end
+
+    def from
+      "Deploy"
+    end
+
+    def subject
+      subject = "#{@user.name} is about to <a href='#{deploy_url}'>deploy</a> <strong>#{@project.name}</strong> on <strong>#{@stage.name}</strong><br>"
+
+      subject = "#{@user.name} successfully deploy <strong>#{@project.name}</strong> @<a href='#{diff_url}'>#{@deploy.commit}...#{@changeset.try(:previous_commit)}</a> on <strong>#{@stage.name}</strong><br>" if @deploy.job.succeeded?
+
+      subject = "#{@user.name} failed to <a href='#{deploy_url}'>deploy</a> <strong>#{@project.name}</strong> on <strong>#{@stage.name}</strong><br>" if @deploy.job.failed? || @deploy.job.errored?
+
+      subject
+    end
+
+    def to_s
+      content
+    end
+
+    def content
+      return subject if @deploy.job.succeeded? || @deploy.job.failed? || @deploy.job.errored?
+      @content ||= HipchatNotificationRenderer.render(@deploy, subject)
+    end
+
+    private
+
+    def color
+      return 'green' if @deploy.job.succeeded?
+      return 'red' if @deploy.job.failed? || @deploy.job.errored?
+      'yellow'
+    end
+
+    def diff_url
+      @changeset.github_url
+    end
+
+    def deploy_url
+      project_deploy_url(@deploy.project, @deploy)
+    end
+  end
+
+  private
+
+  def hipchat
+    HipChat::Client.new @stage.hipchat_rooms.first.token, api_version: 'v2'
+  end
+end

data/app/models/hipchat_notification_renderer.rb

@@ -0,0 +1,8 @@
+class HipchatNotificationRenderer
+  def self.render(deploy, subject)
+    controller = ActionController::Base.new
+    view = ActionView::Base.new(File.expand_path("../../views/samson_hipchat", __FILE__), {}, controller)
+    locals = { deploy: deploy, changeset: deploy.changeset, subject: subject }
+    view.render(template: 'notification', locals: locals).chomp
+  end
+end

data/app/models/hipchat_room.rb

@@ -0,0 +1,3 @@
+class HipchatRoom < ActiveRecord::Base
+  belongs_to :stage
+end

data/app/views/samson_hipchat/_fields.html.erb

@@ -0,0 +1,25 @@
+<fieldset>
+  <legend>Hipchat</legend>
+  <p class="col-lg-offset-2">Hipchat room and token.</p>
+
+  <% stage = form.object %>
+  <% stage.hipchat_rooms.build if stage.hipchat_rooms.last.try(:name).blank? %>
+
+  <%= form.fields_for :hipchat_rooms do |hipchat_fields| %>
+    <div class="form-group">
+      <div class="col-lg-2 col-lg-offset-2">
+        <%= hipchat_fields.text_field :name, class: "form-control", placeholder: "Room name" %>
+      </div>
+      <div class="col-lg-4">
+        <%= hipchat_fields.text_field :token, class: "form-control", placeholder: "Token" %>
+      </div>
+
+      <% if hipchat_fields.object.persisted? %>
+        <div class="col-lg-1 checkbox">
+          <%= hipchat_fields.check_box :_destroy if hipchat_fields.object.persisted? %>
+          <%= hipchat_fields.label :_destroy, "Delete" %>
+        </div>
+      <% end %>
+    </div>
+  <% end %>
+</fieldset>

data/app/views/samson_hipchat/notification.text.erb

@@ -0,0 +1,19 @@
+<%= subject %>
+<% if changeset.commits.count == 0 %>
+There are no new commits since last time.
+<% else %>
+<%= pluralize changeset.commits.count, "commit" %> by <%= changeset.author_names.to_sentence %>.
+<br>
+<strong>Files changed:</strong>
+<ul>
+<% changeset.files.each do |file| %>
+  <li><%= file.status[0].upcase %> <%= file.filename %></li>
+<% end %>
+</ul>
+<strong>Commits:</strong>
+<ol>
+<% changeset.commits.each do |commit| %>
+  <li><a href='<%= commit.url %>'>(<%= commit.author_name %>)</a>: <%= commit.summary %></li>
+<% end %>
+</ol>
+<% end %>

data/config/initializers/hipchat.rb

@@ -0,0 +1 @@
+require 'hipchat'

data/db/migrate/20150519105221_create_hipchat_rooms.rb

@@ -0,0 +1,15 @@
+class CreateHipchatRooms < ActiveRecord::Migration
+  def change
+    create_table :hipchat_rooms do |t|
+      t.string :name, null: false
+      t.string :token, null: false
+      t.string :room_id, null: false
+      t.integer :stage_id, null: false
+
+      t.timestamps
+    end
+
+    add_index :hipchat_rooms, :stage_id
+
+  end
+end

data/lib/samson_hipchat/samson_plugin.rb

@@ -0,0 +1,22 @@
+module SamsonHipchat
+  class Engine < Rails::Engine
+  end
+end
+Samson::Hooks.view :stage_form, "samson_hipchat/fields"
+
+Samson::Hooks.callback :stage_clone do |old_stage, new_stage|
+  new_stage.hipchat_rooms.build(old_stage.hipchat_rooms.map(&:attributes))
+end
+
+Samson::Hooks.callback :stage_permitted_params do
+  { hipchat_rooms_attributes: [:id, :name, :token, :_destroy] }
+end
+
+notify = -> (deploy, _buddy) do
+  if deploy.stage.send_hipchat_notifications?
+    HipchatNotification.new(deploy).deliver
+  end
+end
+
+Samson::Hooks.callback :before_deploy, &notify
+Samson::Hooks.callback :after_deploy, &notify

data/samson_hipchat.gemspec

@@ -0,0 +1,7 @@
+Gem::Specification.new "samson_hipchat", "0.0.1" do |s|
+  s.summary = "Samson hipchat integration"
+  s.authors = ["Vinh Nguyen"]
+  s.email = "vinh@listia.com"
+  s.add_runtime_dependency "hipchat", "~> 1.5"
+  s.files = `git ls-files`.split("\n")
+end

data/test/models/hipchat_notification_renderer_test.rb

@@ -0,0 +1,42 @@
+require_relative '../test_helper'
+
+describe HipchatNotificationRenderer do
+  describe "starting" do
+    it "renders a nicely formatted notification" do
+      changeset = stub("changeset")
+      deploy = stub("deploy", short_reference: "xyz", changeset: changeset)
+
+      author1 = "author1"
+      author2 = "author2"
+      changeset.stubs(:author_names).returns([author1, author2])
+
+      commit1 = stub("commit1", url: "#", author_name: "author1", summary: "Introduce bug")
+      commit2 = stub("commit2", url: "#", author_name: "author2", summary: "Fix bug")
+      changeset.stubs(:commits).returns([commit1, commit2])
+
+      file1 = stub("file1", status: "added", filename: "foo.rb")
+      file2 = stub("file2", status: "modified", filename: "bar.rb")
+      changeset.stubs(:files).returns([file1, file2])
+
+      subject = "Deploy starting"
+
+      result = HipchatNotificationRenderer.render(deploy, subject)
+
+      result.must_equal <<-RESULT.strip_heredoc.chomp
+  Deploy starting
+  2 commits by author1 and author2.
+  <br>
+  <strong>Files changed:</strong>
+  <ul>
+    <li>A foo.rb</li>
+    <li>M bar.rb</li>
+  </ul>
+  <strong>Commits:</strong>
+  <ol>
+    <li><a href='#'>(author1)</a>: Introduce bug</li>
+    <li><a href='#'>(author2)</a>: Fix bug</li>
+  <ol>
+      RESULT
+    end
+  end
+end

data/test/models/hipchat_notification_test.rb

@@ -0,0 +1,47 @@
+require_relative '../test_helper'
+
+describe HipchatNotification do
+  let(:project) { stub(name: "Glitter") }
+  let(:user) { stub(name: "John Wu", email: "wu@rocks.com") }
+  let(:stage) { stub(name: "staging", hipchat_rooms: [stub(name: "x123yx", token: "token123")], project: project) }
+  let(:hipchat_message) { stub(content: "hello world!", style: {color: :red}, subject: "subject") }
+  let(:previous_deploy) { stub(summary: "hello world!", user: user, stage: stage) }
+  let(:deploy) { stub(summary: "hello world!", user: user, stage: stage, changeset: "changeset") }
+  let(:notification) { HipchatNotification.new(deploy) }
+  let(:endpoint) { "https://api.hipchat.com/v2/room/x123yx/notification?auth_token=token123" }
+
+  before do
+    HipchatNotificationRenderer.stubs(:render).returns("foo")
+    HipchatNotification::Message.any_instance.stubs(:content).returns("message to send")
+    HipchatNotification::Message.any_instance.stubs(:from).returns("Deployer")
+    HipchatNotification::Message.any_instance.stubs(:style).returns({color: :red})
+  end
+
+  it "notifies hipchat channels configured for the stage" do
+    delivery = stub_request(:post, endpoint)
+    notification.deliver
+
+    assert_requested delivery
+  end
+
+  it "renders a nicely formatted notification" do
+    stub_request(:post, endpoint)
+    HipchatNotificationRenderer.stubs(:render).returns("bar")
+    notification.deliver
+
+    content, format, from, color = nil
+    assert_requested :post, endpoint do |request|
+      body = JSON.parse(request.body)
+      puts body["message"]
+      content = body.fetch("message")
+      format  = body.fetch("message_format")
+      from  = body.fetch("from")
+      color  = body.fetch("color")
+      content.must_equal "message to send"
+      format.must_equal "html"
+      from.must_equal "Deployer"
+      color.must_equal "red"
+    end
+  end
+
+end

data/test/models/hooks_test.rb

@@ -0,0 +1,32 @@
+require_relative '../test_helper'
+
+describe "hipchat hooks" do
+  let(:deploy) { deploys(:succeeded_test) }
+  let(:stage) { deploy.stage }
+
+  describe :before_deploy do
+    it "sends notification on before hook" do
+      stage.stubs(:send_hipchat_notifications?).returns(true)
+      HipchatNotification.any_instance.expects(:deliver)
+      Samson::Hooks.fire(:before_deploy, deploy, nil)
+    end
+
+    it "does not send notifications when disabled" do
+      HipchatNotification.any_instance.expects(:deliver).never
+      Samson::Hooks.fire(:before_deploy, deploy, nil)
+    end
+  end
+
+  describe :after_deploy do
+    it "sends notification on after hook" do
+      stage.stubs(:send_hipchat_notifications?).returns(true)
+      HipchatNotification.any_instance.expects(:deliver)
+      Samson::Hooks.fire(:after_deploy, deploy, nil)
+    end
+
+    it "does not send notifications when disabled" do
+      HipchatNotification.any_instance.expects(:deliver).never
+      Samson::Hooks.fire(:after_deploy, deploy, nil)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+require_relative '../../../test/test_helper'

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: samson_hipchat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Vinh Nguyen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hipchat
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+description: 
+email: vinh@listia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/decorators/stage_decorator.rb
+- app/models/hipchat_notification.rb
+- app/models/hipchat_notification_renderer.rb
+- app/models/hipchat_room.rb
+- app/views/samson_hipchat/_fields.html.erb
+- app/views/samson_hipchat/notification.text.erb
+- config/initializers/hipchat.rb
+- db/migrate/20150519105221_create_hipchat_rooms.rb
+- lib/samson_hipchat/samson_plugin.rb
+- samson_hipchat.gemspec
+- test/models/hipchat_notification_renderer_test.rb
+- test/models/hipchat_notification_test.rb
+- test/models/hooks_test.rb
+- test/test_helper.rb
+homepage: 
+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.4.7
+signing_key: 
+specification_version: 4
+summary: Samson hipchat integration
+test_files: []