module Snitcher

Constants

VERSION

Public Instance Methods

snitch(*args) click to toggle source

Check-in to Dead Man's Snitch.

@param token [String] The unique Snitch token to check-in with. This can be

found on the Setup page as the last part of the HTTP check-in url. For
example, c2354d53d2 is the token in http://nosnch.in/c2354d53d2.

@param [Hash] opts

@option opts [String] :message Text message to include with the check-in.

The message is limited to 256 characters.

@option opts [String, Fixnum, nil] :status Exit code for the check-in. A

status of "", nil, or 0 are all treated as the job finishing successfully.

@option opts [Float, Fixnum] :timeout Number of seconds to wait for a

response from the server. Default is 5 seconds.

@example

Snitch.snitch("c2354d53d2")
# => true

@return [Boolean] if the check-in succeeded.

# File lib/snitcher.rb, line 78
def snitch(*args)
  snitch!(*args)
rescue StandardError
  false
end

snitch!(token, opts = {}) click to toggle source

Check-in to Dead Man's Snitch, exceptions are raised on failures.

@param token [String] The unique Snitch token to check-in with. This can be

found on the Setup page as the last part of the HTTP check-in url. For
example, c2354d53d2 is the token in http://nosnch.in/c2354d53d2.

@param [Hash] opts

@option opts [String] :message Text message to include with the check-in.

The message is limited to 256 characters.

@option opts [String, Fixnum, nil] :status Exit code for the check-in. A

status of "", nil, or 0 are all treated as the job finishing successfully.

@option opts [Float, Fixnum] :timeout Number of seconds to wait for a

response from the server. Default is 5 seconds.

@example

Snitch.snitch("c2354d53d2")
# => true

@return [Boolean] if the check-in succeeded.

# File lib/snitcher.rb, line 31
def snitch!(token, opts = {})
  params = {}
  params[:m] = opts[:message] if opts[:message]

  # It's unnecessary to send an empty status
  if opts[:status] && opts[:status] != ""
    params[:s] = opts[:status]
  end

  uri = URI.parse(checkin_url(opts, token))
  if params.any?
    uri.query = URI.encode_www_form(params)
  end

  opts = initialize_opts(opts, uri)

  Net::HTTP.start(uri.host, uri.port, opts) do |http|
    request = Net::HTTP::Get.new(uri.request_uri)
    request["User-Agent"] = user_agent

    response = http.request(request)
    response.is_a?(Net::HTTPSuccess)
  end
end

Private Instance Methods

checkin_url(opts, token) click to toggle source

# File lib/snitcher.rb, line 97
def checkin_url(opts, token)
  if opts[:uri].nil?
    "https://nosnch.in/#{token}"
  else
    "#{opts[:uri]}/#{token}"
  end
end

initialize_opts(options, uri) click to toggle source

# File lib/snitcher.rb, line 86
def initialize_opts(options, uri)
  timeout = options.fetch(:timeout, 5)

  {
    open_timeout: timeout,
    read_timeout: timeout,
    ssl_timeout:  timeout,
    use_ssl:      use_ssl?(uri),
  }
end

use_ssl?(uri) click to toggle source

# File lib/snitcher.rb, line 105
def use_ssl?(uri)
  uri.scheme == "https"
end

user_agent() click to toggle source

# File lib/snitcher.rb, line 109
def user_agent
  # RUBY_ENGINE was not added until 1.9.3
  engine = defined?(::RUBY_ENGINE) ? ::RUBY_ENGINE : "Ruby"

  "Snitcher; #{engine}/#{RUBY_VERSION}; #{RUBY_PLATFORM}; v#{::Snitcher::VERSION}"
end