module Checkpoint

Constants

VERSION

Public Class Methods

check(**opts) click to toggle source

Checks for the latest version information as well as alerts.

@param [Hash] opts the options to check with @option opts [String] :product The product @option opts [String] :version The version of the product @option opts [String] :arch The arch this is running on. If not specified,

we will try to determine it.

@option opts [String] :os The OS this is running on. If not specified,

we will try to determine it.

@option opts [String] :signature A signature to eliminate duplicates @option opts [String] :signature_file If specified, a signature will

be read from this path. If it doesn't exist, it will be created with
a new random signature.

@option opts [String] :cache_file If specified, the response will be

cached here for cache_time period (defaults to 48 hours).

# File lib/checkpoint.rb, line 29
def self.check(**opts)
  return nil if @@disabled

  # If we have the cache file, then just return the contents.
  if opts[:cache_file] && File.file?(opts[:cache_file])
    # If the cache file is too old, then delete it
    mtime = File.mtime(opts[:cache_file]).to_i
    limit = Time.now.to_i - (60 * 60 * 24 * 2)
    if mtime > limit
      return build_check(File.read(opts[:cache_file]), "cached" => true)
    end

    # Delete the file
    File.unlink(opts[:cache_file])
  end

  # Build the query parameters
  query = {
    version: opts[:version],
    arch: opts[:arch],
    os: opts[:os],
    signature: opts[:signature],
  }
  query[:arch] ||= Platform.arch
  query[:os] ||= Platform.os

  # If a signature file was specified, read it from there.
  if opts[:signature_file]
    if !File.file?(opts[:signature_file])
      File.open(opts[:signature_file], "w+") do |f|
        f.write(SecureRandom.uuid.to_s + "\n\n")
        f.write("This signature is a randomly generated UUID used to de-duplicate\n")
        f.write("alerts and version information. This signature is random, it is\n")
        f.write("not based on any personally identifiable information. To create\n")
        f.write("a new signature, you can simply delete this file at any time.\n")
      end
    end

    query[:signature] = File.read(opts[:signature_file]).lines.first.chomp
  end

  # Turn the raw query parameters into a proper query string
  query = query.map do |k, v|
    if v
      [CGI.escape(k.to_s), "=", CGI.escape(v.to_s)].join
    end
  end.compact.join("&")

  # Build the URL
  uri = URI::HTTP.build(
    host: "checkpoint-api.hashicorp.com",
    path: "/v1/check/#{opts[:product]}",
    query: query,
  )

  headers = {
    "Accept" => "application/json",
    "User-Agent" => "HashiCorp/ruby-checkpoint #{VERSION}",
  }
  http = Net::HTTP.new(uri.host, 443)
  http.use_ssl = true
  http.verify_mode = OpenSSL::SSL::VERIFY_PEER
  resp = http.get("#{uri.path}?#{uri.query}", headers)
  if !resp.is_a?(Net::HTTPSuccess)
    return nil
  end

  # If we have a cache file, write it
  if opts[:cache_file]
    File.open(opts[:cache_file], "w+") do |f|
      f.write(resp.body)
    end
  end

  build_check(resp.body)
rescue StandardError
  # If we want errors, raise it
  raise if opts[:raise_error]

  # We don't want check to fail for any reason, so just return nil
  return nil
end

disable!() click to toggle source

Disables checkpoint.

# File lib/checkpoint.rb, line 113
def self.disable!
  @@disabled = true
end

Protected Class Methods

build_check(response, extra_info={}) click to toggle source

# File lib/checkpoint.rb, line 119
def self.build_check(response, extra_info={})
  JSON.parse(response).tap do |result|
    result["outdated"] = !!result["outdated"]
    result.merge!(extra_info)
  end
end