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'
    scheme: 'https'
  • 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.

  • +fog_file*: This can be hash or lambda returning hash. The value is used as base properties for new uploaded file.

  • 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)

Constant Summary

AWS_BUCKET_SUBDOMAIN_RESTRICTON_REGEX =
/\A(?:[a-z]|\d(?!\d{0,2}(?:\.\d{1,3}){3}\Z))(?:[a-z0-9]|\.(?![\.\-])|\-(?![\.])){1,61}[a-z0-9]\Z/

Class Method Summary (collapse)

Instance Method Summary (collapse)

Class Method Details

+ (Object) extended(base)



38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
# File 'lib/paperclip/storage/fog.rb', line 38

def self.extended base
  begin
    require 'fog'
  rescue LoadError => e
    e.message << " (You may need to install the fog gem)"
    raise e
  end unless defined?(Fog)

  base.instance_eval do
    unless @options[:url].to_s.match(/\A:fog.*url\Z/)
      @options[:path]  = @options[:path].gsub(/:url/, @options[:url]).gsub(/\A:rails_root\/public\/system\//, '')
      @options[:url]   = ':fog_public_url'
    end
    Paperclip.interpolates(:fog_public_url) do |attachment, style|
      attachment.public_url(style)
    end unless Paperclip::Interpolations.respond_to? :fog_public_url
  end
end

Instance Method Details

- (Object) copy_to_local_file(style, local_dest_path)



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

def copy_to_local_file(style, local_dest_path)
  log("copying #{path(style)} to local file #{local_dest_path}")
  ::File.open(local_dest_path, 'wb') do |local_file|
    file = directory.files.get(path(style))
    local_file.write(file.body)
  end
rescue ::Fog::Errors::Error => e
  warn("#{e} - cannot copy #{path(style)} to local file #{local_dest_path}")
  false
end

- (Boolean) exists?(style = default_style)

Returns:

  • (Boolean)


59
60
61
62
63
64
65
# File 'lib/paperclip/storage/fog.rb', line 59

def exists?(style = default_style)
  if original_filename
    !!directory.files.head(path(style))
  else
    false
  end
end

- (Object) expiring_url(time = (Time.now + 3600), style_name = default_style)



142
143
144
145
146
147
148
149
150
151
152
153
154
155
# File 'lib/paperclip/storage/fog.rb', line 142

def expiring_url(time = (Time.now + 3600), style_name = default_style)
  time = convert_time(time)
  if path(style_name) && directory.files.respond_to?(:get_http_url)
    expiring_url = directory.files.get_http_url(path(style_name), time)

    if @options[:fog_host]
      expiring_url.gsub!(/#{host_name_for_directory}/, dynamic_fog_host_for_style(style_name))
    end
  else
    expiring_url = url(style_name)
  end

  return expiring_url
end

- (Object) flush_deletes



122
123
124
125
126
127
128
# File 'lib/paperclip/storage/fog.rb', line 122

def flush_deletes
  for path in @queued_for_delete do
    log("deleting #{path}")
    directory.files.new(:key => path).destroy
  end
  @queued_for_delete = []
end

- (Object) flush_writes



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
# File 'lib/paperclip/storage/fog.rb', line 96

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(style),
        :content_type => file.content_type
      ))
    rescue Excon::Errors::NotFound
      raise if retried
      retried = true
      directory.save
      retry
    ensure
      file.rewind
    end
  end

  after_flush_writes # allows attachment to clean up temp files

  @queued_for_write = {}
end

- (Object) fog_credentials



67
68
69
# File 'lib/paperclip/storage/fog.rb', line 67

def fog_credentials
  @fog_credentials ||= parse_credentials(@options[:fog_credentials])
end

- (Object) fog_file



71
72
73
74
75
76
77
78
79
80
81
82
# File 'lib/paperclip/storage/fog.rb', line 71

def fog_file
  @fog_file ||= begin
    value = @options[:fog_file]
    if !value
      {}
    elsif value.respond_to?(:call)
      value.call(self)
    else
      value
    end
  end
end

- (Object) fog_public(style = default_style)



84
85
86
87
88
89
90
91
92
93
94
# File 'lib/paperclip/storage/fog.rb', line 84

def fog_public(style = default_style)
  if @options.has_key?(:fog_public)
    if @options[:fog_public].respond_to?(:has_key?) && @options[:fog_public].has_key?(style)
      @options[:fog_public][style]
    else
      @options[:fog_public]
    end
  else
    true
  end
end

- (Object) parse_credentials(creds)



157
158
159
160
161
# File 'lib/paperclip/storage/fog.rb', line 157

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

- (Object) public_url(style = default_style)



130
131
132
133
134
135
136
137
138
139
140
# File 'lib/paperclip/storage/fog.rb', line 130

def public_url(style = default_style)
  if @options[:fog_host]
    "#{dynamic_fog_host_for_style(style)}/#{path(style)}"
  else
    if fog_credentials[:provider] == 'AWS'
      "#{scheme}://#{host_name_for_directory}/#{path(style)}"
    else
      directory.files.new(:key => path(style)).public_url
    end
  end
end