Class: Fastlane::Actions::HipchatAction

Inherits:
Fastlane::Action show all
Defined in:
lib/fastlane/actions/hipchat.rb

Class Method Summary collapse

Methods inherited from Fastlane::Action

action_name, authors, details, output, return_value, sh, step_text

Class Method Details

.author ⇒ Object 



155
156
157
 
# File 'lib/fastlane/actions/hipchat.rb', line 155

def self.author
  "jingx23"
end

.available_options ⇒ Object 



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
 
# File 'lib/fastlane/actions/hipchat.rb', line 92

def self.available_options
  [
    FastlaneCore::ConfigItem.new(key: :message,
                                 env_name: "FL_HIPCHAT_MESSAGE",
                                 description: "The message to post on HipChat",
                                 default_value: ''),
    FastlaneCore::ConfigItem.new(key: :channel,
                                 env_name: "FL_HIPCHAT_CHANNEL",
                                 description: "The room or @username"),
    FastlaneCore::ConfigItem.new(key: :api_token,
                                 env_name: "HIPCHAT_API_TOKEN",
                                 description: "Hipchat API Token",
                                 verify_block: proc do |value|
                                   unless value.to_s.length > 0
                                     Helper.log.fatal "Please add 'ENV[\"HIPCHAT_API_TOKEN\"] = \"your token\"' to your Fastfile's `before_all` section.".red
                                     raise 'No HIPCHAT_API_TOKEN given.'.red
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :success,
                                 env_name: "FL_HIPCHAT_SUCCESS",
                                 description: "Was this build successful? (true/false)",
                                 optional: true,
                                 default_value: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :version,
                                 env_name: "HIPCHAT_API_VERSION",
                                 description: "Version of the Hipchat API. Must be 1 or 2",
                                 verify_block: proc do |value|
                                   if value.nil? || ![1, 2].include?(value.to_i)
                                     Helper.log.fatal "Please add 'ENV[\"HIPCHAT_API_VERSION\"] = \"1 or 2\"' to your Fastfile's `before_all` section.".red
                                     raise 'No HIPCHAT_API_VERSION given.'.red
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :notify_room,
                                 env_name: "HIPCHAT_NOTIFY_ROOM",
                                 description: "Should the people in the room be notified? (true/false)",
                                 default_value: false,
                                 optional: true,
                                 is_string: false),
    FastlaneCore::ConfigItem.new(key: :api_host,
                                 env_name: "HIPCHAT_API_HOST",
                                 description: "The host of the HipChat-Server API",
                                 default_value: "api.hipchat.com",
                                 optional: true),
    FastlaneCore::ConfigItem.new(key: :message_format,
                                 env_name: "FL_HIPCHAT_MESSAGE_FORMAT",
                                 description: "Format of the message to post. Must be either 'html' or 'text'",
                                 default_value: "html",
                                 optional: true,
                                 verify_block: proc do |value|
                                   unless ["html", "text"].include?(value.to_s)
                                     Helper.log.fatal "Please specify the message format as either 'html' or 'text'.".red
                                     raise 'Unrecognized message_format.'.red
                                   end
                                 end),
    FastlaneCore::ConfigItem.new(key: :from,
                                 env_name: "FL_HIPCHAT_FROM",
                                 description: "Name the message will appear be sent from",
                                 default_value: "fastlane",
                                 optional: true)
  ]
end

.check_response_code(response, channel) ⇒ Object 



75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/fastlane/actions/hipchat.rb', line 75

def self.check_response_code(response, channel)
  case response.code.to_i
  when 200, 204
    true
  when 404
    raise "Channel `#{channel}` not found".red
  when 401
    raise "Access denied for channel `#{channel}`".red
  else
    raise "Unexpected #{response.code} for `#{channel}` with response: #{response.body}".red
  end
end

.description ⇒ Object 



88
89
90
 
# File 'lib/fastlane/actions/hipchat.rb', line 88

def self.description
  "Send a error/success message to HipChat"
end

.is_supported?(platform) ⇒ Boolean

Returns:

  • (Boolean) 


159
160
161
 
# File 'lib/fastlane/actions/hipchat.rb', line 159

def self.is_supported?(platform)
  true
end

.run(options) ⇒ Object 



7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/fastlane/actions/hipchat.rb', line 7

def self.run(options)
  require 'net/http'
  require 'uri'

  api_token = options[:api_token]
  api_version = options[:version]
  api_host = options[:api_host]

  message_format = options[:message_format]

  channel = options[:channel]
  color = (options[:success] ? 'green' : 'red')

  from = options[:from]

  message = options[:message]
  if message_format == "html"
    message = "<table><tr><td><img src='https://s3-eu-west-1.amazonaws.com/fastlane.tools/fastlane.png' width='50' height='50'></td><td>#{message[0..9999]}</td></tr></table>"
  end

  if api_version.to_i == 1
    ########## running on V1 ##########
    if user?(channel)
      raise 'HipChat private message not working with API V1 please use API V2 instead'.red
    else
      uri = URI.parse("https://#{api_host}/v1/rooms/message")
      response = Net::HTTP.post_form(uri, { 'from' => from,
                                            'auth_token' => api_token,
                                            'color' => color,
                                            'message_format' => message_format,
                                            'room_id' => channel,
                                            'message' => message,
                                            'notify' => options[:notify_room] ? '1' : '0' })

      check_response_code(response, channel)
    end
  else
    ########## running on V2 ##########
    if user?(channel)
      channel.slice!(0)
      params = { 'message' => message, 'message_format' => message_format }
      json_headers = { 'Content-Type' => 'application/json',
                       'Accept' => 'application/json', 'Authorization' => "Bearer #{api_token}" }

      uri = URI.parse("https://#{api_host}/v2/user/#{channel}/message")
      http = Net::HTTP.new(uri.host, uri.port)
      http.use_ssl = true

      response = http.post(uri.path, params.to_json, json_headers)
      check_response_code(response, channel)
    else
      uri = URI.parse("https://#{api_host}/v2/room/#{channel}/notification")
      response = Net::HTTP.post_form(uri, { 'from' => from,
                                            'auth_token' => api_token,
                                            'color' => color,
                                            'message_format' => message_format,
                                            'message' => message,
                                            'notify' => options[:notify_room] ? 'true' : 'false' })

      check_response_code(response, channel)
    end
  end
end

.user?(channel) ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/fastlane/actions/hipchat.rb', line 71

def self.user?(channel)
  channel.to_s.start_with?('@')
end