tugboat 0.0.1

data/.gitignore

@@ -0,0 +1,12 @@
+*.gem
+*.rbc
+*~
+*.swp
+*.swo
+.bundle
+.rvmrc
+Gemfile.lock
+doc/*
+log/*
+pkg/*
+tmp/*

data/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jack Pearkes
+
+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,122 @@
+# Tugboat
+
+A command line tool for interacting with your [DigitalOcean](https://www.digitalocean.com/) droplets.
+
+## Installation
+
+    gem install tugboat
+
+## Configuration
+
+Run the configuration utility, `tugboat authorize`. You can grab your keys
+[here](https://www.digitalocean.com/api_access).
+
+    $ tugboat authorize
+    Enter your client key: foo
+    Enter your API key: bar
+    Enter your SSH key path (optional, defaults to ~/.ssh/id_rsa):
+    Enter your SSH user (optional, defaults to jack):
+    Authentication with DigitalOcean was successful!
+
+## Usage
+
+### Retrieve a list of your droplets
+
+    $ tugboat droplets
+    pearkes-web-001 (ip: 30.30.30.1, status: active, region: 1, id: 13231511)
+    pearkes-admin-001 (ip: 30.30.30.3, status: active, region: 1, id: 13231512)
+    pearkes-api-001 (ip: 30.30.30.5, status: active, region: 1, id: 13231513)
+
+### Fuzzy name matching
+
+You can pass a unique fragment of a droplets name for interactions
+throughout `tugboat`.
+
+    $ tugboat restart admin
+    Droplet fuzzy name provided. Finding droplet ID...done, 13231512 (pearkes-admin-001)
+    Queuing restart for 13231512 (pearkes-admin-001)...done
+
+tugboat handles multiple matches as well:
+
+    $ tugboat restart pearkes
+    Droplet fuzzy name provided. Finding droplet ID...Multiple droplets found.
+
+    0) pearkes-web-001  (13231511)
+    1) pearkes-admin-001 (13231512)
+    2) pearkes-api-001 (13231513)
+
+    Please choose a droplet: ["0", "1", "2"] 0
+    Queuing restart for 13231511 (pearkes-web-001)...done
+
+### SSH into a droplet
+
+You can configure a SSH username and key path in `tugboat authorize`.
+
+This lets you ssh into a droplet by providing it's name, or a partial
+match.
+
+    $ tugboat ssh admin
+    Droplet fuzzy name provided. Finding droplet ID...done, 13231512 (pearkes-admin-001)
+    Executing SSH (pearkes-admin-001)...
+    Welcome to Ubuntu 12.10 (GNU/Linux 3.5.0-17-generic x86_64)
+    pearkes@pearkes-admin-001:~#
+
+### Create a droplet
+
+    $ tugboat create pearkes-www-002 -s 64 -i 2676 -r 2
+    Queueing creation of droplet 'pearkes-www-002'...done
+
+### Info about a droplet
+
+    $ tugboat info admin
+    Droplet fuzzy name provided. Finding droplet ID...done, 13231512 (pearkes-admin-001)
+
+    Name:             pearkes-admin-001
+    ID:               13231512
+    Status:           active
+    IP:               30.30.30.3
+    Region ID:        1
+    Image ID:         25489
+    Size ID:          66
+    Backups Active:   false
+
+### Destroy a droplet
+
+    $ tugboat destroy pearkes-www-002
+    Droplet fuzzy name provided. Finding droplet ID...done, 13231515 (pearkes-www-002)
+    Warning! Potentially destructive action. Please confirm [y/n]: y
+    Queuing destroy for 13231515 (pearkes-www-002)...done
+
+### Restart a droplet
+
+    $ tugboat restart admin
+    Droplet fuzzy name provided. Finding droplet ID...done, 13231512 (pearkes-admin-001)
+    Queuing restart for 13231512 (pearkes-admin-001)...done
+
+### Shutdown a droplet
+
+    $ tugboat halt admin
+    Droplet fuzzy name provided. Finding droplet ID...done, 13231512 (pearkes-admin-001)
+    Queuing shutdown for 13231512 (pearkes-admin-001)...done
+
+### Snapshot a droplet
+
+    $ tugboat snapshot admin test-admin-snaphot
+    Queuing snapshot 'test' for 13231512 (pearkes-admin-001)...done
+
+## Help
+
+If you're curious about command flags for a specific command, you can
+ask tugboat about it.
+
+    $ tugboat help restart
+
+
+For a complete overview of all of the available commands, run:
+
+    $ tugboat help
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md).
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/tugboat

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "tugboat"
+
+Tugboat::CLI.start(ARGV)

data/lib/tugboat/cli.rb

@@ -0,0 +1,185 @@
+require 'thor'
+
+module Tugboat
+  autoload :Middleware, "tugboat/middleware"
+
+  class CLI < Thor
+    include Thor::Actions
+    ENV['THOR_COLUMNS'] = '120'
+
+    !check_unknown_options
+
+    desc "help [COMMAND]", "Describe commands or a specific command"
+    def help(meth=nil)
+      super
+      if !meth
+        say "To learn more or to contribute, please see github.com/pearkes/tugboat"
+      end
+    end
+
+    desc "authorize", "Authorize a DigitalOcean account with tugboat"
+    long_desc "This takes you through a workflow for adding configuration
+    details to tugboat. First, you are asked for your API and Client keys,
+    which are stored in ~/.tugboat.
+
+    You can retrieve your credentials from digitalocean.com/api_access.
+
+    Optionally, you can configure the default SSH key path and username
+    used for `tugboat ssh`. These default to '~/.ssh/id_rsa' and the
+    $USER environment variable.
+    "
+    def authorize
+      Middleware.sequence_authorize.call({})
+    end
+
+    desc "droplets", "Retrieve a list of your droplets"
+    def droplets
+      Middleware.sequence_list_droplets.call({})
+    end
+
+    desc "images", "Retrieve a list of your images"
+    method_option "global",
+                  :type => :boolean,
+                  :default => false,
+                  :aliases => "-g",
+                  :desc => "Show global images"
+    def images
+      Middleware.sequence_list_images.call({
+        "user_show_global_images" => options[:global],
+        })
+    end
+
+    desc "ssh FUZZY_NAME", "SSH into a droplet"
+    method_option "id",
+                  :type => :string,
+                  :aliases => "-i",
+                  :desc => "The ID of the droplet."
+    method_option "name",
+                  :type => :string,
+                  :aliases => "-n",
+                  :desc => "The exact name of the droplet"
+    def ssh(name=nil)
+      Middleware.sequence_ssh_droplet.call({
+        "user_droplet_id" => options[:id],
+        "user_droplet_name" => options[:name],
+        "user_droplet_fuzzy_name" => name
+      })
+    end
+
+    desc "create NAME", "Create a droplet."
+    method_option  "size",
+                   :type => :numeric,
+                   :aliases => "-s",
+                   :default => 64,
+                   :desc => "The size_id of the droplet"
+    method_option  "image",
+                   :type => :numeric,
+                   :aliases => "-i",
+                   :default => 2676,
+                   :desc => "The image_id of the droplet"
+    method_option  "region",
+                   :type => :numeric,
+                   :aliases => "-r",
+                   :default => 1,
+                   :desc => "The region_id of the droplet"
+    def create(name)
+      Middleware.sequence_create_droplet.call({
+        "create_droplet_size_id" => options[:size],
+        "create_droplet_image_id" => options[:image],
+        "create_droplet_region_id" => options[:region],
+        "create_droplet_name" => name
+      })
+    end
+
+    desc "destroy FUZZY_NAME", "Destroy a droplet"
+    method_option "id",
+                  :type => :string,
+                  :aliases => "-i",
+                  :desc => "The ID of the droplet."
+    method_option "name",
+                  :type => :string,
+                  :aliases => "-n",
+                  :desc => "The exact name of the droplet"
+    def destroy(name=nil)
+        Middleware.sequence_destroy_droplet.call({
+          "user_droplet_id" => options[:id],
+          "user_droplet_name" => options[:name],
+          "user_droplet_fuzzy_name" => name
+        })
+    end
+
+    desc "restart FUZZY_NAME", "Restart a droplet"
+    method_option "id",
+                  :type => :string,
+                  :aliases => "-i",
+                  :desc => "The ID of the droplet."
+    method_option "name",
+                  :type => :string,
+                  :aliases => "-n",
+                  :desc => "The exact name of the droplet"
+    def restart(name=nil)
+      Middleware.sequence_restart_droplet.call({
+        "user_droplet_id" => options[:id],
+        "user_droplet_name" => options[:name],
+        "user_droplet_fuzzy_name" => name
+      })
+    end
+
+    desc "halt FUZZY_NAME", "Shutdown a droplet"
+    method_option "id",
+                  :type => :string,
+                  :aliases => "-i",
+                  :desc => "The ID of the droplet."
+    method_option "name",
+                  :type => :string,
+                  :aliases => "-n",
+                  :desc => "The exact name of the droplet"
+    def halt(name=nil)
+        Middleware.sequence_halt_droplet.call({
+          "user_droplet_id" => options[:id],
+          "user_droplet_name" => options[:name],
+          "user_droplet_fuzzy_name" => name
+        })
+    end
+
+    desc "info FUZZY_NAME [OPTIONS]", "Show a droplet's information"
+    method_option "id",
+                  :type => :string,
+                  :aliases => "-i",
+                  :desc => "The ID of the droplet."
+    method_option "name",
+                  :type => :string,
+                  :aliases => "-n",
+                  :desc => "The exact name of the droplet"
+    def info(name=nil)
+        Middleware.sequence_info_droplet.call({
+          "user_droplet_id" => options[:id],
+          "user_droplet_name" => options[:name],
+          "user_droplet_fuzzy_name" => name
+        })
+    end
+
+    desc "snapshot FUZZY_NAME [OPTIONS]", "Queue a snapshot of the droplet."
+    method_option "id",
+                  :type => :string,
+                  :aliases => "-i",
+                  :desc => "The ID of the droplet."
+    method_option "name",
+                  :type => :string,
+                  :aliases => "-n",
+                  :desc => "The exact name of the droplet"
+    method_option "snapshot",
+                  :type => :string,
+                  :aliases => "-s",
+                  :desc => "The name of the snapshot"
+    def snapshot(name=nil, snapshot_name)
+        Middleware.sequence_snapshot_droplet.call({
+          "user_droplet_id" => options[:id],
+          "user_droplet_name" => options[:name],
+          "user_droplet_fuzzy_name" => name,
+          "user_snapshot_name" => snapshot_name
+        })
+    end
+  end
+end
+

data/lib/tugboat/config.rb

@@ -0,0 +1,76 @@
+require 'singleton'
+
+module Tugboat
+  # This is the configuration object. It reads in configuration
+  # from a .tugboat file located in the user's home directory
+
+  class Configuration
+    include Singleton
+    attr_reader :data
+    attr_reader :path
+
+    FILE_NAME = '.tugboat'
+    DEFAULT_SSH_KEY_PATH = '.ssh/id_rsa'
+
+    def initialize
+      @path = File.join(File.expand_path("~"), FILE_NAME)
+      @data = self.load_config_file
+    end
+
+    # If we can't load the config file, self.data is nil, which we can
+    # check for in CheckConfiguration
+    def load_config_file
+      require 'yaml'
+      YAML.load_file(@path)
+    rescue Errno::ENOENT
+      return
+    end
+
+    def client_key
+      @data['authentication']['client_key']
+    end
+
+    def api_key
+      @data['authentication']['api_key']
+    end
+
+    def ssh_key_path
+      @data['ssh']['ssh_key_path']
+    end
+
+    def ssh_user
+      @data['ssh']['ssh_user']
+    end
+
+    # Allow the path to be set.
+    def path=(path)
+      @path = path
+      path
+    end
+
+    # Re-runs initialize
+    def reset!
+      self.send(:initialize)
+    end
+
+    # Writes a config file
+    def create_config_file(client, api, ssh_key_path, ssh_user)
+      # Default SSH Key path
+      if ssh_key_path.empty?
+        ssh_key_path = File.join(File.expand_path("~"), DEFAULT_SSH_KEY_PATH)
+      end
+
+      if ssh_user.empty?
+        ssh_user = ENV['USER']
+      end
+
+      require 'yaml'
+      File.open(@path, File::RDWR|File::TRUNC|File::CREAT, 0600) do |file|
+        data = {"authentication" => { "client_key" => client, "api_key" => api },
+                "ssh" => { "ssh_user" => ssh_user, "ssh_key_path" => ssh_key_path }}
+        file.write data.to_yaml
+      end
+    end
+
+  end
+end

data/lib/tugboat/middleware/ask_for_credentials.rb

@@ -0,0 +1,21 @@
+module Tugboat
+  module Middleware
+    # Ask for user credentials from the command line, then write them out.
+    class AskForCredentials < Base
+      def call(env)
+        say "Note: You can get this information from digitalocean.com/api_access", :yellow
+        say
+        client_key = ask "Enter your client key:"
+        api_key = ask "Enter your API key:"
+        ssh_key_path = ask "Enter your SSH key path (optional, defaults to ~/.ssh/id_rsa):"
+        ssh_user = ask "Enter your SSH user (optional, defaults to #{ENV['USER']}):"
+
+        # Write the config file.
+        env['config'].create_config_file(client_key, api_key, ssh_key_path, ssh_user)
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/base.rb

@@ -0,0 +1,28 @@
+module Tugboat
+  module Middleware
+    # A base middleware class to initalize.
+    class Base
+      # Some colors for making things pretty.
+      CLEAR      = "\e[0m"
+      RED        = "\e[31m"
+      GREEN      = "\e[32m"
+      YELLOW     = "\e[33m"
+
+      # We want access to all of the fun thor cli helper methods,
+      # like say, yes?, ask, etc.
+      include Thor::Shell
+
+      def initialize(app)
+        @app = app
+        # This resets the color to "clear" on the user's terminal.
+        say "", :clear, false
+      end
+
+      def call(env)
+        @app.call(env)
+      end
+
+    end
+  end
+end
+

data/lib/tugboat/middleware/check_configuration.rb

@@ -0,0 +1,18 @@
+module Tugboat
+  module Middleware
+    # Check if the client has set-up configuration yet.
+    class CheckConfiguration < Base
+      def call(env)
+        config = env["config"]
+
+        if !config || !config.data || !config.api_key || !config.client_key
+          say "You must run `tugboat authorize` in order to connect to DigitalOcean", :red
+          return
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/check_credentials.rb

@@ -0,0 +1,24 @@
+require 'thor'
+
+module Tugboat
+  module Middleware
+    # Check if the client can connect to the ocean
+    class CheckCredentials < Base
+      def call(env)
+        # We use a harmless API call to check if the authentication will
+        # work.
+        begin
+          env["ocean"].droplets.list
+        rescue
+          say "Authentication with DigitalOcean failed. Run `tugboat authorize`", :red
+          return
+        end
+
+        say "Authentication with DigitalOcean was successful.", :green
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/confirm_action.rb

@@ -0,0 +1,18 @@
+module Tugboat
+  module Middleware
+    class ConfirmAction < Base
+      def call(env)
+        response = yes? "Warning! Potentially destructive action. Please confirm [y/n]:"
+
+        if !response
+          say "Aborted due to user request.", :red
+          # Quit
+          return
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/create_droplet.rb

@@ -0,0 +1,26 @@
+module Tugboat
+  module Middleware
+    class CreateDroplet < Base
+      def call(env)
+        ocean = env["ocean"]
+
+        say "Queueing creation of droplet '#{env["create_droplet_name"]}'...", nil, false
+
+        req = ocean.droplets.create :name   => env["create_droplet_name"],
+                                 :size_id   => env["create_droplet_size_id"],
+                                 :image_id  => env["create_droplet_image_id"],
+                                 :region_id => env["create_droplet_region_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/destroy_droplet.rb

@@ -0,0 +1,23 @@
+module Tugboat
+  module Middleware
+    class DestroyDroplet < Base
+      def call(env)
+        ocean = env["ocean"]
+
+        say "Queuing destroy for #{env["droplet_id"]} #{env["droplet_name"]}...", nil, false
+
+        req = ocean.droplets.delete 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
+