dapi-client 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3af6232965a19b8ed245ab347a0d82e0da95f8a686d653463fa9e48e9635c30d
+  data.tar.gz: d47460d0bbc734c3bb2df565d712f29fe010991ebb60c2c4a2381c348e352921
+SHA512:
+  metadata.gz: 91508607d01994bd0d1a63f2775884f44624189c6d505e03f40d74fc00a3e988b9af9210dd8be62a1a9e5eecf955d8cdf9e093ef72efa05bf56cb70e08cf0950
+  data.tar.gz: 48e415ba642caf12a1d8753ca011d0661e13bd1a2bcb77a76fb80578039a9d299f04ca7f8377cf0c63d75df7dd95e55306be7d05cf7106d544a7fa2587368066

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,12 @@
+FROM ruby:2.5
+
+RUN mkdir /usr/src/app
+
+WORKDIR /usr/local/src
+
+ADD Gemfile dapi-client.gemspec ./
+ADD lib/dapi/client/version.rb ./lib/dapi/client/version.rb
+RUN bundle install --jobs=3 --retry=3
+ADD . ./
+
+CMD bundle exec rspec --force-color -fd spec

data/Gemfile

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

data/README.md

@@ -0,0 +1,57 @@
+# Dapi::Client
+
+This is a very thin wrapper over the DAPI HTTP service, providing just enough for OPF.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dapi-client'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dapi-client
+
+## Usage
+
+Example:
+
+```
+dapi = Dapi::Client.new(url: "http://dapi/, token: "secret")
+dapi.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 build test && docker-compose run test
+```
+
+To bring dapi 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 dapi
+
+# Terminal 2
+export DAPI_SERVER_TOKEN=test_blah_admin
+export DAPI_SERVER_ROOT=http://localhost/
+bundle exec rspec -fd spec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/webnifico/dapi-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 "dapi_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/dapi-client.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dapi/client/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dapi-client"
+  spec.version       = Dapi::Client::VERSION
+  spec.authors       = ["Sheldon Hearn"]
+  spec.email         = ["sheldonh@starjuice.net"]
+
+  spec.summary       = %q{DNS API Client}
+  spec.description   = %q{Client for Kernels DNS API over HTTP.}
+  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

data/docker-compose.local.yml

@@ -0,0 +1,9 @@
+version: '2.1'
+
+services:
+  test:
+    volumes:
+      - .:/usr/src/app
+  dapi:
+    ports:
+      - "80:80"

data/docker-compose.yml

@@ -0,0 +1,33 @@
+version: '2.1'
+
+services:
+  test:
+    build:
+      context: .
+    command: /bin/bash -c 'sleep 5 && bundle exec rspec -fd spec'
+    environment:
+      DAPI_SERVER_TOKEN: test_blah_admin
+      DAPI_SERVER_ROOT: http://dapi/
+    links:
+      - dapi
+  dapi:
+    image: gitlab.host-h.net:4567/seals/dapi:v3.17.0-staging
+    command: bundle exec rackup --server webrick -o 0.0.0.0 -p 80
+    environment:
+      ENVIRONMENT: test
+      DNS_CONFIG_FILE: /usr/local/src/conf/test/dns.yml
+      AUTH_CONFIG_FILE: /usr/local/src/conf/test/auth_tokens.yml
+      ROLES_CONFIG_FILE: /usr/local/src/conf/test/roles.yml
+      DEBUG: "true"
+      NSDB_PASSWORD_SA: secret
+      NSDB_PASSWORD_DE: secret
+    links:
+      - nsdb
+    expose:
+      - 80
+  nsdb:
+    image: gitlab.host-h.net:4567/seals/dapi:nsdb
+    expose:
+      - 53
+      - 5432
+

data/lib/dapi/client/error.rb

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

data/lib/dapi/client/version.rb

@@ -0,0 +1,5 @@
+module Dapi
+  class Client
+    VERSION = "0.1.1"
+  end
+end

data/lib/dapi/client.rb

@@ -0,0 +1,75 @@
+require "dapi/client/error"
+require "http"
+
+module Dapi
+
+  class Client
+
+    OPTIMISTIC_LOCKING_CHECK_WAIT = 1.0 unless defined?(OPTIMISTIC_LOCKING_CHECK_WAIT)
+    OPTIMISTIC_LOCKING_RETRIES = 10 unless defined?(OPTIMISTIC_LOCKING_RETRIES)
+
+    def initialize(url:, token:, http: HTTP)
+      @url = url
+      @http = http
+      @token = token
+    end
+
+    def get_zone(zone_name)
+      unwrap { http.get(@url + "zone/" + zone_name) }
+    end
+
+    def upsert_record(zone_name, lvalue, type, rvalue, ttl)
+      retries = OPTIMISTIC_LOCKING_RETRIES
+      begin
+        upsert_record!(zone_name, lvalue, type, rvalue, ttl)
+      rescue Dapi::Client::OptimisticLockFailure
+        if retries > 0
+          retries -= 1
+          sleep(0.1)
+          retry
+        else
+          raise
+        end
+      end
+    end
+
+    private
+
+    def http
+      @http.auth(@token)
+    end
+
+    def unwrap(&block)
+      res = block.call
+      if res.status == 201
+        {}
+      else
+        jsend = JSON.parse(res.body)
+        if jsend["status"] == "success"
+          jsend["data"]
+        elsif jsend["message"]
+          raise Dapi::Client::Error, jsend["message"]
+        else
+          raise Dapi::Client::Error, "unknown DAPI error"
+        end
+      end
+    rescue JSON::ParserError
+      raise Dapi::Client::Error, "error parsing server response (JSON)"
+    end
+
+    def upsert_record!(zone_name, lvalue, type, rvalue, ttl)
+      zone = get_zone(zone_name)
+      zone["records"].reject! { |r| r["name"] == lvalue && r["type"] == type }
+      zone["records"] << {"name" => lvalue, "type" => type, "value" => rvalue, "ttl" => ttl}
+      unwrap { http.post(@url + "zone/" + zone_name, json: {data: zone}) }
+      sleep(OPTIMISTIC_LOCKING_CHECK_WAIT)
+      zone = get_zone(zone_name)
+      unless zone["records"].detect { |r| r["name"] == lvalue && r["type"] == type && r["value"] == rvalue && r["ttl"] == ttl }
+        raise Dapi::Client::OptimisticLockFailure, "upsert_record: optimistic locking failed"
+      end
+      zone
+    end
+
+  end
+
+end

data/lib/dapi-client.rb

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

data/lib/dapi.rb

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

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: dapi-client
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Sheldon Hearn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-12 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 Kernels DNS API over HTTP.
+email:
+- sheldonh@starjuice.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".gitignore"
+- ".rspec"
+- Dockerfile
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dapi-client.gemspec
+- docker-compose.local.yml
+- docker-compose.yml
+- lib/dapi-client.rb
+- lib/dapi.rb
+- lib/dapi/client.rb
+- lib/dapi/client/error.rb
+- lib/dapi/client/version.rb
+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: []