acquia_toolbelt 2.3.2 → 2.4.0

data/README.md

@@ -1,4 +1,4 @@
-# Acquia Toolbelt 
+# Acquia Toolbelt
 
 The Acquia Toolbelt is a CLI tool for using the Acquia Cloud API. Some of the
 features include getting information around your servers, subscription,
@@ -50,20 +50,26 @@ Without parameters:
 ```bash
 $ acquia databases:list
 
-> mydb
-> mydb2
++------------------------+
+| Name                   |
++------------------------+
+| acquiatoolbeltdev      |
+| example-db             |
+| newer-db               |
++------------------------+
 ```
 
 With parameters:
 
 ```bash
-$ acquia databases:list -e dev -d mydb
+$ acquia databases:list --environment=dev --database=acquiatoolbeltdev
+
++-------------------+----------+-----------------+-----------+------------+----------------------+
+| Name              | Username | Password        | Host      | DB cluster | Instance name        |
++-------------------+----------+-----------------+-----------+------------+----------------------+
+| acquiatoolbeltdev | s22614   | 7Ps5kU7s3VEvFTj | free-4422 | 3119       | acquiatoolbeltdevdev |
++-------------------+----------+-----------------+-----------+------------+----------------------+
 
-> Username: exampledb
-> Password: h5hKN4v2nc*1nd
-> Host: staging-1234
-> DB cluster: 1111
-> Instance name: mydb8717
 ```
 
 ## Getting started
@@ -144,6 +150,7 @@ This library aims to support and is [tested against](https://travis-ci.org/jacob
 * Ruby 1.9.2
 * Ruby 1.9.3
 * Ruby 2.0.0
+* Ruby 2.1.0
 
 If you would like support for other implementations or versions, please open an
 issue and it can be looked into.

data/acquia_toolbelt.gemspec

@@ -1,4 +1,3 @@
-# coding: utf-8
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'acquia_toolbelt/version'
@@ -25,6 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'rainbow', '1.1.4'
   spec.add_runtime_dependency 'sshkey', '1.6.0'
   spec.add_runtime_dependency 'multi_json', '1.8.2'
+  spec.add_runtime_dependency 'terminal-table', '1.4.5'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake', '10.1.0'

data/lib/acquia_toolbelt/cli/auth.rb

@@ -15,7 +15,7 @@ module AcquiaToolbelt
       def login
         cli = HighLine.new
         user = cli.ask('Enter your username: ')
-        password = cli.ask('Enter your password: ') { |q| q.echo = false }
+        password = cli.ask('Enter your password (typing will be hidden): ') { |q| q.echo = false }
 
         # Update (or create if needed) the netrc file that will contain the user
         # authentication details.

data/lib/acquia_toolbelt/cli/database.rb

@@ -10,13 +10,17 @@ module AcquiaToolbelt
         # database - The name of the database you wish to fetch the information
         #            about.
         #
-        # Returns multiple lines.
-        def output_database_instance(database)
-          ui.say "> Username: #{database['username']}"
-          ui.say "> Password: #{database['password']}"
-          ui.say "> Host: #{database['host']}"
-          ui.say "> DB cluster: #{database['db_cluster']}"
-          ui.say "> Instance name: #{database['instance_name']}"
+        # Returns the row of data for the database.
+        def database_details(database)
+          row_data = []
+          row_data << database['name']
+          row_data << database['username']
+          row_data << database['password']
+          row_data << database['host']
+          row_data << database['db_cluster']
+          row_data << database['instance_name']
+
+          row_data
         end
       end
 
@@ -36,8 +40,6 @@ module AcquiaToolbelt
         database     = options[:database]
         add_database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs", 'POST', :db => "#{database}"
 
-        puts "#{add_database}"
-
         if add_database['id']
           ui.success "Database '#{database}' has been successfully created."
         else
@@ -113,33 +115,45 @@ module AcquiaToolbelt
           subscription = AcquiaToolbelt::CLI::API.default_subscription
         end
 
+        ui.say
+
         database    = options[:database]
         environment = options[:environment]
+        rows        = []
+        headings    = [
+          'Name',
+          'Username',
+          'Password',
+          'Host',
+          'DB cluster',
+          'Instance name'
+        ]
 
         # Output a single database where the name and environment are specified.
         if database && environment
           database = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}"
-          ui.say
-          output_database_instance(database)
+          rows << database_details(database)
 
         # Only an environment was set so get all expanded data for the requested
         # environment.
         elsif environment
           databases = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs"
           databases.each do |db|
-            ui.say
-            ui.say "#{db['name']}"
-            output_database_instance(db)
+            rows << database_details(db)
           end
 
-        # Just a general listing of the databases, no in depth details.
+        # If no name or environment is passed, just throw back all the database
+        # names - no in depth details.
         else
+          # Only set the 'name' header as we don't need the rest of the headers.
+          headings = ['Name']
           databases = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/dbs"
-          ui.say
           databases.each do |db|
-            say "> #{db['name']}"
+            rows << [db['name']]
           end
         end
+
+        ui.output_table('', headings, rows)
       end
 
       # Public: Create a database instance backup.
@@ -187,16 +201,31 @@ module AcquiaToolbelt
         database    = options[:database]
         environment = options[:environment]
         backups     = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/dbs/#{database}/backups"
+
+        ui.say
+
+        rows = []
+        headings = [
+          'ID',
+          'Checksum',
+          'Type',
+          'Path',
+          'Start',
+          'Completed'
+        ]
+
         backups.each do |backup|
-          ui.say
-          ui.say "> ID: #{backup['id']}"
-          ui.say "> MD5: #{backup['checksum']}"
-          ui.say "> Type: #{backup['type']}"
-          ui.say "> Path: #{backup['path']}"
-          ui.say "> Link: #{backup['link']}"
-          ui.say "> Started: #{Time.at(backup['started'].to_i)}"
-          ui.say "> Completed: #{Time.at(backup['completed'].to_i)}"
+          row_data = []
+          row_data << backup['id']
+          row_data << backup['checksum']
+          row_data << backup['type']
+          row_data << backup['path']
+          row_data << Time.at(backup['started'].to_i)
+          row_data << Time.at(backup['completed'].to_i)
+          rows << row_data
         end
+
+        ui.output_table('', headings, rows)
       end
 
       # Public: Restore a database backup.

data/lib/acquia_toolbelt/cli/domain.rb

@@ -43,15 +43,21 @@ module AcquiaToolbelt
           environments = AcquiaToolbelt::CLI::API.environments
         end
 
+        ui.say
+
+        rows = []
+        headings = ['Domain']
+
         environments.each do |environment|
           domains = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{environment}/domains"
-          ui.say
-          ui.say "Environment: #{environment}" unless options[:environment]
-
           domains.each do |domain|
-            ui.say "> #{domain['name']}"
+            row_data = []
+            row_data << domain['name']
+            rows << row_data
           end
         end
+
+        ui.output_table('', headings, rows)
       end
 
       # Public: Add a domain to the subscription.
@@ -110,7 +116,7 @@ module AcquiaToolbelt
       # Public: Purge a domains web cache.
       #
       # Returns a status message.
-      desc 'purge', 'Purge a domain\'s web cache.'
+      desc 'purge', "Purge a domain's web cache."
       method_option :domain, :type => :string, :aliases => %w(-d),
         :desc => 'URL of the domain to purge.'
       def purge

data/lib/acquia_toolbelt/cli/environment.rb

@@ -23,15 +23,31 @@ module AcquiaToolbelt
           environments = AcquiaToolbelt::CLI::API.environments
         end
 
+        ui.say
+
+        rows = []
+        headings = [
+          'Host',
+          'Environment',
+          'Current release',
+          'Live development',
+          'DB clusters',
+          'Default domain'
+        ]
+
         environments.each do |env|
           env_info = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{env}"
-          ui.say
-          ui.say "> Host: #{env_info['ssh_host']}"
-          ui.say "> Environment: #{env_info['name']}"
-          ui.say "> Current release: #{env_info['vcs_path']}"
-          ui.say "> DB clusters: #{env_info['db_clusters'].join(', ')}"
-          ui.say "> Default domain: #{env_info['default_domain']}"
+          row_data = []
+          row_data << env_info['ssh_host']
+          row_data << env_info['name']
+          row_data << env_info['vcs_path']
+          row_data << env_info['livedev'].capitalize
+          row_data << env_info['db_clusters'].join(', ')
+          row_data << env_info['default_domain']
+          rows << row_data
         end
+
+        ui.output_table('', headings, rows)
       end
 
       # Public: Toggle whether live development is enabled on an environment.

data/lib/acquia_toolbelt/cli/server.rb

@@ -21,46 +21,66 @@ module AcquiaToolbelt
         # Loop over each environment and get all the associated server data.
         environments.each do |env|
           ui.say
-          ui.say "Environment: #{env}"
+
+          rows = []
+          headings = [
+            'FQDN',
+            'Availability zone',
+            'Type',
+            'PHP processes',
+            'Environment state',
+            'Web state',
+            'Varnish state',
+            'External IP'
+          ]
 
           server_env = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/envs/#{env}/servers"
           server_env.each do |server|
-            ui.say
-            ui.say "> Host: #{server['fqdn']}"
-            ui.say "> Region: #{server['ec2_region']}"
-            ui.say "> Instance type: #{server['ami_type']}"
-            ui.say "> Availability zone: #{server['ec2_availability_zone']}"
+            row_data = []
+            row_data << server['fqdn']
+            row_data << server['ec2_availability_zone']
+            row_data << server['ami_type']
 
             # Show how many PHP processes this node can have. Note, this is only
             # available on the web servers.
-            if server['services'] && server['services']['php_max_procs']
-              ui.say "> PHP max processes: #{server['services']['php_max_procs']}"
+            if server['services'] && server['services']['web']
+              row_data << server['services']['web']['php_max_procs']
+            else
+              row_data << 'n/a'
             end
 
-            if server['services'] && server['services']['status']
-              ui.say "> Status: #{server['services']['status']}"
+            if server['services'] && server['services']['web']
+              row_data << server['services']['web']['env_status']
+            else
+              row_data << 'n/a'
             end
 
             if server['services'] && server['services']['web']
-              ui.say "> Web status: #{server['services']['web']['status']}"
+              row_data << server['services']['web']['status']
+            else
+              row_data << 'n/a'
             end
 
             # The state of varnish.
             if server['services'] && server['services']['varnish']
-              ui.say "> Varnish status: #{server['services']['varnish']['status']}"
+              # Replace underscores with a space to make the output slightly
+              # nicer.
+              row_data << server['services']['varnish']['status'].sub('_', ' ')
+            else
+              row_data << 'n/a'
             end
 
             # Only load balancers will have the 'external IP' property.
             if server['services'] && server['services']['external_ip']
-              ui.say "> External IP: #{server['services']['external_ip']}"
+              row_data << server['services']['external_ip']
+            else
+              row_data << 'n/a'
             end
 
-            # If running a dedicated load balancer, there will be a ELB domain
-            # associated with the load balancing tier.
-            if server['services'] && server['services']['elb_domain_name']
-              ui.say "> ELB hostname: #{server['services']['elb_domain_name']}"
-            end
+            rows << row_data
           end
+
+          ui.output_table("Environment: #{env}", headings, rows)
         end
       end
     end

data/lib/acquia_toolbelt/cli/site.rb

@@ -7,26 +7,31 @@ module AcquiaToolbelt
       desc 'list', 'List all subscriptions you have access to.'
       def list
         sites = AcquiaToolbelt::CLI::API.request 'sites'
+        ui.say
+
+        rows = []
+        headings = [
+          'Subscription name',
+          'Username',
+          'Realm name',
+          'UUID',
+          'Production mode'
+        ]
 
         sites.each do |site|
-          ui.say
           # Get the individual subscription information.
           site_data = AcquiaToolbelt::CLI::API.request "sites/#{site}"
 
-          ui.say "#{site_data['title']}"
-          ui.say "> Username: #{site_data['unix_username']}"
-          ui.say "> Subscription: #{site_data['name']}"
-
-          # If the VCS type is SVN, we want it in all uppercase, otherwise just
-          # capitilise it.
-          if site_data['vcs_type'] == 'svn'
-            vcs_name = site_data['vcs_type'].upcase
-          else
-            vcs_name = site_data['vcs_type'].capitalize
-          end
-
-          ui.say "> #{vcs_name} URL: #{site_data['vcs_url']}"
+          row_data = []
+          row_data << site_data['title']
+          row_data << site_data['unix_username']
+          row_data << site_data['name']
+          row_data << site_data['uuid']
+          row_data << site_data['production_mode']
+          rows << row_data
         end
+
+        ui.output_table('', headings, rows)
       end
     end
   end

data/lib/acquia_toolbelt/cli/ssh.rb

@@ -14,13 +14,29 @@ module AcquiaToolbelt
           subscription = AcquiaToolbelt::CLI::API.default_subscription
         end
 
+        ui.say
+
+        rows = []
+        headings = [
+          'ID',
+          'Nickname',
+          'Fingerprint',
+          'Shell access',
+          'VCS access'
+        ]
+
         users = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/sshkeys"
         users.each do |user|
-          say
-          say "> ID: #{user['id']}"
-          say "> Name: #{user['nickname']}"
-          say "> Fingerprint: #{SSHKey.fingerprint user['ssh_pub_key']}"
+          row_data = []
+          row_data << user['id']
+          row_data << user['nickname']
+          row_data << SSHKey.fingerprint(user['ssh_pub_key'])
+          row_data << user['shell_access']
+          row_data << user['vcs_access']
+          rows << row_data
         end
+
+        ui.output_table('', headings, rows)
       end
 
       # Public: Delete a SSH key.

data/lib/acquia_toolbelt/cli/svn.rb

@@ -12,12 +12,23 @@ module AcquiaToolbelt
           subscription = AcquiaToolbelt::CLI::API.default_subscription
         end
 
+        ui.say
+
+        rows = []
+        headings = [
+          'ID',
+          'Name'
+        ]
+
         svn_users = AcquiaToolbelt::CLI::API.request  "sites/#{subscription}/svnusers"
         svn_users.each do |user|
-          ui.say
-          ui.say "> ID: #{user['id']}"
-          ui.say "> Name: #{user['username']}"
+          row_data = []
+          row_data << user['id']
+          row_data << user['username']
+          rows << row_data
         end
+
+        ui.output_table('', headings, rows)
       end
 
       # Public: Create a new SVN user.

data/lib/acquia_toolbelt/cli/task.rb

@@ -8,20 +8,23 @@ module AcquiaToolbelt
         #        task.
         def output_task_item(task)
           completion_time = (task['completed'].to_i - task['started'].to_i) / 60
-          ui.say
-          ui.say "Task ID: #{task['id'].to_i}"
-          ui.say "Description: #{task['description']}"
-          ui.say "Status: #{task['state']}"
+          row_data = []
+          description = task['description'].scan(/.{1,50}[\w\=]/).map(&:strip)
+
+          row_data << task['id'].to_i
+          row_data << task['queue']
+          row_data << description.join("\n")
+          row_data << task['state'].capitalize
 
           # If the completion time is greater then 0, output it in minutes
           # otherwise just say it was less then a minute.
           if completion_time > 0
-            ui.say "Completion time: About #{completion_time} minutes"
+            row_data << "About #{completion_time} minutes"
           else
-            ui.say 'Completion time: Less than 1 minute'
+            row_data << 'Less than 1 minute'
           end
 
-          ui.say "Queue: #{task['queue']}"
+          row_data
         end
       end
 
@@ -40,19 +43,27 @@ module AcquiaToolbelt
           subscription = AcquiaToolbelt::CLI::API.default_subscription
         end
 
-        queue = options[:queue]
-        count = options[:count]
+        ui.say
+
+        queue    = options[:queue]
+        count    = options[:count]
+        tasks    = []
+        rows     = []
+        headings = [
+          'ID',
+          'Queue',
+          'Description',
+          'State',
+          'Completion time'
+        ]
 
         all_tasks = AcquiaToolbelt::CLI::API.request "sites/#{subscription}/tasks"
-        tasks = []
 
         # Fetch a single queue from the tasks list if the queue parameter is set
         # otherwise just add all the tasks.
         if queue
           all_tasks.each do |task|
-            if task['queue'] == queue
-              tasks << task
-            end
+            tasks << task if task['queue'] == queue
           end
         else
           all_tasks.each do |task|
@@ -64,8 +75,10 @@ module AcquiaToolbelt
         tasks = tasks.last(count.to_i) if count && tasks.any?
 
         tasks.each do |task|
-          output_task_item(task)
+          rows << output_task_item(task)
         end
+
+        ui.output_table('', headings, rows)
       end
     end
   end

data/lib/acquia_toolbelt/cli/ui.rb

@@ -39,6 +39,26 @@ module AcquiaToolbelt
       def debug(text)
         puts "#{text}".foreground(:yellow)
       end
+
+      # Internal: Render a CLI table.
+      #
+      # title   - The title to display at the top of the table.
+      # heading - Header rows for the table.
+      # rows    - An array of the row data to output.
+      #
+      # Outputs a table to the end user.
+      def output_table(title = '', headings, rows)
+        table = Terminal::Table.new
+        table.title = title unless title.empty?
+        table.rows = rows
+        table.headings = headings
+        table.style = {
+          :padding_left  => 1,
+          :padding_right => 1
+        }
+
+        puts table
+      end
     end
   end
 end

data/lib/acquia_toolbelt/cli.rb

@@ -1,6 +1,7 @@
 require 'acquia_toolbelt'
 require 'acquia_toolbelt/error'
 require 'acquia_toolbelt/thor'
+require 'terminal-table'
 
 module AcquiaToolbelt
   class CLI < AcquiaToolbelt::Thor

data/lib/acquia_toolbelt/version.rb

@@ -1,3 +1,3 @@
 module AcquiaToolbelt
-  VERSION = '2.3.2'
+  VERSION = '2.4.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: acquia_toolbelt
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 2.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-10 00:00:00.000000000 Z
+date: 2014-11-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -139,6 +139,22 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.8.2
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement