aptible-cli 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4b9fd4e188e1528e1b563686014af146adb94682
-  data.tar.gz: 357b0531bc1e827cf48a9a6ed260b6d181d3da11
+  metadata.gz: b0ef65d679c775ddb6867c82a3dcd03ff8b89242
+  data.tar.gz: 1f59dcda5ee8d9dc6c66adc1253442602c79c33c
 SHA512:
-  metadata.gz: c961a51996a5653d72ea6c43a34756e803442957e74b62d5e982bd8f9d198895243b259699f03fcbf0895b4b1c306d9d4baad5b392934735aaafd3d402474bd2
-  data.tar.gz: c5fece56955f0d3157661cb2a3219cdad0b69b0983fec6b360ae39f6647afec4eb5c3ea8d7ab694320c9c235cf0d2b5155380753549461935c9b09cd707fdeb8
+  metadata.gz: 52cb99978e5c6ec6fdb91d9bbd8903d26df80a1ba4d1aecc62c63ee47bc415c24f864541a2d35e4b0e293be5f3b84d2ce482a1a5c1c8a8324f30d529b8ff0abf
+  data.tar.gz: f50356c6dba2433f232b545415b887de601acc8f3e3ef9ec46d8dd9c0417c4e37dd31db3a2dd3cc2921cb3825822f9a5b894b37dbba5e7789c8fce22b76d4926

data/README.md

@@ -42,7 +42,7 @@ Commands:
   aptible config:unset                                                                                                               # Alias for config:rm
   aptible db:backup HANDLE                                                                                                           # Backup a database
   aptible db:clone SOURCE DEST                                                                                                       # Clone a database to create a new one
-  aptible db:create HANDLE[--type TYPE] [--container-size SIZE_MB] [--size SIZE_GB]                                                  # Create a new database
+  aptible db:create HANDLE [--type TYPE] [--version VERSION] [--container-size SIZE_MB] [--size SIZE_GB]                             # Create a new database
   aptible db:deprovision HANDLE                                                                                                      # Deprovision a database
   aptible db:dump HANDLE                                                                                                             # Dump a remote database to file
   aptible db:execute HANDLE SQL_FILE                                                                                                 # Executes sql against a database
@@ -51,6 +51,7 @@ Commands:
   aptible db:restart HANDLE [--container-size SIZE_MB] [--size SIZE_GB]                                                              # Restart a database
   aptible db:tunnel HANDLE                                                                                                           # Create a local tunnel to a database
   aptible db:url HANDLE                                                                                                              # Display a database URL
+  aptible db:versions                                                                                                                # List available database versions
   aptible deploy [OPTIONS] [VAR1=VAL1] [VAR=VAL2] ...                                                                                # Deploy an app
   aptible domains                                                                                                                    # Print an app's current virtual domains - DEPRECATED
   aptible endpoints:database:create DATABASE                                                                                         # Create a Database Endpoint
@@ -76,6 +77,14 @@ Commands:
 ```
 <!-- END USAGE -->
 
+### Output Format
+
+By default, the Aptible CLI outputs data as unstructured text, designed for human consumption.
+
+If you need to parse the output in another program, set the `APTIBLE_OUTPUT_FORMAT` environment variable to `json` when calling the Aptible CLI for JSON output.
+
+The default format is `text`.
+
 ## Contributing
 
 1. Fork the project.

data/aptible-cli.gemspec

@@ -29,6 +29,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'term-ansicolor'
   spec.add_dependency 'chronic_duration', '~> 0.10.6'
   spec.add_dependency 'win32-process' if Gem.win_platform?
+  spec.add_dependency 'activesupport', '>= 4.0', '< 6.0'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'aptible-tasks', '~> 0.5.8'
   spec.add_development_dependency 'rake'

data/bin/aptible

@@ -10,10 +10,14 @@ end
 begin
   Aptible::CLI::Agent.start
 rescue HyperResource::ClientError => e
-  if e.body['error'] == 'invalid_token'
-    STDERR.puts 'API authentication error: please run aptible login'
-  else
-    STDERR.puts "An error occurred: #{e.body['message']}"
-  end
+  m = if e.body['error'] == 'invalid_token'
+        'API authentication error: please run aptible login'
+      else
+        "An error occurred: #{e.body['message']}"
+      end
+  Aptible::CLI.logger.error(m)
+  exit 1
+rescue Aptible::CLI::UserError => e
+  Aptible::CLI.logger.error e.message
   exit 1
 end

data/lib/aptible/cli.rb

@@ -1,7 +1,43 @@
+require 'logger'
+
 require 'aptible/cli/version'
 require 'aptible/cli/agent'
+require 'aptible/cli/error'
+require 'aptible/cli/formatter'
+require 'aptible/cli/renderer'
+require 'aptible/cli/resource_formatter'
 
 module Aptible
   module CLI
+    class LogFormatter
+      include Term::ANSIColor
+
+      def call(severity, _, _, msg)
+        color = case severity
+                when 'DEBUG'
+                  :no_color
+                when 'INFO'
+                  :green
+                when 'WARN'
+                  :yellow
+                when 'ERROR', 'FATAL'
+                  :red
+                else
+                  :no_color
+                end
+
+        "#{public_send(color, msg)}\n"
+      end
+
+      def no_color(msg)
+        msg
+      end
+    end
+
+    def self.logger
+      @logger ||= Logger.new($stderr).tap do |l|
+        l.formatter = LogFormatter.new
+      end
+    end
   end
 end

data/lib/aptible/cli/agent.rb

@@ -68,7 +68,11 @@ module Aptible
 
       desc 'version', 'Print Aptible CLI version'
       def version
-        puts version_string
+        Formatter.render(Renderer.current) do |root|
+          root.keyed_object('version') do |node|
+            node.value('version', version_string)
+          end
+        end
       end
 
       desc 'login', 'Log in to Aptible'
@@ -111,19 +115,19 @@ module Aptible
         end
 
         save_token(token.access_token)
-        puts "Token written to #{token_file}"
+        CLI.logger.info "Token written to #{token_file}"
 
         lifetime_format = { units: 2, joiner: ', ' }
         token_lifetime = (token.expires_at - token.created_at).round
         expires_in = ChronicDuration.output(token_lifetime, lifetime_format)
-        puts "This token will expire after #{expires_in} " \
-             '(use --lifetime to customize)'
+        CLI.logger.info "This token will expire after #{expires_in} " \
+                        '(use --lifetime to customize)'
       end
 
       private
 
       def deprecated(msg)
-        $stderr.puts yellow([
+        CLI.logger.warn([
           "DEPRECATION NOTICE: #{msg}",
           'Please contact support@aptible.com with any questions.'
         ].join("\n"))
@@ -147,7 +151,7 @@ module Aptible
         now = Time.now.utc.to_i
 
         if last_nag < now - nag_frequency
-          $stderr.puts yellow([
+          CLI.logger.warn([
             'You have installed the Aptible CLI from source.',
             'This is not recommended: some functionality may not work!',
             'Review this support topic for more information:',

data/lib/aptible/cli/error.rb

@@ -0,0 +1,6 @@
+module Aptible
+  module CLI
+    class UserError < StandardError
+    end
+  end
+end

data/lib/aptible/cli/formatter.rb

@@ -0,0 +1,21 @@
+require_relative 'formatter/node'
+require_relative 'formatter/list'
+require_relative 'formatter/keyed_list'
+require_relative 'formatter/grouped_keyed_list'
+require_relative 'formatter/object'
+require_relative 'formatter/keyed_object'
+require_relative 'formatter/root'
+require_relative 'formatter/value'
+
+module Aptible
+  module CLI
+    module Formatter
+      def self.render(renderer)
+        root = Root.new
+        yield root
+        out = renderer.render(root)
+        puts out if out
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/grouped_keyed_list.rb

@@ -0,0 +1,54 @@
+module Aptible
+  module CLI
+    module Formatter
+      class GroupedKeyedList < KeyedList
+        attr_reader :group
+
+        class InvalidGroup
+          def initialize(group)
+            m = 'group argument must be a string or a hash with one key ' \
+                "and a string value. #{group} is invalid"
+            super(m)
+          end
+        end
+
+        def initialize(group, y)
+          @group = group
+          validate_group!
+          super(y)
+        end
+
+        def groups
+          children.group_by(&grouper)
+        end
+
+        private
+
+        def grouper
+          case group
+          when String
+            lambda do |n|
+              n.children.fetch(group)
+            end
+          when Hash
+            first, second = group.to_a.first
+            lambda do |n|
+              n.children.fetch(first).children.fetch(second)
+            end
+          end
+        end
+
+        def validate_group!
+          return if group.is_a?(String)
+          if group.is_a?(Hash)
+            keys = group.keys
+            raise InvalidGroup, group if keys.size != 1
+            raise InvalidGroup, group unless group[keys.first].is_a?(String)
+            return
+          end
+          raise InvalidGroup(group)
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/keyed_list.rb

@@ -0,0 +1,25 @@
+module Aptible
+  module CLI
+    module Formatter
+      class KeyedList < List
+        # KeyedList is a list of objects with one key that is more important
+        # than the others. Some renderers may opt to only display this key when
+        # rendering the list.
+        attr_reader :key
+
+        def initialize(key)
+          @key = key
+          super()
+        end
+
+        def value(_)
+          raise "not supported on #{self.class}"
+        end
+
+        def list
+          raise "not supported on #{self.class}"
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/keyed_object.rb

@@ -0,0 +1,16 @@
+module Aptible
+  module CLI
+    module Formatter
+      class KeyedObject < Object
+        # KeyedObject is rendered as an Object, but flags a given key as being
+        # more important. Renderers may opt to only render this key.
+        attr_reader :key
+
+        def initialize(key)
+          @key = key
+          super()
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/list.rb

@@ -0,0 +1,33 @@
+module Aptible
+  module CLI
+    module Formatter
+      class List < Node
+        attr_reader :children
+
+        def initialize
+          @children = []
+        end
+
+        def value(s)
+          # TODO: Fail if block?
+          @children << Value.new(s)
+          nil
+        end
+
+        def object
+          o = Object.new
+          yield o
+          @children << o
+          nil
+        end
+
+        def list
+          l = List.new
+          yield l
+          @children << l
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/node.rb

@@ -0,0 +1,8 @@
+module Aptible
+  module CLI
+    module Formatter
+      class Node
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/object.rb

@@ -0,0 +1,38 @@
+module Aptible
+  module CLI
+    module Formatter
+      class Object < Node
+        attr_reader :children
+
+        def initialize
+          @children = {}
+        end
+
+        def value(k, v)
+          assign_child(k, Value.new(v)) {}
+        end
+
+        def object(k, &block)
+          assign_child(k, Object.new, &block)
+        end
+
+        def keyed_object(k, object_key, &block)
+          assign_child(k, KeyedObject.new(object_key), &block)
+        end
+
+        def list(k, &block)
+          assign_child(k, List.new, &block)
+        end
+
+        private
+
+        def assign_child(k, node)
+          raise "Overwriting keys (#{k}) is not allowed" if @children[k]
+          yield node
+          @children[k] = node
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/root.rb

@@ -0,0 +1,46 @@
+module Aptible
+  module CLI
+    module Formatter
+      class Root < Node
+        attr_reader :root
+
+        def initialize
+          @root = nil
+        end
+
+        def value(s)
+          assign_root(Value.new(s)) {}
+        end
+
+        def object(&block)
+          assign_root(Object.new, &block)
+        end
+
+        def keyed_object(key, &block)
+          assign_root(KeyedObject.new(key), &block)
+        end
+
+        def list(&block)
+          assign_root(List.new, &block)
+        end
+
+        def keyed_list(key, &block)
+          assign_root(KeyedList.new(key), &block)
+        end
+
+        def grouped_keyed_list(group, key, &block)
+          assign_root(GroupedKeyedList.new(group, key), &block)
+        end
+
+        private
+
+        def assign_root(node)
+          raise "root has already been initialized: #{@root.inspect}" if @root
+          yield node
+          @root = node
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/formatter/value.rb

@@ -0,0 +1,25 @@
+module Aptible
+  module CLI
+    module Formatter
+      class Value < Node
+        include Comparable
+
+        attr_reader :value
+
+        def initialize(value)
+          @value = value
+        end
+
+        def <=>(other)
+          value <=> other.value
+        end
+
+        alias eql? ==
+
+        def hash
+          value.hash
+        end
+      end
+    end
+  end
+end