Class: Runcible::Base

Inherits:
Object
  • Object
show all
Defined in:
lib/runcible/base.rb

Instance Method Summary collapse

Constructor Details

#initialize(config = {}) ⇒ Base

Returns a new instance of Base.



33
34
35
36
 
# File 'lib/runcible/base.rb', line 33

def initialize(config={})
  @mutex = Mutex.new
  @config = config
end

Instance Method Details

#add_http_auth_header ⇒ Object 



171
172
173
 
# File 'lib/runcible/base.rb', line 171

def add_http_auth_header
  return {:user => config[:user], :password => config[:http_auth][:password]}
end

#add_oauth_header(method, path, headers) ⇒ Object 



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/runcible/base.rb', line 175

def add_oauth_header(method, path, headers)
  default_options = { :site               => config[:url],
                      :http_method        => method,
                      :request_token_path => "",
                      :authorize_path     => "",
                      :access_token_path  => "" }

  default_options[:ca_file] = config[:ca_cert_file] unless config[:ca_cert_file].nil?
  consumer = OAuth::Consumer.new(config[:oauth][:oauth_key], config[:oauth][:oauth_secret], default_options)

  method_to_http_request = { :get    => Net::HTTP::Get,
                             :post   => Net::HTTP::Post,
                             :put    => Net::HTTP::Put,
                             :delete => Net::HTTP::Delete }

  http_request = method_to_http_request[method].new(path)
  consumer.sign!(http_request)

  headers['Authorization'] = http_request['Authorization']
  return headers
end

#call(method, path, options = {}) ⇒ Object 



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
85
86
87
88
89
90
91
92
93
 
# File 'lib/runcible/base.rb', line 54

def call(method, path, options={})
  clone_config = self.config.clone
  #on occation path will already have prefix (sync cancel)
  path = clone_config[:api_path] + path if !path.start_with?(clone_config[:api_path])

  RestClient.log    = []
  logger            = clone_config[:logging][:logger]
  debug_logging     = clone_config[:logging][:debug]
  exception_logging = clone_config[:logging][:exception]

  headers = clone_config[:headers].clone

  get_params = options[:params] if options[:params]
  path = combine_get_params(path, get_params) if get_params

  client_options = {}
  client_options[:timeout] =  clone_config[:timeout] if clone_config[:timeout]
  client_options[:open_timeout] =  clone_config[:open_timeout] if clone_config[:open_timeout]

  if clone_config[:oauth]
    headers = add_oauth_header(method, path, headers) if clone_config[:oauth]
    headers["pulp-user"] = clone_config[:user]
    client = RestClient::Resource.new(clone_config[:url], client_options)
  else
    client_options[:user] =  clone_config[:user]
    client_options[:password] = config[:http_auth][:password]
    client = RestClient::Resource.new(clone_config[:url], client_options)
  end

  args = [method]
  args << generate_payload(options) if [:post, :put].include?(method)
  args << headers 

  response = get_response(client, path, *args)
  process_response(response)

rescue => e
  log_exception
  raise e
end

#combine_get_params(path, params) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
 
# File 'lib/runcible/base.rb', line 103

def combine_get_params(path, params)
  query_string  = params.collect do |k, v|
    if v.is_a? Array
      v.collect{|y| "#{k.to_s}=#{y.to_s}" }.join('&')
    else
      "#{k.to_s}=#{v.to_s}"
    end
  end.flatten().join('&')
  path + "?#{query_string}"
end

#config ⇒ Object 



42
43
44
45
46
47
48
 
# File 'lib/runcible/base.rb', line 42

def config
  @mutex.synchronize do
    @config = @lazy_config.call if defined?(@lazy_config)
    raise Runcible::ConfigurationUndefinedError, Runcible::ConfigurationUndefinedError.message unless @config
    @config
  end
end

#generate_log_message ⇒ Object 



211
212
213
 
# File 'lib/runcible/base.rb', line 211

def generate_log_message
  RestClient.log.join('\n')
end

#generate_payload(options) ⇒ Object 



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
 
# File 'lib/runcible/base.rb', line 114

def generate_payload(options)
  if options[:payload]
    if options[:payload][:optional]
      if options[:payload][:required]
        payload = options[:payload][:required].merge(options[:payload][:optional])
      else
        payload = options[:payload][:optional]
      end
    elsif options[:payload][:delta]
      payload = options[:payload]
    else
      payload = options[:payload][:required]
    end
  else
    payload = {}
  end

  return payload.to_json
end

#get_response(client, path, *args) ⇒ Object 



95
96
97
98
99
100
101
 
# File 'lib/runcible/base.rb', line 95

def get_response(client, path, *args)
  client[path].send(*args) do |response, request, result, &block|
    resp = response.return!(request, result)
    log_debug
    return resp
  end
end

#lazy_config=(a_block) ⇒ Object 



38
39
40
 
# File 'lib/runcible/base.rb', line 38

def lazy_config=(a_block)
  @mutex.synchronize { @lazy_config = a_block }
end

#log_debug ⇒ Object 



197
198
199
200
201
202
 
# File 'lib/runcible/base.rb', line 197

def log_debug
  if self.config[:logging][:debug]
    log_message = generate_log_message                  
    self.config[:logging][:logger].debug(log_message)
  end
end

#log_exception ⇒ Object 



204
205
206
207
208
209
 
# File 'lib/runcible/base.rb', line 204

def log_exception
  if self.config[:logging][:exception]
    log_message = generate_log_message
    self.config[:logging][:logger].error(log_message)
  end
end

#logger ⇒ Object 



215
216
217
 
# File 'lib/runcible/base.rb', line 215

def logger
  self.config[:logging][:logger]
end

#path(*args) ⇒ Object 



50
51
52
 
# File 'lib/runcible/base.rb', line 50

def path(*args)
  self.class.path(*args)
end

#process_response(response) ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/runcible/base.rb', line 134

def process_response(response)
  begin
    body = JSON.parse(response.body)
    if body.respond_to? :with_indifferent_access
      body = body.with_indifferent_access
    elsif body.is_a? Array
      body = body.collect  do |i|
        i.respond_to?(:with_indifferent_access) ? i.with_indifferent_access : i
      end
    end
    response = RestClient::Response.create(body, response.net_http_res, response.args)
  rescue JSON::ParserError
  end

  return response
end

#required_params(local_names, binding, keys_to_remove = []) ⇒ Object 



151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/runcible/base.rb', line 151

def required_params(local_names, binding, keys_to_remove=[])
  local_names = local_names.reduce({}) do |acc, v|
    value = binding.eval(v.to_s) unless v == :_
    acc[v] = value unless value.nil?
    acc
  end

  #The double delete is to support 1.8.7 and 1.9.3
  local_names.delete(:payload)
  local_names.delete(:optional)
  local_names.delete("payload")
  local_names.delete("optional")
  keys_to_remove.each do |key|
    local_names.delete(key)
    local_names.delete(key.to_sym)
  end

  return local_names
end