hetznercloud 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 75623886cacdbf6d5513f45eb32c0d34ef0c8f0c1adee2bc7e69bf049b9c77ce
+  data.tar.gz: 8055fc431b7a33ef53c6f30ca9002e36f91e1c723197294bf1cc8c00d8035072
+SHA512:
+  metadata.gz: ccc0bcd9ea354b43cd7b235b788f516a2665066580f44cd25e9d17d6e206680e3cc33786c14c1e47a5948c606588ef517e0a371a6de8537365e8697fea04a16d
+  data.tar.gz: cce03b3d75507f236152b04b731bd85cf88e15bef217805f6758e1fbf7dc12eb66e36b24717ee01680b16226f20d457b301436ca83d03aa183b6f7945f93dda0

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## HCloud v1.0.0
+
+Initial release

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in hcloud.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 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
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,123 @@
+# HCloud
+
+![Continuous Integration](https://github.com/floriandejonckheere/hcloud/workflows/Continuous%20Integration/badge.svg)
+![Release](https://img.shields.io/github/v/release/floriandejonckheere/hcloud?label=Latest%20release)
+
+Unofficial Ruby integration with the [Hetzner Cloud API](https://docs.hetzner.cloud/).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+gem "hetznercloud"
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install hcloud
+
+## Usage
+
+```ruby
+require "hcloud"
+
+# Create a new client
+client = HCloud::Client.new(access_token: "my_access_token")
+
+# Set client as default connection
+HCloud::Client.connection = client
+
+# Create resource
+ssh_key = HCloud::SSHKey.new(name: "My SSH key", public_key: "ssh-rsa ...")
+ssh_key.create
+
+# Alternate syntax:
+ssh_key = HCloud::SSHKey.create(name: "My SSH key", public_key: "ssh-rsa ...")
+
+# Find resource by ID
+ssh_key = HCloud::SSHKey.find(1)
+
+# Update resource
+ssh_key.updatable_attributes # => [:name, :labels]
+ssh_key.name = "New name"
+ssh_key.update
+
+# Delete resource
+ssh_key.delete
+ssh_key.deleted?
+# => true
+
+# For detailed usage of resources, refer to the class documentation
+
+# When specifying associated resources, you can either use an instance of the resource, an integer as ID or a string as name.
+# The following calls are equivalent:
+server = HCloud::Server.new(name: "my_server", location: "fsn", ...)
+server = HCloud::Server.new(name: "my_server", location: 1, ...)
+server = HCloud::Server.new(name: "my_server", location: Location.new(name: "fsn"), ...)
+```
+
+The gem aims to provide a simple, object-oriented interface to the Hetzner Cloud API.
+It does not aim to be an authoritative source of information, and as such does little validation on your input data or behaviour.
+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          | Not implemented       |
+| Certificate Actions   | Not implemented       |
+| Datacenters           | Implemented           |
+| Firewalls             | Implemented           |
+| Firewall Actions      | Not implemented       |
+| Floating IPs          | Implemented           |
+| Floating IP Actions   | Implemented           |
+| Images                | Implemented           |
+| Image Actions         | Implemented           |
+| ISOs                  | Implemented           |
+| Load Balancers        | Not implemented       |
+| Load Balancer Actions | Not implemented       |
+| Load Balancer Types   | Not implemented       |
+| Locations             | Implemented           |
+| Networks              | Not implemented       |
+| Network Actions       | Not implemented       |
+| Placement Groups      | Implemented           |
+| Pricing               | Not implemented       |
+| Servers               | Partially implemented |
+| Server Actions        | Not implemented       |
+| Server Types          | Implemented           |
+| SSH Keys              | Implemented           |
+| Volumes               | Implemented           |
+| Volume Actions        | Implemented           |
+
+## Testing
+
+```ssh
+# Run test suite (without integration tests)
+bundle exec rspec
+
+# Run integration tests (WARNING: THIS WILL DESTROY **ALL** RESOURCES AFTER EACH RUN)
+bundle exec rspec --tag integration
+```
+
+## Releasing
+
+To release a new version, update the version number in `lib/hcloud/version.rb`, update the changelog, commit the files and create a git tag starting with `v`, and push it to the repository.
+Github Actions will automatically run the test suite, build the `.gem` file and push it to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at [https://github.com/floriandejonckheere/hcloud](https://github.com/floriandejonckheere/hcloud). 
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/config/inflections.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+HCloud.loader.inflector.inflect(
+  "dns_pointer" => "DNSPointer",
+  "hcloud" => "HCloud",
+  "ssh_key" => "SSHKey",
+  "floating_ip" => "FloatingIP",
+  "http" => "HTTP",
+  "ip_not_available" => "IPNotAvailable",
+  "iso" => "ISO",
+  "iso_type" => "ISOType",
+)
+
+ActiveSupport::Inflector.inflections(:en) do |inflect|
+  inflect.acronym "DNS"
+  inflect.acronym "JSON"
+  inflect.acronym "IP"
+  inflect.acronym "ISO"
+end

data/lib/core_ext/send_wrap.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module CoreExt
+  module SendWrap
+    # Send a message to self, or all objects contained in self (for enumerables)
+
+    # FIXME: { env: "prod" }.send_wrap(:try, :to_h) returns { env: nil }
+
+    def send_wrap(method_name, ...)
+      is_a?(Array) ? map { |v| v.send(method_name, ...) } : send(method_name, ...)
+    end
+  end
+end
+
+Object.include CoreExt::SendWrap

data/lib/hcloud/action_collection.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module HCloud
+  class ActionCollection < Collection
+    attr_reader :resource
+
+    def initialize(resource)
+      super(&method(:all))
+
+      @resource = resource
+    end
+
+    def find(id)
+      Action.new resource
+        .client
+        .get("/#{resource.resource_name.pluralize}/#{resource.id}/actions/#{id}")
+        .fetch(:action)
+    end
+
+    private
+
+    def all(params)
+      response = resource
+        .client
+        .get("/#{resource.resource_name.pluralize}/#{resource.id}/actions", params)
+
+      data = response
+        .fetch(:actions)
+        .map { |attrs| Action.new attrs }
+
+      meta = response
+        .fetch(:meta)
+
+      [data, meta]
+    end
+  end
+end

data/lib/hcloud/client.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "logger"
+
+module HCloud
+  class NilConnection
+    def raise_error(...)
+      raise ArgumentError, "no default client configured, set HCloud::Client.connection to an instance of HCloud::Client"
+    end
+
+    alias get raise_error
+    alias put raise_error
+    alias post raise_error
+    alias delete raise_error
+  end
+
+  class Client
+    class_attribute :connection
+
+    self.connection = NilConnection.new
+
+    attr_reader :access_token, :endpoint, :logger
+
+    def initialize(access_token:, endpoint: "https://api.hetzner.cloud/v1", logger: Logger.new("/dev/null"))
+      @access_token = access_token
+      @endpoint = endpoint
+      @logger = logger
+    end
+
+    delegate :get, :put, :post, :delete, to: :http
+
+    private
+
+    def http
+      @http ||= HTTP.new(access_token, endpoint, logger)
+    end
+  end
+end

data/lib/hcloud/collection.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module HCloud
+  class Collection
+    include Enumerable
+
+    attr_accessor :page, :previous_page, :next_page, :last_page, :per_page, :total_entries, :proc
+
+    attr_reader :sort_by, :filter_by
+
+    def initialize(&block)
+      @proc = block
+
+      @page = 1
+      @per_page = 50
+
+      @sort_by = nil
+      @filter_by = {}
+    end
+
+    def sort(*sort_by)
+      @sort_by = sort_by
+
+      self
+    end
+
+    def where(**filter_by)
+      @filter_by = filter_by
+
+      self
+    end
+
+    def each(&block)
+      return to_enum(:each) unless block
+
+      loop do
+        # Fetch page
+        data, meta = proc.call(params)
+
+        # Yield data in page
+        data.each(&block)
+
+        # Set cursor and other page attributes
+        meta[:pagination].each { |k, v| send(:"#{k}=", v) }
+
+        break if page == last_page
+
+        # Increment page
+        @page += 1
+      end
+
+      self
+    end
+
+    def count
+      # Fetch total_entries if not present
+      @count ||= (total_entries || proc.call(params.merge(page: 1)).last.dig(:pagination, :total_entries))
+    end
+
+    def empty?
+      count.zero?
+    end
+
+    delegate :[], :last, to: :to_a
+
+    private
+
+    def params
+      {
+        page: page,
+        per_page: per_page,
+        sort: sort_by,
+        **filter_by,
+      }
+    end
+  end
+end

data/lib/hcloud/concerns/actionable.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module HCloud
+  module Actionable
+    extend ActiveSupport::Concern
+
+    included do
+      class_attribute :action_names
+
+      self.action_names = []
+
+      def actions
+        ActionCollection.new(self)
+      end
+    end
+
+    class_methods do
+      def action(name)
+        action_names << name.to_s
+
+        define_method(name) do |**params|
+          Action.new client
+            .post("/#{resource_name.pluralize}/#{id}/actions/#{name}", params)
+            .fetch(:action)
+        end
+      end
+    end
+  end
+end

data/lib/hcloud/concerns/concerns.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module HCloud
+  module Concerns
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def actionable
+        include Actionable
+      end
+
+      def queryable
+        include Queryable
+      end
+
+      def creatable
+        include Creatable
+      end
+
+      def updatable
+        include Updatable
+      end
+
+      def deletable
+        include Deletable
+      end
+    end
+  end
+end

data/lib/hcloud/concerns/creatable.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module HCloud
+  module Creatable
+    extend ActiveSupport::Concern
+
+    included do
+      attribute :created, :datetime
+
+      def create
+        assign_attributes client
+          .post("/#{resource_name.pluralize}", creatable_params)
+          .fetch(resource_name.to_sym)
+      end
+
+      def created?
+        created.present?
+      end
+
+      def creatable_attributes
+        []
+      end
+
+      # Convert creatable_attributes into a key-value list
+      # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      def creatable_params
+        # Split simple and nested attributes
+        nested_attributes, simple_attributes = creatable_attributes.partition { |a| a.respond_to? :each }
+
+        attributes
+          .slice(*simple_attributes.map(&:to_s))
+          .transform_values { |v| v&.send_wrap(:try, :to_h) || v&.send_wrap(:to_s) }
+          .merge(nested_attributes.reduce(&:merge)&.map { |k, v| [k.to_s, Array(v).filter_map { |w| send(k)&.send_wrap(w) }.first] }.to_h)
+          .compact
+      end
+      # rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+    end
+
+    class_methods do
+      def create(**attributes)
+        new(attributes)
+          .tap(&:create)
+      end
+    end
+  end
+end

data/lib/hcloud/concerns/deletable.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module HCloud
+  module Deletable
+    extend ActiveSupport::Concern
+
+    included do
+      def delete
+        client
+          .delete("/#{resource_name.pluralize}/#{id}")
+
+        @deleted = true
+      end
+
+      def deleted?
+        @deleted.present?
+      end
+    end
+  end
+end

data/lib/hcloud/concerns/queryable.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module HCloud
+  module Queryable
+    extend ActiveSupport::Concern
+
+    included do
+      def reload
+        assign_attributes client
+          .get("/#{resource_name.pluralize}/#{id}")
+          .fetch(resource_name.to_sym)
+
+        self
+      end
+    end
+
+    class_methods do
+      def find(id)
+        new client
+          .get("/#{resource_name.pluralize}/#{id}")
+          .fetch(resource_name.to_sym)
+      end
+
+      def all
+        Collection.new do |params|
+          response = client
+            .get("/#{resource_name.pluralize}", params)
+
+          data = response
+            .fetch(resource_name.pluralize.to_sym)
+            .map { |attrs| new attrs }
+
+          meta = response
+            .fetch(:meta)
+
+          [data, meta]
+        end
+      end
+    end
+  end
+end

data/lib/hcloud/concerns/updatable.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module HCloud
+  module Updatable
+    extend ActiveSupport::Concern
+
+    included do
+      def update
+        assign_attributes client
+          .put("/#{resource_name.pluralize}/#{id}", updatable_params)
+          .fetch(resource_name.to_sym)
+      end
+
+      def updatable_attributes
+        []
+      end
+
+      # Convert updatable_attributes into a key-value list
+      def updatable_params
+        attributes.slice(*updatable_attributes.map(&:to_s))
+      end
+    end
+  end
+end

data/lib/hcloud/entities/amount.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module HCloud
+  class Amount < Entity
+    attribute :gross, :decimal
+    attribute :net, :decimal
+  end
+end

data/lib/hcloud/entities/applied_to.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module HCloud
+  class AppliedTo < ApplyTo
+    attribute :applied_to_resources, :applied_to_resource, array: true, default: -> { [] }
+  end
+end

data/lib/hcloud/entities/applied_to_resource.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module HCloud
+  class AppliedToResource < Entity
+    attribute :type
+
+    attribute :server, :server
+  end
+end

data/lib/hcloud/entities/apply_to.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module HCloud
+  class ApplyTo < Entity
+    attribute :type
+
+    attribute :server, :server
+    attribute :label_selector
+
+    def to_h
+      # Omit `label_selector` if type is `server` and vice versa
+      super.except(type == "server" ? "label_selector" : "server")
+    end
+  end
+end

data/lib/hcloud/entities/datacenter_server_type.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module HCloud
+  class DatacenterServerType < Entity
+    attribute :available, array: true, default: -> { [] }
+    attribute :available_for_migration, array: true, default: -> { [] }
+    attribute :supported, array: true, default: -> { [] }
+  end
+end

data/lib/hcloud/entities/dns_pointer.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module HCloud
+  class DNSPointer < Entity
+    attribute :dns_ptr
+    attribute :ip
+  end
+end

data/lib/hcloud/entities/error.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module HCloud
+  class Error < Entity
+    attribute :code
+    attribute :message
+  end
+end

data/lib/hcloud/entities/metrics.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module HCloud
+  class Metrics < Entity
+    attribute :start, :datetime
+    attribute :end, :datetime
+
+    attribute :step, :integer
+
+    attribute :time_series
+  end
+end

data/lib/hcloud/entities/price.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module HCloud
+  class Price < Entity
+    attribute :location
+    attribute :price_hourly, :amount
+    attribute :price_monthly, :amount
+  end
+end

data/lib/hcloud/entities/protection.rb

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

data/lib/hcloud/entities/rule.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module HCloud
+  class Rule < Entity
+    attribute :description
+
+    attribute :source_ips, array: true, default: -> { [] }
+    attribute :destination_ips, array: true, default: -> { [] }
+
+    attribute :port
+    attribute :protocol
+
+    attribute :direction
+  end
+end