Class: ErpTechSvcs::FileSupport::S3Manager

Inherits:
Manager
  • Object
show all
Defined in:
lib/erp_tech_svcs/file_support/s3_manager.rb

Constant Summary

Constants inherited from Manager

Manager::FILE_DOES_NOT_EXIST, Manager::FILE_FOLDER_DOES_NOT_EXIST, Manager::FOLDER_IS_NOT_EMPTY

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Manager

#build_file_assets_tree_for_model, find_parent, #insert_folders, #sync

Class Method Details

.setup_connectionObject



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 10

def setup_connection
  @@configuration = YAML::load_file(File.join(Rails.root, 'config', 's3.yml'))[Rails.env]

  # S3 debug logging
  # AWS.config(
  #     :logger => Rails.logger,
  #     :log_level => :info
  # )

  @@s3_connection = AWS::S3.new(
      :access_key_id => @@configuration['access_key_id'],
      :secret_access_key => @@configuration['secret_access_key']
  )

  @@s3_bucket = @@s3_connection.buckets[@@configuration['bucket'].to_sym]
end

Instance Method Details

#bucketObject



37
38
39
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 37

def bucket
  @@s3_bucket
end

#bucket=(name) ⇒ Object



33
34
35
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 33

def bucket=(name)
  @@s3_bucket = @@s3_connection.buckets[name.to_sym]
end

#bucketsObject



29
30
31
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 29

def buckets
  @@s3_connection.buckets
end

#build_tree(starting_path, options = {}) ⇒ Object



168
169
170
171
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 168

def build_tree(starting_path, options={})
  node_tree = find_node(starting_path, options)
  node_tree.nil? ? [] : node_tree
end

#create_file(path, name, content) ⇒ Object



53
54
55
56
57
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 53

def create_file(path, name, content)
  path = path.sub(%r{^/}, '')
  full_filename = (path.blank? ? name : File.join(path, name))
  bucket.objects[full_filename].write(content, {:acl => :public_read})
end

#create_folder(path, name) ⇒ Object



59
60
61
62
63
64
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 59

def create_folder(path, name)
  path = path.sub(%r{^/}, '')
  full_filename = (path.blank? ? name : File.join(path, name))
  folder = full_filename + "/"
  bucket.objects[folder].write('', {:acl => :public_read})
end

#delete_file(path, options = {}) ⇒ Object



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 122

def delete_file(path, options={})
  is_directory = File.extname(path).blank?
  path = path.sub(%r{^/}, '')
  result = false
  message = nil
  begin
    if options[:force] or bucket.as_tree(:prefix => path).children.count <= 1 # aws-sdk includes the folder itself as a child (like . is current dir), this needs revisited as <= 1 is scary
      bucket.objects.with_prefix(path).delete_all
      message = "File was deleted successfully"
      result = true
    else
      message = FOLDER_IS_NOT_EMPTY
    end
  rescue Exception => e
    result = false
    message = e
  end

  return result, message, is_directory
end

#exists?(path) ⇒ Boolean

Returns:

  • (Boolean)


143
144
145
146
147
148
149
150
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 143

def exists?(path)
  begin
    path = path.sub(%r{^/}, '')
    return bucket.objects[path].exists?
  rescue AWS::S3::Errors::NoSuchKey
    return false
  end
end

#find_node(path, options = {}) ⇒ Object



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
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
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 173

def find_node(path, options={})
  #remove proceeding slash for s3
  path.sub!(%r{^/}, '')

  parent = {:text => path.split('/').pop, :leaf => false, :id => path, :children => []}

  tree = bucket.as_tree(:prefix => path)
  tree.children.each do |node|
    if node.leaf?
      #ignore current path that comes as leaf from s3
      next if node.key == path + '/'

      leaf_hash = {
          :text => node.key.split('/').pop,
          :downloadPath => "/#{node.key}",
          :id => "/#{node.key}",
          :leaf => true
      }

      if options[:file_asset_holder]
        files = options[:file_asset_holder].files

        parent_directories =  leaf_hash[:id].split('/')
        parent_directories.pop
        parent_directory = parent_directories.join('/')

        file = files.find { |file| file.directory == parent_directory and file.name == leaf_hash[:text] }
        unless file.nil?
          leaf_hash[:isSecured] = file.is_secured?
          leaf_hash[:roles] = file.roles.collect { |r| r.internal_identifier }
          leaf_hash[:iconCls] = 'icon-document_lock' if leaf_hash[:isSecured]
          leaf_hash[:size] = file.data_file_size
          leaf_hash[:width] = file.width
          leaf_hash[:height] = file.height
          leaf_hash[:url] = file.url
        end
      end

      parent[:children] << leaf_hash
    else
      parent[:children] << {
          :iconCls => "icon-content",
          :text => node.prefix.split('/').pop,
          :id => "/#{node.prefix}".chop,
          :leaf => false
      }
    end
  end

  parent
end

#get_contents(path) ⇒ Object



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 152

def get_contents(path)
  contents = nil
  message = nil

  path = path.sub(%r{^/}, '')
  begin
    object = bucket.objects[path]
    contents = object.read
  rescue AWS::S3::Errors::NoSuchKey => error
    contents = ''
    message = FILE_DOES_NOT_EXIST
  end

  return contents, message
end

#rename_file(path, name) ⇒ Object



89
90
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
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 89

def rename_file(path, name)
  result = false
  old_name = File.basename(path)
  path_pieces = path.split('/')
  path_pieces.delete(path_pieces.last)
  path_pieces.push(name)
  new_path = path_pieces.join('/')
  begin
    file = FileAsset.where(:name => ::File.basename(path)).where(:directory => ::File.dirname(path)).first
    acl = (file.is_secured? ? :private : :public_read) unless file.nil?
    options = (file.nil? ? {} : {:acl => acl})
    path = path.sub(%r{^/}, '')
    new_path = new_path.sub(%r{^/}, '')
#          Rails.logger.info "renaming from #{path} to #{new_path}"
    old_object = bucket.objects[path]
    if new_object = old_object.move_to(new_path, options)
      message = "#{old_name} was renamed to #{name} successfully"
      result = true
    else
      message = "Error renaming #{old_name}"
    end
  rescue AWS::S3::Errors::NoSuchKey => ex
    message = FILE_FOLDER_DOES_NOT_EXIST
  end

  return result, message
end

#rootObject



41
42
43
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 41

def root
  ''
end

#save_move(path, new_parent_path) ⇒ Object



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 66

def save_move(path, new_parent_path)
  result = false
  unless self.exists? path
    message = FILE_DOES_NOT_EXIST
  else
    file = FileAsset.where(:name => ::File.basename(path)).where(:directory => ::File.dirname(path)).first
    acl = (file.is_secured? ? :private : :public_read) unless file.nil?
    options = (file.nil? ? {} : {:acl => acl})
    name = File.basename(path)
    path = path.sub(%r{^/}, '')
    new_path = File.join(new_parent_path, name).sub(%r{^/}, '')
    old_object = bucket.objects[path]
    if new_object = old_object.move_to(new_path, options)
      message = "#{name} was moved to #{new_path} successfully"
      result = true
    else
      message = "Error moving file #{path}"
    end
  end

  return result, message
end

#set_permissions(path, canned_acl = :public_read) ⇒ Object



117
118
119
120
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 117

def set_permissions(path, canned_acl=:public_read)
  path = path.sub(%r{^/}, '')
  bucket.objects[path].acl = canned_acl
end

#update_file(path, content) ⇒ Object



45
46
47
48
49
50
51
# File 'lib/erp_tech_svcs/file_support/s3_manager.rb', line 45

def update_file(path, content)
  file = FileAsset.where(:name => ::File.basename(path)).where(:directory => ::File.dirname(path)).first
  acl = (file.is_secured? ? :private : :public_read) unless file.nil?
  options = (file.nil? ? {} : {:acl => acl, :content_type => file.content_type})
  path = path.sub(%r{^/}, '')
  bucket.objects[path].write(content, options)
end