appoxy-nettica 0.3.1

data/History.txt

@@ -0,0 +1,12 @@
+== 0.3.0 / 2008-01-29
+
+* Fixed update_record in command line script
+
+== 0.2.0 / 2008-01-28
+
+* Expanded api in command line script
+
+== 0.1.0 / 2008-01-28
+
+* Initial release
+

data/Manifest.txt

@@ -0,0 +1,13 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/nettica
+lib/nettica.rb
+lib/nettica/client.rb
+lib/nettica/stubs/DnsApiAsmxClient.rb
+lib/nettica/stubs/nettica.rb
+lib/nettica/stubs/nettica.wsdl
+lib/nettica/stubs/netticaDriver.rb
+lib/nettica/stubs/netticaMappingRegistry.rb
+test/test_nettica.rb

data/README.txt

@@ -0,0 +1,50 @@
+nettica
+    by Matt Conway
+    http://simplygenius.com
+
+== DESCRIPTION:
+  
+A ruby client for managing nettica bulk-dns entries using the Nettica SOAP API
+
+== FEATURES/PROBLEMS:
+  
+* A thin wrapper for convenience around the soap4r generated stubs for the nettica wsdl.
+
+== SYNOPSIS:
+
+  require 'nettica/client'
+  client = Neticca::Client.new('joe_user', 'secret_password')
+  puts client.list_zones
+
+== REQUIREMENTS:
+
+* soap4r gem
+
+== INSTALL:
+
+* sudo gem install nettica
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 FIX
+
+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/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './lib/nettica.rb'
+
+Hoe.new('nettica', Nettica::VERSION) do |p|
+  p.rubyforge_name = 'nettica'
+  p.author = 'Matt Conway'
+  p.email = 'wr0ngway@yahoo.com'
+  p.summary = 'A ruby client for managing nettica bulk-dns entries using the Nettica SOAP API'
+  # p.description = p.paragraphs_of('README.txt', 2..5).join("\n\n")
+  # p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['soap4r']
+  p.remote_rdoc_dir = '' # Release to root
+end
+
+# vim: syntax=Ruby

data/bin/nettica

@@ -0,0 +1,123 @@
+#!/usr/bin/env ruby
+
+require 'optparse'
+require 'ostruct'
+
+require 'rubygems'
+require 'nettica/client'
+
+options = OpenStruct.new
+options.ttl = [0]
+options.priority = [0]
+
+opts = OptionParser.new do |opts|
+  opts.banner = "Usage: nettica -u username -p password -c command [options]"
+  opts.separator "Runs the given nettica service command, for example:"
+  opts.separator ""
+  opts.separator "  nettica -u my_user -p my_pass -c list_domain -d foo.com"
+  opts.separator "  nettica -u my_user -p my_pass -c add_record -h bar -d foo.com -r A -t 300"
+  opts.separator "          -a 192.168.1.1"
+  opts.separator "  nettica -u my_user -p my_pass -c update_record -h bar -d foo.com"
+  opts.separator "          -a 192.168.1.1,10.0.0.1"
+  opts.separator "  nettica -u my_user -p my_pass -c update_record -h bar -d foo.com -a 10.0.0.1"
+  opts.separator "          -t 60,300"
+  opts.separator ""
+  opts.separator "Options:"
+
+  opts.on("-u", "--user USER", "Nettica username to use for authentication") do |val|
+    options.username = val
+  end
+  opts.on("-p", "--password PASSWORD", "Nettica password to use for authentication") do |val|
+    options.password = val
+  end
+  opts.on("-d", "--domain DOMAIN_NAME", Array, "Domain name to apply command to") do |val|
+    options.domain = val
+  end
+  opts.on("-h", "--host HOST_NAME", Array, "Hostname to act upon") do |val|
+    options.host = val
+  end
+  opts.on("-i", "--ip IP", "IP address") do |val|
+    options.ip = val
+  end
+  opts.on("-r", "--recordtype RECORD_TYPE", Array, "Domain record type (A, CNAME, MX, F, TXT,", "SRV)") do |val|
+    options.recordtype = val
+  end
+  opts.on("-t", "--ttl TIME_TO_LIVE", Array, "TTL for domain entries") do |val|
+    options.ttl = val.collect {|each| each.to_i}
+  end
+  opts.on("-o", "--priority PRIORITY", Array, "Priority for MX/F records") do |val|
+    options.priority = val.collect {|each| each.to_i}
+  end
+  opts.on("-g", "--group GROUP", "Domain group") do |val|
+    options.group = val
+  end
+  opts.on("-m", "--master MASTER", "Master domain") do |val|
+    options.master = val
+  end
+  opts.on("-a", "--data DATA", Array, "IP when creating/deleting records") do |val|
+    options.data = val
+  end
+
+  opts.on("-c", "--command COMMAND",
+           [:list_zones, :get_service_info, :update_record, :delete_record, :apply_template,
+            :list_domain, :create_secondary_zone, :delete_zone, :create_zone, :add_record],
+           "Command to execute against nettica service.",
+           "One of list_zones, get_service_info,",
+           "list_domain, update_record, delete_record,",
+           "apply_template, create_secondary_zone,",
+           "delete_zone, create_zone, add_record") do |val|
+    options.command = val
+  end
+
+  opts.on_tail("--help", "Show this message") do
+    puts opts
+    exit
+  end
+end
+
+begin
+  args = opts.parse!(ARGV)
+  raise "Missing required flag" if ! options.username || ! options.password || ! options.command
+rescue Exception => e
+  puts e, "", opts
+  exit
+end
+
+result = nil
+client = Nettica::Client.new(options.username, options.password)
+case options.command
+  when :list_zones
+    result = client.list_zones()
+  when :get_service_info
+    result = client.get_service_info()
+  when :list_domain
+    result = client.list_domain(options.domain.first)
+  when :update_record
+    drold = client.create_domain_record(options.domain.first, options.host.first, options.recordtype.first,
+                                     options.data.first, options.ttl.first, options.priority.first)
+    drnew = client.create_domain_record(options.domain[1] || options.domain.first,
+                                        options.host[1] || options.host.first,
+                                        options.recordtype[1] || options.recordtype.first,
+                                        options.data[1] || options.data.first,
+                                        options.ttl[1] || options.ttl.first,
+                                        options.priority[1] || options.priority.first)
+    result = client.update_record(drold, drnew)
+  when :delete_record
+    dr = client.create_domain_record(options.domain.first, options.host.first, options.recordtype.first,
+                                     options.data.first, options.ttl.first, options.priority.first)
+    result = client.delete_record(dr)
+  when :apply_template
+    result = client.apply_template(options.domain.first, options.group)
+  when :create_secondary_zone
+    result = client.create_secondary_zone(options.domain.first, options.master, options.ip)
+  when :delete_zone
+    result = client.delete_zone(options.domain.first)
+  when :create_zone
+    result = client.create_zone(options.domain.first)
+  when :add_record
+    dr = client.create_domain_record(options.domain.first, options.host.first, options.recordtype.first,
+                                     options.data.first, options.ttl.first, options.priority.first)
+    result = client.add_record(dr)
+end
+
+puts result.inspect

data/lib/nettica.rb

@@ -0,0 +1,3 @@
+class Nettica
+  VERSION = '0.3.0'
+end

data/lib/nettica/client.rb

@@ -0,0 +1,99 @@
+require 'rubygems'
+gem 'soap4r'
+require "nettica/stubs/netticaDriver"
+require 'base64'
+
+# http://dev.ctor.org/soap4r
+# http://markthomas.org/2007/09/12/getting-started-with-soap4r/
+# wsdl2ruby.rb --module_path Nettica::Stubs --wsdl 'https://www.nettica.com/DNS/DnsApi.asmx?WSDL' --type client --classdef nettica --force
+
+module Nettica
+
+  class Client
+
+    include Nettica::Stubs
+
+    def initialize(username, password)
+      @username = username
+      @password = Base64.encode64(password).strip
+      @proxy = DnsApiAsmxSoap.new
+    end
+
+
+    #   domainName - SOAP::SOAPString
+    #   hostName - SOAP::SOAPString
+    #   recordType - SOAP::SOAPString
+    #   data - SOAP::SOAPString
+    #   ttl - SOAP::SOAPInt
+    #   priority - SOAP::SOAPInt
+    def create_domain_record(domainName = nil, hostName = nil, recordType = nil, data = nil, ttl = 0, priority = 0)
+      valid_ttls = [0, 1, 60, 300, 600, 900, 1800, 2700, 3600, 7200, 14400, 28800, 43200, 64800, 86400, 172800]
+      raise "Ttl must be one of #{valid_ttls.join(',')}" if ttl && ! valid_ttls.include?(ttl)
+
+      mx_prio = [5, 10, 20, 30, 40, 50, 60, 70, 80, 90]
+      f_prio = [1, 2, 3]
+      raise "MX priority must be one of #{mx_prio.join(',')}" if recordType == "MX" and ! mx_prio.include?(priority)
+      raise "F priority must be one of #{f_prio.join(',')}" if recordType == "F" and ! f_prio.include?(priority)
+
+      valid_types = ["A", "CNAME", "MX", "F", "TXT", "SRV"]
+      raise "Record type must be one of #{valid_types.join(',')}" if recordType && ! valid_types.include?(recordType)
+
+      DomainRecord.new(domainName, hostName, recordType, data, ttl, priority)
+    end
+
+    def decode_status(result)
+      case result.result.status
+        when 200 then "Success"
+        when 401 then "Access Denied"
+        when 404 then "Not Found"
+        when 430 then "Domain Exists"
+        when 431 then "Record already exists"
+        when 432 then "Invalid record type.  Must be A, CNAME, MX, F, TXT, SRV"
+        when 450 then "No Service"
+        when 451 then "No credits"
+        when 460 then "Your service has expired"
+      end
+    end
+
+    def update_record(old_domain_record, new_domain_record)
+      @proxy.updateRecord(UpdateRecord.new(@username, @password, old_domain_record, new_domain_record)).updateRecordResult
+    end
+
+    def delete_record(domain_record)
+      @proxy.deleteRecord(DeleteRecord.new(@username, @password, domain_record)).deleteRecordResult
+    end
+
+    def list_zones()
+      @proxy.listZones(ListZones.new(@username, @password)).listZonesResult
+    end
+
+    def apply_template(domainName, groupName)
+      @proxy.applyTemplate(ApplyTemplate.new(@username, @password, domainName, groupName)).applyTemplateResult
+    end
+
+    def list_domain(domainName)
+      @proxy.listDomain(ListDomain.new(@username, @password, domainName)).listDomainResult
+    end
+
+    def create_secondary_zone(domainName, master, ipAddress)
+      @proxy.createSecondaryZone(CreateSecondaryZone.new(@username, @password, domainName, master, ipAddress)).createSecondaryZoneResult
+    end
+
+    def get_service_info()
+      @proxy.getServiceInfo(GetServiceInfo.new(@username, @password)).getServiceInfoResult
+    end
+
+    def delete_zone(domainName)
+      @proxy.deleteZone(DeleteZone.new(@username, @password, domainName)).deleteZoneResult
+    end
+
+    def create_zone(domainName)
+      @proxy.createZone(CreateZone.new(@username, @password, domainName, "")).createZoneResult
+    end
+
+    def add_record(domain_record)
+      @proxy.addRecord(AddRecord.new(@username, @password, domain_record)).addRecordResult
+    end
+  end
+
+end

data/lib/nettica/stubs/DnsApiAsmxClient.rb

@@ -0,0 +1,136 @@
+#!/usr/bin/env ruby
+require 'nettica/stubs/netticaDriver.rb'
+
+
+module Nettica::Stubs
+
+endpoint_url = ARGV.shift
+obj = DnsApiAsmxSoap.new(endpoint_url)
+
+# run ruby with -d to see SOAP wiredumps.
+obj.wiredump_dev = STDERR if $DEBUG
+
+# SYNOPSIS
+#   GetServiceInfo(parameters)
+#
+# ARGS
+#   parameters      GetServiceInfo - {http://www.nettica.com/DNS/DnsApi}GetServiceInfo
+#
+# RETURNS
+#   parameters      GetServiceInfoResponse - {http://www.nettica.com/DNS/DnsApi}GetServiceInfoResponse
+#
+parameters = nil
+puts obj.getServiceInfo(parameters)
+
+# SYNOPSIS
+#   CreateZone(parameters)
+#
+# ARGS
+#   parameters      CreateZone - {http://www.nettica.com/DNS/DnsApi}CreateZone
+#
+# RETURNS
+#   parameters      CreateZoneResponse - {http://www.nettica.com/DNS/DnsApi}CreateZoneResponse
+#
+parameters = nil
+puts obj.createZone(parameters)
+
+# SYNOPSIS
+#   CreateSecondaryZone(parameters)
+#
+# ARGS
+#   parameters      CreateSecondaryZone - {http://www.nettica.com/DNS/DnsApi}CreateSecondaryZone
+#
+# RETURNS
+#   parameters      CreateSecondaryZoneResponse - {http://www.nettica.com/DNS/DnsApi}CreateSecondaryZoneResponse
+#
+parameters = nil
+puts obj.createSecondaryZone(parameters)
+
+# SYNOPSIS
+#   DeleteZone(parameters)
+#
+# ARGS
+#   parameters      DeleteZone - {http://www.nettica.com/DNS/DnsApi}DeleteZone
+#
+# RETURNS
+#   parameters      DeleteZoneResponse - {http://www.nettica.com/DNS/DnsApi}DeleteZoneResponse
+#
+parameters = nil
+puts obj.deleteZone(parameters)
+
+# SYNOPSIS
+#   ListZones(parameters)
+#
+# ARGS
+#   parameters      ListZones - {http://www.nettica.com/DNS/DnsApi}ListZones
+#
+# RETURNS
+#   parameters      ListZonesResponse - {http://www.nettica.com/DNS/DnsApi}ListZonesResponse
+#
+parameters = nil
+puts obj.listZones(parameters)
+
+# SYNOPSIS
+#   ListDomain(parameters)
+#
+# ARGS
+#   parameters      ListDomain - {http://www.nettica.com/DNS/DnsApi}ListDomain
+#
+# RETURNS
+#   parameters      ListDomainResponse - {http://www.nettica.com/DNS/DnsApi}ListDomainResponse
+#
+parameters = nil
+puts obj.listDomain(parameters)
+
+# SYNOPSIS
+#   AddRecord(parameters)
+#
+# ARGS
+#   parameters      AddRecord - {http://www.nettica.com/DNS/DnsApi}AddRecord
+#
+# RETURNS
+#   parameters      AddRecordResponse - {http://www.nettica.com/DNS/DnsApi}AddRecordResponse
+#
+parameters = nil
+puts obj.addRecord(parameters)
+
+# SYNOPSIS
+#   UpdateRecord(parameters)
+#
+# ARGS
+#   parameters      UpdateRecord - {http://www.nettica.com/DNS/DnsApi}UpdateRecord
+#
+# RETURNS
+#   parameters      UpdateRecordResponse - {http://www.nettica.com/DNS/DnsApi}UpdateRecordResponse
+#
+parameters = nil
+puts obj.updateRecord(parameters)
+
+# SYNOPSIS
+#   DeleteRecord(parameters)
+#
+# ARGS
+#   parameters      DeleteRecord - {http://www.nettica.com/DNS/DnsApi}DeleteRecord
+#
+# RETURNS
+#   parameters      DeleteRecordResponse - {http://www.nettica.com/DNS/DnsApi}DeleteRecordResponse
+#
+parameters = nil
+puts obj.deleteRecord(parameters)
+
+# SYNOPSIS
+#   ApplyTemplate(parameters)
+#
+# ARGS
+#   parameters      ApplyTemplate - {http://www.nettica.com/DNS/DnsApi}ApplyTemplate
+#
+# RETURNS
+#   parameters      ApplyTemplateResponse - {http://www.nettica.com/DNS/DnsApi}ApplyTemplateResponse
+#
+parameters = nil
+puts obj.applyTemplate(parameters)
+
+
+
+
+end