tugboat 0.0.3 → 0.0.4

data/.gitignore

@@ -9,4 +9,3 @@ Gemfile.lock
 doc/*
 log/*
 pkg/*
-tmp/*

data/CHANGELOG.md

@@ -0,0 +1,30 @@
+## 0.0.4 (unreleased)
+
+BUG FIXES:
+
+  - Fix a syntax error caused by the order of arguments on `snapshot`.
+  This changes the argument order and is a breaking change [GH-10].
+  - Fix an issue with looking up a droplet by it's `--name`. A variable
+  was changed, and because it was shadowed passed inspection.
+
+IMPROVEMENTS:
+
+  - Added a warning for snapshotting a droplet in a non-powered off
+  state. DigitalOcean currently doesn't return an error from their API.
+  - Added a `--confirm` or `-c` to confirmed actions, like destroy. [GH-7]
+  - [Ørjan](https://github.com/blom) added a `--version` command to see
+  what version of Tugboat you're using.
+  - Substantially more test coverage - all of the commands (except `ssh` are
+  now unit tested. [GH-15]
+
+FEATURES:
+
+   - Optionally add a list of ssh_key_ids when creating a droplet. These
+   SSH keys will automatically be added to your droplet.
+   - Show a list of SSH keys on your account with `tugboat keys`
+  - [Phil](https://github.com/PhilETaylor) added the ability to specify
+  an `--ssh-port` on `tugboat ssh`, as well as set a default in your `.tugboat` [GH-13]
+
+## 0.0.3 (April 15, 2013)
+
+Initial release.

data/README.md

@@ -1,4 +1,5 @@
 # Tugboat
+[![Build Status](https://travis-ci.org/pearkes/tugboat.png?branch=master)](https://travis-ci.org/pearkes/tugboat)
 
 A command line tool for interacting with your [DigitalOcean](https://www.digitalocean.com/) droplets.
 
@@ -50,7 +51,8 @@ tugboat handles multiple matches as well:
 
 ### SSH into a droplet
 
-You can configure a SSH username and key path in `tugboat authorize`.
+*You can configure an SSH username and key path in `tugboat authorize`,
+or by changing your `~/.tugboat`.*
 
 This lets you ssh into a droplet by providing it's name, or a partial
 match.
@@ -63,7 +65,7 @@ match.
 
 ### Create a droplet
 
-    $ tugboat create pearkes-www-002 -s 64 -i 2676 -r 2
+    $ tugboat create pearkes-www-002 -s 64 -i 2676 -r 2 -k 11251
     Queueing creation of droplet 'pearkes-www-002'...done
 
 ### Info about a droplet
@@ -101,8 +103,8 @@ match.
 
 ### Snapshot a droplet
 
-    $ tugboat snapshot admin test-admin-snaphot
-    Queuing snapshot 'test' for 13231512 (pearkes-admin-001)...done
+    $ tugboat snapshot test-admin-snaphot admin
+    Queuing snapshot 'test-admin-snapshot' for 13231512 (pearkes-admin-001)...done
 
 ## Help
 

data/Rakefile

@@ -1 +1,7 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/tugboat/cli.rb

@@ -9,6 +9,8 @@ module Tugboat
 
     !check_unknown_options
 
+    map "--version" => :version, "-v" => :version
+
     desc "help [COMMAND]", "Describe commands or a specific command"
     def help(meth=nil)
       super
@@ -58,11 +60,16 @@ module Tugboat
                   :type => :string,
                   :aliases => "-n",
                   :desc => "The exact name of the droplet"
+    method_option "ssh_port",
+                  :type => :string,
+                  :aliases => "-p",
+                  :desc => "The custom SSH Port to connect to"
     def ssh(name=nil)
       Middleware.sequence_ssh_droplet.call({
         "user_droplet_id" => options[:id],
         "user_droplet_name" => options[:name],
-        "user_droplet_fuzzy_name" => name
+        "user_droplet_fuzzy_name" => name,
+        "user_droplet_ssh_port" => options[:ssh_port]
       })
     end
 
@@ -82,11 +89,16 @@ module Tugboat
                    :aliases => "-r",
                    :default => 1,
                    :desc => "The region_id of the droplet"
+    method_option  "keys",
+                   :type => :string,
+                   :aliases => "-k",
+                   :desc => "A comma separated list of SSH key ids to add to 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_ssh_key_ids" => options[:keys],
         "create_droplet_name" => name
       })
     end
@@ -100,10 +112,15 @@ module Tugboat
                   :type => :string,
                   :aliases => "-n",
                   :desc => "The exact name of the droplet"
+    method_option "confirm",
+                  :type => :boolean,
+                  :aliases => "-c",
+                  :desc => "Skip confirmation of the action"
     def destroy(name=nil)
       Middleware.sequence_destroy_droplet.call({
         "user_droplet_id" => options[:id],
         "user_droplet_name" => options[:name],
+        "user_confirm_action" => options[:confirm],
         "user_droplet_fuzzy_name" => name
       })
     end
@@ -159,7 +176,7 @@ module Tugboat
       })
     end
 
-    desc "snapshot FUZZY_NAME [OPTIONS]", "Queue a snapshot of the droplet."
+    desc "snapshot SNAPSHOT_NAME FUZZY_NAME [OPTIONS]", "Queue a snapshot of the droplet."
     method_option "id",
                   :type => :string,
                   :aliases => "-i",
@@ -168,11 +185,7 @@ module Tugboat
                   :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)
+    def snapshot(snapshot_name, name=nil)
       Middleware.sequence_snapshot_droplet.call({
         "user_droplet_id" => options[:id],
         "user_droplet_name" => options[:name],
@@ -180,6 +193,16 @@ module Tugboat
         "user_snapshot_name" => snapshot_name
       })
     end
+
+    desc "keys", "Show available SSH keys"
+    def keys
+      Middleware.sequence_ssh_keys.call({})
+    end
+
+    desc "version", "Show version"
+    def version
+      say "Tugboat #{Tugboat::VERSION}"
+    end
   end
 end
 

data/lib/tugboat/config.rb

@@ -11,9 +11,10 @@ module Tugboat
 
     FILE_NAME = '.tugboat'
     DEFAULT_SSH_KEY_PATH = '.ssh/id_rsa'
+    DEFAULT_SSH_PORT = '22'
 
     def initialize
-      @path = File.join(File.expand_path("~"), FILE_NAME)
+      @path = ENV["TUGBOAT_CONFIG_PATH"] || File.join(File.expand_path("~"), FILE_NAME)
       @data = self.load_config_file
     end
 
@@ -41,11 +42,9 @@ module Tugboat
     def ssh_user
       @data['ssh']['ssh_user']
     end
-
-    # Allow the path to be set.
-    def path=(path)
-      @path = path
-      path
+    
+    def ssh_port
+      @data['ssh']['ssh_port']
     end
 
     # Re-runs initialize
@@ -53,8 +52,13 @@ module Tugboat
       self.send(:initialize)
     end
 
+    # Re-loads the config
+    def reload!
+      @data = self.load_config_file
+    end
+
     # Writes a config file
-    def create_config_file(client, api, ssh_key_path, ssh_user)
+    def create_config_file(client, api, ssh_key_path, ssh_user, ssh_port)
       # Default SSH Key path
       if ssh_key_path.empty?
         ssh_key_path = File.join(File.expand_path("~"), DEFAULT_SSH_KEY_PATH)
@@ -64,10 +68,14 @@ module Tugboat
         ssh_user = ENV['USER']
       end
 
+      if ssh_port.empty?
+        ssh_port = DEFAULT_SSH_PORT
+      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 }}
+                "ssh" => { "ssh_user" => ssh_user, "ssh_key_path" => ssh_key_path , "ssh_port" => ssh_port}}
         file.write data.to_yaml
       end
     end

data/lib/tugboat/middleware.rb

@@ -19,8 +19,10 @@ module Tugboat
     autoload :ConfirmAction, "tugboat/middleware/confirm_action"
     autoload :SnapshotDroplet, "tugboat/middleware/snapshot_droplet"
     autoload :ListImages, "tugboat/middleware/list_images"
+    autoload :ListSSHKeys, "tugboat/middleware/list_ssh_keys"
 
-    # This takes the user through the authorization flow
+    # Start the authorization flow.
+    # This writes a ~/.tugboat file, which can be edited manually.
     def self.sequence_authorize
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -32,7 +34,7 @@ module Tugboat
       end
     end
 
-    # This provides a list of droplets
+    # Display a list of droplets
     def self.sequence_list_droplets
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -42,7 +44,7 @@ module Tugboat
       end
     end
 
-    # This provides a list of droplets
+    # Display a list of images
     def self.sequence_list_images
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -52,7 +54,7 @@ module Tugboat
       end
     end
 
-    # This restarts a droplet
+    # Restart a droplet
     def self.sequence_restart_droplet
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -63,7 +65,7 @@ module Tugboat
       end
     end
 
-    # This halts a droplet
+    # Shutdown a droplet
     def self.sequence_halt_droplet
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -74,7 +76,7 @@ module Tugboat
       end
     end
 
-    # This shows a droplet
+    # Show information about a droplet
     def self.sequence_info_droplet
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -85,7 +87,7 @@ module Tugboat
       end
     end
 
-    # SSH Into a droplet
+    # SSH into a droplet
     def self.sequence_ssh_droplet
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -96,7 +98,7 @@ module Tugboat
       end
     end
 
-    # SSH Into a droplet
+    # Create a droplet
     def self.sequence_create_droplet
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -106,7 +108,7 @@ module Tugboat
       end
     end
 
-    # SSH Into a droplet
+    # Destroy a droplet
     def self.sequence_destroy_droplet
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -118,7 +120,7 @@ module Tugboat
       end
     end
 
-    # SSH Into a droplet
+    # Snapshot a droplet
     def self.sequence_snapshot_droplet
       ::Middleware::Builder.new do
         use InjectConfiguration
@@ -128,5 +130,15 @@ module Tugboat
         use SnapshotDroplet
       end
     end
+
+    # Display a list of available SSH keys
+    def self.sequence_ssh_keys
+      ::Middleware::Builder.new do
+        use InjectConfiguration
+        use CheckConfiguration
+        use InjectClient
+        use ListSSHKeys
+      end
+    end
   end
 end

data/lib/tugboat/middleware/ask_for_credentials.rb

@@ -9,9 +9,10 @@ module Tugboat
         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']}):"
+        ssh_port = ask "Enter your SSH port number (optional, defaults to 22):"
 
         # Write the config file.
-        env['config'].create_config_file(client_key, api_key, ssh_key_path, ssh_user)
+        env['config'].create_config_file(client_key, api_key, ssh_key_path, ssh_user, ssh_port)
 
         @app.call(env)
       end

data/lib/tugboat/middleware/check_credentials.rb

@@ -9,7 +9,7 @@ module Tugboat
         # work.
         begin
           env["ocean"].droplets.list
-        rescue
+        rescue Faraday::Error::ParsingError
           say "Authentication with DigitalOcean failed. Run `tugboat authorize`", :red
           return
         end

data/lib/tugboat/middleware/confirm_action.rb

@@ -2,12 +2,16 @@ 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
+        if !env["user_confirm_action"]
+          response = yes? "Warning! Potentially destructive action. Please confirm [y/n]:"
+
+          if !response
+            say "Aborted due to user request.", :red
+            # Quit
+            return
+          end
+
         end
 
         @app.call(env)

data/lib/tugboat/middleware/create_droplet.rb

@@ -9,7 +9,8 @@ module Tugboat
         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"]
+                                 :region_id => env["create_droplet_region_id"],
+                                 :ssh_key_ids => env["create_droplet_ssh_key_ids"]
 
         if req.status == "ERROR"
           say req.error_message, :red

data/lib/tugboat/middleware/find_droplet.rb

@@ -11,7 +11,7 @@ module Tugboat
         # 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
+          say "Tugboat attempted to find a droplet with no arguments. Try `tugboat help`", :red
           return
         end
 
@@ -42,7 +42,7 @@ module Tugboat
 
           # Look for the droplet by an exact name match.
           ocean.droplets.list.droplets.each do |d|
-            if droplet.name == user_droplet_name
+            if d.name == user_droplet_name
               env["droplet_id"] = d.id
               env["droplet_name"] = "(#{d.name})"
               env["droplet_ip"] = d.ip_address

data/lib/tugboat/middleware/inject_configuration.rb

@@ -4,7 +4,6 @@ module Tugboat
     class InjectConfiguration < Base
       def call(env)
         config = Tugboat::Configuration.instance
-        config.reset!
 
         env["config"] = config
 

data/lib/tugboat/middleware/list_ssh_keys.rb

@@ -0,0 +1,18 @@
+module Tugboat
+  module Middleware
+    class ListSSHKeys < Base
+      def call(env)
+        ocean = env["ocean"]
+        ssh_keys = ocean.ssh_keys.list
+
+        say "SSH Keys:"
+        ssh_keys.ssh_keys.each do |key|
+          say "#{key.name} (id: #{key.id})"
+        end
+
+        @app.call(env)
+      end
+    end
+  end
+end
+

data/lib/tugboat/middleware/snapshot_droplet.rb

@@ -3,10 +3,13 @@ module Tugboat
     class SnapshotDroplet < Base
       def call(env)
         ocean = env["ocean"]
+        # Right now, the digital ocean API doesn't return an error
+        # when your droplet is not powered off and you try to snapshot.
+        # This is a temporary measure to let the user know.
+        say "Warning: Droplet must be in a powered off state for snapshot to be successful", :yellow
 
         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"]