ultradns-sdk 0.0.2

data/lib/ultradns/api/client_accessor.rb

@@ -0,0 +1,23 @@
+
+class Ultradns::Api::ClientAccessor
+
+  def initialize(client)
+    @client = client
+    if client.kind_of?(Ultradns::Api::ClientAccessor)
+      @client = client.client
+    end
+  end
+
+  protected
+  #########
+
+  def client
+    @client
+  end
+
+  def request_options(params = {})
+    @client.send :request_options, params
+  end
+
+
+end

data/lib/ultradns/api/rrset.rb

@@ -0,0 +1,112 @@
+# Copyright 2000-2014 NeuStar, Inc. All rights reserved.
+# NeuStar, the Neustar logo and related names and logos are registered
+# trademarks, service marks or tradenames of NeuStar, Inc. All other
+# product names, company names, marks, logos and symbols may be trademarks
+# of their respective owners.
+
+require_relative 'client_accessor'
+
+class Ultradns::Api::Rrset < Ultradns::Api::ClientAccessor
+
+  attr_reader :rtype, :owner_name
+
+  def initialize(zone, rtype, owner_name)
+    super(zone)
+    @zone_name = zone.zone_name
+    @rtype = rtype
+    @owner_name = owner_name
+  end
+
+
+  # Creates a new RRSet in the specified zone.
+  #
+  # === Required Parameters
+  #
+  # * +zone_name+ - The zone that contains the RRSet.The trailing dot is optional.
+  # * +rtype+ - The type of the RRSet.This can be numeric (1) or
+  #             if a well-known name is defined for the type (A), you can use it instead.
+  # * +owner_name+ - The owner name for the RRSet.
+  #                  If no trailing dot is supplied, the owner_name is assumed to be relative (foo).
+  #                  If a trailing dot is supplied, the owner name is assumed to be absolute (foo.zonename.com.)
+  # * +ttl+ - The updated TTL value for the RRSet.
+  # * +rdata+ - The updated BIND data for the RRSet as a string.
+  #             If there is a single resource record in the RRSet, you can pass in the single string or an array with a single element.
+  #             If there are multiple resource records in this RRSet, pass in a list of strings.
+  #
+  # === Examples
+  #
+  #     c.zone('zone.invalid.').rrset('A', 'foo').create(300, '1.2.3.4')
+  def create(ttl, rdata)
+    rrset = {:ttl => ttl, :rdata => rdata}
+    rrset[:rdata] = [rdata] unless rdata.kind_of? Array
+    client.with_auth_retry {|c| c.post rrset_path, request_options({body: rrset.to_json}) }
+  end
+
+
+  # List all RRSets for this rtype and owner_name
+  def list
+    client.with_auth_retry {|c| c.get rrset_path, request_options }
+  end
+
+  # (Partially) Updates an existing RRSet for this rtype and owner_name in this zone
+  #
+  # === Required Parameters
+  #
+  # * +ttl+ - The updated TTL value for the RRSet.
+  # * +rdata+ - The updated BIND data for the RRSet as a string.
+  #             If there is a single resource record in the RRSet, you can pass in the single string or an array with a single element.
+  #             If there are multiple resource records in this RRSet, pass in a list of strings.
+  #                                                                                                                                                                                                                #
+  # === Examples
+  #
+  #     c.update('zone.invalid.', "A", "foo", 100, ["10.20.30.40"])
+  def update(ttl, rdata = nil)
+    rrset = {}
+    rrset[:ttl] = ttl if ttl != nil
+    rrset[:rdata] = (rdata.kind_of?(Array) ? rdata : [rdata]) if rdata != nil
+
+    client.with_auth_retry {|c| c.patch rrset_path, request_options({body: rrset.to_json}) }
+  end
+
+  # Updates (by replacing) an existing RRSet for this rtype and owner_name in this zone
+  def replace()
+  end
+
+
+  # Delete an rrset
+  #
+  # === Required Parameters
+  # * +zone_name+ - The zone containing the RRSet to be deleted.  The trailing dot is optional.
+  # * +rtype+ - The type of the RRSet.This can be numeric (1) or if a well-known name
+  #              is defined for the type (A), you can use it instead.
+  # * +owner_name+ - The owner name for the RRSet.
+  #                   If no trailing dot is supplied, the owner_name is assumed to be relative (foo).
+  #                   If a trailing dot is supplied, the owner name is assumed to be absolute (foo.zonename.com.)
+  #
+  # === Examples
+  #
+  #     c.delete_rrset(first_zone_name, 'A', 'foo')
+  def delete
+    client.with_auth_retry {|c| c.delete rrset_path, request_options }
+  end
+
+  #
+  # def profiles
+  #   list()
+  # end
+
+  # Set the profile for the matching rrsets
+  #
+  def profile(options)
+    client.with_auth_retry {|c| c.patch rrset_path, request_options({body: {profile: options}.to_json}) }
+  end
+
+
+  protected
+  #########
+
+  def rrset_path()
+    "/zones/#{@zone_name}/rrsets/#{@rtype}/#{@owner_name}"
+  end
+
+end

data/lib/ultradns/api/zone.rb

@@ -0,0 +1,137 @@
+# Copyright 2000-2014 NeuStar, Inc. All rights reserved.
+# NeuStar, the Neustar logo and related names and logos are registered
+# trademarks, service marks or tradenames of NeuStar, Inc. All other
+# product names, company names, marks, logos and symbols may be trademarks
+# of their respective owners.
+
+require_relative 'client_accessor'
+
+class Ultradns::Api::Zone < Ultradns::Api::ClientAccessor
+
+  attr_reader :zone_name
+
+  def initialize(client, zone_name)
+    super(client)
+    @zone_name = zone_name
+  end
+
+  # Get zone metadata
+  #
+  # === Examples
+  #
+  #     c.zone('foo.invalid.').metadata
+  def metadata
+    client.with_auth_retry {|c| c.get "/zones/#{@zone_name}", request_options }
+  end
+
+  # Create a zone
+  #
+  # === Required Parameters
+  #
+  # * +account_name+ - The account that the zone will be created under.  The user must have write access for zones in that account.
+  #
+  # === Optional Parameters
+  #
+  # * +type+ - The type of zone to be created, one of three possible values: PRIMARY,  SECONDARY, or ALIAS.
+  #
+  # See documentation section: Primary Zone DTO or Secondary Zone DTO for further options.
+  # === Examples
+  #
+  #     c.create('my_account')
+  def create(account_name, options = {})
+    zone_properties = {name: @zone_name, accountName: account_name, type: 'PRIMARY'}
+
+    primary_zone_info = {}
+    if options[:properties][:type] == 'PRIMARY' || options[:properties][:type] == nil
+      primary_zone_info = {forceImport: true, createType: 'NEW'}
+    end
+
+    zone_data = {properties: zone_properties,
+                 primaryCreateInfo: primary_zone_info}.merge(options)
+
+    with_auth_retry {|c| c.post '/zones', request_options({body: zone_data.to_json}) }
+  end
+
+  # Delete a zone
+  #
+  # === Examples
+  #
+  #     c.zone('foo.invalid.').delete
+  def delete
+    client.with_auth_retry {|c| c.delete "/zones/#{@zone_name}", request_options }
+  end
+
+
+
+  # Returns the list of RRSets in the specified zone of the (optional) specified type.
+  #
+  # === Optional Parameters
+  #
+  # * +rtype+ - The type of the RRSets.  This can be numeric (1) or
+  #             if a well-known name is defined for the type (A), you can use it instead.
+  #
+  # === Optional Parameters
+  #
+  # * +:q+ - The search parameters, in a hash.  Valid keys are:
+  #          ttl - must match the TTL for the rrset
+  #          owner - substring match of the owner name
+  #          value - substring match of the first BIND field value
+  # * +:sort+ - The sort column used to order the list. Valid values for the sort field are:
+  #             OWNER
+  #             TTL
+  #             TYPE
+  # * +:reverse+ - Whether the list is ascending(false) or descending(true).  Defaults to true
+  # * +:offset+ - The position in the list for the first returned element(0 based)
+  # * +:limit+ - The maximum number of zones to be returned.
+  #
+  # === Examples
+  #
+  #     c.zone('foo.invalid.').rrsets() # all types returned
+  #     c.zone('foo.invalid.').rrsets('A')
+  #     c.zone('foo.invalid.').rrsets('TXT', q: {value: 'cheese', ttl:300}, offset:5, limit:10)
+  def rrsets(rtype = nil, options={})
+    rrsets_path = "/zones/#{@zone_name}/rrsets"
+    rrsets_path += "/#{rtype}" if rtype != nil
+
+    client.with_auth_retry {|c| c.get(rrsets_path, request_options(options)) }
+  end
+
+
+  # === Required Parameters
+  # * +rtype+ - The type of the RRSet.This can be numeric (1) or if a well-known name
+  #              is defined for the type (A), you can use it instead.
+  # * +owner_name+ - The owner name for the RRSet.
+  #                   If no trailing dot is supplied, the owner_name is assumed to be relative (foo).
+  #                   If a trailing dot is supplied, the owner name is assumed to be absolute (foo.zonename.com.)
+  #
+  # === Examples
+  #
+  #     c.rrset('A', 'foo')
+  def rrset(rtype, owner_name)
+    Ultradns::Api::Rrset.new(self, rtype, owner_name)
+  end
+
+  # Creates a new RRSet in the specified zone.
+  #
+  # === Required Parameters
+  #
+  # * +zone_name+ - The zone that contains the RRSet.The trailing dot is optional.
+  # * +rtype+ - The type of the RRSet.This can be numeric (1) or
+  #             if a well-known name is defined for the type (A), you can use it instead.
+  # * +owner_name+ - The owner name for the RRSet.
+  #                  If no trailing dot is supplied, the owner_name is assumed to be relative (foo).
+  #                  If a trailing dot is supplied, the owner name is assumed to be absolute (foo.zonename.com.)
+  # * +ttl+ - The updated TTL value for the RRSet.
+  # * +rdata+ - The updated BIND data for the RRSet as a string.
+  #             If there is a single resource record in the RRSet, you can pass in the single string or an array with a single element.
+  #             If there are multiple resource records in this RRSet, pass in a list of strings.
+  #
+  # === Examples
+  #
+  #     c.zone('zone.invalid.').create_rrset('A', 'foo', 300, '1.2.3.4')
+  def create_rrset(rtype, owner_name, ttl, rdata)
+    rrset(rtype, owner_name).create(ttl, rdata)
+  end
+
+
+end

data/lib/ultradns/client.rb

@@ -0,0 +1,185 @@
+# Copyright 2000-2014 NeuStar, Inc. All rights reserved.
+# NeuStar, the Neustar logo and related names and logos are registered
+# trademarks, service marks or tradenames of NeuStar, Inc. All other
+# product names, company names, marks, logos and symbols may be trademarks
+# of their respective owners.
+
+require 'httparty'
+require 'logger'
+
+require_relative 'api/authentication'
+require_relative 'api/account'
+require_relative 'api/client_accessor'
+require_relative 'api/rrset'
+require_relative 'api/zone'
+
+class Ultradns::Client
+  include HTTParty
+  include Ultradns::Api::Authentication
+
+  disable_rails_query_string_format
+  default_timeout 30
+  open_timeout 10
+  read_timeout 10
+  headers({'Accept' => 'application/json', 'Content-Type' => 'application/json'})
+  format :json # force the format to json
+
+  # base uri for the service
+  base_uri 'https://restapi.ultradns.com/v1'
+
+  debug_output $stdout if ENV['DEBUG']
+
+
+  # Initialize an Ultra REST API client
+  #
+  # === Required Parameters
+  #
+  # * +username+ - The user name
+  # * +password+ - The user's password
+  #
+  # === Optional Parameters
+  #
+  # * +:use_http+ - Use http instead of https.  Defaults to false, set to true only in test environments.  Will not work in production.
+  # * +:host+ - host and port of the remote server.  Defaults to restapi.ultradns.com.
+  #
+  # === Examples
+  #
+  #     c = RestClient.new("myUname", "myPwd")
+  #     c = RestClient.new("myUname", "myPwd", host: 'restapi-useast1b01-01.ct.ultradns.net:8080')
+  def initialize(username, password, options = {})
+    @logger ||= ::Logger.new($stdout)
+
+    auth(username, password)
+
+    @options = {}
+    # override or ignored if nil
+    @options[:base_uri] = HTTParty.normalize_base_uri(options[:host]) if options[:host]
+
+    logger.debug "Initializing UltraDNS Client using #{@options.inspect}"
+  end
+
+
+
+  # Get version of REST API server
+  #
+  # === Examples
+  #
+  #     c.version
+  def version
+    with_auth_retry {|c| c.get '/version', request_options }
+  end
+
+
+  # Get status of REST API server
+  #
+  # === Examples
+  #
+  #     c.status
+  def status
+    with_auth_retry {|c| c.get '/status', request_options }
+  end
+
+
+  # Access Account Level Resources for the given account_name
+  #
+  # === Required Parameters
+  #
+  # * +account_name+ - One of the user's accounts.  The user must have read access for zones in that account.
+  #
+  def account(account_name)
+    Ultradns::Api::Account.new(self, account_name)
+  end
+
+  # Get account details for user
+  #
+  # === Examples
+  #
+  #     c.accounts
+  def accounts
+    with_auth_retry {|c| c.get '/accounts', request_options }
+  end
+
+
+  # === Required Parameters
+  #
+  # * +zone_name+ - The name of the zone.
+  #
+  def zone(zone_name)
+    Ultradns::Api::Zone.new(self, zone_name)
+  end
+
+
+  # Create a primary zone
+  #
+  # === Required Parameters
+  #
+  # * +account_name+ - The account that the zone will be created under.  The user must have write access for zones in that account.
+  # * +zone_name+ - The name of the zone.  The trailing . is optional.  The zone name must not be in use by anyone.
+  #
+  # === Examples
+  #
+  #     c.create_primary_zone('my_account', 'zone.invalid.')
+  def create_primary_zone(account_name, zone_name)
+    zone_properties = {:name => zone_name, :accountName => account_name, :type => 'PRIMARY'}
+    primary_zone_info = {:forceImport => true, :createType => 'NEW'}
+
+    zone_data = {:properties => zone_properties, :primaryCreateInfo => primary_zone_info}
+
+    with_auth_retry {|c| c.post '/zones', request_options({:body => zone_data.to_json}) }
+  end
+
+  # List the background tasks (jobs) running.  Some APIs will return a Task Id
+  # which can used to determine the state of those jobs.
+  #
+  # === Optional Parameters
+  #
+  # * +:q+ - The search parameters, in a hash. The query used to construct the list.
+  #          Valid keys are: 
+  #          code - valid values for 'code' are PENDING, IN_PROCESS, COMPLETE, and ERROR.
+  #          hasData - valid values for 'hasData' are true and false.
+  #
+  # * +offset+ - The position in the list for the first returned element (0 based). The
+  #              default value is 0.
+  #
+  # * +limit+ - The maximum number of rows requested. The default value is 100.
+  #
+  # * +sort+ - The sort column used to order the list. Valid sort fields are CODE, CONTENT_TYPE, EXTENSIONS,
+  #            HAS_DATA, and DATE. The default value is CODE.
+  #
+  # * +reverse+ - Whether the list is ascending (false) or descending (true). The default
+  #               value is false.
+  #
+  def tasks(options = {})
+    with_auth_retry {|c| c.get("/tasks", request_options(options)) }
+  end
+
+
+
+  protected
+  #########
+  def request_options(params = {})
+    add_auth_header!(params)
+    @options.merge(build_params(params))
+  end
+
+
+  def logger
+    @logger
+  end
+
+  def build_params(args)
+    params = {}
+    if args[:q]
+      q = args[:q]
+      q_str = ''
+      q.each { |k, v| q_str += "#{k}:#{v} " }
+      if q_str.length > 0
+        params[:q] = q_str
+      end
+      args.delete :q
+    end
+    params.update(args)
+    params
+  end
+
+end