dynectastic 0.2.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+
+## Bundler
+.bundle

data/CHANGES.rdoc

@@ -0,0 +1,9 @@
+= Changelog
+
+== 0.2.0
+
+* Added support for Jobs.
+
+== 0.1.2
+
+* Initial public release.

data/Gemfile

@@ -0,0 +1,5 @@
+# A sample Gemfile
+source "http://rubygems.org"
+
+gem "httparty", "~>0.6.1"
+gem "json", "~>1.4.6"

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    crack (0.1.8)
+    httparty (0.6.1)
+      crack (= 0.1.8)
+    json (1.4.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  httparty (~> 0.6.1)
+  json (~> 1.4.6)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ilya Sabanin
+
+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/README.rdoc

@@ -0,0 +1,120 @@
+= dynectastic
+
+Dynectastic is a nice wrapper for Dynect's REST API. Use it to manage Zones, Records and Nodes on your Dynect account.
+
+== Installation
+
+ gem install dynectastic
+ 
+== Requirements
+
+HTTParty 0.6.1
+
+== Usage
+
+First you need to create new Dynect session:
+
+ dynect = Dynectastic.session("dynect_customer_name", "dynect_login", "dynect_password")
+ 
+Make sure to create a separate login/password pair for your API client or it will interfere with your web interface browsing.
+
+Now you can use this "dynect" object to call various API methods.
+
+== Requests
+
+You can always access most recent request of a resource by calling last_request on it:
+
+ zone.freeze
+ zone.last_request # => #<Dynectastic::Request:...>
+ 
+Every request store it's response:
+
+ zone.last_request.response # => #<HTTParty::Response:...>
+
+== Jobs
+
+Every request to Dynect has a special Job assigned to it. You can access it like this:
+
+ zone.publish                    # => true
+ zone.last_request.job.id        # => 343245
+ zone.last_request.job.complete? # => true
+ 
+Sometimes a long running job can not be completed in time, so Dynectastic returns false as a result of your request:
+
+ zone.publish                    # => false
+ zone.last_request.job.id        # => 342626
+ zone.last_request.job.complete? # => false
+
+Since Dynect does not allow you to run several jobs simultaneously, sometimes your requests will return Dynectastic::SessionBusy exception.
+Luckily there is a built-in retry cycle for such exceptions: Dynectastic will sleep for a few seconds and retry your request 5 more times.
+
+== Zone examples
+
+With Dynectastic you can find, create, freeze, unfreeze, publish and destroy zones:
+ 
+ dynect.zones.build(
+   :name    => "newfancyzone.com",
+   :contact => "stalin@communismwilleventuallywin.com",
+   :ttl     => 1800
+ ).save
+ 
+ dynect.zones.find_all
+ 
+ zone = dynect.zones.find_by_name("newfancyzone.com")
+ 
+ zone.freeze
+ zone.frozen?
+ zone.unfreeze
+ 
+ zone.publish
+ zone.published?
+ 
+ zone.destroy
+ 
+Don't forget that you have to publish a zone every time you make any changes to it (for example when you add new record).
+
+== Record examples
+
+For now it's possible to find, create, update and delete records:
+
+ dynect.records.cname.build(
+   :zone => "newfancyzone.com",
+   :node => "new_node.newfancyzone.com", # will be created automatically
+   :ttl  => 1800,
+   :rdata => {
+     :cname => "something.somewhere.com"
+   }
+ ).save
+ 
+ dynect.records.cname.find_all(:zone => "newfancyzone.com", :node => "new_node.newfancyzone.com")
+ 
+ record = dynect.records.cname.find_by_id(0, :zone => "newfancyzone.com", :node => "new_node.newfancyzone.com")
+ 
+ record.rdata['cname'] = "some_other_thing.somewhere.com"
+ record.save
+ 
+ record.destroy
+ 
+Dynect will automatically create Node for your record if it's missing.
+
+You can use all other record types instead of "cname" such as "txt" or "a" or anything else.
+
+== Node examples
+
+The API only allow us to delete nodes, nothing else:
+
+ dynect.nodes.destroy("newfancyzone.com", "new_node.newfancyzone.com")
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Ilya Sabanin. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "dynectastic"
+    gem.summary = "Neat wrapper for Dynect REST API."
+    gem.description = "More or less complete set of tools for managing your Dynect zones, records and nodes via REST API."
+    gem.email = "ilya.sabanin@gmail.com"
+    gem.homepage = "http://github.com/iSabanin/dynectastic"
+    gem.authors = ["Ilya Sabanin"]
+    gem.add_dependency "httparty", ">= 0.6.1"
+    gem.add_development_dependency "shoulda", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "dynectastic #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.2.0

data/dynectastic.gemspec

@@ -0,0 +1,85 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{dynectastic}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Ilya Sabanin"]
+  s.date = %q{2010-11-01}
+  s.description = %q{More or less complete set of tools for managing your Dynect zones, records and nodes via REST API.}
+  s.email = %q{ilya.sabanin@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CHANGES.rdoc",
+     "Gemfile",
+     "Gemfile.lock",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "dynectastic.gemspec",
+     "lib/dynectastic.rb",
+     "lib/dynectastic/error_translator.rb",
+     "lib/dynectastic/errors.rb",
+     "lib/dynectastic/factories/node_factory.rb",
+     "lib/dynectastic/factories/record_factory.rb",
+     "lib/dynectastic/factories/zone_factory.rb",
+     "lib/dynectastic/job.rb",
+     "lib/dynectastic/record.rb",
+     "lib/dynectastic/request.rb",
+     "lib/dynectastic/resource.rb",
+     "lib/dynectastic/session.rb",
+     "lib/dynectastic/zone.rb",
+     "test/helper.rb",
+     "test/test_node_factory.rb",
+     "test/test_record.rb",
+     "test/test_record_factory.rb",
+     "test/test_request.rb",
+     "test/test_resource.rb",
+     "test/test_session.rb",
+     "test/test_zone.rb",
+     "test/test_zone_factory.rb"
+  ]
+  s.homepage = %q{http://github.com/iSabanin/dynectastic}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Neat wrapper for Dynect REST API.}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_node_factory.rb",
+     "test/test_record.rb",
+     "test/test_record_factory.rb",
+     "test/test_request.rb",
+     "test/test_resource.rb",
+     "test/test_session.rb",
+     "test/test_zone.rb",
+     "test/test_zone_factory.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+  end
+end
+

data/lib/dynectastic.rb

@@ -0,0 +1,26 @@
+require 'httparty'
+require 'json'
+
+module Dynectastic
+  
+  VERSION = '0.2.0'
+  API_URL = 'https://api2.dynect.net'
+  RETRIES = 5
+  
+  def self.session(customer_name, user_name, password)
+    Session.new(customer_name, user_name, password)
+  end
+  
+end
+
+require "dynectastic/errors"
+require "dynectastic/error_translator"
+require "dynectastic/request"
+require "dynectastic/resource"
+require "dynectastic/session"
+require "dynectastic/zone"
+require "dynectastic/record"
+require "dynectastic/job"
+require "dynectastic/factories/zone_factory"
+require "dynectastic/factories/node_factory"
+require "dynectastic/factories/record_factory"

data/lib/dynectastic/error_translator.rb

@@ -0,0 +1,22 @@
+module Dynectastic
+  
+  module ErrorTranslator
+  
+    extend self
+  
+    def translate_to_exception(dynect_msg)
+      info, source, code = dynect_msg['INFO'], dynect_msg['SOURCE'], dynect_msg['ERR_CD']
+      
+      case info
+      when /Credentials you entered did not match those in our database/i
+        return AuthenticationError.new(info, source, code)
+      when /This session already has a job running/i
+        return SessionBusy.new(info, source, code)
+      end
+      
+      DynectError.new(info, source, code)
+    end
+  
+  end
+  
+end

data/lib/dynectastic/errors.rb

@@ -0,0 +1,33 @@
+module Dynectastic
+  
+  class DynectError < Exception
+    
+    attr_reader :text, :source, :code
+    
+    def initialize(text, source, code)
+      @text, @source, @code = text, source, code      
+    end
+    
+    def message
+      %Q[#{ text }. (SOURCE: #{ source}; CODE: #{ code })]
+    end
+    
+  end
+  
+  class AuthenticationError < DynectError
+    
+    def message
+      "Credentials you entered did not match those in Dynect's database."
+    end
+    
+  end
+  
+  class SessionBusy < DynectError
+    
+    def message
+      "This session already has a job running. Try again later."
+    end
+    
+  end
+  
+end

data/lib/dynectastic/factories/node_factory.rb

@@ -0,0 +1,15 @@
+module Dynectastic
+  
+  class NodeFactory < Resource
+    
+    def destroy(zone, name)
+      delete("#{ entity_base }/#{ zone }/#{ name }")
+    end
+    
+    def entity_base
+      "/REST/Node"
+    end
+    
+  end
+  
+end