korobkov-paperclip 2.3.1
Sign up to get free protection for your applications and to get access to all the features.
- data/LICENSE +26 -0
- data/README.rdoc +177 -0
- data/Rakefile +99 -0
- data/generators/paperclip/USAGE +5 -0
- data/generators/paperclip/paperclip_generator.rb +27 -0
- data/generators/paperclip/templates/paperclip_migration.rb.erb +21 -0
- data/init.rb +15 -0
- data/lib/paperclip/attachment.rb +425 -0
- data/lib/paperclip/callback_compatability.rb +33 -0
- data/lib/paperclip/geometry.rb +115 -0
- data/lib/paperclip/interpolations.rb +108 -0
- data/lib/paperclip/iostream.rb +58 -0
- data/lib/paperclip/matchers/have_attached_file_matcher.rb +49 -0
- data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +66 -0
- data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +48 -0
- data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +83 -0
- data/lib/paperclip/matchers.rb +4 -0
- data/lib/paperclip/processor.rb +49 -0
- data/lib/paperclip/storage.rb +243 -0
- data/lib/paperclip/thumbnail.rb +73 -0
- data/lib/paperclip/upfile.rb +47 -0
- data/lib/paperclip.rb +353 -0
- data/shoulda_macros/paperclip.rb +117 -0
- data/tasks/paperclip_tasks.rake +80 -0
- data/test/attachment_test.rb +780 -0
- data/test/database.yml +4 -0
- data/test/fixtures/12k.png +0 -0
- data/test/fixtures/50x50.png +0 -0
- data/test/fixtures/5k.png +0 -0
- data/test/fixtures/bad.png +1 -0
- data/test/fixtures/s3.yml +8 -0
- data/test/fixtures/text.txt +0 -0
- data/test/fixtures/twopage.pdf +0 -0
- data/test/geometry_test.rb +177 -0
- data/test/helper.rb +108 -0
- data/test/integration_test.rb +483 -0
- data/test/interpolations_test.rb +124 -0
- data/test/iostream_test.rb +71 -0
- data/test/matchers/have_attached_file_matcher_test.rb +21 -0
- data/test/matchers/validate_attachment_content_type_matcher_test.rb +30 -0
- data/test/matchers/validate_attachment_presence_matcher_test.rb +21 -0
- data/test/matchers/validate_attachment_size_matcher_test.rb +50 -0
- data/test/paperclip_test.rb +327 -0
- data/test/processor_test.rb +10 -0
- data/test/storage_test.rb +303 -0
- data/test/thumbnail_test.rb +227 -0
- metadata +125 -0
@@ -0,0 +1,58 @@
|
|
1
|
+
# Provides method that can be included on File-type objects (IO, StringIO, Tempfile, etc) to allow stream copying
|
2
|
+
# and Tempfile conversion.
|
3
|
+
module IOStream
|
4
|
+
|
5
|
+
# Returns a Tempfile containing the contents of the readable object.
|
6
|
+
def to_tempfile
|
7
|
+
tempfile = Tempfile.new("stream")
|
8
|
+
tempfile.binmode
|
9
|
+
self.stream_to(tempfile)
|
10
|
+
end
|
11
|
+
|
12
|
+
# Copies one read-able object from one place to another in blocks, obviating the need to load
|
13
|
+
# the whole thing into memory. Defaults to 8k blocks. If this module is included in both
|
14
|
+
# StringIO and Tempfile, then either can have its data copied anywhere else without typing
|
15
|
+
# worries or memory overhead worries. Returns a File if a String is passed in as the destination
|
16
|
+
# and returns the IO or Tempfile as passed in if one is sent as the destination.
|
17
|
+
def stream_to path_or_file, in_blocks_of = 8192
|
18
|
+
dstio = case path_or_file
|
19
|
+
when String then File.new(path_or_file, "wb+")
|
20
|
+
when IO then path_or_file
|
21
|
+
when Tempfile then path_or_file
|
22
|
+
end
|
23
|
+
buffer = ""
|
24
|
+
self.rewind
|
25
|
+
while self.read(in_blocks_of, buffer) do
|
26
|
+
dstio.write(buffer)
|
27
|
+
end
|
28
|
+
dstio.rewind
|
29
|
+
dstio
|
30
|
+
end
|
31
|
+
end
|
32
|
+
|
33
|
+
class IO #:nodoc:
|
34
|
+
include IOStream
|
35
|
+
end
|
36
|
+
|
37
|
+
%w( Tempfile StringIO ).each do |klass|
|
38
|
+
if Object.const_defined? klass
|
39
|
+
Object.const_get(klass).class_eval do
|
40
|
+
include IOStream
|
41
|
+
end
|
42
|
+
end
|
43
|
+
end
|
44
|
+
|
45
|
+
# Corrects a bug in Windows when asking for Tempfile size.
|
46
|
+
if defined? Tempfile
|
47
|
+
class Tempfile
|
48
|
+
def size
|
49
|
+
if @tmpfile
|
50
|
+
@tmpfile.fsync
|
51
|
+
@tmpfile.flush
|
52
|
+
@tmpfile.stat.size
|
53
|
+
else
|
54
|
+
0
|
55
|
+
end
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
@@ -0,0 +1,49 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def have_attached_file name
|
5
|
+
HaveAttachedFileMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class HaveAttachedFileMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
end
|
12
|
+
|
13
|
+
def matches? subject
|
14
|
+
@subject = subject
|
15
|
+
responds? && has_column? && included?
|
16
|
+
end
|
17
|
+
|
18
|
+
def failure_message
|
19
|
+
"Should have an attachment named #{@attachment_name}"
|
20
|
+
end
|
21
|
+
|
22
|
+
def negative_failure_message
|
23
|
+
"Should not have an attachment named #{@attachment_name}"
|
24
|
+
end
|
25
|
+
|
26
|
+
def description
|
27
|
+
"have an attachment named #{@attachment_name}"
|
28
|
+
end
|
29
|
+
|
30
|
+
protected
|
31
|
+
|
32
|
+
def responds?
|
33
|
+
methods = @subject.instance_methods.map(&:to_s)
|
34
|
+
methods.include?("#{@attachment_name}") &&
|
35
|
+
methods.include?("#{@attachment_name}=") &&
|
36
|
+
methods.include?("#{@attachment_name}?")
|
37
|
+
end
|
38
|
+
|
39
|
+
def has_column?
|
40
|
+
@subject.column_names.include?("#{@attachment_name}_file_name")
|
41
|
+
end
|
42
|
+
|
43
|
+
def included?
|
44
|
+
@subject.ancestors.include?(Paperclip::InstanceMethods)
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def validate_attachment_content_type name
|
5
|
+
ValidateAttachmentContentTypeMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class ValidateAttachmentContentTypeMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
end
|
12
|
+
|
13
|
+
def allowing *types
|
14
|
+
@allowed_types = types.flatten
|
15
|
+
self
|
16
|
+
end
|
17
|
+
|
18
|
+
def rejecting *types
|
19
|
+
@rejected_types = types.flatten
|
20
|
+
self
|
21
|
+
end
|
22
|
+
|
23
|
+
def matches? subject
|
24
|
+
@subject = subject
|
25
|
+
@allowed_types && @rejected_types &&
|
26
|
+
allowed_types_allowed? && rejected_types_rejected?
|
27
|
+
end
|
28
|
+
|
29
|
+
def failure_message
|
30
|
+
"Content types #{@allowed_types.join(", ")} should be accepted" +
|
31
|
+
" and #{@rejected_types.join(", ")} rejected by #{@attachment_name}"
|
32
|
+
end
|
33
|
+
|
34
|
+
def negative_failure_message
|
35
|
+
"Content types #{@allowed_types.join(", ")} should be rejected" +
|
36
|
+
" and #{@rejected_types.join(", ")} accepted by #{@attachment_name}"
|
37
|
+
end
|
38
|
+
|
39
|
+
def description
|
40
|
+
"validate the content types allowed on attachment #{@attachment_name}"
|
41
|
+
end
|
42
|
+
|
43
|
+
protected
|
44
|
+
|
45
|
+
def allow_types?(types)
|
46
|
+
types.all? do |type|
|
47
|
+
file = StringIO.new(".")
|
48
|
+
file.content_type = type
|
49
|
+
attachment = @subject.new.attachment_for(@attachment_name)
|
50
|
+
attachment.assign(file)
|
51
|
+
attachment.errors[:content_type].nil?
|
52
|
+
end
|
53
|
+
end
|
54
|
+
|
55
|
+
def allowed_types_allowed?
|
56
|
+
allow_types?(@allowed_types)
|
57
|
+
end
|
58
|
+
|
59
|
+
def rejected_types_rejected?
|
60
|
+
not allow_types?(@rejected_types)
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
|
@@ -0,0 +1,48 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def validate_attachment_presence name
|
5
|
+
ValidateAttachmentPresenceMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class ValidateAttachmentPresenceMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
end
|
12
|
+
|
13
|
+
def matches? subject
|
14
|
+
@subject = subject
|
15
|
+
error_when_not_valid? && no_error_when_valid?
|
16
|
+
end
|
17
|
+
|
18
|
+
def failure_message
|
19
|
+
"Attachment #{@attachment_name} should be required"
|
20
|
+
end
|
21
|
+
|
22
|
+
def negative_failure_message
|
23
|
+
"Attachment #{@attachment_name} should not be required"
|
24
|
+
end
|
25
|
+
|
26
|
+
def description
|
27
|
+
"require presence of attachment #{@attachment_name}"
|
28
|
+
end
|
29
|
+
|
30
|
+
protected
|
31
|
+
|
32
|
+
def error_when_not_valid?
|
33
|
+
@attachment = @subject.new.send(@attachment_name)
|
34
|
+
@attachment.assign(nil)
|
35
|
+
not @attachment.errors[:presence].nil?
|
36
|
+
end
|
37
|
+
|
38
|
+
def no_error_when_valid?
|
39
|
+
@file = StringIO.new(".")
|
40
|
+
@attachment = @subject.new.send(@attachment_name)
|
41
|
+
@attachment.assign(@file)
|
42
|
+
@attachment.errors[:presence].nil?
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
47
|
+
end
|
48
|
+
|
@@ -0,0 +1,83 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Shoulda
|
3
|
+
module Matchers
|
4
|
+
def validate_attachment_size name
|
5
|
+
ValidateAttachmentSizeMatcher.new(name)
|
6
|
+
end
|
7
|
+
|
8
|
+
class ValidateAttachmentSizeMatcher
|
9
|
+
def initialize attachment_name
|
10
|
+
@attachment_name = attachment_name
|
11
|
+
@low, @high = 0, (1.0/0)
|
12
|
+
end
|
13
|
+
|
14
|
+
def less_than size
|
15
|
+
@high = size
|
16
|
+
self
|
17
|
+
end
|
18
|
+
|
19
|
+
def greater_than size
|
20
|
+
@low = size
|
21
|
+
self
|
22
|
+
end
|
23
|
+
|
24
|
+
def in range
|
25
|
+
@low, @high = range.first, range.last
|
26
|
+
self
|
27
|
+
end
|
28
|
+
|
29
|
+
def matches? subject
|
30
|
+
@subject = subject
|
31
|
+
lower_than_low? && higher_than_low? && lower_than_high? && higher_than_high?
|
32
|
+
end
|
33
|
+
|
34
|
+
def failure_message
|
35
|
+
"Attachment #{@attachment_name} must be between #{@low} and #{@high} bytes"
|
36
|
+
end
|
37
|
+
|
38
|
+
def negative_failure_message
|
39
|
+
"Attachment #{@attachment_name} cannot be between #{@low} and #{@high} bytes"
|
40
|
+
end
|
41
|
+
|
42
|
+
def description
|
43
|
+
"validate the size of attachment #{@attachment_name}"
|
44
|
+
end
|
45
|
+
|
46
|
+
protected
|
47
|
+
|
48
|
+
def override_method object, method, &replacement
|
49
|
+
(class << object; self; end).class_eval do
|
50
|
+
define_method(method, &replacement)
|
51
|
+
end
|
52
|
+
end
|
53
|
+
|
54
|
+
def passes_validation_with_size(new_size)
|
55
|
+
file = StringIO.new(".")
|
56
|
+
override_method(file, :size){ new_size }
|
57
|
+
attachment = @subject.new.attachment_for(@attachment_name)
|
58
|
+
attachment.assign(file)
|
59
|
+
attachment.errors[:size].nil?
|
60
|
+
end
|
61
|
+
|
62
|
+
def lower_than_low?
|
63
|
+
not passes_validation_with_size(@low - 1)
|
64
|
+
end
|
65
|
+
|
66
|
+
def higher_than_low?
|
67
|
+
passes_validation_with_size(@low + 1)
|
68
|
+
end
|
69
|
+
|
70
|
+
def lower_than_high?
|
71
|
+
return true if @high == (1.0/0)
|
72
|
+
passes_validation_with_size(@high - 1)
|
73
|
+
end
|
74
|
+
|
75
|
+
def higher_than_high?
|
76
|
+
return true if @high == (1.0/0)
|
77
|
+
not passes_validation_with_size(@high + 1)
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
83
|
+
|
@@ -0,0 +1,49 @@
|
|
1
|
+
module Paperclip
|
2
|
+
# Paperclip processors allow you to modify attached files when they are
|
3
|
+
# attached in any way you are able. Paperclip itself uses command-line
|
4
|
+
# programs for its included Thumbnail processor, but custom processors
|
5
|
+
# are not required to follow suit.
|
6
|
+
#
|
7
|
+
# Processors are required to be defined inside the Paperclip module and
|
8
|
+
# are also required to be a subclass of Paperclip::Processor. There is
|
9
|
+
# only one method you *must* implement to properly be a subclass:
|
10
|
+
# #make, but #initialize may also be of use. Both methods accept 3
|
11
|
+
# arguments: the file that will be operated on (which is an instance of
|
12
|
+
# File), a hash of options that were defined in has_attached_file's
|
13
|
+
# style hash, and the Paperclip::Attachment itself.
|
14
|
+
#
|
15
|
+
# All #make needs to return is an instance of File (Tempfile is
|
16
|
+
# acceptable) which contains the results of the processing.
|
17
|
+
#
|
18
|
+
# See Paperclip.run for more information about using command-line
|
19
|
+
# utilities from within Processors.
|
20
|
+
class Processor
|
21
|
+
attr_accessor :file, :options, :attachment
|
22
|
+
|
23
|
+
def initialize file, options = {}, attachment = nil
|
24
|
+
@file = file
|
25
|
+
@options = options
|
26
|
+
@attachment = attachment
|
27
|
+
end
|
28
|
+
|
29
|
+
def make
|
30
|
+
end
|
31
|
+
|
32
|
+
def self.make file, options = {}, attachment = nil
|
33
|
+
new(file, options, attachment).make
|
34
|
+
end
|
35
|
+
end
|
36
|
+
|
37
|
+
# Due to how ImageMagick handles its image format conversion and how Tempfile
|
38
|
+
# handles its naming scheme, it is necessary to override how Tempfile makes
|
39
|
+
# its names so as to allow for file extensions. Idea taken from the comments
|
40
|
+
# on this blog post:
|
41
|
+
# http://marsorange.com/archives/of-mogrify-ruby-tempfile-dynamic-class-definitions
|
42
|
+
class Tempfile < ::Tempfile
|
43
|
+
# Replaces Tempfile's +make_tmpname+ with one that honors file extensions.
|
44
|
+
def make_tmpname(basename, n)
|
45
|
+
extension = File.extname(basename)
|
46
|
+
sprintf("%s,%d,%d%s", File.basename(basename, extension), $$, n, extension)
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
@@ -0,0 +1,243 @@
|
|
1
|
+
module Paperclip
|
2
|
+
module Storage
|
3
|
+
|
4
|
+
# The default place to store attachments is in the filesystem. Files on the local
|
5
|
+
# filesystem can be very easily served by Apache without requiring a hit to your app.
|
6
|
+
# They also can be processed more easily after they've been saved, as they're just
|
7
|
+
# normal files. There is one Filesystem-specific option for has_attached_file.
|
8
|
+
# * +path+: The location of the repository of attachments on disk. This can (and, in
|
9
|
+
# almost all cases, should) be coordinated with the value of the +url+ option to
|
10
|
+
# allow files to be saved into a place where Apache can serve them without
|
11
|
+
# hitting your app. Defaults to
|
12
|
+
# ":rails_root/public/:attachment/:id/:style/:basename.:extension"
|
13
|
+
# By default this places the files in the app's public directory which can be served
|
14
|
+
# directly. If you are using capistrano for deployment, a good idea would be to
|
15
|
+
# make a symlink to the capistrano-created system directory from inside your app's
|
16
|
+
# public directory.
|
17
|
+
# See Paperclip::Attachment#interpolate for more information on variable interpolaton.
|
18
|
+
# :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
|
19
|
+
module Filesystem
|
20
|
+
def self.extended base
|
21
|
+
end
|
22
|
+
|
23
|
+
def exists?(style = default_style)
|
24
|
+
if original_filename
|
25
|
+
File.exist?(path(style))
|
26
|
+
else
|
27
|
+
false
|
28
|
+
end
|
29
|
+
end
|
30
|
+
|
31
|
+
# Returns representation of the data of the file assigned to the given
|
32
|
+
# style, in the format most representative of the current storage.
|
33
|
+
def to_file style = default_style
|
34
|
+
@queued_for_write[style] || (File.new(path(style), 'rb') if exists?(style))
|
35
|
+
end
|
36
|
+
|
37
|
+
def flush_writes #:nodoc:
|
38
|
+
@queued_for_write.each do |style, file|
|
39
|
+
file.close
|
40
|
+
FileUtils.mkdir_p(File.dirname(path(style)))
|
41
|
+
log("saving #{path(style)}")
|
42
|
+
FileUtils.mv(file.path, path(style))
|
43
|
+
FileUtils.chmod(0644, path(style))
|
44
|
+
end
|
45
|
+
@queued_for_write = {}
|
46
|
+
end
|
47
|
+
|
48
|
+
def flush_deletes #:nodoc:
|
49
|
+
@queued_for_delete.each do |path|
|
50
|
+
begin
|
51
|
+
log("deleting #{path}")
|
52
|
+
FileUtils.rm(path) if File.exist?(path)
|
53
|
+
rescue Errno::ENOENT => e
|
54
|
+
# ignore file-not-found, let everything else pass
|
55
|
+
end
|
56
|
+
begin
|
57
|
+
while(true)
|
58
|
+
path = File.dirname(path)
|
59
|
+
FileUtils.rmdir(path)
|
60
|
+
end
|
61
|
+
rescue Errno::EEXIST, Errno::ENOTEMPTY, Errno::ENOENT, Errno::EINVAL, Errno::ENOTDIR
|
62
|
+
# Stop trying to remove parent directories
|
63
|
+
rescue SystemCallError => e
|
64
|
+
log("There was an unexpected error while deleting directories: #{e.class}")
|
65
|
+
# Ignore it
|
66
|
+
end
|
67
|
+
end
|
68
|
+
@queued_for_delete = []
|
69
|
+
end
|
70
|
+
end
|
71
|
+
|
72
|
+
# Amazon's S3 file hosting service is a scalable, easy place to store files for
|
73
|
+
# distribution. You can find out more about it at http://aws.amazon.com/s3
|
74
|
+
# There are a few S3-specific options for has_attached_file:
|
75
|
+
# * +s3_credentials+: Takes a path, a File, or a Hash. The path (or File) must point
|
76
|
+
# to a YAML file containing the +access_key_id+ and +secret_access_key+ that Amazon
|
77
|
+
# gives you. You can 'environment-space' this just like you do to your
|
78
|
+
# database.yml file, so different environments can use different accounts:
|
79
|
+
# development:
|
80
|
+
# access_key_id: 123...
|
81
|
+
# secret_access_key: 123...
|
82
|
+
# test:
|
83
|
+
# access_key_id: abc...
|
84
|
+
# secret_access_key: abc...
|
85
|
+
# production:
|
86
|
+
# access_key_id: 456...
|
87
|
+
# secret_access_key: 456...
|
88
|
+
# This is not required, however, and the file may simply look like this:
|
89
|
+
# access_key_id: 456...
|
90
|
+
# secret_access_key: 456...
|
91
|
+
# In which case, those access keys will be used in all environments. You can also
|
92
|
+
# put your bucket name in this file, instead of adding it to the code directly.
|
93
|
+
# This is useful when you want the same account but a different bucket for
|
94
|
+
# development versus production.
|
95
|
+
# * +s3_permissions+: This is a String that should be one of the "canned" access
|
96
|
+
# policies that S3 provides (more information can be found here:
|
97
|
+
# http://docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html#RESTCannedAccessPolicies)
|
98
|
+
# The default for Paperclip is :public_read.
|
99
|
+
# * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either
|
100
|
+
# 'http' or 'https'. Defaults to 'http' when your :s3_permissions are :public_read (the
|
101
|
+
# default), and 'https' when your :s3_permissions are anything else.
|
102
|
+
# * +s3_headers+: A hash of headers such as {'Expires' => 1.year.from_now.httpdate}
|
103
|
+
# * +bucket+: This is the name of the S3 bucket that will store your files. Remember
|
104
|
+
# that the bucket must be unique across all of Amazon S3. If the bucket does not exist
|
105
|
+
# Paperclip will attempt to create it. The bucket name will not be interpolated.
|
106
|
+
# You can define the bucket as a Proc if you want to determine it's name at runtime.
|
107
|
+
# Paperclip will call that Proc with attachment as the only argument.
|
108
|
+
# * +s3_host_alias+: The fully-qualified domain name (FQDN) that is the alias to the
|
109
|
+
# S3 domain of your bucket. Used with the :s3_alias_url url interpolation. See the
|
110
|
+
# link in the +url+ entry for more information about S3 domains and buckets.
|
111
|
+
# * +url+: There are three options for the S3 url. You can choose to have the bucket's name
|
112
|
+
# placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket).
|
113
|
+
# Lastly, you can specify a CNAME (which requires the CNAME to be specified as
|
114
|
+
# :s3_alias_url. You can read more about CNAMEs and S3 at
|
115
|
+
# http://docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html
|
116
|
+
# Normally, this won't matter in the slightest and you can leave the default (which is
|
117
|
+
# path-style, or :s3_path_url). But in some cases paths don't work and you need to use
|
118
|
+
# the domain-style (:s3_domain_url). Anything else here will be treated like path-style.
|
119
|
+
# NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your
|
120
|
+
# :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host
|
121
|
+
# alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
|
122
|
+
# by S3.
|
123
|
+
# * +path+: This is the key under the bucket in which the file will be stored. The
|
124
|
+
# URL will be constructed from the bucket and the path. This is what you will want
|
125
|
+
# to interpolate. Keys should be unique, like filenames, and despite the fact that
|
126
|
+
# S3 (strictly speaking) does not support directories, you can still use a / to
|
127
|
+
# separate parts of your file name.
|
128
|
+
module S3
|
129
|
+
def self.extended base
|
130
|
+
begin
|
131
|
+
require 'aws/s3'
|
132
|
+
rescue LoadError => e
|
133
|
+
e.message << " (You may need to install the aws-s3 gem)"
|
134
|
+
raise e
|
135
|
+
end
|
136
|
+
|
137
|
+
base.instance_eval do
|
138
|
+
@s3_credentials = parse_credentials(@options[:s3_credentials])
|
139
|
+
@bucket = @options[:bucket] || @s3_credentials[:bucket]
|
140
|
+
@bucket = @bucket.call(self) if @bucket.is_a?(Proc)
|
141
|
+
@s3_options = @options[:s3_options] || {}
|
142
|
+
@s3_permissions = @options[:s3_permissions] || :public_read
|
143
|
+
@s3_protocol = @options[:s3_protocol] || (@s3_permissions == :public_read ? 'http' : 'https')
|
144
|
+
@s3_headers = @options[:s3_headers] || {}
|
145
|
+
@s3_host_alias = @options[:s3_host_alias]
|
146
|
+
@url = ":s3_path_url" unless @url.to_s.match(/^:s3.*url$/)
|
147
|
+
AWS::S3::Base.establish_connection!( @s3_options.merge(
|
148
|
+
:access_key_id => @s3_credentials[:access_key_id],
|
149
|
+
:secret_access_key => @s3_credentials[:secret_access_key]
|
150
|
+
))
|
151
|
+
end
|
152
|
+
Paperclip.interpolates(:s3_alias_url) do |attachment, style|
|
153
|
+
"#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
|
154
|
+
end
|
155
|
+
Paperclip.interpolates(:s3_path_url) do |attachment, style|
|
156
|
+
"#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
|
157
|
+
end
|
158
|
+
Paperclip.interpolates(:s3_domain_url) do |attachment, style|
|
159
|
+
"#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
|
160
|
+
end
|
161
|
+
end
|
162
|
+
|
163
|
+
def bucket_name
|
164
|
+
@bucket
|
165
|
+
end
|
166
|
+
|
167
|
+
def s3_host_alias
|
168
|
+
@s3_host_alias
|
169
|
+
end
|
170
|
+
|
171
|
+
def parse_credentials creds
|
172
|
+
creds = find_credentials(creds).stringify_keys
|
173
|
+
(creds[RAILS_ENV] || creds).symbolize_keys
|
174
|
+
end
|
175
|
+
|
176
|
+
def exists?(style = default_style)
|
177
|
+
if original_filename
|
178
|
+
AWS::S3::S3Object.exists?(path(style), bucket_name)
|
179
|
+
else
|
180
|
+
false
|
181
|
+
end
|
182
|
+
end
|
183
|
+
|
184
|
+
def s3_protocol
|
185
|
+
@s3_protocol
|
186
|
+
end
|
187
|
+
|
188
|
+
# Returns representation of the data of the file assigned to the given
|
189
|
+
# style, in the format most representative of the current storage.
|
190
|
+
def to_file style = default_style
|
191
|
+
return @queued_for_write[style] if @queued_for_write[style]
|
192
|
+
file = Tempfile.new(path(style))
|
193
|
+
file.write(AWS::S3::S3Object.value(path(style), bucket_name))
|
194
|
+
file.rewind
|
195
|
+
return file
|
196
|
+
end
|
197
|
+
|
198
|
+
def flush_writes #:nodoc:
|
199
|
+
@queued_for_write.each do |style, file|
|
200
|
+
begin
|
201
|
+
log("saving #{path(style)}")
|
202
|
+
AWS::S3::S3Object.store(path(style),
|
203
|
+
file,
|
204
|
+
bucket_name,
|
205
|
+
{:content_type => instance_read(:content_type),
|
206
|
+
:access => @s3_permissions,
|
207
|
+
}.merge(@s3_headers))
|
208
|
+
rescue AWS::S3::ResponseError => e
|
209
|
+
raise
|
210
|
+
end
|
211
|
+
end
|
212
|
+
@queued_for_write = {}
|
213
|
+
end
|
214
|
+
|
215
|
+
def flush_deletes #:nodoc:
|
216
|
+
@queued_for_delete.each do |path|
|
217
|
+
begin
|
218
|
+
log("deleting #{path}")
|
219
|
+
AWS::S3::S3Object.delete(path, bucket_name)
|
220
|
+
rescue AWS::S3::ResponseError
|
221
|
+
# Ignore this.
|
222
|
+
end
|
223
|
+
end
|
224
|
+
@queued_for_delete = []
|
225
|
+
end
|
226
|
+
|
227
|
+
def find_credentials creds
|
228
|
+
case creds
|
229
|
+
when File
|
230
|
+
YAML::load(ERB.new(File.read(creds.path)).result)
|
231
|
+
when String
|
232
|
+
YAML::load(ERB.new(File.read(creds)).result)
|
233
|
+
when Hash
|
234
|
+
creds
|
235
|
+
else
|
236
|
+
raise ArgumentError, "Credentials are not a path, file, or hash."
|
237
|
+
end
|
238
|
+
end
|
239
|
+
private :find_credentials
|
240
|
+
|
241
|
+
end
|
242
|
+
end
|
243
|
+
end
|
@@ -0,0 +1,73 @@
|
|
1
|
+
module Paperclip
|
2
|
+
# Handles thumbnailing images that are uploaded.
|
3
|
+
class Thumbnail < Processor
|
4
|
+
|
5
|
+
attr_accessor :current_geometry, :target_geometry, :format, :whiny, :convert_options, :source_file_options
|
6
|
+
|
7
|
+
# Creates a Thumbnail object set to work on the +file+ given. It
|
8
|
+
# will attempt to transform the image into one defined by +target_geometry+
|
9
|
+
# which is a "WxH"-style string. +format+ will be inferred from the +file+
|
10
|
+
# unless specified. Thumbnail creation will raise no errors unless
|
11
|
+
# +whiny+ is true (which it is, by default. If +convert_options+ is
|
12
|
+
# set, the options will be appended to the convert command upon image conversion
|
13
|
+
def initialize file, options = {}, attachment = nil
|
14
|
+
super
|
15
|
+
geometry = options[:geometry]
|
16
|
+
@file = file
|
17
|
+
@crop = geometry[-1,1] == '#'
|
18
|
+
@target_geometry = Geometry.parse geometry
|
19
|
+
@current_geometry = Geometry.from_file @file
|
20
|
+
@source_file_options = options[:source_file_options]
|
21
|
+
@convert_options = options[:convert_options]
|
22
|
+
@whiny = options[:whiny].nil? ? true : options[:whiny]
|
23
|
+
@format = options[:format]
|
24
|
+
|
25
|
+
@current_format = File.extname(@file.path)
|
26
|
+
@basename = File.basename(@file.path, @current_format)
|
27
|
+
end
|
28
|
+
|
29
|
+
# Returns true if the +target_geometry+ is meant to crop.
|
30
|
+
def crop?
|
31
|
+
@crop
|
32
|
+
end
|
33
|
+
|
34
|
+
# Returns true if the image is meant to make use of additional convert options.
|
35
|
+
def convert_options?
|
36
|
+
!@convert_options.nil? && !@convert_options.empty?
|
37
|
+
end
|
38
|
+
|
39
|
+
# Performs the conversion of the +file+ into a thumbnail. Returns the Tempfile
|
40
|
+
# that contains the new image.
|
41
|
+
def make
|
42
|
+
src = @file
|
43
|
+
dst = Tempfile.new([@basename, @format].compact.join("."))
|
44
|
+
dst.binmode
|
45
|
+
|
46
|
+
command = <<-end_command
|
47
|
+
#{ source_file_options }
|
48
|
+
"#{ File.expand_path(src.path) }[0]"
|
49
|
+
#{ transformation_command }
|
50
|
+
"#{ File.expand_path(dst.path) }"
|
51
|
+
end_command
|
52
|
+
|
53
|
+
begin
|
54
|
+
success = Paperclip.run("convert", command.gsub(/\s+/, " "))
|
55
|
+
rescue PaperclipCommandLineError
|
56
|
+
raise PaperclipError, "There was an error processing the thumbnail for #{@basename}" if @whiny
|
57
|
+
end
|
58
|
+
|
59
|
+
dst
|
60
|
+
end
|
61
|
+
|
62
|
+
# Returns the command ImageMagick's +convert+ needs to transform the image
|
63
|
+
# into the thumbnail.
|
64
|
+
def transformation_command
|
65
|
+
scale, crop = @current_geometry.transformation_to(@target_geometry, crop?)
|
66
|
+
trans = ""
|
67
|
+
trans << " -resize \"#{scale}\"" unless scale.nil? || scale.empty?
|
68
|
+
trans << " -crop \"#{crop}\" +repage" if crop
|
69
|
+
trans << " #{convert_options}" if convert_options?
|
70
|
+
trans
|
71
|
+
end
|
72
|
+
end
|
73
|
+
end
|