pdns-client 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 100b3241c08e1c760231a4a2bfb746ae01edefbe7702c2a89c74ef543cf23ee8
+  data.tar.gz: 2b7babd54f1696f95eea60aa54b48a484dbdead5b02b8ab6723b06a5191bd2cf
+SHA512:
+  metadata.gz: be825ef227acd339f702b271e09785eee5fb7c8e040cb708800711cb9ddea00f72f2d111120df1f87a9cbd1666dcca3f7c3f9b4bf2cd80d5ccf2d1e70caf6df2
+  data.tar.gz: f97e28a07bc5057a5d4d94a8b78aafa807c8d96b71f2215f582e08e02a763f6854b3672dabb7fbaf16e9f6bd143fb209acc38f358d2614fc97229200c2e811e6

data/.dockerignore

@@ -0,0 +1 @@
+/Gemfile.lock

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/Gemfile.lock
+/docker-compose.override.yml

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/Dockerfile

@@ -0,0 +1,15 @@
+FROM ruby:2.5
+
+RUN mkdir /usr/src/app
+
+WORKDIR /usr/local/src
+
+ADD docker/docker-entrypoint.sh /
+ADD Gemfile pdns-client.gemspec ./
+ADD lib/pdns/client/version.rb ./lib/pdns/client/version.rb
+RUN bundle install --jobs=3 --retry=3
+ADD . ./
+
+ENTRYPOINT [ "/docker-entrypoint.sh" ]
+
+CMD bundle exec rspec --force-color -fd spec

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in pdns-client.gemspec
+gemspec

data/README.md

@@ -0,0 +1,59 @@
+# Pdns::Client
+
+This is a very thin wrapper over the PowerDNS REST API, providing just enough for OPF.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'pdns-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install pdns-client
+
+## Usage
+
+Example:
+
+```
+pdns = Pdns::Client.new(url: ENV.fetch("PDNS_SERVER_ROOT"), token: ENV.fetch("PDNS_SERVER_TOKEN"))
+pdns.upsert_record("example.com", "www", "A", "172.16.0.1", 60)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+To run the tests in an isolated docker-compose graph:
+
+```
+docker-compose down --volumes --remove-orphans && \
+  docker-compose build test && \
+  docker-compose run test
+```
+
+To bring the PowerDNS REST API up on a local host port to run tests against it:
+
+```
+# Terminal 1
+ln -s docker-compose.local.yml docker-compose.override.yml
+docker-compose up pdns
+
+# Terminal 2
+export PDNS_SERVER_TOKEN=secret
+export PDNS_SERVER_ROOT=http://localhost:8081/
+bundle exec rspec -fd spec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/webnifico/pdns-client.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "pdns-client"
+
+# 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
+
+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/docker-compose.local.yml

@@ -0,0 +1,11 @@
+version: '2.1'
+
+services:
+  test:
+    volumes:
+      - .:/usr/local/src
+  pdns:
+    ports:
+      - 53
+      - "53/udp"
+      - "8081:8081"

data/docker-compose.yml

@@ -0,0 +1,31 @@
+version: '2.1'
+
+services:
+  test:
+    build:
+      context: .
+    environment:
+      PDNS_SERVER_TOKEN: secret
+      PDNS_SERVER_ROOT: http://pdns:8081/
+    links:
+      - pdns
+  pdns:
+    image: psitrax/powerdns:4.1.0
+    restart: always
+    environment:
+     - MYSQL_HOST=db
+     - MYSQL_USER=root
+     - MYSQL_PASS=secret
+    volumes:
+      - ./docker/pdns.api.conf:/etc/pdns/conf.d/api.conf
+    depends_on:
+     - db
+    ports:
+      - 53
+      - "53/udp"
+      - 8080
+      - 8081
+  db:
+    image: mariadb:10.1
+    environment:
+     - MYSQL_ROOT_PASSWORD=secret

data/docker/docker-entrypoint.sh

@@ -0,0 +1,15 @@
+#!/bin/bash
+
+waitfor() {
+  host=$1
+  port=$2
+
+  while ! echo > /dev/tcp/$host/$port; do
+    echo Waiting for tcp://$host:$port... 1>&2
+    sleep 1
+  done 2>/dev/null
+}
+
+waitfor pdns 8081
+
+exec "$@"

data/docker/pdns.api.conf

@@ -0,0 +1,8 @@
+local-address=0.0.0.0
+webserver=yes
+webserver-password=unused
+webserver-address=0.0.0.0
+webserver-allow-from=0.0.0.0/0
+api=yes
+api-key=secret
+api-logfile=/var/log/pdns.log

data/lib/pdns-client.rb

@@ -0,0 +1,2 @@
+require "pdns"
+require "pdns/client"

data/lib/pdns.rb

@@ -0,0 +1,2 @@
+module Pdns
+end

data/lib/pdns/client.rb

@@ -0,0 +1,117 @@
+require "pdns/client/error"
+require "http"
+
+module Pdns
+
+  class Client
+
+    def initialize(url:, token:, http: HTTP)
+      @url = url
+      @http = http
+      @token = token
+    end
+
+    def delete_record(zone_name, lvalue, type)
+      unwrap {
+        http.patch(@url + "api/v1/servers/localhost/zones/#{zone_name}", json: {
+          "rrsets": [
+            {
+              "name": "#{lvalue}.#{zone_name}.",
+              "type": type,
+              "changetype": "DELETE",
+              "records": [],
+            }
+          ]
+        })
+      }
+    end
+
+    # Only for testing
+    def create_zone(zone_name, nameserver_addresses)
+      unwrap {
+        http.post(@url + "api/v1/servers/localhost/zones", json: {
+          "kind": "Native",
+          "masters": [],
+          "id": "#{zone_name}",
+          "name": "#{zone_name}.",
+          "nameservers": nameserver_addresses,
+          "records": [
+              {
+                "content": "ns.#{zone_name}. hostmaster.#{zone_name}. 1 1800 900 604800 86400",
+                  "disabled": false,
+                  "name": "#{zone_name}.",
+                  "ttl": 86400,
+                  "type": "SOA"
+              },
+          ]
+        })
+      }
+    end
+
+    # Only for testing
+    def delete_zone(zone_name)
+      unwrap { http.delete(@url + "api/v1/servers/localhost/zones/#{zone_name}") }
+    end
+
+    # Only for testing
+    def get_zone(zone_name)
+      native = unwrap { http.get(@url + "api/v1/servers/localhost/zones/#{zone_name}") }
+
+      dapi_compatible = native["rrsets"].map { |rrset|
+        rrset["records"].map { |record|
+          {
+            "type" => rrset["type"],
+            "name" => rrset["name"].chomp(".#{zone_name}."),
+            "value" => record["content"],
+          }
+        }
+      }.flatten
+      {"records" => dapi_compatible}
+    end
+
+    def upsert_record(zone_name, lvalue, type, rvalue, ttl = 60)
+      unwrap {
+        http.patch(@url + "api/v1/servers/localhost/zones/#{zone_name}", json: {
+          "rrsets": [
+            {
+              "name": "#{lvalue}.#{zone_name}.",
+              "type": type,
+              "ttl": ttl,
+              "changetype": "REPLACE",
+              "records": [
+                {
+                  "content": rvalue,
+                  "disabled": false,
+                  "name": "#{lvalue}.#{zone_name}.",
+                  "type": type,
+                  "priority": 0
+                }
+              ]
+            }
+          ]
+        })
+      }
+    end
+
+    private
+
+    def http
+      @http.headers("X-API-Key" => @token)
+    end
+
+    def unwrap(&block)
+      res = block.call
+      if [200, 201].include?(res.status)
+        JSON.parse(res.body)
+      elsif res.status == 204
+        {}
+      else
+        raise Pdns::Client::Error, "PowerDNS error: #{JSON.parse(res.body)["error"]}"
+      end
+    rescue JSON::ParserError
+      raise Pdns::Client::Error, "error parsing PowerDNS HTTP #{res.status} response (JSON)"
+    end
+
+  end
+
+end

data/lib/pdns/client/error.rb

@@ -0,0 +1,13 @@
+module Pdns
+
+  class Client
+
+    class Error < RuntimeError
+    end
+
+    class OptimisticLockFailure < Error
+    end
+
+  end
+
+end

data/lib/pdns/client/version.rb

@@ -0,0 +1,5 @@
+module Pdns
+  class Client
+    VERSION = "0.1.0"
+  end
+end

data/pdns-client.gemspec

@@ -0,0 +1,28 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "pdns/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "pdns-client"
+  spec.version       = Pdns::Client::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{DNS API Client}
+  spec.description   = %q{Client for PowerDNS REST API.}
+  spec.homepage      = "https://github.com/webnifico/opf-manifold"
+
+  # 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 "http", "~> 4.1"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: pdns-client
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-03-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+description: Client for PowerDNS REST API.
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rspec"
+- Dockerfile
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.local.yml
+- docker-compose.yml
+- docker/docker-entrypoint.sh
+- docker/pdns.api.conf
+- lib/pdns-client.rb
+- lib/pdns.rb
+- lib/pdns/client.rb
+- lib/pdns/client/error.rb
+- lib/pdns/client/version.rb
+- pdns-client.gemspec
+homepage: https://github.com/webnifico/opf-manifold
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: DNS API Client
+test_files: []