boxen 2.9.0 → 3.0.0.beta1

data/lib/boxen/hook.rb

@@ -2,7 +2,6 @@ module Boxen
   class Hook
     attr_reader :config
     attr_reader :checkout
-    attr_reader :puppet
     attr_reader :result
 
     @hooks = []
@@ -16,13 +15,24 @@ module Boxen
     end
 
     def self.all
-      @hooks || []
+      @hooks
     end
 
-    def initialize(config, checkout, puppet, result)
+    def self.register(klass)
+      unless defined? @hooks
+        @hooks = []
+      end
+
+      @hooks << klass
+    end
+
+    def self.run
+      @hooks.each { |hook| hook.new(nil, nil, nil).run }
+    end
+
+    def initialize(config, checkout, result)
       @config   = config
       @checkout = checkout
-      @puppet   = puppet
       @result   = result
     end
 
@@ -34,7 +44,7 @@ module Boxen
     end
 
     def perform?
-      false
+      enabled?
     end
 
     def run
@@ -42,6 +52,3 @@ module Boxen
     end
   end
 end
-
-require "boxen/hook/github_issue"
-require "boxen/hook/web"

data/lib/boxen/keychain.rb

@@ -44,7 +44,7 @@ module Boxen
     def set(service, token)
       cmd = shellescape(HELPER, service, login, token)
 
-      unless system *cmd
+      unless system(*cmd)
         raise Boxen::Error, "Can't save #{service} in the keychain."
       end
 

data/lib/boxen/postflight/env.rb

@@ -24,6 +24,6 @@ class Boxen::Postflight::Env < Boxen::Postflight
   end
 
   def run
-    warn "Run source #{config.envfile} or restart your shell for new stuff!"
+    warn "Source #{config.envfile} or restart your shell for new stuff!"
   end
 end

data/lib/boxen/postflight/github_issue.rb

@@ -0,0 +1,124 @@
+require "boxen/postflight"
+require "boxen/checkout"
+
+# Checks to see if the basic environment is loaded.
+
+class Boxen::Postflight::GithubIssue < Boxen::Postflight
+  def checkout
+    @checkout ||= Boxen::Checkout.new(@config)
+  end
+
+  def ok?
+    # Only run if we have credentials and we're on master
+    !enabled? || config.login.to_s.empty? || !checkout.master?
+  end
+
+  def run
+    if command.success?
+      close_failures
+    else
+      warn "Sorry! Creating an issue on #{config.reponame}"
+      record_failure
+    end
+  end
+
+  def compare_url
+    return unless config.reponame
+    "#{config.ghurl}/#{config.reponame}/compare/#{checkout.sha}...master"
+  end
+
+  def hostname
+    Socket.gethostname
+  end
+
+  def os
+    `sw_vers -productVersion`.strip
+  end
+
+  def shell
+    ENV["SHELL"]
+  end
+
+  def logfile
+    File.read config.logfile
+  end
+
+  def record_failure
+    return unless issues?
+
+    title = "Failed for #{config.user}"
+    config.api.create_issue config.reponame,
+      title,
+      failure_details,
+      :labels => [
+        failure_label
+      ]
+  end
+
+  def close_failures
+    return unless issues?
+
+    comment = "Succeeded at version #{checkout.sha}."
+    failures.each do |issue|
+      config.api.add_comment(config.reponame, issue.number, comment)
+      config.api.close_issue(config.reponame, issue.number)
+    end
+  end
+
+  def failures
+    return [] unless issues?
+
+    issues = config.api.list_issues(config.reponame, :state => 'open',
+      :labels => failure_label, :creator => config.login)
+    issues.reject! {|i| i.labels.collect(&:name).include?(ongoing_label)}
+    issues
+  end
+
+  def failure_details
+    body = ''
+    body << "Running on `#{hostname}` (OS X #{os}) under `#{shell}`, "
+    body << "version #{checkout.sha} ([compare to master](#{compare_url}))."
+    body << "\n\n"
+
+    if checkout.dirty?
+      body << "### Changes"
+      body << "\n\n"
+      body << "```\n#{checkout.changes}\n```"
+      body << "\n\n"
+    end
+
+    body << "### Output (from #{config.logfile})"
+    body << "\n\n"
+    body << "```\n#{logfile}\n```\n"
+
+    body
+  end
+
+  attr_writer :failure_label
+  def failure_label
+    @failure_label ||= 'failure'
+  end
+
+  attr_writer :ongoing_label
+  def ongoing_label
+    @ongoing_label ||= 'ongoing'
+  end
+
+  def issues?
+    return unless config.reponame
+    return if config.reponame == 'boxen/our-boxen'
+
+    config.api.repository(config.reponame).has_issues
+  end
+
+  def required_environment_variables
+    ['BOXEN_ISSUES_ENABLED']
+  end
+
+  def enabled?
+    required_vars = Array(required_environment_variables)
+    required_vars.any? && required_vars.all? do |var|
+      ENV[var] && !ENV[var].empty?
+    end
+  end
+end

data/lib/boxen/postflight/hooks.rb

@@ -0,0 +1,16 @@
+require "boxen/postflight"
+require "boxen/hook"
+
+# Prints deprecation notices for all pre-3.x style hooks
+
+class Boxen::Postflight::Hooks < Boxen::Postflight
+  def ok?
+    !Boxen::Hook.all.any?
+  end
+
+  def run
+    ::Boxen::Hook.all.each do |hook|
+      warn "DEPRECATION WARNING: Boxen::Hook is deprecated (#{hook})"
+    end
+  end
+end

data/lib/boxen/postflight/web_hook.rb

@@ -0,0 +1,63 @@
+require "boxen/postflight"
+require "json"
+require "net/http"
+
+class Boxen::Postflight::WebHook < Boxen::Postflight
+  def ok?
+    !enabled?
+  end
+
+  attr_writer :checkout
+  def checkout
+    @checkout ||= Boxen::Checkout.new(config)
+  end
+
+  def run
+    payload = {
+      :login  => config.user,
+      :sha    => checkout.sha,
+      :status => command.success? ? 'success' : 'failure',
+      :time   => "#{Time.now.utc.to_i}"
+    }
+
+    post_web_hook payload
+  end
+
+  def post_web_hook(payload)
+    headers = { 'Content-Type' => 'application/json' }
+
+    uri = URI.parse(URI.escape(ENV['BOXEN_WEB_HOOK_URL']))
+
+    user, pass, host, port, path = \
+      uri.user, uri.pass, uri.host, uri.port, uri.path
+
+    request = Net::HTTP::Post.new(path, headers)
+
+    if uri.scheme =~ /https/
+      http.use_ssl = true
+    end
+
+    if user && pass
+      request.basic_auth user, pass
+    end
+
+    request.body = payload.to_json
+
+    response = Net::HTTP.new(host, port).start do |http|
+      http.request(request)
+    end
+
+    response
+  end
+
+  def required_environment_variables
+    ['BOXEN_WEB_HOOK_URL']
+  end
+
+  def enabled?
+    required_vars = Array(required_environment_variables)
+    required_vars.any? && required_vars.all? do |var|
+      ENV[var] && !ENV[var].empty?
+    end
+  end
+end

data/lib/boxen/preflight.rb

@@ -1,13 +1,10 @@
 require "boxen/check"
 
 module Boxen
-
-  # The superclass for preflight checks.
-
   class Preflight < Boxen::Check
-
-    # Load all available preflight checks.
-
-    register File.expand_path("../preflight", __FILE__)
   end
 end
+
+Dir["#{File.expand_path('../preflight', __FILE__)}/*"].each do |f|
+  require "boxen/preflight/#{File.basename f}"
+end

data/lib/boxen/preflight/creds.rb

@@ -1,8 +1,6 @@
 require "boxen/preflight"
 require "highline"
 require "octokit"
-require "digest"
-require "socket"
 
 # HACK: Unless this is `false`, HighLine has some really bizarre
 # problems with empty/expended streams at bizarre intervals.
@@ -14,6 +12,8 @@ class Boxen::Preflight::Creds < Boxen::Preflight
   attr :password
 
   def ok?
+    return true if config.offline?
+
     if config.token && config.api.user
       # There was a period of time when login wasn't geting set on first run.
       # This should correct that.
@@ -70,27 +70,12 @@ class Boxen::Preflight::Creds < Boxen::Preflight
     fetch_login_and_password
     tokens = get_tokens
 
-    # Boxen now supports the updated GitHub Authorizations API by using a unique
-    # `fingerprint` for each Boxen installation for a user. We delete any older
-    # authorization that does not make use of `fingerprint` so that the "legacy"
-    # authorization doesn't persist in the user's list of personal access
-    # tokens.
-    legacy_auth = tokens.detect { |a| a.note == "Boxen" && a.fingerprint == nil }
-    tmp_api.delete_authorization(legacy_auth.id, :headers => headers) if legacy_auth
-
-    # The updated GitHub authorizations API, in order to improve security, no
-    # longer returns a plaintext `token` for existing authorizations. So, if an
-    # authorization already exists for this machine we need to first delete it
-    # so that we can create a new one.
-    auth = tokens.detect { |a| a.note == note && a.fingerprint == fingerprint }
-    tmp_api.delete_authorization(auth.id, :headers => headers) if auth
-
-    auth = tmp_api.create_authorization(
-      :note => note,
-      :scopes => %w(repo user),
-      :fingerprint => fingerprint,
-      :headers => headers
-    )
+    unless auth = tokens.detect { |a| a.note == "Boxen" }
+      auth = tmp_api.create_authorization \
+        :note => "Boxen",
+        :scopes => %w(repo user),
+        :headers => headers
+    end
 
     config.token = auth.token
 
@@ -122,28 +107,4 @@ class Boxen::Preflight::Creds < Boxen::Preflight
     warn "Oh, looks like you've provided your #{thing} as environmental variable..."
     found
   end
-
-  def fingerprint
-    @fingerprint ||= begin
-      # See Apple technical note TN1103, "Uniquely Identifying a Macintosh
-      # Computer."
-      serial_number_match_data = IO.popen(
-        ["ioreg", "-c", "IOPlatformExpertDevice", "-d", "2"]
-      ).read.match(/"IOPlatformSerialNumber" = "([[:alnum:]]+)"/)
-      if serial_number_match_data
-        # The fingerprint must be unique across all personal access tokens for a
-        # given user. We prefix the serial number with the application name to
-        # differentiate between any other personal access token that uses the
-        # Mac serial number for the fingerprint.
-        Digest::SHA256.hexdigest("Boxen: #{serial_number_match_data[1]}")
-      else
-        abort "Sorry, I was unable to obtain your Mac's serial number.",
-          "Boxen requires access to your Mac's serial number in order to generate a unique GitHub personal access token."
-      end
-    end
-  end
-
-  def note
-    @note ||= "Boxen: #{Socket.gethostname}"
-  end
 end

data/lib/boxen/preflight/facts.rb

@@ -0,0 +1,36 @@
+require "fileutils"
+require "pathname"
+
+require "boxen/preflight"
+
+class Boxen::Preflight::Facts < Boxen::Preflight
+  def ok?
+    write_facts
+
+    true
+  end
+
+  def run
+  end
+
+  private
+
+  def facter_d
+    Pathname.new("#{config.homedir}/facts.d")
+  end
+
+  def write_facts
+    FileUtils.mkdir_p facter_d
+
+    write_fact "offline", config.offline?
+  end
+
+  def write_fact(name, value)
+    File.open("#{facter_d}/#{name}.txt", "w") do |f|
+      f.write "#{name}=#{value}\n"
+    end
+
+    debug "Setting global fact `#{name}` to `#{value}`"
+  end
+
+end

data/lib/boxen/preflight/homebrew.rb

@@ -0,0 +1,13 @@
+require "boxen/preflight"
+
+class Boxen::Preflight::Homebrew < Boxen::Preflight
+  def run
+    warn "You have an existing Homebrew install in /usr/local",
+      "The Boxen provides its own Homebrew, so consider deleting yours.",
+      "Keeping both will confuse many projects."
+  end
+
+  def ok?
+    !File.exist? "/usr/local/Library/Homebrew"
+  end
+end

data/lib/boxen/preflight/identity.rb

@@ -2,6 +2,8 @@ require "boxen/preflight"
 
 class Boxen::Preflight::Identity < Boxen::Preflight
   def ok?
+    return true if config.offline?
+    
     !user || (config.email && config.name)
   end
 

data/lib/boxen/preflight/offline.rb

@@ -0,0 +1,33 @@
+require "socket"
+require "timeout"
+
+require "boxen/preflight"
+
+class Boxen::Preflight::Offline < Boxen::Preflight
+  def ok?
+    config.offline = !google_reachable?
+
+    info "Running boxen in offline mode as we couldn't reach google." if config.offline?
+
+    true
+  end
+
+  def run
+  end
+
+  private
+
+  def google_reachable?
+    @online = begin
+      timeout(3) do
+        s = TCPSocket.new('google.com', 80)
+        s.close
+      end
+      true
+    rescue Errno::ECONNREFUSED
+      true
+    rescue Timeout::Error, StandardError
+      false
+    end
+  end
+end