pdns_api 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e775769016b6af7782ddfa3baec55322b779ef01
+  data.tar.gz: a782baf51327ab968e84dfb96d1460caf2623df1
+SHA512:
+  metadata.gz: e58156e4d03ee86e35cded0a95b35b6210d0c6af8294fc6618aaa818cf4cbe04df7b5e606aa2c9d0ba8b732c8a4e578d8adfc1ca1e1ed68ee563aae962c25696
+  data.tar.gz: ddc4ba236a91245518f8bb751a62efdcaf3912167435b5da82b63d0c0ccc5fbe80b87d84d380219807d429fa95bc40102efee8d9024c6a8d76eb23b974ebb507

data/lib/pdns_api/api.rb

@@ -0,0 +1,55 @@
+require 'pdns_api/http'
+
+# PDNS API interface
+module PDNS
+  # Class for interacting with the API
+  class API
+    def initialize(args)
+      @version = args.key?(:version) ? args[:version] : 1
+      @http    = PDNS::HTTP.new(args)
+      @url     = @http.uri
+      @r_url   = @url
+      @info    = {}
+    end
+
+    ## Standard manipulation methods
+
+    # Get information for this object
+    def get
+      @info = @http.get @url
+    end
+
+    # Delete this object
+    def delete
+      @http.delete @url
+    end
+
+    # Create this object on the server
+    def create(info = nil)
+      info(info)
+      @http.post(@r_url, @info)
+    end
+
+    # Get/set info
+    def info(info = nil)
+      return @info if info.nil?
+
+      @info.merge!(info)
+    end
+
+    ## Helper methods
+
+    def ensure_array(item)
+      return item if item.is_a? Array
+      [item]
+    end
+
+    def self.hash_sym_to_string(hash)
+      hash.map { |symbol, value| [symbol.to_s, value] }.to_h
+    end
+
+    def self.hash_string_to_sym(hash)
+      hash.map { |string, value| [string.to_sym, value] }.to_h
+    end
+  end
+end

data/lib/pdns_api/client.rb

@@ -0,0 +1,22 @@
+require 'pdns_api/version'
+require 'pdns_api/api'
+require 'pdns_api/server'
+
+# PDNS client
+module PDNS
+  # Client
+  class Client < API
+    attr_reader :version
+
+    ## Main methods
+    def servers(id = nil)
+      return Server.new(@http, @url, id) unless id.nil?
+
+      # Return a hash of server objects
+      servers = @http.get "#{@url}/servers"
+      servers.map! { |s| [s[:id], Server.new(@url, s[:id], s)] }.to_h
+    end
+
+    alias server servers
+  end
+end

data/lib/pdns_api/config.rb

@@ -0,0 +1,35 @@
+# PDNS Server config
+module PDNS
+  # Server config
+  class Config < API
+    attr_accessor :name, :value
+
+    def initialize(http, t_url, name, value = nil)
+      @http  = http
+      @name  = name
+      @r_url = "#{t_url}/config"
+      @url   = "#{t_url}/config/#{name}"
+      @value = value.get if value.nil?
+      value(value)
+    end
+
+    ## Simple interfaces to metadata
+    # Get/set config value
+    def value(value = nil)
+      return @info[:value] if value.nil?
+      @info = { type: 'ConfigSetting', namen: @name, value: value }
+    end
+
+    # Get configuration value
+    def get
+      res = @http.get(@url)
+      return value if res.key? :value
+    end
+
+    # Change configuration
+    def change(value = nil)
+      value(value)
+      @http.put(@url, @info)
+    end
+  end
+end

data/lib/pdns_api/cryptokey.rb

@@ -0,0 +1,20 @@
+# PDNS Zone CryptoKeys
+module PDNS
+  # Zone CryptoKey
+  class CryptoKey < API
+    def initialize(http, t_url, id, info = {})
+      @http  = http
+      @id    = id
+      @info  = info
+      @r_url = "#{t_url}/metadata"
+      @url   = "#{t_url}/metadata/#{kind}"
+    end
+
+    ## Simple interfaces to metadata
+
+    # Change cryptokey information
+    def change(rrsets)
+      @http.put(@url, rrsets)
+    end
+  end
+end

data/lib/pdns_api/http.rb

@@ -0,0 +1,89 @@
+# PDNS HTTP API interface
+module PDNS
+  # Class for doing HTTP requests
+  class HTTP
+    attr_accessor :headers
+
+    def initialize(args)
+      @host    = args[:host]
+      @key     = args[:key]
+      @port    = args.key?(:port)    ? args[:port]    : 8081
+      @version = args.key?(:version) ? args[:version] : 1
+      @headers = { 'X-API-Key' => @key }
+    end
+
+    def uri(request = '')
+      base = ''
+      base = "/api/v#{@version}" unless @version == 0 || request[0..4] == '/api/'
+      base + request
+    end
+
+    # Create the right method object
+    def http_method(method, uri)
+      # Create the right request
+      case method
+      when 'GET'    then Net::HTTP::Get.new(uri, @headers)
+      when 'PATCH'  then Net::HTTP::Patch.new(uri, @headers)
+      when 'POST'   then Net::HTTP::Post.new(uri, @headers)
+      when 'PUT'    then Net::HTTP::Put.new(uri, @headers)
+      when 'DELETE' then Net::HTTP::Delete.new(uri, @headers)
+      else               abort('Unknown method: ' + method)
+      end
+    end
+
+    def response_decode(response)
+      return {} if response.body.nil?
+
+      # Parse and return JSON
+      begin
+        JSON.parse(response.body, symbolize_names: true)
+      rescue JSON::ParserError
+        { error: 'Non-JSON response', result: response.body }
+      end
+    end
+
+    # Do an HTTP request
+    def http(method, request, body = nil)
+      # Start an HTTP connection
+      begin
+        response = Net::HTTP.start(@host, @port) do |http|
+          # Create uri & request
+          uri = uri(request)
+          req = http_method(method, uri)
+
+          # Do the request
+          http.request(req, body.to_json)
+        end
+      rescue StandardError, Timeout::Error => e
+        abort("Error: #{e}")
+      end
+
+      response_decode(response)
+    end
+
+    # Do a DELETE request
+    def delete(uri)
+      http('DELETE', uri)
+    end
+
+    # Do a GET request
+    def get(uri)
+      http('GET', uri)
+    end
+
+    # Do a PATCH request
+    def patch(uri, body = nil)
+      http('PATCH', uri, body)
+    end
+
+    # Do a POST request
+    def post(uri, body = nil)
+      http('POST', uri, body)
+    end
+
+    # Do a PUT request
+    def put(uri, body = nil)
+      http('PUT', uri, body)
+    end
+  end
+end

data/lib/pdns_api/metadata.rb

@@ -0,0 +1,38 @@
+# PDNS Zone Metadata
+module PDNS
+  # Zone Metadata
+  class Metadata < API
+    def initialize(http, t_url, kind, info = {})
+      @http  = http
+      @kind  = kind
+      @info  = info
+      @r_url = "#{t_url}/metadata"
+      @url   = "#{t_url}/metadata/#{kind}"
+    end
+
+    ## Simple interfaces to metadata
+
+    # Set the metadata value
+    def value(value = nil)
+      return @info[:metadata] if value.nil?
+
+      # Convert to array if value is string
+      value = [value] if value.is_a? String
+
+      # Set info
+      @info = { type: 'Metadata', kind: @kind, metadata: value }
+    end
+
+    # Retrieve metadata value
+    def get
+      res = @http.get @url
+      return value if res.key? :value
+    end
+
+    # Change metadata
+    def change(value)
+      value(value)
+      @http.put(@url, @info)
+    end
+  end
+end

data/lib/pdns_api/override.rb

@@ -0,0 +1,22 @@
+# PDNS Server Override
+module PDNS
+  # Server override
+  class Override < API
+    attr_reader :id, :url, :info
+
+    def initialize(http, t_url, id, info = {})
+      @http  = http
+      @id    = id
+      @info  = info
+      @r_url = "#{t_url}/metadata"
+      @url   = "#{t_url}/metadata/#{kind}"
+    end
+
+    ## Simple interfaces to overrides
+
+    # Change override settings
+    def change(rrsets)
+      @http.put(@url, rrsets)
+    end
+  end
+end

data/lib/pdns_api/server.rb

@@ -0,0 +1,75 @@
+require 'pdns_api/config'
+require 'pdns_api/override'
+require 'pdns_api/zone'
+
+# PDNS Server
+module PDNS
+  # PDNS Server
+  class Server < API
+    attr_reader :id, :url
+
+    def initialize(http, t_url, id, info = {})
+      @http  = http
+      @id    = id
+      @r_url = "#{t_url}/servers"
+      @url   = "#{t_url}/servers/#{id}"
+      @info  = info
+    end
+
+    ## Server interfaces
+    # TODO: /servers/:server_id: ?
+
+    ## Server actions
+
+    def cache(domain)
+      # TODO: #{url}/cache/flush?domain=:domain: PUT
+    end
+
+    def search_log(search_term)
+      # TODO: /servers/:server_id/search-log?q=:search_term: GET
+    end
+
+    def statistics
+      # TODO: /servers/:server_id/statistics: GET
+    end
+
+    def trace
+      # TODO: /servers/:server_id/trace: GET, PUT
+    end
+
+    def failures
+      # TODO: /servers/:server_id/failures: GET, PUT
+    end
+
+    ## Server resources
+
+    # Get or set server config
+    def config(name = nil, value = nil)
+      return Config.new(@http, @url, name, value).create unless name.nil? || value.nil?
+      return Config.new(@http, @url, name) unless name.nil?
+
+      # Get all current configuration
+      config = @http.get("#{@url}/config")
+      config.map { |c| [c[:name], c[:value]] }.to_h
+    end
+
+    # Get or set server overrides, not yet implemented
+    def overrides(id = nil)
+      return Override.new(@http, @url, id) unless id.nil?
+
+      overrides = @http.get("#{@url}/config")
+      overrides.map { |o| [o[:id], Override.new(@http, @url, o[:id], o)] }.to_h
+    end
+
+    # Get zones or create one
+    def zones(zone_id = nil)
+      return Zone.new(@http, @url, zone_id) unless zone_id.nil?
+
+      zones = @http.get("#{@url}/zones")
+      zones.map { |z| [z[:id], Zone.new(@http, @url, z[:id], z)] }.to_h
+    end
+
+    alias override overrides
+    alias zone zones
+  end
+end

data/lib/pdns_api/version.rb

@@ -0,0 +1,4 @@
+# PDNS version
+module PDNS
+  VERSION = '0.0.4'.freeze
+end

data/lib/pdns_api/zone.rb

@@ -0,0 +1,184 @@
+# PDNS Zone
+module PDNS
+  require_relative 'metadata'
+  require_relative 'cryptokey'
+
+  # Zone
+  class Zone < API
+    attr_reader :id, :url
+
+    def initialize(http, t_url, id, info = {})
+      @http  = http
+      @id    = id
+      @info  = info
+      @r_url = "#{t_url}/zones"
+      @url   = "#{t_url}/zones/#{id}"
+    end
+
+    ## Zone interfaces
+
+    # Modifies present RRsets and comments.
+    def modify(rrsets)
+      rrsets.map! { |rrset| format_records(rrset) if rrset.key?(:records) }
+
+      @http.patch(@url, rrsets: rrsets)
+    end
+
+    # Modifies basic zone data (metadata).
+    def change(rrsets)
+      @http.put(@url, rrsets)
+    end
+
+    ## Zone actions
+
+    # Notify slaves for a zone
+    def notify
+      @http.put "#{@url}/notify"
+    end
+
+    # Get the AXFR for a zone
+    def axfr_retrieve
+      @http.put "#{@url}/axfr-retrieve"
+    end
+
+    # Export a zone
+    def export
+      @http.get "#{@url}/export"
+    end
+
+    # Check a zone
+    def check
+      @http.get "#{@url}/check"
+    end
+
+    ## Zone resources
+
+    # Manipulate metadata for a zone
+    def metadata(kind = nil, value = nil)
+      return Metadata.new(@http, @url, kind, value).create unless kind.nil? || value.nil?
+      return Metadata.new(@http, @url, kind) unless kind.nil?
+
+      # Get all current metadata
+      metadata = @http.get("#{@url}/metadata")
+
+      # Check for errors
+      return metadata if metadata.is_a?(Hash) && metadata.key?(:error)
+
+      # Convert metadata to hash
+      metadata.map! { |c| [c[:kind], c[:metadata]] }.to_h
+    end
+
+    # Change cryptokeys for a zone
+    def cryptokeys(id = nil)
+      return CryptoKey.new(@http, @url, id) unless id.nil?
+
+      # Get all current metadata
+      cryptokeys = @http.get("#{@url}/cryptokeys")
+
+      # Convert cryptokeys to hash
+      cryptokeys.map! { |c| [c[:id], CryptoKey.new(@http, @url, c[:id], c)] }.to_h
+    end
+
+    ## Additional methods
+
+    def format_single_record(record)
+      # Ensure content
+      record = { content: record } if record.is_a? String
+
+      # Add disabled and set_ptr
+      record[:disabled] = !!record[:disabled]
+      record[:set_ptr]  = !!record[:set_ptr]
+
+      # Replace some symbols
+      record[:'set-ptr'] = record.delete :set_ptr
+      record
+    end
+
+    # Add required items to records in an rrset
+    def format_records(rrset)
+      # Abort if rrset is something else than an array
+      abort('Error: records needs to be array') unless rrset[:records].is_a? Array
+
+      # Ensure existence of required keys
+      rrset[:records].map! do |record|
+        # Format the record content
+        record = format_single_record(record)
+
+        # Add disabled from the rrset
+        record[:disabled] ||= !!rrset[:disabled]
+
+        # Return record
+        next record unless @version == 0
+
+        # But add some more for APIv0
+        record.merge(name: rrset[:name], type: rrset[:type], ttl: rrset[:ttl])
+      end
+      rrset
+    end
+
+    # Add records to the ones already existing
+    # Only works from API v1 and up
+    def add(*rrsets)
+      # Get current zone data
+      data = get
+
+      # Return any errors
+      return data if data.key?(:error)
+
+      # Run v0 version
+      return add_v0(rrsets, data) if @version == 0
+
+      # Add these records to the rrset
+      rrsets.map! do |rrset|
+        # Get current data from rrset
+        current = data[:rrsets].select { |r| r[:name] == rrset[:name] && r[:type] == rrset[:type] }
+
+        # Merge data
+        rrset[:records]    = current.first[:records] + ensure_array(rrset[:records])
+        rrset[:changetype] = 'REPLACE'
+        rrset
+      end
+      modify(rrsets)
+    end
+
+    # Add records to the ones already existing
+    # Only works from API v1 and down
+    def add_v0(rrsets, data)
+      # Add these records to the rrset
+      rrsets.map! do |rrset|
+        current = data[:records].select do |r|
+          r[:name] == rrset[:name] && r[:type] == rrset[:type]
+        end
+        current.map! do |record|
+          {
+            content:  record[:content],
+            disabled: record[:disabled]
+          }
+        end
+        rrset[:records] = current + ensure_array(rrset[:records])
+        rrset[:changetype] = 'REPLACE'
+        rrset
+      end
+      modify(rrsets)
+    end
+
+    def update(*rrsets)
+      # Set type and format records
+      rrsets.map! do |rrset|
+        rrset[:changetype] = 'REPLACE'
+        rrset[:records] = ensure_array(rrset[:records])
+        rrset
+      end
+      modify(rrsets)
+    end
+
+    def remove(*rrsets)
+      # Set type and format records
+      rrsets.map! do |rrset|
+        rrset[:changetype] = 'DELETE'
+        rrset
+      end
+      apply(rrsets)
+    end
+  end
+end

data/lib/pdns_api.rb

@@ -0,0 +1,13 @@
+require 'json'
+require 'net/http'
+
+# PDNS module
+module PDNS
+  require_relative 'pdns_api/client'
+
+  class << self
+    def new(args)
+      Client.new(args)
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: pdns_api
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Silke Hofstra
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-24 00:00:00.000000000 Z
+dependencies: []
+description: A gem for manipulation of DNS through the PowerDNS API
+email: silke@slxh.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/pdns_api.rb
+- lib/pdns_api/api.rb
+- lib/pdns_api/client.rb
+- lib/pdns_api/config.rb
+- lib/pdns_api/cryptokey.rb
+- lib/pdns_api/http.rb
+- lib/pdns_api/metadata.rb
+- lib/pdns_api/override.rb
+- lib/pdns_api/server.rb
+- lib/pdns_api/version.rb
+- lib/pdns_api/zone.rb
+homepage: https://github.com/silkeh/ruby-pdns_api
+licenses:
+- GPLv3+
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: PowerDNS API gem
+test_files: []