Class: Backup::Dependency

Inherits:
Object
  • Object
show all
Defined in:
lib/backup/dependency.rb

Overview

A little self-contained gem manager for Backup. Rather than specifying hard dependencies in the gemspec, forcing users to install gems they do not want/need, Backup will notify them when a gem has not been installed, or when the gem’s version is incorrect, and provide the command to install the gem. These dependencies are dynamically loaded in the Gemfile

Class Method Summary collapse

Class Method Details

.all ⇒ Object

Returns a hash of dependencies that Backup requires in order to run every available feature



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
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
 
# File 'lib/backup/dependency.rb', line 16

def self.all
  {
    'fog' => {
      :require => 'fog',
      :version => '~> 1.4.0',
      :for     => 'Amazon S3, Rackspace Cloud Files (S3, CloudFiles Storages)'
    },

    'dropbox-sdk' => {
      :require => 'dropbox_sdk',
      :version => '~> 1.2.0',
      :for     => 'Dropbox Web Service (Dropbox Storage)'
    },

    'net-sftp' => {
      :require => 'net/sftp',
      :version => '~> 2.0.5',
      :for     => 'SFTP Protocol (SFTP Storage)'
    },

    'net-scp' => {
      :require => 'net/scp',
      :version => '~> 1.0.4',
      :for     => 'SCP Protocol (SCP Storage)'
    },

    'net-ssh' => {
      :require => 'net/ssh',
      :version => '~> 2.3.0',
      :for     => 'SSH Protocol (SSH Storage)'
    },

    'mail' => {
      :require => 'mail',
      :version => '~> 2.4.0',
      :for     => 'Sending Emails (Mail Notifier)'
    },

    'twitter' => {
      :require => 'twitter',
      :version => '>= 1.7.1',
      :for     => 'Sending Twitter Updates (Twitter Notifier)'
    },

    'httparty' => {
      :require => 'httparty',
      :version => '~> 0.8.1',
      :for     => 'Sending Http Updates'
    },

    'prowler' => {
      :require => 'prowler',
      :version => '>= 1.3.1',
      :for     => 'Sending iOS push notifications (Prowl Notifier)'
    },

    'hipchat' => {
      :require => 'hipchat',
      :version => '~> 0.4.1',
      :for => 'Sending notifications to Hipchat'
    },

    'parallel' => {
      :require => 'parallel',
      :version => '~> 0.5.12',
      :for => 'Adding concurrency to Cloud-based syncers.'
    }
  }
end

.load(name) ⇒ Object

Attempts to load the specified gem (by name and version). If the gem with the correct version cannot be found, it’ll display a message to the user with instructions on how to install the required gem



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/backup/dependency.rb', line 90

def self.load(name)
  begin
    gem(name, all[name][:version])
    require(all[name][:require])
  rescue LoadError
    Logger.error Errors::Dependency::LoadError.new(<<-EOS)
      Dependency missing
      Dependency required for:
      #{all[name][:for]}
      To install the gem, issue the following command:
      > gem install #{name} -v '#{all[name][:version]}'
      Please try again after installing the missing dependency.
    EOS
    exit 1
  end
end