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)

Constant Summary collapse

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

Class Method Summary collapse

Instance Method Summary collapse

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.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(/^:fog.*url$/)
      @options[:path]  = @options[:path].gsub(/:url/, @options[:url]).gsub(/^: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

#copy_to_local_file(style, local_dest_path) ⇒ Object 



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

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

#exists?(style = default_style) ⇒ Boolean

Returns:

  • (Boolean) 


56
57
58
59
60
61
62
 
# File 'lib/paperclip/storage/fog.rb', line 56

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

#expiring_url(time = (Time.now + 3600), style = default_style) ⇒ Object 



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

def expiring_url(time = (Time.now + 3600), style = default_style)
  expiring_url = directory.files.get_http_url(path(style), time)

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

  return expiring_url
end

#flush_deletes ⇒ Object 



110
111
112
113
114
115
116
 
# File 'lib/paperclip/storage/fog.rb', line 110

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 



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/paperclip/storage/fog.rb', line 84

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

#fog_credentials ⇒ Object 



64
65
66
 
# File 'lib/paperclip/storage/fog.rb', line 64

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

#fog_file ⇒ Object 



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

def fog_file
  @fog_file ||= @options[:fog_file] || {}
end

#fog_public(style = default_style) ⇒ Object 



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

def fog_public(style = default_style)
  if defined?(@options[:fog_public])
    if defined?(@options[:fog_public][style])
      return @options[:fog_public][style]
    else
      return @options[:fog_public]
    end
  else
    return true
  end
end

#parse_credentials(creds) ⇒ Object 



140
141
142
143
144
 
# File 'lib/paperclip/storage/fog.rb', line 140

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 



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

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