brightbox-cli 3.3.0 → 4.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 881d758fc2932375edc56797f613f757a7f83729087cf2335a44736f4554fe1d
-  data.tar.gz: cfb933331637277089d47a0feccf9456e18b45f0a248aa27f233c52f24ba2f61
+  metadata.gz: 22b1f59a54b3f902822d401bfc12d5bf3b797ac07ca778006abc0627423fe7f6
+  data.tar.gz: ea3417d3a85def958ffe7897493056ceccb07f40d3370f6c20047333bb29066c
 SHA512:
-  metadata.gz: a7b28703cc70a953b900f0caabaf036ff78c1e914810fcba9523b7f8b44ae5c7d148ee09f08d073d71449b587024f7d64ead1f88a659c3a2d2a52c502134d23a
-  data.tar.gz: ea62fcbe6b909e8b7cb8744da7acacd50c75bcb0c109fada221ef135ff1c1ac0d88dc01d8975ef3a8068c75e86956ce244ab88abc641e2dc3d79ed474502e59d
+  metadata.gz: f5d7882274fbf277684ace5bd46bace4e2a3157e09ae3e91313e746edb134501d525cee5a2e2121e38780f355141e14d322e800fd83ad1393d5a9b10be2b53ff
+  data.tar.gz: 82af52ec25efac5169fef7dd5f2e7b2ad8b4975b9d0dffb9c6014930ceead76a1b251379ca6c185f04b23df77ccfd649e79eaabcc27f837d5d8f0a1040b18bcf

data/.gitattributes

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

data/.github/workflows/ruby.yml

@@ -20,7 +20,7 @@ jobs:
 
     strategy:
       matrix:
-        ruby: ["2.1", "2.2", "2.3", "2.4", "2.5", "2.6", "2.7", "3.0"]
+        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,55 @@
+### v4.0.0 / master
+
+[Full Changelog](https://github.com/brightbox/brightbox-cli/compare/v3.3.0...master)
+
+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)

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    brightbox-cli (3.3.0)
-      dry-inflector (< 0.2)
-      fog-brightbox (>= 1.3.0)
+    brightbox-cli (4.0.0.rc2)
+      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)
 
@@ -17,14 +17,16 @@ GEM
   specs:
     addressable (2.8.0)
       public_suffix (>= 2.0.2, < 5.0)
+    ast (2.4.2)
     builder (3.2.4)
-    coderay (1.0.9)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.10)
     crack (0.4.5)
       rexml
-    diff-lcs (1.4.3)
-    dry-inflector (0.1.2)
-    excon (0.79.0)
-    fog-brightbox (1.4.0)
+    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
@@ -35,45 +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)
-    public_suffix (2.0.5)
-    rake (12.3.3)
+    public_suffix (4.0.7)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.5.0)
     rexml (3.2.5)
-    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)
+    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)
-    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
@@ -84,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,13 +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 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]
+You will need a Brightbox account in order to make use of these tools.
 
+You can sign up at https://cloud.brightbox.com/signup
 
 == Installation instructions
 
@@ -101,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>"
@@ -129,11 +124,10 @@ appropriate section:
     password_helper_command = pass john-example-com-brightbox
 
 
-== Usage guides
+== Documentation
 
-* http://docs.brightbox.com/reference/cli
-* http://brightbox.com
-* http://docs.brightbox.com/reference/api/
+* https://www.brightbox.com/docs/guides/cli/
+* http://www.brightbox.com/docs/reference/cli/
 
 == BASH Auto-completion
 
@@ -175,12 +169,13 @@ process is not perfect, please report an issue
 
 == Alternatives
 
-There are a number of alternative ways to interact with the Brightbox Cloud.
+There are a number of alternative ways to manage Brightbox resources:
 
-* 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
+* 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
 
 == Packaging
 

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

data/lib/brightbox-cli/api.rb

@@ -4,12 +4,13 @@ module Brightbox
 
   class Api
     attr_reader :id
-    class ApiError < StandardError ; end
-    class NotFound < ApiError ; end
-    class Conflict < ApiError ; end
-    class InvalidRecord < ApiError ; end
-    class Forbidden < ApiError ; end
-    class InvalidArguments < ApiError ; end
+
+    class ApiError < StandardError; end
+    class NotFound < ApiError; end
+    class Conflict < ApiError; end
+    class InvalidRecord < ApiError; end
+    class Forbidden < ApiError; end
+    class InvalidArguments < ApiError; end
 
     @@connection_manager = nil
 
@@ -19,12 +20,8 @@ module Brightbox
     # @return [Fog::Brightbox::Compute::Real]
     #
     def self.conn
-      if @@connection_manager
-        @@connection_manager.fetch_connection(require_account?)
-      else
-        @@connection_manager = Brightbox::ConnectionManager.new(Brightbox.config.to_fog)
-        @@connection_manager.fetch_connection(require_account?)
-      end
+      @@connection_manager ||= Brightbox::ConnectionManager.new(Brightbox.config.to_fog)
+      @@connection_manager.fetch_connection(require_account?)
     end
 
     # Returns +true+ if instances of this class require account details to be
@@ -43,14 +40,14 @@ module Brightbox
       name.split("::").last
     end
 
-    def initialize(m = nil)
-      if m.is_a? String
-        @id = m
-      elsif m.respond_to?(:attributes) && m.respond_to?(:id)
-        @fog_model = m
-        @id = m.id
+    def initialize(model = nil)
+      if model.is_a? String
+        @id = model
+      elsif model.respond_to?(:attributes) && model.respond_to?(:id)
+        @fog_model = model
+        @id = model.id
       else
-        raise InvalidArguments, "Can't initialize #{self.class} with #{m.inspect}"
+        raise InvalidArguments, "Can't initialize #{self.class} with #{model.inspect}"
       end
       Brightbox.config.cache_id(@id) if Brightbox.config.respond_to?(:cache_id)
     end
@@ -99,6 +96,7 @@ module Brightbox
     def self.find(args = :all, options = {})
       raise InvalidArguments, "find(nil)" if args.nil?
       raise InvalidArguments, "find([])" if args.respond_to?(:empty?) && args.empty?
+
       options = { :order => :created_at }.merge(options)
 
       objects = nil
@@ -113,6 +111,7 @@ module Brightbox
         objects = args.map do |arg|
           o = cached_get(arg.to_s)
           raise NotFound, "Couldn't find '#{arg}'" if o.nil?
+
           o
         end
       else
@@ -141,21 +140,23 @@ module Brightbox
     def self.find_or_call(ids, &_block)
       objects = []
       ids.each do |id|
-        begin
-          objects << find(id)
-        rescue Api::NotFound
-          yield id
-        end
+        objects << find(id)
+      rescue Api::NotFound
+        yield id
       end
       objects
     end
 
-    def method_missing(m, *args)
-      if fog_model
-        fog_model.send(m, *args)
-      else
-        raise NoMethodError
-      end
+    def method_missing(method_name, *args)
+      raise NoMethodError unless fog_model
+
+      fog_model.send(method_name, *args)
+    end
+
+    def respond_to_missing?(method_name, _)
+      return false unless fog_model
+
+      fog_model.respond_to?(method_name)
     end
 
     def self.cached_get(id)
@@ -169,9 +170,10 @@ module Brightbox
       end
     end
 
-    def self.find_by_handle(h)
-      object = find(:all).find { |o| o.handle == h }
-      raise Api::NotFound, "Invalid #{klass_name} #{h}" if object.nil?
+    def self.find_by_handle(handle)
+      object = find(:all).find { |obj| obj.handle == handle }
+      raise Api::NotFound, "Invalid #{klass_name} #{handle}" if object.nil?
+
       object
     end
 
@@ -186,9 +188,9 @@ module Brightbox
     # Displays creation date in ISO 8601 Complete date format
     #
     def created_on
-      if fog_model.created_at
-        fog_model.created_at.strftime("%Y-%m-%d")
-      end
+      return unless fog_model.created_at
+
+      fog_model.created_at.strftime("%Y-%m-%d")
     end
   end
 end

data/lib/brightbox-cli/cloud_ips.rb

@@ -27,6 +27,7 @@ module Brightbox
       translators.split(",").map do |t|
         incoming, outgoing, protocol = t.split(":")
         raise "translator #{t} is invalid" if incoming.nil? || outgoing.nil? || protocol.nil?
+
         { :incoming => incoming, :outgoing => outgoing, :protocol => protocol }
       end
     end
@@ -44,21 +45,20 @@ module Brightbox
     end
 
     def mapped?
-      status == 'mapped'
+      status == "mapped"
     end
 
     def translators(raw_attributes)
-      if translators = (raw_attributes[:port_translators] || raw_attributes['port_translators'])
-        translators.map do |t|
-          [t['incoming'], t['outgoing'], t['protocol']].join(":")
-        end
-      else
-        nil
+      translators = (raw_attributes[:port_translators] || raw_attributes["port_translators"])
+      return unless translators
+
+      translators.map do |t|
+        [t["incoming"], t["outgoing"], t["protocol"]].join(":")
       end
     end
 
     def self.default_field_order
-      [:id, :status, :public_ip, :destination, :reverse_dns, :name]
+      %i[id status public_ip destination reverse_dns name]
     end
 
     def <=>(other)