hetzner-api 0.0.1 → 0.0.2

data/README.rdoc

@@ -1,9 +1,38 @@
 = hetzner-api
 
-A HTTParty based wrapper for Hetzner.de's server management interface.
-see http://wiki.hetzner.de/index.php/Robot_Webservice for details.
+A HTTParty[http://httparty.rubyforge.org/] based wrapper for Hetzner.de's server management API.
+
+see http://wiki.hetzner.de/index.php/Robot_Webservice_en for details.
+
+== Installation
+
+<b>gem install hetzner-api</b> 
+
+(you may want to use sudo for that.)
+
+== Example
+
+<tt>h = Hetzner::API.new "username", "password"</tt>
+
+<tt>h.reset? "111.111.111.111"</tt>
+
+<tt>h.enable_rescue! "111.111.111.111", "linux", "64"</tt>
+
+<tt>h.reset! "111.111.111.111", :sw</tt>
+
+<tt>h.wol! "111.111.111.222"</tt>
+
+<tt>h.rdns! "111.111.111.222", "web100.falkenstein.de.example.com"</tt>
+
+== Readme (rdoc)
+
+<b>http://rdoc.info/github/rmoriz/hetzner-api</b>
+
+
+== WARNING!
+
+This is not an official Hetzner AG project.
 
-This is not an official Hetzner AG software!
 The gem and the author are not related to Hetzner AG!
 
 <b>Use at your very own risk! Satisfaction NOT guaranteed!</b>
@@ -11,3 +40,7 @@ The gem and the author are not related to Hetzner AG!
 == Copyright
 
 Copyright (c) 2010 Roland Moriz. See LICENSE for details.
+
+{Ruby on Rails Entwicklung}[http://moriz.de/] -> Moriz GmbH
+
+{Ruby on Rails Hosting}[http://rails.io/] -> Rails.io

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/rmoriz/hetzner-api"
     gem.authors = ["Roland Moriz"]
     gem.add_development_dependency "rspec", ">= 1.2.9"
+    gem.add_dependency "httparty", ">= 0.6.1"
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError
@@ -38,7 +39,7 @@ Rake::RDocTask.new do |rdoc|
   version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "hetzner #{version}"
+  rdoc.title = "hetzner-api #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/hetzner-api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hetzner-api}
-  s.version = "0.0.1"
+  s.version = "0.0.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Roland Moriz"]
-  s.date = %q{2010-09-02}
+  s.date = %q{2010-09-03}
   s.description = %q{A small, unofficial wrapper for Hetzner.de's API (server management)}
   s.email = %q{roland@rails.io}
   s.extra_rdoc_files = [
@@ -53,11 +53,14 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
     else
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
     end
   else
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
   end
 end
 

data/lib/api/boot.rb

@@ -1,6 +1,7 @@
 module Hetzner
   class API
     module Boot
+      # lists boot options for a given IP address/server or all servers of the account
       def boot?(ip = nil)
         path = "/boot"
         path << "/#{ip}" if ip

data/lib/api/failover.rb

@@ -1,12 +1,14 @@
 module Hetzner
   class API
     module Failover
+      # queries the failover status of one IP address or all failover IP addresses of the account
       def failover?(ip = nil)
         path = "/failover"
         path << "/#{ip}" if @ip
         perform_get path
       end
       
+      # redirects the failover_ip to another server ip
       def failover!(failover_ip, active_server_ip)
         path = "/rdns/#{failover_ip}"
         perform_post path, :query => { :active_server_ip => active_server_ip }

data/lib/api/rdns.rb

@@ -1,21 +1,27 @@
 module Hetzner
   class API
     module Rdns
+      # queries the reverse mapping status of one IP address
       def rdns?(ip)
         path = "/rdns/#{ip}"
         perform_get path
       end
       
+      # creates or updates a reverse mapping record.
+      # ptr contains a hostname
       def rdns!(ip, ptr)
         path = "/rdns/#{ip}"
         perform_post path, :query => { :ptr => ptr }
       end
       
+      # creates a reverse mapping record. fails if already one exists
+      # ptr contains a hostname
       def initialize_rdns!(ip, ptr)
         path = "/rdns/#{ip}"
         perform_put path, :query => { :ptr => ptr }
       end
       
+      # delete the reverse mapping of one IP address
       def delete_rdns!(ip)
         path = "/rdns/#{ip}"
         perform_delete path

data/lib/api/rescue.rb

@@ -1,10 +1,16 @@
 module Hetzner
   class API
     module Rescue
+      # enables the rescue systm for given IP address/server using <em>os</em> (operating system) and <em>arch</em> (architecture)
+      #
+      # see <em>boot?</em> method to query the API for available options
+      #
+      # defaults to 64bit Linux
       def enable_rescue!(ip, os = 'linux', arch = '64')
         perform_post "/boot/#{ip}/rescue", :query => { :os => os, :arch => arch }
       end
       
+      # disables the rescue system for a given IP address/server
       def disable_rescue!(ip)
         perform_delete "/boot/#{ip}/rescue"
       end

data/lib/api/reset.rb

@@ -1,12 +1,19 @@
 module Hetzner
   class API
     module Reset
+      # returns the reset status of a given IP address or all servers of the account
       def reset?(ip = nil)
         path = "/reset"
         path << "/#{ip}" if ip
         perform_get path
       end
       
+      # resets a server by its IP address.
+      #
+      # <em>type</em> is one of:
+      # * <b>sw</b>  (software reset)
+      # * <b>hw</b>  (hardware reset)
+      # * <b>man</b> (manual reset)
       def reset!(ip, type)
         perform_post "/reset/#{ip}", :query => { :type => type }
       end

data/lib/api/vnc.rb

@@ -1,16 +1,21 @@
 module Hetzner
   class API
     module VNC
+      # queries the vnc boot status of one IP address/server
       def boot_vnc?(ip)
         path = "/boot/#{ip}/vnc"
         perform_get path
       end
-
+      
+      # enables vnc boot option for one IP address/server
+      #
+      # see <em>Boot</em> to query the API for available options
       def boot_vnc!(ip, dist, arch, lang)
         path = "/boot/#{ip}/vnc"
         perform_post path, :query => { :dist => dist, :arch => arch, :lang => lang }
       end
-
+      
+      # disables the vnc boot status of one IP address/server
       def disable_boot_vnc!(ip)
         path = "/boot/#{ip}/vnc"
         perform_delete path

data/lib/api/wol.rb

@@ -1,10 +1,13 @@
 module Hetzner
   class API
     module WOL
+      # queries the WOL of one IP address/server
       def wol?(ip)
         path = "/wol/#{ip}"
         perform_get path
       end
+      
+      # triggers a WOL packet for given IP address/server
       def wol!(ip)
         path = "/wol/#{ip}"
         perform_post path

data/spec/spec_helper.rb

@@ -2,7 +2,7 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'rubygems'
-require 'hetzner'
+require 'hetzner-api'
 require 'spec'
 require 'spec/autorun'
 

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Roland Moriz
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-02 00:00:00 +02:00
+date: 2010-09-03 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -31,6 +31,20 @@ dependencies:
         version: 1.2.9
   type: :development
   version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id002
 description: A small, unofficial wrapper for Hetzner.de's API (server management)
 email: roland@rails.io
 executables: []