Class: Appsignal::CLI::Install
- Extended by:
- Helpers
- Defined in:
- lib/appsignal/cli/install.rb
Constant Summary collapse
- EXCLUDED_ENVIRONMENTS =
['test'].freeze
Class Method Summary collapse
- .configure(config, environments, name_overwritten) ⇒ Object
- .done_notice ⇒ Object
- .install_for_capistrano ⇒ Object
- .install_for_grape(config) ⇒ Object
- .install_for_padrino(config) ⇒ Object
- .install_for_rails(config) ⇒ Object
- .install_for_sinatra(config) ⇒ Object
- .installed_frameworks ⇒ Object
- .new_config ⇒ Object
- .rails_environments ⇒ Object
- .run(push_api_key) ⇒ Object
- .write_config_file(data) ⇒ Object
Class Method Details
.configure(config, environments, name_overwritten) ⇒ Object
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 |
# File 'lib/appsignal/cli/install.rb', line 150 def configure(config, environments, name_overwritten) install_for_capistrano ENV["APPSIGNAL_APP_ENV"] = "development" puts "How do you want to configure AppSignal?" puts " (1) a config file" puts " (2) environment variables" loop do print " Choose (1/2): " case ask_for_input when '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 when '2' ENV["APPSIGNAL_ACTIVE"] = "true" ENV["APPSIGNAL_PUSH_API_KEY"] = config[:push_api_key] ENV["APPSIGNAL_APP_NAME"] = config[:name] puts puts "Add the following environment variables to configure AppSignal:" 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
194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 |
# File 'lib/appsignal/cli/install.rb', line 194 def done_notice sleep 0.3 puts colorize "#####################################", :green puts colorize "## AppSignal installation complete ##", :green puts colorize "#####################################", :green sleep 0.3 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 " Sending example data to AppSignal..." if Appsignal::Demo.transmit puts " Example data sent!" puts " It may take about a minute for the data to appear on https://appsignal.com/accounts" puts puts " Please return to your browser and follow the instructions." else puts " Couldn't start the AppSignal agent and send example data to AppSignal.com" puts " Please use `appsignal diagnose` to debug your configuration." end end end |
.install_for_capistrano ⇒ Object
135 136 137 138 139 140 141 142 143 144 145 146 147 148 |
# File 'lib/appsignal/cli/install.rb', line 135 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
120 121 122 123 124 125 126 127 128 129 130 131 132 133 |
# File 'lib/appsignal/cli/install.rb', line 120 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 at:" puts " http://docs.appsignal.com/getting-started/supported-frameworks.html#grape" press_any_key done_notice end |
.install_for_padrino(config) ⇒ Object
102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 |
# File 'lib/appsignal/cli/install.rb', line 102 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.(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 98 99 100 |
# 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'" puts puts " You can find more information in the documentation:" puts " http://docs.appsignal.com/getting-started/supported-frameworks.html#sinatra" press_any_key done_notice end |
.installed_frameworks ⇒ Object
217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 |
# File 'lib/appsignal/cli/install.rb', line 217 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 |
.new_config ⇒ Object
261 262 263 |
# File 'lib/appsignal/cli/install.rb', line 261 def new_config Appsignal::Config.new(Dir.pwd, "") end |
.rails_environments ⇒ Object
242 243 244 245 246 |
# File 'lib/appsignal/cli/install.rb', line 242 def rails_environments Dir.glob( File.join(Dir.pwd, 'config/environments/*.rb') ).map { |o| File.basename(o, ".rb") }.sort - EXCLUDED_ENVIRONMENTS end |
.run(push_api_key) ⇒ Object
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 14 def run(push_api_key) 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 end config = new_config 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 end rescue => e puts " There was an error validating your API key:" puts colorize "'#{e}'", :red puts " Please try again" return end puts colorize ' API key valid!', :green puts if installed_frameworks.include?(:rails) install_for_rails(config) elsif installed_frameworks.include?(:padrino) install_for_padrino(config) elsif installed_frameworks.include?(:grape) install_for_grape(config) elsif installed_frameworks.include?(:sinatra) install_for_sinatra(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." end end |
.write_config_file(data) ⇒ Object
248 249 250 251 252 253 254 255 256 257 258 259 |
# File 'lib/appsignal/cli/install.rb', line 248 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 |