Class: Etna::Clients::Metis

Inherits:
Object
  • Object
show all
Defined in:
lib/etna/clients/metis/client.rb,
lib/etna/clients/metis/models.rb,
lib/etna/clients/metis/workflows/metis_upload_workflow.rb,
lib/etna/clients/metis/workflows/metis_download_workflow.rb

Defined Under Namespace

Classes: AuthorizeUploadRequest, CopyFilesRequest, CopyRevision, CreateFolderRequest, DeleteFolderRequest, File, Files, FilesResponse, FindParam, FindRequest, Folder, Folders, FoldersAndFilesResponse, FoldersResponse, ListFolderRequest, ListFoldersRequest, MetisDownloadWorkflow, MetisUploadWorkflow, RenameFileRequest, RenameFolderRequest, UploadAction, UploadBlobRequest, UploadResponse, UploadStartRequest

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(host:, token:, persistent: true, ignore_ssl: false) ⇒ Metis

Returns a new instance of Metis.



13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/etna/clients/metis/client.rb', line 13

def initialize(host:, token:, persistent: true, ignore_ssl: false)
  raise 'Metis client configuration is missing host.' unless host
  raise 'Metis client configuration is missing token.' unless token
  @etna_client = ::Etna::Client.new(
    host,
    token,
    persistent: persistent,
    ignore_ssl: ignore_ssl)

  @token = token
end

Instance Attribute Details

#token ⇒ Object (readonly)

Returns the value of attribute token.



12
13
14
 
# File 'lib/etna/clients/metis/client.rb', line 12

def token
  @token
end

Instance Method Details

#authorize_upload(authorize_upload_request = AuthorizeUploadRequest.new) ⇒ Object 



102
103
104
105
106
107
108
109
 
# File 'lib/etna/clients/metis/client.rb', line 102

def authorize_upload(authorize_upload_request = AuthorizeUploadRequest.new)
  json = nil
  @etna_client.post("/authorize/upload", authorize_upload_request) do |res|
    json = JSON.parse(res.body)
  end

  UploadResponse.new(json)
end

#copy_files(copy_files_request) ⇒ Object 



120
121
122
123
 
# File 'lib/etna/clients/metis/client.rb', line 120

def copy_files(copy_files_request)
  FilesResponse.new(
    @etna_client.file_bulk_copy(copy_files_request.to_h))
end

#create_folder(create_folder_request) ⇒ Object 



66
67
68
69
 
# File 'lib/etna/clients/metis/client.rb', line 66

def create_folder(create_folder_request)
  FoldersResponse.new(
    @etna_client.folder_create(create_folder_request.to_h))
end

#delete_folder(delete_folder_request) ⇒ Object 



71
72
73
74
 
# File 'lib/etna/clients/metis/client.rb', line 71

def delete_folder(delete_folder_request)
  FoldersResponse.new(
    @etna_client.folder_remove(delete_folder_request.to_h))
end

#download_file(file_or_url = File.new, &block) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/etna/clients/metis/client.rb', line 81

def download_file(file_or_url = File.new, &block)
  if file_or_url.instance_of?(File)
    download_path =  file_or_url.download_path
  else
    download_path = file_or_url.sub(%r!^https://[^/]*?/!, '/')
  end

  @etna_client.get(download_path) do |response|
    response.read_body(&block)
  end
end

#ensure_parent_folder_exists(project_name:, bucket_name:, path:) ⇒ Object 



35
36
37
38
39
40
41
42
 
# File 'lib/etna/clients/metis/client.rb', line 35

def ensure_parent_folder_exists(project_name:, bucket_name:, path:)
  create_folder_request = CreateFolderRequest.new(
    project_name: project_name,
    bucket_name: bucket_name,
    folder_path: parent_folder_path(path)
  )
  create_folder(create_folder_request) if !folder_exists?(create_folder_request)
end

#find(find_request) ⇒ Object 



76
77
78
79
 
# File 'lib/etna/clients/metis/client.rb', line 76

def find(find_request)
  FoldersAndFilesResponse.new(
    @etna_client.bucket_find(find_request.to_h))
end

#folder_exists?(create_folder_request) ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/etna/clients/metis/client.rb', line 125

def folder_exists?(create_folder_request)
  # NOTE: this doesn't test if the folder_path itself exists
  #   This can be confusing for root folders, because
  #       they have no parents, so you don't need
  #       to create anything.
  return true if create_folder_request.folder_path.empty? # root folder

  # returns 422 if the folder_path does not exist
  begin
    list_folder(
        Etna::Clients::Metis::ListFolderRequest.new(
          project_name: create_folder_request.project_name,
          bucket_name: create_folder_request.bucket_name,
          folder_path: create_folder_request.folder_path
      ))
  rescue Etna::Error => e
      return false if e.status == 422
      raise
  end
  return true
end

#folders(project_name:, bucket_name:) ⇒ Object 



147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/etna/clients/metis/client.rb', line 147

def folders(project_name:, bucket_name:)
  @folders ||= Hash.new { |h, key|
    h[key] = list_all_folders(
      Etna::Clients::Metis::ListFoldersRequest.new(
        project_name: project_name,
        bucket_name: key
      )).folders.all
  }

  @folders[bucket_name]
end

#list_all_folders(list_all_folders_request = ListFoldersRequest.new) ⇒ Object 



25
26
27
28
 
# File 'lib/etna/clients/metis/client.rb', line 25

def list_all_folders(list_all_folders_request = ListFoldersRequest.new)
  FoldersResponse.new(
    @etna_client.folder_list_all_folders(list_all_folders_request.to_h))
end

#list_folder(list_folder_request = ListFolderRequest.new) ⇒ Object 



30
31
32
33
 
# File 'lib/etna/clients/metis/client.rb', line 30

def list_folder(list_folder_request = ListFolderRequest.new)
  FoldersAndFilesResponse.new(
    @etna_client.folder_list(list_folder_request.to_h))
end

#recursively_rename_folder(project_name:, source_bucket:, dest_bucket:, folder:) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/etna/clients/metis/client.rb', line 195

def recursively_rename_folder(project_name:, source_bucket:, dest_bucket:, folder:)
  folder_contents = list_folder(
    Etna::Clients::Metis::ListFolderRequest.new(
      project_name: project_name,
      bucket_name: source_bucket,
      folder_path: folder.folder_path
  ))

  folder_contents.folders.all.each do |sub_folder|
    recursively_rename_folder(
      project_name: project_name,
      source_bucket: source_bucket,
      dest_bucket: dest_bucket,
      folder: sub_folder
    )
  end

  folder_contents.files.all.each do |file|
    rename_file(Etna::Clients::Metis::RenameFileRequest.new(
      bucket_name: source_bucket,
      project_name: project_name,
      file_path: file.file_path,
      new_bucket_name: dest_bucket,
      new_file_path: file.file_path,
      create_parent: true)
    )
  end

  # Now delete the source folder
  delete_folder(
    Etna::Clients::Metis::DeleteFolderRequest.new(
      project_name: project_name,
      bucket_name: source_bucket,
      folder_path: folder.folder_path
  ))
end

#rename_file(rename_file_request) ⇒ Object 



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/etna/clients/metis/client.rb', line 55

def rename_file(rename_file_request)
  ensure_parent_folder_exists(
    project_name: rename_file_request.project_name,
    bucket_name: rename_file_request.new_bucket_name,
    path: rename_file_request.new_file_path # ensure_parent_folder_exists() parses this for the parent path
  ) if rename_file_request.create_parent

  FilesResponse.new(
    @etna_client.file_rename(rename_file_request.to_h))
end

#rename_folder(rename_folder_request) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
 
# File 'lib/etna/clients/metis/client.rb', line 44

def rename_folder(rename_folder_request)
  ensure_parent_folder_exists(
    project_name: rename_folder_request.project_name,
    bucket_name: rename_folder_request.new_bucket_name,
    path: rename_folder_request.new_folder_path
  ) if rename_folder_request.create_parent

  FoldersResponse.new(
    @etna_client.folder_rename(rename_folder_request.to_h))
end

#rename_folders_by_regex(project_name:, source_bucket:, source_folders:, dest_bucket:, regex:) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/etna/clients/metis/client.rb', line 159

def rename_folders_by_regex(project_name:, source_bucket:, source_folders:, dest_bucket:, regex:)
  found_folders = source_folders.select { |folder|
      folder.folder_path =~ regex
  }

  return if found_folders.length == 0

  found_folders.each { |folder|
    # If the destination folder already exists, we need to copy the files
    #   over to it and delete the source folder.
    create_folder_request = CreateFolderRequest.new(
      project_name: project_name,
      bucket_name: dest_bucket,
      folder_path: folder.folder_path
    )

    if folder_exists?(create_folder_request)
      recursively_rename_folder(
        project_name: project_name,
        source_bucket: source_bucket,
        dest_bucket: dest_bucket,
        folder: folder
      )
    else
      rename_folder(Etna::Clients::Metis::RenameFolderRequest.new(
        bucket_name: source_bucket,
        project_name: project_name,
        folder_path: folder.folder_path,
        new_bucket_name: dest_bucket,
        new_folder_path: folder.folder_path,
        create_parent: true)
      )
    end
  }
end

#upload_blob(upload_blob_request = UploadBlobRequest.new) ⇒ Object 



111
112
113
114
115
116
117
118
 
# File 'lib/etna/clients/metis/client.rb', line 111

def upload_blob(upload_blob_request = UploadBlobRequest.new)
  json = nil
  @etna_client.multipart_post(upload_blob_request.upload_path, upload_blob_request.encode_multipart_content) do |res|
    json = JSON.parse(res.body)
  end

  UploadResponse.new(json)
end

#upload_start(upload_start_request = UploadStartRequest.new) ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/etna/clients/metis/client.rb', line 93

def upload_start(upload_start_request = UploadStartRequest.new)
  json = nil
  @etna_client.post(upload_start_request.upload_path, upload_start_request) do |res|
    json = JSON.parse(res.body)
  end

  UploadResponse.new(json)
end