hetznercloud 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7de89d0a6117d05ba5b57c40b41601aecb419a6ca8c9bd5b639117051a6501e4
-  data.tar.gz: 9b3a8d86043d7c2a7622816f987b4bfa7c2584b2fe0b2535e8e3300f4a5117ab
+  metadata.gz: a1b9b0de15d2fe2aecdbfa6b00b46df9ec658855ebdafcabebe72f371dd98d50
+  data.tar.gz: 6c39c3ee93d35767d355e522408d1285ce3777fc841753968ae9c33d0916cc6c
 SHA512:
-  metadata.gz: ae331dfc72e7baf0bda9b6e6ad9354630166d4faa9169538d56f69c3d5117703955df6d5b7f10851e5f1cbd082d4b942826914091d2f22ec628040259e63405f
-  data.tar.gz: 2898e89f00a5ba8be3b7d75eb27ba3b3d507a83683f0b214555600c89482c7fc317b5cbf3f1e7e5461a784a5e047e6f302a08047320e230ab0bc5049eda70fc4
+  metadata.gz: 7a9971d0195c839594b88759d828dc04f98e36d37eab7880d27f4299f8266d2e37676eea3b60399440bed9240e6d39190dba0af75f2d32bfe78c5e42bb160cd5
+  data.tar.gz: bbecc7998329638d8499d0a33c877cdc5857b2a94c80633672a874f6828cc69f29e67d8e3a618b21db5cd84d87cf66cecd2e2ee3ddcfa16db00f841394f0ea85

data/CHANGELOG.md

@@ -1,11 +1,26 @@
 # Changelog
 
-## HCloud v1.3.0
+## HCloud v1.4.0 (2023-01-22)
+
+- Implemented Primary IPs
+- Implemented Primary IP Actions
+- Allow calling `#update` with additional attributes to be updated
+- Return the resource when calling `#create`, `#update` or `#delete`
+- Add additional primary IP mismatch errors:
+  - `PrimaryIPAssigned`
+  - `PrimaryIPDatacenterMismatch`
+  - `PrimaryIPVersionMismatch`
+
+## HCloud v1.3.1 (2022-02-06)
+
+- Add missing `Server#user_data`
+
+## HCloud v1.3.0 (2022-02-04)
 
 - Implemented Load Balancers
 - Implemented Load Balancer Types
 
-## HCloud v1.2.0
+## HCloud v1.2.0 (2022-02-01)
 
 - Implemented Networks
 - Implemented Network Actions
@@ -13,10 +28,10 @@
 - Implemented Certificates
 - Implemented Certificate Actions
 
-## HCloud v1.1.0
+## HCloud v1.1.0 (2022-01-30)
 
 - Implemented Firewall Actions
 
-## HCloud v1.0.0
+## HCloud v1.0.0 (2022-01-16)
 
 Initial release

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Florian Dejonckheere
+Copyright (c) 2023 Florian Dejonckheere
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -88,6 +88,8 @@ Not all Hetzner Cloud API endpoints have been implemented yet.
 | 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           |

data/config/inflections.rb

@@ -14,6 +14,7 @@ HCloud.loader.inflector.inflect(
   "ipv6" => "IPv6",
   "iso" => "ISO",
   "iso_type" => "ISOType",
+  "primary_ip" => "PrimaryIP",
   "service_http" => "ServiceHTTP",
   "ssh_key" => "SSHKey",
   "target_ip" => "TargetIP",
@@ -23,6 +24,8 @@ ActiveSupport::Inflector.inflections(:en) do |inflect|
   inflect.acronym "DNS"
   inflect.acronym "HTTP"
   inflect.acronym "IP"
+  inflect.acronym "IPv4"
+  inflect.acronym "IPv6"
   inflect.acronym "ISO"
   inflect.acronym "JSON"
 end

data/lib/hcloud/concerns/creatable.rb

@@ -12,6 +12,8 @@ module HCloud
           .post("/#{resource_name.pluralize}", creatable_params)
           .tap { |r| r[resource_name.to_sym].merge!(r.slice(:root_password)) }
           .fetch(resource_name.to_sym)
+
+        self
       end
 
       def created?

data/lib/hcloud/concerns/deletable.rb

@@ -12,6 +12,8 @@ module HCloud
           .delete("/#{resource_name.pluralize}/#{id}")
 
         @deleted = true
+
+        self
       end
 
       def deleted?

data/lib/hcloud/concerns/updatable.rb

@@ -5,12 +5,16 @@ module HCloud
     extend ActiveSupport::Concern
 
     included do
-      def update
+      def update(**attributes)
         raise Errors::MissingIDError unless id
 
+        assign_attributes attributes
+
         assign_attributes client
           .put("/#{resource_name.pluralize}/#{id}", updatable_params)
           .fetch(resource_name.to_sym)
+
+        self
       end
 
       def updatable_attributes

data/lib/hcloud/errors.rb

@@ -43,6 +43,10 @@ module HCloud
     class NotFound < Error; end
     class PlacementError < Error; end
     class PlacementError < Error; end
+    class PrimaryIPAssigned < Error; end
+    class PrimaryIPAlreadyAssigned < Error; end
+    class PrimaryIPDatacenterMismatch < Error; end
+    class PrimaryIPVersionMismatch < Error; end
     class Protected < Error; end
     class RateLimitExceeded < Error; end
     class ResourceInUse < Error; end
@@ -52,7 +56,11 @@ module HCloud
     class ServerAlreadyAdded < Error; end
     class ServerAlreadyAttached < Error; end
     class ServerError < Error; end
+    class ServerHasIPv4 < Error; end
+    class ServerHasIPv6 < Error; end
+    class ServerIsLoadBalancerTarget < Error; end
     class ServerNotAttachedToNetwork < Error; end
+    class ServerNotStopped < Error; end
     class ServiceError < Error; end
     class SourcePortAlreadyUsed < Error; end
     class TargetAlreadyDefined < Error; end

data/lib/hcloud/resource_type.rb

@@ -90,6 +90,7 @@ 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(:private_net, HCloud::ResourceType.Type("HCloud::PrivateNet"))
 ActiveModel::Type.register(:protection, HCloud::ResourceType.Type("HCloud::Protection"))
 ActiveModel::Type.register(:public_net, HCloud::ResourceType.Type("HCloud::PublicNet"))

data/lib/hcloud/resources/primary_ip.rb

@@ -0,0 +1,148 @@
+# 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.all.sort(id: :asc)
+  #     # => [#<HCloud::PrimaryIP id: 1, ...>, ...]
+  #
+  #     HCloud::PrimaryIP.all.sort(:id, created: :asc)
+  #     # => [#<HCloud::PrimaryIP id: 1, ...>, ...]
+  #
+  # == Search primary IPs
+  #
+  #     HCloud::PrimaryIP.all.where(name: "my_primary_ip")
+  #     # => #<HCloud::PrimaryIP id: 1, ...>
+  #
+  #     HCloud::PrimaryIP.all.where(ip: "1.2.3.4")
+  #     # => #<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
+
+    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
+
+    attribute :labels, default: -> { {} }
+
+    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

@@ -33,7 +33,7 @@ module HCloud
   # == Create server
   #
   #     user_data = File.read("user_data.yml")
-  #     server = HCloud::Server.new(name: "my_server", image: "debian-11", server_type: "cx11")
+  #     server = HCloud::Server.new(name: "my_server", image: "debian-11", server_type: "cx11", user_data: user_data)
   #     server.create
   #     server.created?
   #     # => true
@@ -82,6 +82,9 @@ module HCloud
 
     attribute :backup_window
 
+    # TODO: use only for creation
+    attribute :user_data
+
     # TODO: use only for creation
     attribute :location, :location
 

data/lib/hcloud/version.rb

@@ -3,7 +3,7 @@
 module HCloud
   module Version
     MAJOR = 1
-    MINOR = 3
+    MINOR = 4
     PATCH = 0
     PRE   = nil
 

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")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hetznercloud
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Florian Dejonckheere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-04 00:00:00.000000000 Z
+date: 2023-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -275,6 +275,7 @@ files:
 - lib/hcloud/resources/network.rb
 - lib/hcloud/resources/placement_group.rb
 - lib/hcloud/resources/pricing.rb
+- lib/hcloud/resources/primary_ip.rb
 - lib/hcloud/resources/server.rb
 - lib/hcloud/resources/server_type.rb
 - lib/hcloud/resources/ssh_key.rb
@@ -301,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.3.5
 signing_key: 
 specification_version: 4
 summary: Ruby library wrapping the Hetzner Cloud API