# File lib/heroku/client.rb, line 122 def maintenance(app_name, mode) deprecate # 07/31/2012 mode = mode == :on ? '1' : '0' post("/apps/#{app_name}/server/maintenance", :maintenance_mode => mode).to_s end
Object
A Ruby class to call the Heroku REST API. You might use this if you want to manage your Heroku apps from within a Ruby program, such as Capistrano.
Example:
require 'heroku' heroku = Heroku::Client.new('me@example.com', 'mypass') heroku.create()
# File lib/heroku/client.rb, line 53 def self.auth(user, password, host=Heroku::Auth.host) deprecate # 08/01/2012 client = new(user, password, host) json_decode client.post('/login', { :username => user, :password => password }, :accept => 'json').to_s end
# File lib/heroku/client.rb, line 41 def self.deprecate method = caller.first.split('`').last[0...-1] source = caller[1].split(' ').first[0...-3] $stderr.puts(" ! DEPRECATED: Heroku::Client##{method} is deprecated, please use the heroku-api gem.") $stderr.puts(" ! DEPRECATED: More information available at https://github.com/heroku/heroku.rb") $stderr.puts(" ! DEPRECATED: Deprecated method called from #{source}.") end
# File lib/heroku/client.rb, line 28 def self.gem_version_string "heroku-gem/#{version}" end
Invite a person by email address to collaborate on the app.
# File lib/heroku/client.rb, line 158 def add_collaborator(app_name, email) deprecate # 07/31/2012 xml(post("/apps/#{app_name}/collaborators", { 'collaborator[email]' => email }).to_s) end
# File lib/heroku/client.rb, line 133 def add_config_vars(app_name, new_vars) deprecate # 07/27/2012 put("/apps/#{app_name}/config_vars", json_encode(new_vars), :accept => :json).to_s end
# File lib/heroku/client.rb, line 185 def add_domain(app_name, domain) deprecate # 07/31/2012 post("/apps/#{app_name}/domains", domain).to_s end
# File lib/heroku/client.rb, line 543 def add_drain(app_name, url) post("/apps/#{app_name}/logs/drains", "url=#{CGI.escape(url)}").to_s end
Add an ssh public key to the current user.
# File lib/heroku/client.rb, line 211 def add_key(key) deprecate # 07/31/2012 post("/user/keys", key, { 'Content-Type' => 'text/ssh-authkey' }).to_s end
# File lib/heroku/client.rb, line 421 def add_ssl(app_name, pem, key) json_decode(post("/apps/#{app_name}/ssl", :pem => pem, :key => key).to_s) end
# File lib/heroku/client.rb, line 551 def addons(filters = {}) url = "/addons" params = filters.map{|k,v| "#{k}=#{v}"}.join("&") params = nil if params.empty? json_decode get([url,params].compact.join("?"), :accept => 'application/json').to_s end
# File lib/heroku/client.rb, line 143 def clear_config_vars(app_name) deprecate # 07/27/2012 delete("/apps/#{app_name}/config_vars").to_s end
# File lib/heroku/client.rb, line 429 def clear_ssl(app_name) delete("/apps/#{app_name}/ssl") end
# File lib/heroku/client.rb, line 128 def config_vars(app_name) deprecate # 07/27/2012 json_decode get("/apps/#{app_name}/config_vars", :accept => :json).to_s end
Execute a one-off console command, or start a new console tty session if cmd is nil.
# File lib/heroku/client.rb, line 448 def console(app_name, cmd=nil) if block_given? id = post("/apps/#{app_name}/consoles").to_s yield ConsoleSession.new(id, app_name, self) delete("/apps/#{app_name}/consoles/#{id}").to_s else run_console_command("/apps/#{app_name}/console", cmd) end rescue RestClient::BadGateway => e raise(AppCrashed, Unable to attach to a dyno to open a console session.Your application may have crashed.Check the output of "heroku ps" and "heroku logs" for more information.) end
Create a new app, with an optional name.
# File lib/heroku/client.rb, line 82 def create(name=nil, options={}) deprecate # 07/26/2012 name = create_request(name, options) loop do break if create_complete?(name) sleep 1 end name end
# File lib/heroku/client.rb, line 92 def create_app(name=nil, options={}) deprecate # 07/26/2012 options[:name] = name if name json_decode(post("/apps", { :app => options }, :accept => "application/json").to_s) end
# File lib/heroku/client.rb, line 104 def create_complete?(name) deprecate # 07/26/2012 put("/apps/#{name}/status", {}).code == 201 end
# File lib/heroku/client.rb, line 98 def create_request(name=nil, options={}) deprecate # 07/26/2012 options[:name] = name if name xml(post('/apps', :app => options).to_s).elements["//app/name"].text end
# File lib/heroku/client.rb, line 49 def deprecate self.class.deprecate end
Destroy the app permanently.
# File lib/heroku/client.rb, line 117 def destroy(name) deprecate # 07/26/2012 delete("/apps/#{name}").to_s end
# File lib/heroku/client.rb, line 320 def disable_feature(app, name) deprecate # 07/31/2012 json_decode delete("/features/#{name}?app=#{app}", :accept => :json).to_s end
# File lib/heroku/client.rb, line 240 def dynos(app_name) deprecate # 07/31/2012 doc = xml(get("/apps/#{app_name}").to_s) doc.elements["//app/dynos"].text.to_i end
# File lib/heroku/client.rb, line 315 def enable_feature(app, name) deprecate # 07/31/2012 json_decode post("/features/#{name}?app=#{app}", :accept => :json).to_s end
# File lib/heroku/client.rb, line 631 def extract_warning(response) return unless response if response.headers[:x_heroku_warning] && @warning_callback warning = response.headers[:x_heroku_warning] @displayed_warnings ||= {} unless @displayed_warnings[warning] @warning_callback.call(warning) @displayed_warnings[warning] = true end end end
# File lib/heroku/client.rb, line 310 def get_feature(app, name) deprecate # 07/31/2012 json_decode get("features/#{name}?app=#{app}", :accept => :json).to_s end
# File lib/heroku/client.rb, line 575 def httpcache_purge(app_name) delete("/apps/#{app_name}/httpcache").to_s end
Show info such as mode, custom domain, and collaborators on an app.
# File lib/heroku/client.rb, line 71 def info(name_or_domain) deprecate # 07/26/2012 raise ArgumentError.new("name_or_domain is required for info") unless name_or_domain name_or_domain = name_or_domain.gsub(/^(http:\/\/)?(www\.)?/, '') doc = xml(get("/apps/#{name_or_domain}").to_s) attrs = hash_from_xml_doc(doc)[:app] attrs.merge!(:collaborators => list_collaborators(attrs[:name])) attrs.merge!(:addons => installed_addons(attrs[:name])) end
# File lib/heroku/client.rb, line 562 def install_addon(app_name, addon, config={}) configure_addon :install, app_name, addon, config end
# File lib/heroku/client.rb, line 558 def installed_addons(app_name) json_decode get("/apps/#{app_name}/addons", :accept => 'application/json').to_s end
Get the list of ssh public keys for the current user.
# File lib/heroku/client.rb, line 202 def keys deprecate # 07/31/2012 doc = xml get('/user/keys').to_s doc.elements.to_a('//keys/key').map do |key| key.elements['contents'].text end end
Show a list of apps which you are a collaborator on.
# File lib/heroku/client.rb, line 60 def list deprecate # 07/26/2012 doc = xml(get('/apps').to_s) doc.elements.to_a("//apps/app").map do |a| name = a.elements.to_a("name").first owner = a.elements.to_a("owner").first [name.text, owner.text] end end
Get a list of collaborators on the app, returns an array of hashes each with :email
# File lib/heroku/client.rb, line 149 def list_collaborators(app_name) deprecate # 07/31/2012 doc = xml(get("/apps/#{app_name}/collaborators").to_s) doc.elements.to_a("//collaborators/collaborator").map do |a| { :email => a.elements['email'].text } end end
# File lib/heroku/client.rb, line 169 def list_domains(app_name) deprecate # 08/02/2012 doc = xml(get("/apps/#{app_name}/domains").to_s) doc.elements.to_a("//domains/*").map do |d| attrs = { :domain => d.elements['domain'].text } if cert = d.elements['cert'] attrs[:cert] = { :expires_at => Time.parse(cert.elements['expires-at'].text), :subject => cert.elements['subject'].text, :issuer => cert.elements['issuer'].text, } end attrs end end
# File lib/heroku/client.rb, line 539 def list_drains(app_name) get("/apps/#{app_name}/logs/drains").to_s end
# File lib/heroku/client.rb, line 305 def list_features(app) deprecate # 07/31/2012 json_decode(get("features?app=#{app}", :accept => :json).to_s) end
Get a list of stacks available to the app, with the current one marked.
# File lib/heroku/client.rb, line 326 def list_stacks(app_name, options={}) deprecate # 07/31/2012 include_deprecated = options.delete(:include_deprecated) || false json_decode get("/apps/#{app_name}/stack", :params => { :include_deprecated => include_deprecated }, :accept => 'application/json' ).to_s end
Fetch recent logs from the app server.
# File lib/heroku/client.rb, line 300 def logs(app_name) deprecate # 07/31/2012 get("/apps/#{app_name}/logs").to_s end
# File lib/heroku/client.rb, line 122 def maintenance(app_name, mode) deprecate # 07/31/2012 mode = mode == :on ? '1' : '0' post("/apps/#{app_name}/server/maintenance", :maintenance_mode => mode).to_s end
Request a stack migration.
# File lib/heroku/client.rb, line 337 def migrate_to_stack(app_name, stack) deprecate # 07/31/2012 put("/apps/#{app_name}/stack", stack, :accept => 'text/plain').to_s end
# File lib/heroku/client.rb, line 579 def on_warning(&blk) @warning_callback = blk end
# File lib/heroku/client.rb, line 611 def process(method, uri, extra_headers={}, payload=nil) headers = heroku_headers.merge(extra_headers) args = [method, payload, headers].compact resource_options = default_resource_options_for_uri(uri) begin response = resource(uri, resource_options).send(*args) rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, SocketError host = URI.parse(realize_full_uri(uri)).host error "Unable to connect to #{host}" rescue RestClient::SSLCertificateNotVerified => ex host = URI.parse(realize_full_uri(uri)).host error "WARNING: Unable to verify SSL certificate for #{host}\nTo disable SSL verification, run with HEROKU_SSL_VERIFY=disable" end extract_warning(response) response end
Retreive ps list for the given app name.
# File lib/heroku/client.rb, line 229 def ps(app_name) deprecate # 07/31/2012 json_decode get("/apps/#{app_name}/ps", :accept => 'application/json').to_s end
# File lib/heroku/client.rb, line 274 def ps_restart(app, opts={}) deprecate # 07/31/2012 post("/apps/#{app}/ps/restart", opts) end
# File lib/heroku/client.rb, line 264 def ps_run(app, opts={}) deprecate # 07/31/2012 json_decode post("/apps/#{app}/ps", opts, :accept => :json).to_s end
# File lib/heroku/client.rb, line 269 def ps_scale(app, opts={}) deprecate # 07/31/2012 Integer(post("/apps/#{app}/ps/scale", opts).to_s) end
# File lib/heroku/client.rb, line 279 def ps_stop(app, opts={}) deprecate # 07/31/2012 post("/apps/#{app}/ps/stop", opts) end
Run a rake command on the Heroku app and return output as a string
# File lib/heroku/client.rb, line 343 def rake(app_name, cmd) # deprecated by virtue of start deprecation 08/02/2012 start(app_name, "rake #{cmd}", :attached).to_s end
# File lib/heroku/client.rb, line 482 def read_logs(app_name, options=[]) query = "&" + options.join("&") unless options.empty? url = get("/apps/#{app_name}/logs?logplex=true#{query}").to_s if url == 'Use old logs' puts get("/apps/#{app_name}/logs").to_s else uri = URI.parse(url); if uri.scheme == 'https' proxy = https_proxy else proxy = http_proxy end if proxy proxy_uri = URI.parse(proxy) http = Net::HTTP.new(uri.host, uri.port, proxy_uri.host, proxy_uri.port, proxy_uri.user, proxy_uri.password) else http = Net::HTTP.new(uri.host, uri.port) end if uri.scheme == 'https' http.use_ssl = true if ENV["HEROKU_SSL_VERIFY"] == "disable" http.verify_mode = OpenSSL::SSL::VERIFY_NONE else http.verify_mode = OpenSSL::SSL::VERIFY_PEER http.ca_file = local_ca_file http.verify_callback = lambda do |preverify_ok, ssl_context| if (!preverify_ok) || ssl_context.error != 0 error "WARNING: Unable to verify SSL certificate for #{host}\nTo disable SSL verification, run with HEROKU_SSL_VERIFY=disable" end true end end end http.read_timeout = 60 * 60 * 24 begin http.start do http.request_get(uri.path + (uri.query ? "?" + uri.query : "")) do |response| error(response.message) if response.is_a? Net::HTTPServerError response["Tail-warning"] && $stderr.puts(response["X-Heroku-Warning"]) response.read_body do |chunk| yield chunk end end end rescue Errno::ECONNREFUSED, Errno::ETIMEDOUT, SocketError error("Could not connect to logging service") rescue Timeout::Error, EOFError error("\nRequest timed out") end end end
# File lib/heroku/client.rb, line 289 def release(app, release) deprecate # 07/31/2012 json_decode get("/apps/#{app}/releases/#{release}", :accept => :json).to_s end
# File lib/heroku/client.rb, line 284 def releases(app) deprecate # 07/31/2012 json_decode get("/apps/#{app}/releases", :accept => :json).to_s end
Clear all keys on the current user.
# File lib/heroku/client.rb, line 223 def remove_all_keys deprecate # 07/31/2012 delete("/user/keys").to_s end
Remove a collaborator.
# File lib/heroku/client.rb, line 164 def remove_collaborator(app_name, email) deprecate # 07/31/2012 delete("/apps/#{app_name}/collaborators/#{escape(email)}").to_s end
# File lib/heroku/client.rb, line 138 def remove_config_var(app_name, key) deprecate # 07/27/2012 delete("/apps/#{app_name}/config_vars/#{escape(key)}", :accept => :json).to_s end
# File lib/heroku/client.rb, line 190 def remove_domain(app_name, domain) deprecate # 07/31/2012 raise ArgumentError.new("invalid domain: #{domain.inspect}") if domain.to_s.strip == "" delete("/apps/#{app_name}/domains/#{domain}").to_s end
# File lib/heroku/client.rb, line 196 def remove_domains(app_name) deprecate # 07/31/2012 delete("/apps/#{app_name}/domains").to_s end
# File lib/heroku/client.rb, line 547 def remove_drain(app_name, url) delete("/apps/#{app_name}/logs/drains?url=#{CGI.escape(url)}").to_s end
Remove an existing ssh public key from the current user.
# File lib/heroku/client.rb, line 217 def remove_key(key) deprecate # 07/31/2012 delete("/user/keys/#{escape(key)}").to_s end
# File lib/heroku/client.rb, line 425 def remove_ssl(app_name, domain) delete("/apps/#{app_name}/domains/#{domain}/ssl").to_s end
# File lib/heroku/client.rb, line 585 def resource(uri, options={}) RestClient.proxy = case URI.parse(realize_full_uri(uri)).scheme when "http" http_proxy when "https" https_proxy end RestClient::Resource.new(realize_full_uri(uri), options.merge(:user => user, :password => password)) end
Restart the app servers.
# File lib/heroku/client.rb, line 235 def restart(app_name) deprecate # 07/31/2012 delete("/apps/#{app_name}/server").to_s end
# File lib/heroku/client.rb, line 294 def rollback(app, release=nil) deprecate # 07/31/2012 post("/apps/#{app}/releases", :rollback => release) end
internal method to run console commands formatting the output
# File lib/heroku/client.rb, line 465 def run_console_command(url, command, prefix=nil) output = post(url, { :command => command }, :accept => "text/plain").to_s return output unless prefix if output.include?("\n") lines = output.split("\n") (lines[0..-2] << "#{prefix}#{lines.last}").join("\n") else prefix + output end rescue RestClient::RequestFailed => e if e.http_code == 422 Heroku::Command.extract_error(e.http_body, :raw => true) else raise e end end
Scales the web dynos.
# File lib/heroku/client.rb, line 253 def set_dynos(app_name, qty) deprecate # 07/31/2012 put("/apps/#{app_name}/dynos", :dynos => qty).to_s end
Scales the background dynos.
# File lib/heroku/client.rb, line 259 def set_workers(app_name, qty) deprecate # 07/31/2012 put("/apps/#{app_name}/workers", :workers => qty).to_s end
# File lib/heroku/client/ssl_endpoint.rb, line 2 def ssl_endpoint_add(app, pem, key) json_decode(post("apps/#{app}/ssl-endpoints", :accept => :json, :pem => pem, :key => key).to_s) end
# File lib/heroku/client/ssl_endpoint.rb, line 6 def ssl_endpoint_info(app, cname) json_decode(get("apps/#{app}/ssl-endpoints/#{escape(cname)}", :accept => :json).to_s) end
# File lib/heroku/client/ssl_endpoint.rb, line 10 def ssl_endpoint_list(app) json_decode(get("apps/#{app}/ssl-endpoints", :accept => :json).to_s) end
# File lib/heroku/client/ssl_endpoint.rb, line 14 def ssl_endpoint_remove(app, cname) json_decode(delete("apps/#{app}/ssl-endpoints/#{escape(cname)}", :accept => :json).to_s) end
# File lib/heroku/client/ssl_endpoint.rb, line 18 def ssl_endpoint_rollback(app, cname) json_decode(post("apps/#{app}/ssl-endpoints/#{escape(cname)}/rollback", :accept => :json).to_s) end
# File lib/heroku/client/ssl_endpoint.rb, line 22 def ssl_endpoint_update(app, cname, pem, key) json_decode(put("apps/#{app}/ssl-endpoints/#{escape(cname)}", :accept => :json, :pem => pem, :key => key).to_s) end
Run a service. If Responds to each and yields output as it’s received.
# File lib/heroku/client.rb, line 415 def start(app_name, command, attached=false) deprecate # 08/02/2012 service = Service.new(self, app_name) service.start(command, attached) end
# File lib/heroku/client.rb, line 571 def uninstall_addon(app_name, addon, options={}) configure_addon :uninstall, app_name, addon, options end
Update an app. Available attributes:
:name => rename the app (changes http and git urls)
# File lib/heroku/client.rb, line 111 def update(name, attributes) deprecate # 07/26/2012 put("/apps/#{name}", :app => attributes).to_s end
# File lib/heroku/client.rb, line 566 def upgrade_addon(app_name, addon, config={}) configure_addon :upgrade, app_name, addon, config end
Generated with the Darkfish Rdoc Generator 2.