Module: Paperclip::Storage::Azure

Defined in:
lib/paperclip/storage/azure.rb,
lib/paperclip/storage/azure/environment.rb

Overview

Azure’s container file hosting service is a scalable, easy place to store files for distribution. You can find out more about it at azure.microsoft.com/en-us/services/storage/

To use Paperclip with Azure, include the azure-storage-blob gem in your Gemfile:

gem 'azure-storage-blob'

There are a few Azure-specific options for has_attached_file:

  • azure_credentials: Takes a path, a File, a Hash or a Proc. The path (or File) must point to a YAML file containing the storage_access_key and storage_account_name that azure gives you. You can ‘environment-space’ this just like you do to your database.yml file, so different environments can use different accounts:

    development:
  storage_account_name: foo
  storage_access_key: 123...
test:
  storage_account_name: foo
  storage_access_key: abc...
production:
  storage_account_name: foo
  storage_access_key: 456...

    This is not required, however, and the file may simply look like this:

    storage_account_name: foo
storage_access_key: 456...

    In which case, those access keys will be used in all environments. You can also put your container name in this file, instead of adding it to the code directly. This is useful when you want the same account but a different container for development versus production. When using a Proc it provides a single parameter which is the attachment itself. A method #instance is available on the attachment which will take you back to your code. eg.

    class User
  has_attached_file :download,
                    :storage => :azure,
                    :azure_credentials => Proc.new{|a| a.instance.azure_credentials }

  def azure_credentials
    { :container => "xxx", :storage_account_name => "xxx", :storage_access_key => "xxx" }
  end
end

  • container: This is the name of the Azure container that will store your files. Remember that the container must be unique across the storage account. If the container does not exist Paperclip will attempt to create it. The container name will not be interpolated. You can define the container as a Proc if you want to determine it’s name at runtime. Paperclip will call that Proc with attachment as the only argument.

  • path: This is the key under the container in which the file will be stored. The URL will be constructed from the container and the path. This is what you will want to interpolate. Keys should be unique, like filenames, and despite the fact that Azure (strictly speaking) does not support directories, you can still use a / to separate parts of your file name.

  • region: Depending on the region, different base urls are used. Supported values :global, :de

Defined Under Namespace

Classes: Environment

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.extended(base) ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/paperclip/storage/azure.rb', line 57

def self.extended base
  base.instance_eval do
    @azure_options     = @options[:azure_options]     || {}

    unless @options[:url].to_s.match(/\A:azure.*url\z/) || @options[:url] == ":asset_host".freeze
      @options[:path] = path_option.gsub(/:url/, @options[:url]).sub(/\A:rails_root\/public\/system/, "".freeze)
      @options[:url]  = ":azure_path_url".freeze
    end
    @options[:url] = @options[:url].inspect if @options[:url].is_a?(Symbol)

    @http_proxy = @options[:http_proxy] || nil
  end

  unless Paperclip::Interpolations.respond_to? :azure_alias_url
    Paperclip.interpolates(:azure_alias_url) do |attachment, style|
      protocol = attachment.azure_protocol(style, true)
      host = attachment.azure_host_alias
      path = attachment.path(style).
             split("/")[attachment.azure_prefixes_in_alias..-1].
             join("/").
             sub(%r{\A/}, "")
      "#{protocol}//#{host}/#{path}"
    end
  end
  Paperclip.interpolates(:azure_path_url) do |attachment, style|
    attachment.azure_uri(style)
  end unless Paperclip::Interpolations.respond_to? :azure_path_url
  Paperclip.interpolates(:asset_host) do |attachment, style|
    "#{attachment.path(style).sub(%r{\A/}, "".freeze)}"
  end unless Paperclip::Interpolations.respond_to? :asset_host
end

Instance Method Details

#auto_connect_duration ⇒ Object 



120
121
122
123
 
# File 'lib/paperclip/storage/azure.rb', line 120

def auto_connect_duration
  @auto_connect_duration ||= @options[:auto_connect_duration] || azure_credentials[:auto_connect_duration] || 10
  @auto_connect_duration
end

#azure_account_name ⇒ Object 



129
130
131
132
133
134
 
# File 'lib/paperclip/storage/azure.rb', line 129

def 
   = @options[:azure_storage_account_name] || azure_credentials[:storage_account_name]
   = .call(self) if .is_a?(Proc)

  
end

#azure_container ⇒ Object 



169
170
171
 
# File 'lib/paperclip/storage/azure.rb', line 169

def azure_container
  @azure_container ||= azure_interface.get_container_properties
end

#azure_credentials ⇒ Object 



125
126
127
 
# File 'lib/paperclip/storage/azure.rb', line 125

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

#azure_host_alias ⇒ Object 



99
100
101
102
103
 
# File 'lib/paperclip/storage/azure.rb', line 99

def azure_host_alias
  @azure_host_alias = @options[:azure_host_alias]
  @azure_host_alias = @azure_host_alias.call(self) if @azure_host_alias.respond_to?(:call)
  @azure_host_alias
end

#azure_interface ⇒ Object 



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

def azure_interface
  @azure_interface ||= begin
    config = {}

    [:storage_account_name, :storage_access_key, :container, :principal_id, :use_managed_identities].each do |opt|
      config[opt] = azure_credentials[opt] if azure_credentials[opt]
    end

    obtain_azure_instance_for(config.merge(@azure_options))
  end
end

#azure_object(style_name = default_style) ⇒ Object 



173
174
175
 
# File 'lib/paperclip/storage/azure.rb', line 173

def azure_object(style_name = default_style)
  azure_interface.get_blob_properties path(style_name).sub(%r{\A/},'')
end

#azure_prefixes_in_alias ⇒ Object 



105
106
107
 
# File 'lib/paperclip/storage/azure.rb', line 105

def azure_prefixes_in_alias
  @azure_prefixes_in_alias ||= @options[:azure_prefixes_in_alias].to_i
end

#azure_protocol(style = default_style, with_colon = false) ⇒ Object 



109
110
111
112
113
114
115
116
117
118
 
# File 'lib/paperclip/storage/azure.rb', line 109

def azure_protocol(style = default_style, with_colon = false)
  protocol = @azure_options[:protocol]
  protocol = protocol.call(style, self) if protocol.respond_to?(:call)

  if with_colon && !protocol.empty?
    "#{protocol}:"
  else
    protocol.to_s
  end
end

#azure_uri(style_name = default_style) ⇒ Object 



165
166
167
 
# File 'lib/paperclip/storage/azure.rb', line 165

def azure_uri(style_name = default_style)
  azure_interface.generate_uri("#{container_name}/#{path(style_name).gsub(%r{\A/}, '')}")
end

#container_name ⇒ Object 



136
137
138
139
140
 
# File 'lib/paperclip/storage/azure.rb', line 136

def container_name
  @container ||= @options[:container] || azure_credentials[:container]
  @container = @container.call(self) if @container.respond_to?(:call)
  @container or raise ArgumentError, "missing required :container option"
end

#copy_to_local_file(style, local_dest_path) ⇒ Object 



240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/paperclip/storage/azure.rb', line 240

def copy_to_local_file(style, local_dest_path)
  log("copying #{path(style)} to local file #{local_dest_path}")

  content = azure_interface.get_blob(path(style).sub(%r{\A/},''))

  ::File.open(local_dest_path, 'wb') do |local_file|
    local_file.write(content)
  end
rescue AzureBlob::Http::FileNotFoundError
  warn("Cannot copy #{path(style)} to local file #{local_dest_path}")
  false
end

#create_container ⇒ Object 



194
195
196
 
# File 'lib/paperclip/storage/azure.rb', line 194

def create_container
  azure_interface.create_container container_name
end

#exists?(style = default_style) ⇒ Boolean

Returns:

  • (Boolean) 


184
185
186
187
188
189
190
191
192
 
# File 'lib/paperclip/storage/azure.rb', line 184

def exists?(style = default_style)
  if original_filename
    azure_object(style).present?
  else
    false
  end
rescue AzureBlob::Http::FileNotFoundError
  false
end

#expiring_url(time = 3600, style_name = default_style) ⇒ Object 



89
90
91
92
93
94
95
96
97
 
# File 'lib/paperclip/storage/azure.rb', line 89

def expiring_url(time = 3600, style_name = default_style)
  if path(style_name)
    obj_path = path(style_name).gsub(%r{\A/}, '')
    expiry = Time.now.utc.advance(seconds: time).iso8601
    azure_interface.signed_uri(obj_path, permissions: 'r', expiry:).to_s
  else
    url(style_name)
  end
end

#flush_deletes ⇒ Object

:nodoc:



228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/paperclip/storage/azure.rb', line 228

def flush_deletes #:nodoc:
  @queued_for_delete.each do |path|
    begin
      log("deleting #{path}")

      azure_interface.delete_blob path
    rescue AzureBlob::Http::FileNotFoundError
    end
  end
  @queued_for_delete = []
end

#flush_writes ⇒ Object

:nodoc:



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/paperclip/storage/azure.rb', line 198

def flush_writes #:nodoc:
  @queued_for_write.each do |style, file|
    begin
      log("saving #{path(style)}")

      write_options = {
        content_type: file.content_type,
      }

      if azure_container
        save_blob path(style).sub(%r{\A/},''), file, write_options
      end
    rescue AzureBlob::Http::FileNotFoundError
        create_container
        retry
    ensure
      file.rewind
    end
  end

  after_flush_writes # allows attachment to clean up temp files

  @queued_for_write = {}
end

#obtain_azure_instance_for(options) ⇒ Object 



154
155
156
157
158
159
160
161
162
163
 
# File 'lib/paperclip/storage/azure.rb', line 154

def obtain_azure_instance_for(options)
  AzureBlob::Client.new(
    account_name: options[:storage_account_name],
    access_key: options[:storage_access_key],
    principal_id: options[:principal_id],
    use_managed_identities: options[:use_managed_identities],
    container: container_name,
    cloud_regions: azure_credentials[:region],
  )
end

#parse_credentials(creds) ⇒ Object 



177
178
179
180
181
182
 
# File 'lib/paperclip/storage/azure.rb', line 177

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

#save_blob(storage_path, file, write_options) ⇒ Object 



223
224
225
226
 
# File 'lib/paperclip/storage/azure.rb', line 223

def save_blob(storage_path, file, write_options)
  write_options = write_options.merge(block_size: 4.megabytes) if file.size >= 64.megabytes
  azure_interface.create_block_blob(storage_path, file, write_options)
end