hetznercloud 1.0.0

data/lib/hcloud/resources/image.rb

@@ -0,0 +1,140 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a image
+  #
+  # == List all images
+  #
+  #     HCloud::Image.all
+  #     # => [#<HCloud::Image id: 1, ...>, ...]
+  #
+  # == Sort images
+  #
+  #     HCloud::Image.all.sort(name: :desc)
+  #     # => [#<HCloud::Image id: 1, ...>, ...]
+  #
+  #     HCloud::Image.all.sort(:id, name: :asc)
+  #     # => [#<HCloud::Image id: 1, ...>, ...]
+  #
+  # == Search images
+  #
+  #     HCloud::Image.all.where(name: "my_image")
+  #     # => #<HCloud::Image id: 1, ...>
+  #
+  #     HCloud::Image.all.where(status: "available", include_deprecated: false)
+  #     # => #<HCloud::Image id: 1, ...>
+  #
+  #     HCloud::Image.all.where(type: "backup", bound_to: 1)
+  #     # => #<HCloud::Image id: 1, ...>
+  #
+  # == Find image by ID
+  #
+  #     HCloud::Image.find(1)
+  #     # => #<HCloud::Image id: 1, ...>
+  #
+  # == Update image
+  #
+  #     image = HCloud::Image.find(1)
+  #     image.type = "snapshot"
+  #     image.description = "#{image.description} (snapshot)"
+  #     image.update
+  #
+  # == Delete image
+  #
+  #     image = HCloud::Image.find(1)
+  #     image.delete
+  #     image.deleted?
+  #     # => true
+  #
+  # = Actions
+  # == List actions
+  #
+  #     actions = HCloud::Image.find(1).actions
+  #     # => [#<HCloud::Action id: 1, ...>, ...]
+  #
+  # == Sort actions
+  #
+  #     HCloud::Image.find(1).actions.sort(finished: :desc)
+  #     # => [#<HCloud::Action id: 1, ...>, ...]
+  #
+  #     HCloud::Image.find(1).actions.sort(:command, finished: :asc)
+  #     # => [#<HCloud::Actions id: 1, ...>, ...]
+  #
+  # == Search actions
+  #
+  #     HCloud::Image.find(1).actions.where(command: "change_protection")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     HCloud::Image.find(1).actions.where(status: "success")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Find action by ID
+  #
+  #     HCloud::Image.find(1).actions.find(1)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # = Image-specific actions
+  # == Change protection
+  #
+  #     HCloud::Image.find(1).change_protection(delete: true)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  class Image < Resource
+    actionable
+    queryable
+    updatable
+    deletable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :description
+
+    attribute :type
+    attribute :status
+
+    attribute :build_id
+
+    attribute :disk_size, :integer
+    attribute :image_size, :integer
+
+    attribute :os_flavor
+    attribute :os_version
+
+    attribute :protection, :protection
+
+    attribute :bound_to, :server
+    attribute :created_from, :server
+
+    # Explicitly specify created attribute, because resource is not Creatable
+    attribute :created, :datetime
+    attribute :deleted, :datetime
+    attribute :deprecated, :datetime
+
+    attribute :rapid_deploy
+
+    attribute :labels, default: -> { {} }
+
+    action :change_protection
+
+    def created?
+      created.present?
+    end
+
+    def deleted?
+      deleted.present?
+    end
+
+    def deprecated?
+      deprecated.present?
+    end
+
+    def rapid_deploy?
+      rapid_deploy.present?
+    end
+
+    def updatable_attributes
+      [:description, :type, :labels]
+    end
+  end
+end

data/lib/hcloud/resources/iso.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents an ISO image
+  #
+  # == List all ISOs
+  #
+  #     HCloud::ISO.all
+  #     # => [#<HCloud::ISO id: 7631, ...>, ...]
+  #
+  # == Search ISOs
+  #
+  #     HCloud::ISO.all.where(name: "debian-10.10.0-amd64-netinst.iso")
+  #     # => #<HCloud::ISO id: 7631, ...>
+  #
+  # == Find ISO by ID
+  #
+  #     HCloud::ISO.find(1)
+  #     # => #<HCloud::ISO id: 7631, ...>
+  #
+  class ISO < Resource
+    queryable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :description
+
+    attribute :type
+    attribute :deprecated, :datetime
+
+    def deprecated?
+      deprecated.present?
+    end
+  end
+end

data/lib/hcloud/resources/location.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a location
+  #
+  # == List all locations
+  #
+  #     HCloud::Location.all
+  #     # => [#<HCloud::Location id: 1, ...>, ...]
+  #
+  # == Search locations
+  #
+  #     HCloud::Location.all.where(name: "fsn1")
+  #     # => #<HCloud::Location id: 1, ...>
+  #
+  # == Find location by ID
+  #
+  #     HCloud::Location.find(1)
+  #     # => #<HCloud::Location id: 1, ...>
+  #
+  class Location < Resource
+    queryable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :description
+
+    attribute :network_zone
+
+    attribute :city
+    attribute :country
+
+    attribute :latitude, :decimal
+    attribute :longitude, :decimal
+  end
+end

data/lib/hcloud/resources/placement_group.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a placement group
+  #
+  # == List all placement group
+  #
+  #     HCloud::PlacementGroup.all
+  #     # => [#<HCloud::PlacementGroup id: 2, ...>, ...]
+  #
+  # == Sort placement groups
+  #
+  #     HCloud::PlacementGroup.all.sort(name: :desc)
+  #     # => [#<HCloud::PlacementGroup id: 1, ...>, ...]
+  #
+  #     HCloud::PlacementGroup.all.sort(:id, name: :asc)
+  #     # => [#<HCloud::PlacementGroup id: 1, ...>, ...]
+  #
+  # == Search placement groups
+  #
+  #     HCloud::PlacementGroup.all.where(name: "my_placement_group")
+  #     # => #<HCloud::PlacementGroup id: 2, ...>
+  #
+  # == Find placement group by ID
+  #
+  #     HCloud::PlacementGroup.find(2)
+  #     # => #<HCloud::PlacementGroup id: 2, ...>
+  #
+  # == Create placement group
+  #
+  #     placement_group = HCloud::PlacementGroup.new(name: "my_placement_group", type: "spread")
+  #     placement_group.create
+  #     placement_group.created?
+  #     # => true
+  #
+  #     firewall = HCloud::PlacementGroup.create(name: "my_placement_group")
+  #     # => #<HCloud::PlacementGroup id: 1, ...>
+  #
+  # == Update placement group
+  #
+  #     placement_group = HCloud::PlacementGroup.find(1)
+  #     placement_group.name = "another_placement_group"
+  #     placement_group.update
+  #
+  # == Delete placement group
+  #
+  #     placement_group = HCloud::PlacementGroup.find(1)
+  #     placement_group.delete
+  #     placement_group.deleted?
+  #     # => true
+  #
+  class PlacementGroup < Resource
+    queryable
+    creatable
+    updatable
+    deletable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :type
+
+    attribute :servers, :server, array: true, default: -> { [] }
+
+    attribute :labels, default: -> { {} }
+
+    def creatable_attributes
+      [:name, :type, :labels]
+    end
+
+    def updatable_attributes
+      [:name, :labels]
+    end
+  end
+end

data/lib/hcloud/resources/server.rb

@@ -0,0 +1,179 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a server
+  #
+  # == List all servers
+  #
+  #     HCloud::Server.all
+  #     # => [#<HCloud::Server id: 1, ...>, ...]
+  #
+  # == Sort servers
+  #
+  #     HCloud::Server.all.sort(name: :desc)
+  #     # => [#<HCloud::Server id: 1, ...>, ...]
+  #
+  #     HCloud::Server.all.sort(:id, name: :asc)
+  #     # => [#<HCloud::Server id: 1, ...>, ...]
+  #
+  # == Search servers
+  #
+  #     HCloud::Server.all.where(name: "my_server")
+  #     # => #<HCloud::Server id: 1, ...>
+  #
+  #     HCloud::Server.all.where(status: "running")
+  #     # => #<HCloud::Server id: 1, ...>
+  #
+  # == Find server by ID
+  #
+  #     HCloud::Server.find(1)
+  #     # => #<HCloud::Server id: 1, ...>
+  #
+  # == Create server
+  #
+  #     user_data = File.read("user_data.yml")
+  #     server = HCloud::Server.new(name: "my_server", image: "debian-11", server_type: "cx11")
+  #     server.create
+  #     server.created?
+  #     # => true
+  #
+  #     firewall = HCloud::Server.create(name: "my_server", image: "debian-11", server_type: "cx11")
+  #     # => #<HCloud::Server id: 1, ...>
+  #
+  # == Update server
+  #
+  #     server = HCloud::Server.find(1)
+  #     server.name = "another_server"
+  #     server.update
+  #
+  # == Delete server
+  #
+  #     server = HCloud::Server.find(1)
+  #     server.delete
+  #     server.deleted?
+  #     # => true
+  #
+  # == Get metrics
+  #
+  #     server = HCloud::Server.find(1)
+  #     server.metrics(type: :cpu, from: 2.minutes.ago, to: 1.minute.ago)
+  #     # => #<HCloud::Metrics ...>
+  #
+  #     server.metrics(type: [:cpu, :disk, :network], from: 2.minutes.ago, to: 1.minute.ago, step: 60)
+  #     # => #<HCloud::Metrics ...>
+  #
+  # TODO: actions
+  # TODO: return root_password if ssh_keys is empty
+  #
+  class Server < Resource
+    actionable
+    queryable
+    creatable
+    updatable
+    deletable
+
+    attribute :id, :integer
+    attribute :name
+
+    attribute :server_type, :server_type
+
+    attribute :status
+
+    attribute :backup_window
+
+    # TODO: use only for creation
+    attribute :location, :location
+
+    # TODO: use only for creation
+    attribute :ssh_keys, :ssh_key, array: true, default: -> { [] }
+
+    # TODO: use only for creation
+    attribute :firewalls, array: true, default: -> { [] }
+
+    # TODO: use only for creation
+    attribute :networks, array: true, default: -> { [] }
+
+    attribute :datacenter, :datacenter
+
+    attribute :included_traffic, :integer
+    attribute :ingoing_traffic, :integer
+    attribute :outgoing_traffic, :integer
+
+    attribute :primary_disk_size, :integer
+
+    attribute :protection, :protection
+
+    attribute :image, :image
+
+    # TODO: network resource
+    attribute :public_net
+    attribute :private_net
+
+    attribute :placement_group, :placement_group
+
+    attribute :iso, :iso
+
+    attribute :labels, default: -> { {} }
+
+    # TODO: load balancer resource
+    attribute :load_balancers, array: true, default: -> { [] }
+
+    attribute :volumes, :volume, array: true, default: -> { [] }
+
+    attribute :locked
+    attribute :rescue_enabled
+
+    alias rescue_enabled? rescue_enabled
+
+    alias locked? locked
+
+    action :add_to_placement_group
+    action :remove_from_placement_group
+
+    action :attach_iso
+    action :detach_iso
+
+    action :attach_to_network
+    action :detach_from_network
+
+    action :change_alias_ips
+    action :change_dns_ptr
+
+    action :change_protection
+    action :change_type
+    action :create_image
+
+    action :enable_backup
+    action :disable_backup
+
+    action :enable_rescue
+    action :disable_rescue
+
+    action :poweron
+    action :poweroff
+    action :reboot
+    action :reset
+    action :shutdown
+
+    action :reset_password
+
+    action :rebuild
+
+    action :request_console
+
+    def metrics(type:, from:, to:, step: nil)
+      Metrics.new client
+        .get("/servers/#{id}/metrics", type: Array(type).join(","), start: from.iso8601, end: to.iso8601, step: step)
+        .fetch(:metrics)
+    end
+
+    def creatable_attributes
+      [:name, :automount, :start_after_create, :user_data, :labels, datacenter: [:id, :name], image: [:id, :name], location: [:id, :name], server_type: [:id, :name], ssh_keys: [:id, :name], firewalls: :id, networks: :id, volumes: :id]
+    end
+
+    def updatable_attributes
+      [:name, :labels]
+    end
+  end
+end

data/lib/hcloud/resources/server_type.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a server type
+  #
+  # == List all server types
+  #
+  #     HCloud::ServerType.all
+  #     # => [#<HCloud::ServerType id: 1, ...>, ...]
+  #
+  # == Search server types
+  #
+  #     HCloud::ServerType.all.where(name: "cx11")
+  #     # => #<HCloud::ServerType id: 1, ...>
+  #
+  # == Find server type by ID
+  #
+  #     HCloud::ServerType.find(1)
+  #     # => #<HCloud::ServerType id: 1, ...>
+  #
+  class ServerType < Resource
+    queryable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :description
+
+    attribute :cores, :integer
+    attribute :disk, :integer
+    attribute :memory, :integer
+
+    attribute :cpu_type
+    attribute :storage_type
+
+    attribute :prices, :price, array: true, default: -> { [] }
+
+    attribute :deprecated, :boolean
+
+    alias deprecated? deprecated
+  end
+end

data/lib/hcloud/resources/ssh_key.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a SSH key
+  #
+  # == List all SSH keys
+  #
+  #     HCloud::SSHKey.all
+  #     # => [#<HCloud::SSHKey id: 1, ...>, ...]
+  #
+  # == Sort SSH keys
+  #
+  #     HCloud::SSHKey.all.sort(name: :desc)
+  #     # => [#<HCloud::SSHKey id: 1, ...>, ...]
+  #
+  #     HCloud::SSHKey.all.sort(:id, name: :asc)
+  #     # => [#<HCloud::SSHKey id: 1, ...>, ...]
+  #
+  # == Search SSH keys
+  #
+  #     HCloud::SSHKey.all.where(name: "cx11")
+  #     # => #<HCloud::SSHKey id: 1, ...>
+  #
+  #     HCloud::SSHKey.all.where(fingerprint: "B6:6C:CD:DA:A2:24:43:39:98:80:0F:F5:51:17:7E")
+  #     # => #<HCloud::SSHKey id: 1, ...>
+  #
+  # == Find SSH key by ID
+  #
+  #     HCloud::SSHKey.find(1)
+  #     # => #<HCloud::SSHKey id: 1, ...>
+  #
+  # == Create SSH key
+  #
+  #     ssh_key = HCloud::SSHKey.new(name: "my_ssh_key", public_key: File.read("id_rsa.pub"))
+  #     ssh_key.create
+  #     ssh_key.created?
+  #     # => true
+  #
+  #     firewall = HCloud::SSHKey.create(name: "my_ssh_key", public_key: File.read("id_rsa.pub"))
+  #     # => #<HCloud::SSHKey id: 1, ...>
+  #
+  # == Update SSH key
+  #
+  #     ssh_key = HCloud::SSHKey.find(1)
+  #     ssh_key.name = "another_ssh_key"
+  #     ssh_key.update
+  #
+  # == Delete SSH key
+  #
+  #     ssh_key = HCloud::SSHKey.find(1)
+  #     ssh_key.delete
+  #     ssh_key.deleted?
+  #     # => true
+  #
+  class SSHKey < Resource
+    queryable
+    creatable
+    updatable
+    deletable
+
+    attribute :id, :integer
+    attribute :name
+    attribute :public_key
+    attribute :fingerprint
+
+    attribute :labels, default: -> { {} }
+
+    def creatable_attributes
+      [:name, :public_key, :labels]
+    end
+
+    def updatable_attributes
+      [:name, :labels]
+    end
+  end
+end