Class: ProcessOut::GatewayConfiguration

Inherits:
Object
  • Object
show all
Defined in:
lib/processout/gateway_configuration.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(client, data = {}) ⇒ GatewayConfiguration

Initializes the GatewayConfiguration object Params:

client

ProcessOut client instance

data

data that can be used to fill the object



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/processout/gateway_configuration.rb', line 96

def initialize(client, data = {})
  @client = client

  self.id = data.fetch(:id, nil)
  self.project = data.fetch(:project, nil)
  self.project_id = data.fetch(:project_id, nil)
  self.gateway = data.fetch(:gateway, nil)
  self.gateway_id = data.fetch(:gateway_id, nil)
  self.name = data.fetch(:name, nil)
  self.default_currency = data.fetch(:default_currency, nil)
  self.enabled = data.fetch(:enabled, nil)
  self.public_keys = data.fetch(:public_keys, nil)
  self.created_at = data.fetch(:created_at, nil)
  self.enabled_at = data.fetch(:enabled_at, nil)
  
end

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



19
20
21
 
# File 'lib/processout/gateway_configuration.rb', line 19

def created_at
  @created_at
end

#default_currency ⇒ Object

Returns the value of attribute default_currency.



16
17
18
 
# File 'lib/processout/gateway_configuration.rb', line 16

def default_currency
  @default_currency
end

#enabled ⇒ Object

Returns the value of attribute enabled.



17
18
19
 
# File 'lib/processout/gateway_configuration.rb', line 17

def enabled
  @enabled
end

#enabled_at ⇒ Object

Returns the value of attribute enabled_at.



20
21
22
 
# File 'lib/processout/gateway_configuration.rb', line 20

def enabled_at
  @enabled_at
end

#gateway ⇒ Object

Returns the value of attribute gateway.



13
14
15
 
# File 'lib/processout/gateway_configuration.rb', line 13

def gateway
  @gateway
end

#gateway_id ⇒ Object

Returns the value of attribute gateway_id.



14
15
16
 
# File 'lib/processout/gateway_configuration.rb', line 14

def gateway_id
  @gateway_id
end

#id ⇒ Object

Returns the value of attribute id.



10
11
12
 
# File 'lib/processout/gateway_configuration.rb', line 10

def id
  @id
end

#name ⇒ Object

Returns the value of attribute name.



15
16
17
 
# File 'lib/processout/gateway_configuration.rb', line 15

def name
  @name
end

#project ⇒ Object

Returns the value of attribute project.



11
12
13
 
# File 'lib/processout/gateway_configuration.rb', line 11

def project
  @project
end

#project_id ⇒ Object

Returns the value of attribute project_id.



12
13
14
 
# File 'lib/processout/gateway_configuration.rb', line 12

def project_id
  @project_id
end

#public_keys ⇒ Object

Returns the value of attribute public_keys.



18
19
20
 
# File 'lib/processout/gateway_configuration.rb', line 18

def public_keys
  @public_keys
end

Instance Method Details

#all(options = {}) ⇒ Object

Get all the gateway configurations. Params:

options

Hash of options



187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/processout/gateway_configuration.rb', line 187

def all(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/gateway-configurations"
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  a    = Array.new
  body = response.body
  for v in body['gateway_configurations']
    tmp = GatewayConfiguration.new(@client)
    tmp.fill_with_data(v)
    a.push(tmp)
  end

  return_values.push(a)
  

  
  return_values[0]
end

#create(gateway_name, options = {}) ⇒ Object

Create a new gateway configuration. Params:

gateway_name

Name of the gateway

options

Hash of options



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/processout/gateway_configuration.rb', line 298

def create(gateway_name, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/gateways/" + CGI.escape(gateway_name) + "/gateway-configurations"
  data    = {
    "id" => @id, 
    "name" => @name, 
    "enabled" => @enabled, 
    "default_currency" => @default_currency, 
    "settings" => options.fetch(:settings, nil), 
    "sub_accounts_enabled" => options.fetch(:sub_accounts_enabled, nil)
  }

  response = Response.new(request.post(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["gateway_configuration"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end

#delete(options = {}) ⇒ Object

Delete the gateway configuration. Params:

options

Hash of options



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/processout/gateway_configuration.rb', line 276

def delete(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/gateway-configurations/" + CGI.escape(@id) + ""
  data    = {

  }

  response = Response.new(request.delete(path, data, options))
  return_values = Array.new
  
  return_values.push(response.success)

  
  return_values[0]
end

#fill_with_data(data) ⇒ Object

Fills the object with data coming from the API Params:

data

Hash of data coming from the API



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/processout/gateway_configuration.rb', line 121

def fill_with_data(data)
  if data.nil?
    return self
  end
  if data.include? "id"
    self.id = data["id"]
  end
  if data.include? "project"
    self.project = data["project"]
  end
  if data.include? "project_id"
    self.project_id = data["project_id"]
  end
  if data.include? "gateway"
    self.gateway = data["gateway"]
  end
  if data.include? "gateway_id"
    self.gateway_id = data["gateway_id"]
  end
  if data.include? "name"
    self.name = data["name"]
  end
  if data.include? "default_currency"
    self.default_currency = data["default_currency"]
  end
  if data.include? "enabled"
    self.enabled = data["enabled"]
  end
  if data.include? "public_keys"
    self.public_keys = data["public_keys"]
  end
  if data.include? "created_at"
    self.created_at = data["created_at"]
  end
  if data.include? "enabled_at"
    self.enabled_at = data["enabled_at"]
  end
  
  self
end

#find(configuration_id, options = {}) ⇒ Object

Find a gateway configuration by its ID. Params:

configuration_id

ID of the gateway configuration

options

Hash of options



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/processout/gateway_configuration.rb', line 218

def find(configuration_id, options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/gateway-configurations/" + CGI.escape(configuration_id) + ""
  data    = {

  }

  response = Response.new(request.get(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["gateway_configuration"]
  
  
  obj = GatewayConfiguration.new(@client)
  return_values.push(obj.fill_with_data(body))
  

  
  return_values[0]
end

#new(data = {}) ⇒ Object

Create a new GatewayConfiguration using the current client



114
115
116
 
# File 'lib/processout/gateway_configuration.rb', line 114

def new(data = {})
  GatewayConfiguration.new(@client, data)
end

#prefill(data) ⇒ Object

Prefills the object with the data passed as parameters Params:

data

Hash of data



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/processout/gateway_configuration.rb', line 165

def prefill(data)
  if data.nil?
    return self
  end
  self.id = data.fetch(:id, self.id)
  self.project = data.fetch(:project, self.project)
  self.project_id = data.fetch(:project_id, self.project_id)
  self.gateway = data.fetch(:gateway, self.gateway)
  self.gateway_id = data.fetch(:gateway_id, self.gateway_id)
  self.name = data.fetch(:name, self.name)
  self.default_currency = data.fetch(:default_currency, self.default_currency)
  self.enabled = data.fetch(:enabled, self.enabled)
  self.public_keys = data.fetch(:public_keys, self.public_keys)
  self.created_at = data.fetch(:created_at, self.created_at)
  self.enabled_at = data.fetch(:enabled_at, self.enabled_at)
  
  self
end

#save(options = {}) ⇒ Object

Save the updated gateway configuration attributes and settings. Params:

options

Hash of options



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
 
# File 'lib/processout/gateway_configuration.rb', line 245

def save(options = {})
  self.prefill(options)

  request = Request.new(@client)
  path    = "/gateway-configurations/" + CGI.escape(@id) + ""
  data    = {
    "id" => @id, 
    "name" => @name, 
    "enabled" => @enabled, 
    "default_currency" => @default_currency, 
    "settings" => options.fetch(:settings, nil), 
    "sub_accounts_enabled" => options.fetch(:sub_accounts_enabled, nil)
  }

  response = Response.new(request.put(path, data, options))
  return_values = Array.new
  
  body = response.body
  body = body["gateway_configuration"]
  
  
  return_values.push(self.fill_with_data(body))
  

  
  return_values[0]
end