doorway 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3-p125-perf

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in doorway.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Felipe Coury
+
+MIT License
+
+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,84 @@
+# Doorway
+
+Sane set of utility methods to provision remote servers over SSH and SCP.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'doorway'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install doorway
+
+## Usage
+
+	doorway = Doorway.connect(:root, "10.0.1.20", :ssh_key => "~/.keys/somekey.pem")
+	doorway.exec "ls -la"
+	
+	# -or-
+	
+	Doorway.connect(:deployer, "10.0.1.20", :ssh_key => "~/.keys/deployer.pem") do |conn|
+	
+		# Raw command execution
+
+		conn.exec    "whoami"
+		conn.exec_as :root, "REALLY_GEM_UPDATE_SYSTEM=y gem update --system"
+	
+		# Script execution
+
+		conn.exec_script <<-EOS.strip_heredoc
+		
+			#!/bin/bash
+			apt-get install -y some-package
+		
+		EOS
+		
+		conn.exec_script_as :git, "scripts/add-public-ip"
+		
+		# Remote files
+
+		conn.remote_file "/etc/nginx/nginx.conf", "nginx/nginx.conf"
+		conn.remote_file "/etc/init.d/nginx", "nginx/nginx.init.d"
+		conn.append_from "/etc/nginx/nginx.conf", "nginx/include"
+
+		# ERB templates 
+		
+		conn.remote_file "/etc/nginx/conf.d/site.conf",
+			:template => "nginx/vhost.conf.erb",
+			:server   => "www.example.org",
+			:root     => "/var/www/example"
+			
+		conn.append_from "/etc/sudoers.d/my_sudoers",
+			:template => "sudoers/god.erb",
+			:user     => "fcoury",
+			:allow    => "/var/bin/all_your_base"
+			
+		# Download a file to server
+		
+		conn.get "https://webbynode_packages.s3.amazonaws.com/icecream-8.30.tar.gz", "/usr/local/src"
+		  
+		# Ubuntu specific package management
+
+		conn.add_ppa "chris-lea/node.js"
+		conn.install "nodejs"
+	
+		# Advanced commands
+		
+		conn.sed "/home/git/repo/.git/config", 
+			/remote "github"/, 'remote "bitbucket"'
+	end
+	
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/doorway.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "doorway/version"
+
+Gem::Specification.new do |s|
+  s.name          = "doorway"
+  s.version       = Doorway::Version::STRING
+  s.authors       = ["Felipe Coury"]
+  s.email         = ["felipe.coury@gmail.com"]
+  s.homepage      = "http://github.com/webbynode/doorway"
+  s.summary       = "Sane set of utility methods to provision remote servers over SSH and SCP."
+  s.description   = s.summary
+
+  s.add_development_dependency "rspec"          , "~> 2.11"
+  s.add_dependency "activesupport"              , "~> 3.0"
+  s.add_dependency "net-ssh"                    , "~> 2.5.2"
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+end

data/lib/doorway.rb

@@ -0,0 +1,20 @@
+require "active_support/core_ext/string/inflections"
+require "net/ssh"
+
+module Doorway
+  autoload :Version, "doorway/version"
+  autoload :Base, "doorway/base"
+
+  Dir[File.join(File.dirname(__FILE__), "doorway", "commands", "*.rb")].each do |f| 
+    require f
+  end
+
+  def self.connect(user, host, options={})
+    ssh  = Net::SSH.start(host, user.to_s, options)
+    conn = Doorway::Base.new(ssh)
+
+    yield conn if block_given?
+
+    conn
+  end
+end

data/lib/doorway/base.rb

@@ -0,0 +1,15 @@
+module Doorway
+  class Base
+    Dir[File.join(File.dirname(__FILE__), "commands", "*.rb")].each do |f|
+      command = File.basename(f)[/(.*)\.rb/, 1].camelize
+      module_name = "Doorway::#{command}"
+      self.send :include, module_name.constantize
+    end
+
+    attr_reader :conn
+
+    def initialize(conn)
+      @conn = conn
+    end
+  end
+end

data/lib/doorway/commands/exec.rb

@@ -0,0 +1,5 @@
+module Doorway::Exec
+  def exec(command)
+    conn.exec! command
+  end
+end

data/lib/doorway/commands/exec_as.rb

@@ -0,0 +1,9 @@
+module Doorway::ExecAs
+  def exec_as(user, command)
+    exec %Q[sudo -i -u #{user} bash -c "#{escape_chars(command)}"]
+  end
+
+  def escape_chars(command)
+    command.gsub('"', '\"').gsub('$', '\$')
+  end
+end

data/lib/doorway/commands/packages.rb

@@ -0,0 +1,15 @@
+module Doorway::Packages
+  def update_packages
+    exec_as :root, "apt-get update"
+  end
+
+  def install(package)
+    exec_as :root, 
+      "DEBIAN_FRONTEND=noninteractive apt-get install -y -q #{package}"
+  end
+
+  def add_ppa(ppa)
+    exec_as :root, "add-apt-repository ppa:#{ppa}"
+    update_packages
+  end
+end

data/lib/doorway/commands/remote_file.rb

@@ -0,0 +1,15 @@
+module Doorway::RemoteFile
+  def remote_file(remote, options)
+    if options.is_a?(Hash)
+      if template = options.delete(:template)
+        local = temp_from_template(template, options)
+      end
+    else
+      local = options
+    end
+
+    raise "You need to specify a local file or a template" unless local
+
+    conn.scp.upload! local, remote
+  end
+end

data/lib/doorway/template.rb

@@ -0,0 +1,33 @@
+require 'ostruct'
+require 'tempfile'
+
+module Template
+  def asset(name)
+    File.expand_path("../../../assets/#{name}", __FILE__)
+  end
+
+  def compile_template(template, vars)
+    contents = File.read asset(template)
+    struct = ErbBinding.new(vars)
+    ERB.new(contents).result(struct.send(:get_binding))
+  end
+
+  def create_from_template(file, template, vars={})
+    write_file file, compile_template(template, vars)
+  end
+
+  def temp_from_template(template, vars={})
+    tmp = Tempfile.new("doorway")
+    tmp.write compile_template(template, vars)
+  end
+
+  def write_file(file, contents)
+    File.open(file, 'w+') { |f| f.write contents }
+  end
+end
+
+class ErbBinding < OpenStruct
+  def get_binding
+    binding
+  end
+end

data/lib/doorway/version.rb

@@ -0,0 +1,5 @@
+module Doorway
+  module Version
+    STRING = "0.0.1"
+  end
+end

data/spec/doorway/base_spec.rb

@@ -0,0 +1,17 @@
+require 'spec_helper'
+
+describe Doorway::Base do
+  let(:ssh) { stub(:ssh) }
+
+  subject { Doorway::Base.new(ssh) }
+
+  its(:conn) { should == ssh }
+
+  describe "includes" do
+    it "includes all commands" do
+      subject.should be_kind_of(Doorway::Exec)
+      subject.should be_kind_of(Doorway::ExecAs)
+      subject.should be_kind_of(Doorway::RemoteFile)
+    end
+  end
+end

data/spec/doorway/commands/exec_as_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+
+describe Doorway::ExecAs do
+  include_context "command"
+
+  before { include_commands_from Doorway::ExecAs }
+
+  it "executes the command as the user" do
+    expected_command = %Q[sudo -i -u git bash -c "/etc/init.d/nginx stop"]
+    subject.should_receive(:exec).with(expected_command)
+    subject.exec_as :git, "/etc/init.d/nginx stop"
+  end
+
+  it "escapes double quotes" do
+    expected_command = %q[sudo -i -u git bash -c "echo \"something\" > ~/.bashrc"]
+    subject.should_receive(:exec).with(expected_command)
+    subject.exec_as :git, 'echo "something" > ~/.bashrc'
+  end
+
+  it "escapes dollar signs" do
+    expected_command = %q[sudo -i -u git bash -c "PATH=\$HOME/bin:\$PATH"]
+    subject.should_receive(:exec).with(expected_command)
+    subject.exec_as :git, 'PATH=$HOME/bin:$PATH'
+  end
+end

data/spec/doorway/commands/exec_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Doorway::Exec do
+  include_context "command"
+
+  before { include_commands_from Doorway::Exec }
+
+  it "executes the command as the default user" do
+    conn.should_receive(:exec!).with("command")
+    subject.exec "command"
+  end
+end

data/spec/doorway/commands/packages_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Doorway::Packages do
+  include_context "command"
+
+  before do
+    include_commands_from Doorway::Packages
+    subject.stub(:exec_as)
+  end
+
+  describe "#update_packages" do
+    it "updates the package list" do
+      subject.should_receive(:exec_as).with(:root, "apt-get update")
+      subject.update_packages
+    end
+  end
+
+  describe "#install" do
+    it "installs a package" do
+      subject.should_receive(:exec_as).
+        with(:root, 
+          "DEBIAN_FRONTEND=noninteractive apt-get install -y -q package")
+      subject.install "package"
+    end
+  end
+
+  describe "#add_ppa" do
+    before do
+      subject.stub(:update_packages)
+    end
+
+    it "executes the command as the default user" do
+      subject.should_receive(:exec_as).with(:root, "add-apt-repository ppa:ppa")
+      subject.add_ppa "ppa"
+    end
+
+    it "updates the packages" do
+      subject.should_receive(:update_packages)      
+      subject.add_ppa "ppa"
+    end
+  end
+end

data/spec/doorway/commands/remote_file_spec.rb

@@ -0,0 +1,54 @@
+require 'spec_helper'
+
+describe Doorway::RemoteFile do
+  include_context "command"
+
+  before do
+    include_commands_from Doorway::RemoteFile
+  end
+  
+  context "with a local file" do
+    it "uploads the file" do
+      scp.should_receive(:upload!).with('local', 'remote')
+      subject.remote_file 'remote', 'local'
+    end
+  end
+
+  context "with a template" do
+    before do
+      subject.stub(:temp_from_template => '/dir/temp')
+    end
+
+    it "creates a tempfile from the template" do
+      subject.should_receive(:temp_from_template).
+        with('nginx/vhost.conf.erb', hash_including(
+          :server   => 'www.example.org',
+          :root     => '/var/www/example'
+        )).
+        and_return('/path/to/temp')
+
+      subject.remote_file '/etc/nginx/conf.d/site.conf', 
+        :template => 'nginx/vhost.conf.erb',
+        :server   => 'www.example.org',
+        :root     => '/var/www/example'
+    end
+
+    it "uploads the tempfile" do
+      scp.should_receive(:upload!).with('/dir/temp', 
+        '/etc/nginx/conf.d/site.conf')
+
+      subject.remote_file '/etc/nginx/conf.d/site.conf', 
+        :template => 'nginx/vhost.conf.erb',
+        :server   => 'www.example.org',
+        :root     => '/var/www/example'      
+    end
+  end
+
+  context "with no template or local file" do
+    it "raises an error" do
+      expect do
+        subject.remote_file('file', :a => :b)
+      end.to raise_error
+    end
+  end
+end

data/spec/doorway/template_spec.rb

@@ -0,0 +1,82 @@
+require './lib/doorway/template'
+
+describe Template do
+  subject { Class.new { include Template }.new }
+
+  describe "#asset" do
+    it "maps to the template path" do
+      expected = File.expand_path("../../../assets/path/file", __FILE__)
+      expect(subject.asset("path/file")).to eql(expected)
+    end
+  end
+
+  describe '#compile_template' do
+    it "returns the string for the template" do
+      asset = subject.asset('vhosts/nginx/rails3.erb')
+      File.should_receive(:read).with(asset).
+        and_return('abcdef <%= app.name %> <%= app.path %>')
+
+      app = stub(
+        :name    => 'app1',
+        :path    => '/var/app/app1',
+        :domain  => 'webby.com',
+        :alaises => 'app2.webby.com app3.webby.com'
+      )
+      
+      result = subject.compile_template('vhosts/nginx/rails3.erb', 
+        { :app => app })
+      result.should == "abcdef app1 /var/app/app1"
+    end
+  end
+
+  describe '#create_from_template' do
+    before do
+      subject.stub(:write_file)
+    end
+
+    it "compiles the template" do
+      subject.should_receive(:compile_template).with('template', {})
+      subject.create_from_template 'file', 'template'
+    end
+
+    it "writes the file with compiled template" do
+      subject.stub(:compile_template => 'contents')
+      subject.should_receive(:write_file).with('file', 'contents')
+      subject.create_from_template 'file', 'template'
+    end
+  end
+
+  describe '#write_file' do
+    it "writes the file" do
+      file = stub(:file)
+      File.should_receive(:open).with('file', 'w+').and_yield(file)
+      file.should_receive(:write).with('contents')
+      subject.write_file 'file', 'contents'
+    end
+  end
+
+  describe "#temp_from_template" do
+    let(:tmp) { stub(:tmp).as_null_object }
+
+    before do
+      subject.stub(:compile_template => 'contents')
+      Tempfile.stub(:new => tmp)
+    end
+
+    it "creates a tempfile" do
+      Tempfile.should_receive(:new).with("doorway").and_return(tmp)
+      expect(subject.temp_from_template("template", :a => :b)).to eql(tmp)
+    end
+
+    it "compiles the template" do
+      subject.should_receive(:compile_template).with("template", :a => :b).
+        and_return("temp_contents")
+      subject.temp_from_template("template", :a => :b)
+    end
+
+    it "writes the result of the template to the tempfile" do
+      tmp.should_receive(:write).with('contents')
+      subject.temp_from_template("template", :a => :b)
+    end
+  end
+end

data/spec/doorway_spec.rb

@@ -0,0 +1,38 @@
+require './lib/doorway'
+require './lib/doorway/base'
+
+describe Doorway do
+  let(:ssh)       { stub(:ssh)  }
+  let(:ssh_conn)  { stub(:ssh_conn) }
+  let(:conn)      { stub(:conn) }
+
+  subject { Doorway }
+
+  before do
+    stub_const("Net::SSH", ssh)
+    Net::SSH.stub(:start => ssh_conn)
+  end
+
+  describe "#connect" do
+    it "creates a new SSH connection" do
+      Net::SSH.should_receive(:start).with("host", "root", hash_including(
+        :password => "password",
+        :port     => 389
+      ))
+      subject.connect(:root, "host", :password => "password", :port => 389)
+    end
+
+    it "creates a new connection" do
+      Doorway::Base.should_receive(:new).with(ssh_conn).and_return(conn)
+      subject.connect(:root, "host")
+    end
+
+    it "yields the connection if block given" do
+      yielded = false
+      subject.connect(:root, "host") do |conn|
+        yielded = conn.is_a?(Doorway::Base)
+      end
+      fail "block not raised or connection not of expected type" unless yielded
+    end
+  end
+end

data/spec/shared/command_context.rb

@@ -0,0 +1,19 @@
+shared_context "command" do
+  let(:conn) { stub(:conn).as_null_object }
+  let(:scp)  { stub(:scp).as_null_object  }
+
+  class Subject; end
+
+  subject do
+    Subject.new
+  end
+
+  def include_commands_from(base)
+    Subject.send :include, base
+  end
+
+  before do
+    subject.stub(:conn => conn)
+    conn.stub(:scp => scp)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require "bundler"
+Bundler.setup(:default, :development)
+Bundler.require(:default, :development)
+
+require "doorway"
+
+Dir[File.dirname(__FILE__) + "/support/**/*.rb"].each {|file| require file}
+Dir[File.dirname(__FILE__) + "/shared/**/*.rb"].each {|file| require file}

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: doorway
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Felipe Coury
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.2
+description: Sane set of utility methods to provision remote servers over SSH and
+  SCP.
+email:
+- felipe.coury@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- doorway.gemspec
+- lib/doorway.rb
+- lib/doorway/base.rb
+- lib/doorway/commands/exec.rb
+- lib/doorway/commands/exec_as.rb
+- lib/doorway/commands/packages.rb
+- lib/doorway/commands/remote_file.rb
+- lib/doorway/template.rb
+- lib/doorway/version.rb
+- spec/doorway/base_spec.rb
+- spec/doorway/commands/exec_as_spec.rb
+- spec/doorway/commands/exec_spec.rb
+- spec/doorway/commands/packages_spec.rb
+- spec/doorway/commands/remote_file_spec.rb
+- spec/doorway/template_spec.rb
+- spec/doorway_spec.rb
+- spec/shared/command_context.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep
+homepage: http://github.com/webbynode/doorway
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.21
+signing_key: 
+specification_version: 3
+summary: Sane set of utility methods to provision remote servers over SSH and SCP.
+test_files:
+- spec/doorway/base_spec.rb
+- spec/doorway/commands/exec_as_spec.rb
+- spec/doorway/commands/exec_spec.rb
+- spec/doorway/commands/packages_spec.rb
+- spec/doorway/commands/remote_file_spec.rb
+- spec/doorway/template_spec.rb
+- spec/doorway_spec.rb
+- spec/shared/command_context.rb
+- spec/spec_helper.rb
+- spec/support/.gitkeep