hetzner-api 1.0.0.alpha.2 → 1.0.0.alpha.3

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    hetzner-api (1.0.0.alpha.1)
+    hetzner-api (1.0.0.alpha.2)
       httparty
       thor
 

data/lib/hetzner/api/boot/plesk.rb

@@ -2,6 +2,26 @@ module Hetzner
   class API
     module Boot
       module Plesk
+        # queries the plesk boot status of one IP address/server
+        def boot_plesk?(ip)
+          path = "/boot/#{ip}/plesk"
+          perform_get path
+        end
+        
+        # enables plesk boot option for one IP address/server
+        #
+        # see <em>Boot</em> to query the API for available options
+        def boot_plesk!(ip, dist, arch, lang, hostname)
+          path = "/boot/#{ip}/plesk"
+          perform_post path, :query => { :dist => dist, :arch => arch, :lang => lang, :hostname => hostname }
+        end
+      
+        # disables the vnc boot status of one IP address/server
+        def disable_boot_plesk!(ip)
+          path = "/boot/#{ip}/plesk"
+          perform_delete path
+        end
+        
       end
     end
   end

data/lib/hetzner/api/server.rb

@@ -1,6 +1,23 @@
 module Hetzner
   class API
     module Server
+      # returns a list of all servers of the customer
+      def servers?
+        get_server_or_servers
+      end
+      
+      # returns a list of all servers or just for a specific server ip
+      def server?(server_ip)
+        get_server_or_servers server_ip
+      end
+      
+      private
+      
+      def  get_server_or_servers(server_ip = nil)
+        path = "/server"
+        path << "/#{server_ip}" if server_ip
+        perform_get path  
+      end
     end
   end
 end

data/lib/hetzner/api/subnet.rb

@@ -1,6 +1,35 @@
 module Hetzner
   class API
     module Subnet
+      # shows all IP subnets that belong to the main server IP
+      def subnets_for_server?(server_ip)
+        path = "/subnet"
+        perform_get path, :query => { :server_ip => server_ip }
+      end
+      
+      # shows information of all IP subnets of the customer 
+      def subnets?
+        get_subnet_or_subnets
+      end   
+      
+      # shows information of a given IP subnet of the customer
+      def subnet?(ip)
+        get_subnet_or_subnets ip
+      end
+      
+      # sets or unsets traffic warning limits on a specific IP subnet address
+      def subnet!(ip, options = {})
+        path = "/subnet/#{ip}"
+        perform_post path, :query => options
+      end
+      
+      private
+      
+      def get_subnet_or_subnets(ip = nil)
+        path = "/subnet"
+        path << "/#{ip}" if ip
+        perform_get path
+      end
     end
   end
 end

data/lib/hetzner/api/traffic.rb

@@ -1,6 +1,71 @@
 module Hetzner
   class API
     module Traffic
+      # returns the traffic information for an IP and/or subnet according to the selected time frame.
+      def traffic?(options = {})
+
+        ips     = options[:ips]
+        subnets = options[:subnets]
+        from    = options[:from]
+        to      = options[:to]
+        type    = options[:type].to_sym
+
+        from = DateTime.parse(from) unless from.is_a? Date
+        to   = DateTime.parse(to)   unless to.is_a?   Date
+
+        case type
+        when :year
+          format = "%Y-%m"       # 2010-01
+          from_date = from.strftime format
+          to_date   = to.strftime   format
+        when :month
+          format = "%Y-%m-%d"    # 2010-12-30
+          from_date = from.strftime format
+          to_date   = to.strftime   format
+        when :day
+          format = "%Y-%m-%dT%H" # 2010-01-01T15
+          from_date = from.strftime format
+          to_date   = to.strftime   format
+        else
+          raise ArgumentError, 'Invalid time frame type. Must be one of:  :year, :month, :day'
+        end
+        
+        validate_dates_and_type from, to, type
+        
+        perform_post "/traffic", :query => { 
+          :ip     => ips,
+          :subnet => subnets,
+          :from   => from_date,
+          :to     => to_date,
+          :type   => type
+        }
+      end
+
+      private
+
+      def validate_dates_and_type(from, to, type)
+        today = DateTime.now
+
+        case type
+        when :month
+          #if (same_year_and_month?(today, from) || same_year_and_month?(today, to))
+          #  raise ArgumentError, 'Invalid timeframe: Time frame :month for this date is available AFTER CURRENT MONTH ONLY! => try :day instead'
+          #end
+
+        when :day
+          unless same_day?(from, to)
+            raise ArgumentError, 'Invalid date for timeframe. for type == :day queries both dates have to be on the same *day*'
+          end
+        end
+      end
+
+      def same_year_and_month?(a,b)
+        a.strftime("%Y-%m") == b.strftime("%Y-%m")
+      end
+
+      def same_day?(a,b)
+        a.strftime("%Y-%m-%d") == b.strftime("%Y-%m-%d")
+      end
     end
   end
 end

data/lib/hetzner/api/version.rb

@@ -1,5 +1,5 @@
 module Hetzner
   class API
-    VERSION = "1.0.0.alpha.2"
+    VERSION = "1.0.0.alpha.3"
   end
 end

data/spec/api_stubs.rb

@@ -68,6 +68,15 @@ FakeWeb.register_uri :post,   uri("#{WORKING_IP}/vnc?arch=32&lang=en_US&dist=Fed
 FakeWeb.register_uri :delete, uri("#{WORKING_IP}/vnc"),
                      :response => fixture('vnc/delete.raw')  
 
+FakeWeb.register_uri :get,    uri("#{WORKING_IP}/plesk"),
+                     :response => fixture('plesk/get.raw')
+
+FakeWeb.register_uri :post,   uri("#{WORKING_IP}/plesk?arch=32&lang=en_US&dist=Fedora-13&hostname=dr-gerner-aus-gzsz.confixx.de"),
+                     :response => fixture('plesk/post.raw') # perl2exe insider               
+
+FakeWeb.register_uri :delete, uri("#{WORKING_IP}/plesk"),
+                     :response => fixture('plesk/delete.raw')  
+
 
 @resource = 'wol'
 
@@ -103,9 +112,47 @@ FakeWeb.register_uri :get,    uri("#{WORKING_IP}"),
                                           
 FakeWeb.register_uri :post,   uri("#{WORKING_IP}?traffic_warnings=true&traffic_monthly=2342"),
                      :response => fixture('post_activate_with_data.raw')
-                     
+
 FakeWeb.register_uri :post,   uri("#{WORKING_IP}?traffic_warnings=false"),
                      :response => fixture('post_deactivate_with_data.raw')
 
 
+@resource = 'subnet'
+
+FakeWeb.register_uri :get,    uri,
+                     :response => fixture('get.raw')
+
+FakeWeb.register_uri :get,    uri(nil, "?server_ip=#{WORKING_IP}"),
+                     :response => fixture('get_with_server_ip.raw')
+                                          
+FakeWeb.register_uri :get,    uri("#{WORKING_SUBNET_IP}"),
+                     :response => fixture('get_with_subnet_ip.raw')
+                                          
+FakeWeb.register_uri :post,   uri("#{WORKING_SUBNET_IP}?traffic_warnings=true&traffic_monthly=2342"),
+                     :response => fixture('post_activate_with_data.raw')
+
+FakeWeb.register_uri :post,   uri("#{WORKING_SUBNET_IP}?traffic_warnings=false"),
+                     :response => fixture('post_deactivate_with_data.raw')
+
+
+@resource = 'server'
+
+FakeWeb.register_uri :get,    uri,
+                     :response => fixture('get.raw')
+
+FakeWeb.register_uri :get,    uri("#{WORKING_IP}"),
+                     :response => fixture('get_with_server_ip.raw')
+
+
+@resource = 'traffic'
+
+FakeWeb.register_uri :post,   uri(nil, "?from=2010-10-10T01&type=day&ip[]=#{WORKING_IP}&to=2010-10-10T10&subnet[]=#{WORKING_SUBNET_IP}"),
+                     :response => fixture('post_with_one_ip_and_one_subnet_day.raw')
+
+FakeWeb.register_uri :post,   uri(nil, "?from=2010-09-01&type=month&ip[]=#{WORKING_IP}&to=2010-10-01&ip[]=#{WORKING_IP_2}"),
+                     :response => fixture('post_with_two_ips_and_no_subnet_month.raw')
+
+FakeWeb.register_uri :post,   uri(nil, "?from=2010-01&to=2010-10&type=year&subnet[]=#{WORKING_SUBNET_IP}&subnet[]=#{WORKING_SUBNET_IP_2}"),
+                     :response => fixture('post_with_two_subnets_and_no_ip_year.raw')
+                     
 #pp FakeWeb::Registry.instance.uri_map

data/spec/fixtures/boot/plesk/delete.raw

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "plesk": {
+    "server_ip": "11.11.11.111",
+    "dist": ["CentOS 5.4 minimal","Debian 5.0 minimal"],
+    "arch": [64,32],
+    "lang": ["en","de"],
+    "active": false,
+    "password": null,
+    "hostname": null
+  }
+}

data/spec/fixtures/boot/plesk/get.raw

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "plesk": {
+    "server_ip": "11.11.11.111",
+    "dist": ["CentOS 5.4 minimal","Debian 5.0 minimal"],
+    "arch": [64,32],
+    "lang": ["en","de"],
+    "active": false,
+    "password": null,
+    "hostname": null
+  }
+}

data/spec/fixtures/boot/plesk/post.raw

@@ -0,0 +1,14 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "plesk": {
+    "server_ip": "11.11.11.111",
+    "dist": "CentOS 5.4 minimal",
+    "arch": 32,
+    "lang": "de",
+    "active": true,
+    "password": "ie8Nhz6R",
+    "hostname": "dr-gerner-aus-gzsz.confixx.de"
+  }
+}

data/spec/fixtures/server/get.raw

@@ -0,0 +1,29 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+[
+  {
+    "server": {
+      "server_ip": "11.11.11.111",
+      "product": "DS 3000",
+      "dc": 6,
+      "traffic": "5 TB",
+      "status": "ready",
+      "throttled": true,
+      "cancelled": false,
+      "paid_until": "2010-09-02"
+    }
+  },
+  {
+    "server": {
+      "server_ip": "11.11.11.112",
+      "product": "X5",
+      "dc": 5,
+      "traffic": "2 TB",
+      "status": "ready",
+      "throttled": false,
+      "cancelled": false,
+      "paid_until": "2010-06-11"
+    }
+  }
+]

data/spec/fixtures/server/get_with_server_ip.raw

@@ -0,0 +1,23 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "server": {
+    "server_ip": "11.11.11.111",
+    "product": "EQ 8",
+    "dc": 11,
+    "traffic": "5 TB",
+    "status": "ready",
+    "throttled": false,
+    "cancelled": false,
+    "paid_until": "2010-08-04",
+    "ip": ["11.11.11.111"],
+    "subnet": [{"ip": "2a01:4f8:111:4221::", "mask": "64"}],
+    "reset": true,
+    "rescue": true,
+    "vnc": true,
+    "windows": true,
+    "plesk": true,
+    "wol": true
+  }
+}

data/spec/fixtures/subnet/get.raw

@@ -0,0 +1,33 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+[
+  {
+    "subnet": {
+      "ip": "11.11.12.111",
+      "mask": 29,
+      "gateway": "123.123.123.123",
+      "server_ip": "88.198.123.123",
+      "failover": false,
+      "locked": false,
+      "traffic_warnings": false,
+      "traffic_hourly": 100,
+      "traffic_daily": 500,
+      "traffic_monthly": 2
+    }
+  },
+  {
+    "subnet":{
+      "ip": "11.11.13.111",
+      "mask": 25,
+      "gateway": "178.63.123.124",
+      "server_ip": null,
+      "failover": false,
+      "locked": false,
+      "traffic_warnings": false,
+      "traffic_hourly": 100,
+      "traffic_daily": 500,
+      "traffic_monthly": 2
+    }
+  }
+]

data/spec/fixtures/subnet/get_with_server_ip.raw

@@ -0,0 +1,19 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+[
+  {
+    "subnet": {
+      "ip": "11.11.12.111",
+      "mask": 29,
+      "gateway": "123.123.123.123",
+      "server_ip": "88.198.123.123",
+      "failover": false,
+      "locked": false,
+      "traffic_warnings": false,
+      "traffic_hourly": 100,
+      "traffic_daily": 500,
+      "traffic_monthly": 2
+    }
+  }
+]

data/spec/fixtures/subnet/get_with_subnet_ip.raw

@@ -0,0 +1,17 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "subnet": {
+    "ip": "11.11.12.111",
+    "mask": 29,
+    "gateway": "123.123.123.123",
+    "server_ip": "88.198.123.123",
+    "failover": false,
+    "locked": false,
+    "traffic_warnings": false,
+    "traffic_hourly": 100,
+    "traffic_daily": 500,
+    "traffic_monthly": 2
+  }
+}

data/spec/fixtures/traffic/post_with_one_ip_and_one_subnet_day.raw

@@ -0,0 +1,37 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "traffic": {
+    "data": {
+      "11.11.11.111": {
+        "sum": 0.0107,
+        "out": 0.0078,
+        "in": 0.0029
+      },
+      "11.11.12.111": {
+        "sum": 0.1002,
+        "out": 0.0128,
+        "in": 0.0874
+      },
+      "11.11.12.112": {
+        "sum": 0.0095,
+        "out": 0.0066,
+        "in": 0.0029
+      },
+      "11.11.12.113": {
+        "sum": 0.0128,
+        "out": 0.0094,
+        "in": 0.0034
+      },
+      "11.11.12.114": {
+        "sum": 0.0109,
+        "out": 0.0079,
+        "in": 0.003
+      }
+    },
+    "from": "2010-10-108T01:00+0200",
+    "to": "2010-10-10T10:00+0200",
+    "type": "day"
+  }
+}

data/spec/fixtures/traffic/post_with_two_ips_and_no_subnet_month.raw

@@ -0,0 +1,22 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "traffic": {
+    "data": {
+      "11.11.11.111": {
+        "sum": 0.0107,
+        "out": 0.0078,
+        "in": 0.0029
+      },
+      "11.11.11.112": {
+        "sum": 0.1002,
+        "out": 0.0128,
+        "in": 0.0874
+      }
+    },
+    "from": "2010-09-01",
+    "to": "2010-10-01",
+    "type": "month"
+  }
+}

data/spec/fixtures/traffic/post_with_two_subnets_and_no_ip_year.raw

@@ -0,0 +1,52 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+  "traffic": {
+    "data": {
+      "11.11.12.111": {
+        "sum": 0.1002,
+        "out": 0.0128,
+        "in": 0.0874
+      },
+      "11.11.12.112": {
+        "sum": 0.0095,
+        "out": 0.0066,
+        "in": 0.0029
+      },
+      "11.11.12.113": {
+        "sum": 0.0128,
+        "out": 0.0094,
+        "in": 0.0034
+      },
+      "11.11.12.114": {
+        "sum": 0.0109,
+        "out": 0.0079,
+        "in": 0.003
+      },
+      "11.11.13.111": {
+        "sum": 0.1002,
+        "out": 0.0128,
+        "in": 0.0874
+      },
+      "11.11.13.112": {
+        "sum": 0.0095,
+        "out": 0.0066,
+        "in": 0.0029
+      },
+      "11.11.13.113": {
+        "sum": 0.0128,
+        "out": 0.0094,
+        "in": 0.0034
+      },
+      "11.11.13.114": {
+        "sum": 0.0109,
+        "out": 0.0079,
+        "in": 0.003
+      }
+    },
+    "from": "2010-01",
+    "to": "2010-10",
+    "type": "year"
+  }
+}

data/spec/hetzner_api_spec.rb

@@ -219,3 +219,144 @@ describe 'IP' do
   end
 end
 
+describe 'Subnet' do
+  describe "information" do
+    before(:all) do
+      @h = Hetzner::API.new API_USERNAME, API_PASSWORD
+    end
+    it "should be able to display all IP subnets of the customer account" do
+      result = @h.subnets?
+      result.response.should be_an_instance_of Net::HTTPOK
+      result.parsed_response.should have_at_least(2).entries
+    end  
+  
+    it "should be able to display a IP subnet of the customer account" do
+      result = @h.subnet? WORKING_SUBNET_IP
+      result.response.should be_an_instance_of Net::HTTPOK
+      result.parsed_response.should have(1).entry
+    end
+    
+    it "should be able to display all IP addresses for a given server IP address" do
+      result = @h.subnets_for_server? WORKING_IP
+      result.response.should be_an_instance_of Net::HTTPOK
+      result.parsed_response.should have(1).entry
+    end
+  end
+  
+  describe "manage traffic warnings" do
+    before(:all) do
+      @h = Hetzner::API.new API_USERNAME, API_PASSWORD
+    end
+    
+    it "should be able to activate and set traffic warning limits on a specific IP address" do
+      result = @h.ip! WORKING_IP, :traffic_warnings => 'true', :traffic_monthly => TRAFFIC_LIMIT_IN_GIGABYTE
+      result.response.should be_an_instance_of Net::HTTPOK
+      result.parsed_response.should have(1).entry
+    end
+    
+    it "should be able to deactivate traffic warnings for a specific IP address" do
+      result = @h.ip! WORKING_IP, :traffic_warnings => 'false'
+      result.response.should be_an_instance_of Net::HTTPOK
+      result.parsed_response.should have(1).entry
+    end
+  end
+end
+
+
+describe "Server" do
+  describe "information" do
+    before(:all) do
+      @h = Hetzner::API.new API_USERNAME, API_PASSWORD
+    end
+    
+    it "should be able to display all servers of the customer account" do
+      result = @h.servers?
+      result.response.should be_an_instance_of Net::HTTPOK
+      result.parsed_response.should have_at_least(2).entries
+    end
+    
+    it "should be able to display a specific server by its IP address" do
+      result = @h.server? WORKING_IP
+      result.response.should be_an_instance_of Net::HTTPOK
+      result.parsed_response.should have_at_least(1).entry
+    end   
+  end
+end
+
+describe "Plesk" do
+  before(:all) do
+    @h = Hetzner::API.new API_USERNAME, API_PASSWORD
+  end
+  
+  it "should be able to query plesk boot option status" do
+    result = @h.boot_plesk? WORKING_IP
+    result.response.should be_an_instance_of Net::HTTPOK
+    result['plesk']['server_ip'].should == WORKING_IP
+    result['plesk']['active'].should be_false
+    result['plesk']['password'].should be_nil
+  end
+  
+  it "should be able to activate plesk boot option" do
+    result = @h.boot_plesk! WORKING_IP, 'Fedora-13', '32', 'en_US', 'dr-gerner-aus-gzsz.confixx.de'
+    result.response.should be_an_instance_of Net::HTTPOK
+    result['plesk']['server_ip'].should == WORKING_IP
+    result['plesk']['active'].should be_true
+    result['plesk']['password'].should_not be_nil
+  end
+  
+  it "should be able to disable plesk boot option" do
+    result = @h.disable_boot_plesk! WORKING_IP
+    result.response.should be_an_instance_of Net::HTTPOK
+    result['plesk']['server_ip'].should == WORKING_IP
+    result['plesk']['active'].should be_false
+    result['plesk']['password'].should be_nil
+  end
+end
+
+describe "Traffic" do
+   before(:all) do
+    @h = Hetzner::API.new API_USERNAME, API_PASSWORD
+  end
+  
+  it "should display the traffic for a specific ip address and a subnet" do
+    options = {
+      :ips     => [WORKING_IP],
+      :subnets => [WORKING_SUBNET_IP],
+      :from    => DateTime.parse('10.10.2010 01:00'),
+      :to      => DateTime.parse('10.10.2010 10:21'),
+      :type    => :day
+    }
+
+    result = @h.traffic? options
+
+    result.response.should be_an_instance_of Net::HTTPOK
+  end
+  
+  it "should display the traffic for serveral IP addresse and no subnet" do
+    options = {
+      :ips     => [WORKING_IP, WORKING_IP_2],
+      :subnets => [],
+      :from    => "01.09.2010",
+      :to      => "01.10.2010",
+      :type    => :month
+    }
+
+    result = @h.traffic? options
+
+    result.response.should be_an_instance_of Net::HTTPOK
+  end 
+ 
+  it "should display the traffic for subnets and no ip address" do
+    options = {
+      :ips     => [],
+      :subnets => [WORKING_SUBNET_IP, WORKING_SUBNET_IP_2],
+      :from    => "01.01.2010",
+      :to      => "01.10.2010",
+      :type    => :year
+    }
+
+    result = @h.traffic? options
+
+    result.response.should be_an_instance_of Net::HTTPOK
+  end 
+end

data/spec/spec_constants.rb

@@ -1,4 +1,7 @@
 WORKING_IP             = '11.11.11.111'
+WORKING_IP_2           = '11.11.11.112'
+WORKING_SUBNET_IP      = '11.11.12.111'
+WORKING_SUBNET_IP_2    = '11.11.13.111'
 UNKOWN_IP              = '11.11.11.222'
 
 RESET_IP_NOT_AVAILABLE = '11.11.11.223'

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification 
 name: hetzner-api
 version: !ruby/object:Gem::Version 
-  hash: -3702664328
+  hash: -3702664326
   prerelease: true
   segments: 
   - 1
   - 0
   - 0
   - alpha
-  - 2
-  version: 1.0.0.alpha.2
+  - 3
+  version: 1.0.0.alpha.3
 platform: ruby
 authors: 
 - Roland Moriz
@@ -17,7 +17,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-08 00:00:00 +02:00
+date: 2010-10-09 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -190,6 +190,9 @@ files:
 - lib/hetzner/api/wol.rb
 - spec/api_stubs.rb
 - spec/fixtures/boot/get_with_ip.raw
+- spec/fixtures/boot/plesk/delete.raw
+- spec/fixtures/boot/plesk/get.raw
+- spec/fixtures/boot/plesk/post.raw
 - spec/fixtures/boot/rescue/delete.raw
 - spec/fixtures/boot/rescue/post.raw
 - spec/fixtures/boot/vnc/delete.raw
@@ -212,6 +215,14 @@ files:
 - spec/fixtures/reset/post_with_ip_manual_active.raw
 - spec/fixtures/reset/post_with_ip_unavailable.raw
 - spec/fixtures/reset/post_with_ip_unknown.raw
+- spec/fixtures/server/get.raw
+- spec/fixtures/server/get_with_server_ip.raw
+- spec/fixtures/subnet/get.raw
+- spec/fixtures/subnet/get_with_server_ip.raw
+- spec/fixtures/subnet/get_with_subnet_ip.raw
+- spec/fixtures/traffic/post_with_one_ip_and_one_subnet_day.raw
+- spec/fixtures/traffic/post_with_two_ips_and_no_subnet_month.raw
+- spec/fixtures/traffic/post_with_two_subnets_and_no_ip_year.raw
 - spec/fixtures/wol/get.raw
 - spec/fixtures/wol/post.raw
 - spec/hetzner_api_spec.rb