hetzner_dns 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f3de9b6eca1aee08bf8664fec0eaa99eff6a6004f49cc60ba271602231b01f7
+  data.tar.gz: 75ca7176c3a9197993e37fb4658c696763337838f65dd34df748bc1946de37d0
+SHA512:
+  metadata.gz: 4acd038b83002c03d1dbec9f3dbc2951a176aac943962a4aa25fa00f264f39ced2be446caadaaea3f77bb48a4be2d1f4f1bedf90c4eee241dc13db59a5522123
+  data.tar.gz: ae8c660e4262b0a0b38e2d07a2b9ff6c8dcb2bc80cdeb267c272c22ca00c598c7c4654ccb44e7c3fa53357be46d9a5a98eaba24aaae3cdd03d4bfab5a77d354a

data/.env.example

@@ -0,0 +1 @@
+HETZNER_DNS_TOKEN=

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+buy_me_a_coffee: deanpcmad

data/.github/workflows/ci.yml

@@ -0,0 +1,22 @@
+name: CI
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version:
+          - 3.1
+          - 3.2
+          - 3.3
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby_version }}
+          bundler: default
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in twitch.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"
+gem "dotenv"
+
+gem "vcr"

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    hetzner_dns (0.1.0)
+      faraday (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    dotenv (2.7.6)
+    faraday (2.9.0)
+      faraday-net_http (>= 2.0, < 3.2)
+    faraday-net_http (3.1.0)
+      net-http
+    minitest (5.15.0)
+    net-http (0.4.1)
+      uri
+    rake (12.3.3)
+    uri (0.13.0)
+    vcr (6.2.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  dotenv
+  hetzner_dns!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+  vcr
+
+BUNDLED WITH
+   2.5.7

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Dean Perry
+
+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,43 @@
+# HetznerDNS
+
+HetznerDNS is a Ruby library for the Hetzner DNS API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "hetzner_dns"
+```
+
+## Usage
+
+### Set Client Details
+
+Firstly you'll need to create an API Token on [Hetzner DNS](https://dns.hetzner.com/settings/api-token) site
+and then configure it like below.
+
+```ruby
+HetznerDNS.configure do |config|
+  config.api_token = ENV["HETZNER_DNS_TOKEN"]
+end
+```
+
+### Zones
+
+```ruby
+# Retrieve a list of Zone's
+HetznerDNS::Zone.list
+
+# Create a zone
+# TTL is optional
+HetznerDNS::Zone.create(name: "mydomain.com", ttl: 86400)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/deanpcmad/hetzner_dns.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "hetzner_dns"
+
+# Load environment variables from .env file
+require 'dotenv/load'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+HetznerDNS.configure do |config|
+  config.api_token = ENV["HETZNER_DNS_TOKEN"]
+end
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/hetzner_dns.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/hetzner_dns/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hetzner_dns"
+  spec.version       = HetznerDNS::VERSION
+  spec.authors       = ["Dean Perry"]
+  spec.email         = ["dean@deanpcmad.com"]
+
+  spec.summary       = "A Ruby library for the HetznerDNS API"
+  spec.homepage      = "https://deanpcmad.com"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/deanpcmad/hetzner_dns"
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "faraday", "~> 2.0"
+end

data/lib/hetzner_dns/client.rb

@@ -0,0 +1,72 @@
+module HetznerDNS
+  class Client
+
+    BASE_URL = "https://dns.hetzner.com/api/v1"
+
+    class << self
+
+      def connection
+        @connection ||= Faraday.new(BASE_URL) do |conn|
+          conn.headers = {
+            "Auth-API-Token" => HetznerDNS.config.api_token,
+            "User-Agent" => "hetzner_dns/v#{VERSION} (github.com/deanpcmad/hetzner_dns)"
+          }
+
+          conn.request :json
+
+          conn.response :json, content_type: "application/json"
+        end
+      end
+
+      def get_request(url, params: {}, headers: {})
+        handle_response connection.get(url, params, headers)
+      end
+
+      def post_request(url, body: {}, headers: {})
+        handle_response connection.post(url, body, headers)
+      end
+
+      def put_request(url, body:, headers: {})
+        handle_response connection.put(url, body, headers)
+      end
+
+      def patch_request(url, body:, headers: {})
+        handle_response connection.patch(url, body, headers)
+      end
+
+      def delete_request(url, headers: {})
+        handle_response connection.delete(url, headers)
+      end
+
+      def handle_response(response)
+        case response.status
+        when 400
+          raise Error, "Error 400: Your request was malformed. '#{response.body["message"]}'"
+        when 401
+          raise Error, "Error 401: You did not supply valid authentication credentials. '#{response.body["message"]}'"
+        when 403
+          raise Error, "Error 403: You are not allowed to perform that action. '#{response.body["message"]}'"
+        when 404
+          raise Error, "Error 404: No results were found for your request. '#{response.body["message"]}'"
+        when 409
+          raise Error, "Error 409: Your request was a conflict. '#{response.body["message"]}'"
+        when 422
+          raise Error, "Error 422: Unprocessable Content. '#{response.body["message"]}'"
+        when 429
+          raise Error, "Error 429: Your request exceeded the API rate limit. '#{response.body["message"]}'"
+        when 500
+          raise Error, "Error 500: We were unable to perform the request due to server-side problems. '#{response.body["message"]}'"
+        when 503
+          raise Error, "Error 503: You have been rate limited for sending more than 20 requests per second. '#{response.body["message"]}'"
+        when 501
+          raise Error, "Error 501: This resource has not been implemented. '#{response.body["message"]}'"
+        when 204
+          return true
+        end
+
+        response
+      end
+    end
+
+  end
+end

data/lib/hetzner_dns/collection.rb

@@ -0,0 +1,25 @@
+module HetznerDNS
+  class Collection
+    attr_reader :data, :total
+
+    def self.from_response(response, type:, key: nil)
+      body = response.body
+
+      if key.is_a?(String)
+        data = body[key].map { |attrs| type.new(attrs) }
+      else
+        data = body.map { |attrs| type.new(attrs) }
+      end
+
+      new(
+        data: data,
+        total: body.count
+      )
+    end
+
+    def initialize(data:, total:)
+      @data = data
+      @total = total
+    end
+  end
+end

data/lib/hetzner_dns/configuration.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module HetznerDNS
+  class Configuration
+
+    attr_accessor :api_token
+
+  end
+end

data/lib/hetzner_dns/error.rb

@@ -0,0 +1,4 @@
+module HetznerDNS
+  class Error < StandardError
+  end
+end

data/lib/hetzner_dns/models/zone.rb

@@ -0,0 +1,19 @@
+module HetznerDNS
+  class Zone < Object
+
+    class << self
+
+      def list
+        response = Client.get_request("zones")
+        Collection.from_response(response, type: Zone, key: "zones")
+      end
+
+      def create(name:, ttl: nil)
+        response = Client.post_request("zones", body: { name: name, ttl: ttl })
+        Zone.new(response.body)
+      end
+
+    end
+
+  end
+end

data/lib/hetzner_dns/object.rb

@@ -0,0 +1,19 @@
+require "ostruct"
+
+module HetznerDNS
+  class Object < OpenStruct
+    def initialize(attributes)
+      super to_ostruct(attributes)
+    end
+
+    def to_ostruct(obj)
+      if obj.is_a?(Hash)
+        OpenStruct.new(obj.map { |key, val| [key, to_ostruct(val)] }.to_h)
+      elsif obj.is_a?(Array)
+        obj.map { |o| to_ostruct(o) }
+      else # Assumed to be a primitive value
+        obj
+      end
+    end
+  end
+end

data/lib/hetzner_dns/version.rb

@@ -0,0 +1,3 @@
+module HetznerDNS
+  VERSION = "0.1.0"
+end

data/lib/hetzner_dns.rb

@@ -0,0 +1,27 @@
+require "faraday"
+
+require_relative "hetzner_dns/version"
+
+module HetznerDNS
+
+  autoload :Configuration, "hetzner_dns/configuration"
+  autoload :Client, "hetzner_dns/client"
+  autoload :Collection, "hetzner_dns/collection"
+  autoload :Error, "hetzner_dns/error"
+  autoload :Object, "hetzner_dns/object"
+
+  class << self
+    attr_writer :config
+  end
+
+  def self.configure
+    yield(config) if block_given?
+  end
+
+  def self.config
+    @config ||= HetznerDNS::Configuration.new
+  end
+
+  autoload :Zone, "hetzner_dns/models/zone"
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: hetzner_dns
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dean Perry
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description:
+email:
+- dean@deanpcmad.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".github/FUNDING.yml"
+- ".github/workflows/ci.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- hetzner_dns.gemspec
+- lib/hetzner_dns.rb
+- lib/hetzner_dns/client.rb
+- lib/hetzner_dns/collection.rb
+- lib/hetzner_dns/configuration.rb
+- lib/hetzner_dns/error.rb
+- lib/hetzner_dns/models/zone.rb
+- lib/hetzner_dns/object.rb
+- lib/hetzner_dns/version.rb
+homepage: https://deanpcmad.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://deanpcmad.com
+  source_code_uri: https://github.com/deanpcmad/hetzner_dns
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: A Ruby library for the HetznerDNS API
+test_files: []