hetznercloud 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a1b9b0de15d2fe2aecdbfa6b00b46df9ec658855ebdafcabebe72f371dd98d50
-  data.tar.gz: 6c39c3ee93d35767d355e522408d1285ce3777fc841753968ae9c33d0916cc6c
+  metadata.gz: 0a4ca2b02a62b66c5fc5024fcfc7d1c0614f29b7008fdb7b7d92ce9839b542c3
+  data.tar.gz: 26a182b4a53db2a04731130c5b74ffa6f92eaadf17ae0d69080c64b3a0a71c50
 SHA512:
-  metadata.gz: 7a9971d0195c839594b88759d828dc04f98e36d37eab7880d27f4299f8266d2e37676eea3b60399440bed9240e6d39190dba0af75f2d32bfe78c5e42bb160cd5
-  data.tar.gz: bbecc7998329638d8499d0a33c877cdc5857b2a94c80633672a874f6828cc69f29e67d8e3a618b21db5cd84d87cf66cecd2e2ee3ddcfa16db00f841394f0ea85
+  metadata.gz: e57fbe462b9805f2f6615f9ddef3ef9eb1b4498620d54537dc0d73a2000e34df78ed2b8493e12032fdb842cb632887fe1e7df826cffb87f8b630d99fa002c35e
+  data.tar.gz: 2ee09e22a6c9d4dafb745ab98f204bd2af649b26eaab35f2a67370250a47fd7ff6c1060e79fe3e785c736c7c9ed5d48725479856dfc1d879147c82a0f32de79d

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## HCloud v1.5.0 (2023-02-01)
+
+- Add pricing for Primary IPs
+- Add server Metadata resource
+- Add support for rate limits
+- `Action#resources` now returns a list of resources instead of a list of hashes
+- Separate server protection entity from other protection entity (only server protection includes `rebuild`)
+- Add shorthand methods for `.first`, `.last`, `.count`, `.where`, `.sort`, `.each`, and `.empty?` on resource
+- Add `label_selector:` argument to `HCloud::Collection`
+
 ## HCloud v1.4.0 (2023-01-22)
 
 - Implemented Primary IPs

data/Gemfile

@@ -4,3 +4,16 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in hcloud.gemspec
 gemspec
+
+group :development, :test do
+  gem "byebug", require: false
+  gem "dotenv", require: false
+  gem "ffaker", require: false
+  gem "rake", require: false
+  gem "rspec", require: false
+  gem "rubocop", require: false
+  gem "rubocop-performance", require: false
+  gem "rubocop-rspec", require: false
+  gem "timecop", require: false
+  gem "webmock", require: false
+end

data/README.md

@@ -69,37 +69,82 @@ It expects you to use it in a sane way.
 
 ## Features
 
-Not all Hetzner Cloud API endpoints have been implemented yet.
-
-| Resource              | State                 |
-|-----------------------|-----------------------|
-| Actions               | Implemented           |
-| Certificates          | Implemented           |
-| Certificate Actions   | Implemented           |
-| Datacenters           | Implemented           |
-| Firewalls             | Implemented           |
-| Firewall Actions      | Implemented           |
-| Floating IPs          | Implemented           |
-| Floating IP Actions   | Implemented           |
-| Images                | Implemented           |
-| Image Actions         | Implemented           |
-| ISOs                  | Implemented           |
-| Load Balancers        | Implemented           |
-| Load Balancer Actions | Not implemented       |
-| Load Balancer Types   | Implemented           |
-| Locations             | Implemented           |
-| Primary IPs           | Implemented           |
-| Primary IP Actions    | Implemented           |
-| Networks              | Implemented           |
-| Network Actions       | Implemented           |
-| Placement Groups      | Implemented           |
-| Pricing               | Implemented           |
-| Servers               | Partially implemented |
-| Server Actions        | Not implemented       |
-| Server Types          | Implemented           |
-| SSH Keys              | Implemented           |
-| Volumes               | Implemented           |
-| Volume Actions        | Implemented           |
+The following table lists the Hetzner Cloud API endpoints that are currently implemented.
+
+| Resource                                                       | State                 |
+|----------------------------------------------------------------|-----------------------|
+| [Actions](lib/hcloud/resources/action.rb)                      | Implemented           |
+| [Certificates](lib/hcloud/resources/certificate.rb)            | Implemented           |
+| [Certificate Actions](lib/hcloud/resources/certificate.rb)     | Implemented           |
+| [Datacenters](lib/hcloud/resources/datacenter.rb)              | Implemented           |
+| [Firewalls](lib/hcloud/resources/firewall.rb)                  | Implemented           |
+| [Firewall Actions](lib/hcloud/resources/firewall.rb)           | Implemented           |
+| [Floating IPs](lib/hcloud/resources/floating_ip.rb)            | Implemented           |
+| [Floating IP Actions](lib/hcloud/resources/floating_ip.rb)     | Implemented           |
+| [Images](lib/hcloud/resources/image.rb)                        | Implemented           |
+| [Image Actions](lib/hcloud/resources/image.rb)                 | Implemented           |
+| [ISOs](lib/hcloud/resources/iso.rb)                            | Implemented           |
+| [Load Balancers](lib/hcloud/resources/load_balancer.rb)        | Implemented           |
+| [Load Balancer Actions](lib/hcloud/resources/load_balancer.rb) | Not implemented       |
+| [Load Balancer Types](lib/hcloud/resources/load_balancer.rb)   | Implemented           |
+| [Locations](lib/hcloud/resources/location.rb)                  | Implemented           |
+| [Primary IPs](lib/hcloud/resources/primary_ip.rb)              | Implemented           |
+| [Primary IP Actions](lib/hcloud/resources/primary_ip.rb)       | Implemented           |
+| [Networks](lib/hcloud/resources/network.rb)                    | Implemented           |
+| [Network Actions](lib/hcloud/resources/network.rb)             | Implemented           |
+| [Placement Groups](lib/hcloud/resources/placement_group.rb)    | Implemented           |
+| [Pricing](lib/hcloud/resources/pricing.rb)                     | Implemented           |
+| [Servers](lib/hcloud/resources/server.rb)                      | Partially implemented |
+| [Server Actions](lib/hcloud/resources/server.rb)               | Not implemented       |
+| [Server Types](lib/hcloud/resources/server_type.rb)            | Implemented           |
+| [SSH Keys](lib/hcloud/resources/ssh_key.rb)                    | Implemented           |
+| [Volumes](lib/hcloud/resources/volume.rb)                      | Implemented           |
+| [Volume Actions](lib/hcloud/resources/volume.rb)               | Implemented           |
+|                                                                |                       |
+| [Metadata](lib/hcloud/resources/metadata.rb)                   | Implemented           |
+
+### Pagination
+
+Paginated resources are wrapped in a `HCloud::Collection` that automatically fetches the next page when needed.
+The collection acts as a (lazy) enumerator.
+Call `to_a` to fetch all pages and parse all resources.
+
+### Rate limiting
+
+From the [documentation](https://docs.hetzner.cloud/#rate-limiting):
+
+> The default limit is 3600 requests per hour and per Project.
+> The number of remaining requests increases gradually.
+> For example, when your limit is 3600 requests per hour, the number of remaining requests will increase by 1 every second.
+
+The client is able to handle the rate limiting by delaying the requests if necessary and executing them whenever possible.
+To enable this behaviour, pass `rate_limit: true` as argument to `HCloud::Client.new`.
+Client calls will block until possible to execute and then return.
+
+```ruby
+client = HCloud::Client.new(access_token: "my_token", rate_limit: true)
+
+# At least one request has to be made to enable the rate limiter
+client.rate_limiter.limit # => nil
+client.rate_limiter.remaining # => nil
+client.rate_limiter.reset # => nil
+
+HCloud::Server.create(...)
+
+client.rate_limiter.limit # => 3600
+client.rate_limiter.remaining # => 3599
+client.rate_limiter.reset # => 2023-01-01 00:00:00 +0100
+
+# Make a bunch of requests
+
+client.rate_limiter.remaining # => 0
+
+servers = HCloud::Server.all # Will block until remaining requests have regenerated (1 second by default) and then execute
+ssh_keys = HCloud::SSHKey.all # Will block until remaining requests have regenerated (1 second by default) and then execute
+```
+
+Since rate limits are per hour and per project, using multiple clients at the same time will interfere with the rate limiting mechanism.
+To prevent this, wrap client calls in a loop that retries the call after it fails with a `HCloud::RateLimitExceeded` error.
 
 ## Testing
 
@@ -130,7 +175,6 @@ When executing the test suite, set `LOG_LEVEL` environment variable to `debug` i
 
 `HCloud::Client` also accepts an alternate endpoint:
 
-
 ```ruby
 client = HCloud::Client.new(access_token: "my_access_token", endpoint: "https://myproxy/v1")
 ```

data/config/inflections.rb

@@ -15,9 +15,11 @@ HCloud.loader.inflector.inflect(
   "iso" => "ISO",
   "iso_type" => "ISOType",
   "primary_ip" => "PrimaryIP",
+  "primary_ip_prices" => "PrimaryIPPrices",
   "service_http" => "ServiceHTTP",
   "ssh_key" => "SSHKey",
   "target_ip" => "TargetIP",
+  "yaml" => "YAML",
 )
 
 ActiveSupport::Inflector.inflections(:en) do |inflect|
@@ -28,4 +30,5 @@ ActiveSupport::Inflector.inflections(:en) do |inflect|
   inflect.acronym "IPv6"
   inflect.acronym "ISO"
   inflect.acronym "JSON"
+  inflect.acronym "YAML"
 end

data/lib/hcloud/client.rb

@@ -19,12 +19,13 @@ module HCloud
 
     self.connection = NilConnection.new
 
-    attr_reader :access_token, :endpoint, :logger
+    attr_reader :access_token, :endpoint, :logger, :rate_limit
 
-    def initialize(access_token:, endpoint: "https://api.hetzner.cloud/v1", logger: Logger.new("/dev/null"))
+    def initialize(access_token:, endpoint: "https://api.hetzner.cloud/v1", logger: Logger.new("/dev/null"), rate_limit: false)
       @access_token = access_token
       @endpoint = endpoint
       @logger = logger
+      @rate_limit = rate_limit
     end
 
     delegate :get, :put, :post, :delete, to: :http
@@ -32,7 +33,7 @@ module HCloud
     private
 
     def http
-      @http ||= HTTP.new(access_token, endpoint, logger)
+      @http ||= HTTP.new(access_token, endpoint, logger, rate_limit)
     end
   end
 end

data/lib/hcloud/collection.rb

@@ -6,7 +6,7 @@ module HCloud
 
     attr_accessor :page, :previous_page, :next_page, :last_page, :per_page, :total_entries, :proc
 
-    attr_reader :sort_by, :filter_by
+    attr_reader :sort_by, :filter_by, :label_selector
 
     def initialize(&block)
       @proc = block
@@ -24,8 +24,9 @@ module HCloud
       self
     end
 
-    def where(**filter_by)
+    def where(label_selector: nil, **filter_by)
       @filter_by = filter_by
+      @label_selector = label_selector
 
       self
     end
@@ -70,6 +71,7 @@ module HCloud
         page: page,
         per_page: per_page,
         sort: sort_by,
+        label_selector: label_selector&.map { |k, v| "#{k}=#{v}" }&.join(","),
         **filter_by,
       }
     end

data/lib/hcloud/concerns/concerns.rb

@@ -32,6 +32,10 @@ module HCloud
       def singleton
         include Singleton
       end
+
+      def labelable
+        include Labelable
+      end
     end
   end
 end

data/lib/hcloud/concerns/labelable.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module HCloud
+  module Labelable
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :labels, default: -> { {} }
+    end
+  end
+end

data/lib/hcloud/concerns/queryable.rb

@@ -17,6 +17,8 @@ module HCloud
     end
 
     class_methods do
+      delegate :first, :last, :count, :where, :sort, :each, :empty?, :any?, to: :all
+
       def find(id)
         raise Errors::MissingIDError unless id
 

data/lib/hcloud/entities/primary_ip_prices.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module HCloud
+  class PrimaryIPPrices < Entity
+    attribute :type
+    attribute :prices, :price
+  end
+end

data/lib/hcloud/entities/private_network.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module HCloud
+  class PrivateNetwork < Entity
+    attribute :ip
+    attribute :alias_ips, array: true, default: -> { [] }
+    attribute :interface_num, :integer
+    attribute :mac_address
+    attribute :network_id, :integer
+    attribute :network_name
+    attribute :network
+    attribute :subnet
+    attribute :gateway
+  end
+end

data/lib/hcloud/entities/protection.rb

@@ -3,9 +3,7 @@
 module HCloud
   class Protection < Entity
     attribute :delete, :boolean
-    attribute :rebuild, :boolean
 
     alias delete? delete
-    alias rebuild? rebuild
   end
 end

data/lib/hcloud/entities/server_protection.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module HCloud
+  class ServerProtection < Entity
+    attribute :delete, :boolean
+    attribute :rebuild, :boolean
+
+    alias delete? delete
+    alias rebuild? rebuild
+  end
+end

data/lib/hcloud/http.rb

@@ -4,12 +4,13 @@ require "http"
 
 module HCloud
   class HTTP
-    attr_reader :access_token, :endpoint, :logger, :timeout
+    attr_reader :access_token, :endpoint, :logger, :rate_limit, :timeout
 
-    def initialize(access_token, endpoint, logger, timeout = 10)
+    def initialize(access_token, endpoint, logger, rate_limit = false, timeout = 10)
       @access_token = access_token
       @endpoint = endpoint
       @logger = logger
+      @rate_limit = rate_limit
       @timeout = timeout
     end
 
@@ -80,6 +81,7 @@ module HCloud
         .headers(accept: "application/json", user_agent: "#{HCloud::NAME}/#{HCloud::VERSION}")
         .timeout(timeout)
         .use(logging: { logger: logger })
+        .then { |h| rate_limit ? h.use(:rate_limiter) : h }
         .encoding("utf-8")
         .auth("Bearer #{access_token}")
     end

data/lib/hcloud/resource_type.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
 module HCloud
   class ResourceType
     class_attribute :resource_class_name
@@ -10,7 +11,6 @@ module HCloud
       @array = array
     end
 
-    # rubocop:disable Metrics/CyclomaticComplexity
     def cast(value)
       case value
       when nil, []
@@ -28,12 +28,13 @@ module HCloud
       when Hash # Attribute hash
         resource_class.new(value)
       when Array # List
+        raise ArgumentError, "cannot cast value: #{value} for type #{resource_class_name}" unless array?
+
         value.map { |v| cast(v) }
       else
         raise ArgumentError, "cannot cast value: #{value} for type #{resource_class_name}"
       end
     end
-    # rubocop:enable Metrics/CyclomaticComplexity
 
     def resource_class
       @resource_class ||= resource_class_name.constantize
@@ -52,8 +53,32 @@ module HCloud
         .tap { |klass| HCloud.const_set(:"#{class_name.demodulize}ResourceType", klass) }
     end
     # rubocop:enable Naming/MethodName
+
+    class GenericType < ResourceType
+      def cast(value)
+        case value
+        when nil, []
+          array? ? [] : nil
+        when HCloud::Resource # Class
+          value
+        when Hash # Attribute hash
+          ActiveModel::Type
+            .lookup(value.fetch(:type).to_sym)
+            .cast(value.except(:type))
+        when Array # List
+          raise ArgumentError, "cannot cast value: #{value} for generic type" unless array?
+
+          value.map { |v| cast(v) }
+        else
+          raise ArgumentError, "cannot cast value: #{value} for generic type"
+        end
+      rescue KeyError => e
+        raise ArgumentError, "cannot cast value: #{value} for generic type: #{e.message}"
+      end
+    end
   end
 end
+# rubocop:enable Metrics/CyclomaticComplexity,Metrics/AbcSize
 
 ActiveModel::Type.register(:action, HCloud::ResourceType.Type("HCloud::Action"))
 ActiveModel::Type.register(:algorithm, HCloud::ResourceType.Type("HCloud::Algorithm"))
@@ -86,18 +111,23 @@ ActiveModel::Type.register(:load_balancer_public_net, HCloud::ResourceType.Type(
 ActiveModel::Type.register(:load_balancer_type, HCloud::ResourceType.Type("HCloud::LoadBalancerType"))
 ActiveModel::Type.register(:load_balancer_type_price, HCloud::ResourceType.Type("HCloud::LoadBalancerTypePrice"))
 ActiveModel::Type.register(:location, HCloud::ResourceType.Type("HCloud::Location"))
+ActiveModel::Type.register(:metadata, HCloud::ResourceType.Type("HCloud::Metadata"))
 ActiveModel::Type.register(:network, HCloud::ResourceType.Type("HCloud::Network"))
 ActiveModel::Type.register(:placement_group, HCloud::ResourceType.Type("HCloud::PlacementGroup"))
 ActiveModel::Type.register(:price, HCloud::ResourceType.Type("HCloud::Price"))
 ActiveModel::Type.register(:pricing, HCloud::ResourceType.Type("HCloud::Pricing"))
 ActiveModel::Type.register(:primary_ip, HCloud::ResourceType.Type("HCloud::PrimaryIP"))
+ActiveModel::Type.register(:primary_ip_prices, HCloud::ResourceType.Type("HCloud::PrimaryIPPrices"))
 ActiveModel::Type.register(:private_net, HCloud::ResourceType.Type("HCloud::PrivateNet"))
+ActiveModel::Type.register(:private_network, HCloud::ResourceType.Type("HCloud::PrivateNetwork"))
 ActiveModel::Type.register(:protection, HCloud::ResourceType.Type("HCloud::Protection"))
 ActiveModel::Type.register(:public_net, HCloud::ResourceType.Type("HCloud::PublicNet"))
+ActiveModel::Type.register(:resource, HCloud::ResourceType::GenericType)
 ActiveModel::Type.register(:route, HCloud::ResourceType.Type("HCloud::Route"))
 ActiveModel::Type.register(:rule, HCloud::ResourceType.Type("HCloud::Rule"))
 ActiveModel::Type.register(:server, HCloud::ResourceType.Type("HCloud::Server"))
 ActiveModel::Type.register(:server_backup_price, HCloud::ResourceType.Type("HCloud::ServerBackupPrice"))
+ActiveModel::Type.register(:server_protection, HCloud::ResourceType.Type("HCloud::ServerProtection"))
 ActiveModel::Type.register(:server_type, HCloud::ResourceType.Type("HCloud::ServerType"))
 ActiveModel::Type.register(:server_type_price, HCloud::ResourceType.Type("HCloud::ServerTypePrice"))
 ActiveModel::Type.register(:service, HCloud::ResourceType.Type("HCloud::Service"))

data/lib/hcloud/resources/action.rb

@@ -11,18 +11,18 @@ module HCloud
   #
   # == Sort actions
   #
-  #     HCloud::Action.all.sort(command: :desc)
+  #     HCloud::Action.sort(command: :desc)
   #     # => [#<HCloud::Action id: 1, ...>, ...]
   #
-  #     HCloud::Action.all.sort(:id, command: :asc)
+  #     HCloud::Action.sort(:id, command: :asc)
   #     # => [#<HCloud::Action id: 1, ...>, ...]
   #
   # == Search actions
   #
-  #     HCloud::Action.all.where(command: "my_action")
+  #     HCloud::Action.where(command: "my_action")
   #     # => #<HCloud::Action id: 1, ...>
   #
-  #     HCloud::Action.all.where(status: "success")
+  #     HCloud::Action.where(status: "success")
   #     # => #<HCloud::Action id: 1, ...>
   #
   # == Find action by ID
@@ -43,7 +43,6 @@ module HCloud
     attribute :status
     attribute :error, :error
 
-    # TODO: return array of resources
-    attribute :resources, array: true, default: -> { [] }
+    attribute :resources, :resource, array: true, default: -> { [] }
   end
 end

data/lib/hcloud/resources/certificate.rb

@@ -11,18 +11,21 @@ module HCloud
   #
   # == Sort certificates
   #
-  #     HCloud::Certificate.all.sort(name: :desc)
+  #     HCloud::Certificate.sort(name: :desc)
   #     # => [#<HCloud::Certificate id: 1, ...>, ...]
   #
-  #     HCloud::Certificate.all.sort(:id, name: :asc)
+  #     HCloud::Certificate.sort(:id, name: :asc)
   #     # => [#<HCloud::Certificate id: 1, ...>, ...]
   #
   # == Search certificates
   #
-  #     HCloud::Certificate.all.where(name: "my_certificate")
+  #     HCloud::Certificate.where(name: "my_certificate")
   #     # => #<HCloud::Certificate id: 1, ...>
   #
-  #     HCloud::Certificate.all.where(type: "uploaded")
+  #     HCloud::Certificate.where(type: "uploaded")
+  #     # => #<HCloud::Certificate id: 1, ...>
+  #
+  #     HCloud::Certificate.where(label_selector: { environment: "production" })
   #     # => #<HCloud::Certificate id: 1, ...>
   #
   # == Find certificate by ID
@@ -94,6 +97,7 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -116,8 +120,6 @@ module HCloud
     # TODO: dynamically return resource classes
     attribute :used_by, :used_by, array: true, default: -> { [] }
 
-    attribute :labels, default: -> { {} }
-
     action :retry
 
     def creatable_attributes

data/lib/hcloud/resources/datacenter.rb

@@ -11,7 +11,7 @@ module HCloud
   #
   # == Search datacenters
   #
-  #     HCloud::Datacenter.all.where(name: "fsn1-dc8")
+  #     HCloud::Datacenter.where(name: "fsn1-dc8")
   #     # => #<HCloud::Datacenter id: 2, ...>
   #
   # == Find datacenter by ID

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

@@ -11,18 +11,21 @@ module HCloud
   #
   # == Sort primary IPs
   #
-  #     HCloud::PrimaryIP.all.sort(id: :asc)
+  #     HCloud::PrimaryIP.sort(id: :asc)
   #     # => [#<HCloud::PrimaryIP id: 1, ...>, ...]
   #
-  #     HCloud::PrimaryIP.all.sort(:id, created: :asc)
+  #     HCloud::PrimaryIP.sort(:id, created: :asc)
   #     # => [#<HCloud::PrimaryIP id: 1, ...>, ...]
   #
   # == Search primary IPs
   #
-  #     HCloud::PrimaryIP.all.where(name: "my_primary_ip")
+  #     HCloud::PrimaryIP.where(name: "my_primary_ip")
   #     # => #<HCloud::PrimaryIP id: 1, ...>
   #
-  #     HCloud::PrimaryIP.all.where(ip: "1.2.3.4")
+  #     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
@@ -107,6 +110,7 @@ module HCloud
     creatable
     updatable
     deletable
+    labelable
 
     attribute :id, :integer
     attribute :name
@@ -125,8 +129,6 @@ module HCloud
 
     attribute :protection, :protection
 
-    attribute :labels, default: -> { {} }
-
     alias auto_delete? auto_delete
     alias blocked? blocked
 

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,7 +3,7 @@
 module HCloud
   module Version
     MAJOR = 1
-    MINOR = 4
+    MINOR = 5
     PATCH = 0
     PRE   = nil
 

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)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hetznercloud
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Florian Dejonckheere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-01-22 00:00:00.000000000 Z
+date: 2023-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -66,132 +66,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: dotenv
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: ffaker
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-performance
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop-rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Native Ruby integration with the Hetzner Cloud API
 email:
 - florian@floriandejonckheere.be
@@ -213,6 +87,7 @@ files:
 - lib/hcloud/concerns/concerns.rb
 - lib/hcloud/concerns/creatable.rb
 - lib/hcloud/concerns/deletable.rb
+- lib/hcloud/concerns/labelable.rb
 - lib/hcloud/concerns/meterable.rb
 - lib/hcloud/concerns/queryable.rb
 - lib/hcloud/concerns/singleton.rb
@@ -240,12 +115,15 @@ files:
 - lib/hcloud/entities/load_balancer_type_price.rb
 - lib/hcloud/entities/metrics.rb
 - lib/hcloud/entities/price.rb
+- lib/hcloud/entities/primary_ip_prices.rb
 - lib/hcloud/entities/private_net.rb
+- lib/hcloud/entities/private_network.rb
 - lib/hcloud/entities/protection.rb
 - lib/hcloud/entities/public_net.rb
 - lib/hcloud/entities/route.rb
 - lib/hcloud/entities/rule.rb
 - lib/hcloud/entities/server_backup_price.rb
+- lib/hcloud/entities/server_protection.rb
 - lib/hcloud/entities/server_type_price.rb
 - lib/hcloud/entities/service.rb
 - lib/hcloud/entities/service_http.rb
@@ -272,6 +150,7 @@ files:
 - lib/hcloud/resources/load_balancer.rb
 - lib/hcloud/resources/load_balancer_type.rb
 - lib/hcloud/resources/location.rb
+- lib/hcloud/resources/metadata.rb
 - lib/hcloud/resources/network.rb
 - lib/hcloud/resources/placement_group.rb
 - lib/hcloud/resources/pricing.rb
@@ -281,6 +160,8 @@ files:
 - lib/hcloud/resources/ssh_key.rb
 - lib/hcloud/resources/volume.rb
 - lib/hcloud/version.rb
+- lib/http/mime_type/yaml.rb
+- lib/http/rate_limiter.rb
 homepage: https://github.com/floriandejonckheere/hcloud
 licenses:
 - MIT