Module: Paperclip::Storage::Aws

Defined in:
lib/paperclip-aws.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/paperclip-aws.rb', line 10

def self.extended base
  begin
    require 'aws-sdk'
  rescue LoadError => e
    e.message << " (You may need to install the aws-sdk gem)"
    raise e
  end unless defined?(AWS)
  
  attr_accessor :s3_options
  base.instance_eval do

             
    @s3_credentials = parse_credentials(@options.s3_credentials)
    @s3_permissions = set_permissions(@options.s3_permissions)
    
    @s3_protocol    = @options.s3_protocol    ||
      Proc.new do |style, attachment|
        permission  = (@s3_permissions[style.to_sym] || @s3_permissions[:default])
        permission  = permission.call(attachment, style) if permission.is_a?(Proc)
        (permission == :public_read) ? 'http' : 'https'
      end
    
    @s3_headers     = @options.s3_headers     || {}
    
    @s3_bucket      = @options.bucket
    @s3_bucket = @s3_bucket.call(self) if @s3_bucket.is_a?(Proc) 
    
    @s3_options     = @options.s3_options     || {}
    # setup Amazon Server Side encryption
    @s3_options.reverse_merge!({
      :sse => false,
      :storage_class => :standard,
      :content_disposition => nil
    })
    
    @s3_endpoint      = @s3_credentials[:endpoint] || 's3.amazonaws.com'
              
    @s3_host_alias    = @options.s3_host_alias
    @s3_host_alias    = @s3_host_alias.call(self) if @s3_host_alias.is_a?(Proc)
              
    @s3 = AWS::S3.new(
      :access_key_id => @s3_credentials[:access_key_id],
      :secret_access_key => @s3_credentials[:secret_access_key],
      :s3_endpoint => @s3_endpoint
    )
  end
  
end

Instance Method Details

#bucket_name ⇒ Object 



83
84
85
 
# File 'lib/paperclip-aws.rb', line 83

def bucket_name
  @s3_bucket
end

#choose_protocol(style, options = {}) ⇒ Object 



113
114
115
116
117
118
119
 
# File 'lib/paperclip-aws.rb', line 113

def choose_protocol(style, options={})
  if options[:protocol].present?
    return options[:protocol].to_s
  else
    return @s3_protocol.is_a?(Proc) ? @s3_protocol.call(style, self) : @s3_protocol
  end
end

#create_bucket ⇒ Object 



135
136
137
 
# File 'lib/paperclip-aws.rb', line 135

def create_bucket
  @s3.buckets.create(@s3_bucket)
end

#exists?(style = default_style) ⇒ Boolean

Returns:

  • (Boolean) 


102
103
104
105
106
107
108
109
110
111
 
# File 'lib/paperclip-aws.rb', line 102

def exists?(style = default_style)
  if path(style).nil? || path(style).to_s.strip == ""
    return false
  end
  begin
    return @s3.buckets[@s3_bucket].objects[path(style)].exists?
  rescue AWS::S3::Errors::Base
    return false
  end
end

#flush_deletes ⇒ Object

:nodoc:



162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/paperclip-aws.rb', line 162

def flush_deletes #:nodoc:
  @queued_for_delete.each do |path|
    begin
      log("deleting #{path}")
      @s3.buckets[@s3_bucket].objects[path].delete
    rescue AWS::Errors::Base => e
      raise
    end
  end
  @queued_for_delete = []
end

#flush_writes ⇒ Object

:nodoc:



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/paperclip-aws.rb', line 139

def flush_writes #:nodoc:
  @queued_for_write.each do |style, file|
    begin
      log("saving #{path(style)}")
      
      @s3.buckets[@s3_bucket].objects[path(style)].write(
        :file => file.path,
        :acl => @s3_permissions[:style.to_sym] || @s3_permissions[:default],
        :storage_class => @s3_options[:storage_class],
        :content_type => file.content_type,
        :content_disposition => @s3_options[:content_disposition],
        :server_side_encryption => @s3_options[:sse]
      )
    rescue AWS::S3::Errors::NoSuchBucket => e
      create_bucket
      retry
    rescue AWS::Errors::Base => e
      raise
    end
  end
  @queued_for_write = {}
end

#parse_credentials(creds) ⇒ Object 



87
88
89
90
91
 
# File 'lib/paperclip-aws.rb', line 87

def parse_credentials(creds)
  creds = find_credentials(creds).stringify_keys
  env = Object.const_defined?(:Rails) ? Rails.env : nil
  (creds[env] || creds).symbolize_keys
end

#set_permissions(permissions) ⇒ Object 



93
94
95
96
97
98
99
100
 
# File 'lib/paperclip-aws.rb', line 93

def set_permissions permissions
  if permissions.is_a?(Hash)
    permissions[:default] = permissions[:default] || :public_read
  else
    permissions = { :default => permissions || :public_read }
  end
  permissions
end

#to_file(style = default_style) ⇒ Object

Returns representation of the data of the file assigned to the given style, in the format most representative of the current storage.



123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/paperclip-aws.rb', line 123

def to_file style = default_style
  return @queued_for_write[style] if @queued_for_write[style]
  filename = path(style)
  extname  = File.extname(filename)
  basename = File.basename(filename, extname)
  file = Tempfile.new([basename, extname])
  file.binmode
  file.write(@s3.buckets[@s3_bucket].objects[path(style)].read)
  file.rewind
  return file
end

#url(style = default_style, options = {}) ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/paperclip-aws.rb', line 59

def url(style=default_style, options={})
  if self.original_filename.nil? 
    # default_url = @default_url.is_a?(Proc) ? @default_url.call(self) : @default_url
    # return interpolate(default_url, style)          
    return super
  end
  
  if options[:expires].present? || options[:action].present?
    options.reverse_merge!({
      :expires => 60*60,
      :action => :read
    })          
    secure = ( self.choose_protocol(style, options) == 'https' )                   
    return @s3.buckets[@s3_bucket].objects[path(style).gsub(%r{^/}, "")].url_for(options[:action], {  :secure => secure, :expires => options[:expires] }).to_s
  else
    if @s3_host_alias.present?
      url = "#{choose_protocol(style, options)}://#{@s3_host_alias}/#{path(style).gsub(%r{^/}, "")}"
    else
      url = "#{choose_protocol(style, options)}://#{@s3_endpoint}/#{@s3_bucket}/#{path(style).gsub(%r{^/}, "")}"
    end        
    return URI.escape(url)
  end              
end