profitbricks-sdk-ruby 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f80ac5a51d396292326f14918566126032cca98b
-  data.tar.gz: e8b6c95be2b363bb7582e5b59db138862d89cf9f
+  metadata.gz: 6692ce451a899b262c070c4165835a5d416b7e28
+  data.tar.gz: 7cd8499014f70a3de75c39ef4adde967c194efc4
 SHA512:
-  metadata.gz: ea7523e99d476d63a2676c8adb111ffdaf4b56ff423a4375d474a0107a2d7a28fef69328275d1aed6cff7ca546c535b09fbd6a9523f13fd2d82f3f15033b33d4
-  data.tar.gz: d2a7d38eab2c97ea8e9b382447feae97f457dcb47299bc3fdbc73a8d572c3ffcbee7cec1b63570483ce82438f71d7cfcd6ccd2ab0ab14c51ad76ba7226d23ff7
+  metadata.gz: 44b05afffd5308078aefd416297122a9b5c20fd344ed1bafa99596c06bc3ade0d5cef62d2e94188186d5a0c3593e6a0cf472126ecd932a366fcd4eadcee11ac8
+  data.tar.gz: 237afdae61b2e7171cac86deab394f6295ef2d47aa75fb86e9623dc7bc372e78464fa9267ac37a31348a4b17747eeded3687079642ba8f410c416fa918602ffa

data/docs/guide.md

@@ -120,6 +120,19 @@ The following example shows you how to create a new server in the virtual data c
 
 One of the unique features of the ProfitBricks platform when compared with the other providers is that it allows you to define your own settings for cores, memory, and disk size without being tied to a particular size.
 
+## How To: Create a Composite Server
+
+A composite server is a server instance that has volumes and NICs already attached. The following example will demonstrate how a composite server can be built with a single request, but the volume, NICs, and included firewall rule will be defined separately for readability.
+
+    volumes = [ { name: 'OS', size: 10, image: '4dc4585c-505a-11e5-bfc6-52540066fee9', bus: 'VIRTIO', imagePassword: 'secretpassword' } ]
+    fwrules = [ { name: 'SSH', protocol: 'TCP', portRangeStart: 22, portRangeEnd: 22 } ]
+    nics = [ { name: 'public', lan: 1, firewallrules: fwrules }, { name: 'private', lan: 2 } ]
+
+The composite server can now be created.
+
+    server = datacenter.create_server(name: 'Composite Server', cores: 1, ram: 1024, volumes: volumes, nics: nics)
+    server.wait_for { ready? }
+
 ## How To: List Available Disk and ISO Images
 
 A list of disk and ISO images are available from ProfitBricks for immediate use. These can be easily viewed and selected with the following code.

data/docs/reference.md

@@ -70,6 +70,14 @@ Create a server:
     datacenter = Datacenter.get(datacenter_id)
     server = datacenter.create_server(name: "server1", cores: 2, ram: 4096)
 
+Create a composite server:
+
+    volumes = [ { name: "server2-os", size: 10, image: "4dc4585c-505a-11e5-bfc6-52540066fee9", bus: "VIRTIO", imagePassword: "secretpassword" }, { name: "server2-data", size: 5, bus: "VIRTIO", licenceType: "UNKNOWN" } ]
+    fwrules = [ { name: "SSH", protocol: "TCP", portRangeStart: 22, portRangeEnd: 22 } ]
+    nics = [ { name: "public", lan: 1, firewallrules: fwrules }, { name: "private", lan: 2 } ]
+
+    server = datacenter.create_server(name: "server2", cores: 1, ram: 1024, volumes: volumes, nics: nics)
+
 Update a server:
 
     server.update(description: "My Server", cores: 4)
@@ -373,4 +381,4 @@ Retrieve a request:
 
 Retrieve status of a request:
 
-    request.status
+    request.status

data/lib/profitbricks/server.rb

@@ -1,12 +1,11 @@
 module ProfitBricks
   # Server class
   class Server < ProfitBricks::Model
-
     # Delete the server.
     def delete
       ProfitBricks.request(
         method: :delete,
-        path: "/datacenters/#{self.datacenterId}/servers/#{self.id}",
+        path: "/datacenters/#{datacenterId}/servers/#{id}",
         expects: 202
       )
     end
@@ -15,13 +14,11 @@ module ProfitBricks
     def update(options = {})
       response = ProfitBricks.request(
         method: :patch,
-        path: "/datacenters/#{self.datacenterId}/servers/#{self.id}",
+        path: "/datacenters/#{datacenterId}/servers/#{id}",
         expects: 202,
         body: options.to_json
       )
-      if response
-        @properties = @properties.merge(response['properties'])
-      end
+      @properties = @properties.merge(response['properties']) if response
       self
     end
 
@@ -42,30 +39,30 @@ module ProfitBricks
 
     # List server volumes.
     def list_volumes
-      ProfitBricks::Volume.list(self.datacenterId, self.id)
+      ProfitBricks::Volume.list(datacenterId, id)
     end
 
     # Retrieve server volume.
     def get_volume(volume_id)
-      ProfitBricks::Volume.get(self.datacenterId, self.id, volume_id)
+      ProfitBricks::Volume.get(datacenterId, id, volume_id)
     end
 
     # Attach volume to server.
     def attach_volume(volume_id)
-      volume = ProfitBricks::Volume.get(self.datacenterId, nil, volume_id)
-      volume.attach(self.id)
+      volume = ProfitBricks::Volume.get(datacenterId, nil, volume_id)
+      volume.attach(id)
     end
 
     # Detach volume from server.
     def detach_volume(volume_id)
-      volume = ProfitBricks::Volume.get(self.datacenterId, nil, volume_id)
-      volume.detach(self.id)
+      volume = ProfitBricks::Volume.get(datacenterId, nil, volume_id)
+      volume.detach(id)
     end
 
     def list_cdroms
       response = ProfitBricks.request(
         method: :get,
-        path: "/datacenters/#{self.datacenterId}/servers/#{self.id}/cdroms",
+        path: "/datacenters/#{datacenterId}/servers/#{id}/cdroms",
         expects: 200
       )
       self.class.instantiate_objects(response)
@@ -74,7 +71,7 @@ module ProfitBricks
     def get_cdrom(cdrom_id)
       response = ProfitBricks.request(
         method: :get,
-        path: "/datacenters/#{self.datacenterId}/servers/#{self.id}/cdroms/#{cdrom_id}",
+        path: "/datacenters/#{datacenterId}/servers/#{id}/cdroms/#{cdrom_id}",
         expects: 200
       )
       self.class.instantiate_objects(response)
@@ -83,7 +80,7 @@ module ProfitBricks
     def attach_cdrom(cdrom_id)
       response = ProfitBricks.request(
         method: :post,
-        path: "/datacenters/#{self.datacenterId}/servers/#{self.id}/cdroms",
+        path: "/datacenters/#{datacenterId}/servers/#{id}/cdroms",
         expects: 202,
         body: { id: cdrom_id }.to_json
       )
@@ -93,24 +90,24 @@ module ProfitBricks
     def detach_cdrom(cdrom_id)
       ProfitBricks.request(
         method: :delete,
-        path: "/datacenters/#{self.datacenterId}/servers/#{self.id}/cdroms/#{cdrom_id}",
+        path: "/datacenters/#{datacenterId}/servers/#{id}/cdroms/#{cdrom_id}",
         expects: 202
       )
     end
 
     # List server NICs.
     def list_nics
-      ProfitBricks::NIC.list(self.datacenterId, self.id)
+      ProfitBricks::NIC.list(datacenterId, id)
     end
 
     # Retrieve server NIC.
     def get_nic(nic_id)
-      ProfitBricks::NIC.get(self.datacenterId, self.id, nic_id)
+      ProfitBricks::NIC.get(datacenterId, id, nic_id)
     end
 
     # Create server NIC.
     def create_nic(options = {})
-      ProfitBricks::NIC.create(self.datacenterId, self.id, options)
+      ProfitBricks::NIC.create(datacenterId, id, options)
     end
 
     alias_method :nics, :list_nics
@@ -118,12 +115,25 @@ module ProfitBricks
 
     class << self
       # Create a new server.
+
       def create(datacenter_id, options = {})
+        entities = {}
+
+        # Retrieve volumes collection if present and generate appropriate JSON.
+        if options.key?(:volumes)
+          entities[:volumes] = collect_entities(options.delete(:volumes))
+        end
+
+        # Retrieve nics collection if present and generate appropriate JSON.
+        if options.key?(:nics)
+          entities[:nics] = collect_entities(options.delete(:nics))
+        end
+
         response = ProfitBricks.request(
           method: :post,
           path: "/datacenters/#{datacenter_id}/servers",
           expects: 202,
-          body: { properties: options }.to_json
+          body: { properties: options, entities: entities }.to_json
         )
         add_parent_identities(response)
         instantiate_objects(response)
@@ -153,10 +163,28 @@ module ProfitBricks
 
     private
 
+    def self.collect_entities(entities)
+      if entities.is_a?(Array) && entities.length > 0
+        items = []
+        entities.each do |entity|
+          if entity.key?(:firewallrules)
+            subentities = collect_entities(entity.delete(:firewallrules))
+            items << {
+              properties: entity,
+              entities: { firewallrules: subentities }
+            }
+          else
+            items << { properties: entity }
+          end
+        end
+        { items: items }
+      end
+    end
+
     def server_control(operation)
       ProfitBricks.request(
         method: :post,
-        path: "/datacenters/#{self.datacenterId}/servers/#{self.id}/#{operation}",
+        path: "/datacenters/#{datacenterId}/servers/#{id}/#{operation}",
         headers: { 'Content-Type' => 'application/x-www-form-urlencoded' },
         expects: 202
       )

data/lib/profitbricks/version.rb

@@ -1,3 +1,3 @@
 module ProfitBricks
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/profitbricks/volume.rb

@@ -86,7 +86,7 @@ module ProfitBricks
         headers: { 'Content-Type' => 'application/x-www-form-urlencoded' },
         expects: 202,
         body: URI.encode_www_form(options)
-      ) 
+      )
       ProfitBricks::Snapshot.new(response)
     end
 
@@ -105,7 +105,7 @@ module ProfitBricks
         headers: { 'Content-Type' => 'application/x-www-form-urlencoded' },
         expects: 202,
         body: URI.encode_www_form(snapshotId: snapshot_id)
-      ) 
+      )
     end
 
     class << self

data/spec/datacenter_spec.rb

@@ -27,8 +27,8 @@ describe ProfitBricks::Datacenter do
     expect(@datacenter.id).to match(
       /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i
     )
-    expect(@datacenter.properties['name']).to eq('My New Datacenter')
-    expect(@datacenter.properties['description']).to eq('Production environment')
+    expect(@datacenter.properties['name']).to eq('Ruby SDK Datacenter')
+    expect(@datacenter.properties['description']).to eq('SDK test environment')
     expect(@datacenter.properties['location']).to eq('de/fkb')
   end
 
@@ -47,19 +47,19 @@ describe ProfitBricks::Datacenter do
 
     expect(datacenter.type).to eq('datacenter')
     expect(datacenter.id).to eq(@datacenter.id)
-    expect(datacenter.properties['name']).to eq('My New Datacenter')
-    expect(datacenter.properties['description']).to eq('Production environment')
+    expect(datacenter.properties['name']).to eq('Ruby SDK Datacenter')
+    expect(datacenter.properties['description']).to eq('SDK test environment')
     expect(datacenter.properties['location']).to eq('de/fkb')
     expect(datacenter.properties['version']).to be_kind_of(Integer)
   end
 
   it '#update' do
     datacenter = ProfitBricks::Datacenter.get(@datacenter.id)
-    datacenter.update(name: 'datacenter1', description: 'Production environment')
+    datacenter.update(name: 'datacenter1', description: 'Ruby SDK test environment')
 
     expect(datacenter.id).to eq(@datacenter.id)
     expect(datacenter.properties['name']).to eq('datacenter1')
-    expect(datacenter.properties['description']).to eq('Production environment')
+    expect(datacenter.properties['description']).to eq('Ruby SDK test environment')
     expect(datacenter.properties['location']).to eq('de/fkb')
     expect(datacenter.properties['version']).to be_kind_of(Integer)
   end
@@ -206,7 +206,7 @@ describe ProfitBricks::Datacenter do
 
     expect(lans[0].type).to eq('lan')
     expect(lans[0].id).to match(/^\d+$/)
-    expect(lans[0].properties['name']).to eq('Switch for LAN 0')
+    expect(lans[0].properties['name']).to eq('public Lan 4')
     expect(lans[0].properties['public']).to be false
   end
 

data/spec/firewall_spec.rb

@@ -22,7 +22,7 @@ describe ProfitBricks::Firewall do
   it '#create' do
     expect(@fwrule.type).to eq('firewall-rule')
     expect(@fwrule.id).to be_kind_of(String)
-    expect(@fwrule.properties['name']).to eq('Open SSH port')
+    expect(@fwrule.properties['name']).to eq('SSH')
     expect(@fwrule.properties['protocol']).to eq('TCP')
     expect(@fwrule.properties['sourceMac']).to eq('01:23:45:67:89:00')
     expect(@fwrule.properties['sourceIp']).to be nil
@@ -39,7 +39,7 @@ describe ProfitBricks::Firewall do
     expect(fwrules.count).to be > 0
     expect(fwrules[0].type).to eq('firewall-rule')
     expect(fwrules[0].id).to eq(@fwrule.id)
-    expect(fwrules[0].properties['name']).to eq('Open SSH port')
+    expect(fwrules[0].properties['name']).to eq('SSH')
     expect(fwrules[0].properties['protocol']).to eq('TCP')
     expect(fwrules[0].properties['sourceMac']).to eq('01:23:45:67:89:00')
     expect(fwrules[0].properties['sourceIp']).to be nil
@@ -55,7 +55,7 @@ describe ProfitBricks::Firewall do
 
     expect(fwrule.type).to eq('firewall-rule')
     expect(fwrule.id).to eq(@fwrule.id)
-    expect(fwrule.properties['name']).to eq('Open SSH port')
+    expect(fwrule.properties['name']).to eq('SSH')
     expect(fwrule.properties['protocol']).to eq('TCP')
     expect(fwrule.properties['sourceMac']).to eq('01:23:45:67:89:00')
     expect(fwrule.properties['sourceIp']).to be nil
@@ -75,7 +75,7 @@ describe ProfitBricks::Firewall do
 
     expect(fwrule.type).to eq('firewall-rule')
     expect(fwrule.id).to eq(@fwrule.id)
-    expect(fwrule.properties['name']).to eq('Open SSH port')
+    expect(fwrule.properties['name']).to eq('SSH')
     expect(fwrule.properties['protocol']).to eq('TCP')
     expect(fwrule.properties['sourceMac']).to eq('01:98:22:22:44:22')
     expect(fwrule.properties['sourceIp']).to be nil

data/spec/server_spec.rb

@@ -17,6 +17,11 @@ describe ProfitBricks::Server do
 
     @image = ProfitBricks::Image.list[0]
     @server.attach_cdrom(@image.id)
+
+    @composite_server = ProfitBricks::Server.create(
+      @datacenter.id,
+      options[:composite_server]
+    )
   end
 
   before do
@@ -40,13 +45,29 @@ describe ProfitBricks::Server do
     expect(@server.properties['vmState']).to eq('RUNNING')
   end
 
+  it '#create composite' do
+    @composite_server.wait_for(300) { ready? }
+    @composite_server.reload
+    expect(@composite_server.type).to eq('server')
+    expect(@composite_server.id).to match(
+      /^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$/i
+    )
+    expect(@composite_server.properties['name']).to eq('New Composite Server')
+    expect(@composite_server.properties['cores']).to eq(1)
+    expect(@composite_server.properties['ram']).to eq(1024)
+    expect(@composite_server.properties['availabilityZone']).to eq('AUTO')
+    expect(@composite_server.properties['vmState']).to eq('RUNNING')
+    expect(@composite_server.entities['volumes']['items'].count).to be > 0
+    expect(@composite_server.entities['nics']['items'].count).to be > 0
+  end
+
   it '#list' do
     servers = ProfitBricks::Server.list(@datacenter.id)
 
     expect(servers.count).to be > 0
     expect(servers[0].type).to eq('server')
-    expect(servers[0].id).to eq(@server.id)
-    expect(servers[0].properties['name']).to eq('New Server')
+    # expect(servers[0].id).to eq(@server.id)
+    # expect(servers[0].properties['name']).to eq('New Server')
     expect(servers[0].properties['cores']).to eq(1)
     expect(servers[0].properties['ram']).to eq(1024)
     expect(servers[0].properties['availabilityZone']).to eq('AUTO')

data/spec/spec_helper.rb

@@ -10,9 +10,9 @@ end
 
 ProfitBricks.configure do |config|
   config.url = 'https://api.profitbricks.com/rest/'
-  config.username = ''
-  config.password = ''
+  config.username = ENV['PROFITBRICKS_USERNAME']
+  config.password = ENV['PROFITBRICKS_PASSWORD']
   config.debug = false
-  config.timeout = 60
+  config.timeout = 300
   config.interval = 5
 end

data/spec/support/resource_helper.rb

@@ -2,8 +2,8 @@ module Helpers
   def options
     {
       datacenter: {
-        name: 'My New Datacenter',
-        description: 'Production environment',
+        name: 'Ruby SDK Datacenter',
+        description: 'SDK test environment',
         location: 'de/fkb'
       },
 
@@ -26,14 +26,13 @@ module Helpers
 
       nic: {
         name: 'nic1',
-        # ips: [ '10.1.1.1' ],
         dhcp: 'true',
         lan: 1,
         firewallActive: true
       },
 
       fwrule: {
-        name: 'Open SSH port',
+        name: 'SSH',
         protocol: 'TCP',
         sourceMac: '01:23:45:67:89:00',
         sourceIp: nil,
@@ -58,6 +57,34 @@ module Helpers
       ipblock: {
         location: "de/fra",
         size: 1
+      },
+
+      composite_server: {
+        name: 'New Composite Server',
+        ram: 1024,
+        cores: 1,
+        volumes: [
+          {
+            name: 'composite-boot',
+            size: 10,
+            licenceType: 'UNKNOWN'
+          }
+        ],
+        nics: [
+          {
+            name: 'nic1',
+            dhcp: 'true',
+            lan: 1,
+            firewallrules: [
+              {
+                name: 'SSH',
+                protocol: 'TCP',
+                portRangeStart: 22,
+                portRangeEnd: 22,
+              }
+            ]
+          }
+        ]
       }
     }
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: profitbricks-sdk-ruby
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Ethan Devenport
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: excon