aptible-cli 0.19.8 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5297ec1eb7d106b2b69705d31ab05426fb64d8c553b170918c4090aaf582398f
-  data.tar.gz: d0478f4e443b88f9def1a45a9db9b029f62d36e6d73bc53c6a686c858bfd3e83
+  metadata.gz: 985fa3322948f2656c41b9b6e7ed378625424554dcf26d1db461386586f488a9
+  data.tar.gz: 71150a291daf6e6a054979d6308e9a919654679b88b9581d51959c3100cf9a07
 SHA512:
-  metadata.gz: 9e0490170403f7272b481a09272115aafc5d1a3c65b21c26d357e149fc305b5ffef0c04903d8e677f865b992d76551828e3621a338d2bc6c6ee69a33222b8ddf
-  data.tar.gz: fa77c4fd5462b8b99a5f0ae8146e876e163e8faf6b2e34aa1275cdbea6d920d40b48b9f1fb08820b92d3b5ab02de681c17b20a4192305b7c674760cdfbd80ba3
+  metadata.gz: 3551dbb8cff5d22404f022652c70dadf2407f46f11443c84b36eeaa9ba1ec2cb13260d3fd613402c24532e366daf25d9516e19c05a3017f605d5fb8d8a5d5059
+  data.tar.gz: 7ef21a787bbb1c81587fd3ad4ef4adee351a10de48d9b80299d8f7f83912a67d1a54c835c856be2b79d93783c6c45e7211d6abb7f5eb7531f80bc834eadbfcf1

data/.dockerignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+*.dump
+.bundle
+.config
+.yardoc
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.idea
+/.vscode
+Makefile

data/.gitignore

@@ -4,7 +4,6 @@
 .bundle
 .config
 .yardoc
-Gemfile.lock
 InstalledFiles
 _yardoc
 coverage

data/.travis.yml

@@ -11,9 +11,10 @@ rvm:
   - "2.7"
 
 before_install:
-  - ./cleanup_bundler
   - gem install bundler -v '< 2'
 script:
   - bundle exec rake
   - bundle exec script/sync-readme-usage
   - git diff --exit-code
+env:
+  - BUNDLER_VERSION=1.17.3

data/Dockerfile

@@ -0,0 +1,27 @@
+FROM ruby:2.7.8
+
+# Install and use an compatible bundler
+ENV BUNDLER_VERSION=1.17.3
+RUN gem install bundler -v "${BUNDLER_VERSION}"
+
+# Install required gems before copying in code
+# to avoid re-installing gems when developing
+WORKDIR /app
+COPY Gemfile /app
+COPY Gemfile.lock /app
+COPY aptible-cli.gemspec /app
+
+# We reference the version, so copy that in, too
+CMD mkdir -p /app/lib/aptible/cli/
+COPY lib/aptible/cli/version.rb /app/lib/aptible/cli/
+
+RUN bundle install
+
+COPY . /app
+
+# Save on typing while testing
+RUN echo '#!/bin/bash' > /usr/bin/aptible \
+ && echo 'bundle exec bin/aptible $@' >> /usr/bin/aptible \
+ && chmod +x /usr/bin/aptible
+
+CMD ["aptible"]

data/Gemfile.lock

@@ -0,0 +1,184 @@
+GIT
+  remote: https://github.com/fancyremarker/pry.git
+  revision: be3823aa4ffc51260f2f3ce84f0984da3dc6dd10
+  branch: aptible
+  specs:
+    pry (0.10.0)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+
+PATH
+  remote: .
+  specs:
+    aptible-cli (0.20.0)
+      activesupport (>= 4.0, < 6.0)
+      aptible-api (~> 1.5.3)
+      aptible-auth (~> 1.2.4)
+      aptible-billing (~> 1.0)
+      aptible-resource (~> 1.1)
+      aws-sdk (~> 2.0)
+      bigdecimal (~> 1.3.5)
+      cbor
+      chronic_duration (~> 0.10.6)
+      git (< 1.10)
+      term-ansicolor
+      thor (~> 0.20.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.2.11.3)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    aptible-api (1.5.3)
+      aptible-auth (~> 1.0)
+      aptible-resource (~> 1.0)
+      gem_config
+      multipart-post (< 2.2.0)
+    aptible-auth (1.2.5)
+      aptible-resource (~> 1.0)
+      gem_config
+      multipart-post (= 2.1.1)
+      oauth2 (= 1.4.7)
+    aptible-billing (1.0.1)
+      activesupport (>= 4.0, < 6.0)
+      aptible-resource (~> 1.0)
+      stripe (>= 1.13.0)
+    aptible-resource (1.1.2)
+      activesupport
+      fridge
+      gem_config (~> 0.3.1)
+      httpclient (~> 2.8)
+      json
+      uri_template (>= 0.5.2)
+    aptible-tasks (0.5.9)
+      rake (>= 10, < 13.0)
+      rubocop (= 0.42.0)
+    ast (2.4.2)
+    aws-eventstream (1.1.1)
+    aws-sdk (2.11.632)
+      aws-sdk-resources (= 2.11.632)
+    aws-sdk-core (2.11.632)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.11.632)
+      aws-sdk-core (= 2.11.632)
+    aws-sigv4 (1.2.4)
+      aws-eventstream (~> 1, >= 1.0.2)
+    bigdecimal (1.3.5)
+    cbor (0.5.9.8)
+    chronic_duration (0.10.6)
+      numerizer (~> 0.1.1)
+    climate_control (0.0.3)
+      activesupport (>= 3.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    connection_pool (2.2.3)
+    crack (1.0.0)
+      bigdecimal
+      rexml
+    diff-lcs (1.5.1)
+    fabrication (2.15.2)
+    faraday (0.17.6)
+      multipart-post (>= 1.2, < 3)
+    fridge (0.2.2)
+      gem_config
+      jwt
+    gem_config (0.3.2)
+    git (1.7.0)
+      rchardet (~> 1.8)
+    hashdiff (1.1.0)
+    httpclient (2.8.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.6.2)
+    json (2.5.1)
+    jwt (2.3.0)
+    method_source (0.8.2)
+    minitest (5.12.0)
+    multi_json (1.15.0)
+    multi_xml (0.6.0)
+    multipart-post (2.1.1)
+    net-http-persistent (3.1.0)
+      connection_pool (~> 2.2)
+    numerizer (0.1.1)
+    oauth2 (1.4.7)
+      faraday (>= 0.8, < 2.0)
+      jwt (>= 1.0, < 3.0)
+      multi_json (~> 1.3)
+      multi_xml (~> 0.5)
+      rack (>= 1.2, < 3)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    powerpack (0.1.3)
+    public_suffix (3.1.1)
+    rack (1.6.13)
+    rainbow (2.2.2)
+      rake
+    rake (12.3.3)
+    rchardet (1.8.0)
+    rexml (3.2.5)
+    rspec (3.13.0)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.0)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.1)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (~> 1.0, >= 1.0.1)
+    ruby-progressbar (1.13.0)
+    slop (3.6.0)
+    stripe (4.24.0)
+      faraday (~> 0.13)
+      net-http-persistent (~> 3.0)
+    sync (0.5.0)
+    term-ansicolor (1.8.0)
+      tins (~> 1.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tins (1.33.0)
+      bigdecimal
+      sync
+    tzinfo (1.2.11)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.8.0)
+    uri_template (0.7.0)
+    webmock (3.16.2)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (~> 4.0)
+  aptible-cli!
+  aptible-tasks (~> 0.5.8)
+  bundler (~> 1.3)
+  climate_control (= 0.0.3)
+  fabrication (~> 2.15.2)
+  pry!
+  rack (~> 1.0)
+  rake
+  rspec (~> 3.2)
+  webmock
+
+BUNDLED WITH
+   1.17.3

data/Makefile

@@ -0,0 +1,10 @@
+build:
+	docker compose build --pull
+
+bash: build
+	docker compose run cli bash
+
+test: build
+	docker compose run cli bundle exec rake
+
+.PHONY: build bash test

data/README.md

@@ -35,8 +35,11 @@ Commands:
   aptible backup:orphaned                                                                                                                                                                                                                                                                                                                                       # List backups associated with deprovisioned databases
   aptible backup:purge BACKUP_ID                                                                                                                                                                                                                                                                                                                                # Permanently delete a backup and any copies of it
   aptible backup:restore BACKUP_ID [--environment ENVIRONMENT_HANDLE] [--handle HANDLE] [--container-size SIZE_MB] [--disk-size SIZE_GB] [--key-arn KEY_ARN]                                                                                                                                                                                                    # Restore a backup
+  aptible backup_retention_policy [ENVIRONMENT_HANDLE]                                                                                                                                                                                                                                                                                                          # Show the current backup retention policy for the environment
+  aptible backup_retention_policy:set [ENVIRONMENT_HANDLE] [--daily DAILY_BACKUPS] [--monthly MONTHLY_BACKUPS] [--yearly YEARLY_BACKUPS] [--make-copy|--no-make-copy] [--keep-final|--no-keep-final]                                                                                                                                                            # Change the environemnt's backup retention policy
   aptible config                                                                                                                                                                                                                                                                                                                                                # Print an app's current configuration
   aptible config:add [VAR1=VAL1] [VAR2=VAL2] [...]                                                                                                                                                                                                                                                                                                              # Add an ENV variable to an app
+  aptible config:get [VAR1]                                                                                                                                                                                                                                                                                                                                     # Print a specific key within an app's current configuration
   aptible config:rm [VAR1] [VAR2] [...]                                                                                                                                                                                                                                                                                                                         # Remove an ENV variable from an app
   aptible config:set [VAR1=VAL1] [VAR2=VAL2] [...]                                                                                                                                                                                                                                                                                                              # Add an ENV variable to an app
   aptible config:unset [VAR1] [VAR2] [...]                                                                                                                                                                                                                                                                                                                      # Remove an ENV variable from an app

data/aptible-cli.gemspec

@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ['lib']
 
   spec.add_dependency 'aptible-resource', '~> 1.1'
-  spec.add_dependency 'aptible-api', '~> 1.4'
+  spec.add_dependency 'aptible-api', '~> 1.5.3'
   spec.add_dependency 'aptible-auth', '~> 1.2.4'
   spec.add_dependency 'aptible-billing', '~> 1.0'
   spec.add_dependency 'thor', '~> 0.20.0'

data/docker-compose.yml

@@ -0,0 +1,10 @@
+services:
+  cli:
+    build: .
+    volumes:
+      - type: bind
+        source: .
+        target: /app
+      - type: bind
+        source: $HOME/.aptible/tokens.json
+        target: /root/.aptible/tokens.json

data/lib/aptible/cli/agent.rb

@@ -42,6 +42,7 @@ require_relative 'subcommands/endpoints'
 require_relative 'subcommands/log_drain'
 require_relative 'subcommands/metric_drain'
 require_relative 'subcommands/maintenance'
+require_relative 'subcommands/backup_retention_policy'
 
 module Aptible
   module CLI
@@ -70,6 +71,7 @@ module Aptible
       include Subcommands::LogDrain
       include Subcommands::MetricDrain
       include Subcommands::Maintenance
+      include Subcommands::BackupRetentionPolicy
 
       # Forward return codes on failures.
       def self.exit_on_failure?

data/lib/aptible/cli/resource_formatter.rb

@@ -247,10 +247,10 @@ module Aptible
           raw_start, raw_end = maintenance_resource.maintenance_deadline
           window_start = utc_string(raw_start)
           window_end = utc_string(raw_end)
-          label = "#{maintenance_resource.handle} between #{window_start} "\
+          label = "#{maintenance_resource.handle} between #{window_start} " \
                   "and #{window_end}"
-          restart_command = "#{command_prefix}"\
-                            " #{maintenance_resource.handle}"\
+          restart_command = "#{command_prefix}" \
+                            " #{maintenance_resource.handle}" \
                             " --environment #{account.handle}"
           node.value('label', label)
           node.value('handle', maintenance_resource.handle)
@@ -259,6 +259,17 @@ module Aptible
           attach_account(node, account)
         end
 
+        def inject_backup_retention_policy(node, policy, account)
+          node.value('id', policy.id)
+          node.value('daily', policy.daily)
+          node.value('monthly', policy.monthly)
+          node.value('yearly', policy.yearly)
+          node.value('make_copy', policy.make_copy)
+          node.value('keep_final', policy.keep_final)
+
+          attach_account(node, account)
+        end
+
         private
 
         def attach_account(node, account)

data/lib/aptible/cli/subcommands/backup_retention_policy.rb

@@ -0,0 +1,92 @@
+require 'term/ansicolor'
+require 'uri'
+require 'English'
+
+module Aptible
+  module CLI
+    module Subcommands
+      module BackupRetentionPolicy
+        def self.included(thor)
+          thor.class_eval do
+            include Helpers::Environment
+            include Term::ANSIColor
+
+            desc 'backup_retention_policy [ENVIRONMENT_HANDLE]',
+                 'Show the current backup retention policy for the environment'
+            define_method 'backup_retention_policy' do |env|
+              account = ensure_environment(environment: env)
+              policy = account.backup_retention_policies.first
+              unless policy
+                raise Thor::Error, "Environment #{env} does not have a " \
+                                   'custom backup retention policy'
+              end
+
+              Formatter.render(Renderer.current) do |root|
+                root.object do |node|
+                  ResourceFormatter.inject_backup_retention_policy(
+                    node, policy, account
+                  )
+                end
+              end
+            end
+
+            desc 'backup_retention_policy:set [ENVIRONMENT_HANDLE] ' \
+                 '[--daily DAILY_BACKUPS] [--monthly MONTHLY_BACKUPS] ' \
+                 '[--yearly YEARLY_BACKUPS] [--make-copy|--no-make-copy] ' \
+                 '[--keep-final|--no-keep-final]',
+                 "Change the environemnt's backup retention policy"
+            option :daily, type: :numeric,
+                           desc: 'Number of daily backups to retain'
+            option :monthly, type: :numeric,
+                             desc: 'Number of monthly backups to retain'
+            option :yearly, type: :numeric,
+                            desc: 'Number of yearly backups to retain'
+            option :make_copy, type: :boolean,
+                               desc: 'If backup copies should be created'
+            option(
+              :keep_final,
+              type: :boolean,
+              desc: 'If final backups should be kept when databases are ' \
+                    'deprovisioned'
+            )
+            define_method 'backup_retention_policy:set' do |env|
+              if options.empty?
+                raise Thor::Error,
+                      'Please specify at least one attribute to change'
+              end
+
+              account = ensure_environment(environment: env)
+              current_policy = account.backup_retention_policies.first
+
+              # If an attribute isn't provided, use the value from the current
+              # policy
+              attrs = {}
+              %i(daily monthly yearly make_copy keep_final).each do |a|
+                opt = options[a]
+                attrs[a] = opt.nil? ? current_policy.try(a) : opt
+              end
+
+              # If any of the attribues are missing, raise an error so that
+              # we're not relying on the server's defaults
+              if attrs.values.any?(&:nil?)
+                raise Thor::Error, "Environemnt #{env} does not have a " \
+                                   'custom backup retention policy. Please ' \
+                                   'specify all attributes to create one.'
+              end
+
+              new_policy = account.create_backup_retention_policy!(**attrs)
+
+              Formatter.render(Renderer.current) do |root|
+                root.object do |node|
+                  ResourceFormatter.inject_backup_retention_policy(
+                    node, new_policy.reload, account
+                  )
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aptible/cli/subcommands/config.rb

@@ -29,6 +29,23 @@ module Aptible
               end
             end
 
+            desc 'config:get [VAR1]',
+                 "Print a specific key within an app's current configuration"
+            app_options
+            define_method 'config:get' do |*args|
+              app = ensure_app(options)
+              config = app.current_configuration
+              env = config ? config.env : {}
+
+              Formatter.render(Renderer.current) do |root|
+                key = args[0]
+                value = env
+                        .select { |k| k == key }
+                        .map { |_, v| v }
+                root.value(value)
+              end
+            end
+
             desc 'config:add [VAR1=VAL1] [VAR2=VAL2] [...]',
                  'Add an ENV variable to an app'
             app_options

data/lib/aptible/cli/version.rb

@@ -1,5 +1,5 @@
 module Aptible
   module CLI
-    VERSION = '0.19.8'.freeze
+    VERSION = '0.20.0'.freeze
   end
 end

data/spec/aptible/cli/subcommands/config_spec.rb

@@ -57,6 +57,28 @@ describe Aptible::CLI::Agent do
     end
   end
 
+  describe '#config:get' do
+    it 'should show single environment variable specified' do
+      app.current_configuration = Fabricate(
+        :configuration, app: app, env: { 'FOO' => 'BAR', 'QUX' => 'two words' }
+      )
+      subject.send('config:get', 'FOO')
+
+      expect(captured_output_text).to match(/BAR/)
+      expect(captured_output_text).not_to match(/two\\ words/)
+      expect(captured_output_json).to match_array(['BAR'])
+    end
+
+    it 'should show empty line when env var not found' do
+      app.current_configuration = Fabricate(
+        :configuration, app: app, env: { 'FOO' => 'BAR', 'QUX' => 'two words' }
+      )
+      subject.send('config:get', 'MIZ')
+
+      expect(captured_output_text).to eq('')
+    end
+  end
+
   describe '#config:set' do
     it 'sets environment variables' do
       expect(app).to receive(:create_operation!)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aptible-cli
 version: !ruby/object:Gem::Version
-  version: 0.19.8
+  version: 0.20.0
 platform: ruby
 authors:
 - Frank Macreery
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-05-15 00:00:00.000000000 Z
+date: 2024-06-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aptible-resource
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.5.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.4'
+        version: 1.5.3
 - !ruby/object:Gem::Dependency
   name: aptible-auth
   requirement: !ruby/object:Gem::Requirement
@@ -290,20 +290,24 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".dockerignore"
 - ".github/CODEOWNERS"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- Dockerfile
 - Gemfile
+- Gemfile.lock
 - LICENSE.md
+- Makefile
 - README.md
 - Rakefile
 - SECURITY.md
 - appveyor.yml
 - aptible-cli.gemspec
 - bin/aptible
-- cleanup_bundler
 - codecov.yml
+- docker-compose.yml
 - lib/aptible/cli.rb
 - lib/aptible/cli/agent.rb
 - lib/aptible/cli/error.rb
@@ -341,6 +345,7 @@ files:
 - lib/aptible/cli/resource_formatter.rb
 - lib/aptible/cli/subcommands/apps.rb
 - lib/aptible/cli/subcommands/backup.rb
+- lib/aptible/cli/subcommands/backup_retention_policy.rb
 - lib/aptible/cli/subcommands/config.rb
 - lib/aptible/cli/subcommands/db.rb
 - lib/aptible/cli/subcommands/deploy.rb
@@ -437,7 +442,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.0.3.1
 signing_key:
 specification_version: 4
 summary: Command-line interface for Aptible services

data/cleanup_bundler

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-# Newer rubies have Bundler 2.x installed as default so it can't be deleted
-# We need Bundler 1.x
-
-gempaths = `gem env gempath`.split(':')
-gempaths.each do |gempath|
-  # lookup bundler-*.gemspec files and delete them
-  # this is the only way to completely cleanup default bundler
-  # Note: the bundler gemspecs' paths are different for CRuby and JRuby
-  Dir.glob(gempath.strip + '/specifications/**/bundler-*.gemspec').each do |p|
-    File.delete(p)
-  end
-end