remote 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+.rvmrc
+*~
+.DS_Store

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rico Sta. Cruz
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+Remote
+======
+
+SSH helpers.
+
+Getting started
+---------------
+
+First, install it.
+
+    gem install remote
+
+Then, create a sample config file.
+
+    remote --sample
+
+This generates a file called `remotes.yml`. Edit this sample file. (Tip: you can also put this in `config/remotes.yml` -- useful for Rails/Sinatra projects.)
+
+    # remotes.yml
+    live:
+      host: foo.mysite.com
+      user: app
+      key: ~/.ssh/id_rsa
+      path: /home/app/myapp
+
+Now, you may easily run commands on your given servers.
+
+    remote live rake db:migrate
+    # Equivalent of running `ssh -i ~/.ssh/id_rsa app@foo.mysite.com -- rake db:migrate`
+
+Going further
+-------------
+
+You may even define aliases for complicated commands.
+
+    # remotes.yml
+    live:
+      host: foo.mysite.com
+      commands:
+        deploy: |
+          git pull
+          thin -C config/thin.yml restart
+          rake cdn:propogate
+          echo Deployed new version `rake app:version`
+
+You may then run it easily with one command:
+
+    remote live deploy
+    # Runs the deploy script you've defined in the config file
+
+You may also define aliases than take arguments.
+
+    # remotes.yml
+    live:
+      host: foo.mysite.com
+      commands:
+        thor: env RACK_ENV=production rake %s
+
+So then you may:
+
+    remote live rake app:version 
+    # Executes 'env RACK_ENV=production rake app:version' on the remote server
+     
+Using in Ruby
+-------------
+
+    require 'remote'
+
+    r = Remote::App.new
+    r = Remote::App.new(:config => 'servers.yml')  # Optional
+
+    r.run 'live', 'ls'    # Same as 'remote live ls'
+    r.servers             #=> [<Server 'development'>, <Server 'production'>, ...]
+    r.write_sample        # same as 'remote --sample'
+
+    r = Remote::App.new(:console => true)
+    r.list    # Same as 'remote --list'
+    r.help    # Same as 'remote --help'

data/Rakefile

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "remote"
+    gem.summary = "Helpers to execute complex commands in multiple servers via SSH"
+    gem.description = "Remote lets you define a YAML config file with your servers and command aliases, and let you run them easily from the command line."
+    gem.email = "rico@sinefunc.com"
+    gem.homepage = "http://github.com/sinefunc/remote"
+    gem.authors = ["Rico Sta. Cruz"]
+    # gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end

data/bin/remote

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+prefix = File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib'))
+require "#{prefix}/remote"
+
+app = Remote::App.new :console => true
+
+if __FILE__ == $0
+  if ARGV.first == '--sample'
+    app.write_sample
+
+  elsif ARGV.first == "--list"
+    app.list
+
+  elsif ARGV.empty? or ARGV == ['-h'] or ARGV == ['--help'] or ARGV == ['-?']
+    cmd = File.basename($0)
+    app.help(cmd)
+
+  else
+    servers = ARGV.shift.to_s.split(',')
+    command = ARGV.join(' ')
+
+    app.run servers, *command
+  end
+end

data/lib/remote.rb

@@ -0,0 +1,7 @@
+module Remote
+  PREFIX = File.expand_path(File.join(File.dirname(__FILE__), 'remote'))
+
+  autoload :Server,  "#{PREFIX}/server"
+  autoload :App,     "#{PREFIX}/app"
+  autoload :Printer, "#{PREFIX}/printer"
+end

data/lib/remote/app.rb

@@ -0,0 +1,154 @@
+require 'yaml'
+
+module Remote
+  class App
+    def initialize(options={})
+      if options[:config]
+        @config_file = [options[:config]].flatten
+      end
+
+      self.extend Printer  if options[:console]
+    end
+
+    # Returns the config file location.
+    def config_file
+      config_file_locations.detect { |f| File.exists? (f) }
+    end
+
+    # Returns a list of where configuration files are expected to be present.
+    def config_file_locations
+      @config_file || ['config/remotes.yml', 'remotes.yml']
+    end
+
+    # Returns the configuration hash.
+    def config
+      verify_config
+      @config ||= YAML::load_file(config_file)
+    end
+
+    def servers
+      return @servers  unless @servers.nil?
+      @servers = Hash.new
+      config.each { |name, data| @servers[name] = Server.new(name, data) }
+      @servers
+    end
+
+    def list
+      servers.keys.each { |name| log "  #{name}" }
+    end
+
+    def run(to, *cmd)
+      verify_config
+      [to].flatten.each do |server_name|
+        svr = servers[server_name]
+        if svr.nil?
+          log "Unknown server '#{server_name}'. Available servers are:"
+          list
+          log "See #{config_file} for more information."
+          exit
+        end
+
+        command = svr.to_cmd(*cmd)
+        what = cmd.any? ? cmd.join(' ') : 'console'
+        status svr.to_s, what
+        system command
+      end
+    end
+
+    def write_sample
+      unless config_file.nil?
+        log "A configuration file already exists in #{config_file}."
+        return
+      end
+
+      fname = config_file_locations.last
+      begin
+        File.open(fname, 'w') { |f| f.write(sample_data) }
+        log "Created the file #{fname}."
+        log "Edit this file with your list of servers, then type 'remote <yourserver>' to try it out."
+      rescue => e
+        log "Error: unable to save to #{fname}."
+      end
+    end
+
+    def help(cmd='remote')
+      log "Usage: #{cmd} <server>"
+      log "       Opens a console session in the given server."
+      log ""
+      log "Usage: #{cmd} <server> <command>"
+      log "       Executes the given command in the given server."
+      log ""
+      log "Usage: remote <svr1>,<svr2> <command>"
+      log "       Executes the given command in multiple servers."
+      log ""
+      log "Usage: remote --list"
+      log "       Lists available servers."
+      log ""
+      log "Configuration"
+      log "-------------"
+      log ""
+      log "Servers are defined in a config file. Use `#{cmd} --sample` to"
+      log "create a sample config file."
+      log ""
+
+      if config_file.nil?
+        log "Config files are searched for in:"
+        log "  " + config_file_locations.join(", ")
+      else
+        log "Your configuration file is in #{config_file}."
+      end
+
+      log ""
+      log "Examples"
+      log "--------"
+      log ""
+      log "1) Executes 'irb -r./init' in the server called 'live'."
+      log "   #{cmd} live irb -r./init"
+      log ""
+      log "2) Starts a console for the 'live' server."
+      log "   #{cmd} live"
+      log ""
+    end
+
+  protected
+    def status(where, what)
+    end
+
+    def log(what)
+    end
+
+    def verify_config
+      if config_file.nil?
+        log "Error: no config file is present."
+        exit
+      end
+    end
+
+    def sample_data
+      <<-adios.gsub(/^ {6}/, '')
+        staging: &defaults
+          host: staging.myserver.com
+          # Everything below are optional.
+          user: rsc
+          path: /home/rsc/app/current
+          key: ~/.ssh/id_rsa.pub
+          commands:
+            # These are optional aliases.
+            # Typing 'remoter staging rake x' will execute this, with %s replaced by 'x'.
+            rake: 'bin/rake %s'
+
+            # Typing 'remoter staging deploy' will execute this script.
+            deploy: |
+              echo Deploying...
+              git pull
+              echo Done!
+
+        # This is an example of how to define another server via inheritance.
+        live:
+          <<: *defaults
+          path: /home/rsc/app
+          host: www.myserver.com
+      adios
+    end
+  end
+end

data/lib/remote/printer.rb

@@ -0,0 +1,14 @@
+module Remote
+module Printer
+  def log(str)
+    $stderr << "#{str}\n"
+  end
+
+  def status(where, what)
+    c1 = "\033[0;30m"
+    c2 = "\033[0;33m"
+    c0 = "\033[0m"
+    log "#{c1}[#{where}]$#{c2} #{what}#{c0}"
+  end
+end
+end

data/lib/remote/server.rb

@@ -0,0 +1,49 @@
+require 'ostruct'
+require 'shellwords'
+
+module Remote
+  class Server < OpenStruct
+    def initialize(name, data)
+      super data
+      self.host ||= name
+      self.commands ||= Hash.new
+    end
+
+    def to_s
+      host.to_s
+    end
+
+    # Construct an SSH command line for the given command.
+    def to_cmd(*what)
+      hostname = self.user.nil? ? self.host.to_s : "#{self.user}@#{self.host}"
+
+      cmd = [ "ssh", hostname ]
+      cmd << "-i #{self.key}" unless self.key.nil?
+
+      [ cmd.join(' '), translate(*what) ].compact.join(' -- ')
+    end
+
+    # Translates a given set of commands, taking into account aliases.
+    #
+    # translate('git pull', 'thor app:restart') #=> "cd ~/x; git pull; env RACK_ENV=production thor app:restart" 
+    def translate(*cmds)
+      return nil  if cmds.empty?
+
+      ret = []
+      ret << "cd #{self.path}"  unless self.path.nil?
+      cmds.each { |full_cmd| ret << translate_single(full_cmd) }
+      ret.flatten.compact.join(';').shellescape
+    end
+
+    # Translates a single command by resolving aliases.
+    def translate_single(full_cmd)
+      key, *args = full_cmd.split(' ')
+      command_alias = self.commands[key]
+      unless command_alias.nil?
+        command_alias.gsub("\n",';').gsub('%s', args.join(' '))
+      else
+        full_cmd
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: remote
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Rico Sta. Cruz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-26 00:00:00 +08:00
+default_executable: remote
+dependencies: []
+
+description: Remote lets you define a YAML config file with your servers and command aliases, and let you run them easily from the command line.
+email: rico@sinefunc.com
+executables: 
+- remote
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.md
+files: 
+- .gitignore
+- LICENSE
+- README.md
+- Rakefile
+- bin/remote
+- lib/remote.rb
+- lib/remote/app.rb
+- lib/remote/printer.rb
+- lib/remote/server.rb
+has_rdoc: true
+homepage: http://github.com/sinefunc/remote
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Helpers to execute complex commands in multiple servers via SSH
+test_files: []
+