hetznercloud 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c90b55b1202ba500b10d67653c2c0bf7d4af7b2045f257a58d973da7d73501db
-  data.tar.gz: f752ab64cb5d2208aed1cae8d5312aafee5314a54d27929e67f38978439d7b36
+  metadata.gz: 34a83a28ff685be48e3c59036aec00189356152540e96e3f0cdcd87dd927ea65
+  data.tar.gz: c3b9f90bd3bf142961216555382e62452e4bb0141bfba3d7ac5d09b2cbc9f93b
 SHA512:
-  metadata.gz: 99a1bd26d8f9e2f4f0c4bfffdc3f01233cd5e3616594c15144a3c3f6ee3f268f6fd47c18c57a8073118d8630832d15ace0c89c8af355a31602eb7d78221ce6c9
-  data.tar.gz: 9db2511d57761816e5a02051f0c9e3ab817074056c05ce33d079ad0dfb34173da239f97cf14342dd9c8986ce65770b621c2568d762ef8647d8dc1335b573ca80
+  metadata.gz: 54cc55c7d63d2dc949fe2112847a53184fb6155be571fcd1ec2940905536f2da2ffab94b7808bba2c3eb42775bce7a86a9b0057b1afdf98e60507f799e2e0db3
+  data.tar.gz: 48ac006b7ee34632ad52f177b2e89d1e260161311421c61fdd57e778791cf8d302a9276ead67ede50f2d022af7e2661af9ffc57a9c50fbabb07a4b334d83056f

data/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## HCloud v2.2.0 (2024-08-22)
+
+- Add support for (de-)compression of HTTP requests
+
 ## HCloud v2.1.0 (2024-07-28)
 
 - Add `included_traffic` attribute to `ServerType#prices` and `LoadBalancerType#prices`

data/Gemfile

@@ -5,7 +5,12 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in hcloud.gemspec
 gemspec
 
+group :development do
+  gem "yard", require: false
+end
+
 group :development, :test do
+  gem "brotli"
   gem "debug", require: false
   gem "dotenv", require: false
   gem "ffaker", require: false

data/README.md

@@ -143,6 +143,22 @@ ssh_keys = HCloud::SSHKey.all # Will block until remaining requests have regener
 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.
 
+### Compression
+
+Enable compression by passing an appropriate `compression` option to `HCloud::Client.new`.
+Current supported options are `nil`, `"gzip"`, and `"brotli"`.
+Compression is disabled by default.
+
+```ruby
+client = HCloud::Client.new(access_token: "my_access_token", compression: "gzip")
+```
+
+To use Brotli compression, you need to install the `brotli` gem (at least version 0.3.0):
+
+```ruby
+gem "brotli"
+```
+
 ## Testing
 
 ```ssh

data/config/inflections.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 HCloud.loader.inflector.inflect(
+  "block_io" => "BlockIO",
   "dns_pointer" => "DNSPointer",
   "floating_ip" => "FloatingIP",
   "floating_ip_price" => "FloatingIPPrice",

data/lib/core_ext/send_wrap.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+# @!visibility private
 module CoreExt
+  # @!visibility private
   module SendWrap
     # Send a message to self, or all objects contained in self (for arrays)
 

data/lib/hcloud/action_collection.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   class ActionCollection < Collection
     attr_reader :resource
 

data/lib/hcloud/client.rb

@@ -3,6 +3,7 @@
 require "logger"
 
 module HCloud
+  # @!visibility private
   class NilConnection
     def raise_error(...)
       raise ArgumentError, "no default client configured, set HCloud::Client.connection to an instance of HCloud::Client"
@@ -14,18 +15,21 @@ module HCloud
     alias delete raise_error
   end
 
+  # @!visibility private
   class Client
     class_attribute :connection
 
     self.connection = NilConnection.new
 
-    attr_reader :access_token, :endpoint, :logger, :rate_limit
+    attr_reader :access_token, :endpoint, :logger, :rate_limit, :timeout, :compression
 
-    def initialize(access_token:, endpoint: "https://api.hetzner.cloud/v1", logger: Logger.new("/dev/null"), rate_limit: false)
+    def initialize(access_token:, endpoint: "https://api.hetzner.cloud/v1", logger: Logger.new("/dev/null"), rate_limit: false, timeout: 10, compression: nil)
       @access_token = access_token
       @endpoint = endpoint
       @logger = logger
       @rate_limit = rate_limit
+      @timeout = timeout
+      @compression = compression
     end
 
     delegate :get, :put, :post, :delete, to: :http
@@ -33,7 +37,7 @@ module HCloud
     private
 
     def http
-      @http ||= HTTP.new(access_token, endpoint, logger, rate_limit)
+      @http ||= HTTP.new(access_token, endpoint, logger, rate_limit, timeout, compression)
     end
   end
 end

data/lib/hcloud/collection.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   class Collection
     include Enumerable
 

data/lib/hcloud/concerns/actionable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Actionable
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/concerns.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Concerns
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/creatable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Creatable
     extend ActiveSupport::Concern
 
@@ -25,7 +26,7 @@ module HCloud
       end
 
       # Convert creatable_attributes into a key-value list
-      # rubocop:disable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      # rubocop:disable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
       def creatable_params
         # Split simple and nested attributes
         nested_attributes, simple_attributes = creatable_attributes.partition { |a| a.respond_to? :each }
@@ -36,7 +37,7 @@ module HCloud
           .merge(nested_attributes.reduce(&:merge).to_h { |k, v| [k.to_s, Array(v).filter_map { |w| send(k)&.send_wrap(w) }.first] })
           .compact_blank
       end
-      # rubocop:enable Metrics/AbcSize,Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
+      # rubocop:enable Metrics/CyclomaticComplexity,Metrics/PerceivedComplexity
     end
 
     class_methods do

data/lib/hcloud/concerns/deletable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Deletable
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/dynamic_attributes.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module DynamicAttributes
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/labelable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Labelable
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/meterable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Meterable
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/queryable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Queryable
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/singleton.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Singleton
     extend ActiveSupport::Concern
 

data/lib/hcloud/concerns/updatable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Updatable
     extend ActiveSupport::Concern
 

data/lib/hcloud/entity.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   class Entity
     include ActiveModel::Attributes
     include ActiveModel::AttributeAssignment

data/lib/hcloud/http.rb

@@ -3,15 +3,25 @@
 require "http"
 
 module HCloud
+  # @!visibility private
   class HTTP
-    attr_reader :access_token, :endpoint, :logger, :rate_limit, :timeout
+    # Supported compression algorithms
+    COMPRESSION_ALGORITHMS = [
+      "gzip",
+      "brotli",
+    ].freeze
+
+    attr_reader :access_token, :endpoint, :logger, :rate_limit, :timeout, :compression
+
+    def initialize(access_token, endpoint, logger, rate_limit = false, timeout = 10, compression = nil)
+      raise ArgumentError, "invalid compression algorithm: #{compression}" if compression && !COMPRESSION_ALGORITHMS.include?(compression)
 
-    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
+      @compression = compression
     end
 
     def get(path, params = {})
@@ -78,10 +88,12 @@ module HCloud
 
     def http
       @http ||= ::HTTP
-        .headers(accept: "application/json", user_agent: "#{HCloud::NAME}/#{HCloud::VERSION}")
+        .headers(user_agent: "#{HCloud::NAME}/#{HCloud::VERSION}")
+        .accept("application/json")
         .timeout(timeout)
-        .use(logging: { logger: logger })
         .then { |h| rate_limit ? h.use(:rate_limiter) : h }
+        .then { |h| compression ? h.use(compression: { method: compression }) : h }
+        .use(logging: { logger: logger })
         .encoding("utf-8")
         .auth("Bearer #{access_token}")
     end

data/lib/hcloud/resource_type.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
-# rubocop:disable Metrics/CyclomaticComplexity,Metrics/AbcSize
+# rubocop:disable Metrics/CyclomaticComplexity
 module HCloud
+  # @!visibility private
   class ResourceType
     class_attribute :resource_class_name
 
@@ -54,6 +55,7 @@ module HCloud
     end
     # rubocop:enable Naming/MethodName
 
+    # @!visibility private
     class GenericType < ResourceType
       def cast(value)
         case value
@@ -78,7 +80,7 @@ module HCloud
     end
   end
 end
-# rubocop:enable Metrics/CyclomaticComplexity,Metrics/AbcSize
+# rubocop:enable Metrics/CyclomaticComplexity
 
 ActiveModel::Type.register(:action, HCloud::ResourceType.Type("HCloud::Action"))
 ActiveModel::Type.register(:algorithm, HCloud::ResourceType.Type("HCloud::Algorithm"))

data/lib/hcloud/version.rb

@@ -1,9 +1,10 @@
 # frozen_string_literal: true
 
 module HCloud
+  # @!visibility private
   module Version
     MAJOR = 2
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
     PRE   = nil
 

data/lib/http/features/block_io.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# @!visibility private
+module HTTP
+  # @!visibility private
+  module Features
+    # @!visibility private
+    class BlockIO
+      def initialize(block)
+        @block = block
+      end
+
+      def write(data)
+        @block.call(data)
+      end
+    end
+  end
+end

data/lib/http/features/compression.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# @!visibility private
+module HTTP
+  # @!visibility private
+  module Features
+    # @!visibility private
+    class Compression < Feature
+      SUPPORTED_ENCODING = {
+        "gzip" => "gzip",
+        "brotli" => "br",
+      }.freeze
+
+      HTTP::Options.register_feature(:compression, self)
+
+      attr_reader :method
+
+      def initialize(**)
+        super
+
+        @method = @opts.fetch(:method, "gzip").to_s || "gzip"
+
+        raise Error, "Only gzip and brotli methods are supported" unless SUPPORTED_ENCODING.key?(method)
+      end
+
+      def wrap_request(request)
+        return request unless method
+
+        # Set Accept-Encoding header
+        request.headers[Headers::ACCEPT_ENCODING] = SUPPORTED_ENCODING[method]
+
+        return request if request.body.size.zero? # rubocop:disable Style/ZeroLengthPredicate
+
+        # Delete Content-Length header, it is set automatically by HTTP::Request::Writer
+        request.headers.delete(Headers::CONTENT_LENGTH)
+
+        # Set Content-Encoding header
+        request.headers[Headers::CONTENT_ENCODING] = SUPPORTED_ENCODING[method]
+
+        HTTP::Request.new(
+          version: request.version,
+          verb: request.verb,
+          uri: request.uri,
+          headers: request.headers,
+          proxy: request.proxy,
+          body: compress(request.body),
+          uri_normalizer: request.uri_normalizer,
+        )
+      end
+
+      def wrap_response(response)
+        return response unless SUPPORTED_ENCODING.value?(response.headers.get(Headers::CONTENT_ENCODING).first)
+
+        HTTP::Response.new(
+          status: response.status,
+          version: response.version,
+          headers: response.headers,
+          proxy_headers: response.proxy_headers,
+          connection: response.connection,
+          body: decompress(response.connection),
+          request: response.request,
+        )
+      end
+
+      private
+
+      def compress(body)
+        case method
+        when "gzip"
+          Request::GzippedBody.new(body)
+        when "brotli"
+          Request::BrotliBody.new(body)
+        end
+      end
+
+      def decompress(connection)
+        case method
+        when "gzip"
+          HTTP::Response::Body.new(Response::GzipInflater.new(connection))
+        when "brotli"
+          HTTP::Response::Body.new(Response::BrotliInflater.new(connection))
+        end
+      end
+    end
+  end
+end

data/lib/http/features/request/brotli_body.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+begin
+  require "brotli"
+
+  version = Brotli::VERSION.split(".").map(&:to_i)
+  raise ArgumentError, "incompatible version of brotli: #{Brotli::VERSION}, needs to be at least 0.3.0" unless (version[0]).positive? || version[1] >= 3
+rescue LoadError
+  # Ignore
+end
+
+# @!visibility private
+module HTTP
+  # @!visibility private
+  module Features
+    # @!visibility private
+    module Request
+      # @!visibility private
+      class BrotliBody < CompressedBody
+        def compress(&block)
+          brotli = Brotli::Writer.new(BlockIO.new(block))
+          @body.each { |chunk| brotli.write(chunk) }
+        ensure
+          brotli.finish
+        end
+      end
+    end
+  end
+end

data/lib/http/features/request/compressed_body.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+# @!visibility private
+module HTTP
+  # @!visibility private
+  module Features
+    # @!visibility private
+    module Request
+      # @!visibility private
+      class CompressedBody < HTTP::Request::Body
+        def initialize(uncompressed_body) # rubocop:disable Lint/MissingSuper
+          @body = uncompressed_body
+          @compressed = nil
+        end
+
+        def size
+          compress_all! unless @compressed
+          @compressed.size
+        end
+
+        def each(&block)
+          return to_enum __method__ unless block
+
+          if @compressed
+            compressed_each(&block)
+          else
+            compress(&block)
+          end
+
+          self
+        end
+
+        def compress(&_block)
+          raise NotImplementedError
+        end
+
+        private
+
+        def compressed_each
+          while (data = @compressed.read(Connection::BUFFER_SIZE))
+            yield data
+          end
+        ensure
+          @compressed.close!
+        end
+
+        def compress_all!
+          @compressed = Tempfile.new("http-compressed_body", binmode: true)
+          compress { |data| @compressed.write(data) }
+          @compressed.rewind
+        end
+      end
+    end
+  end
+end

data/lib/http/features/request/gzipped_body.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+# @!visibility private
+module HTTP
+  # @!visibility private
+  module Features
+    # @!visibility private
+    module Request
+      # @!visibility private
+      class GzippedBody < CompressedBody
+        def compress(&block)
+          gzip = Zlib::GzipWriter.new(BlockIO.new(block))
+          @body.each { |chunk| gzip.write(chunk) }
+        ensure
+          gzip.finish
+        end
+      end
+    end
+  end
+end

data/lib/http/features/response/brotli_inflater.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+begin
+  require "brotli"
+
+  version = Brotli::VERSION.split(".").map(&:to_i)
+  raise ArgumentError, "incompatible version of brotli: #{Brotli::VERSION}, needs to be at least 0.3.0" unless (version[0]).positive? || version[1] >= 3
+rescue LoadError
+  # Ignore
+end
+
+# @!visibility private
+module HTTP
+  # @!visibility private
+  module Features
+    # @!visibility private
+    module Response
+      # @!visibility private
+      class BrotliInflater < HTTP::Response::Inflater
+        def readpartial(*args)
+          chunks = []
+
+          while (chunk = @connection.readpartial(*args))
+            chunks << chunk
+          end
+
+          return if chunks.empty?
+
+          Brotli.inflate(chunks.join)
+        end
+      end
+    end
+  end
+end

data/lib/http/features/response/gzip_inflater.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "zlib"
+
+# @!visibility private
+module HTTP
+  # @!visibility private
+  module Features
+    # @!visibility private
+    module Response
+      # @!visibility private
+      class GzipInflater < HTTP::Response::Inflater
+      end
+    end
+  end
+end

data/lib/http/mime_type/yaml.rb

@@ -2,8 +2,11 @@
 
 require "yaml"
 
+# @!visibility private
 module HTTP
+  # @!visibility private
   module MimeType
+    # @!visibility private
     class YAML < Adapter
       def encode(obj)
         return obj.to_yaml if obj.respond_to?(:to_yaml)

data/lib/http/rate_limiter.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+# @!visibility private
 module HTTP
+  # @!visibility private
   class RateLimiter < Feature
     attr_reader :limit, :remaining, :reset, :at, :rate
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hetznercloud
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - Florian Dejonckheere
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-07-28 00:00:00.000000000 Z
+date: 2024-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -163,6 +163,13 @@ files:
 - lib/hcloud/resources/ssh_key.rb
 - lib/hcloud/resources/volume.rb
 - lib/hcloud/version.rb
+- lib/http/features/block_io.rb
+- lib/http/features/compression.rb
+- lib/http/features/request/brotli_body.rb
+- lib/http/features/request/compressed_body.rb
+- lib/http/features/request/gzipped_body.rb
+- lib/http/features/response/brotli_inflater.rb
+- lib/http/features/response/gzip_inflater.rb
 - lib/http/mime_type/yaml.rb
 - lib/http/rate_limiter.rb
 homepage: https://github.com/floriandejonckheere/hcloud