ultradns-sdk 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 06df7262ad8408d0307754d7d51b1e845526b0c9
+  data.tar.gz: abf75483f56211d0b1d56802a1f86651f2e3ad04
+SHA512:
+  metadata.gz: 9f0b2efaf5f1f4be7f77f3ba8c1f75785db4545710e9355f8ae4ce00ed01ccec2bb80802523523b546005ec868aa6b2c505a4bd298b034953a7198036db2636f
+  data.tar.gz: fb767fe0f818805642e1f0cb69881c47873b8abd5e63051be13d53bf222fc84cb49ab2d7173da0f43878a077a86a338b49f1ad41e08dc7b6675e06ca283c0534

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.1.0

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2014 NeuStar, Inc. All rights reserved.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,44 @@
+
+# UltraDNS SDK
+
+This SDK implements a subset of the UltraDNS functionality. It does not attempt to implement a client for all available UltraDNS REST API functionality.
+Adding additional functionality should be relatively straightforward, and any contributions from the UltraDNS community would be greatly appreciated.
+
+
+[![Build Status](https://travis-ci.org/ultradns/ultradns-sdk-ruby.svg?branch=master)](https://travis-ci.org/ultradns/ultradns-sdk-ruby)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ultradns-sdk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ultradns-sdk
+
+## Usage
+
+
+* Right now only basic records are supported and RD (Resource Distribution) Pools.
+
+
+## Future
+
+* Directional Pools
+* Mail Forwarding
+* Web Forwarding
+
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ultradns-sdk/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test*.rb', 'test/**/test*.rb']
+  t.verbose = true
+end
+
+task :default => [:test]

data/lib/ultradns.rb

@@ -0,0 +1,11 @@
+# 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.
+
+module Ultradns; module Api; end; end
+
+
+require_relative "ultradns/version"
+require_relative 'ultradns/client'

data/lib/ultradns/api/account.rb

@@ -0,0 +1,52 @@
+# 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::Account < Ultradns::Api::ClientAccessor
+
+  attr_reader :account_name
+
+  def initialize(client, account_name)
+    super(client)
+    @account_name = account_name
+  end
+
+
+  # List zones for this account
+  #
+  #
+  # === Optional Parameters
+  #
+  # * +:q+ - The search parameters, in a hash.  Valid keys are:
+  #          name - substring match of the zone name
+  #          zone_type - one of :
+  #              PRIMARY
+  #              SECONDARY
+  #              ALIAS
+  # * +:sort+ - The sort column used to order the list. Valid values for the sort field are:
+  #             NAME
+  #             ACCOUNT_NAME
+  #             RECORD_COUNT
+  #             ZONE_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
+  #
+  #     client.account('myaccount').zones
+  #     client.account('myaccount').zones(q: {name: 'foo', zone_type: 'PRIMARY'}, sort: 'NAME', reverse: true, offset:10, limit:50)
+  def zones(options={})
+    client.with_auth_retry {|c| c.get("/accounts/#{@account_name}/zones", request_options(options)) }
+  end
+
+  # List users for this account
+  def users()
+    client.with_auth_retry {|c| c.get "/accounts/#{@account_name}/users", request_options }
+  end
+
+end

data/lib/ultradns/api/authentication.rb

@@ -0,0 +1,107 @@
+# 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.
+
+module Ultradns::Api::Authentication
+
+
+  # Try a request and if there is an authentication failure, retry after
+  # refreshing the tokens.
+  #
+  # yields to the block with the class so that HTTParty class methods can be used.
+  # Example:  with_auth_retry {|c| c.get '/' }
+  def with_auth_retry(&block)
+    retries = 3
+    response = nil
+    while retries > 0
+      response = yield(self.class)
+      if auth_failure?(response)
+        refresh
+        retries = retries - 1
+        logger.info "authentication failure, retrying..." if retries > 0
+      else
+        retries = 0
+      end
+    end
+    response
+  end
+
+  def auth_failure?(response)
+    error_code = response.parsed_response["errorCode"] rescue nil
+    (response.code == 400 || response.code == 401) && error_code == 60001
+  end
+
+  def add_auth_header!(params)
+    refresh if params[:force_refresh]
+    (params[:headers] ||= {})['Authorization'] = "Bearer #{access_token}"
+    params
+  end
+
+  def auth(username, password)
+    @auth = {}
+    @auth[:requested_at] = Time.now.to_i
+    response = self.class.post('/authorization/token',
+      body: {
+        grant_type: 'password',
+        username: username,
+        password: password
+      },
+      headers: {
+        'Content-Type' => 'application/x-www-form-urlencoded'
+      }
+    )
+
+    body = response.parsed_response
+
+    logger.debug "Auth Response: #{response.inspect}"
+    raise "Authentication Error: #{response.body}" unless response.code == 200
+
+    # temp
+    @auth[:username] = username
+    @auth[:password] = password
+
+    @auth[:access_token] = body['accessToken']
+    @auth[:refresh_token] = body['refreshToken']
+    @auth[:expires_in] = body['expiresIn']
+  end
+
+  def no_expiry?
+    # no expires provided yet - TBD
+    @auth[:expires_in] == nil || @auth[:expires_in] == ''
+  end
+
+  def refresh?
+    (@auth[:requested_at] + @auth[:expires_in]) >= Time.now.to_i
+  end
+
+  def refresh
+    # expires not available, then reauth
+    return auth(@auth[:username], @auth[:password]) if no_expiry?
+
+    # not expired yet.
+    return unless refresh?
+
+    requested_at = Time.now.to_i
+    response = @client.post('/authorization/token') do |request|
+      request.params[:grant_type] = 'refresh_token'
+      request.params[:refreshToken] = @auth[:refresh_token]
+    end
+
+    logger.debug "Auth Refresh Response: #{response.inspect}"
+    raise "Token Refresh Error: #{response.body}" unless response.code == 200
+
+    body = response.parsed_response
+
+    @auth.clear # reset everything
+    @auth[:requested_at] = requested_at
+    @auth[:access_token] = body['accessToken']
+    @auth[:refresh_token] = body['refreshToken']
+    @auth[:expires_in] = body['expiresIn']
+  end
+
+  def access_token
+    @auth[:access_token]
+  end
+end