paperclip-youtube 2.3.8.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. data/LICENSE +26 -0
  2. data/README.md +91 -0
  3. data/Rakefile +80 -0
  4. data/generators/paperclip/USAGE +5 -0
  5. data/generators/paperclip/paperclip_generator.rb +27 -0
  6. data/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  7. data/init.rb +1 -0
  8. data/lib/generators/paperclip/USAGE +8 -0
  9. data/lib/generators/paperclip/paperclip_generator.rb +31 -0
  10. data/lib/generators/paperclip/templates/paperclip_migration.rb.erb +19 -0
  11. data/lib/paperclip.rb +378 -0
  12. data/lib/paperclip/attachment.rb +376 -0
  13. data/lib/paperclip/callback_compatability.rb +61 -0
  14. data/lib/paperclip/command_line.rb +86 -0
  15. data/lib/paperclip/geometry.rb +115 -0
  16. data/lib/paperclip/interpolations.rb +130 -0
  17. data/lib/paperclip/iostream.rb +45 -0
  18. data/lib/paperclip/matchers.rb +33 -0
  19. data/lib/paperclip/matchers/have_attached_file_matcher.rb +57 -0
  20. data/lib/paperclip/matchers/validate_attachment_content_type_matcher.rb +75 -0
  21. data/lib/paperclip/matchers/validate_attachment_presence_matcher.rb +54 -0
  22. data/lib/paperclip/matchers/validate_attachment_size_matcher.rb +95 -0
  23. data/lib/paperclip/processor.rb +58 -0
  24. data/lib/paperclip/railtie.rb +24 -0
  25. data/lib/paperclip/storage.rb +3 -0
  26. data/lib/paperclip/storage/filesystem.rb +73 -0
  27. data/lib/paperclip/storage/s3.rb +192 -0
  28. data/lib/paperclip/storage/youtube.rb +331 -0
  29. data/lib/paperclip/style.rb +90 -0
  30. data/lib/paperclip/thumbnail.rb +79 -0
  31. data/lib/paperclip/upfile.rb +55 -0
  32. data/lib/paperclip/version.rb +3 -0
  33. data/lib/tasks/paperclip.rake +72 -0
  34. data/rails/init.rb +2 -0
  35. data/shoulda_macros/paperclip.rb +118 -0
  36. data/test/attachment_test.rb +921 -0
  37. data/test/command_line_test.rb +138 -0
  38. data/test/database.yml +4 -0
  39. data/test/fixtures/12k.png +0 -0
  40. data/test/fixtures/50x50.png +0 -0
  41. data/test/fixtures/5k.png +0 -0
  42. data/test/fixtures/bad.png +1 -0
  43. data/test/fixtures/s3.yml +8 -0
  44. data/test/fixtures/text.txt +0 -0
  45. data/test/fixtures/twopage.pdf +0 -0
  46. data/test/fixtures/uppercase.PNG +0 -0
  47. data/test/geometry_test.rb +177 -0
  48. data/test/helper.rb +146 -0
  49. data/test/integration_test.rb +570 -0
  50. data/test/interpolations_test.rb +143 -0
  51. data/test/iostream_test.rb +71 -0
  52. data/test/matchers/have_attached_file_matcher_test.rb +24 -0
  53. data/test/matchers/validate_attachment_content_type_matcher_test.rb +47 -0
  54. data/test/matchers/validate_attachment_presence_matcher_test.rb +26 -0
  55. data/test/matchers/validate_attachment_size_matcher_test.rb +51 -0
  56. data/test/paperclip_test.rb +301 -0
  57. data/test/processor_test.rb +10 -0
  58. data/test/storage_test.rb +386 -0
  59. data/test/style_test.rb +141 -0
  60. data/test/thumbnail_test.rb +227 -0
  61. data/test/upfile_test.rb +36 -0
  62. metadata +195 -0
@@ -0,0 +1,54 @@
1
+ module Paperclip
2
+ module Shoulda
3
+ module Matchers
4
+ # Ensures that the given instance or class validates the presence of the
5
+ # given attachment.
6
+ #
7
+ # describe User do
8
+ # it { should validate_attachment_presence(:avatar) }
9
+ # end
10
+ def validate_attachment_presence name
11
+ ValidateAttachmentPresenceMatcher.new(name)
12
+ end
13
+
14
+ class ValidateAttachmentPresenceMatcher
15
+ def initialize attachment_name
16
+ @attachment_name = attachment_name
17
+ end
18
+
19
+ def matches? subject
20
+ @subject = subject
21
+ @subject = @subject.class unless Class === @subject
22
+ error_when_not_valid? && no_error_when_valid?
23
+ end
24
+
25
+ def failure_message
26
+ "Attachment #{@attachment_name} should be required"
27
+ end
28
+
29
+ def negative_failure_message
30
+ "Attachment #{@attachment_name} should not be required"
31
+ end
32
+
33
+ def description
34
+ "require presence of attachment #{@attachment_name}"
35
+ end
36
+
37
+ protected
38
+
39
+ def error_when_not_valid?
40
+ (subject = @subject.new).send(@attachment_name).assign(nil)
41
+ subject.valid?
42
+ not subject.errors[:"#{@attachment_name}_file_name"].blank?
43
+ end
44
+
45
+ def no_error_when_valid?
46
+ @file = StringIO.new(".")
47
+ (subject = @subject.new).send(@attachment_name).assign(@file)
48
+ subject.valid?
49
+ subject.errors[:"#{@attachment_name}_file_name"].blank?
50
+ end
51
+ end
52
+ end
53
+ end
54
+ end
@@ -0,0 +1,95 @@
1
+ module Paperclip
2
+ module Shoulda
3
+ module Matchers
4
+ # Ensures that the given instance or class validates the size of the
5
+ # given attachment as specified.
6
+ #
7
+ # Examples:
8
+ # it { should validate_attachment_size(:avatar).
9
+ # less_than(2.megabytes) }
10
+ # it { should validate_attachment_size(:icon).
11
+ # greater_than(1024) }
12
+ # it { should validate_attachment_size(:icon).
13
+ # in(0..100) }
14
+ def validate_attachment_size name
15
+ ValidateAttachmentSizeMatcher.new(name)
16
+ end
17
+
18
+ class ValidateAttachmentSizeMatcher
19
+ def initialize attachment_name
20
+ @attachment_name = attachment_name
21
+ @low, @high = 0, (1.0/0)
22
+ end
23
+
24
+ def less_than size
25
+ @high = size
26
+ self
27
+ end
28
+
29
+ def greater_than size
30
+ @low = size
31
+ self
32
+ end
33
+
34
+ def in range
35
+ @low, @high = range.first, range.last
36
+ self
37
+ end
38
+
39
+ def matches? subject
40
+ @subject = subject
41
+ @subject = @subject.class unless Class === @subject
42
+ lower_than_low? && higher_than_low? && lower_than_high? && higher_than_high?
43
+ end
44
+
45
+ def failure_message
46
+ "Attachment #{@attachment_name} must be between #{@low} and #{@high} bytes"
47
+ end
48
+
49
+ def negative_failure_message
50
+ "Attachment #{@attachment_name} cannot be between #{@low} and #{@high} bytes"
51
+ end
52
+
53
+ def description
54
+ "validate the size of attachment #{@attachment_name}"
55
+ end
56
+
57
+ protected
58
+
59
+ def override_method object, method, &replacement
60
+ (class << object; self; end).class_eval do
61
+ define_method(method, &replacement)
62
+ end
63
+ end
64
+
65
+ def passes_validation_with_size(new_size)
66
+ file = StringIO.new(".")
67
+ override_method(file, :size){ new_size }
68
+ override_method(file, :to_tempfile){ file }
69
+
70
+ (subject = @subject.new).send(@attachment_name).assign(file)
71
+ subject.valid?
72
+ subject.errors[:"#{@attachment_name}_file_size"].blank?
73
+ end
74
+
75
+ def lower_than_low?
76
+ not passes_validation_with_size(@low - 1)
77
+ end
78
+
79
+ def higher_than_low?
80
+ passes_validation_with_size(@low + 1)
81
+ end
82
+
83
+ def lower_than_high?
84
+ return true if @high == (1.0/0)
85
+ passes_validation_with_size(@high - 1)
86
+ end
87
+
88
+ def higher_than_high?
89
+ return true if @high == (1.0/0)
90
+ not passes_validation_with_size(@high + 1)
91
+ end
92
+ end
93
+ end
94
+ end
95
+ end
@@ -0,0 +1,58 @@
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
+ # This is Ruby 1.8.7's implementation.
44
+ if RUBY_VERSION <= "1.8.6"
45
+ def make_tmpname(basename, n)
46
+ case basename
47
+ when Array
48
+ prefix, suffix = *basename
49
+ else
50
+ prefix, suffix = basename, ''
51
+ end
52
+
53
+ t = Time.now.strftime("%y%m%d")
54
+ path = "#{prefix}#{t}-#{$$}-#{rand(0x100000000).to_s(36)}-#{n}#{suffix}"
55
+ end
56
+ end
57
+ end
58
+ end
@@ -0,0 +1,24 @@
1
+ require 'paperclip'
2
+
3
+ module Paperclip
4
+ if defined? Rails::Railtie
5
+ require 'rails'
6
+ class Railtie < Rails::Railtie
7
+ initializer 'paperclip.insert_into_active_record' do
8
+ ActiveSupport.on_load :active_record do
9
+ Paperclip::Railtie.insert
10
+ end
11
+ end
12
+ rake_tasks do
13
+ load "tasks/paperclip.rake"
14
+ end
15
+ end
16
+ end
17
+
18
+ class Railtie
19
+ def self.insert
20
+ ActiveRecord::Base.send(:include, Paperclip::Glue)
21
+ File.send(:include, Paperclip::Upfile)
22
+ end
23
+ end
24
+ end
@@ -0,0 +1,3 @@
1
+ require "paperclip/storage/filesystem"
2
+ require "paperclip/storage/s3"
3
+ require "paperclip/storage/youtube"
@@ -0,0 +1,73 @@
1
+ module Paperclip
2
+ module Storage
3
+ # The default place to store attachments is in the filesystem. Files on the local
4
+ # filesystem can be very easily served by Apache without requiring a hit to your app.
5
+ # They also can be processed more easily after they've been saved, as they're just
6
+ # normal files. There is one Filesystem-specific option for has_attached_file.
7
+ # * +path+: The location of the repository of attachments on disk. This can (and, in
8
+ # almost all cases, should) be coordinated with the value of the +url+ option to
9
+ # allow files to be saved into a place where Apache can serve them without
10
+ # hitting your app. Defaults to
11
+ # ":rails_root/public/:attachment/:id/:style/:basename.:extension"
12
+ # By default this places the files in the app's public directory which can be served
13
+ # directly. If you are using capistrano for deployment, a good idea would be to
14
+ # make a symlink to the capistrano-created system directory from inside your app's
15
+ # public directory.
16
+ # See Paperclip::Attachment#interpolate for more information on variable interpolaton.
17
+ # :path => "/var/app/attachments/:class/:id/:style/:basename.:extension"
18
+ module Filesystem
19
+ def self.extended base
20
+ end
21
+
22
+ def exists?(style_name = default_style)
23
+ if original_filename
24
+ File.exist?(path(style_name))
25
+ else
26
+ false
27
+ end
28
+ end
29
+
30
+ # Returns representation of the data of the file assigned to the given
31
+ # style, in the format most representative of the current storage.
32
+ def to_file style_name = default_style
33
+ @queued_for_write[style_name] || (File.new(path(style_name), 'rb') if exists?(style_name))
34
+ end
35
+
36
+ def flush_writes #:nodoc:
37
+ @queued_for_write.each do |style_name, file|
38
+ file.close
39
+ FileUtils.mkdir_p(File.dirname(path(style_name)))
40
+ log("saving #{path(style_name)}")
41
+ FileUtils.mv(file.path, path(style_name))
42
+ FileUtils.chmod(0644, path(style_name))
43
+ end
44
+ @queued_for_write = {}
45
+ end
46
+
47
+ def flush_deletes #:nodoc:
48
+ @queued_for_delete.each do |path|
49
+ begin
50
+ log("deleting #{path}")
51
+ FileUtils.rm(path) if File.exist?(path)
52
+ rescue Errno::ENOENT => e
53
+ # ignore file-not-found, let everything else pass
54
+ end
55
+ begin
56
+ while(true)
57
+ path = File.dirname(path)
58
+ FileUtils.rmdir(path)
59
+ break if File.exists?(path) # Ruby 1.9.2 does not raise if the removal failed.
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
+ end
73
+ end
@@ -0,0 +1,192 @@
1
+ module Paperclip
2
+ module Storage
3
+ # Amazon's S3 file hosting service is a scalable, easy place to store files for
4
+ # distribution. You can find out more about it at http://aws.amazon.com/s3
5
+ # There are a few S3-specific options for has_attached_file:
6
+ # * +s3_credentials+: Takes a path, a File, or a Hash. The path (or File) must point
7
+ # to a YAML file containing the +access_key_id+ and +secret_access_key+ that Amazon
8
+ # gives you. You can 'environment-space' this just like you do to your
9
+ # database.yml file, so different environments can use different accounts:
10
+ # development:
11
+ # access_key_id: 123...
12
+ # secret_access_key: 123...
13
+ # test:
14
+ # access_key_id: abc...
15
+ # secret_access_key: abc...
16
+ # production:
17
+ # access_key_id: 456...
18
+ # secret_access_key: 456...
19
+ # This is not required, however, and the file may simply look like this:
20
+ # access_key_id: 456...
21
+ # secret_access_key: 456...
22
+ # In which case, those access keys will be used in all environments. You can also
23
+ # put your bucket name in this file, instead of adding it to the code directly.
24
+ # This is useful when you want the same account but a different bucket for
25
+ # development versus production.
26
+ # * +s3_permissions+: This is a String that should be one of the "canned" access
27
+ # policies that S3 provides (more information can be found here:
28
+ # http://docs.amazonwebservices.com/AmazonS3/2006-03-01/RESTAccessPolicy.html#RESTCannedAccessPolicies)
29
+ # The default for Paperclip is :public_read.
30
+ # * +s3_protocol+: The protocol for the URLs generated to your S3 assets. Can be either
31
+ # 'http' or 'https'. Defaults to 'http' when your :s3_permissions are :public_read (the
32
+ # default), and 'https' when your :s3_permissions are anything else.
33
+ # * +s3_headers+: A hash of headers such as {'Expires' => 1.year.from_now.httpdate}
34
+ # * +bucket+: This is the name of the S3 bucket that will store your files. Remember
35
+ # that the bucket must be unique across all of Amazon S3. If the bucket does not exist
36
+ # Paperclip will attempt to create it. The bucket name will not be interpolated.
37
+ # You can define the bucket as a Proc if you want to determine it's name at runtime.
38
+ # Paperclip will call that Proc with attachment as the only argument.
39
+ # * +s3_host_alias+: The fully-qualified domain name (FQDN) that is the alias to the
40
+ # S3 domain of your bucket. Used with the :s3_alias_url url interpolation. See the
41
+ # link in the +url+ entry for more information about S3 domains and buckets.
42
+ # * +url+: There are three options for the S3 url. You can choose to have the bucket's name
43
+ # placed domain-style (bucket.s3.amazonaws.com) or path-style (s3.amazonaws.com/bucket).
44
+ # Lastly, you can specify a CNAME (which requires the CNAME to be specified as
45
+ # :s3_alias_url. You can read more about CNAMEs and S3 at
46
+ # http://docs.amazonwebservices.com/AmazonS3/latest/index.html?VirtualHosting.html
47
+ # Normally, this won't matter in the slightest and you can leave the default (which is
48
+ # path-style, or :s3_path_url). But in some cases paths don't work and you need to use
49
+ # the domain-style (:s3_domain_url). Anything else here will be treated like path-style.
50
+ # NOTE: If you use a CNAME for use with CloudFront, you can NOT specify https as your
51
+ # :s3_protocol; This is *not supported* by S3/CloudFront. Finally, when using the host
52
+ # alias, the :bucket parameter is ignored, as the hostname is used as the bucket name
53
+ # by S3.
54
+ # * +path+: This is the key under the bucket in which the file will be stored. The
55
+ # URL will be constructed from the bucket and the path. This is what you will want
56
+ # to interpolate. Keys should be unique, like filenames, and despite the fact that
57
+ # S3 (strictly speaking) does not support directories, you can still use a / to
58
+ # separate parts of your file name.
59
+ module S3
60
+ def self.extended base
61
+ begin
62
+ require 'aws/s3'
63
+ rescue LoadError => e
64
+ e.message << " (You may need to install the aws-s3 gem)"
65
+ raise e
66
+ end unless defined?(AWS::S3)
67
+
68
+ base.instance_eval do
69
+ @s3_credentials = parse_credentials(@options[:s3_credentials])
70
+ @bucket = @options[:bucket] || @s3_credentials[:bucket]
71
+ @bucket = @bucket.call(self) if @bucket.is_a?(Proc)
72
+ @s3_options = @options[:s3_options] || {}
73
+ @s3_permissions = @options[:s3_permissions] || :public_read
74
+ @s3_protocol = @options[:s3_protocol] || (@s3_permissions == :public_read ? 'http' : 'https')
75
+ @s3_headers = @options[:s3_headers] || {}
76
+ @s3_host_alias = @options[:s3_host_alias]
77
+ unless @url.to_s.match(/^:s3.*url$/)
78
+ @path = @path.gsub(/:url/, @url)
79
+ @url = ":s3_path_url"
80
+ end
81
+ AWS::S3::Base.establish_connection!( @s3_options.merge(
82
+ :access_key_id => @s3_credentials[:access_key_id],
83
+ :secret_access_key => @s3_credentials[:secret_access_key]
84
+ ))
85
+ end
86
+ Paperclip.interpolates(:s3_alias_url) do |attachment, style|
87
+ "#{attachment.s3_protocol}://#{attachment.s3_host_alias}/#{attachment.path(style).gsub(%r{^/}, "")}"
88
+ end unless Paperclip::Interpolations.respond_to? :s3_alias_url
89
+ Paperclip.interpolates(:s3_path_url) do |attachment, style|
90
+ "#{attachment.s3_protocol}://s3.amazonaws.com/#{attachment.bucket_name}/#{attachment.path(style).gsub(%r{^/}, "")}"
91
+ end unless Paperclip::Interpolations.respond_to? :s3_path_url
92
+ Paperclip.interpolates(:s3_domain_url) do |attachment, style|
93
+ "#{attachment.s3_protocol}://#{attachment.bucket_name}.s3.amazonaws.com/#{attachment.path(style).gsub(%r{^/}, "")}"
94
+ end unless Paperclip::Interpolations.respond_to? :s3_domain_url
95
+ end
96
+
97
+ def expiring_url(time = 3600)
98
+ AWS::S3::S3Object.url_for(path, bucket_name, :expires_in => time )
99
+ end
100
+
101
+ def bucket_name
102
+ @bucket
103
+ end
104
+
105
+ def s3_host_alias
106
+ @s3_host_alias
107
+ end
108
+
109
+ def parse_credentials creds
110
+ creds = find_credentials(creds).stringify_keys
111
+ (creds[Rails.env] || creds).symbolize_keys
112
+ end
113
+
114
+ def exists?(style = default_style)
115
+ if original_filename
116
+ AWS::S3::S3Object.exists?(path(style), bucket_name)
117
+ else
118
+ false
119
+ end
120
+ end
121
+
122
+ def s3_protocol
123
+ @s3_protocol
124
+ end
125
+
126
+ # Returns representation of the data of the file assigned to the given
127
+ # style, in the format most representative of the current storage.
128
+ def to_file style = default_style
129
+ return @queued_for_write[style] if @queued_for_write[style]
130
+ filename = path(style)
131
+ extname = File.extname(filename)
132
+ basename = File.basename(filename, extname)
133
+ file = Tempfile.new([basename, extname])
134
+ file.binmode
135
+ file.write(AWS::S3::S3Object.value(path(style), bucket_name))
136
+ file.rewind
137
+ return file
138
+ end
139
+
140
+ def create_bucket
141
+ AWS::S3::Bucket.create(bucket_name)
142
+ end
143
+
144
+ def flush_writes #:nodoc:
145
+ @queued_for_write.each do |style, file|
146
+ begin
147
+ log("saving #{path(style)}")
148
+ AWS::S3::S3Object.store(path(style),
149
+ file,
150
+ bucket_name,
151
+ {:content_type => instance_read(:content_type),
152
+ :access => @s3_permissions,
153
+ }.merge(@s3_headers))
154
+ rescue AWS::S3::NoSuchBucket => e
155
+ create_bucket
156
+ retry
157
+ rescue AWS::S3::ResponseError => e
158
+ raise
159
+ end
160
+ end
161
+ @queued_for_write = {}
162
+ end
163
+
164
+ def flush_deletes #:nodoc:
165
+ @queued_for_delete.each do |path|
166
+ begin
167
+ log("deleting #{path}")
168
+ AWS::S3::S3Object.delete(path, bucket_name)
169
+ rescue AWS::S3::ResponseError
170
+ # Ignore this.
171
+ end
172
+ end
173
+ @queued_for_delete = []
174
+ end
175
+
176
+ def find_credentials creds
177
+ case creds
178
+ when File
179
+ YAML::load(ERB.new(File.read(creds.path)).result)
180
+ when String, Pathname
181
+ YAML::load(ERB.new(File.read(creds)).result)
182
+ when Hash
183
+ creds
184
+ else
185
+ raise ArgumentError, "Credentials are not a path, file, or hash."
186
+ end
187
+ end
188
+ private :find_credentials
189
+
190
+ end
191
+ end
192
+ end