Class: Appsignal::CLI::Install

Inherits:
Object
  • Object
show all
Defined in:
lib/appsignal/cli/install.rb

Constant Summary collapse

EXCLUDED_ENVIRONMENTS = 
['test'].freeze

Class Method Summary collapse

Class Method Details

.colorize(text, color) ⇒ Object 



149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/appsignal/cli/install.rb', line 149

def colorize(text, color)
  return text if Gem.win_platform?
  color_code = case color
               when :red then 31
               when :green then 32
               when :yellow then 33
               when :blue then 34
               when :pink then 35
               else 0
               end
 "\e[#{color_code}m#{text}\e[0m"
end

.configure(config, environments, name_overwritten) ⇒ Object 



199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/appsignal/cli/install.rb', line 199

def configure(config, environments, name_overwritten)
  install_for_capistrano

  puts "How do you want to configure AppSignal?"
  puts "  (1) a config file"
  puts "  (2) environment variables"
  loop do
    print "  Choose (1/2): "
    input = gets.chomp
    if input == '1'
      puts
      print "Writing config file"
      periods
      puts
      puts colorize "  Config file written to config/appsignal.yml", :green
      write_config_file(
        :push_api_key => config[:push_api_key],
        :app_name => config[:name],
        :environments => environments
      )
      puts
      break
    elsif input == '2'
      puts
      puts "Add the following environment variables to configure AppSignal:"
      puts "  export APPSIGNAL_ACTIVE=true"
      puts "  export APPSIGNAL_PUSH_API_KEY=#{config[:push_api_key]}"
      if name_overwritten
        puts "  export APPSIGNAL_APP_NAME=#{config[:name]}"
      end
      puts
      puts "  See the documentation for more configuration options:"
      puts "  http://docs.appsignal.com/gem-settings/configuration.html"
      press_any_key
      break
    end
  end
end

.done_notice ⇒ Object 



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/appsignal/cli/install.rb', line 238

def done_notice
  sleep 0.3
  puts colorize "#####################################", :green
  puts colorize "## AppSignal installation complete ##", :green
  puts colorize "#####################################", :green
  sleep 0.3
  puts
  puts '  Now you need to send us some data...'
  puts
  if Gem.win_platform?
    puts 'The AppSignal agent currently does not work on Windows, please push these changes to your test/staging/production environment'
  else
    puts "  Run your app with AppSignal activated:"
    puts "  - You can do this on your dev environment"
    puts "  - Or deploy to staging or production"
    puts
    puts "  Test if AppSignal is receiving data:"
    puts "  - Requests > 200ms are shown in AppSignal"
    puts "  - Generate an error to test (e.g. add .xml to a url)"
    puts
    puts "Please return to your browser and follow the instructions."
  end
end

.install_for_capistrano ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
 
# File 'lib/appsignal/cli/install.rb', line 134

def install_for_capistrano
  capfile = File.join(Dir.pwd, 'Capfile')
  return unless File.exist?(capfile)
  return if File.read(capfile) =~ %r{require ['|"]appsignal/capistrano}

  puts 'Installing for Capistrano'
  print '  Adding AppSignal integration to Capfile'
  File.open(capfile, 'a') do |f|
    f.write "\nrequire 'appsignal/capistrano'\n"
  end
  periods
  puts
  puts
end

.install_for_grape(config) ⇒ Object 



119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/appsignal/cli/install.rb', line 119

def install_for_grape(config)
  puts 'Installing for Grape'

  config[:name] = required_input('  Enter application name: ')
  puts

  configure(config, ['development', 'production', 'staging'], true)

  puts "Manual Grape configuration needed"
  puts "  See the installation instructions here:"
  puts "  http://docs.appsignal.com/getting-started/supported-frameworks.html#grape"
  press_any_key
  done_notice
end

.install_for_padrino(config) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'lib/appsignal/cli/install.rb', line 99

def install_for_padrino(config)
  puts 'Installing for Padrino'

  config[:name] = required_input('  Enter application name: ')
  puts

  configure(config, ['development', 'production', 'staging'], true)

  puts "Finish Padrino installation"
  puts "  Padrino requires some manual configuration."
  puts "  After installing the gem, add the following line to /config/boot.rb:"
  puts
  puts "  require 'appsignal/integrations/padrino"
  puts
  puts "  You can find more information in the documentation:"
  puts "  http://docs.appsignal.com/getting-started/supported-frameworks.html#padrino"
  press_any_key
  done_notice
end

.install_for_rails(config) ⇒ Object 



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/appsignal/cli/install.rb', line 66

def install_for_rails(config)
  require File.expand_path(File.join(Dir.pwd, 'config/application.rb'))

  puts 'Installing for Ruby on Rails'

  config[:name] = Rails.application.class.parent_name

  name_overwritten = yes_or_no("  Your app's name is: '#{config[:name]}' \n  Do you want to change how this is displayed in AppSignal? (y/n): ")
  puts
  if name_overwritten
    config[:name] = required_input("  Choose app's display name: ")
    puts
  end

  configure(config, rails_environments, name_overwritten)
  done_notice
end

.install_for_sinatra(config) ⇒ Object 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/appsignal/cli/install.rb', line 84

def install_for_sinatra(config)
  puts 'Installing for Sinatra'
  config[:name] = required_input('  Enter application name: ')
  puts
  configure(config, ['development', 'production', 'staging'], true)

  puts "Finish Sinatra configuration"
  puts "  Sinatra requires some manual configuration."
  puts "  Add this line beneath require 'sinatra':"
  puts
  puts "  require 'appsignal/integrations/sinatra'"
  press_any_key
  done_notice
end

.installed_frameworks ⇒ Object 



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/appsignal/cli/install.rb', line 262

def installed_frameworks
  [].tap do |out|
    begin
      require 'rails'
      out << :rails
    rescue LoadError
    end
    begin
      require 'sinatra'
      out << :sinatra
    rescue LoadError
    end
    begin
      require 'padrino'
      out << :padrino
    rescue LoadError
    end
    begin
      require 'grape'
      out << :grape
    rescue LoadError
    end
  end
end

.periods ⇒ Object 



162
163
164
165
166
167
 
# File 'lib/appsignal/cli/install.rb', line 162

def periods
  3.times do
    print "."
    sleep(0.5)
  end
end

.press_any_key ⇒ Object 



169
170
171
172
173
174
175
 
# File 'lib/appsignal/cli/install.rb', line 169

def press_any_key
  puts
  print "  Ready? Press any key:"
  STDIN.getch
  puts
  puts
end

.rails_environments ⇒ Object 



287
288
289
290
291
 
# File 'lib/appsignal/cli/install.rb', line 287

def rails_environments
  @environments ||= Dir.glob(
    File.join(Dir.pwd, 'config/environments/*.rb')
  ).map { |o| File.basename(o, ".rb") }.sort - EXCLUDED_ENVIRONMENTS
end

.required_input(prompt) ⇒ Object 



189
190
191
192
193
194
195
196
197
 
# File 'lib/appsignal/cli/install.rb', line 189

def required_input(prompt)
  loop do
    print prompt
    input = gets.chomp
    if input.length > 0
      return input
    end
  end
end

.run(push_api_key, config) ⇒ Object 



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
 
# File 'lib/appsignal/cli/install.rb', line 11

def run(push_api_key, config)
  puts
  puts colorize "#######################################", :green
  puts colorize "## Starting AppSignal Installer      ##", :green
  puts colorize "## --------------------------------- ##", :green
  puts colorize "## Need help?  [email protected] ##", :green
  puts colorize "## Docs?       docs.appsignal.com    ##", :green
  puts colorize "#######################################", :green
  puts
  unless push_api_key
    puts colorize 'Problem encountered:', :red
    puts '  No push API key entered.'
    puts '  - Sign up for AppSignal and follow the instructions'
    puts "  - Already signed up? Click 'New app' on the account overview page"
    puts
    puts colorize 'Exiting installer...', :red
    return false
  end

  config[:push_api_key] = push_api_key

  print 'Validating API key'
  periods
  puts
  begin
    auth_check = Appsignal::AuthCheck.new(config)
    unless auth_check.perform == '200'
      puts "\n  API key '#{config[:push_api_key]}' is not valid, please get a new one on https://appsignal.com"
      return false
    end
  rescue Exception => e
    puts "  There was an error validating your API key:"
    puts colorize "'#{e}'", :red
    puts "  Please try again"
    return false
  end
  puts colorize '  API key valid!', :green
  puts

  if installed_frameworks.include?(:rails)
    install_for_rails(config)
  elsif installed_frameworks.include?(:sinatra) && !installed_frameworks.include?(:padrino)
    install_for_sinatra(config)
  elsif installed_frameworks.include?(:padrino)
    install_for_padrino(config)
  elsif installed_frameworks.include?(:grape)
    install_for_grape(config)
  else
    puts "We could not detect which framework you are using. We'd be very grateful if you email us on [email protected] with information about your setup."
    return false
  end

  true
end

.write_config_file(data) ⇒ Object 



293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/appsignal/cli/install.rb', line 293

def write_config_file(data)
  template = ERB.new(
    File.read(File.join(File.dirname(__FILE__), "../../../resources/appsignal.yml.erb")),
    nil,
    '-'
  )

  config = template.result(OpenStruct.new(data).instance_eval { binding })

  FileUtils.mkdir_p(File.join(Dir.pwd, 'config'))
  File.write(File.join(Dir.pwd, 'config/appsignal.yml'), config)
end

.yes_or_no(prompt) ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/appsignal/cli/install.rb', line 177

def yes_or_no(prompt)
  loop do
    print prompt
    input = gets.chomp
    if input == 'y'
      return true
    elsif input == 'n'
      return false
    end
  end
end