gitpusshuten 0.0.1

data/lib/gitpusshuten/commands/initialize.rb

@@ -0,0 +1,61 @@
+# encoding: utf-8
+module GitPusshuTen
+  module Commands
+    class Initialize < GitPusshuTen::Commands::Base
+      description "Initializes Git Pusshu Ten (プッシュ点) with the working directory."
+      usage       "initialize"
+      example     "heavenly initialize  # Initializes Git Pusshu Ten (プッシュ点) with the working directory."
+
+      ##
+      # Initialize specific attributes/arguments
+      attr_accessor :working_directory
+
+      ##
+      # Incase template files already exist
+      attr_accessor :confirm_perform
+
+      def initialize(*objects)
+        super
+        
+        @working_directory = Dir.pwd
+        @confirm_perform   = true
+      end
+
+      ##
+      # Performs the Initialize command
+      def perform!
+        message "Would you like to initialize Git Pusshu Ten (プッシュ点) with #{working_directory}?"
+        if yes?
+          copy_templates!
+          if not git.initialized?
+            git.initialize!
+          end
+          git.ignore!
+        else
+          message "If you wish to initialize it elsewhere, please move into that directory and run #{y("heavenly initialize")} again."
+        end
+      end
+
+      ##
+      # Copies the "config.rb" and "hooks.rb" templates over
+      # to the .gitpusshuten inside the working directory
+      def copy_templates!
+        if File.directory?(File.join(working_directory, '.gitpusshuten'))
+          warning "Git Pusshu Ten (プッシュ点) is already initialized in #{y(working_directory)}."
+          warning "Re-initializing it will cause it to overwrite the current #{y("config.rb")} and #{y("hooks.rb")} files."
+          warning "Are you sure you wish to continue?"
+          @confirm_perform = yes?
+        end
+        
+        if confirm_perform
+          local.execute("mkdir -p '#{working_directory}/.gitpusshuten'")
+          Dir[File.expand_path(File.join(File.dirname(__FILE__), '..', '..', 'templates', '*.rb'))].each do |template|
+            local.execute("cp '#{template}' '#{working_directory}/.gitpusshuten/#{template.split('/').last}'")
+          end
+          message "Git Pusshu Ten (プッシュ点) initialized in: #{y(working_directory)}!"
+        end
+      end
+
+    end
+  end
+end

data/lib/gitpusshuten/commands/push.rb

@@ -0,0 +1,54 @@
+module GitPusshuTen
+  module Commands
+    class Push < GitPusshuTen::Commands::Base
+      description "Pushes a branch, tag or ref to the specified environment."
+      usage       "push <command> <type> to <environment>"
+      example     "heavenly push branch develop to staging                                    # Pushes the specified branch to the staging environment."
+      example     "heavenly push tag 1.0.3 to staging                                         # Pushes the specified tag to the staging environment."
+      example     "heavenly push ref 2dbec02aa0b8604b8512e2fcbb8aac582c7f6a73 to production   # Pushes the specified ref to the production environment."
+
+      attr_accessor :type
+
+      def initialize(*objects)
+        super
+        perform_hooks!
+        
+        @command = cli.arguments.shift
+        @type    = cli.arguments.shift
+        
+        help if type.nil? or e.name.nil?
+        
+        set_remote!
+      end
+
+      ##
+      # Pushes the specified branch to the remote environment.
+      def perform_branch!
+        message "Pushing branch #{y(type)} to the #{y(e.name)} environment."
+        git.push(:branch, type).to(e.name)
+      end
+
+      ##
+      # Pushes the specified tag to the remote environment.
+      def perform_tag!
+        message "Pushing tag #{y(type)} to the #{y(e.name)} environment."
+        git.push(:tag, type).to(e.name)
+      end
+
+      ##
+      # Pushes the specified ref to the remote environment.
+      def perform_ref!
+        message "Pushing ref #{y(type)} to the #{y(e.name)} environment."
+        git.push(:ref, type).to(e.name)
+      end
+
+      ##
+      # Adds the remote
+      def set_remote!
+        git.remove_remote(e.name) if git.has_remote?(e.name)
+        git.add_remote(e.name, "ssh://#{c.user}@#{c.ip}:#{c.port}/#{e.app_dir}")
+      end
+
+    end
+  end
+end

data/lib/gitpusshuten/commands/remote.rb

@@ -0,0 +1,29 @@
+module GitPusshuTen
+  module Commands
+    class Remote < GitPusshuTen::Commands::Base
+      description "Performs a command on the remote server for the specified environment from the application root."
+      usage       "remote command on <environment> '<command>'"
+      example     "heavenly remote command on staging 'cat log/production.log'                # Invokes 'cat log/production.log' in the staging environment."
+      example     "heavenly remote command on production 'mkdir tmp; touch tmp/restart.txt'   # Invokes 'mkdir tmp; touch tmp/restart.txt' in the production environment."
+
+      attr_accessor :command_to_execute
+
+      def initialize(*objects)
+        super
+                
+        @command = cli.arguments.shift if cli.arguments.any?
+        @command_to_execute = cli.arguments.join(' ') if cli.arguments.any?
+        
+        help if command.nil? or command_to_execute.nil? or e.name.nil?
+      end
+
+      ##
+      # Performs a unix command on the remote server
+      def perform_command!
+        message "Performing command on #{y(c.application)} (#{y(e.name)}) at #{y(c.ip)}!"
+        puts e.execute_as_user("cd #{e.app_dir}; #{command_to_execute}")
+      end
+
+    end
+  end
+end

data/lib/gitpusshuten/commands/user.rb

@@ -0,0 +1,252 @@
+module GitPusshuTen
+  module Commands
+    class User < GitPusshuTen::Commands::Base
+      description "Interacts with users, based on the <app_root>/.gitpusshuten/config.rb file."
+      usage       "user <command> (to|for|from|on) <environment>"
+      example     "heavenly user add to production                # Sets up the user on the remote server for production."
+      example     "heavenly user reconfigure for production       # Reconfigures the user without removing applications."
+      example     "heavenly user remove from production           # Removes the user and all it's applications."
+      example     "heavenly user install-ssh-key to staging       # Installs your ssh key on the server for the user."
+      example     "heavenly user install-root-ssh-key to staging  # Installs your ssh key on the server for the root user."
+      example     "$(heavenly user login to staging)              # Logs the user in to the staging environment as user."
+      example     "$(heavenly user login-root to production)      # Logs the user in to the production environment as root."
+
+      def initialize(*objects)
+        super
+        
+        @command = cli.arguments.shift
+        
+        help if command.nil? or e.name.nil?
+        
+        @command = command.underscore
+      end
+      
+      ##
+      # Sets up a new UNIX user and configures it based on the .gitpusshuten/config.rb
+      def perform_add!
+        if not e.user_exists? # prompts root
+          ensure_git_installed!           
+          message "It looks like #{y(c.user)} does not yet exist."
+          message "Would you like to add #{y(c.user)} to #{y(c.application)} (#{y(c.ip)})?"
+          if yes?
+            message "Adding #{y(c.user)} to #{y(c.ip)}.."
+            if e.add_user!
+              message "Successfully added #{y(c.user)} to #{y(c.application)} (#{y(c.ip)})!"
+            else
+              error "Failed to add user #{y(c.user)} to #{y(c.application)} (#{y(c.ip)})."
+              error "An error occurred. Is your configuration file properly configured?"
+              exit
+            end
+          end
+        else
+          error "User #{y(c.user)} already exists."
+          error "If you want to remove this user, run the following command:"
+          standard "\n\s\s#{y("heavenly user remove from #{e.name}")}\n\n"
+          error "If you just want to reconfigure the user without removing it, run the following ommand:"
+          standard "\n\s\s#{(y("heavenly user reconfigure for #{e.name}"))}"
+          exit
+        end
+        
+        ##
+        # Configures the user
+        configure_user!
+        
+        ##
+        # Finished adding user!
+        message "Finished adding and configuring #{y(c.user)}!"
+        message "You should now be able to push your application to #{y(c.application)} at #{y(c.ip)}."
+      end
+
+      ##
+      # Removes the user and home directory
+      def perform_remove!
+        if e.user_exists?
+          warning "Are you #{y('SURE')} you want to remove #{y(c.user)}?"
+          warning "Doing so will also remove #{y(e.home_dir)}, in which the #{y('applications')} of #{y(c.user)} are."
+          if yes?
+            warning "Are you #{y('REALLY')} sure?"
+            if yes?
+              message "Removing user #{y(c.user)} from #{y(c.ip)}."
+              if e.remove_user!
+                e.execute_as_root("rm -rf '#{e.home_dir}'")
+                message "User #{y(c.user)} has been removed from #{y(c.ip)}."
+              else
+                error "Failed to remove user #{y(c.user)} from #{y(c.ip)}."
+                error "An error occurred. Is your configuration file properly configured?"
+                exit
+              end
+            end
+          end
+        else
+          error "User #{y(c.user)} does not exist at #{y(c.ip)}."
+        end
+      end
+
+      ##
+      # Reconfigures the user without removing it or any applications
+      def perform_reconfigure!
+        if e.user_exists? # prompts root
+          configure_user!
+        else
+          error "User #{y(c.user)} does not exist at #{y(c.ip)}."
+          error "If you want to add #{y(c.user)}, run the following command:"
+          standard "\n\s\s#{y("heavenly user add to #{e.name}")}"
+        end
+      end
+
+      ##
+      # Returns a string which can be used to login the user
+      def perform_login!
+        if not e.user_exists?
+          error "Cannot login, #{y(c.user)} does not exist."
+          exit
+        end
+        
+        puts "ssh #{c.user}@#{c.ip} -p #{c.port}"
+      end
+
+      ##
+      # Returns a string which can be used to login as root
+      def perform_login_root!
+        puts "ssh root@#{c.ip} -p #{c.port}"
+      end
+
+      ##
+      # Installs the ssh key for the application user
+      def perform_install_ssh_key!
+        unless e.has_ssh_key?
+          error "Could not find ssh key in #{y(e.ssh_key_path)}"
+          error "To create one, run: #{y('ssh-keygen -t rsa')}"
+          exit
+        end
+        
+        unless e.ssh_key_installed? # prompts root
+          Spinner.return :message => "Installing SSH Key.." do
+            e.install_ssh_key!
+            g("Done!")
+          end
+        else
+          message "Your ssh has already been installed for #{y(c.user)} at #{y(c.ip)}."
+        end
+      end
+
+      ##
+      # Installs the ssh key for the root user
+      def perform_install_root_ssh_key!
+        unless e.has_ssh_key?
+          error "Could not find ssh key in #{y(e.ssh_key_path)}"
+          error "To create one, run: #{y('ssh-keygen -t rsa')}"
+          exit
+        end
+        
+        unless e.root_ssh_key_installed? # prompts root
+          Spinner.return :message => "Installing SSH Key.." do
+            e.install_root_ssh_key!
+            g("Done!")
+          end
+        else
+          message "Your ssh has already been installed for #{y('root')} at #{y(c.ip)}."
+        end
+      end
+
+      ##
+      # Ensures that Git is installed on the remote server
+      def ensure_git_installed!
+        if not e.installed?('git') #prompts root
+          warning "It is required that you have #{y('Git')} installed at #{y(c.ip)}."
+          warning "Could not find #{y('Git')}, would you like to install it?"
+          
+          if yes?
+            Spinner.return :message => "Installing #{y('Git')}.." do
+              e.install!('git-core')
+              @git_installed = e.installed?('git')
+              if @git_installed
+                g("Done!")
+              else
+                r("Unable to install Git.")
+              end
+            end
+            exit unless @git_installed
+          else
+            exit
+          end
+        end
+      end
+
+      ##
+      # Configures the user. Overwrites all current configurations (if any exist)
+      def configure_user!
+        message "Configuring #{y(c.user)}."
+        
+        ##
+        # If the user has an SSH key and it hasn't been installed
+        # on the server under the current user then it'll go ahead and install it
+        if e.has_ssh_key? and not e.ssh_key_installed?
+          perform_install_ssh_key!
+        end
+        
+        ##
+        # Configure .bashrc
+        Spinner.return :message => "Configuring #{y('.bashrc')}.." do
+          e.execute_as_root("echo -e \"export RAILS_ENV=production\nsource /etc/profile\" > '#{File.join(c.path, '.bashrc')}'")
+          g('Done!')
+        end
+        
+        ##
+        # Creating .gemrc
+        Spinner.return :message => "Configuring #{y('.gemrc')}.." do
+          e.download_packages!(e.home_dir)
+          e.execute_as_root("cd #{e.home_dir}; cat gitpusshuten-packages/modules/rvm/gemrc > .gemrc")
+          e.clean_up_packages!(e.home_dir)
+          g('Done!')
+        end
+        
+        ##
+        # Add user to sudoers file if not already in sudo'ers
+        if not e.user_in_sudoers?
+          Spinner.return :message => "Adding #{y(c.user)} to sudo-ers.." do
+            e.add_user_to_sudoers!
+            g('Done!')
+          end
+        end
+        
+        ##
+        # Checks to see if the RVM group exists.
+        # If it does exist, perform RVM specific tasks.
+        Spinner.return :message => "Searching for #{y('RVM')} (Ruby version Manager).." do
+          @rvm_found = e.directory?("/usr/local/rvm")
+          if @rvm_found
+            g("Found!")
+          else
+            y("Not found, skipping.")
+          end
+        end
+        if @rvm_found
+          Spinner.return :message => "Adding #{y(c.user)} to the #{y('RVM')} group.." do
+            e.execute_as_root("usermod -G rvm '#{c.user}'")
+            g('Done!')
+          end
+        end
+        
+        ##
+        # Installs the .gitconfig and minimum configuration
+        # if the configuration file does not exist.
+        Spinner.return :message => "Configuring #{y('Git')} for #{y(c.user)}." do
+          e.install_gitconfig!
+          e.install_pushand!
+          g('Done!')
+        end
+        
+        ##
+        # Ensure home directory ownership is set to the user
+        Spinner.return :message => "Setting permissions.." do
+          e.execute_as_root("chown -R #{c.user}:#{c.user} '#{e.home_dir}'")
+          g('Done!')
+        end
+        
+        message "Finished configuring #{y(c.user)}."
+      end
+
+    end
+  end
+end

data/lib/gitpusshuten/commands/version.rb

@@ -0,0 +1,21 @@
+# encoding: utf-8
+module GitPusshuTen
+  module Commands
+    class Version < GitPusshuTen::Commands::Base
+      description "Displays the current version of Git Pusshu Ten (プッシュ点)."
+
+      ##
+      # Initializes the Version command
+      def initialize(*objects)
+        super
+      end
+
+      ##
+      # Performs the Version command
+      def perform!
+        standard "Git Pusshu Ten (プッシュ点) version #{GitPusshuTen::VERSION}"
+      end
+
+    end
+  end
+end

data/lib/gitpusshuten/configuration.rb

@@ -0,0 +1,122 @@
+module GitPusshuTen
+  class Configuration
+
+    ##
+    # Contains the Application's name which is extracted from
+    # the selected configuration in the configuration file
+    attr_accessor :application
+
+    ##
+    # Contains the environment on the remote server name which
+    # is extracted from the selected configuration in the configuration file
+    attr_accessor :environment
+
+    ##
+    # Returns true if the configuration has been found
+    attr_accessor :found
+    alias :found? :found
+
+    ##
+    # Contains the user, password, passphrase, ip and port for connecting
+    # and authorizing the user to the remote server
+    attr_accessor :user, :password, :passphrase, :ip, :port
+
+    ##
+    # Contains the path to where the application should be pushed
+    attr_accessor :path
+
+    ##
+    # Contains a list of modules
+    attr_accessor :additional_modules
+
+    ##
+    # A flag to force the parsing
+    attr_accessor :force_parse
+
+    ##
+    # Configure
+    # helper method for the pusshuten configuration method
+    def configure
+      yield self
+    end
+
+    ##
+    # Modules
+    # Helper method for adding modules
+    def modules
+      yield self
+    end
+
+    ##
+    # Modules - Add
+    # Helper method for the Modules helper to add modules to the array
+    def add(module_object)
+      @additional_modules << module_object
+    end
+
+    ##
+    # Pusshuten
+    # Helper method used to configure the configuration file
+    def pusshuten(application, *environment, &block)
+      environment.flatten!
+      
+      environment.each do |env|
+        unless env.is_a?(Symbol)
+          GitPusshuTen::Log.error 'Please use symbols as environment name.'
+          exit
+        end
+      end
+      
+      if environment.include?(@environment) or force_parse
+        @application = application
+        @found       = true
+        block.call
+      end
+    end
+
+    ##
+    # Initializes a new configuration object
+    # takes the absolute path to the configuration file
+    def initialize(environment)
+      @environment = environment
+      @found       = false
+      @force_parse = false
+      
+      @additional_modules = []
+    end
+
+    ##
+    # Parses the configuration file and loads all the
+    # configuration values into the GitPusshuTen::Configuration instance
+    def parse!(configuration_file)
+      instance_eval(File.read(configuration_file))
+      
+      ##
+      # If no configuration is found by environment then
+      # it will re-parse it in a forced manner, meaning it won't
+      # care about the environment and it will just parse everything it finds.
+      # This is done because we can then extract all set "modules" from the configuration
+      # file and display them in the "Help" screen so users can look up information/examples on them.
+      #
+      # This will only occur if no environment is found/specified. So when doing anything
+      # environment specific, it will never force the parsing.
+      if not found? and environment.nil?
+        @force_parse = true
+        instance_eval(File.read(configuration_file))
+        @additional_modules.uniq!
+      end
+      
+      if not found? and not environment.nil?
+        GitPusshuTen::Log.error "Could not find any configuration for #{environment.to_s.color(:yellow)}."
+        exit
+      end
+      
+      ##
+      # Default to port 22 if no port is specified
+      @port ||= '22'
+      
+      self
+    end
+
+  end
+end

data/lib/gitpusshuten/environment.rb

@@ -0,0 +1,70 @@
+Dir[File.expand_path(File.dirname(__FILE__) + '/helpers/environment/*.rb')].each do |helper|
+  require helper
+end
+
+module GitPusshuTen
+  class Environment
+
+    include GitPusshuTen::Helpers::Environment::SCP
+    include GitPusshuTen::Helpers::Environment::SSH
+    include GitPusshuTen::Helpers::Environment::SSHKeys
+    include GitPusshuTen::Helpers::Environment::Packages
+    include GitPusshuTen::Helpers::Environment::User
+    include GitPusshuTen::Helpers::Environment::Installers
+    include GitPusshuTen::Helpers::Environment::SCP
+
+    ##
+    # Stores the configuration
+    attr_accessor :configuration
+
+    ##
+    # Initializes the environment with the provided configuration
+    def initialize(configuration)
+      @configuration = configuration
+    end
+
+    ##
+    # Shorthand for the configuration object
+    def c
+      configuration
+    end
+
+    ##
+    # Returns the name of the environment
+    def name
+      c.environment
+    end
+
+    ##
+    # Users home directory
+    def home_dir
+      c.path
+    end
+
+    ##
+    # Returns the name of the application
+    def app_name
+      c.application
+    end
+
+    ##
+    # Returns the root of the application
+    def app_dir
+      File.join(home_dir, "#{sanitized_app_name}.#{name}")
+    end
+
+    ##
+    # Takes the application name from the configuration and
+    # replaces spaces with underscores and downcases capitalized characters
+    def sanitized_app_name
+      app_name.gsub(' ', '_').downcase
+    end
+
+    ##
+    # Deletes the current environment (application)
+    def delete!
+      execute_as_user("rm -rf #{app_dir}")
+    end
+
+  end
+end

data/lib/gitpusshuten/gem.rb

@@ -0,0 +1,33 @@
+module GitPusshuTen
+  class Gem
+
+    ##
+    # Stores the JSON gem object from RubyGems.org
+    attr_accessor :gem
+
+    ##
+    # Instantiages a new gem
+    def initialize(name)
+      @gem = JSON.parse(open(File.join(base_url, "#{name}.json")).read)
+    end
+
+    ##
+    # Returns the latest version of the gem
+    def latest_version
+      gem['version']
+    end
+
+    ##
+    # Checks to see if the provided version number is outdated
+    def outdated?(version)
+      version < latest_version
+    end
+
+    ##
+    # Returns the base url to the RubyGems API
+    def base_url
+      "http://rubygems.org/api/v1/gems/"
+    end
+
+  end
+end