Class: Morpheus::StorageProvidersInterface

Inherits:
APIClient
  • Object
show all
Defined in:
lib/morpheus/api/storage_providers_interface.rb

Constant Summary

Constants inherited from APIClient

APIClient::CLIENT_ID

Instance Method Summary collapse

Methods inherited from APIClient

#account_groups, #account_users, #accounts, #activity, #appliance_settings, #approvals, #apps, #archive_buckets, #archive_files, #audit, #auth, #authorization_required?, #backup_jobs, #backup_restores, #backup_results, #backup_service_types, #backup_services, #backup_settings, #backup_types, #backups, #billing, #blueprints, #budgets, #catalog, #catalog_item_types, #certificate_types, #certificates, #client_id, #client_id=, #clients, #cloud_datastores, #cloud_folders, #cloud_policies, #cloud_resource_pools, #clouds, #clusters, #common_interface_options, #containers, #credential_types, #credentials, #cypher, #dashboard, #datastores, #default_content_type, #default_timeout, #deploy, #deployments, #dry, #dry_run, #email_templates, #environments, #execute, #execute_schedules, #execution_request, #file_copy_request, #forgot, #group_policies, #groups, #guidance, #guidance_settings, #health, #hub, #image_builder, #initialize, #inspect, #instance_types, #instances, #integration_types, #integrations, #interface, #invoice_line_items, #invoices, #jobs, #key_pairs, #library_cluster_layouts, #library_cluster_packages, #library_container_scripts, #library_container_templates, #library_container_types, #library_container_upgrades, #library_instance_types, #library_layouts, #library_operating_systems, #library_spec_template_types, #library_spec_templates, #license, #load_balancer_monitors, #load_balancer_pool_nodes, #load_balancer_pools, #load_balancer_pools_secondary, #load_balancer_profiles, #load_balancer_types, #load_balancer_virtual_servers, #load_balancers, #log_settings, #logged_in?, #login, #logout, #logs, #monitoring, #monitoring_settings, #network_dhcp_relays, #network_dhcp_servers, #network_domain_records, #network_domains, #network_edge_clusters, #network_floating_ips, #network_groups, #network_pool_ips, #network_pool_server_types, #network_pool_servers, #network_pools, #network_proxies, #network_resource_types, #network_routers, #network_security_server_types, #network_security_servers, #network_server_groups, #network_server_services, #network_server_types, #network_servers, #network_services, #network_static_routes, #network_types, #networks, #old_cypher, #option_type_forms, #option_type_lists, #option_types, #options, #packages, #ping, #plugins, #policies, #power_schedules, #price_sets, #prices, #processes, #projects, #provision_types, #provisioning_license_types, #provisioning_licenses, #provisioning_settings, #reports, #resource_pool_groups, #rest, #roles, #scale_thresholds, #search, #security_group_rules, #security_groups, #security_package_types, #security_packages, #security_scans, #server_types, #servers, #service_plans, #set_ssl_verification_enabled, #setopts, #setup, #snapshots, #ssl_verification_enabled?, #storage_providers, #storage_server_types, #storage_servers, #storage_volume_types, #storage_volumes, #subnet_types, #subnets, #task_sets, #tasks, #to_s, #url, #usage, #use_refresh_token, #user_groups, #user_settings, #user_sources, #users, #vdi, #vdi_allocations, #vdi_apps, #vdi_gateways, #vdi_pools, #virtual_images, #whitelabel_settings, #whoami, #wiki, #withopts

Constructor Details

This class inherits a constructor from Morpheus::APIClient

Instance Method Details

#create(payload) ⇒ Object

[View source]

20
21
22
23
24
25
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 20

def create(payload)
  url = "#{@base_url}/api/storage/buckets"
  headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
  opts = {method: :post, url: url, headers: headers, payload: payload.to_json}
  execute(opts)
end

#destroy(id, params = {}) ⇒ Object

[View source]

34
35
36
37
38
39
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 34

def destroy(id, params={})
  url = "#{@base_url}/api/storage/buckets/#{id}"
  headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
  opts = {method: :delete, url: url, headers: headers}
  execute(opts)
end

#download_file(id, file_path, params = {}) ⇒ Object

[View source]

81
82
83
84
85
86
87
88
89
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 81

def download_file(id, file_path, params={})
  raise "#{self.class}.download_file() passed a blank id!" if id.to_s == ''
  raise "#{self.class}.download_file() passed a blank file path!" if file_path.to_s == ''
  escaped_file_path = file_path.split("/").collect {|it| CGI::escape(it) }.join("/")
  url = "#{@base_url}/api/storage/buckets/#{CGI::escape(id.to_s)}" + "/download-file/#{escaped_file_path}".squeeze('/')
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  execute(opts, false)
end

#download_file_chunked(id, file_path, outfile, params = {}) ⇒ Object

[View source]

91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 91

def download_file_chunked(id, file_path, outfile, params={})
  raise "#{self.class}.download_file() passed a blank id!" if id.to_s == ''
  raise "#{self.class}.download_file() passed a blank file path!" if file_path.to_s == ''
  escaped_file_path = file_path.split("/").collect {|it| CGI::escape(it) }.join("/")
  url = "#{@base_url}/api/storage/buckets/#{CGI::escape(id.to_s)}" + "/download-file/#{escaped_file_path}".squeeze('/')
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  # execute(opts, false)
  if Dir.exist?(outfile)
    raise "outfile is invalid. It is the name of an existing directory: #{outfile}"
  end
  # if @verify_ssl == false
  #   opts[:verify_ssl] = OpenSSL::SSL::VERIFY_NONE
  # end
  if @dry_run
    return opts
  end
  http_response = nil
  File.open(outfile, 'w') {|f|
    block = proc { |response|
      response.read_body do |chunk|
        # writing to #{outfile} ..."
        f.write chunk
      end
    }
    opts[:block_response] = block
    http_response = Morpheus::RestClient.execute(opts)
  }
  return http_response
end

#download_zip_chunked(id, outfile, params = {}) ⇒ Object

[View source]

122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 122

def download_zip_chunked(id, outfile, params={})
  #url = "#{@base_url}/api/storage/buckets/#{CGI::escape(id.to_s)}" + ".zip"
  url = "#{@base_url}/api/storage/buckets/#{CGI::escape(id.to_s)}/download-zip"
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  # execute(opts, false)
  if Dir.exist?(outfile)
    raise "outfile is invalid. It is the name of an existing directory: #{outfile}"
  end
  # if @verify_ssl == false
  #   opts[:verify_ssl] = OpenSSL::SSL::VERIFY_NONE
  # end
  if @dry_run
    return opts
  end
  http_response = nil
  File.open(outfile, 'w') {|f|
    block = proc { |response|
      response.read_body do |chunk|
        # writing to #{outfile} ..."
        f.write chunk
      end
    }
    opts[:block_response] = block
    http_response = Morpheus::RestClient.execute(opts)
  }
  return http_response
end

#get(id, params = {}) ⇒ Object

[View source]

5
6
7
8
9
10
11
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 5

def get(id, params={})
  raise "#{self.class}.get() passed a blank id!" if id.to_s == ''
  url = "#{@base_url}/api/storage/buckets/#{id}"
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  execute(opts)
end

#list(params = {}) ⇒ Object

[View source]

13
14
15
16
17
18
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 13

def list(params={})
  url = "#{@base_url}/api/storage/buckets"
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  execute(opts)
end

#list_files(id, file_path, params = {}) ⇒ Object

[View source]

41
42
43
44
45
46
47
48
49
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 41

def list_files(id, file_path, params={})
  if file_path.to_s.strip == "/"
    file_path = ""
  end
  url = "#{@base_url}/api/storage/buckets/#{CGI::escape(id.to_s)}" + "/files/#{escape_filepath(file_path)}".squeeze('/')
  headers = { params: params, authorization: "Bearer #{@access_token}" }
  opts = {method: :get, url: url, headers: headers}
  execute(opts)
end

#update(id, payload) ⇒ Object

[View source]

27
28
29
30
31
32
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 27

def update(id, payload)
  url = "#{@base_url}/api/storage/buckets/#{id}"
  headers = { :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/json' }
  opts = {method: :put, url: url, headers: headers, payload: payload.to_json}
  execute(opts)
end

#upload_file(id, local_file, destination, params = {}) ⇒ Object

upload a file without multipart

[View source]

52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
 
# File 'lib/morpheus/api/storage_providers_interface.rb', line 52

def upload_file(id, local_file, destination, params={})
  # puts "upload_file #{local_file} to destination #{destination}"
  # destination should be the full filePath, but the api looks like directory?filename=
  path = destination.to_s.squeeze("/")
  if !path || path == "" || path == "/" || path == "."
    raise "#{self.class}.upload_file() passed a bad destination: '#{destination}'"
  end
  if path[0].chr == "/"
    path = path[1..-1]
  end
  path_chunks = path.split("/")
  filename = path_chunks.pop
  safe_dirname = path_chunks.collect {|it| CGI::escape(it) }.join("/")
  # filename = File.basename(destination)
  # dirname = File.dirname(destination)
  # if filename == "" || filename == "/"
  #   filename = File.basename(local_file)
  # end
  url = "#{@base_url}/api/storage/buckets/#{CGI::escape(id.to_s)}" + "/files/#{safe_dirname}".squeeze('/')
  headers = { :params => params, :authorization => "Bearer #{@access_token}", 'Content-Type' => 'application/octet-stream'}
  headers[:params][:filename] = filename # File.basename(destination)
  if !local_file.kind_of?(File)
    local_file = File.new(local_file, 'rb')
  end
  payload = local_file
  headers['Content-Length'] = local_file.size # File.size(local_file)
  execute(method: :post, url: url, headers: headers, payload: payload)
end