Class: Runcible::Base

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

Class Method Summary collapse

Class Method Details

.add_http_auth_header ⇒ Object 



167
168
169
 
# File 'lib/runcible/base.rb', line 167

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

.add_oauth_header(method, path, headers) ⇒ Object 



171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
 
# File 'lib/runcible/base.rb', line 171

def self.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 



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
 
# File 'lib/runcible/base.rb', line 56

def self.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

  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])
  else
    client = RestClient::Resource.new(clone_config[:url], :user => clone_config[:user], :password => config[:http_auth][:password])
  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 



99
100
101
102
103
104
105
106
107
108
 
# File 'lib/runcible/base.rb', line 99

def self.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 



52
53
54
 
# File 'lib/runcible/base.rb', line 52

def self.config 
  @@config
end

.config=(conf = {}) ⇒ Object

Accepted Configuration Values

:user Pulp username :password Password for this user :oauth Oauth credentials :headers Additional headers e.g. content-type => “application/json” :url Scheme and hostname for the pulp server e.g. localhost/ :api_path URL path for the api e.g. pulp/api/v2/



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

def self.config=(conf={})
  @@config = {
    :api_path   => '/pulp/api/v2/',
    :url        => 'https://localhost',
    :user       => '',
    :http_auth  => {:password => {} },
    :headers    => {:content_type => 'application/json',
                    :accept       => 'application/json'},
    :logging    => {}
  }.merge(conf)
end

.generate_log_message ⇒ Object 



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

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

.generate_payload(options) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/runcible/base.rb', line 110

def self.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 



91
92
93
94
95
96
97
 
# File 'lib/runcible/base.rb', line 91

def self.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

.log_debug ⇒ Object 



193
194
195
196
197
198
 
# File 'lib/runcible/base.rb', line 193

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

.log_exception ⇒ Object 



200
201
202
203
204
205
 
# File 'lib/runcible/base.rb', line 200

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

.process_response(response) ⇒ Object 



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
 
# File 'lib/runcible/base.rb', line 130

def self.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 



147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/runcible/base.rb', line 147

def self.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