fog-brightbox 1.5.0.rc1 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21377239d27fb6e504db5619e6ce945fdee02066f01f75629efd9028df3ba6e5
-  data.tar.gz: a7d34f4986720231418c445f1d121faa7001626e7984fe4b9e022afde73f807c
+  metadata.gz: 930c37c33d46857b7fa6f4e9880bd11068f9b4cc3a90aad25d1db39904ae6601
+  data.tar.gz: e9bfaa815ea41d8a0fc5afc094b4e7626d8dfa3fb7b35ddb58f9fa0c60aaf945
 SHA512:
-  metadata.gz: e69f8b23071481ccc0642a12e237f82de430e149cdf171e2d1a8b1275a69e13081ff62df96c5df0128a311a7fcf0883cb10daf699296928147f6c02d7287eb5d
-  data.tar.gz: 38e0912ad00a805b6828c0238cf19408a16b29011d997b4876b322d0375793701160724b0b29c328127330a0ed1328091b0338bc3e11f57f84f0f95923c60746
+  metadata.gz: e7d00dbc24b5d7b9c2e292bf7caa4797d93ed6d94d28622ea5beb9f29af6c29d6098d17ab495d3707f9e7a847694f9a331e5de5268000bddb1e4f884d80566c6
+  data.tar.gz: 4164e7796800011e460411dccc08efb780362b61afd2790b5af8e724151c86e50e315fba45f785ad8cf5fb44f9016e1aac36d7093436f07670332afff66c1aec

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+### 1.7.0 / 2022-07-28
+
+Changes:
+
+* Adds support for `ConfigMaps` which are simple key/value stores for configuring
+  other resources.
+* Updated the API models to include the latest set of attributes defined in the
+  Brightbox API enabling them to be referenced.
+
+### 1.6.0 / 2022-07-25
+
+Changes:
+
+* Added support to opt-in to support Brightbox 2FA within clients.
+
+Two Factor Authentication (2FA) support:
+
+Passing `brightbox_support_two_factor` into a configuration will raise a new
+error when user authentication has failed BUT the presence of the
+`X-Brightbox-OTP: required` HTTP header is found.
+
+This new error `Fog::Brightbox::OAuth2::TwoFactorMissingError` can be handled
+differently by the client and the second factor can be prompted for or
+recovered from a secure keychain.
+
+Without opting in, the previous error `Excon::Errors::Unauthorized` is raised.
+
+To send the OTP, the `brightbox_one_time_password` can be passed into a
+configuration object or one_time_password can be passed to a credentials
+object.
+
 ### 1.5.0 / 2022-06-09
 
 Changes:

data/lib/fog/brightbox/compute/shared.rb

@@ -39,21 +39,15 @@ module Fog
           @persistent          = @config.connection_persistent?
           @connection          = Fog::Core::Connection.new(@api_url, @persistent, @connection_options)
 
-          # Authentication options
-          client_id            = @config.client_id
-          client_secret        = @config.client_secret
-
-          username             = @config.username
-          password             = @config.password
           @configured_account  = @config.account
           # Request account can be changed at anytime and changes behaviour of future requests
           @scoped_account      = @configured_account
 
-          credential_options   = { :username => username, :password => password }
-          @credentials         = CredentialSet.new(client_id, client_secret, credential_options)
+          @two_factor          = @config.two_factor?
+          @one_time_password   = @config.one_time_password
 
           # If existing tokens have been cached, allow continued use of them in the service
-          @credentials.update_tokens(@config.cached_access_token, @config.cached_refresh_token)
+          credentials.update_tokens(@config.cached_access_token, @config.cached_refresh_token)
 
           @token_management    = @config.managed_tokens?
         end
@@ -73,6 +67,12 @@ module Fog
           @scoped_account = @configured_account
         end
 
+        def credentials
+          client_id = @config.client_id
+          client_secret = @config.client_secret
+          @credentials ||= CredentialSet.new(client_id, client_secret, credential_options)
+        end
+
         # Returns the scoped account being used for requests
         #
         # * For API clients this is the owning account
@@ -122,7 +122,7 @@ module Fog
         def get_access_token
           begin
             get_access_token!
-          rescue Excon::Errors::Unauthorized, Excon::Errors::BadRequest
+          rescue Fog::Brightbox::OAuth2::TwoFactorMissingError, Excon::Errors::Unauthorized, Excon::Errors::BadRequest
             @credentials.update_tokens(nil, nil)
           end
           @credentials.access_token
@@ -154,8 +154,24 @@ module Fog
           @default_image_id ||= (@config.default_image_id || select_default_image)
         end
 
+        def two_factor?
+          @two_factor || false
+        end
+
         private
 
+        # This returns a formatted set of options for the credentials for this service
+        #
+        # @return [Hash]
+        def credential_options
+          {
+            username: @config.username,
+            password: @config.password
+          }.tap do |opts|
+            opts[:one_time_password] = @one_time_password if two_factor?
+          end
+        end
+
         # This makes a request of the API based on the configured setting for
         # token management.
         #

data/lib/fog/brightbox/compute.rb

@@ -21,6 +21,10 @@ module Fog
       # Automatic token management
       recognizes :brightbox_token_management
 
+      # Two Factor Authentication support (2FA)
+      recognizes :brightbox_support_two_factor
+      recognizes :brightbox_one_time_password
+
       # Excon connection settings
       recognizes :persistent
 
@@ -33,6 +37,8 @@ module Fog
       model :api_client
       collection :collaborations
       model :collaboration
+      collection :config_maps
+      model :config_map
       collection :servers
       model :server
       collection :server_groups
@@ -81,6 +87,7 @@ module Fog
       request :create_application
       request :create_cloud_ip
       request :create_collaboration
+      request :create_config_map
       request :create_firewall_policy
       request :create_firewall_rule
       request :create_image
@@ -93,6 +100,7 @@ module Fog
       request :delete_application
       request :delete_cloud_ip
       request :delete_collaboration
+      request :delete_config_map
       request :delete_firewall_policy
       request :delete_firewall_rule
       request :delete_image
@@ -110,6 +118,7 @@ module Fog
       request :get_authenticated_user
       request :get_cloud_ip
       request :get_collaboration
+      request :get_config_map
       request :get_firewall_policy
       request :get_firewall_rule
       request :get_image
@@ -131,6 +140,7 @@ module Fog
       request :list_applications
       request :list_cloud_ips
       request :list_collaborations
+      request :list_config_maps
       request :list_events
       request :list_firewall_policies
       request :list_images
@@ -184,6 +194,7 @@ module Fog
       request :update_api_client
       request :update_application
       request :update_cloud_ip
+      request :update_config_map
       request :update_firewall_policy
       request :update_firewall_rule
       request :update_image

data/lib/fog/brightbox/config.rb

@@ -33,6 +33,10 @@ module Fog
       #   Set to specify the client secret to use for requests.
       # @option options [String] :brightbox_token_management (true)
       #   Set to specify if the service should handle expired tokens or raise an error instead.
+      # @option options [Boolean] :brightbox_support_two_factor
+      #   Set to enable two factor authentication (2FA) for this configuration/user
+      # @option options [String] :brightbox_one_time_password
+      #   Set to pass through the current one time password when using 2FA
       # @option options [String] :brightbox_username
       #   Set to specify your user account. Either user identifier (+usr-12345+) or email address
       #   may be used.
@@ -226,6 +230,14 @@ module Fog
       def storage_temp_key
         @options[:brightbox_temp_url_key]
       end
+
+      def two_factor?
+        @options[:brightbox_support_two_factor] || false
+      end
+
+      def one_time_password
+        @options[:brightbox_one_time_password]
+      end
     end
   end
 end

data/lib/fog/brightbox/models/compute/account.rb

@@ -3,8 +3,8 @@ module Fog
     class Compute
       class Account < Fog::Brightbox::Model
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :name
         attribute :status
@@ -20,35 +20,47 @@ module Fog
         attribute :telephone_number
         attribute :verified_telephone
         attribute :verified_ip
-        attribute :servers_used
-        attribute :ram_limit
-        attribute :ram_used
-        attribute :cloud_ips_limit
-        attribute :cloud_ips_used
-        attribute :load_balancers_limit
-        attribute :load_balancers_used
-        attribute :dbs_servers_used
-        attribute :dbs_ram_limit
-        attribute :dbs_ram_used
+
+        # Account limits (read-only)
+        attribute :block_storage_limit, type: :integer
+        attribute :block_storage_used, type: :integer
+        attribute :cloud_ips_limit, type: :integer
+        attribute :cloud_ips_used, type: :integer
+        attribute :dbs_instances_used, type: :integer
+        attribute :dbs_ram_limit, type: :integer
+        attribute :dbs_ram_used, type: :integer
+        attribute :load_balancers_limit, type: :integer
+        attribute :load_balancers_used, type: :integer
+        attribute :ram_limit, type: :integer
+        attribute :ram_used, type: :integer
+        attribute :servers_used, type: :integer
+
         attribute :library_ftp_host
         attribute :library_ftp_user
         # This is always returned as nil unless after a call to reset_ftp_password
         attribute :library_ftp_password
 
         # Boolean flags
-        attribute :valid_credit_card
-        attribute :telephone_verified
+        attribute :valid_credit_card, type: :boolean
+        attribute :telephone_verified, type: :boolean
 
-        # Times
-        attribute :created_at, :type => :time
-        attribute :verified_at, :type => :time
+        # Timestamps
+        attribute :created_at, type: :time
+        attribute :verified_at, type: :time
 
-        # Links - to be replaced
-        attribute :owner_id, :aliases => "owner", :squash => "id"
+        # Links
+        attribute :owner_id, aliases: "owner", squash: "id"
         attribute :clients
+        attribute :cloud_ips
+        attribute :database_servers
+        attribute :database_snapshots
+        attribute :firewall_policies
         attribute :images
+        attribute :load_balancers
+        attribute :server_groups
         attribute :servers
         attribute :users
+        attribute :volumes
         attribute :zones
 
         # Resets the account's image library FTP password returning the new value

data/lib/fog/brightbox/models/compute/api_client.rb

@@ -3,12 +3,20 @@ module Fog
     class Compute
       class ApiClient < Fog::Brightbox::Model
         identity :id
+        attribute :resource_type
+        attribute :url
+
         attribute :name
         attribute :description
+
         attribute :secret
-        attribute :revoked_at, :type => :time
         attribute :permissions_group
-        attribute :account_id
+
+        # Timestamps
+        attribute :revoked_at, type: :time
+
+        # Links
+        attribute :account_id, aliases: "account", squash: "id"
 
         def save
           raise Fog::Errors::Error.new("Resaving an existing object may create a duplicate") if persisted?

data/lib/fog/brightbox/models/compute/application.rb

@@ -3,10 +3,18 @@ module Fog
     class Compute
       class Application < Fog::Brightbox::Model
         identity :id
+        attribute :resource_type
         attribute :url
+
         attribute :name
+        attribute :description
         attribute :secret
 
+        # Timestamps
+        attribute :created_at, type: :time
+        attribute :updated_at, type: :time
+        attribute :revoked_at, type: :time
+
         def save
           raise Fog::Errors::Error.new("Resaving an existing object may create a duplicate") if persisted?
           options = {

data/lib/fog/brightbox/models/compute/cloud_ip.rb

@@ -3,28 +3,28 @@ module Fog
     class Compute
       class CloudIp < Fog::Brightbox::Model
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :name
         attribute :status
         attribute :description
 
-        attribute :reverse_dns
+        attribute :fqdn
+        attribute :mode
         attribute :public_ip
         attribute :public_ipv4
         attribute :public_ipv6
-        attribute :fqdn
+        attribute :reverse_dns
 
-        # Links - to be replaced
-        attribute :account_id, :aliases => "account", :squash => "id"
-        attribute :interface_id, :aliases => "interface", :squash => "id"
-        attribute :server_id, :aliases => "server", :squash => "id"
-        attribute :load_balancer, :alias => "load_balancer", :squash => "id"
-        attribute :server_group, :alias => "server_group", :squash => "id"
-        attribute :database_server, :alias => "database_server", :squash => "id"
+        # Links
+        attribute :account_id, aliases: "account", squash: "id"
+        attribute :interface_id, aliases: "interface", squash: "id"
+        attribute :server_id, aliases: "server", squash: "id"
+        attribute :load_balancer, :alias => "load_balancer", squash: "id"
+        attribute :server_group, :alias => "server_group", squash: "id"
+        attribute :database_server, :alias => "database_server", squash: "id"
         attribute :port_translators
-        attribute :name
 
         # Attempt to map or point the Cloud IP to the destination resource.
         #

data/lib/fog/brightbox/models/compute/collaboration.rb

@@ -3,10 +3,21 @@ module Fog
     class Compute
       class Collaboration < Fog::Brightbox::Model
         identity :id
+        attribute :resource_type
+        attribute :url
+
         attribute :status
+
         attribute :email
         attribute :role
         attribute :role_label
+
+        # Timestamps
+        attribute :created_at, type: :time
+        attribute :started_at, type: :time
+        attribute :finished_at, type: :time
+
+        # Links
         attribute :account
         attribute :user
         attribute :inviter

data/lib/fog/brightbox/models/compute/config_map.rb

@@ -0,0 +1,14 @@
+module Fog
+  module Brightbox
+    class Compute
+      class ConfigMap < Fog::Brightbox::Model
+        identity :id
+        attribute :resource_type
+        attribute :url
+
+        attribute :name
+        attribute :data
+      end
+    end
+  end
+end

data/lib/fog/brightbox/models/compute/config_maps.rb

@@ -0,0 +1,22 @@
+module Fog
+  module Brightbox
+    class Compute
+      class ConfigMaps < Fog::Collection
+        model Fog::Brightbox::Compute::ConfigMap
+
+        def all
+          data = service.list_config_maps
+          load(data)
+        end
+
+        def get(identifier)
+          return nil if identifier.nil? || identifier == ""
+          data = service.get_config_map(identifier)
+          new(data)
+        rescue Excon::Errors::NotFound
+          nil
+        end
+      end
+    end
+  end
+end

data/lib/fog/brightbox/models/compute/database_server.rb

@@ -5,39 +5,43 @@ module Fog
         include Fog::Brightbox::Compute::ResourceLocking
 
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :name
         attribute :description
-        attribute :state, :aliases => "status"
+        attribute :state, aliases: "status"
 
         attribute :admin_username
         attribute :admin_password
-
+        attribute :allow_access
         attribute :database_engine
         attribute :database_version
+        attribute :maintenance_hour #, type: :integer
+        attribute :maintenance_weekday #, type: :integer
+        attribute :source
 
-        attribute :maintenance_weekday
-        attribute :maintenance_hour
+        attribute :snapshots_retention, type: :string
 
         # This is a crontab formatted string e.g. "* 5 * * 0"
-        attribute :snapshots_schedule, :type => :string
-        attribute :snapshots_schedule_next_at, :type => :time
+        attribute :snapshots_schedule, type: :string
+        attribute :snapshots_schedule_next_at, type: :time
 
-        attribute :created_at, :type => :time
-        attribute :updated_at, :type => :time
-        attribute :deleted_at, :type => :time
+        # Timestamps
+        attribute :created_at, type: :time
+        attribute :updated_at, type: :time
+        attribute :deleted_at, type: :time
 
-        attribute :allow_access
+        # Links
+        attribute :flavor_id, alias: "database_server_type", squash: "id"
+        attribute :zone_id, alias: "zone", squash: "id"
 
-        attribute :flavor_id, "alias" => "database_server_type", :squash => "id"
-        attribute :zone_id, "alias" => "zone", :squash => "id"
+        attribute :account
+        attribute :cloud_ips
 
+        # Generated from snapshot action and not a real attribute
         attribute :snapshot_id
 
-        attribute :cloud_ips
-
         def save
           options = {
             :name => name,

data/lib/fog/brightbox/models/compute/database_snapshot.rb

@@ -7,21 +7,28 @@ module Fog
         include Fog::Brightbox::Compute::ResourceLocking
 
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :name
         attribute :description
-        attribute :state, :aliases => "status"
+        attribute :state, aliases: "status"
 
         attribute :database_engine
         attribute :database_version
 
-        attribute :size
+        attribute :size, type: :integer
+        attribute :source
+        attribute :source_trigger
+
+        # Timestamps
+        attribute :created_at, type: :time
+        attribute :updated_at, type: :time
+        attribute :deleted_at, type: :time
 
-        attribute :created_at, :type => :time
-        attribute :updated_at, :type => :time
-        attribute :deleted_at, :type => :time
+        # Links
+        attribute :account
+        attribute :account_id, aliases: "account", squash: "id"
 
         def save
           options = {

data/lib/fog/brightbox/models/compute/database_type.rb

@@ -3,14 +3,17 @@ module Fog
     class Compute
       class DatabaseType < Fog::Brightbox::Model
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :name
         attribute :description
 
-        attribute :disk, :aliases => "disk_size"
-        attribute :ram
+        attribute :disk, aliases: "disk_size", type: :integer
+        attribute :ram, type: :integer
+
+        # Boolean flags
+        attribute :default, type: :boolean
       end
     end
   end

data/lib/fog/brightbox/models/compute/event.rb

@@ -4,17 +4,18 @@ module Fog
       # @api private
       class Event < Fog::Brightbox::Model
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :action
         attribute :message
         attribute :short_message
 
-        # Times
-        attribute :created_at, :type => :time
+        # Timestamps
+        attribute :created_at, type: :time
 
-        # Links - to be replaced
+        # Links
+        attribute :affects
         attribute :resource
         attribute :client
         attribute :user

data/lib/fog/brightbox/models/compute/firewall_policy.rb

@@ -3,16 +3,22 @@ module Fog
     class Compute
       class FirewallPolicy < Fog::Brightbox::Model
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :name
         attribute :description
 
-        attribute :default
+        # Boolean flags
+        attribute :default, type: :boolean
+
+        # Timestamps
+        attribute :created_at, type: :time
+
+        # Links
+        attribute :account_id, aliases: "account", squash: "id"
+        attribute :server_group_id, aliases: "server_group", squash: "id"
 
-        attribute :server_group_id, :aliases => "server_group", :squash => "id"
-        attribute :created_at, :type => :time
         attribute :rules
 
         # Sticking with existing Fog behaviour, save does not update but creates a new resource

data/lib/fog/brightbox/models/compute/firewall_rule.rb

@@ -3,20 +3,23 @@ module Fog
     class Compute
       class FirewallRule < Fog::Brightbox::Model
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :description
 
-        attribute :source
-        attribute :source_port
         attribute :destination
         attribute :destination_port
-        attribute :protocol
         attribute :icmp_type_name
-        attribute :created_at, :type => :time
+        attribute :protocol
+        attribute :source
+        attribute :source_port
+
+        # Timestamps
+        attribute :created_at, type: :time
 
-        attribute :firewall_policy_id, :aliases => "firewall_policy", :squash => "id"
+        # Links
+        attribute :firewall_policy_id, aliases: "firewall_policy", squash: "id"
 
         # Sticking with existing Fog behaviour, save does not update but creates a new resource
         def save

data/lib/fog/brightbox/models/compute/flavor.rb

@@ -3,19 +3,19 @@ module Fog
     class Compute
       class Flavor < Fog::Brightbox::Model
         identity :id
-        attribute :url
         attribute :resource_type
+        attribute :url
 
         attribute :name
         attribute :status
-        attribute :description
 
         attribute :handle
 
         attribute :bits
         attribute :cores
-        attribute :disk, :aliases => "disk_size"
+        attribute :disk, aliases: "disk_size"
         attribute :ram
+        attribute :storage_type
 
         def bits
           64 # This is actually based on the Image type used. 32bit or 64bit Images are supported