gitpusshuten 0.0.1

data/lib/gitpusshuten/git.rb

@@ -0,0 +1,111 @@
+module GitPusshuTen
+  class Git
+
+    ##
+    # Push-To Chain
+    # "type"  represents either "tag", "branch" or "ref"
+    # "value" represents the value of the "type"
+    attr_accessor :type, :value
+
+    ##
+    # Pushing
+    # a boolean that determines whether git is currently busy pushing
+    attr_accessor :pushing
+    alias :pushing? :pushing
+
+    ##
+    # Determines whether the repository has the specified remote defined
+    def has_remote?(remote)
+      git('remote') =~ /#{remote}/
+    end
+
+    ##
+    # Adds the specified remote with the specified url to the git repository
+    def add_remote(remote, url)
+      git("remote add #{remote} #{url}")
+    end
+
+    ##
+    # Removes the specified remote from the git repository
+    def remove_remote(remote)
+      git("remote rm #{remote}")
+    end
+
+    ##
+    # Determines whether Git has been initialized
+    def initialized?
+      File.directory?(File.join(Dir.pwd, '.git'))
+    end
+
+    ##
+    # Initializes Git
+    def initialize!
+      %x[git init]
+    end
+
+    ##
+    # Adds ignore line to the gitignore.
+    def ignore!
+      if File.exist?('.gitignore')
+        if not File.read('.gitignore').include?('.gitpusshuten/**/*')
+          %x[echo '.gitpusshuten/**/*' >> .gitignore]
+        end
+      else
+        %x[echo '.gitpusshuten/**/*' >> .gitignore]
+      end
+    end
+
+    ##
+    # Push
+    # Begin of the push(type, value).to(remote) chain
+    # Pass in the type ("tag", "branch" or "ref") as the first argument
+    # followed by the value of the type (e.g. "1.4.2", "develop", or "9fb5c3201186")
+    def push(type, value)
+      @type  = type
+      @value = value
+      self
+    end
+
+    ##
+    # To
+    # End of the push(type, value).to(remote) chain
+    # Pass in the remote (e.g. "staging") as the first argument
+    def to(remote)
+      @pushing = true
+      send("push_#{type}", value, remote)
+      @pushing = false
+      @type    = nil
+      @value   = nil
+    end
+
+    private
+
+    ##
+    # Wrapper for the git unix utility command
+    def git(command)
+      %x(git #{command})
+    end
+
+    ##
+    # Pushes the local git repository "tag" to the
+    # specified remote repository's master branch (forced)
+    def push_tag(tag, remote)
+      git("push #{remote} #{tag}~0:refs/heads/master --force")
+    end
+
+    ##
+    # Pushes the local git repository "branch" to the
+    # specified remote repository's master branch (forced)
+    def push_branch(branch, remote)
+      git("push #{remote} #{branch}:refs/heads/master --force")
+    end
+
+    ##
+    # Pushes the local git repository "ref" to the
+    # specified remote repository's master branch (forced)
+    def push_ref(ref, remote)
+      git("push #{remote} #{ref}:refs/heads/master --force")
+    end
+
+  end
+end

data/lib/gitpusshuten/helpers/environment/installers.rb

@@ -0,0 +1,59 @@
+module GitPusshuTen
+  module Helpers
+    module Environment
+      module Installers
+
+        ##
+        # Installs the specified package(s)
+        def install!(utility)
+          ensure_aptitude_installed!
+          execute_as_root("aptitude update; aptitude install -y #{utility}")
+        end
+
+        ##
+        # Uninstalls the specified package(s)
+        def uninstall!(utility)
+          ensure_aptitude_installed!
+          execute_as_root("aptitude remove -y #{utility}")
+        end
+
+        ##
+        # Installs PushAnd
+        def install_pushand!      
+          download_packages!(home_dir)
+          command = "cd #{home_dir}; cp -R gitpusshuten-packages/pushand/ .; chown -R #{c.user}:#{c.user} pushand;"
+          command += "'#{home_dir}/pushand/pushand_server_uninstall'; '#{home_dir}/pushand/pushand_server_install'"
+          execute_as_root(command)
+          clean_up_packages!(home_dir)
+        end
+
+        ##
+        # Installs a generated .gitconfig
+        def install_gitconfig!
+          command  = "cd #{home_dir}; echo -e \"[receive]\ndenyCurrentBranch = ignore\" > .gitconfig;"
+          command += "chown #{c.user}:#{c.user} .gitconfig"
+          execute_as_root(command)
+        end
+
+        ##
+        # Determines whether the specified utility has been installed or not
+        def installed?(utility)
+          return false if execute_as_root("which #{utility}").nil?
+          true
+        end
+
+        ##
+        # Ensures that the aptitude package manager is installed
+        def ensure_aptitude_installed!
+          if not installed?('aptitude')
+            Spinner.return :message => "Ensuring package manager is installed and up to date.." do
+              execute_as_root!('apt-get update; apt-get install -y aptitude')
+              g('Done!')
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/gitpusshuten/helpers/environment/packages.rb

@@ -0,0 +1,21 @@
+module GitPusshuTen
+  module Helpers
+    module Environment
+      module Packages
+
+        ##
+        # Downloads the gitpusshuten packages
+        def download_packages!(path, user = 'user')
+          send("execute_as_#{user}", "cd #{path}; git clone git://github.com/meskyanichi/gitpusshuten-packages.git")
+        end
+
+        ##
+        # Cleans up the gitpusshuten-packages git repository
+        def clean_up_packages!(path, user = 'user')
+          send("execute_as_#{user}", "cd #{path}; rm -rf gitpusshuten-packages")
+        end
+
+      end
+    end
+  end
+end

data/lib/gitpusshuten/helpers/environment/scp.rb

@@ -0,0 +1,57 @@
+module GitPusshuTen
+  module Helpers
+    module Environment
+      module SCP
+
+        ##
+        # Establishes a SCP session for "root"
+        def scp_as_user(direction, from, to)
+          while true
+            begin
+              Net::SCP.start(c.ip, 'root', {
+                :password   => @user_password,
+                :passphrase => c.passphrase,
+                :port       => c.port
+              }) do |scp|
+                return scp.send("#{direction}!", from, to)
+              end              
+            rescue Net::SCP::AuthenticationFailed
+              if @user_attempted
+                GitPusshuTen::Log.error "Password incorrect. Please retry."
+              else
+                GitPusshuTen::Log.message "Please provide the password for #{c.user.to_s.color(:yellow)}."
+                @user_attempted = true
+              end
+              @user_password = ask('') { |q| q.echo = false }
+            end
+          end
+        end
+
+        ##
+        # Establishes a SCP session for "root"
+        def scp_as_root(direction, from, to)
+          while true
+            begin
+              Net::SCP.start(c.ip, 'root', {
+                :password   => @root_password,
+                :passphrase => c.passphrase,
+                :port       => c.port
+              }) do |scp|
+                return scp.send("#{direction}!", from, to)
+              end              
+            rescue Net::SSH::AuthenticationFailed
+              if @root_attempted
+                GitPusshuTen::Log.error "Password incorrect. Please retry."
+              else
+                GitPusshuTen::Log.message "Please provide the password for #{"root".color(:yellow)}."
+                @root_attempted = true
+              end
+              @root_password = ask('') { |q| q.echo = false }
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/gitpusshuten/helpers/environment/ssh.rb

@@ -0,0 +1,77 @@
+module GitPusshuTen
+  module Helpers
+    module Environment
+      module SSH
+
+        ##
+        # Tests if the specified directory exists
+        def directory?(path)
+          return true if execute_as_root("if [[ -d '#{path}' ]]; then exit; else echo 1; fi").nil?
+          false
+        end
+
+        ##
+        # Tests if the specified file exists
+        def file?(path)
+          return true if execute_as_root("if [[ -f '#{path}' ]]; then exit; else echo 1; fi").nil?
+          false
+        end
+
+        ##
+        # Performs a single command on the remote environment as a user
+        def execute_as_user(command)
+          @user_password ||= c.password
+          
+          while true
+            begin
+              Net::SSH.start(c.ip, c.user, {
+                :password   => @user_password,
+                :passphrase => c.passphrase,
+                :port       => c.port
+              }) do |ssh|
+                response = ssh.exec!(command)
+                GitPusshuTen::Log.silent response 
+                return response
+              end
+            rescue Net::SSH::AuthenticationFailed
+              if @user_attempted
+                GitPusshuTen::Log.error "Password incorrect. Please retry."
+              else
+                GitPusshuTen::Log.message "Please provide the password for #{c.user.to_s.color(:yellow)} (#{c.ip.color(:yellow)})."
+                @user_attempted = true
+              end
+              @user_password = ask('') { |q| q.echo = false }
+            end
+          end
+        end
+
+        ##
+        # Performs a command as root
+        def execute_as_root(command)
+          while true
+            begin
+              Net::SSH.start(c.ip, 'root', {
+                :password   => @root_password,
+                :passphrase => c.passphrase,
+                :port       => c.port
+              }) do |ssh|
+                response = ssh.exec!(command)
+                GitPusshuTen::Log.silent response 
+                return response
+              end              
+            rescue Net::SSH::AuthenticationFailed
+              if @root_attempted
+                GitPusshuTen::Log.error "Password incorrect. Please retry."
+              else
+                GitPusshuTen::Log.message "Please provide the password for #{'root'.color(:yellow)} (#{c.ip.color(:yellow)})."
+                @root_attempted = true
+              end
+              @root_password = ask('') { |q| q.echo = false }
+            end
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/gitpusshuten/helpers/environment/ssh_key.rb

@@ -0,0 +1,79 @@
+module GitPusshuTen
+  module Helpers
+    module Environment
+      module SSHKeys
+
+        ##
+        # USERS
+        ##
+        # Returns true or false, based on whether the (local) ssh
+        # key has been installed on the remote server or not
+        def ssh_key_installed?
+          return false unless has_ssh_key?
+          return true if authorized_ssh_keys.include?(ssh_key)
+          false
+        end
+
+        ##
+        # Returns true or false, based on whether the (local) ssh key exists
+        def has_ssh_key?
+          File.exist?(ssh_key_path)
+        end
+
+        ##
+        # Reads out the ssh key file contents
+        def ssh_key
+          File.read(ssh_key_path)
+        end
+
+        ##
+        # Connects to the server to read out the ~/.ssh/authorized_keys
+        def authorized_ssh_keys
+          execute_as_root("cat '#{File.join(home_dir, '.ssh', 'authorized_keys')}'")
+        end
+
+        ##
+        # Returns the default (local) SSH key path
+        def ssh_key_path
+          File.join(ENV['HOME'], '.ssh', 'id_rsa.pub')
+        end
+
+        ##
+        # Installs the ssh key on the remote server
+        def install_ssh_key!
+          command  = "mkdir -p '#{File.join(home_dir, '.ssh')}';"
+          command += "echo '#{ssh_key}' >> '#{File.join(home_dir, '.ssh', 'authorized_keys')}';"
+          command += "chown -R #{c.user}:#{c.user} '#{File.join(home_dir, '.ssh')}';"
+          command += "chmod 700 '#{File.join(home_dir, '.ssh')}'; chmod 600 '#{File.join(home_dir, '.ssh', 'authorized_keys')}'"
+          execute_as_root(command)
+        end
+
+        ##
+        # ROOT
+        ##
+        # Checks to see if the user's key is already installed in the authorized keys
+        # of the root user on the remote server
+        def root_ssh_key_installed?
+          return false unless has_ssh_key?
+          return true if authorized_root_ssh_keys.include?(ssh_key)
+          false
+        end
+
+        ##
+        # Returns a list of authorized keys for the root user
+        def authorized_root_ssh_keys
+          execute_as_root("cat $HOME/.ssh/authorized_keys")
+        end
+
+        ##
+        # Installs the user's SSH key in root's authorized keys file
+        def install_root_ssh_key!
+          command  = "mkdir -p $HOME/.ssh; echo '#{ssh_key}' >> $HOME/.ssh/authorized_keys;"
+          command += "chmod 700 $HOME/.ssh; chmod 600 $HOME/.ssh/authorized_keys"
+          execute_as_root(command)
+        end
+
+      end
+    end
+  end
+end

data/lib/gitpusshuten/helpers/environment/user.rb

@@ -0,0 +1,70 @@
+module GitPusshuTen
+  module Helpers
+    module Environment
+      module User
+
+        ##
+        # Removes a user from the remote server but does not remove
+        # the user's home directory since it might contain applications
+        def remove_user!
+          response = execute_as_root("userdel -f '#{c.user}'")
+          return true if response.nil? or response =~ /userdel: user .+ is currently logged in/
+          false
+        end
+
+        ##
+        # Adds the user to the sudoers file
+        def add_user_to_sudoers!
+          execute_as_root("echo '#{c.user} ALL=(ALL) ALL' >> /etc/sudoers")
+        end
+
+        ##
+        # Checks the remote server to see if the provided user exists
+        def user_exists?
+          return false if execute_as_root("grep '#{c.user}' /etc/passwd").nil?
+          true
+        end
+
+        ##
+        # Checks to see if the user is already in the sudoers file or not
+        def user_in_sudoers?
+          return true if execute_as_root("cat /etc/sudoers").include?("#{c.user} ALL=(ALL) ALL")
+          false
+        end
+
+        ##
+        # Adds a user to the remote server and sets the home directory
+        # to the path specified in the config.rb. This is the location
+        # to where applications will be deployed
+        #
+        # If a password is not specified in the configuration, it will prompt
+        # the user to fill one in here in the CLI.
+        def add_user!
+          if c.password.nil?
+            GitPusshuTen::Log.message "What password would you like to give #{c.user.to_s.color(:yellow)}?"
+            while @new_password.nil?
+              new_password = ask('Fill in a password.') { |q| q.echo = false }
+              new_password_verification = ask('Verify password.') { |q| q.echo = false }
+              if not new_password.empty? and (new_password == new_password_verification)
+                @new_password = new_password
+              else
+                if new_password.empty?
+                  GitPusshuTen::Log.error "Please provide a password."
+                else
+                  GitPusshuTen::Log.error "Verification failed, please try again."
+                end
+              end
+            end
+          else
+            @new_password = c.password
+          end
+
+          response = execute_as_root("useradd -m --home='#{home_dir}' -s '/bin/bash' --password='" + %x[openssl passwd #{@new_password}].chomp + "' '#{c.user}'")
+          return true if response.nil? or response =~ /useradd\: warning\: the home directory already exists\./
+          false
+        end
+
+      end 
+    end
+  end
+end

data/lib/gitpusshuten/helpers/spinner.rb

@@ -0,0 +1,98 @@
+STDOUT.sync = true
+
+class Spinner
+  
+  ##
+  # Loadify Method
+  #  * block of code you want to provide a loader for
+  #
+  # Options
+  #  * :message  => 'Message to be displayed while processing'
+  #  * :complete => 'Message to be displayed after processing, regardless of the returned value'
+  #  * :return   => 'When set to true, it will display the returned value of the executed code' 
+  def initialize(options = {}, &code)
+    
+    ##
+    # Character to loop through (loader)
+    characters = %w[| / - \\ | / - \\]
+  
+    ##
+    # Create a new thread to run the provided block of code in
+    thread = Thread.new do
+      code.call
+    end
+  
+    ##
+    # Enter a while loop and stay in it until the thread
+    # finished processing the provided code. This will display
+    # and animate the loader meanwhile.
+    while thread.alive?
+      next_character = characters.shift
+      message = "#{next_character} #{options[:message] || ''}"
+      print message
+      characters << next_character
+      sleep 0.065
+      print "\b" * message.length
+    end
+  
+    ##
+    # Extract the value from the dead thread
+    returned_value = thread.value
+  
+    ##
+    # Print Final Message
+    print "#{options[:message]}  "
+  
+    ##
+    # Print On Complete Message if options is set to true
+    unless options[:complete].nil?
+      print options[:complete]
+      print " "
+    end
+  
+    ##
+    # Prints the returned value from the code block
+    # that was executed if set to true
+    if options[:return]
+      if options[:put]
+        puts "\n" + returned_value
+      else
+        print returned_value
+      end
+    end
+    
+    ##
+    # Add a new line
+    print "\n"
+    
+    ##
+    # Return the value from the dead thread
+    returned_value
+    
+  end
+
+  def self.return(options = {}, &code)
+    Spinner.new({:return => true}.merge(options), &code)
+  end
+
+  def self.installing(options = {}, &code)
+    Spinner.new({:message => "Installing..", :complete => 'Done!'.color(:green)}.merge(options), &code)
+  end
+
+  def self.installing_a_while(options = {}, &code)
+    Spinner.new({:message => "Installing, this may take a while..", :complete => 'Done!'.color(:green)}.merge(options), &code)
+  end
+
+  def self.configuring(options = {}, &code)
+    Spinner.new({:message => "Configuring..", :complete => 'Done!'.color(:green)}.merge(options), &code)
+  end
+
+  def self.updating(options = {}, &code)
+    Spinner.new({:message => "Updating..", :complete => 'Done!'.color(:green)}.merge(options), &code)
+  end
+
+  def self.loading(options = {}, &code)
+    Spinner.new({:message => "Loading..", :complete => 'Done!'.color(:green)}.merge(options), &code)
+  end
+
+end

data/lib/gitpusshuten/hook.rb

@@ -0,0 +1,26 @@
+module GitPusshuTen
+  class Hook
+
+    ##
+    # Stores the name of the performed hook
+    attr_accessor :name
+
+    ##
+    # Stores the type of hook (pre or post)
+    attr_accessor :type
+
+    ##
+    # Stores the (parsed) commands that need to be run
+    attr_accessor :commands
+
+    ##
+    # Initializes a new hook
+    # Takes a hash of parameters
+    def initialize(options)
+      @name     = options[:name]
+      @type     = options[:type]
+      @commands = options[:commands]
+    end
+
+  end
+end