zerigodns 1.0.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Tom Wilson
+
+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,29 @@
+require 'rubygems'
+require 'rake'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+RSpec::Core::RakeTask.new(:spec)
+
+task :build do
+  %x{gem build zerigodns.gemspec}
+end
+
+task :doc do
+  %x{yard doc}
+end
+
+task :default => :spec
+task :default => :build
+task :default => :doc
+
+
+# require 'rdoc/task'
+# RDoc::Task.new do |rdoc|
+#   version = File.exist?('VERSION') ? File.read('VERSION') : ""
+# 
+#   rdoc.rdoc_dir = 'rdoc'
+#   rdoc.title = "zerigo_dns #{version}"
+#   rdoc.rdoc_files.include('README*')
+#   rdoc.rdoc_files.include('lib/**/*.rb')
+# end

data/lib/activeresource-ext.rb

@@ -0,0 +1,43 @@
+require 'active_resource'
+require 'active_support/core_ext/module'
+
+module ActiveResource
+  module CaptureHeaders
+    module InstanceMethods
+      private
+      def request_with_headers(method, path, *arguments)
+        request_without_headers(method, path, *arguments).tap do |resp|
+          @headers = resp.to_hash
+        end
+      end
+
+    end
+
+    def self.included(receiver)
+      receiver.class_eval do
+        include InstanceMethods
+        alias_method_chain :request, :headers
+        attr :headers
+      end
+    end
+  end
+  
+  module RetrieveHeaders
+    module InstanceMethods
+      def last_count
+        @last_count ||= (c = connection.headers['x-query-count']) ? c[0].to_i : nil
+      end
+      
+    end
+    
+    def self.included(receiver)
+      receiver.class_eval do
+        include InstanceMethods
+      end
+    end
+  end
+  
+end
+
+ActiveResource::Connection.send :include, ActiveResource::CaptureHeaders
+ActiveResource::Base.send :include, ActiveResource::RetrieveHeaders

data/lib/zerigodns/base.rb

@@ -0,0 +1,47 @@
+module ZerigoDNS
+  class Base < ActiveResource::Base
+    class << self
+      attr_reader :secure
+      alias_method :api_key, :password
+      alias_method :api_key=, :password=
+      def secure=(bool)
+        @secure=bool
+        self.site = @secure ? 'https://ns.zerigo.com/api/1.1/' : 'http://ns.zerigo.com/api/1.1/'
+      end
+    end
+    
+    self.site='https://ns.zerigo.com/api/1.1/'
+    self.timeout = 5 # timeout after 5 seconds
+    self.format = ActiveResource::Formats::XmlFormat
+    @secure = true
+    
+    
+    
+    # fix load() so that it no longer clobbers @prefix_options
+    # also fix bug exposed by reload() where attributes is effectively parsed twice, causing the first line to raise an exception the 2nd time
+    def load(attributes, remove_root = false)
+      raise ArgumentError, "expected an attributes Hash, got #{attributes.inspect}" unless attributes.is_a?(Hash)
+      new_prefix_options, attributes = split_options(attributes)
+      @prefix_options.merge!(new_prefix_options)
+      attributes.each do |key, value|
+        @attributes[key.to_s] =
+          case value
+          when Array
+            if value.all?{|v2| v2.kind_of?(ActiveResource::Base)}
+              value.dup rescue value
+            else
+              resource = find_or_create_resource_for_collection(key)
+              value.map { |attrs| attrs.is_a?(String) ? attrs.dup : resource.new(attrs) }
+            end
+          when Hash
+            resource = find_or_create_resource_for(key)
+            resource.new(value)
+          else
+            value.dup rescue value
+          end
+      end
+      self
+    end
+  end
+end
+

data/lib/zerigodns/config.rb

@@ -0,0 +1,18 @@
+module ZerigoDNS
+  #@attr [String] api_key The Api key generated by Zerigo DNS
+  #@attr [String] user Your e-mail address
+  #@attr [Boolean] secure Whether to use HTTPS
+  class Config
+    
+    BASE_ATTRIBUTES = %w(api_key site secure user password)
+      BASE_ATTRIBUTES.each do |attr|
+        define_method attr do
+          ZerigoDNS::Base.send(attr)
+        end
+        
+        define_method "#{attr}=" do |val|
+          ZerigoDNS::Base.send("#{attr}=", val)
+        end
+      end
+  end
+end

data/lib/zerigodns/host.rb

@@ -0,0 +1,59 @@
+class ZerigoDNS::Host < ZerigoDNS::Base
+  class << self
+    
+    # Find host record(s) by zone and hostname
+    # @param [Symbol, #read] which One of :one, :first, :last, or :all.  See http://api.rubyonrails.org/v3.2.1/classes/ActiveResource/Base.html#method-c-find
+    # @param [Zone, #read] zone The zone from which to find the host record.
+    # @param [String, #read] hostname The hostname to find.
+    # @return Host records, or an empty list if no records found.
+    def find_by_zone_and_hostname which, zone, hostname
+      fqdn = [hostname, zone.domain].select(&:present?).join('.')
+      find(which, params: {fqdn: fqdn, zone_id: zone.id})
+    end
+    
+    def find_all_by_hostname zone, hostname
+      find_by_zone_and_hostname(:all, zone, hostname)
+    end
+    
+    # @return [Host] The record found, or nil.
+    def find_first_by_hostname zone, hostname
+      find_by_zone_and_hostname(:all, zone, hostname).try(:first)
+    end
+    
+    # Update or Create Host for a zone
+    # This method will only update the _first_ record. 
+    # @param [Zone, #read] zone The zone to which the host belongs
+    # @param [String, #read] hostname The hostname
+    # @param [String, #read] type The type of record (e.g 'CNAME')
+    # @param [Fixnum, #read] ttl The TTL of the record, in seconds.
+    # @param [String, #read] data The data field of the record.
+    # @return [Host] The created or updated host.
+    def update_or_create(zone, hostname, type, ttl, data)
+      host = find_first_by_hostname(zone, hostname)
+      if host
+        host.update_record(type,ttl,data)
+      else
+        host = create(
+          :zone_id    => zone.id, 
+          :hostname   => hostname,
+          :host_type  => type,
+          :data       => data,
+          :ttl        => ttl
+        )
+      end  
+      host
+    end
+  end
+  
+  # Convienence method to update the record.
+  # @param [String, #read] type
+  # @param [String, #read] ttl 
+  # @param [String, #read] data
+  # @return [Boolean, #read] True if saved, false otherwise.
+  def update_record type, ttl, data
+    self.host_type  = type
+    self.data       = data
+    self.ttl        = ttl
+    save
+  end
+end

data/lib/zerigodns/host_template.rb

@@ -0,0 +1,9 @@
+class ZerigoDNS::HostTemplate < ZerigoDNS::Base
+  
+  # Fetches the zone template to which the host template belongs.
+  # @return [ZoneTemplate] The zone template to which the host template belongs.
+  # @raise [ActiveResource::ResourceNotFound] if the zone template does not exist.
+  def zone_template
+    @zone_template ||= ZerigoDNS::ZoneTemplate.find(zone_template_id)
+  end
+end

data/lib/zerigodns/tools.rb

@@ -0,0 +1,23 @@
+class ZerigoDNS::Tools < ZerigoDNS::Base
+  class <<self
+    
+    # Fetch current public ipv4 address
+    # @return [String] Current public ipv4 address or "unknown"
+    def public_ipv4
+      get :public_ipv4
+    end
+    
+    # Fetch current public ipv6 address
+    # @return [String] Current public ipv6 address or "unknown"
+    def public_ipv6
+      get :public_ipv6
+    end
+    
+    # Fetch the current public IP address (either ipv4 or ipv6)
+    # @return [String] Current public ip address (ipv4 or ipv6)
+    def public_ip
+      get :public_ip
+    end
+  end
+
+end

data/lib/zerigodns/zone.rb

@@ -0,0 +1,32 @@
+class ZerigoDNS::Zone < ZerigoDNS::Base
+  class <<self
+    # Get count of all zones
+    # @return [Fixnum] Count of all zones
+    def count
+      get(:count).to_i
+    end
+    
+    # Find zone by domain name
+    # @param [String, #read] domain the domain to retrieve
+    # @raise ActiveResource::ResourceNotFound if the domain is not present.
+    # @return [Zone] the domain retrieved.
+    def find_by_domain(domain)
+      find(domain)
+    end
+    
+    # Find or Create Zone
+    # @param [String, #read] domain name of domain to create
+    # @return [Zone] the zone found or created.
+    def find_or_create(domain)
+      find_by_domain(domain)
+    rescue ActiveResource::ResourceNotFound
+      create(:domain=> domain, :ns_type=>'pri_sec')
+    end
+  end
+  
+  # Get count of all hosts belonging to this zone
+  # @return [Fixnum] Count of all hosts belonging to this zone.
+  def count_hosts
+    get('hosts/count').to_i
+  end
+end

data/lib/zerigodns/zone_template.rb

@@ -0,0 +1,39 @@
+class ZerigoDNS::ZoneTemplate < ZerigoDNS::Base
+  
+  # Get count of zone templates
+  # @return [Fixnum] the count of zone templates
+  def self.count
+    get(:count).to_i
+  end
+  
+  # Get count of host templates
+  # @return [Fixnum] the count of host templates for this zone template
+  def count_host_templates
+    get('host_templates/count').to_i
+  end
+  
+  # Create a zone using the zone template
+  # @param [Hash, #read] attrs Attributes of the zone to be created
+  # @option attrs domain [String, #read] The domain name
+  # @option attrs follow_template [String, #read] ('follow')
+  #   * 'follow'  The zone will reflect updates made to the template.
+  #   * 'no'  The zone will be a one-time copy of the template.
+  # 
+  #   Due to a problem with XML conversion, the value assigned to follow_template must be a string and not a symbol.
+  # @return [Zone] The created zone
+  def create_zone attrs
+    ZerigoDNS::Zone.create({follow_template: 'follow', zone_template_id: id}.merge(attrs))
+  end
+  
+  # List all host templates of this zone template
+  # @return [Array] An array of host templates
+  def host_templates
+    @host_templates ||= ZerigoDNS::HostTemplate.find(:all, params: {zone_template_id: id})
+  end
+  
+  # Create a host template for this template
+  # @param [Hash, #read] attrs Attributes of the host template to be created
+  def create_host_template attrs={}
+    ZerigoDNS::HostTemplate.create(attrs.merge(zone_template_id: id))
+  end
+end

data/lib/zerigodns.rb

@@ -0,0 +1,29 @@
+# Copyright 2009 Zerigo, Inc.  See MIT-LICENSE for license information.
+# Visit http://www.zerigo.com/docs/managed-dns for updates and documentation.
+require 'activeresource-ext'
+require 'zerigodns/base'
+require 'zerigodns/config'
+require 'zerigodns/host'
+require 'zerigodns/zone'
+require 'zerigodns/zone_template'
+require 'zerigodns/host_template'
+require 'zerigodns/tools'
+
+module ZerigoDNS
+  class <<self
+    ## Instantiates and memoizes a new +Config+ object
+    #
+    # @return [Config] the cached configuration instance
+    def config
+      @config ||= Config.new
+    end
+    
+    
+    # Exposes a block with the +Config+ instance
+    #
+    # @yield [Config] the config instance
+    def configure
+      yield config
+    end
+  end
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: zerigodns
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Tom Wilson
+- Zerigo Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activeresource
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.7.6
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.99'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.1
+- !ruby/object:Gem::Dependency
+  name: zerigodns
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for interacting with the Zerigo DNS REST API.
+email: support@zerigo.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE
+files:
+- LICENSE
+- Rakefile
+- lib/activeresource-ext.rb
+- lib/zerigodns/base.rb
+- lib/zerigodns/config.rb
+- lib/zerigodns/host.rb
+- lib/zerigodns/host_template.rb
+- lib/zerigodns/tools.rb
+- lib/zerigodns/zone.rb
+- lib/zerigodns/zone_template.rb
+- lib/zerigodns.rb
+homepage: http://github.com/8x8Cloud/zerigo_dns
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Zerigo DNS Gem
+test_files: []
+has_rdoc: