Class: Backup::Storage::Base

Inherits:
Object
  • Object
show all
Includes:
Config::Helpers
Defined in:
lib/backup/storage/base.rb

Direct Known Subclasses

CloudFiles, Dropbox, FTP, Local, Qiniu, RSync, S3, SCP, SFTP

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Config::Helpers

included

Constructor Details

#initialize(model, storage_id = nil, &block) ⇒ Base

storage_id is a user-defined string used to uniquely identify multiple storages of the same type. If multiple storages of the same type are added to a single backup model, this identifier must be set. This will be appended to the YAML storage file used for cycling backups.



34
35
36
37
38
39
40
41
 
# File 'lib/backup/storage/base.rb', line 34

def initialize(model, storage_id = nil, &block)
  @model = model
  @package = model.package
  @storage_id = storage_id.to_s.gsub(/\W/, '_') if storage_id

  load_defaults!
  instance_eval(&block) if block_given?
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class Backup::Config::Helpers

Instance Attribute Details

#keep ⇒ Integer|Time

Parameters:

  • (Integer|Time)

Returns:

  • (Integer|Time) 


25
26
27
 
# File 'lib/backup/storage/base.rb', line 25

def keep
  @keep
end

#model ⇒ Object (readonly)

Returns the value of attribute model.



27
28
29
 
# File 'lib/backup/storage/base.rb', line 27

def model
  @model
end

#package ⇒ Object (readonly)

Returns the value of attribute package.



27
28
29
 
# File 'lib/backup/storage/base.rb', line 27

def package
  @package
end

#path ⇒ Object

Base path on the remote where backup package files will be stored.



10
11
12
 
# File 'lib/backup/storage/base.rb', line 10

def path
  @path
end

#storage_id ⇒ Object (readonly)

Returns the value of attribute storage_id.



27
28
29
 
# File 'lib/backup/storage/base.rb', line 27

def storage_id
  @storage_id
end

Instance Method Details

#perform! ⇒ Object 



43
44
45
46
47
48
49
50
 
# File 'lib/backup/storage/base.rb', line 43

def perform!
  Logger.info "#{ storage_name } Started..."
  transfer!
  if respond_to?(:cycle!, true) && (keep.to_i > 0 || keep.is_a?(Time))
    cycle!
  end
  Logger.info "#{ storage_name } Finished!"
end