class RemoteFiles::Configuration

Attributes

name[R]

Public Class Methods

new(name, config = {}) click to toggle source
# File lib/remote_files/configuration.rb, line 7
def initialize(name, config = {})
  @name       = name
  @stores     = []
  @stores_map = {}
  @max_delete_in_parallel = config.delete(:max_delete_in_parallel) || 10
  from_hash(config)
end

Public Instance Methods

add_store(store_identifier, options = {}, &block) click to toggle source
# File lib/remote_files/configuration.rb, line 56
def add_store(store_identifier, options = {}, &block)
  store = (options[:class] || FogStore).new(store_identifier)
  block.call(store) if block_given?

  store[:read_only] = options[:read_only] if options.key?(:read_only)

  if options[:primary]
    @stores.unshift(store)
  else
    @stores << store
  end

  @stores_map[store_identifier] = store
end
clear() click to toggle source
# File lib/remote_files/configuration.rb, line 23
def clear
  @stores.clear
  @stores_map.clear
end
configured?() click to toggle source
# File lib/remote_files/configuration.rb, line 71
def configured?
  !@stores.empty?
end
delete!(file) click to toggle source
# File lib/remote_files/configuration.rb, line 127
def delete!(file)
  RemoteFiles.delete_file(file)
end
delete_in_parallel!(file, stores, exceptions) click to toggle source

This method is used to delete a file from all stores in parallel exceptions are passed back to the caller

# File lib/remote_files/configuration.rb, line 156
def delete_in_parallel!(file, stores, exceptions)
  pool = Concurrent::FixedThreadPool.new(@max_delete_in_parallel)

  futures = stores.map do |store|
    Concurrent::Promises.future_on(pool) do
      begin
        store.delete!(file.identifier)
      rescue NotFoundError => e
        e
      end
    end
  end

  futures.each do |future|
    result = future.value
    exceptions << result if result.is_a?(Exception)
  end

  pool.shutdown
  pool.wait_for_termination
end
delete_now!(file, parallel: false) click to toggle source
# File lib/remote_files/configuration.rb, line 131
def delete_now!(file, parallel: false)
  exceptions = []
  stores = file.read_write_stores

  raise "No stores configured" if stores.empty?

  if parallel
    delete_in_parallel!(file, stores, exceptions)
  else
    stores.each do |store|
      begin
        store.delete!(file.identifier)
      rescue NotFoundError => e
        exceptions << e
      end
    end
  end

  raise exceptions.first if exceptions.size == stores.size # they all failed

  true
end
file_from_url(url, options = {}) click to toggle source
# File lib/remote_files/configuration.rb, line 187
def file_from_url(url, options = {})
  stores.each do |store|
    file = store.file_from_url(url, options.merge(:configuration => name))
    return file if file
  end

  nil
end
from_hash(hash) click to toggle source
# File lib/remote_files/configuration.rb, line 28
def from_hash(hash)
  hash.each do |store_identifier, config|
    #symbolize_keys!
    cfg = {}
    config.each { |name, value| cfg[name.to_sym] = config[name] }
    config = cfg

    #camelize
    type = config[:type].gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase } + 'Store'

    klass = RemoteFiles.const_get(type) rescue nil
    unless klass
      require "remote_files/#{config[:type]}_store"
      klass = RemoteFiles.const_get(type)
    end

    config.delete(:type)

    add_store(store_identifier.to_sym, :class => klass, :primary => !!config.delete(:primary)) do |store|
      config.each do |name, value|
        store[name] = value
      end
    end
  end

  self
end
logger() click to toggle source
# File lib/remote_files/configuration.rb, line 19
def logger
  @logger ||= RemoteFiles.logger
end
logger=(logger) click to toggle source
# File lib/remote_files/configuration.rb, line 15
def logger=(logger)
  @logger = logger
end
lookup_store(store_identifier) click to toggle source
# File lib/remote_files/configuration.rb, line 89
def lookup_store(store_identifier)
  @stores_map[store_identifier.to_sym]
end
primary_store() click to toggle source
# File lib/remote_files/configuration.rb, line 93
def primary_store
  stores.first
end
read_only_stores() click to toggle source
# File lib/remote_files/configuration.rb, line 81
def read_only_stores
  stores.select {|s| s.read_only?}
end
read_write_stores() click to toggle source
# File lib/remote_files/configuration.rb, line 85
def read_write_stores
  stores.reject {|s| s.read_only?}
end
store!(file) click to toggle source
# File lib/remote_files/configuration.rb, line 119
def store!(file)
  store_once!(file) unless file.stored?

  RemoteFiles.synchronize_stores(file) unless file.stored_everywhere?

  true
end
store_once!(file) click to toggle source
# File lib/remote_files/configuration.rb, line 97
def store_once!(file)
  return file.stored_in.first if file.stored?

  exception = nil

  read_write_stores.each do |store|
    begin
      stored = store.store!(file)
      file.stored_in << store.identifier
      break
    rescue ::RemoteFiles::Error => e
      file.logger.info(e) if file.logger
      file.errors.push(e) if file.errors
      exception = e
    end
  end

  raise exception unless file.stored?

  file.stored_in.first
end
stores() click to toggle source
# File lib/remote_files/configuration.rb, line 75
def stores
  raise "You need to configure add stores to the #{name} RemoteFiles configuration" unless configured?

  @stores
end
synchronize!(file) click to toggle source
# File lib/remote_files/configuration.rb, line 178
def synchronize!(file)
  file.missing_stores.each do |store|
    next if store.read_only?

    store.store!(file)
    file.stored_in << store.identifier
  end
end