esgob 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c771929d5f34833c2a7b647e05c11686e0ecd9db
-  data.tar.gz: c0c648e1341855edd956c83d29b373e107e8db8e
+  metadata.gz: f029cb699d12ea2f9ebc3d62538b301ac22c4ce2
+  data.tar.gz: 878e694007c2d41a71ed940fc5f7cf9215a4ad23
 SHA512:
-  metadata.gz: 6650464bd90d58172139131df815d59f7b8601c9f75cd5a2b214ed9bded0b393e81ff4252e782f03ee10cfce2679a927bcfeba9dd655acb81740269c976a556b
-  data.tar.gz: 35b9700a1ec0f86df74720e404ea5ebb5ee08e33ecb0a7885d1f8cb5874d369d68a7af7029dd3e8d4e263259af0b2941c900a862be3e4f2edb3e62b8f484c07e
+  metadata.gz: 48559b9d9ac0b9a5def0e60cd6ed4242d90e28a2ec617d71fb673c0fedadd4e6aee7a32a81c6db88d649d539a59df04ab8e83e8317c5bfe65f442a13929159f5
+  data.tar.gz: 5ff773471a48fc33e975ae314aec3519f9d7422b8526301bebf66f5328955f886bf9c9a8d0fb03838766d2321df230988108810aca80091a00a9d17079945202

data/.gitignore

@@ -11,4 +11,5 @@
 *.so
 *.o
 *.a
+.ruby-version
 mkmf.log

data/README.md

@@ -52,12 +52,12 @@ Here is an example of what can be done in an IRB session:
 
     $ irb -resgob
     irb(main):001:0> esgob = Esgob::Client.new
-    => #<Esgob::Client:0x007fd2e3b13420>
+    => #<Esgob::Client account=myacct>
     irb(main):002:0> esgob.domains_slaves_list
     => {"example.com"=>"192.168.0.1", "example.uk"=>"192.168.0.1"}
     irb(main):003:0> esgob.domains_slaves_list.keys
     => ["example.com", "example.uk"]
-    irb(main):004:0> 
+    irb(main):004:0>
 
 See the [API documentation] for full details.
 

data/bin/esgob

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path("../../lib", __FILE__)
+
+require "rubygems"
+require "esgob"
+
+Esgob::CLI.start

data/esgob.gemspec

@@ -4,35 +4,37 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'esgob/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "esgob"
+  spec.name          = 'esgob'
   spec.version       = Esgob::VERSION
-  spec.authors       = ["Nicholas Humfrey"]
-  spec.email         = ["njh@aelius.com"]
-  spec.summary       = %q{Client library for talking to the Esgob anycast DNS API.}
-  #spec.description   = %q{TODO: Write a longer description. Optional.}
-  spec.homepage      = ""
-  spec.license       = "MIT"
+  spec.authors       = ['Nicholas Humfrey']
+  spec.email         = ['njh@aelius.com']
+  spec.summary       = 'Client library for talking to the Esgob anycast DNS API.'
+  # spec.description   = 'TODO: Write a longer description. Optional.'
+  spec.homepage      = 'http://github.com/njh/ruby-esgob'
+  spec.license       = 'MIT'
 
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
-
-  spec.add_dependency "json", "~> 1.8"
+  spec.add_dependency 'json', '~> 1.8'
+  spec.add_dependency 'thor', '~> 0.19.1'
 
   if Gem.ruby_version > Gem::Version.new('1.9')
     spec.add_development_dependency 'bundler',  '>= 1.5.0'
     spec.add_development_dependency 'rake',     '>= 0.10.0'
     spec.add_development_dependency 'yard',     '>= 0.8.0'
     spec.add_development_dependency 'fakeweb',  '~> 1.3.0'
+    spec.add_development_dependency 'mocha',    '~> 1.1.0'
     spec.add_development_dependency 'simplecov'
   elsif Gem.ruby_version > Gem::Version.new('1.8')
     spec.add_development_dependency 'bundler',  '>= 1.1.0'
     spec.add_development_dependency 'rake',     '~> 0.9.0'
     spec.add_development_dependency 'yard',     '~> 0.8.0'
-    spec.add_development_dependency 'minitest', '~> 5.5.0'
     spec.add_development_dependency 'fakeweb',  '~> 1.3.0'
+    spec.add_development_dependency 'minitest', '~> 5.5.0'
+    spec.add_development_dependency 'mocha',    '~> 1.1.0'
   else
     raise "#{Gem.ruby_version} is an unsupported version of ruby"
   end

data/lib/esgob/cli.rb

@@ -0,0 +1,134 @@
+require "thor"
+
+class Esgob::CLI < Thor
+  class_option :account,
+               :type =>   :string,
+               :aliases => '-a',
+               :banner =>  'Account Name'
+
+  class_option :key,
+               :type =>   :string,
+               :aliases => '-k',
+               :banner =>  'API Key'
+
+  class_option :verbose,
+               :type =>  :boolean,
+               :default => false,
+               :aliases => '-v'
+
+  def self.start(args = ARGV, config = {})
+    config[:shell] ||= Thor::Base.shell.new
+    begin
+      super(args, config)
+    rescue Esgob::ServerError => err
+      $stderr.puts config[:shell].set_color("=> Error: #{err.message} [#{err.code}]", :red, :bold)
+    end
+  end
+
+  desc "account", "Display account info"
+  def account
+    client.accounts_get.each_pair do |k, v|
+      say sprintf("%8s: %s\n", k, v)
+    end
+  end
+  
+  desc "domains", "List all domains"
+  def domains
+    print_table(
+      [['Domain', 'Type']] +
+      [['------', '----']] +
+      client.domains_list.map { |h| [h[:domain], h[:type]] }
+    )
+  end
+
+  desc "slaves", "List slave domains"
+  def slaves
+    print_table(
+      [['Domain', 'Master IP']] +
+      [['------', '---------']] +
+      client.domains_slaves_list.to_a
+    )
+  end
+
+  desc "slaves-add DOMAIN MASTERIP", "Add new slave domain"
+  def slaves_add(domain, masterip)
+    check_action do
+      client.domains_slaves_add(domain, masterip)
+    end
+  end
+
+  desc "slaves-delete DOMAIN", "Delete a slave domain"
+  def slaves_delete(domain)
+    check_action do
+      client.domains_slaves_delete(domain)
+    end
+  end
+
+  desc "slaves-transfer DOMAIN",
+       "Force transfer from master of a slave domain"
+  def slaves_transfer(domain)
+    check_action do
+      client.domains_slaves_forcetransfer(domain)
+    end
+  end
+
+  desc "slaves-update DOMAIN MASTERIP",
+       "Updates the master IP of a slave domain"
+  def slaves_update(domain, masterip)
+    check_action do
+      client.domains_slaves_updatemasterip(domain, masterip)
+    end
+  end
+
+  desc "slaves-sync FILE MASTERIP",
+       "Synronises list of slave domains in a file"
+  def slaves_sync(filename, masterip)
+    domains = []
+    File.foreach(filename) do |line|
+      domains << line.strip.split(/\s+/).first
+    end
+
+    check_action do
+      client.domains_slaves_sync(domains, masterip)
+    end
+  end
+
+  desc "soacheck DOMAIN",
+       "Fetch domain SOA serial number for all nodes"
+  def soacheck(domain)
+    response = client.domains_tools_soacheck(domain)
+    print_table(
+      [['Identifier', 'Type', 'Country', 'SOA', 'Response']] +
+      [['----------', '----', '-------', '---', '--------']] +
+      response[:responses][:masters].map do |node|
+        [node[:ip], "master", '', node[:soa], node[:response]]
+      end +
+      response[:responses][:anycastnodes].map do |node|
+        [node[:ref], 'anycast', node[:country], node[:soa], node[:response]]
+      end
+    )
+  end
+
+  desc "version", "Show Esgob Ruby Client version"
+  def version
+    say "Esgob Ruby Client version #{Esgob::VERSION}"
+  end
+  map "--version" => "version"
+
+  private ######################################################################
+
+  def client
+    @client ||= Esgob::Client.new(options[:account], options[:key])
+  end
+
+  def check_action
+    results = yield
+    results = [results] unless results.is_a?(Array)
+    results.each do |result|
+      unless result[:action].nil?
+        say "#{result[:domain]} " + set_color("=> #{result[:action]}", :green, :bold)
+      end
+    end
+  end
+  
+end

data/lib/esgob/client.rb

@@ -10,19 +10,27 @@ class Esgob::Client
   DEFAULT_API_ENDPOINT = "https://api.esgob.com/1.0/".freeze
 
   def initialize(*args)
-    if args.first.kind_of?(Hash)
-      args.first.each_pair { |k,v| send("#{k}=", v) }
+    if args.first.is_a?(Hash)
+      args.first.each_pair { |k, v| send("#{k}=", v) }
     else
       self.account = args[0]
       self.api_key = args[1]
     end
 
+    self.account ||= ENV['ESGOB_ACCOUNT']
+    self.api_key ||= ENV['ESGOB_API_KEY']
     self.endpoint ||= DEFAULT_API_ENDPOINT
-    self.account  ||= ENV['ESGOB_ACCOUNT']
-    self.api_key  ||= ENV['ESGOB_API_KEY']
+
+    if account.nil? or account.empty?
+      raise(ArgumentError, "No account name configured for Esgob")
+    end
+
+    if api_key.nil? or api_key.empty?
+      raise(ArgumentError, "No API key configured for Esgob")
+    end
   end
 
-  def call(function_name, arguments={})
+  def call(function_name, arguments = {})
     uri = URI(endpoint + function_name)
     uri.query = build_query(default_arguments.merge(arguments))
 
@@ -32,22 +40,28 @@ class Esgob::Client
       http.request(req)
     end
 
-    if res.code =~ /^2/
-      if res.content_type == 'application/json'
-        symbolize_keys! JSON.parse(res.body)
+    if res.content_type == 'application/json'
+      data = symbolize_keys! JSON.parse(res.body)
+      if data.key?(:error)
+        raise Esgob::ServerError.new(
+          data[:error][:message],
+          data[:error][:code].to_s
+        )
+      elsif res.code !~ /^2/
+        raise Esgob::ServerError.new(res.message, res.code)
       else
-       raise "HTTP response from ESGOB is not of type JSON"
+        return data
       end
     else
-      # The badly named method throws an Net::HTTP exception
-      res.value
+      raise "HTTP response from ESGOB is not of type JSON"
     end
-
   end
 
   # Return account status; credit balance, etc
   def accounts_get
-    call('accounts.get')
+    account = call('accounts.get')
+    account[:added] = Time.at(account[:added]) if account[:added].is_a?(Fixnum)
+    account
   end
 
   # Returns all hosted domains
@@ -56,7 +70,7 @@ class Esgob::Client
   end
 
   # Returns all hosted slave domains as a hash
-  # 
+  #
   def domains_slaves_list
     Hash[
       call('domains.slaves.list')[:domains].map do |item|
@@ -67,32 +81,44 @@ class Esgob::Client
 
   # Adds a new slave domain
   def domains_slaves_add(domain, masterip)
-    call('domains.slaves.add', :domain => domain, :masterip => masterip)
+    result = call('domains.slaves.add', :domain => domain, :masterip => masterip)
+    result[:domain] ||= domain
+    result
   end
 
   # Deletes a slave domain
   def domains_slaves_delete(domain)
-    call('domains.slaves.delete', :domain => domain)
+    result = call('domains.slaves.delete', :domain => domain)
+    result[:domain] ||= domain
+    result
   end
 
   # Force AXFR / transfer from master of a slave domain
   def domains_slaves_forcetransfer(domain)
-    call('domains.slaves.forcetransfer', :domain => domain)
+    result = call('domains.slaves.forcetransfer', :domain => domain)
+    result[:domain] ||= domain
+    result
   end
 
   # Updates the master IP of a slave domain
   def domains_slaves_updatemasterip(domain, masterip)
-    call('domains.slaves.updatemasterip', :domain => domain, :masterip => masterip)
+    result = call('domains.slaves.updatemasterip', :domain => domain, :masterip => masterip)
+    result[:domain] ||= domain
+    result
   end
 
   # Add a host allowed to AXFR out
   def domains_slaves_axfrout_add(domain, axfrip)
-    call('domains.slaves.axfrout.add', :domain => domain, :axfrip => axfrip)
+    result = call('domains.slaves.axfrout.add', :domain => domain, :axfrip => axfrip)
+    result[:domain] ||= domain
+    result
   end
 
   # Account	Delete a host allowed to AXFR out
   def domains_slaves_axfrout_delete(domain, axfrip)
-    call('domains.slaves.axfrout.delete', :domain => domain, :axfrip => axfrip)
+    result = call('domains.slaves.axfrout.delete', :domain => domain, :axfrip => axfrip)
+    result[:domain] ||= domain
+    result
   end
 
   # Retrieve the domain SOA serial number from the master and each anycast node
@@ -100,6 +126,44 @@ class Esgob::Client
     call('domains.tools.soacheck', :domain => domain)
   end
 
+  # Given a list of domains and a master IP, add and delete domains
+  # so that the Esgob account matches the local list
+  def domains_slaves_sync(domains, masterip)
+    existing_domains = domains_slaves_list
+
+    # Add any missing domains
+    responses = []
+    domains.each do |domain|
+      unless existing_domains.include?(domain)
+        response = domains_slaves_add(domain, masterip)
+        response[:domain] ||= domain
+        responses << response
+      end
+    end
+
+    # Now check the existing domains
+    existing_domains.keys.sort.each do |domain|
+      if domains.include?(domain)
+        # Update the masterip if it isn't correct
+        if existing_domains[domain] != masterip
+          response = domains_slaves_updatemasterip(domain, masterip)
+          response[:domain] ||= domain
+          responses << response
+        end
+      else
+        # Delete domain; not on list
+        response = domains_slaves_delete(domain)
+        response[:domain] ||= domain
+        responses << response
+      end
+    end
+
+    responses
+  end
+
+  def inspect
+    "\#<#{self.class} account=#{@account}>"
+  end
 
   protected
 
@@ -111,10 +175,10 @@ class Esgob::Client
         when Hash
           symbolize_keys!(hash[ks])
         when Array
-          hash[ks].each {|item| symbolize_keys!(item) if item.kind_of?(Hash)}
+          hash[ks].each { |item| symbolize_keys!(item) if item.is_a?(Hash) }
       end
     end
-    return hash
+    hash
   end
 
   def default_arguments
@@ -126,8 +190,8 @@ class Esgob::Client
   end
 
   def build_query(hash)
-    hash.keys.sort{|a,b| a.to_s <=> b.to_s}.map { |key|
-      URI::escape(key.to_s) + '=' + URI::escape(hash[key].to_s)
-    }.join('&')
+    hash.keys.sort { |a, b| a.to_s <=> b.to_s }.map do |key|
+      URI.escape(key.to_s) + '=' + URI.escape(hash[key].to_s)
+    end.join('&')
   end
 end

data/lib/esgob/version.rb

@@ -1,3 +1,3 @@
 module Esgob
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/esgob.rb

@@ -1,4 +1,14 @@
 module Esgob
   autoload :Client,   'esgob/client'
-  autoload :Version,  'esgob/version'
+  autoload :CLI,      'esgob/cli'
+  autoload :VERSION,  'esgob/version'
+
+  class ServerError < StandardError
+    attr_reader :code
+
+    def initialize(message, code = nil)
+      super message
+      @code = code
+    end
+  end
 end

data/test/esgob_cli_test.rb

@@ -0,0 +1,129 @@
+$:.unshift(File.dirname(__FILE__))
+
+require 'test_helper'
+require 'esgob'
+
+class TestCLI < MiniTest::Unit::TestCase
+  def setup
+    # Run before each test
+    FakeWeb.clean_registry
+
+    @client = Esgob::Client.new('acct', 'xxxx')
+    Esgob::Client.stubs(:new).returns(@client)
+
+    ENV['THOR_SHELL'] = 'Basic'
+  end
+
+  def teardown
+    # Reset environment variables after each test
+    ENV.delete('ESGOB_ACCOUNT')
+    ENV.delete('ESGOB_API_KEY')
+  end
+
+  def test_account
+    register_fixture('accounts.get')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(account)) }
+    assert_match "      id: xyz\n", output
+    assert_match "    name: Person Name\n", output
+    assert_match " credits: 48\n", output
+  end
+
+  def test_account_error
+    FakeWeb.register_uri(
+      :get, %r{^https?://api\.esgob\.com(:443)?/},
+      :status => ['401', 'UNAUTHORIZED'],
+      :content_type => 'application/json',
+      :body => read_fixture(:code_1003)
+    )
+
+    output = capture(:stderr) { Esgob::CLI.start(%w(account)) }
+    assert_equal "=> Error: Account and API key combination not valid [1003]\n", output
+  end
+
+  def test_domains
+    register_fixture('domains.list')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(domains)) }
+    assert_match "Domain       Type\n", output
+    assert_match "------       ----\n", output
+    assert_match "example.com  slave\n", output
+    assert_match "example.uk   slave\n", output
+  end
+
+  def test_slaves
+    register_fixture('domains.slaves.list')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(slaves)) }
+    assert_match "Domain       Master IP\n", output
+    assert_match "------       ---------\n", output
+    assert_match "example.com  195.177.253.166\n", output
+    assert_match "example.uk   195.177.253.166\n", output
+  end
+
+  def test_slaves_add
+    register_fixture('domains.slaves.add')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(slaves-add example.org 195.177.253.166)) }
+    assert_equal "example.org => domain added\n", output
+  end
+
+  def test_slaves_delete
+    register_fixture('domains.slaves.delete')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(slaves-delete example.org)) }
+    assert_equal "example.org => domain deleted\n", output
+  end
+
+  def test_slaves_delete_error
+    FakeWeb.register_uri(
+      :get, %r{^https?://api\.esgob\.com(:443)?/},
+      :status => ['403', 'FORBIDDEN'],
+      :content_type => 'application/json',
+      :body => read_fixture(:code_2007)
+    )
+
+    output = capture(:stderr) { Esgob::CLI.start(%w(slaves-delete example.com)) }
+    assert_equal "=> Error: Domain is not present in your account [2007]\n", output
+  end
+
+  def test_slaves_transfer
+    register_fixture('domains.slaves.forcetransfer')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(slaves-transfer example.org)) }
+    assert_equal "example.org => Domain AXFR requested from master\n", output
+  end
+
+  def test_slaves_update
+    register_fixture('domains.slaves.updatemasterip')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(slaves-update example.org 195.177.253.167)) }
+    assert_equal "example.org => domain master IP updated\n", output
+  end
+
+  def test_slaves_sync
+    @client.expects(:domains_slaves_list).with().returns('a.com' => '195.177.253.169', 'b.com' => '195.177.253.169')
+    @client.expects(:domains_slaves_delete).with('a.com').returns(:action => 'domain deleted')
+    @client.expects(:domains_slaves_add).with('c.com', '195.177.253.169').returns(:action => 'domain added')
+
+    output = capture(:stdout) { Esgob::CLI.start(['slaves-sync', fixture_path('sync-domain-list.txt'), '195.177.253.169']) }
+    assert_match "a.com => domain deleted\n", output
+    assert_match "c.com => domain added\n", output
+  end
+
+  def test_soacheck
+    register_fixture('domains.tools.soacheck')
+
+    output = capture(:stdout) { Esgob::CLI.start(%w(soacheck example.org)) }
+    assert_match "Identifier       Type     Country  SOA  Response\n", output
+    assert_match "----------       ----     -------  ---  --------\n", output
+    assert_match "195.177.253.167  master                 fail\n", output
+    assert_match "4f31ad80         anycast  gb            fail\n", output
+    assert_match "fgej72a1         anycast  us            fail\n", output
+  end
+
+  def test_version
+    assert_match /Esgob Ruby Client version \d+.\d+\.\d+/,
+                 capture(:stdout) { Esgob::CLI.start(%w(version)) }
+  end
+end

data/test/esgob_client_test.rb

@@ -44,6 +44,20 @@ class TestClient < MiniTest::Unit::TestCase
     assert_equal 'http://api.example.com/', client.endpoint
   end
 
+  def test_new_client_with_no_account
+    ENV.delete('ESGOB_ACCOUNT')
+    assert_raises(ArgumentError) do
+      Esgob::Client.new(nil, 'mykey')
+    end
+  end
+
+  def test_new_client_with_no_api_key
+    ENV.delete('ESGOB_API_KEY')
+    assert_raises(ArgumentError) do
+      Esgob::Client.new('acct', nil)
+    end
+  end
+
   def test_call_with_no_parameters
     register_fixture('accounts.get')
     response = @client.call('accounts.get')
@@ -53,7 +67,13 @@ class TestClient < MiniTest::Unit::TestCase
       FakeWeb.last_request.path
     )
     assert_equal(
-      {:credits=>48, :users=>[], :added=>1422792434, :id=>"xyz", :name=>"Person Name"},
+      {
+        :credits => 48,
+        :users => [],
+        :added => 1422792434,
+        :id => 'xyz',
+        :name => 'Person Name'
+      },
       response
     )
   end
@@ -79,27 +99,38 @@ class TestClient < MiniTest::Unit::TestCase
   end
 
   def test_call_with_404_error
-    assert_raises(Net::HTTPServerException) do
-      FakeWeb.register_uri(
-        :get, %r[^https?://api\.esgob\.com(:443)?/],
-        :status => ["404", "Not Found"],
-        :content_type => "application/json",
-        :body => '{}'
-      )
-      response = @client.call('accounts.get')
-    end
+    FakeWeb.register_uri(
+      :get, %r{^https?://api\.esgob\.com(:443)?/},
+      :status => ['404', 'Not Found'],
+      :content_type => 'application/json',
+      :body => '{}'
+    )
+    err = assert_raises(Esgob::ServerError) { @client.call('accounts.get') }
+    assert_equal 'Not Found', err.message
+    assert_equal '404', err.code
   end
 
   def test_call_with_non_json_reponse
-    assert_raises(RuntimeError) do
-      FakeWeb.register_uri(
-        :get, %r[^https?://api\.esgob\.com(:443)?/],
-        :status => ["200", "OK"],
-        :content_type => "text/plain",
-        :body => 'This is plain text'
-      )
-      response = @client.call('accounts.get')
-    end
+    FakeWeb.register_uri(
+      :get, %r{^https?://api\.esgob\.com(:443)?/},
+      :status => ['200', 'OK'],
+      :content_type => 'text/plain',
+      :body => 'This is plain text'
+    )
+    err = assert_raises(RuntimeError) { @client.call('accounts.get') }
+    assert_equal 'HTTP response from ESGOB is not of type JSON', err.message
+  end
+
+  def test_call_domain_not_present
+    FakeWeb.register_uri(
+      :get, %r{^https?://api\.esgob\.com(:443)?/},
+      :status => ['403', 'FORBIDDEN'],
+      :content_type => 'application/json',
+      :body => read_fixture(:code_2007)
+    )
+    err = assert_raises(Esgob::ServerError) { @client.call('domains.slaves.delete', :domain => 'example.org') }
+    assert_equal 'Domain is not present in your account', err.message
+    assert_equal '2007', err.code
   end
 
   def test_accounts_get
@@ -111,7 +142,13 @@ class TestClient < MiniTest::Unit::TestCase
       FakeWeb.last_request.path
     )
     assert_equal(
-      {:credits=>48, :users=>[], :added=>1422792434, :id=>"xyz", :name=>"Person Name"},
+      {
+        :credits => 48,
+        :users => [],
+        :added => Time.parse('2015-02-01 12:07:14 +0000'),
+        :id => 'xyz',
+        :name => 'Person Name'
+      },
       response
     )
   end
@@ -126,8 +163,8 @@ class TestClient < MiniTest::Unit::TestCase
     )
     assert_equal(
       [
-        {:domain => "example.com", :type => "slave"},
-        {:domain => "example.uk",  :type => "slave"}
+        { :domain => 'example.com', :type => 'slave' },
+        { :domain => 'example.uk',  :type => 'slave' }
       ],
       response
     )
@@ -142,7 +179,7 @@ class TestClient < MiniTest::Unit::TestCase
       FakeWeb.last_request.path
     )
     assert_equal(
-      {"example.com"=>"195.177.253.166", "example.uk"=>"195.177.253.166"},
+      { 'example.com' => '195.177.253.166', 'example.uk' => '195.177.253.166' },
       response
     )
   end
@@ -155,7 +192,7 @@ class TestClient < MiniTest::Unit::TestCase
       '/1.0/domains.slaves.add?account=acct&domain=example.org&f=json&key=xxxx&masterip=195.177.253.166',
       FakeWeb.last_request.path
     )
-    assert_equal({:action=>"domain added"}, response)
+    assert_equal({ :action => 'domain added', :domain => 'example.org' }, response)
   end
 
   def test_domains_slaves_delete
@@ -166,7 +203,7 @@ class TestClient < MiniTest::Unit::TestCase
       '/1.0/domains.slaves.delete?account=acct&domain=example.org&f=json&key=xxxx',
       FakeWeb.last_request.path
     )
-    assert_equal({:action=>"domain deleted"}, response)
+    assert_equal({ :action => 'domain deleted', :domain => 'example.org' }, response)
   end
 
   def test_domains_slaves_forcetransfer
@@ -177,7 +214,7 @@ class TestClient < MiniTest::Unit::TestCase
       '/1.0/domains.slaves.forcetransfer?account=acct&domain=example.org&f=json&key=xxxx',
       FakeWeb.last_request.path
     )
-    assert_equal({:action=>"Domain AXFR requested from master"}, response)
+    assert_equal({ :action => 'Domain AXFR requested from master', :domain => 'example.org' }, response)
   end
 
   def test_domains_slaves_updatemasterip
@@ -188,7 +225,7 @@ class TestClient < MiniTest::Unit::TestCase
       '/1.0/domains.slaves.updatemasterip?account=acct&domain=example.org&f=json&key=xxxx&masterip=195.177.253.167',
       FakeWeb.last_request.path
     )
-    assert_equal({:action=>"domain master IP updated"}, response)
+    assert_equal({ :action => 'domain master IP updated', :domain => 'example.org' }, response)
   end
 
   def test_domains_slaves_axfrout_add
@@ -199,7 +236,7 @@ class TestClient < MiniTest::Unit::TestCase
       '/1.0/domains.slaves.axfrout.add?account=acct&axfrip=195.177.253.1&domain=example.org&f=json&key=xxxx',
       FakeWeb.last_request.path
     )
-    assert_equal({:action=>"domain AXFR out IPs updated"}, response)
+    assert_equal({ :action => 'domain AXFR out IPs updated', :domain => 'example.org' }, response)
   end
 
   def test_domains_slaves_axfrout_delete
@@ -210,7 +247,7 @@ class TestClient < MiniTest::Unit::TestCase
       '/1.0/domains.slaves.axfrout.delete?account=acct&axfrip=195.177.253.1&domain=example.org&f=json&key=xxxx',
       FakeWeb.last_request.path
     )
-    assert_equal({:action=>"domain AXFR out IPs updated"}, response)
+    assert_equal({ :action => 'domain AXFR out IPs updated', :domain => 'example.org' }, response)
   end
 
   def test_domains_tools_soacheck
@@ -225,4 +262,56 @@ class TestClient < MiniTest::Unit::TestCase
     refute_empty(response[:responses])
   end
 
+  def test_domains_slaves_sync_noop
+    @client.expects(:domains_slaves_list).with().returns(
+      'a.com' => '195.177.253.1', 'b.com' => '195.177.253.1'
+    )
+
+    responses = @client.domains_slaves_sync(['a.com', 'b.com'], '195.177.253.1')
+    assert_equal [], responses
+  end
+
+  def test_domains_slaves_sync_add_only
+    @client.expects(:domains_slaves_list).with().returns({})
+    @client.expects(:domains_slaves_add).with('a.com', '195.177.253.1').returns(:action => 'domain added')
+    @client.expects(:domains_slaves_add).with('b.com', '195.177.253.1').returns(:action => 'domain added')
+
+    responses = @client.domains_slaves_sync(['a.com', 'b.com'], '195.177.253.1')
+    assert_equal [
+      { :action => 'domain added', :domain => 'a.com' },
+      { :action => 'domain added', :domain => 'b.com' }
+    ], responses
+  end
+
+  def test_domains_slaves_sync_add_and_delete
+    @client.expects(:domains_slaves_list).with().returns({'a.com' => '195.177.253.1'})
+    @client.expects(:domains_slaves_delete).with('a.com').returns({:action => 'domain deleted'})
+    @client.expects(:domains_slaves_add).with('b.com', '195.177.253.1').returns(:action => 'domain added')
+
+    responses = @client.domains_slaves_sync(['b.com'], '195.177.253.1')
+    assert_equal [
+      { :action => 'domain added', :domain => 'b.com' },
+      { :action => 'domain deleted', :domain => 'a.com' }
+    ], responses
+  end
+
+  def test_domains_slaves_sync_add_and_delete_and_change_masterip
+    @client.expects(:domains_slaves_list).with().returns(
+      'a.com' => '195.177.253.1', 'c.com' => '127.0.0.1'
+    )
+    @client.expects(:domains_slaves_delete).with('a.com').returns(:action => 'domain deleted')
+    @client.expects(:domains_slaves_add).with('b.com', '195.177.253.1').returns(:action => 'domain added')
+    @client.expects(:domains_slaves_updatemasterip).with('c.com', '195.177.253.1').returns(:action => 'domain master IP updated')
+
+    responses = @client.domains_slaves_sync(['b.com', 'c.com'], '195.177.253.1')
+    assert_equal [
+      { :action => 'domain added', :domain => 'b.com' },
+      { :action => 'domain deleted', :domain => 'a.com' },
+      { :action => 'domain master IP updated', :domain => 'c.com' }
+    ], responses
+  end
+
+  def test_inspect
+    assert_match('#<Esgob::Client account=acct>', @client.inspect)
+  end
 end

data/test/esgob_version_test.rb

@@ -4,11 +4,9 @@ require 'test_helper'
 require 'esgob'
 
 class TestVersion < MiniTest::Unit::TestCase
-
   def test_version_number_looks_sensible
     assert_equal 'constant', defined?(Esgob::VERSION)
     assert_kind_of String, Esgob::VERSION
     assert_match /^\d{1,2}\.\d{1,2}\.\d{1,2}$/, Esgob::VERSION
   end
-
 end

data/test/fixtures/code_1003.json

@@ -0,0 +1,6 @@
+{
+    "error": {
+        "message": "Account and API key combination not valid", 
+        "code": 1003
+    }
+}

data/test/fixtures/code_2007.json

@@ -0,0 +1,6 @@
+{
+    "error": {
+        "message": "Domain is not present in your account", 
+        "code": 2007
+    }
+}

data/test/fixtures/sync-domain-list.txt

@@ -0,0 +1,2 @@
+b.com
+c.com

data/test/test_helper.rb

@@ -4,6 +4,7 @@ require 'rubygems'
 require 'bundler'
 Bundler.require(:default, :development)
 require 'minitest/autorun'
+require 'mocha/mini_test'
 
 unless RUBY_VERSION =~ /^1\.8/
   SimpleCov.start
@@ -11,18 +12,34 @@ end
 
 FakeWeb.allow_net_connect = false
 
+def fixture_path(fixture_name)
+  fixture_name = fixture_name.to_s
+  fixture_name += '.json' unless fixture_name.match(/\.\w+$/)
+  File.join(File.dirname(__FILE__), 'fixtures', fixture_name)
+end
+
+def read_fixture(fixture_name)
+  File.read fixture_path(fixture_name)
+end
 
-def register_fixture(api_call, fixture_name=nil)
+def register_fixture(api_call, fixture_name = nil)
   if fixture_name.nil?
     fixture_name = api_call.gsub(/\W+/, '_')
   end
 
-  fixture_file = File.join(File.dirname(__FILE__), 'fixtures', fixture_name + '.json')
-
   FakeWeb.register_uri(
     :get, %r[^https?://api\.esgob\.com(:443)?/1.0/#{api_call}],
     :status => ["200", "OK"],
     :content_type => "application/json",
-    :body => File.read(fixture_file)
+    :body => read_fixture(fixture_name)
   )
 end
+
+def capture(stream)
+  original = eval "$#{stream}"
+  eval "$#{stream} = StringIO.new"
+  yield
+  result = eval("$#{stream}").string
+  eval "$#{stream} = original"
+  result
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: esgob
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Nicholas Humfrey
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-12 00:00:00.000000000 Z
+date: 2015-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.3.0
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -97,7 +125,8 @@ dependencies:
 description: 
 email:
 - njh@aelius.com
-executables: []
+executables:
+- esgob
 extensions: []
 extra_rdoc_files: []
 files:
@@ -107,13 +136,18 @@ files:
 - LICENSE.md
 - README.md
 - Rakefile
+- bin/esgob
 - esgob.gemspec
 - lib/esgob.rb
+- lib/esgob/cli.rb
 - lib/esgob/client.rb
 - lib/esgob/version.rb
+- test/esgob_cli_test.rb
 - test/esgob_client_test.rb
 - test/esgob_version_test.rb
 - test/fixtures/accounts_get.json
+- test/fixtures/code_1003.json
+- test/fixtures/code_2007.json
 - test/fixtures/domains_list.json
 - test/fixtures/domains_slaves_add.json
 - test/fixtures/domains_slaves_axfrout_add.json
@@ -123,8 +157,9 @@ files:
 - test/fixtures/domains_slaves_list.json
 - test/fixtures/domains_slaves_updatemasterip.json
 - test/fixtures/domains_tools_soacheck.json
+- test/fixtures/sync-domain-list.txt
 - test/test_helper.rb
-homepage: ''
+homepage: http://github.com/njh/ruby-esgob
 licenses:
 - MIT
 metadata: {}
@@ -149,9 +184,12 @@ signing_key:
 specification_version: 4
 summary: Client library for talking to the Esgob anycast DNS API.
 test_files:
+- test/esgob_cli_test.rb
 - test/esgob_client_test.rb
 - test/esgob_version_test.rb
 - test/fixtures/accounts_get.json
+- test/fixtures/code_1003.json
+- test/fixtures/code_2007.json
 - test/fixtures/domains_list.json
 - test/fixtures/domains_slaves_add.json
 - test/fixtures/domains_slaves_axfrout_add.json
@@ -161,5 +199,6 @@ test_files:
 - test/fixtures/domains_slaves_list.json
 - test/fixtures/domains_slaves_updatemasterip.json
 - test/fixtures/domains_tools_soacheck.json
+- test/fixtures/sync-domain-list.txt
 - test/test_helper.rb
 has_rdoc: