tugboat 0.0.1

data/lib/tugboat/middleware/find_droplet.rb

@@ -0,0 +1,112 @@
+module Tugboat
+  module Middleware
+    # Check if the client has set-up configuration yet.
+    class FindDroplet < Base
+      def call(env)
+        ocean = env["ocean"]
+        user_fuzzy_name = env['user_droplet_fuzzy_name']
+        user_droplet_name = env['user_droplet_name']
+        user_droplet_id = env['user_droplet_id']
+
+        # First, if nothing is provided to us, we should quit and
+        # let the user know.
+        if !user_fuzzy_name && !user_droplet_name && !user_droplet_id
+          say "Tugboat attempted to find a droplet with no arguments.", :red
+          return
+        end
+
+        # If you were to `tugboat restart foo -n foo-server-001` then we'd use
+        # 'foo-server-001' without looking up the fuzzy name.
+        #
+        # This is why we check in this order.
+
+        # Easy for us if they provide an id. Just set it to the droplet_id
+        if user_droplet_id
+          say "Droplet id provided. Finding Droplet...", nil, false
+          droplet = ocean.droplets.show user_droplet_id
+
+          env["droplet_id"] = droplet.id
+          env["droplet_name"] = "(#{droplet.name})"
+          env["droplet_ip"] = droplet.ip_address
+        end
+
+        # If they provide a name, we need to get the ID for it.
+        # This requires a lookup.
+        if user_droplet_name && !env["droplet_id"]
+          say "Droplet name provided. Finding droplet ID...", nil, false
+
+          # Look for the droplet by an exact name match.
+          ocean.droplets.list.droplets.each do |d|
+            if droplet.name == user_droplet_name
+              env["droplet_id"] = d.id
+              env["droplet_name"] = "(#{d.name})"
+              env["droplet_ip"] = d.ip_address
+            end
+          end
+
+          # If we coulnd't find it, tell the user and drop out of the
+          # sequence.
+          if !env["droplet_id"]
+            say "Unable to find a droplet named '#{user_droplet_name}'.", :red
+            return
+          end
+        end
+
+        # We only need to "fuzzy find" a droplet if a fuzzy name is provided,
+        # and we don't want to fuzzy search if an id or name is provided
+        # with a flag.
+        #
+        # This requires a lookup.
+        if user_fuzzy_name && !env["droplet_id"]
+          say "Droplet fuzzy name provided. Finding droplet ID...", nil, false
+
+          found_droplets = []
+          choices = []
+
+          ocean.droplets.list.droplets.each_with_index do |d, i|
+            # Check to see if one of the droplet names have the fuzzy string.
+            if d.name.include? user_fuzzy_name
+              found_droplets << d
+            end
+          end
+
+          # Check to see if we have more then one droplet, and prompt
+          # a user to choose otherwise.
+          if found_droplets.length == 1
+            env["droplet_id"] = found_droplets.first.id
+            env["droplet_name"] = "(#{found_droplets.first.name})"
+            env["droplet_ip"] = found_droplets.first.ip_address
+          elsif found_droplets.length > 1
+            # Did we run the multiple questionairre?
+            did_run_multiple = true
+
+            say "Multiple droplets found."
+            say
+            found_droplets.each_with_index do |d, i|
+              say "#{i}) #{d.name} (#{d.id})"
+              choices << i.to_s
+            end
+            say
+            choice = ask "Please choose a droplet:", :limited_to => choices
+            env["droplet_id"] = found_droplets[choice.to_i].id
+            env["droplet_name"] = found_droplets[choice.to_i].name
+            env["droplet_ip"] = found_droplets[choice.to_i].ip_address
+          end
+
+          # If we coulnd't find it, tell the user and drop out of the
+          # sequence.
+          if !env["droplet_id"]
+            say "error\nUnable to find a droplet named '#{user_fuzzy_name}'.", :red
+            return
+          end
+        end
+
+        if !did_run_multiple
+          say "done#{CLEAR}, #{env["droplet_id"]} #{env["droplet_name"]}", :green
+        end
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/halt_droplet.rb

@@ -0,0 +1,23 @@
+module Tugboat
+  module Middleware
+    class HaltDroplet < Base
+      def call(env)
+        ocean = env["ocean"]
+
+        say "Queuing shutdown for #{env["droplet_id"]} #{env["droplet_name"]}...", nil, false
+
+        req = ocean.droplets.shutdown env["droplet_id"]
+
+        if req.status == "ERROR"
+          say req.error_message, :red
+          return
+        end
+
+        say "done", :green
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/info_droplet.rb

@@ -0,0 +1,37 @@
+module Tugboat
+  module Middleware
+    class InfoDroplet < Base
+      def call(env)
+        ocean = env["ocean"]
+
+        req = ocean.droplets.show env["droplet_id"]
+
+        if req.status == "ERROR"
+          say "#{req.status}: #{req.error_message}", :red
+          return
+        end
+
+        droplet = req.droplet
+
+          if droplet.status == "active"
+            status_color = GREEN
+          else
+            status_color = RED
+          end
+
+        say
+        say "Name:             #{droplet.name}"
+        say "ID:               #{droplet.id}"
+        say "Status:           #{status_color}#{droplet.status}#{CLEAR}"
+        say "IP:               #{droplet.ip_address}"
+        say "Region ID:        #{droplet.region_id}"
+        say "Image ID:         #{droplet.image_id}"
+        say "Size ID:          #{droplet.size_id}"
+        say "Backups Active:   #{droplet.backups_active || false}"
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/inject_client.rb

@@ -0,0 +1,19 @@
+require 'digital_ocean'
+module Tugboat
+  module Middleware
+    # Inject the digital ocean client into the environment
+    class InjectClient < Base
+        def call(env)
+          # Sets the digital ocean client into the environment for use
+          # later.
+          env["ocean"]  = DigitalOcean::API.new \
+                             :client_id => env["config"].client_key,
+                             :api_key   => env["config"].api_key,
+                             :debug => ENV['DEBUG'] || false
+
+          @app.call(env)
+        end
+    end
+  end
+end
+

data/lib/tugboat/middleware/inject_configuration.rb

@@ -0,0 +1,16 @@
+module Tugboat
+  module Middleware
+    # Check if the client has set-up configuration yet.
+    class InjectConfiguration < Base
+      def call(env)
+        config = Tugboat::Configuration.instance
+        config.reset!
+
+        env["config"] = config
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/list_droplets.rb

@@ -0,0 +1,24 @@
+module Tugboat
+  module Middleware
+    # Check if the client has set-up configuration yet.
+    class ListDroplets < Base
+      def call(env)
+        ocean = env["ocean"]
+
+        ocean.droplets.list.droplets.each do |droplet|
+
+          if droplet.status == "active"
+            status_color = GREEN
+          else
+            status_color = RED
+          end
+
+          say "#{droplet.name} (ip: #{droplet.ip_address}, status: #{status_color}#{droplet.status}#{CLEAR}, region: #{droplet.region_id}, id: #{droplet.id})"
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/list_images.rb

@@ -0,0 +1,29 @@
+module Tugboat
+  module Middleware
+    class ListImages < Base
+      def call(env)
+        ocean = env["ocean"]
+        my_images = ocean.images.list :filter => "my_images"
+        if env["user_show_global_images"]
+          global = ocean.images.list :filter => "global"
+        end
+
+        say "My Images:"
+        my_images.images.each do |image|
+          say "#{image.name} (id: #{image.id}, distro: #{image.distribution})"
+        end
+
+        if env["user_show_global_images"]
+          say
+          say "Global Images:"
+          global.images.each do |image|
+            say "#{image.name} (id: #{image.id}, distro: #{image.distribution})"
+          end
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/restart_droplet.rb

@@ -0,0 +1,23 @@
+module Tugboat
+  module Middleware
+    class RestartDroplet < Base
+      def call(env)
+        ocean = env["ocean"]
+
+        say "Queuing restart for #{env["droplet_id"]} #{env["droplet_name"]}...", nil, false
+
+        req = ocean.droplets.reboot env["droplet_id"]
+
+        if req.status == "ERROR"
+          say "#{req.status}: #{req.error_message}", :red
+          return
+        end
+
+        say "done", :green
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/snapshot_droplet.rb

@@ -0,0 +1,25 @@
+module Tugboat
+  module Middleware
+    class SnapshotDroplet < Base
+      def call(env)
+        ocean = env["ocean"]
+
+        say "Queuing snapshot '#{env["user_snapshot_name"]}' for #{env["droplet_id"]} #{env["droplet_name"]}...", nil, false
+
+        # Temporary
+        req = ocean.droplets.snapshot env["droplet_id"],
+                                :name => env["user_snapshot_name"]
+
+        if req.status == "ERROR"
+          say "#{req.status}: #{req.error_message}", :red
+          return
+        end
+
+        say "done", :green
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/ssh_droplet.rb

@@ -0,0 +1,26 @@
+module Tugboat
+  module Middleware
+    class SSHDroplet < Base
+      def call(env)
+        say "Executing SSH #{env["droplet_name"]}..."
+
+        options = [
+          "-o", "IdentitiesOnly=yes",
+          "-o", "LogLevel=ERROR",
+          "-o", "StrictHostKeyChecking=no",
+          "-o", "UserKnownHostsFile=/dev/null",
+          "-i", env["config"].ssh_key_path.to_s]
+
+        host_string = "#{env["config"].ssh_user}@#{env["droplet_ip"]}"
+
+        options << host_string
+
+
+        Kernel.exec("ssh", *options)
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware.rb

@@ -0,0 +1,132 @@
+require "middleware"
+
+module Tugboat
+  module Middleware
+    autoload :Base, "tugboat/middleware/base"
+    autoload :InjectConfiguration, "tugboat/middleware/inject_configuration"
+    autoload :CheckConfiguration, "tugboat/middleware/check_configuration"
+    autoload :AskForCredentials, "tugboat/middleware/ask_for_credentials"
+    autoload :InjectClient, "tugboat/middleware/inject_client"
+    autoload :CheckCredentials, "tugboat/middleware/check_credentials"
+    autoload :ListDroplets, "tugboat/middleware/list_droplets"
+    autoload :FindDroplet, "tugboat/middleware/find_droplet"
+    autoload :RestartDroplet, "tugboat/middleware/restart_droplet"
+    autoload :HaltDroplet, "tugboat/middleware/halt_droplet"
+    autoload :InfoDroplet, "tugboat/middleware/info_droplet"
+    autoload :SSHDroplet, "tugboat/middleware/ssh_droplet"
+    autoload :CreateDroplet, "tugboat/middleware/create_droplet"
+    autoload :DestroyDroplet, "tugboat/middleware/destroy_droplet"
+    autoload :ConfirmAction, "tugboat/middleware/confirm_action"
+    autoload :SnapshotDroplet, "tugboat/middleware/snapshot_droplet"
+    autoload :ListImages, "tugboat/middleware/list_images"
+
+    # This takes the user through the authorization flow
+    def self.sequence_authorize
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use AskForCredentials
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use CheckCredentials
+      end
+    end
+
+    # This provides a list of droplets
+    def self.sequence_list_droplets
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use ListDroplets
+      end
+    end
+
+    # This provides a list of droplets
+    def self.sequence_list_images
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use ListImages
+      end
+    end
+
+    # This restarts a droplet
+    def self.sequence_restart_droplet
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use FindDroplet
+        use RestartDroplet
+      end
+    end
+
+    # This halts a droplet
+    def self.sequence_halt_droplet
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use FindDroplet
+        use HaltDroplet
+      end
+    end
+
+    # This shows a droplet
+    def self.sequence_info_droplet
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use FindDroplet
+        use InfoDroplet
+      end
+    end
+
+    # SSH Into a droplet
+    def self.sequence_ssh_droplet
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use FindDroplet
+        use SSHDroplet
+      end
+    end
+
+    # SSH Into a droplet
+    def self.sequence_create_droplet
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use CreateDroplet
+      end
+    end
+
+    # SSH Into a droplet
+    def self.sequence_destroy_droplet
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use FindDroplet
+        use ConfirmAction
+        use DestroyDroplet
+      end
+    end
+
+    # SSH Into a droplet
+    def self.sequence_snapshot_droplet
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use FindDroplet
+        use SnapshotDroplet
+      end
+    end
+  end
+end

data/lib/tugboat/version.rb

@@ -0,0 +1,3 @@
+module Tugboat
+  VERSION = "0.0.1"
+end

data/lib/tugboat.rb

@@ -0,0 +1,6 @@
+require 'tugboat/cli'
+require "tugboat/config"
+require "tugboat/version"
+
+module Tugboat
+end

data/spec/config_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Tugboat::Configuration do
+  let(:tmp_path)             { project_path + "/tmp/tugboat" }
+
+  after :each do
+    # Clean up the temp file.
+    File.delete(project_path + "/tmp/tugboat") if File.exist?(project_path + "/tmp/tugboat")
+  end
+
+  it "is a singleton" do
+    expect(Tugboat::Configuration).to be_a Class
+    expect do
+      Tugboat::Configuration.new
+    end.to raise_error(NoMethodError, /private method `new' called/)
+  end
+
+  it "has a data attribute" do
+    config = Tugboat::Configuration.instance
+    expect(config.data).to be
+  end
+
+  it "can set a path" do
+    config = Tugboat::Configuration.instance
+    config.path = tmp_path
+    expect(config.path).to equal(tmp_path)
+  end
+
+  it "properly resets path" do
+    config = Tugboat::Configuration.instance
+    config.path = tmp_path
+    config.reset!
+    expect(config.path).to eq(File.join(File.expand_path("~"), '.tugboat'))
+  end
+
+  describe "the file" do
+    let(:client_key)       { "foo" }
+    let(:api_key)          { "bar" }
+    let(:ssh_user)         { "baz" }
+    let(:ssh_key_path)     { "~/.ssh/id_rsa2.pub" }
+
+    let(:config)           { config = Tugboat::Configuration.instance }
+
+    before :each do
+      # Create a temporary file
+      config.path = tmp_path
+      config.create_config_file(client_key, api_key, ssh_key_path, ssh_user)
+    end
+
+    it "can be created" do
+      expect(File.exist?(tmp_path)).to be_true
+    end
+
+    it "can be loaded" do
+      data = config.load_config_file
+      expect(data).to_not be_nil
+    end
+
+    describe "the file format"
+      let(:data)  { YAML.load_file(tmp_path) }
+
+      it "should have authentication at the top level" do
+        expect(data).to have_key("authentication")
+      end
+
+      it "should have ssh at the top level" do
+        expect(data).to have_key("ssh")
+      end
+
+      it "should have a client key" do
+        auth = data["authentication"]
+        expect(auth).to have_key("client_key")
+      end
+
+      it "should have an api key" do
+        auth = data["authentication"]
+        expect(auth).to have_key("api_key")
+      end
+
+      it "should have an ssh key path" do
+        ssh = data["ssh"]
+        expect(ssh).to have_key("ssh_key_path")
+      end
+
+      it "should have an ssh user" do
+        ssh = data["ssh"]
+        expect(ssh).to have_key("ssh_user")
+      end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'tugboat'
+
+RSpec.configure do |config|
+  # Pretty tests
+  config.color_enabled = true
+end
+
+def project_path
+  File.expand_path("../..", __FILE__)
+end
+

data/tugboat.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'tugboat/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "tugboat"
+  gem.version       = Tugboat::VERSION
+  gem.authors       = ["Jack Pearkes"]
+  gem.email         = ["jackpearkes@gmail.com"]
+  gem.description   = %q{A command line tool for interacting with your DigitalOcean droplets.}
+  gem.summary       = %q{A command line tool for interacting with your DigitalOcean droplets.}
+  gem.homepage      = "https://github.com/pearkes/tugboat"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency "thor", "~> 0.18.1"
+  gem.add_dependency "digital_ocean", "~> 1.0.1"
+  gem.add_dependency "middleware" , "~> 0.1.0"
+  gem.add_dependency "activesupport"
+end