hetzner-api 0.0.1

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Roland Moriz
+
+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,13 @@
+= hetzner-api
+
+A HTTParty based wrapper for Hetzner.de's server management interface.
+see http://wiki.hetzner.de/index.php/Robot_Webservice for details.
+
+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>
+
+== Copyright
+
+Copyright (c) 2010 Roland Moriz. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "hetzner-api"
+    gem.summary = %Q{A small, unofficial wrapper for Hetzner.de's API (server management)}
+    gem.description = %Q{A small, unofficial wrapper for Hetzner.de's API (server management)}
+    gem.email = "roland@rails.io"
+    gem.homepage = "http://github.com/rmoriz/hetzner-api"
+    gem.authors = ["Roland Moriz"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "hetzner #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/hetzner-api.gemspec

@@ -0,0 +1,63 @@
+# 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{hetzner-api}
+  s.version = "0.0.1"
+
+  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.description = %q{A small, unofficial wrapper for Hetzner.de's API (server management)}
+  s.email = %q{roland@rails.io}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "hetzner-api.gemspec",
+     "lib/api/boot.rb",
+     "lib/api/failover.rb",
+     "lib/api/rdns.rb",
+     "lib/api/rescue.rb",
+     "lib/api/reset.rb",
+     "lib/api/vnc.rb",
+     "lib/api/windows.rb",
+     "lib/api/wol.rb",
+     "lib/hetzner-api.rb",
+     "spec/hetzner_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/rmoriz/hetzner-api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{A small, unofficial wrapper for Hetzner.de's API (server management)}
+  s.test_files = [
+    "spec/hetzner_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/api/boot.rb

@@ -0,0 +1,11 @@
+module Hetzner
+  class API
+    module Boot
+      def boot?(ip = nil)
+        path = "/boot"
+        path << "/#{ip}" if ip
+        perform_get path
+      end
+    end
+  end
+end

data/lib/api/failover.rb

@@ -0,0 +1,16 @@
+module Hetzner
+  class API
+    module Failover
+      def failover?(ip = nil)
+        path = "/failover"
+        path << "/#{ip}" if @ip
+        perform_get path
+      end
+      
+      def failover!(failover_ip, active_server_ip)
+        path = "/rdns/#{failover_ip}"
+        perform_post path, :query => { :active_server_ip => active_server_ip }
+      end
+    end
+  end
+end

data/lib/api/rdns.rb

@@ -0,0 +1,25 @@
+module Hetzner
+  class API
+    module Rdns
+      def rdns?(ip)
+        path = "/rdns/#{ip}"
+        perform_get path
+      end
+      
+      def rdns!(ip, ptr)
+        path = "/rdns/#{ip}"
+        perform_post path, :query => { :ptr => ptr }
+      end
+      
+      def initialize_rdns!(ip, ptr)
+        path = "/rdns/#{ip}"
+        perform_put path, :query => { :ptr => ptr }
+      end
+      
+      def delete_rdns!(ip)
+        path = "/rdns/#{ip}"
+        perform_delete path
+      end
+    end
+  end
+end

data/lib/api/rescue.rb

@@ -0,0 +1,13 @@
+module Hetzner
+  class API
+    module Rescue
+      def enable_rescue!(ip, os = 'linux', arch = '64')
+        perform_post "/boot/#{ip}/rescue", :query => { :os => os, :arch => arch }
+      end
+      
+      def disable_rescue!(ip)
+        perform_delete "/boot/#{ip}/rescue"
+      end
+    end
+  end
+end

data/lib/api/reset.rb

@@ -0,0 +1,15 @@
+module Hetzner
+  class API
+    module Reset
+      def reset?(ip = nil)
+        path = "/reset"
+        path << "/#{ip}" if ip
+        perform_get path
+      end
+      
+      def reset!(ip, type)
+        perform_post "/reset/#{ip}", :query => { :type => type }
+      end
+    end
+  end
+end

data/lib/api/vnc.rb

@@ -0,0 +1,20 @@
+module Hetzner
+  class API
+    module VNC
+      def boot_vnc?(ip)
+        path = "/boot/#{ip}/vnc"
+        perform_get path
+      end
+
+      def boot_vnc!(ip, dist, arch, lang)
+        path = "/boot/#{ip}/vnc"
+        perform_post path, :query => { :dist => dist, :arch => arch, :lang => lang }
+      end
+
+      def disable_boot_vnc!(ip)
+        path = "/boot/#{ip}/vnc"
+        perform_delete path
+      end
+    end
+  end
+end

data/lib/api/windows.rb

@@ -0,0 +1,20 @@
+module Hetzner
+  class API
+    module Windows
+      def boot_windows?(ip)
+        path = "/boot/#{ip}/windows"
+        perform_get path
+      end
+
+      def boot_windows!(ip, lan)
+        path = "/boot/#{ip}/windows"
+        perform_post path, :query => { :lang => lang }
+      end
+
+      def disable_boot_windows!(ip)
+        path = "/boot/#{ip}/windows"
+        perform_delete path
+      end
+    end
+  end
+end

data/lib/api/wol.rb

@@ -0,0 +1,14 @@
+module Hetzner
+  class API
+    module WOL
+      def wol?(ip)
+        path = "/wol/#{ip}"
+        perform_get path
+      end
+      def wol!(ip)
+        path = "/wol/#{ip}"
+        perform_post path
+      end
+    end
+  end
+end

data/lib/hetzner-api.rb

@@ -0,0 +1,55 @@
+require 'httparty'
+require 'forwardable'
+
+require 'api/boot'
+require 'api/failover'
+require 'api/rdns'
+require 'api/rescue'
+require 'api/reset'
+require 'api/vnc'
+require 'api/windows'
+require 'api/wol'
+
+module Hetzner
+  class API
+    include ::HTTParty
+    format :json
+    base_uri 'https://robot-ws.your-server.de'
+        
+    include Boot
+    include Failover
+    include Rdns
+    include Rescue
+    include Reset
+    include VNC
+    include Windows
+    include WOL
+    
+    def initialize(username, password)
+      @auth = {:username => username, :password => password}
+    end
+    
+  private
+    
+    def perform_get(path, options = {})
+      options.merge!({:basic_auth => @auth})
+      Hetzner::API.get path, options
+    end
+    
+    def perform_post(path, options = {})
+      options.merge!({:basic_auth => @auth})
+      options[:headers] = { 'Content-Type' => 'application/x-www-form-urlencoded' }
+      Hetzner::API.post path, options
+    end
+    
+    def perform_delete(path, options = {})
+      options.merge!({:basic_auth => @auth})
+      Hetzner::API.delete path, options
+    end
+    
+    def perform_put(path, options = {})
+      options.merge!({:basic_auth => @auth})
+      Hetzner::API.put path, options
+    end
+  end
+end

data/spec/hetzner_spec.rb

@@ -0,0 +1,139 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+TEST_IP      = ''
+TEST_PTR     = ''
+RDNS_TEST_IP = ''
+USERNAME     = ''
+PASSWORD     = ''
+                
+describe "Reset" do
+  describe "query status" do
+    before(:all) do
+      @h = Hetzner::API.new(USERNAME, PASSWORD)
+    end
+
+    it "should list available reset options" do
+      result = @h.reset?
+      result.should == [{"reset"=>{"server_ip"=>TEST_IP, "type"=>["man", "hw", "sw"]}}]
+    end
+
+    it "should list available reset options" do
+      result = @h.reset? TEST_IP
+      result.should == {"reset"=>{"server_ip"=>TEST_IP, "type"=>["man", "hw", "sw"]}}
+    end
+
+    it "should fail on a unknown ip" do
+      result = @h.reset? "127.0.0.1" 
+      result['error']['status'].should == 404
+    end
+  end
+
+  describe "do reset" do
+    before(:all) do
+      @h = Hetzner::API.new(USERNAME, PASSWORD)
+    end
+    
+    it "should reset the server" do
+      result = @h.reset! "123.123.123.223", :sw
+      result.should == { "reset"=> {"server_ip"=>"123.123.123.123", "type"=> "sw" } }
+    end
+  end
+end
+
+describe "Boot" do
+  describe "query boot configuration" do 
+    before(:all) do
+      @h = Hetzner::API.new(USERNAME, PASSWORD)
+    end
+    
+    it "should display the boot configuration" do
+      result = @h.boot? TEST_IP 
+      result.should == {"boot"=>{"vnc"=>{"arch"=>[64, 32], "server_ip"=>TEST_IP, "lang"=>["de_DE", "en_US", "fr_FR"], "dist"=>["centOS-5.3", "centOS-5.4", "centOS-5.5", "Fedora-11", "Fedora-12", "Fedora-13", "Fedora-9", "openSUSE-11.0", "openSUSE-11.1", "openSUSE-11.3"], "password"=>nil, "active"=>false}, "rescue"=>{"arch"=>[64, 32], "os"=>["linux", "freebsd", "opensolaris", "vkvm"], "server_ip"=>TEST_IP, "password"=>nil, "active"=>false}, "windows"=>{"server_ip"=>TEST_IP, "lang"=>nil, "dist"=>nil, "password"=>nil, "active"=>false}}}
+    end
+  end
+  
+  describe "Rescue" do
+    before(:all) do
+      @h = Hetzner::API.new(USERNAME, PASSWORD)
+    end
+    it "should be able to activate" do
+      result = @h.enable_rescue! TEST_IP
+      
+      # {"rescue"=>{"arch"=>64, "os"=>"linux", "server_ip"=>TEST_IP, "password"=>"h9JbXPz8", "active"=>true}} 
+      result['rescue']['arch'].should == 64
+      result['rescue']['os'].should == 'linux'
+      result['rescue']['active'].should be_true
+    end
+    
+    it "should be able to deactivate" do
+      result = @h.disable_rescue! TEST_IP
+      result.should == {"rescue"=>{"arch"=>[64, 32], "os"=>["linux", "freebsd", "opensolaris", "vkvm"], "server_ip"=>TEST_IP, "password"=>nil, "active"=>false}}
+    end
+  end
+end
+
+describe "Rdns" do
+  before(:all) do
+    @h = Hetzner::API.new(USERNAME, PASSWORD)
+  end
+  
+  it "should query the current rdns status" do
+    result = @h.rdns? TEST_IP
+    result['rdns']['ip'].should == TEST_IP
+    result['rdns']['ptr'].should == TEST_PTR
+  end
+  
+  it "should be able to set a new ptr" do
+    result = @h.rdns! RDNS_TEST_IP, 'testen.de'
+    result['rdns']['ip'].should == RDNS_TEST_IP
+    result['rdns']['ptr'].should == 'testen.de'
+  end
+  
+  it "should be able to remove a new ptr" do
+    result = @h.delete_rdns! RDNS_TEST_IP
+    puts result
+  end
+end
+
+describe "VNC" do
+  before(:all) do
+    @h = Hetzner::API.new(USERNAME, PASSWORD)
+  end
+  
+  it "should be able to query vnc boot status" do
+    result = @h.boot_vnc? TEST_IP
+    result['vnc']['server_ip'].should == TEST_IP
+    result['vnc']['active'].should be_false
+    result['vnc']['password'].should be_nil
+  end
+  
+  it "should be able to set vnc boot status" do
+    result = @h.boot_vnc! TEST_IP, 'Fedora-13', '32', 'en_US'
+    result['vnc']['server_ip'].should == TEST_IP
+    result['vnc']['active'].should be_true
+    result['vnc']['password'].should_not be_nil
+  end
+  
+  it "should be able to disable vnc boot status" do
+    result = @h.disable_boot_vnc! TEST_IP
+    result['vnc']['server_ip'].should == TEST_IP
+    result['vnc']['active'].should be_false
+    result['vnc']['password'].should be_nil
+  end
+end
+
+describe "WOL" do
+  before(:all) do
+    @h = Hetzner::API.new(USERNAME, PASSWORD)
+  end
+  
+  it "should be able to query WOL status" do
+    result = @h.wol? TEST_IP
+    result['wol']['server_ip'].should == TEST_IP
+  end
+  
+  it "should be able to send a WOL notification" do
+    result = @h.wol! TEST_IP
+    result['wol']['server_ip'].should == TEST_IP
+  end
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'hetzner'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification 
+name: hetzner-api
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Roland Moriz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-02 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id001
+description: A small, unofficial wrapper for Hetzner.de's API (server management)
+email: roland@rails.io
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- hetzner-api.gemspec
+- lib/api/boot.rb
+- lib/api/failover.rb
+- lib/api/rdns.rb
+- lib/api/rescue.rb
+- lib/api/reset.rb
+- lib/api/vnc.rb
+- lib/api/windows.rb
+- lib/api/wol.rb
+- lib/hetzner-api.rb
+- spec/hetzner_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/rmoriz/hetzner-api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A small, unofficial wrapper for Hetzner.de's API (server management)
+test_files: 
+- spec/hetzner_spec.rb
+- spec/spec_helper.rb