cookpad · eagletmt · Oct 6, 2023
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,4 +1,6 @@
 ## lastest(master branch)
+- Drop HipChat notifier
+
 ## v0.8.0
 - Upgrade Rails to v7.0
 - Support Ruby 3.2

diff --git a/app/controllers/kuroko2/api/job_definitions_controller.rb b/app/controllers/kuroko2/api/job_definitions_controller.rb
@@ -56,7 +56,6 @@ def definition_params(params)
       :description,
       :script,
       :notify_cancellation,
-      :hipchat_room,
       :hipchat_notify_finished,
       :suspended,
       :prevent_multi,

diff --git a/app/controllers/kuroko2/job_definitions_controller.rb b/app/controllers/kuroko2/job_definitions_controller.rb
@@ -91,7 +91,7 @@ def admin_id_params
   end
 
   def definition_params
-    params.require(:job_definition).permit(:name, :description, :script, :notify_cancellation, :hipchat_room, :hipchat_notify_finished, :suspended, :prevent_multi, :prevent_multi_on_failure, :hipchat_additional_text, :text_tags, :api_allowed, :slack_channel, :webhook_url)
+    params.require(:job_definition).permit(:name, :description, :script, :notify_cancellation, :hipchat_notify_finished, :suspended, :prevent_multi, :prevent_multi_on_failure, :hipchat_additional_text, :text_tags, :api_allowed, :slack_channel, :webhook_url)
   end
 
   def query_params

diff --git a/app/models/kuroko2/job_definition.rb b/app/models/kuroko2/job_definition.rb
@@ -1,6 +1,9 @@
 class Kuroko2::JobDefinition < Kuroko2::ApplicationRecord
   include Kuroko2::TableNameCustomizable
 
+  # TODO: Drop column in the next release
+  self.ignored_columns += %i[hipchat_room]
+
   module PreventMultiStatus
     NONE = 0
     WORKING_OR_ERROR = 1

diff --git a/app/views/kuroko2/job_definitions/_form.html.slim b/app/views/kuroko2/job_definitions/_form.html.slim
@@ -23,9 +23,6 @@
         ' Allow API execution of this job
 
     label Notification
-    .form-group
-      label Hipchat Room Name
-      = form.text_field :hipchat_room, class: 'form-control', placeholder: 'Hipchat Room name'
     .form-group
       label Slack Channel
       = form.text_field :slack_channel, class: 'form-control', placeholder: '#slack-channel'
@@ -36,7 +33,7 @@
     .checkbox
       label
         = form.check_box :hipchat_notify_finished
-        ' Notify all event to Slack/Hipchat/Webhook
+        ' Notify all event to Slack/Webhook
 
     .checkbox
       label

diff --git a/app/views/kuroko2/job_definitions/show.html.slim b/app/views/kuroko2/job_definitions/show.html.slim
@@ -43,30 +43,28 @@
         h3 Options
         h4 Notification
         ul
-          - if @definition.hipchat_room.present? || @definition.slack_channel.present?
+          - if @definition.slack_channel.present?
             - if @definition.hipchat_notify_finished?
               li
-                'Notify all event to Slack/Hipchat/Webhook
+                'Notify all event to Slack/Webhook
                 ul
                   li webhook url: #{@definition.webhook_url}
-                  li hipchat room: #{@definition.hipchat_room}
                   li slack channel: #{@definition.slack_channel}
                   - if @definition.hipchat_additional_text
                     li Failure notification text: #{@definition.hipchat_additional_text}
             - else
               li
-                'Notify failure event to Slack/Hipchat/Webhook
+                'Notify failure event to Slack/Webhook
                 ul
                   li webhook url: #{@definition.webhook_url}
-                  li hipchat room: #{@definition.hipchat_room}
                   li slack channel: #{@definition.slack_channel}
                   - if @definition.hipchat_additional_text
                     li Failure notification text: #{@definition.hipchat_additional_text}
 
           - if @definition.notify_cancellation
             li Notify administrators when the job is cancelled by system.
 
-          - if !@definition.hipchat_room.present? && !@definition.slack_channel && [email protected]_cancellation
+          - if [email protected]_channel && [email protected]_cancellation
             li None
 
         h4 Next Job Execution

diff --git a/app_template.rb b/app_template.rb
@@ -28,11 +28,6 @@
       mail_to: "[email protected]"
     slack:
       webhook_url: 'https://localhost/test/slack'
-    hipchat:
-      api_token: 'token'
-      options:
-#        api_version: 'v2'
-#        server_url: 'https://api.example.com'
     webhook:
       secret_token: '<%= ENV["WEBHOOK_SECRET_TOKEN"] %>'
   api_basic_authentication_applications:

diff --git a/docs/user_guide.md b/docs/user_guide.md
@@ -12,7 +12,7 @@
 - Name ... The name of the job.
 - Description ... A description of the job.
 - Script ... Definition of a workflow, will be explained later.
-- Slack channel / Hipchat room ... A chat room to send a message.
+- Slack channel ... A chat room to send a message.
 - Next Job Execution ... Check if you want to prevent multiple instances of same jobs.
 
 ![](images/kuroko2_job_form.png)
@@ -92,16 +92,15 @@ Kuroko2 notifies job statuses by below methods.
 
 - Mail
 - Slack
-- Hipchat
 - Webhook
 
 ### Notifications Frequency Options
 
 You can configurable notifications frequency.
 
-#### Notify all event to Slack/Hipchat/Webhook
+#### Notify all event to Slack/Webhook
 
-If you enable this option, Kuroko2 notifies all events by Slack/Hipchat/Webhook (except Email) that jobs state is changed,
+If you enable this option, Kuroko2 notifies all events by Slack/Webhook (except Email) that jobs state is changed,
 Events is below.
 
 - The job is launched

diff --git a/kuroko2.gemspec b/kuroko2.gemspec
@@ -45,8 +45,6 @@ Gem::Specification.new do |s|
   s.add_dependency 'rinku'
   s.add_dependency 'visjs-rails'
 
-  s.add_dependency 'hipchat', '~> 1.3.0'
-
   s.add_dependency 'the_garage'
   s.add_dependency 'weak_parameters'
 

diff --git a/lib/autoload/kuroko2/workflow/notifier/hipchat.rb b/lib/autoload/kuroko2/workflow/notifier/hipchat.rb
diff --git a/lib/kuroko2.rb b/lib/kuroko2.rb
@@ -4,7 +4,6 @@
 require 'retryable'
 require 'faraday'
 require 'html/pipeline'
-require 'hipchat'
 require 'omniauth-google-oauth2'
 require 'omniauth/rails_csrf_protection'
 

diff --git a/spec/dummy/config/kuroko2.yml b/spec/dummy/config/kuroko2.yml
@@ -13,9 +13,6 @@ default: &default
       mail_to: "[email protected]"
     slack:
       webhook_url: 'https://localhost/test/slack'
-    hipchat:
-      api_token: 'token'
-      options:
     webhook:
       secret_token: 'secret_token'
   api_basic_authentication_applications:

diff --git a/spec/requests/api/job_definitions_spec.rb b/spec/requests/api/job_definitions_spec.rb
@@ -76,7 +76,6 @@
           description: "description",
           script: "noop:",
           notify_cancellation: 1,
-          hipchat_room: "",
           hipchat_notify_finished: 1,
           suspended: false,
           prevent_multi: 1,
@@ -108,7 +107,6 @@
           description: "description",
           script: "noop:",
           notify_cancellation: 1,
-          hipchat_room: "",
           hipchat_notify_finished: 1,
           suspended: false,
           prevent_multi: 1,
@@ -232,7 +230,6 @@
           description: "description",
           script: "noop:",
           notify_cancellation: 1,
-          hipchat_room: "",
           hipchat_notify_finished: 1,
           suspended: false,
           prevent_multi: 1,
@@ -286,7 +283,6 @@
           description: "description",
           script: "echo: Hello",
           notify_cancellation: 1,
-          hipchat_room: "",
           hipchat_notify_finished: 1,
           suspended: false,
           prevent_multi: 1,
@@ -310,7 +306,6 @@
           description: "description",
           script: "echo: Hello",
           notify_cancellation: 1,
-          hipchat_room: "",
           hipchat_notify_finished: 1,
           suspended: false,
           prevent_multi: 1,
@@ -340,7 +335,6 @@
           description: "description",
           script: "noop",
           notify_cancellation: 1,
-          hipchat_room: "",
           hipchat_notify_finished: 1,
           suspended: false,
           prevent_multi: 1,
@@ -364,7 +358,6 @@
           description: "description",
           script: "echo: Hello",
           notify_cancellation: 1,
-          hipchat_room: "",
           hipchat_notify_finished: 1,
           suspended: false,
           prevent_multi: 1,