Module: Paperclip::Storage::Fog
- Defined in:
- lib/paperclip/storage/fog.rb
Overview
fog is a modern and versatile cloud computing library for Ruby. Among others, it supports Amazon S3 to store your files. In contrast to the outdated AWS-S3 gem it is actively maintained and supports multiple locations. Amazon’s S3 file hosting service is a scalable, easy place to store files for distribution. You can find out more about it at aws.amazon.com/s3 There are a few fog-specific options for has_attached_file, which will be explained using S3 as an example:
-
fog_credentials
: Takes a Hash with your credentials. For S3, you can use the following format:aws_access_key_id: '<your aws_access_key_id>' aws_secret_access_key: '<your aws_secret_access_key>' provider: 'AWS' region: 'eu-west-1'
-
fog_directory
: This is the name of the S3 bucket that will store your files. Remember that the bucket must be unique across all of Amazon S3. If the bucket does not exist, Paperclip will attempt to create it. -
path
: This is the key under the bucket in which the file will be stored. The URL will be constructed from the bucket and the path. This is what you will want to interpolate. Keys should be unique, like filenames, and despite the fact that S3 (strictly speaking) does not support directories, you can still use a / to separate parts of your file name. -
fog_public
: (optional, defaults to true) Should the uploaded files be public or not? (true/false) -
fog_host
: (optional) The fully-qualified domain name (FQDN) that is the alias to the S3 domain of your bucket, e.g. ‘images.example.com’. This can also be used in conjunction with Cloudfront (aws.amazon.com/cloudfront)
Class Method Summary collapse
Instance Method Summary collapse
- #exists?(style = default_style) ⇒ Boolean
- #flush_deletes ⇒ Object
- #flush_writes ⇒ Object
- #fog_credentials ⇒ Object
- #fog_file ⇒ Object
- #fog_public ⇒ Object
- #parse_credentials(creds) ⇒ Object
- #public_url(style = default_style) ⇒ Object
-
#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.
Class Method Details
.extended(base) ⇒ Object
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 |
# File 'lib/paperclip/storage/fog.rb', line 35 def self.extended base begin require 'fog' rescue LoadError => e e. << " (You may need to install the fog gem)" raise e end unless defined?(Fog) base.instance_eval do unless @options.url.to_s.match(/^:fog.*url$/) @options.path = @options.path.gsub(/:url/, @options.url) @options.url = ':fog_public_url' end Paperclip.interpolates(:fog_public_url) do |, style| .public_url(style) end unless Paperclip::Interpolations.respond_to? :fog_public_url end end |
Instance Method Details
#exists?(style = default_style) ⇒ Boolean
54 55 56 57 58 59 60 |
# File 'lib/paperclip/storage/fog.rb', line 54 def exists?(style = default_style) if original_filename !!directory.files.head(path(style)) else false end end |
#flush_deletes ⇒ Object
97 98 99 100 101 102 103 |
# File 'lib/paperclip/storage/fog.rb', line 97 def flush_deletes for path in @queued_for_delete do log("deleting #{path}") directory.files.new(:key => path).destroy end @queued_for_delete = [] end |
#flush_writes ⇒ Object
74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/paperclip/storage/fog.rb', line 74 def flush_writes for style, file in @queued_for_write do log("saving #{path(style)}") retried = false begin directory.files.create(fog_file.merge( :body => file, :key => path(style), :public => fog_public )) rescue Excon::Errors::NotFound raise if retried retried = true directory.save retry end end after_flush_writes # allows attachment to clean up temp files @queued_for_write = {} end |
#fog_credentials ⇒ Object
62 63 64 |
# File 'lib/paperclip/storage/fog.rb', line 62 def fog_credentials @fog_credentials ||= parse_credentials(@options.fog_credentials) end |
#fog_file ⇒ Object
66 67 68 |
# File 'lib/paperclip/storage/fog.rb', line 66 def fog_file @fog_file ||= @options.fog_file || {} end |
#fog_public ⇒ Object
70 71 72 |
# File 'lib/paperclip/storage/fog.rb', line 70 def fog_public @fog_public ||= @options.fog_public || true end |
#parse_credentials(creds) ⇒ Object
132 133 134 135 136 |
# File 'lib/paperclip/storage/fog.rb', line 132 def parse_credentials(creds) creds = find_credentials(creds).stringify_keys env = Object.const_defined?(:Rails) ? Rails.env : nil (creds[env] || creds).symbolize_keys end |
#public_url(style = default_style) ⇒ Object
123 124 125 126 127 128 129 130 |
# File 'lib/paperclip/storage/fog.rb', line 123 def public_url(style = default_style) if @options.fog_host host = (@options.fog_host =~ /%d/) ? @options.fog_host % (path(style).hash % 4) : @options.fog_host "#{host}/#{path(style)}" else directory.files.new(:key => path(style)).public_url end 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.
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 |
# File 'lib/paperclip/storage/fog.rb', line 107 def to_file(style = default_style) if @queued_for_write[style] @queued_for_write[style] else body = directory.files.get(path(style)).body filename = path(style) extname = File.extname(filename) basename = File.basename(filename, extname) file = Tempfile.new([basename, extname]) file.binmode file.write(body) file.rewind file end end |