brightbox-cli 3.2.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5c03039c9263c4872064938223b825be9550d1c08e2a77d438b68f1fd7b42cc
-  data.tar.gz: 85f994952c28133cf8ad08c70d16228b165373f94a90916a0a83fe365e14672d
+  metadata.gz: cf8d230d121ac70d4971ed2acf19776ed75bac9256d4f4ea7d980af8e563350a
+  data.tar.gz: feb53ae71fe302c76fcbe2f6b4e1e67723b64d706266ed3db5531195df9ec167
 SHA512:
-  metadata.gz: 013e062376468560718cfbf25c2e2221db7e0808bcadc6413b6cbf5532b966917de0e2c40d2ffd1a859f8fd78267c28b86166e5638d2869cfe22e9c315bd8a4b
-  data.tar.gz: f81c26c3a3705e6caa3399e1598e4c8ad399f175a0be4d26c2383ccfab8a8cfc75c2ebde0135aa9cee2f4cd220df2119a4d3a880b4c585b3dfc113384cfe57e6
+  metadata.gz: c5325d637d559f620a9b5a4cff4157aa67f6da2a802329c59d81270a429958afbf5e7d9f982d59d99786f099931b64bd1f50feedd123e6221371580234ac8986
+  data.tar.gz: 97431207227f81834213a4ab61c6d77d78f526ba4ec1a1885975c4169299cb4f88c323197984391ffed000feee9523b0a4aabbc7075fc15fe8389943400cb8d9

data/.gitattributes

@@ -0,0 +1 @@
+spec/cassettes/**/*.yml linguist-generated

data/.github/workflows/ruby.yml

@@ -20,7 +20,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ["2.4", "2.5", "2.6", "2.7"]
+        ruby: ["2.5", "2.6", "2.7", "3.0", "3.1", "head"]
 
     steps:
     - uses: actions/checkout@v2

data/.gitignore

@@ -16,4 +16,4 @@ spec/brightbox/cache/
 *.html
 *.gem
 /vendor/
-
+spec/examples.txt

data/.rubocop.yml

@@ -0,0 +1,70 @@
+AllCops:
+  NewCops: enable
+  Exclude:
+    - bin/*
+    - lib/brightbox-cli/vendor/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.5
+
+Layout/HeredocIndentation:
+  Enabled: true
+
+Layout/LineLength:
+  Enabled: false
+  Max: 100
+
+Lint/SuppressedException:
+  Enabled: false
+
+Metrics/AbcSize:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false
+
+Metrics/ClassLength:
+  Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Naming/HeredocDelimiterNaming:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/Encoding:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/HashSyntax:
+  Enabled: true
+  EnforcedStyle: no_mixed_keys
+
+Style/GlobalVars:
+  Enabled: false # It's horrid, there's so many
+
+Style/IfUnlessModifier:
+  Enabled: false
+
+Style/SignalException:
+  # Valid values are: semantic, only_raise and only_fail
+  EnforcedStyle: only_raise
+
+Style/SingleLineMethods:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes

data/CHANGELOG.md

@@ -1,3 +1,74 @@
+### v4.0.0 / 2022-08-01
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v3.3.0...v4.0.0)
+
+Backwards incompatible changes:
+
+* Drop support for Ruby versions older than 2.5
+* Update `Gemfile.lock` to use Bundler 2.1.4
+* Remove hypenated versions of sub commands. For example `brightbox-servers`
+  wrapping `brightbox servers`.
+
+Changes:
+
+* Improved Two Factor Authentication (2FA) support resulting in it working
+  automatically without configuration prompting when required. The `two_factor`
+  configuration setting is now ignored
+* The `brightbox login` command will now work when 2FA is enabled for a user
+* Adds Ruby 3.1 and 3.2 (preview) to testing matrix
+* Update `fog-brightbox` to `v1.7.0`
+* Removed references to `Fixnum` from code and dependencies to allow
+  testing of Ruby 3.2 support
+* Updates `webmock` from 1.21.0 to 3.14.0
+* Removes `rubyforge` reference from gemspec to remove deprecation warning
+* Remove post install message from gemspec
+* Update `gli` to latest version v2.21.0 to clear some deprecations seen under
+  later Ruby versions
+* Update development gems to ensure up to date
+* Change `client_id` logging level from info to debug
+* Setup Rubocop to help improve code quality/consistency
+* Updated code based on Rubocop reports resulting in many changes
+* Pin `dry-inflector` to v0.2.0 to prevent issues with Ruby =< 2.5
+* Add support for `min-ram` to `brightbox images` commands
+* Update authors (and emails) in gemspec
+
+Bug fixes:
+
+* Implement `Brightbox::Api#respond_to_missing?` to avoid issues when
+  delegating made `#respond_to?` raise an error
+* `brightbox login` no longer attempts (and fails) to download accounts when
+  authentication has failed
+
+Testing:
+
+* Updated testing/development gems
+* Update VCR to latest release v2.9.3
+* Remove VCR identifier sanitisation as temp dev instance are used and
+  squashing IDs cause bug when chain/multiple requests combined
+* RSpec is configured to allow re-runs
+* Timeout testing is dropped to 10s
+* Updated `.dev` TLD used in testing to `.localhost` to avoid problems when the
+  original was commercialised such as local DNS blocked by browsers.
+
+### v3.3.0 / 2021-09-17
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v3.2.0...v3.3.0)
+
+Changes:
+
+* Update `fog-brightbox` to v1.4.0` (allowing Ruby 3.0 support)
+* Added support for getting 2FA from helper
+* Added missing `sql snapshot` fields
+* Infrastructure changes to test on more versions of Ruby
+* Added GitHub actions support for CI testing.
+* Removed Travis CI support.
+
+Bug fixes:
+
+* Updates `crack` gem to switch from `safe_yaml` to `rexml`
+* Bump addressable from 2.3.8 to 2.8.0. (fixing ReDoS vulnerability)
+* Bump rexml from 3.2.4 to 3.2.5 (fixing round-trip vulnerability bugs)
+
 ### v3.2.0 / 2020-11-26
 
 [Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v3.1.0...v3.2.0)

data/Gemfile.lock

@@ -1,29 +1,32 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (3.2.0)
-      dry-inflector (< 0.2)
-      fog-brightbox (>= 1.3.0)
+    brightbox-cli (4.0.0)
+      dry-inflector (= 0.2.0)
+      fog-brightbox (>= 1.7.0)
       fog-core (< 2.0)
-      gli (~> 2.12.0)
+      gli (~> 2.21.0)
       highline (~> 1.6.0)
       hirb (~> 0.6)
-      i18n (~> 0.6.0)
+      i18n (>= 0.6, < 1.11)
       mime-types (~> 2.6)
       multi_json (~> 1.11.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.3.8)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     builder (3.2.4)
-    coderay (1.0.9)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.4.3)
-    dry-inflector (0.1.2)
-    excon (0.78.0)
-    fog-brightbox (1.3.0)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.5.0)
+    dry-inflector (0.2.0)
+    excon (0.92.4)
+    fog-brightbox (1.7.0)
       dry-inflector
       fog-core (>= 1.45, < 3.0)
       fog-json
@@ -34,44 +37,67 @@ GEM
     fog-json (1.2.0)
       fog-core
       multi_json (~> 1.10)
-    formatador (0.2.5)
-    gli (2.12.3)
+    formatador (0.3.0)
+    gli (2.21.0)
+    hashdiff (1.0.1)
     highline (1.6.21)
     hirb (0.7.3)
-    i18n (0.6.11)
-    metaclass (0.0.1)
-    method_source (0.8.1)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
     mime-types (2.99.3)
-    mocha (0.14.0)
-      metaclass (~> 0.0.1)
+    mocha (1.14.0)
     multi_json (1.11.3)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
+    parallel (1.22.1)
+    parser (3.1.2.0)
+      ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     pry-remote (0.1.8)
       pry (~> 0.9)
       slop (~> 3.0)
-    rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
+    rexml (3.2.5)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
-    safe_yaml (1.0.4)
-    slop (3.4.5)
-    vcr (2.5.0)
-    webmock (1.21.0)
-      addressable (>= 2.3.6)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.28.2)
+      parallel (~> 1.10)
+      parser (>= 3.1.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.17.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.17.0)
+      parser (>= 3.1.1.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.10.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    slop (3.6.0)
+    unicode-display_width (2.1.0)
+    vcr (2.9.3)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   ruby
@@ -82,8 +108,11 @@ DEPENDENCIES
   pry-remote
   rake
   rspec
+  rubocop
+  rubocop-rake
+  rubocop-rspec
   vcr (~> 2.5)
   webmock
 
 BUNDLED WITH
-   1.17.3
+   2.1.4

data/README

@@ -2,24 +2,9 @@
 
 `brightbox-cli` is a set of cli tools to interact with the Brightbox Cloud API.
 
-You will need a user account on the Brightbox Cloud in order to make use of
-these tools.
+You will need a Brightbox account in order to make use of these tools.
 
-You can sign up at https://manage.brightbox.com
-
-{<img src="https://travis-ci.org/brightbox/brightbox-cli.png?branch=master" alt="Build Status" />}[https://travis-ci.org/brightbox/brightbox-cli]
-
-== UPGRADE NOTES
-
-Version 1.0.0 adds a new top level `brightbox` command for the suite.
-
-This may clash with our `brightbox` (brightbox-deployment) gem which, before
-version 2.4.0, used `brightbox` as the name for it's binary. Please ensure you
-update your `brightbox` gem to avoid using the wrong command.
-
-We have included backwards compatible binaries for all the older CLI commands
-(brightbox-accounts, brightbox-servers etc...) but recommend getting used to the
-new form.
+You can sign up at https://cloud.brightbox.com/signup
 
 == Installation instructions
 
@@ -36,7 +21,11 @@ For a list of available commands use:
 
    $ brightbox help
 
-To add client (account based) credentials use:
+To login with your user credentials use:
+
+   $ brightbox login john@example.com
+
+To instead add api client (account-specific) credentials use:
 
    $ brightbox config client_add cli-2igtb theclientsecret
    Using config file /home/ubuntu/.brightbox/config
@@ -49,7 +38,14 @@ To browse available resources use the resource name as the command:
    $ brightbox images
    ... List of images
 
-Command structure may be subject to change.
+=== Two factor authentication ===
+
+If you've enabled two factor authentication for your user, you should be
+prompted for a one time password (OTP) when it is required unless you have set
+up a two factor helper (see below).
+
+The previous configuration setting `two_factor` is no longer required when
+using v4.0 or greater. This is ignored and can be removed.
 
 === Integrating with a password manager
 
@@ -64,6 +60,13 @@ appropriate section:
     username = john@example.com
     password_helper_command = pass john-example-com-brightbox
 
+You can also specify a separate helper command to retrive two factor pins:
+
+    [john@example.com]
+    username = john@example.com
+    password_helper_command = pass john-example-com-brightbox
+    two_factor_helper_command = get-two-factor-pin john-example-com-brightbox
+
 === Using GPG to secure passwords
 
 If you use an OAuth application to access your accounts
@@ -94,7 +97,6 @@ The alias here is `main`. To prepare the password run this command:
     $ gpg --decrypt ~/.brightbox/main.password.gpg
     password!2015
     $ brightbox accounts
-    INFO: client_id: app-12345 (main)
     INFO: Decrypting /home/user/.brightbox/main.password.gpg to obtain password
     gpg: encrypted with 2048-bit RSA key, ID ABCDE890, created 2015-01-01
           "Jason Null <gpg@example.com>"
@@ -108,11 +110,24 @@ incorrectly or there may be an issue with your GPG configuration.
 
 To remove the password delete the `~/.brightbox/main.password.gpg` file.
 
-== Usage guides
+=== Integrating with a password manager
 
-* http://docs.brightbox.com/reference/cli
-* http://brightbox.com
-* http://docs.brightbox.com/reference/api/
+You can retrieve your passwords from an external password manager by specifying
+a password helper command. This command will be executed any time your password
+is required and its output used as your password.
+
+Configure the command in your config file (usually ~/.brightbox/config) in the
+appropriate section:
+
+    [john@example.com]
+    username = john@example.com
+    password_helper_command = pass john-example-com-brightbox
+
+
+== Documentation
+
+* https://www.brightbox.com/docs/guides/cli/
+* http://www.brightbox.com/docs/reference/cli/
 
 == BASH Auto-completion
 
@@ -130,6 +145,24 @@ in the path, just specify the full path to it:
 
     complete -C /full/path/to/bin/_brightbox-bash-completer -o filenames brightbox
 
+== UPGRADE NOTES
+
+Version 4.0.0 removes the older, backward compatible binaries for users of the
+original `brightbox` (brightbox-deployment) gem.
+
+So `brightbox-servers` will no longer work. Use the subcommand variation
+`brightbox servers` instead.
+
+== Alternatives
+
+There are a number of alternative ways to manage Brightbox resources:
+
+* Control Panel - https://cloud.brightbox.com/
+* Terraform – https://registry.terraform.io/providers/brightbox/brightbox/latest
+* Kubernetes - https://github.com/brightbox/brightbox-cloud-controller-manager
+* fog - https://github.com/fog/fog-brightbox
+* Go - https://github.com/brightbox/gobrightbox
+
 == Testing
 
 You should be able to run the specs and features with the following steps:
@@ -140,15 +173,6 @@ You should be able to run the specs and features with the following steps:
 The specs use VCR to playback filtered recordings from real API sessions. This
 process is not perfect, please report an issue
 
-== Alternatives
-
-There are a number of alternative ways to interact with the Brightbox Cloud.
-
-* The Web GUI - https://manage.brightbox.com/
-* fog - https://github.com/fog/fog
-* knife plugin - https://github.com/rubiojr/knife-brightbox
-* Vagrant plugin - https://github.com/NeilW/vagrant-brightbox
-
 == Packaging
 
 === Vendoring libraries

data/README.rdoc

@@ -1 +1 @@
-./README
+README

data/brightbox-cli.gemspec

@@ -1,60 +1,47 @@
 # -*- encoding: utf-8 -*-
+
 require File.join(File.dirname(__FILE__), "lib/brightbox-cli/version")
 
 Gem::Specification.new do |s|
   s.name        = "brightbox-cli"
   s.version     = Brightbox::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["John Leach"]
-  s.email       = ["john@brightbox.co.uk"]
-  s.homepage    = "http://docs.brightbox.com/cli"
-  s.summary     = %q(The Brightbox cloud management system)
-  s.description = %q(Scripts to interact with the Brightbox cloud API)
+  s.authors     = ["John Leach", "Paul Thornthwaite"]
+  s.email       = ["john@brightbox.com", "paul@brightbox.com"]
+  s.homepage    = "https://www.brightbox.com/cli"
+  s.summary     = "The Brightbox cloud management system"
+  s.description = "Scripts to interact with the Brightbox cloud API"
   s.license     = "MIT"
+  s.metadata['rubygems_mfa_required'] = 'true'
 
-  s.required_ruby_version = ">= 2.0"
-
-  s.rubyforge_project = "brightbox-cli"
+  s.required_ruby_version = ">= 2.5"
 
   s.files         = `git ls-files`.split("\n") + `find lib/brightbox-cli/vendor`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   s.require_paths = ["lib"]
 
-  s.add_dependency "fog-brightbox", ">= 1.3.0"
+  s.add_dependency "fog-brightbox", ">= 1.7.0"
   s.add_dependency "fog-core", "< 2.0"
-  s.add_dependency "gli", "~> 2.12.0"
-  s.add_dependency "i18n", "~> 0.6.0"
-  s.add_dependency "mime-types", "~> 2.6"
-  s.add_dependency "multi_json", "~> 1.11.0"
+  s.add_dependency "gli", "~> 2.21.0"
   s.add_dependency "highline", "~> 1.6.0"
   s.add_dependency "hirb", "~> 0.6"
+  s.add_dependency "i18n", ">= 0.6", "< 1.11"
+  s.add_dependency "mime-types", "~> 2.6"
+  s.add_dependency "multi_json", "~> 1.11.0"
 
-  # dry-inflector >= 0.2 drops supports for Ruby < 2.4
-  s.add_dependency "dry-inflector", "< 0.2"
+  # Indirect dependency
+  # 0.3 drops support for Ruby < 2.7
+  # 0.2.1 drops support for Ruby < 2.6
+  s.add_dependency "dry-inflector", "= 0.2.0"
 
   s.add_development_dependency "mocha"
   s.add_development_dependency "pry-remote"
   s.add_development_dependency "rake"
   s.add_development_dependency "rspec"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-rake"
+  s.add_development_dependency "rubocop-rspec"
   s.add_development_dependency "vcr", "~> 2.5"
   s.add_development_dependency "webmock"
-
-  s.post_install_message = <<-EOS
-The CLI command is now `brightbox` with subcommands for the resources.
-Such as `brightbox config` or `brightbox servers`.
-
-  `brightbox --help` lists all the commands.
-
-The old hypenated versions of the commands (e.g. `brightbox-servers`)
-are deprecated and may be removed in the future.
-
-If you have been using the old "brightbox" gem please ensure you have
-the latest version to be able to use the `brightbox-capify` command.
-
-To enable Bash auto-completion you can do the following:
-
-  complete -C _brightbox-bash-completer -o filenames brightbox
-
-EOS
 end

data/lib/brightbox-cli/accounts.rb

@@ -25,21 +25,19 @@ module Brightbox
     end
 
     def self.get(id)
-      if Brightbox.config.using_application?
-        a = conn.accounts.get(id)
-      else
-        a = conn.account
-      end
+      acc = if Brightbox.config.using_application?
+              conn.accounts.get(id)
+            else
+              conn.account
+            end
 
-      if a && a.id == id
-        a
-      else
-        nil
-      end
+      return unless acc && acc.id == id
+
+      acc
     end
 
     def self.default_field_order
-      [:id, :name, :cloud_ips_limit, :lb_limit, :ram_limit, :ram_used, :ram_free]
+      %i[id name cloud_ips_limit lb_limit ram_limit ram_used ram_free]
     end
 
     def to_s