Module: Fog::Volume::OpenStack::Real

Included in:
V1::Real, V2::Real
Defined in:
lib/fog/openstack/requests/volume/list_transfers.rb,
lib/fog/openstack/requests/volume/get_quota.rb,
lib/fog/openstack/requests/volume/list_zones.rb,
lib/fog/openstack/requests/volume/set_tenant.rb,
lib/fog/openstack/requests/volume/list_volumes.rb,
lib/fog/openstack/requests/volume/update_quota.rb,
lib/fog/openstack/requests/volume/create_volume.rb,
lib/fog/openstack/requests/volume/delete_volume.rb,
lib/fog/openstack/requests/volume/extend_volume.rb,
lib/fog/openstack/requests/volume/list_snapshots.rb,
lib/fog/openstack/requests/volume/accept_transfer.rb,
lib/fog/openstack/requests/volume/create_transfer.rb,
lib/fog/openstack/requests/volume/delete_snapshot.rb,
lib/fog/openstack/requests/volume/delete_transfer.rb,
lib/fog/openstack/requests/volume/get_quota_usage.rb,
lib/fog/openstack/requests/volume/list_volume_types.rb,
lib/fog/openstack/requests/volume/create_volume_type.rb,
lib/fog/openstack/requests/volume/delete_volume_type.rb,
lib/fog/openstack/requests/volume/get_quota_defaults.rb,
lib/fog/openstack/requests/volume/get_volume_details.rb,
lib/fog/openstack/requests/volume/update_volume_type.rb,
lib/fog/openstack/requests/volume/get_snapshot_details.rb,
lib/fog/openstack/requests/volume/get_transfer_details.rb,
lib/fog/openstack/requests/volume/list_volumes_detailed.rb,
lib/fog/openstack/requests/volume/create_volume_snapshot.rb,
lib/fog/openstack/requests/volume/get_volume_type_details.rb,
lib/fog/openstack/requests/volume/list_snapshots_detailed.rb,
lib/fog/openstack/requests/volume/list_transfers_detailed.rb

Overview

no Mock needed, test coverage in RSpec

Instance Method Summary collapse

Instance Method Details

#accept_transfer(transfer_id, auth_key) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/fog/openstack/requests/volume/accept_transfer.rb', line 5

def accept_transfer(transfer_id, auth_key)
  data = {
      'accept' => {
          'auth_key' => auth_key
      }
  }

  request(
      :body    => Fog::JSON.encode(data),
      :expects => [200, 202],
      :method  => 'POST',
      :path    => "os-volume-transfer/#{transfer_id}/accept"
  )
end

#create_transfer(volume_id, options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/fog/openstack/requests/volume/create_transfer.rb', line 5

def create_transfer(volume_id, options={})
  data = {
      'transfer' => {
          'volume_id' => volume_id
      }
  }
  if options[:name]
    data['transfer']['name'] = options[:name]
  end

  request(
      :body    => Fog::JSON.encode(data),
      :expects => [200, 202],
      :method  => 'POST',
      :path    => 'os-volume-transfer'
  )
end

#create_volume_type(options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/fog/openstack/requests/volume/create_volume_type.rb', line 5

def create_volume_type(options = {})
  data = {
    'volume_type' => {}
  }

  vanilla_options = [:name, :extra_specs]
  vanilla_options.select { |o| options[o] }.each do |key|
    data['volume_type'][key] = options[key]
  end
  request(
    :body     => Fog::JSON.encode(data),
    :expects  => [200, 202],
    :method   => 'POST',
    :path     => "types"
  )
end

#delete_snapshot(snapshot_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/delete_snapshot.rb', line 5

def delete_snapshot(snapshot_id)
  request(
    :expects  => 202,
    :method   => 'DELETE',
    :path     => "snapshots/#{snapshot_id}"
  )
end

#delete_transfer(transfer_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/delete_transfer.rb', line 5

def delete_transfer(transfer_id)
  request(
    :expects => 202,
    :method  => 'DELETE',
    :path    => "os-volume-transfer/#{transfer_id}"
  )
end

#delete_volume(volume_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/delete_volume.rb', line 5

def delete_volume(volume_id)
  request(
    :expects  => 202,
    :method   => 'DELETE',
    :path     => "volumes/#{volume_id}"
  )
end

#delete_volume_type(volume_type_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/delete_volume_type.rb', line 5

def delete_volume_type(volume_type_id)
  request(
    :expects  => 202,
    :method   => 'DELETE',
    :path     => "types/#{volume_type_id}"
  )
end

#extend_volume(volume_id, size) ⇒ Object 



5
6
7
8
9
10
11
12
13
 
# File 'lib/fog/openstack/requests/volume/extend_volume.rb', line 5

def extend_volume(volume_id, size)
  body = { 'os-extend' => { 'new_size' => size } }
  request(
    :expects  => 202,
    :method   => 'POST',
    :path     => "volumes/#{volume_id}/action",
    :body     => Fog::JSON.encode(body)
  )
end

#get_quota(tenant_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/get_quota.rb', line 5

def get_quota(tenant_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "/os-quota-sets/#{tenant_id}"
  )
end

#get_quota_defaults(tenant_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/get_quota_defaults.rb', line 5

def get_quota_defaults(tenant_id)
  request(
      :expects  => 200,
      :method   => 'GET',
      :path     => "/os-quota-sets/#{tenant_id}/defaults"
  )
end

#get_quota_usage(tenant_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/get_quota_usage.rb', line 5

def get_quota_usage(tenant_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "/os-quota-sets/#{tenant_id}?usage=True"
  )
end

#get_snapshot_details(snapshot_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/get_snapshot_details.rb', line 5

def get_snapshot_details(snapshot_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "snapshots/#{snapshot_id}"
  )
end

#get_transfer_details(transfer_id) ⇒ Object 



7
8
9
10
11
12
13
 
# File 'lib/fog/openstack/requests/volume/get_transfer_details.rb', line 7

def get_transfer_details(transfer_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "os-volume-transfer/#{transfer_id}"
  )
end

#get_volume_details(volume_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/get_volume_details.rb', line 5

def get_volume_details(volume_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "volumes/#{volume_id}"
  )
end

#get_volume_type_details(volume_type_id) ⇒ Object 



5
6
7
8
9
10
11
 
# File 'lib/fog/openstack/requests/volume/get_volume_type_details.rb', line 5

def get_volume_type_details(volume_type_id)
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => "types/#{volume_type_id}"
  )
end

#list_snapshots(options = true, options_deprecated = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/fog/openstack/requests/volume/list_snapshots.rb', line 5

def list_snapshots(options = true, options_deprecated = {})
  if options.is_a?(Hash)
    path  = 'snapshots'
    query = options
  else
    # Backwards compatibility layer, when 'detailed' boolean was sent as first param
    if options
      Fog::Logger.deprecation('Calling OpenStack[:volume].list_snapshots(true) is deprecated, use .list_snapshots_detailed instead')
    else
      Fog::Logger.deprecation('Calling OpenStack[:volume].list_snapshots(false) is deprecated, use .list_snapshots({}) instead')
    end
    path  = options ? 'snapshots/detail' : 'snapshots'
    query = options_deprecated
  end

  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => path,
    :query    => query
  )
end

#list_snapshots_detailed(options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/fog/openstack/requests/volume/list_snapshots_detailed.rb', line 5

def list_snapshots_detailed(options = {})
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => 'snapshots/detail',
    :query    => options
  )
end

#list_transfers(options = {}) ⇒ Object 



7
8
9
10
11
12
13
14
 
# File 'lib/fog/openstack/requests/volume/list_transfers.rb', line 7

def list_transfers(options = {})
  request(
    :expects => 200,
    :method  => 'GET',
    :path    => 'os-volume-transfer',
    :query   => options
  )
end

#list_transfers_detailed(options = {}) ⇒ Object 



7
8
9
10
11
12
13
14
 
# File 'lib/fog/openstack/requests/volume/list_transfers_detailed.rb', line 7

def list_transfers_detailed(options = {})
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => 'os-volume-transfer/detail',
    :query    => options
  )
end

#list_volume_types(options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/fog/openstack/requests/volume/list_volume_types.rb', line 5

def list_volume_types(options = {})
  request(
    :expects => 200,
    :method  => 'GET',
    :path    => 'types',
    :query   => options
  )
end

#list_volumes(options = true, options_deprecated = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/fog/openstack/requests/volume/list_volumes.rb', line 5

def list_volumes(options = true, options_deprecated = {})
  if options.is_a?(Hash)
    path  = 'volumes'
    query = options
  else
    # Backwards compatibility layer, when 'detailed' boolean was sent as first param
    if options
      Fog::Logger.deprecation('Calling OpenStack[:volume].list_volumes(true) is deprecated, use .list_volumes_detailed instead')
    else
      Fog::Logger.deprecation('Calling OpenStack[:volume].list_volumes(false) is deprecated, use .list_volumes({}) instead')
    end
    path  = options ? 'volumes/detail' : 'volumes'
    query = options_deprecated
  end

  request(
    :expects => 200,
    :method  => 'GET',
    :path    => path,
    :query   => query
  )
end

#list_volumes_detailed(options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/fog/openstack/requests/volume/list_volumes_detailed.rb', line 5

def list_volumes_detailed(options = {})
  request(
    :expects  => 200,
    :method   => 'GET',
    :path     => 'volumes/detail',
    :query    => options
  )
end

#list_zones(options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
 
# File 'lib/fog/openstack/requests/volume/list_zones.rb', line 5

def list_zones(options = {})
  request(
    :expects => 200,
    :method  => 'GET',
    :path    => 'os-availability-zone.json',
    :query   => options
  )
end

#set_tenant(tenant) ⇒ Object 



5
6
7
8
9
 
# File 'lib/fog/openstack/requests/volume/set_tenant.rb', line 5

def set_tenant(tenant)
  @openstack_must_reauthenticate = true
  @openstack_tenant = tenant.to_s
  authenticate
end

#update_quota(tenant_id, options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
 
# File 'lib/fog/openstack/requests/volume/update_quota.rb', line 5

def update_quota(tenant_id, options = {})
  options['tenant_id'] = tenant_id
  request(
    :body => Fog::JSON.encode({ 'quota_set' => options }),
    :expects => 200,
    :method => 'PUT',
    :path => "/os-quota-sets/#{tenant_id}"
  )
end

#update_volume_type(volume_type_id, options = {}) ⇒ Object 



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/fog/openstack/requests/volume/update_volume_type.rb', line 5

def update_volume_type(volume_type_id, options = {})
  data = {
    'volume_type' => {}
  }

  vanilla_options = [:name, :extra_specs]
  vanilla_options.select { |o| options[o] }.each do |key|
    data['volume_type'][key] = options[key]
  end
  request(
    :body     => Fog::JSON.encode(data),
    :expects  => [200, 202],
    :method   => 'PUT',
    :path     => "types/#{volume_type_id}"
  )
end