hetznercloud 1.3.1 → 1.5.0

data/lib/hcloud/resources/firewall.rb

@@ -11,15 +11,18 @@ module HCloud
   #
   # == Sort firewalls
   #
-  #     HCloud::Firewall.all.sort(name: :desc)
+  #     HCloud::Firewall.sort(name: :desc)
   #     # => [#<HCloud::Firewall id: 1, ...>, ...]
   #
-  #     HCloud::Firewall.all.sort(:id, name: :asc)
+  #     HCloud::Firewall.sort(:id, name: :asc)
   #     # => [#<HCloud::Firewall id: 1, ...>, ...]
   #
   # == Search firewalls
   #
-  #     HCloud::Firewall.all.where(name: "my_firewall")
+  #     HCloud::Firewall.where(name: "my_firewall")
+  #     # => #<HCloud::Firewall id: 1, ...>
+  #
+  #     HCloud::Firewall.where(label_selector: { environment: "production" })
   #     # => #<HCloud::Firewall id: 1, ...>
   #
   # == Find firewall by ID
@@ -107,6 +110,7 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -117,8 +121,6 @@ module HCloud
 
     attribute :rules, :rule, array: true, default: -> { [] }
 
-    attribute :labels, default: -> { {} }
-
     action :apply_to_resources
     action :remove_from_resources
     action :set_rules

data/lib/hcloud/resources/floating_ip.rb

@@ -11,15 +11,18 @@ module HCloud
   #
   # == Sort floating IPs
   #
-  #     HCloud::FloatingIP.all.sort(id: :asc)
+  #     HCloud::FloatingIP.sort(id: :asc)
   #     # => [#<HCloud::FloatingIP id: 1, ...>, ...]
   #
-  #     HCloud::FloatingIP.all.sort(:id, created: :asc)
+  #     HCloud::FloatingIP.sort(:id, created: :asc)
   #     # => [#<HCloud::FloatingIP id: 1, ...>, ...]
   #
   # == Search floating IPs
   #
-  #     HCloud::FloatingIP.all.where(name: "my_floating_ip")
+  #     HCloud::FloatingIP.where(name: "my_floating_ip")
+  #     # => #<HCloud::FloatingIP id: 1, ...>
+  #
+  #     HCloud::FloatingIP.where(label_selector: { environment: "production" })
   #     # => #<HCloud::FloatingIP id: 1, ...>
   #
   # == Find floating IP by ID
@@ -104,6 +107,7 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -121,8 +125,6 @@ module HCloud
 
     attribute :server, :server
 
-    attribute :labels, default: -> { {} }
-
     alias blocked? blocked
 
     action :assign

data/lib/hcloud/resources/image.rb

@@ -11,21 +11,21 @@ module HCloud
   #
   # == Sort images
   #
-  #     HCloud::Image.all.sort(name: :desc)
+  #     HCloud::Image.sort(name: :desc)
   #     # => [#<HCloud::Image id: 1, ...>, ...]
   #
-  #     HCloud::Image.all.sort(:id, name: :asc)
+  #     HCloud::Image.sort(:id, name: :asc)
   #     # => [#<HCloud::Image id: 1, ...>, ...]
   #
   # == Search images
   #
-  #     HCloud::Image.all.where(name: "my_image")
+  #     HCloud::Image.where(name: "my_image")
   #     # => #<HCloud::Image id: 1, ...>
   #
-  #     HCloud::Image.all.where(status: "available", include_deprecated: false)
+  #     HCloud::Image.where(status: "available", include_deprecated: false)
   #     # => #<HCloud::Image id: 1, ...>
   #
-  #     HCloud::Image.all.where(type: "backup", bound_to: 1)
+  #     HCloud::Image.where(type: "backup", bound_to: 1)
   #     # => #<HCloud::Image id: 1, ...>
   #
   # == Find image by ID
@@ -85,6 +85,7 @@ module HCloud
     queryable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -113,8 +114,6 @@ module HCloud
 
     attribute :rapid_deploy
 
-    attribute :labels, default: -> { {} }
-
     action :change_protection
 
     def created?

data/lib/hcloud/resources/iso.rb

@@ -11,7 +11,7 @@ module HCloud
   #
   # == Search ISOs
   #
-  #     HCloud::ISO.all.where(name: "debian-10.10.0-amd64-netinst.iso")
+  #     HCloud::ISO.where(name: "debian-10.10.0-amd64-netinst.iso")
   #     # => #<HCloud::ISO id: 7631, ...>
   #
   # == Find ISO by ID

data/lib/hcloud/resources/load_balancer.rb

@@ -11,15 +11,18 @@ module HCloud
   #
   # == Sort load balancers
   #
-  #     HCloud::LoadBalancer.all.sort(name: :desc)
+  #     HCloud::LoadBalancer.sort(name: :desc)
   #     # => [#<HCloud::LoadBalancer id: 1, ...>, ...]
   #
-  #     HCloud::LoadBalancer.all.sort(:id, name: :asc)
+  #     HCloud::LoadBalancer.sort(:id, name: :asc)
   #     # => [#<HCloud::LoadBalancer id: 1, ...>, ...]
   #
   # == Search load balancers
   #
-  #     HCloud::LoadBalancer.all.where(name: "my_load_balancer")
+  #     HCloud::LoadBalancer.where(name: "my_load_balancer")
+  #     # => #<HCloud::LoadBalancer id: 1, ...>
+  #
+  #     HCloud::LoadBalancer.where(label_selector: { environment: "production" })
   #     # => #<HCloud::LoadBalancer id: 1, ...>
   #
   # == Find load balancer by ID
@@ -65,6 +68,7 @@ module HCloud
     updatable
     deletable
     meterable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -94,8 +98,6 @@ module HCloud
 
     attribute :protection, :protection
 
-    attribute :labels, default: -> { {} }
-
     def creatable_attributes
       [:name, :labels, :algorithm, :network_zone, :public_interface, :services, :targets, load_balancer_type: [:id, :name], location: [:id, :name], network: [:id, :name]]
     end

data/lib/hcloud/resources/load_balancer_type.rb

@@ -11,7 +11,7 @@ module HCloud
   #
   # == Search load balancer types
   #
-  #     HCloud::LoadBalancerType.all.where(name: "cx11")
+  #     HCloud::LoadBalancerType.where(name: "cx11")
   #     # => #<HCloud::LoadBalancerType id: 1, ...>
   #
   # == Find load balancer type by ID

data/lib/hcloud/resources/location.rb

@@ -11,7 +11,7 @@ module HCloud
   #
   # == Search locations
   #
-  #     HCloud::Location.all.where(name: "fsn1")
+  #     HCloud::Location.where(name: "fsn1")
   #     # => #<HCloud::Location id: 1, ...>
   #
   # == Find location by ID

data/lib/hcloud/resources/metadata.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Server metadata.
+  #
+  # This resource allows a Hetzner server to retrieve metadata about itself.
+  # It cannot be used outside of Hetzner servers.
+  #
+  # == Find metadata
+  #
+  #     HCloud::Metadata.find
+  #     # => #<HCloud::Metadata ...>
+  #
+  class Metadata < Resource
+    ENDPOINT = "https://169.254.169.254/hetzner/v1/metadata"
+
+    attribute :hostname
+    attribute :instance_id, :integer
+    attribute :public_ipv4
+    attribute :availability_zone
+    attribute :region
+
+    attribute :private_networks, :private_network, array: true, default: -> { [] }
+
+    def self.find
+      new(::HTTP
+        .get(ENDPOINT)
+        .parse(:yaml)
+        .deep_transform_keys { |key| key.underscore.to_sym })
+    end
+  end
+end

data/lib/hcloud/resources/network.rb

@@ -11,7 +11,10 @@ module HCloud
   #
   # == Search networks
   #
-  #     HCloud::Network.all.where(name: "my_network")
+  #     HCloud::Network.where(name: "my_network")
+  #     # => #<HCloud::Network id: 1, ...>
+  #
+  #     HCloud::Network.where(label_selector: { environment: "production" })
   #     # => #<HCloud::Network id: 1, ...>
   #
   # == Find network by ID
@@ -106,6 +109,7 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -121,8 +125,6 @@ module HCloud
 
     attribute :protection, :protection
 
-    attribute :labels, default: -> { {} }
-
     action :change_protection
 
     action :add_route

data/lib/hcloud/resources/placement_group.rb

@@ -11,15 +11,18 @@ module HCloud
   #
   # == Sort placement groups
   #
-  #     HCloud::PlacementGroup.all.sort(name: :desc)
+  #     HCloud::PlacementGroup.sort(name: :desc)
   #     # => [#<HCloud::PlacementGroup id: 1, ...>, ...]
   #
-  #     HCloud::PlacementGroup.all.sort(:id, name: :asc)
+  #     HCloud::PlacementGroup.sort(:id, name: :asc)
   #     # => [#<HCloud::PlacementGroup id: 1, ...>, ...]
   #
   # == Search placement groups
   #
-  #     HCloud::PlacementGroup.all.where(name: "my_placement_group")
+  #     HCloud::PlacementGroup.where(name: "my_placement_group")
+  #     # => #<HCloud::PlacementGroup id: 2, ...>
+  #
+  #     HCloud::PlacementGroup.where(label_selector: { environment: "production" })
   #     # => #<HCloud::PlacementGroup id: 2, ...>
   #
   # == Find placement group by ID
@@ -55,6 +58,7 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -62,8 +66,6 @@ module HCloud
 
     attribute :servers, :server, array: true, default: -> { [] }
 
-    attribute :labels, default: -> { {} }
-
     def creatable_attributes
       [:name, :type, :labels]
     end

data/lib/hcloud/resources/pricing.rb

@@ -21,6 +21,8 @@ module HCloud
 
     attribute :load_balancer_types, :load_balancer_type_price, array: true, default: -> { [] }
 
+    attribute :primary_ips, :primary_ip_prices, array: true, default: -> { [] }
+
     attribute :server_backup, :server_backup_price
 
     attribute :server_types, :server_type_price, array: true, default: -> { [] }

data/lib/hcloud/resources/primary_ip.rb

@@ -0,0 +1,150 @@
+# frozen_string_literal: true
+
+module HCloud
+  ##
+  # Represents a primary IP
+  #
+  # == List all primary IPs
+  #
+  #     HCloud::PrimaryIP.all
+  #     # => [#<HCloud::PrimaryIP id: 1, ...>, ...]
+  #
+  # == Sort primary IPs
+  #
+  #     HCloud::PrimaryIP.sort(id: :asc)
+  #     # => [#<HCloud::PrimaryIP id: 1, ...>, ...]
+  #
+  #     HCloud::PrimaryIP.sort(:id, created: :asc)
+  #     # => [#<HCloud::PrimaryIP id: 1, ...>, ...]
+  #
+  # == Search primary IPs
+  #
+  #     HCloud::PrimaryIP.where(name: "my_primary_ip")
+  #     # => #<HCloud::PrimaryIP id: 1, ...>
+  #
+  #     HCloud::PrimaryIP.where(ip: "1.2.3.4")
+  #     # => #<HCloud::PrimaryIP id: 1, ...>
+  #
+  #     HCloud::PrimaryIP.where(label_selector: { environment: "production" })
+  #     # => #<HCloud::PrimaryIP id: 1, ...>
+  #
+  # == Find primary IP by ID
+  #
+  #     HCloud::PrimaryIP.find(1)
+  #     # => #<HCloud::PrimaryIP id: 1, ...>
+  #
+  # == Create primary IP
+  #
+  #     primary IP = HCloud::PrimaryIP.new(name: "my_primary_ip", type: "ipv4", datacenter: "fsn1-dc8")
+  #     primary IP.create
+  #     primary IP.created?
+  #     # => true
+  #
+  #     firewall = HCloud::PrimaryIP.create(name: "my_primary_ip")
+  #     # => #<HCloud::PrimaryIP id: 1, ...>
+  #
+  # == Update primary IP
+  #
+  #     primary IP = HCloud::PrimaryIP.find(1)
+  #     primary IP.name = "another_primary_ip"
+  #     primary IP.update
+  #
+  # == Delete primary IP
+  #
+  #     primary IP = HCloud::PrimaryIP.find(1)
+  #     primary IP.delete
+  #     primary IP.deleted?
+  #     # => true
+  #
+  # = Actions
+  # == List actions
+  #
+  #     actions = HCloud::PrimaryIP.find(1).actions
+  #     # => [#<HCloud::Action id: 1, ...>, ...]
+  #
+  # == Sort actions
+  #
+  #     HCloud::PrimaryIP.find(1).actions.sort(finished: :desc)
+  #     # => [#<HCloud::Action id: 1, ...>, ...]
+  #
+  #     HCloud::PrimaryIP.find(1).actions.sort(:command, finished: :asc)
+  #     # => [#<HCloud::Actions id: 1, ...>, ...]
+  #
+  # == Search actions
+  #
+  #     HCloud::PrimaryIP.find(1).actions.where(command: "assign_primary_ip")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  #     HCloud::PrimaryIP.find(1).actions.where(status: "success")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Find action by ID
+  #
+  #     HCloud::PrimaryIP.find(1).actions.find(1)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # = Resource-specific actions
+  # == Assign a primary IP to a server
+  #
+  #     HCloud::PrimaryIP.find(1).assign(assignee_id: 1, assignee_type: "server")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Unassign a primary IP from a server
+  #
+  #     HCloud::PrimaryIP.find(1).unassign
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Change reverse DNS entry
+  #
+  #     HCloud::PrimaryIP.find(1).change_dns_ptr(dns_ptr: "server.example.com", ip: "1.2.3.4")
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  # == Change protection
+  #
+  #     HCloud::PrimaryIP.find(1).change_protection(delete: true)
+  #     # => #<HCloud::Action id: 1, ...>
+  #
+  class PrimaryIP < Resource
+    actionable
+    queryable
+    creatable
+    updatable
+    deletable
+    labelable
+
+    attribute :id, :integer
+    attribute :name
+
+    attribute :type
+    attribute :ip
+    attribute :dns_ptr, :dns_pointer, array: true, default: -> { [] }
+
+    attribute :assignee_id
+    attribute :assignee_type, default: "server"
+
+    attribute :auto_delete, :boolean
+    attribute :blocked, :boolean
+
+    attribute :datacenter, :datacenter
+
+    attribute :protection, :protection
+
+    alias auto_delete? auto_delete
+    alias blocked? blocked
+
+    action :assign
+    action :unassign
+
+    action :change_dns_ptr
+
+    action :change_protection
+
+    def creatable_attributes
+      [:name, :type, :assignee_id, :assignee_type, :auto_delete, :labels, datacenter: [:id, :name]]
+    end
+
+    def updatable_attributes
+      [:name, :auto_delete, :labels]
+    end
+  end
+end

data/lib/hcloud/resources/server.rb

@@ -11,18 +11,21 @@ module HCloud
   #
   # == Sort servers
   #
-  #     HCloud::Server.all.sort(name: :desc)
+  #     HCloud::Server.sort(name: :desc)
   #     # => [#<HCloud::Server id: 1, ...>, ...]
   #
-  #     HCloud::Server.all.sort(:id, name: :asc)
+  #     HCloud::Server.sort(:id, name: :asc)
   #     # => [#<HCloud::Server id: 1, ...>, ...]
   #
   # == Search servers
   #
-  #     HCloud::Server.all.where(name: "my_server")
+  #     HCloud::Server.where(name: "my_server")
   #     # => #<HCloud::Server id: 1, ...>
   #
-  #     HCloud::Server.all.where(status: "running")
+  #     HCloud::Server.where(status: "running")
+  #     # => #<HCloud::Server id: 1, ...>
+  #
+  #     HCloud::Server.where(label_selector: { environment: "production" })
   #     # => #<HCloud::Server id: 1, ...>
   #
   # == Find server by ID
@@ -72,6 +75,7 @@ module HCloud
     updatable
     deletable
     meterable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -107,7 +111,7 @@ module HCloud
 
     attribute :primary_disk_size, :integer
 
-    attribute :protection, :protection
+    attribute :protection, :server_protection
 
     attribute :image, :image
 
@@ -118,8 +122,6 @@ module HCloud
 
     attribute :iso, :iso
 
-    attribute :labels, default: -> { {} }
-
     attribute :load_balancers, :load_balancer, array: true, default: -> { [] }
 
     attribute :volumes, :volume, array: true, default: -> { [] }

data/lib/hcloud/resources/server_type.rb

@@ -11,7 +11,7 @@ module HCloud
   #
   # == Search server types
   #
-  #     HCloud::ServerType.all.where(name: "cx11")
+  #     HCloud::ServerType.where(name: "cx11")
   #     # => #<HCloud::ServerType id: 1, ...>
   #
   # == Find server type by ID

data/lib/hcloud/resources/ssh_key.rb

@@ -11,18 +11,21 @@ module HCloud
   #
   # == Sort SSH keys
   #
-  #     HCloud::SSHKey.all.sort(name: :desc)
+  #     HCloud::SSHKey.sort(name: :desc)
   #     # => [#<HCloud::SSHKey id: 1, ...>, ...]
   #
-  #     HCloud::SSHKey.all.sort(:id, name: :asc)
+  #     HCloud::SSHKey.sort(:id, name: :asc)
   #     # => [#<HCloud::SSHKey id: 1, ...>, ...]
   #
   # == Search SSH keys
   #
-  #     HCloud::SSHKey.all.where(name: "cx11")
+  #     HCloud::SSHKey.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.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 id: 1, ...>
   #
   # == Find SSH key by ID
@@ -58,14 +61,13 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
     attribute :public_key
     attribute :fingerprint
 
-    attribute :labels, default: -> { {} }
-
     def creatable_attributes
       [:name, :public_key, :labels]
     end

data/lib/hcloud/resources/volume.rb

@@ -11,18 +11,21 @@ module HCloud
   #
   # == Sort volumes
   #
-  #     HCloud::Volume.all.sort(name: :desc)
+  #     HCloud::Volume.sort(name: :desc)
   #     # => [#<HCloud::Volume id: 1, ...>, ...]
   #
-  #     HCloud::Volume.all.sort(:id, name: :asc)
+  #     HCloud::Volume.sort(:id, name: :asc)
   #     # => [#<HCloud::Volume id: 1, ...>, ...]
   #
   # == Search volumes
   #
-  #     HCloud::Volume.all.where(name: "my_volume")
+  #     HCloud::Volume.where(name: "my_volume")
   #     # => #<HCloud::Volume id: 1, ...>
   #
-  #     HCloud::Volume.all.where(status: "available")
+  #     HCloud::Volume.where(status: "available")
+  #     # => #<HCloud::Volume id: 1, ...>
+  #
+  #     HCloud::Volume.where(label_selector: { environment: "production" })
   #     # => #<HCloud::Volume id: 1, ...>
   #
   # == Find volume by ID
@@ -107,6 +110,7 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -124,8 +128,6 @@ module HCloud
 
     attribute :server, :server
 
-    attribute :labels, default: -> { {} }
-
     alias automount? automount
 
     action :attach

data/lib/hcloud/version.rb

@@ -3,8 +3,8 @@
 module HCloud
   module Version
     MAJOR = 1
-    MINOR = 3
-    PATCH = 1
+    MINOR = 5
+    PATCH = 0
     PRE   = nil
 
     VERSION = [MAJOR, MINOR, PATCH].compact.join(".")

data/lib/hcloud.rb

@@ -16,7 +16,7 @@ module HCloud
     end
 
     def setup
-      @loader = Zeitwerk::Loader.for_gem
+      @loader = Zeitwerk::Loader.for_gem(warn_on_extra_files: false)
 
       # Register inflections
       require root.join("config/inflections.rb")

data/lib/http/mime_type/yaml.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require "yaml"
+
+module HTTP
+  module MimeType
+    class YAML < Adapter
+      def encode(obj)
+        return obj.to_yaml if obj.respond_to?(:to_yaml)
+
+        ::YAML.dump(obj)
+      end
+
+      # Decodes JSON
+      def decode(str)
+        ::YAML.safe_load(str)
+      end
+    end
+  end
+end
+
+HTTP::MimeType.register_adapter "application/x-yaml", HTTP::MimeType::YAML
+HTTP::MimeType.register_alias "application/x-yaml", :yaml

data/lib/http/rate_limiter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module HTTP
+  class RateLimiter < Feature
+    attr_reader :limit, :remaining, :reset, :at, :rate
+
+    def initialize(...)
+      super
+
+      @limit = Float::INFINITY
+      @remaining = Float::INFINITY
+      @reset = Time.at(0)
+      @at = Time.at(0)
+      @rate = 1
+    end
+
+    def wrap_request(request)
+      sleep rate while remaining.zero? && (at + rate).future?
+
+      request
+    end
+
+    def wrap_response(response)
+      # Extract rate limits
+      @limit = response["RateLimit-Limit"].to_i
+      @remaining = response["RateLimit-Remaining"].to_i
+      @reset = Time.at(response["RateLimit-Reset"].to_i)
+
+      # Extract request date
+      @at = Time.parse(response.headers["Date"])
+
+      # Calculate remaining increment rate
+      @rate = 3600 / limit
+
+      response
+    end
+  end
+end
+
+HTTP::Options.register_feature(:rate_limiter, HTTP::RateLimiter)