Class: Fog::Service

Inherits:
Object
  • Object
show all
Defined in:
lib/fog/core/service.rb

Defined Under Namespace

Modules: Collections Classes: Error, NotFound

Class Method Summary collapse

Class Method Details

.coerce_options(options) ⇒ Object 



118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/fog/core/service.rb', line 118

def coerce_options(options)
  options.each do |key, value|
    value_string = value.to_s.downcase
    if value.nil?
      options.delete(key)
    elsif value == value_string.to_i.to_s
      options[key] = value.to_i
    else
      options[key] = case value_string
      when 'false'
        false
      when 'true'
        true
      else
        value
      end
    end
  end
end

.collection(new_collection) ⇒ Object 



110
111
112
 
# File 'lib/fog/core/service.rb', line 110

def collection(new_collection)
  collections << new_collection
end

.collections ⇒ Object 



114
115
116
 
# File 'lib/fog/core/service.rb', line 114

def collections
  @collections ||= []
end

.inherited(child) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/fog/core/service.rb', line 30

def inherited(child)
  child.class_eval <<-EOS, __FILE__, __LINE__
    class Error < Fog::Service::Error; end
    class NotFound < Fog::Service::NotFound; end

    module Collections
      include Fog::Service::Collections

      def service
        #{child}
      end
    end

    def self.service
      #{child}
    end
  EOS
end

.mocked_requests ⇒ Object 



138
139
140
 
# File 'lib/fog/core/service.rb', line 138

def mocked_requests
  @mocked_requests ||= []
end

.model(new_model) ⇒ Object 



142
143
144
 
# File 'lib/fog/core/service.rb', line 142

def model(new_model)
  models << new_model
end

.model_path(new_path) ⇒ Object 



106
107
108
 
# File 'lib/fog/core/service.rb', line 106

def model_path(new_path)
  @model_path = new_path
end

.models ⇒ Object 



146
147
148
 
# File 'lib/fog/core/service.rb', line 146

def models
  @models ||= []
end

.new(options = {}) ⇒ Object 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/fog/core/service.rb', line 49

def new(options={})
  # attempt to load credentials from config file
  begin
    default_credentials = Fog.credentials.reject {|key, value| !(recognized | requirements).include?(key)}
    options = default_credentials.merge(options)
  rescue LoadError
    # if there are no configured credentials, do nothing
  end

  validate_options(options)
  coerce_options(options)
  setup_requirements

  if Fog.mocking?
    service::Mock.send(:include, service::Collections)
    service::Mock.new(options)
  else
    service::Real.send(:include, service::Collections)
    service::Real.new(options)
  end
end

.recognized ⇒ Object 



174
175
176
 
# File 'lib/fog/core/service.rb', line 174

def recognized
  @recognized ||= [:connection_options]
end

.recognizes(*args) ⇒ Object 



170
171
172
 
# File 'lib/fog/core/service.rb', line 170

def recognizes(*args)
  recognized.concat(args)
end

.request(new_request) ⇒ Object 



154
155
156
 
# File 'lib/fog/core/service.rb', line 154

def request(new_request)
  requests << new_request
end

.request_path(new_path) ⇒ Object 



150
151
152
 
# File 'lib/fog/core/service.rb', line 150

def request_path(new_path)
  @request_path = new_path
end

.requests ⇒ Object 



158
159
160
 
# File 'lib/fog/core/service.rb', line 158

def requests
  @requests ||= []
end

.requirements ⇒ Object 



166
167
168
 
# File 'lib/fog/core/service.rb', line 166

def requirements
  @requirements ||= []
end

.requires(*args) ⇒ Object 



162
163
164
 
# File 'lib/fog/core/service.rb', line 162

def requires(*args)
  requirements.concat(args)
end

.setup_requirements ⇒ Object 



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/fog/core/service.rb', line 71

def setup_requirements
  if superclass.respond_to?(:setup_requirements)
    superclass.setup_requirements
  end

  @required ||= false
  unless @required
    for collection in collections
      require [@model_path, collection].join('/')
      constant = collection.to_s.split('_').map {|characters| characters[0...1].upcase << characters[1..-1]}.join('')
      service::Collections.module_eval <<-EOS, __FILE__, __LINE__
        def #{collection}(attributes = {})
          #{service}::#{constant}.new({:connection => self}.merge(attributes))
        end
      EOS
    end
    for model in models
      require [@model_path, model].join('/')
    end
    for request in requests
      require [@request_path, request].join('/')
      if service::Mock.method_defined?(request)
        mocked_requests << request
      else
        service::Mock.module_eval <<-EOS, __FILE__, __LINE__
          def #{request}(*args)
            Fog::Mock.not_implemented
          end
        EOS
      end
    end
    @required = true
  end
end

.validate_options(options) ⇒ Object 



178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/fog/core/service.rb', line 178

def validate_options(options)
  keys = []
  for key, value in options
    unless value.nil?
      keys << key
    end
  end
  missing = requirements - keys
  unless missing.empty?
    raise ArgumentError, "Missing required arguments: #{missing.join(', ')}"
  end

  unless recognizes.empty?
    unrecognized = options.keys - requirements - recognized
    unless unrecognized.empty?
      raise ArgumentError, "Unrecognized arguments: #{unrecognized.join(', ')}"
    end
  end
end