Class: Gridium::GridiumS3

Inherits:
Object
  • Object
show all
Defined in:
lib/s3.rb

Constant Summary collapse

DELIMITER = 
"/"

Instance Method Summary collapse

Constructor Details

#initialize(project_name, subdirectory_name = 'screenshots') ⇒ GridiumS3

Returns a new instance of GridiumS3.



8
9
10
11
12
13
14
15
16
 
# File 'lib/s3.rb', line 8

def initialize(project_name, subdirectory_name='screenshots')
    Log.debug("[GRIDIUM::S3] initializing GridiumS3 with #{project_name} and #{subdirectory_name}")
    Aws.config.update({ credentials: Aws::Credentials.new(ENV['S3_ACCESS_KEY_ID'], ENV['S3_SECRET_ACCESS_KEY']) , region: ENV['S3_DEFAULT_REGION']})
    _validate_string(project_name)
    _validate_string(subdirectory_name)
    @project_name = _sanitize_string(project_name)
    @subdirectory_name = _sanitize_string(subdirectory_name)
    @bucket = Aws::S3::Resource.new().bucket(ENV['S3_ROOT_BUCKET'])
end

Instance Method Details

#_sanitize_string(input_string) ⇒ Object 



45
46
47
48
49
 
# File 'lib/s3.rb', line 45

def _sanitize_string(input_string)
    #remove left/right whitespace, split and join to collapse contiguous white space, replace whitespace and non-period special chars with underscore
    input_string = input_string.strip().split.join(" ").gsub(/[^\w.]/i, '_')
    input_string
end

#_validate_path(path_to_file) ⇒ Object 



58
59
60
61
62
63
 
# File 'lib/s3.rb', line 58

def _validate_path(path_to_file)
    Log.debug("[GRIDIUM::S3]  attempting to validate #{path_to_file} as a legitimate path")
    if not File.exist? path_to_file then
        raise(ArgumentError, "[GRIDIUM::S3] this path doesn't resolve #{path_to_file}")
    end
end

#_validate_string(input_string) ⇒ Object 



51
52
53
54
55
56
 
# File 'lib/s3.rb', line 51

def _validate_string(input_string)
    Log.debug("[GRIDIUM::S3] attempting to validate #{input_string} for use as a name")
    if input_string.empty? or input_string.strip().empty? then
        raise(ArgumentError, "[GRIDIUM::S3] empty and/or whitespace file names are not wanted here.")
    end
end

#_verify_upload(s3_name, local_absolute_path) ⇒ Object 



65
66
67
68
69
70
 
# File 'lib/s3.rb', line 65

def _verify_upload(s3_name, local_absolute_path)
    upload_size = @bucket.object(s3_name).content_length
    local_size = File.size local_absolute_path
    Log.debug("[GRIDIUM::S3] file upload verified: #{upload_size == local_size}. upload size is #{upload_size} and local size is #{local_size}")
    upload_size == local_size
end

#create_s3_name(file_name) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/s3.rb', line 38

def create_s3_name(file_name)
    _validate_string(file_name)
    file_name = _sanitize_string(file_name)
    joined_name = [@project_name, @subdirectory_name, file_name].join(DELIMITER)
    joined_name
end

#save_file(absolute_path_of_file) ⇒ Object 



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/s3.rb', line 18

def save_file(absolute_path_of_file)
    Log.debug("[GRIDIUM::S3] attempting to save #{absolute_path_of_file} to s3")
    _validate_path(absolute_path_of_file)
    file_name = File.basename(absolute_path_of_file)
    destination_name = create_s3_name(file_name)
    begin
      @bucket.object(destination_name).upload_file(absolute_path_of_file)
      @bucket.object(destination_name).wait_until_exists
      _verify_upload(destination_name, absolute_path_of_file)
      # @bucket.object(s3_name).presigned_url(:get, expires_in: 3600) #uncomment this if public url ends up not working out OPREQ-83850
      return @bucket.object(destination_name).public_url
    rescue Aws::S3::Errors::InvalidAccessKeyId
      Log.error("[GRIDIUM::S3] unable to save file to s3 due to Aws::S3::Errors::InvalidAccessKeyId")
    rescue Seahorse::Client::NetworkingError => error
      Log.error("[GRIDIUM::S3] unable to save file to s3 due to underlying network error: #{error}")
    rescue StandardErrer => error
      Log.error("[GRIDIUM::S3] unable to save file to s3 due to unexpected error: #{error}")
    end
end