hetznercloud 3.0.0 → 4.0.0

data/lib/hcloud/errors.rb

@@ -12,7 +12,7 @@ module HCloud
       end
 
       def full_messages
-        return unless data[:details]
+        return unless data[:details] && data[:details][:fields]
 
         data[:details][:fields].flat_map do |field|
           Array(field.fetch(:messages, data[:message])).map do |detail|
@@ -36,6 +36,7 @@ module HCloud
     class InvalidInput < Error; end
     class JSONError < Error; end
     class LoadBalancerNotAttachedToNetwork < Error; end
+    class LoadBalancerPublicInterfaceDisabled < Error; end
     class Locked < Error; end
     class Maintenance < Error; end
     class NetworksOverlap < Error; end

data/lib/hcloud/resource.rb

@@ -7,6 +7,7 @@ module HCloud
 
     include Concerns
     include DynamicAttributes
+    include Subresource
 
     def initialize(attributes = {})
       super()

data/lib/hcloud/resource_type.rb

@@ -137,6 +137,16 @@ ActiveModel::Type.register(:server_type_price, HCloud::ResourceType.Type("HCloud
 ActiveModel::Type.register(:service, HCloud::ResourceType.Type("HCloud::Service"))
 ActiveModel::Type.register(:service_http, HCloud::ResourceType.Type("HCloud::ServiceHTTP"))
 ActiveModel::Type.register(:ssh_key, HCloud::ResourceType.Type("HCloud::SSHKey"))
+ActiveModel::Type.register(:storage_box, HCloud::ResourceType.Type("HCloud::StorageBox"))
+ActiveModel::Type.register(:storage_box_access_settings, HCloud::ResourceType.Type("HCloud::StorageBoxAccessSettings"))
+ActiveModel::Type.register(:storage_box_price, HCloud::ResourceType.Type("HCloud::StorageBoxPrice"))
+ActiveModel::Type.register(:storage_box_snapshot_plan, HCloud::ResourceType.Type("HCloud::StorageBoxSnapshotPlan"))
+ActiveModel::Type.register(:storage_box_stats, HCloud::ResourceType.Type("HCloud::StorageBoxStats"))
+ActiveModel::Type.register(:storage_box_type, HCloud::ResourceType.Type("HCloud::StorageBoxType"))
+ActiveModel::Type.register(:storage_box_snapshot, HCloud::ResourceType.Type("HCloud::StorageBoxSnapshot"))
+ActiveModel::Type.register(:storage_box_snapshot_stats, HCloud::ResourceType.Type("HCloud::StorageBoxSnapshotStats"))
+ActiveModel::Type.register(:storage_box_subaccount, HCloud::ResourceType.Type("HCloud::StorageBoxSubaccount"))
+ActiveModel::Type.register(:storage_box_subaccount_access_settings, HCloud::ResourceType.Type("HCloud::StorageBoxSubaccountAccessSettings"))
 ActiveModel::Type.register(:subnet, HCloud::ResourceType.Type("HCloud::Subnet"))
 ActiveModel::Type.register(:target, HCloud::ResourceType.Type("HCloud::Target"))
 ActiveModel::Type.register(:targets, HCloud::ResourceType.Type("HCloud::Targets"))

data/lib/hcloud/resources/certificate.rb

@@ -25,7 +25,7 @@ module HCloud
   #     HCloud::Certificate.where(type: "uploaded")
   #     # => #<HCloud::Certificate id: 1, ...>
   #
-  #     HCloud::Certificate.where(label_selector: { environment: "production" })
+  #     HCloud::Certificate.where(label_selector: "environment=production")
   #     # => #<HCloud::Certificate id: 1, ...>
   #
   # == Find certificate by ID

data/lib/hcloud/resources/datacenter.rb

@@ -44,7 +44,7 @@ module HCloud
 
     def self.recommendation
       find client
-        .get("/#{resource_name.pluralize}")
+        .get(resource_path)
         .fetch(:recommendation)
     end
   end

data/lib/hcloud/resources/firewall.rb

@@ -22,7 +22,7 @@ module HCloud
   #     HCloud::Firewall.where(name: "my_firewall")
   #     # => #<HCloud::Firewall id: 1, ...>
   #
-  #     HCloud::Firewall.where(label_selector: { environment: "production" })
+  #     HCloud::Firewall.where(label_selector: "environment=production")
   #     # => #<HCloud::Firewall id: 1, ...>
   #
   # == Find firewall by ID

data/lib/hcloud/resources/floating_ip.rb

@@ -22,7 +22,7 @@ module HCloud
   #     HCloud::FloatingIP.where(name: "my_floating_ip")
   #     # => #<HCloud::FloatingIP id: 1, ...>
   #
-  #     HCloud::FloatingIP.where(label_selector: { environment: "production" })
+  #     HCloud::FloatingIP.where(label_selector: "environment=production")
   #     # => #<HCloud::FloatingIP id: 1, ...>
   #
   # == Find floating IP by ID

data/lib/hcloud/resources/load_balancer.rb

@@ -22,7 +22,7 @@ module HCloud
   #     HCloud::LoadBalancer.where(name: "my_load_balancer")
   #     # => #<HCloud::LoadBalancer id: 1, ...>
   #
-  #     HCloud::LoadBalancer.where(label_selector: { environment: "production" })
+  #     HCloud::LoadBalancer.where(label_selector: "environment=production")
   #     # => #<HCloud::LoadBalancer id: 1, ...>
   #
   # == Find load balancer by ID

data/lib/hcloud/resources/network.rb

@@ -14,7 +14,7 @@ module HCloud
   #     HCloud::Network.where(name: "my_network")
   #     # => #<HCloud::Network id: 1, ...>
   #
-  #     HCloud::Network.where(label_selector: { environment: "production" })
+  #     HCloud::Network.where(label_selector: "environment=production")
   #     # => #<HCloud::Network id: 1, ...>
   #
   # == Find network by ID

data/lib/hcloud/resources/placement_group.rb

@@ -22,7 +22,7 @@ module HCloud
   #     HCloud::PlacementGroup.where(name: "my_placement_group")
   #     # => #<HCloud::PlacementGroup id: 2, ...>
   #
-  #     HCloud::PlacementGroup.where(label_selector: { environment: "production" })
+  #     HCloud::PlacementGroup.where(label_selector: "environment=production")
   #     # => #<HCloud::PlacementGroup id: 2, ...>
   #
   # == Find placement group by ID

data/lib/hcloud/resources/primary_ip.rb

@@ -25,7 +25,7 @@ module HCloud
   #     HCloud::PrimaryIP.where(ip: "1.2.3.4")
   #     # => #<HCloud::PrimaryIP id: 1, ...>
   #
-  #     HCloud::PrimaryIP.where(label_selector: { environment: "production" })
+  #     HCloud::PrimaryIP.where(label_selector: "environment=production")
   #     # => #<HCloud::PrimaryIP id: 1, ...>
   #
   # == Find primary IP by ID

data/lib/hcloud/resources/server.rb

@@ -25,7 +25,7 @@ module HCloud
   #     HCloud::Server.where(status: "running")
   #     # => #<HCloud::Server id: 1, ...>
   #
-  #     HCloud::Server.where(label_selector: { environment: "production" })
+  #     HCloud::Server.where(label_selector: "environment=production")
   #     # => #<HCloud::Server id: 1, ...>
   #
   # == Find server by ID

data/lib/hcloud/resources/ssh_key.rb

@@ -25,7 +25,7 @@ module HCloud
   #     HCloud::SSHKey.where(fingerprint: "B6:6C:CD:DA:A2:24:43:39:98:80:0F:F5:51:17:7E")
   #     # => #<HCloud::SSHKey id: 1, ...>
   #
-  #     HCloud::SSHKey.where(label_selector: { environment: "production" })
+  #     HCloud::SSHKey.where(label_selector: "environment=production")
   #     # => #<HCloud::SSHKey id: 1, ...>
   #
   # == Find SSH key by ID

data/lib/hcloud/resources/storage_box.rb

@@ -0,0 +1,191 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a storage box
+  #
+  # == List all storage boxes
+  #
+  #     HCloud::StorageBox.all
+  #     # => [#<HCloud::StorageBox id: 1, ...>, ...]
+  #
+  # == Search storage boxes
+  #
+  #     HCloud::StorageBox.where(name: "my_storage_box")
+  #     # => #<HCloud::StorageBox id: 1, ...>
+  #
+  #     HCloud::StorageBox.where(label_selector: "environment=production")
+  #     # => #<HCloud::StorageBox id: 1, ...>
+  #
+  # == Find storage box by ID
+  #
+  #     HCloud::StorageBox.find(1)
+  #     # => #<HCloud::StorageBox id: 1, ...>
+  #
+  # == Create storage box
+  #
+  #     storage_box = HCloud::StorageBox.new(name: "my_storage_box", storage_box_type: "bx20", location: "fsn1", password: "my_password")
+  #     storage_box.create
+  #     storage_box.created?
+  #     # => true
+  #
+  #     storage_box = HCloud::StorageBox.create(name: "my_storage_box", storage_box_type: "bx20", location: "fsn1", password: "my_password")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     Note: this endpoint returns an Action rather than the created resource itself
+  #
+  # == Update storage box
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.name = "another_storage_box"
+  #     storage_box.update
+  #
+  # == Delete storage box
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.delete
+  #     storage_box.deleted?
+  #     # => true
+  #
+  # == List storage box contents
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.contents
+  #     # => ["photos", "documents", ...]
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.contents(folder: "photos")
+  #     # => ["photo1.jpg", "photo2.jpg", ...]
+  #
+  # = Actions
+  # == List actions
+  #
+  #     actions = HCloud::StorageBox.find(1).actions
+  #     # => [#<HCloud::Action id: 1, ...>, ...]
+  #
+  # == Sort actions
+  #
+  #     HCloud::StorageBox.find(1).actions.sort(finished: :desc)
+  #     # => [#<HCloud::Action id: 1, ...>, ...]
+  #
+  #     HCloud::StorageBox.find(1).actions.sort(:command, finished: :asc)
+  #     # => [#<HCloud::Actions id: 1, ...>, ...]
+  #
+  # == Search actions
+  #
+  #     HCloud::StorageBox.find(1).actions.where(command: "start_resource")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     HCloud::StorageBox.find(1).actions.where(status: "success")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Find action by ID
+  #
+  #     HCloud::StorageBox.find(1).actions.find(1)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # = Resource-specific actions
+  # == Change type
+  #
+  #     HCloud::StorageBox.find(1).change_type(storage_box_type: "bx21")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Reset password
+  #
+  #     HCloud::StorageBox.find(1).reset_password(password: "mypassword")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Update access settings
+  #
+  #     HCloud::StorageBox.find(1).update_access_settings(samba_enabled: false, ssh_enabled: true, webdav_enabled: false, zfs_enabled: false, reachable_externally: false)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Enable snapshot plan
+  #
+  #     HCloud::StorageBox.find(1).enable_snapshot_plan(max_snapshots: 10, minute: 30, hour: 3, day_of_week: nil, day_of_month: nil)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Disable snapshot plan
+  #
+  #     HCloud::StorageBox.find(1).disable_snapshot_plan
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Rollback snapshot
+  #
+  #     HCloud::StorageBox.find(1).rollback_snapshot(snapshot_id: 42)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Change protection
+  #
+  #     HCloud::StorageBox.find(1).change_protection(delete: true)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # = Snapshots
+  #
+  # See {HCloud::StorageBoxSnapshot} for more information on snapshots.
+  #
+  # = Subaccounts
+  #
+  # See {HCloud::StorageBoxSubaccount} for more information on subaccounts.
+  #
+  class StorageBox < Resource
+    actionable
+    queryable
+    creatable
+    updatable
+    deletable
+    labelable
+
+    subresource :snapshot, :storage_box_snapshot
+    subresource :subaccount, :storage_box_subaccount
+
+    attribute :id, :integer
+    attribute :name
+    attribute :location, :location
+
+    attribute :username
+
+    attribute :status
+
+    attribute :storage_box_type, :storage_box_type
+    attribute :access_settings, :storage_box_access_settings
+
+    # String, not a Server resource
+    attribute :server
+    attribute :system
+
+    attribute :stats, :storage_box_stats
+    attribute :snapshot_plan, :storage_box_snapshot_plan
+
+    attribute :protection, :protection
+
+    action :change_type
+    action :reset_password
+    action :update_access_settings
+
+    action :enable_snapshot_plan
+    action :disable_snapshot_plan
+
+    action :rollback_snapshot
+
+    action :change_protection
+
+    def contents(path: nil)
+      client
+        .get("#{resource_path}/#{id}/folders", path: path)
+        .fetch(:folders)
+    end
+
+    def creatable_attributes
+      [:name, :storage_box_type, :password, :ssh_keys, :location, :labels, access_settings: [:samba_enabled, :ssh_enabled, :webdav_enabled, :zfs_enabled, :reachable_externally]]
+    end
+
+    def updatable_attributes
+      [:name, :labels]
+    end
+
+    def self.client
+      HCloud::Client.connection.storage_box_client
+    end
+  end
+end

data/lib/hcloud/resources/storage_box_snapshot.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a storage box's snapshot
+  #
+  # == List all snapshots
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.snapshots
+  #     # => [#<HCloud::StorageBox::Snapshot id: 1, ...>, ...]
+  #
+  # == Search snapshots
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.snapshots.where(name: "monthly_backup")
+  #     # => #<HCloud::StorageBox::Snapshot id: 1, ...>
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.snapshots.where(label_selector: "environment=production")
+  #     # => #<HCloud::StorageBox::Snapshot id: 1, ...>
+  #
+  # == Find snapshot by ID
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.snapshots.find(1)
+  #     # => #<HCloud::StorageBox::Snapshot id: 1, ...>
+  #
+  # == Create snapshot
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     snapshot = storage_box.snapshots.new(description: "my_snapshot")
+  #     snapshot.create
+  #     snapshot.created?
+  #     # => false
+  #
+  #     Note: this endpoint returns an Action rather than the created resource itself, as the snapshot is created asynchronously.
+  #     Reload the snapshot to check if it was created successfully.
+  #
+  #     snapshot.reload
+  #     snapshot.created?
+  #     # => true
+  #
+  #     snapshot = storage_box.snapshots.create(description: "my_snapshot")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     Note: this endpoint returns an Action rather than the created resource itself
+  #
+  #     snapshot = HCloud::StorageBox::Snapshot.create(storage_box: 1, description: "my_snapshot")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     Note: this endpoint returns an Action rather than the created resource itself
+  #
+  # == Update snapshot
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     snapshot = storage_box.snapshots.find(1)
+  #     snapshot.description = "another_snapshot"
+  #     snapshot.update
+  #
+  # == Delete snapshot
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     snapshot = storage_box.snapshots.find(1)
+  #     snapshot.delete
+  #     snapshot.deleted?
+  #     # => true
+  #
+  class StorageBoxSnapshot < Resource
+    subresource_of :storage_box
+
+    queryable
+    creatable
+    updatable
+    deletable
+    labelable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :description
+
+    attribute :is_automatic, :boolean
+
+    attribute :stats, :storage_box_snapshot_stats
+
+    attribute :protection, :protection
+
+    def creatable_attributes
+      [:description]
+    end
+
+    def updatable_attributes
+      [:description, :labels]
+    end
+
+    def self.resource_name
+      "snapshot"
+    end
+
+    def self.client
+      HCloud::Client.connection.storage_box_client
+    end
+  end
+end

data/lib/hcloud/resources/storage_box_subaccount.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a storage box's subaccount
+  #
+  # == List all subaccounts
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.subaccounts
+  #     # => [#<HCloud::StorageBox::Subaccount id: 1, ...>, ...]
+  #
+  # == Search subaccounts
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.subaccounts.where(label_selector: "environment=production")
+  #     # => #<HCloud::StorageBox::Subaccount id: 1, ...>
+  #
+  # == Find subaccount by ID
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     storage_box.subaccounts.find(1)
+  #     # => #<HCloud::StorageBox::Subaccount id: 1, ...>
+  #
+  # == Create subaccount
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     subaccount = storage_box.subaccounts.new(password: "my_password", description: "my_subaccount", home_directory: "backup/", access_settings: { samba_enabled: false, ssh_enabled: true, webdav_enabled: false, readonly: false, reachable_externally: false })
+  #     subaccount.create
+  #     subaccount.created?
+  #     # => false
+  #
+  #     Note: this endpoint returns an Action rather than the created resource itself, as the subaccount is created asynchronously.
+  #     Reload the subaccount to check if it was created successfully.
+  #
+  #     subaccount.reload
+  #     subaccount.created?
+  #     # => true
+  #
+  #     subaccount = storage_box.subaccounts.create(password: "my_password", description: "my_subaccount", home_directory: "backup/", access_settings: { samba_enabled: false, ssh_enabled: true, webdav_enabled: false, readonly: false, reachable_externally: false })
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     Note: this endpoint returns an Action rather than the created resource itself
+  #
+  #     subaccount = HCloud::StorageBox::Subaccount.create(storage_box: 1, password: "my_password", description: "my_subaccount", home_directory: "backup/", access_settings: { samba_enabled: false, ssh_enabled: true, webdav_enabled: false, readonly: false, reachable_externally: false })
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     Note: this endpoint returns an Action rather than the created resource itself
+  #
+  # == Update subaccount
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     subaccount = storage_box.subaccounts.find(1)
+  #     subaccount.description = "another_subaccount"
+  #     subaccount.update
+  #
+  # == Delete subaccount
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     subaccount = storage_box.subaccounts.find(1)
+  #     subaccount.delete
+  #     subaccount.deleted?
+  #     # => true
+  #
+  # = Resource-specific actions
+  # == Reset password
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     subaccount = storage_box.subaccounts.find(1)
+  #     subaccount.reset_subaccount_password(password: "mypassword")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Update access settings
+  #
+  #     storage_box = HCloud::StorageBox.find(1)
+  #     subaccount = storage_box.subaccounts.find(1)
+  #     subaccount.update_access_settings(samba_enabled: false, ssh_enabled: true, webdav_enabled: false, zfs_enabled: false, reachable_externally: false)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  class StorageBoxSubaccount < Resource
+    subresource_of :storage_box
+
+    actionable
+    queryable
+    creatable
+    updatable
+    deletable
+    labelable
+
+    attribute :id, :integer
+    attribute :username
+    attribute :home_directory
+    attribute :description
+    attribute :comment
+
+    # String, not a Server resource
+    attribute :server
+
+    attribute :access_settings, :storage_box_subaccount_access_settings
+
+    attribute :protection, :protection
+
+    # Creatable attributes
+    attribute :password
+
+    action :reset_subaccount_password
+    action :update_access_settings
+
+    def creatable_attributes
+      [:password, :home_directory, :description, :labels, :access_settings]
+    end
+
+    def updatable_attributes
+      [:description, :labels]
+    end
+
+    def self.resource_name
+      "subaccount"
+    end
+
+    def self.client
+      HCloud::Client.connection.storage_box_client
+    end
+  end
+end

data/lib/hcloud/resources/storage_box_type.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a storage box type
+  #
+  # == List all storage box types
+  #
+  #     HCloud::StorageBoxType.all
+  #     # => [#<HCloud::StorageBoxType id: 1, ...>, ...]
+  #
+  # == Search storage box types
+  #
+  #     HCloud::StorageBoxType.where(name: "bx11")
+  #     # => #<HCloud::StorageBoxType id: 1, ...>
+  #
+  # == Find storage box type by ID
+  #
+  #     HCloud::StorageBoxType.find(1)
+  #     # => #<HCloud::StorageBoxType id: 1, ...>
+  #
+  class StorageBoxType < Resource
+    queryable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :description
+
+    attribute :size, :integer
+
+    attribute :snapshot_limit, :integer
+    attribute :automatic_snapshot_limit, :integer
+    attribute :subaccounts_limit, :integer
+
+    attribute :prices, :storage_box_price, array: true, default: -> { [] }
+
+    attribute :deprecation, :deprecation
+
+    def self.client
+      HCloud::Client.connection.storage_box_client
+    end
+  end
+end

data/lib/hcloud/resources/volume.rb

@@ -25,7 +25,7 @@ module HCloud
   #     HCloud::Volume.where(status: "available")
   #     # => #<HCloud::Volume id: 1, ...>
   #
-  #     HCloud::Volume.where(label_selector: { environment: "production" })
+  #     HCloud::Volume.where(label_selector: "environment=production")
   #     # => #<HCloud::Volume id: 1, ...>
   #
   # == Find volume by ID
@@ -40,7 +40,7 @@ module HCloud
   #     volume.created?
   #     # => true
   #
-  #     firewall = HCloud::Volume.create(name: "my_volume", size: 10, format: "ext4", automount: false, location: "fsn1")
+  #     volume = HCloud::Volume.create(name: "my_volume", size: 10, format: "ext4", automount: false, location: "fsn1")
   #     # => #<HCloud::Volume id: 1, ...>
   #
   # == Update volume