Class: Adyen::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/adyen/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ws_user: nil, ws_password: nil, api_key: nil, oauth_token: nil, env: :live, adapter: nil, mock_port: 3001, live_url_prefix: nil, mock_service_url_base: nil, connection_options: nil, adapter_options: nil, terminal_region: nil) ⇒ Client

Returns a new instance of Client.



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'lib/adyen/client.rb', line 18

def initialize(ws_user: nil, ws_password: nil, api_key: nil, oauth_token: nil, env: :live, adapter: nil, mock_port: 3001,
               live_url_prefix: nil, mock_service_url_base: nil, connection_options: nil, adapter_options: nil, terminal_region: nil)
  @ws_user = ws_user
  @ws_password = ws_password
  @api_key = api_key
  @oauth_token = oauth_token
  @env = env
  @adapter = adapter || Faraday.default_adapter
  if Gem::Version.new(Faraday::VERSION) >= Gem::Version.new('2.1')
    # for faraday 2.1 and higher
    @adapter_options = adapter_options || Faraday.default_adapter_options
  else
    # for faraday 1.x and 2.0
    @adapter_options = adapter_options || {}
  end
  @mock_service_url_base = mock_service_url_base || "http://localhost:#{mock_port}"
  @live_url_prefix = live_url_prefix
  @connection_options = connection_options || Faraday::ConnectionOptions.new
  @terminal_region = terminal_region
end

Instance Attribute Details

#adapter ⇒ Object

Returns the value of attribute adapter.



15
16
17
 
# File 'lib/adyen/client.rb', line 15

def adapter
  @adapter
end

#adapter_options ⇒ Object (readonly)

Returns the value of attribute adapter_options.



16
17
18
 
# File 'lib/adyen/client.rb', line 16

def adapter_options
  @adapter_options
end

#api_key ⇒ Object

Returns the value of attribute api_key.



15
16
17
 
# File 'lib/adyen/client.rb', line 15

def api_key
  @api_key
end

#client ⇒ Object

Returns the value of attribute client.



15
16
17
 
# File 'lib/adyen/client.rb', line 15

def client
  @client
end

#connection_options ⇒ Object (readonly)

Returns the value of attribute connection_options.



16
17
18
 
# File 'lib/adyen/client.rb', line 16

def connection_options
  @connection_options
end

#env ⇒ Object

Returns the value of attribute env.



16
17
18
 
# File 'lib/adyen/client.rb', line 16

def env
  @env
end

#oauth_token ⇒ Object

Returns the value of attribute oauth_token.



15
16
17
 
# File 'lib/adyen/client.rb', line 15

def oauth_token
  @oauth_token
end

#terminal_region ⇒ Object (readonly)

Returns the value of attribute terminal_region.



16
17
18
 
# File 'lib/adyen/client.rb', line 16

def terminal_region
  @terminal_region
end

#ws_password ⇒ Object

Returns the value of attribute ws_password.



15
16
17
 
# File 'lib/adyen/client.rb', line 15

def ws_password
  @ws_password
end

#ws_user ⇒ Object

Returns the value of attribute ws_user.



15
16
17
 
# File 'lib/adyen/client.rb', line 15

def ws_user
  @ws_user
end

Instance Method Details

#balance_control_service ⇒ Object 



279
280
281
 
# File 'lib/adyen/client.rb', line 279

def balance_control_service
  @balance_control_service ||= Adyen::BalanceControlService.new(self)
end

#balance_platform ⇒ Object 



263
264
265
 
# File 'lib/adyen/client.rb', line 263

def balance_platform
  @balance_platform ||= Adyen::BalancePlatform.new(self)
end

#bin_lookup ⇒ Object 



255
256
257
 
# File 'lib/adyen/client.rb', line 255

def bin_lookup
  @bin_lookup ||= Adyen::BinLookup.new(self)
end

#call_adyen_api(service, action, request_data, headers, version, _with_application_info: false) ⇒ Object

send request to adyen API



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
213
214
215
216
217
218
219
220
 
# File 'lib/adyen/client.rb', line 125

def call_adyen_api(service, action, request_data, headers, version, _with_application_info: false)
  # get URL for requested endpoint
  url = service_url(service, action.is_a?(String) ? action : action.fetch(:url), version)

  auth_type = auth_type(service, request_data)

  # initialize Faraday connection object
  conn = Faraday.new(url, @connection_options) do |faraday|
    faraday.adapter @adapter, **@adapter_options
    faraday.headers['Content-Type'] = 'application/json'
    faraday.headers['User-Agent'] = "#{Adyen::NAME}/#{Adyen::VERSION}"

    # set header based on auth_type and service
    auth_header(auth_type, faraday)

    # add optional headers if specified in request
    # will overwrite default headers if overlapping
    headers.map do |key, value|
      faraday.headers[key] = value
    end

    # add library headers
    faraday.headers['adyen-library-name'] = Adyen::NAME
    faraday.headers['adyen-library-version'] = Adyen::VERSION
  end
  # if json string convert to hash
  # needed to add applicationInfo
  request_data = JSON.parse(request_data) if request_data.is_a?(String)

  # convert to json
  request_data = request_data.to_json

  if action.is_a?(::Hash)
    if action.fetch(:method) == 'get'
      begin
        response = conn.get
      rescue Faraday::ConnectionFailed => e
        raise e, "Connection to #{url} failed"
      end
    end
    if action.fetch(:method) == 'delete'
      begin
        response = conn.delete
      rescue Faraday::ConnectionFailed => e
        raise e, "Connection to #{url} failed"
      end
    end
    if action.fetch(:method) == 'patch'
      begin
        response = conn.patch do |req|
          req.body = request_data
        end
      rescue Faraday::ConnectionFailed => e
        raise e, "Connection to #{url} failed"
      end
    end
    if action.fetch(:method) == 'post'
      # post request to Adyen
      begin
        response = conn.post do |req|
          req.body = request_data
        end
      rescue Faraday::ConnectionFailed => e
        raise e, "Connection to #{url} failed"
      end
    end
  else
    begin
      response = conn.post do |req|
        req.body = request_data
      end
    rescue Faraday::ConnectionFailed => e
      raise e, "Connection to #{url} failed"
    end
  end
  # check for API errors
  case response.status
  when 401
    raise Adyen::AuthenticationError.new(
      'Invalid API authentication; https://docs.adyen.com/user-management/how-to-get-the-api-key', request_data
    )
  when 403
    raise Adyen::PermissionError.new('Missing user permissions; https://docs.adyen.com/user-management/user-roles',
                                     request_data, response.body)
  end

  # delete has no response.body (unless it throws an error)
  if response.body.nil? || response.body === ''
    AdyenResult.new('{}', response.headers, response.status)
  # terminal API async call returns always 'ok'
  elsif response.body === 'ok'
    AdyenResult.new('{}', response.headers, response.status)
  else
    AdyenResult.new(response.body, response.headers, response.status)
  end
end

#checkout ⇒ Object

services



223
224
225
 
# File 'lib/adyen/client.rb', line 223

def checkout
  @checkout ||= Adyen::Checkout.new(self)
end

#data_protection ⇒ Object 



247
248
249
 
# File 'lib/adyen/client.rb', line 247

def data_protection
  @data_protection ||= Adyen::DataProtection.new(self)
end

#disputes ⇒ Object 



251
252
253
 
# File 'lib/adyen/client.rb', line 251

def disputes
  @disputes ||= Adyen::Disputes.new(self)
end

#legal_entity_management ⇒ Object 



259
260
261
 
# File 'lib/adyen/client.rb', line 259

def legal_entity_management
  @legal_entity_management ||= Adyen::LegalEntityManagement.new(self)
end

#live_url_prefix=(value) ⇒ Object

remove ‘https’ from live_url_prefix if necessary



49
50
51
52
 
# File 'lib/adyen/client.rb', line 49

def live_url_prefix=(value)
  value['https://'] = '' unless value['https://'].nil?
  @live_url_prefix = value
end

#management ⇒ Object 



271
272
273
 
# File 'lib/adyen/client.rb', line 271

def management
  @management ||= Adyen::Management.new(self)
end

#marketpay ⇒ Object 



239
240
241
 
# File 'lib/adyen/client.rb', line 239

def marketpay
  @marketpay ||= Adyen::Marketpay::Marketpay.new(self)
end

#payment ⇒ Object 



227
228
229
 
# File 'lib/adyen/client.rb', line 227

def payment
  @payment ||= Adyen::Payment.new(self)
end

#payout ⇒ Object 



231
232
233
 
# File 'lib/adyen/client.rb', line 231

def payout
  @payout ||= Adyen::Payout.new(self)
end

#pos_terminal_management ⇒ Object 



243
244
245
 
# File 'lib/adyen/client.rb', line 243

def pos_terminal_management
  @pos_terminal_management ||= Adyen::PosTerminalManagement.new(self)
end

#recurring ⇒ Object 



235
236
237
 
# File 'lib/adyen/client.rb', line 235

def recurring
  @recurring ||= Adyen::Recurring.new(self)
end

#service_url(service, action, version) ⇒ Object

construct full URL from service and endpoint



114
115
116
117
118
119
120
121
122
 
# File 'lib/adyen/client.rb', line 114

def service_url(service, action, version)
  if service == "Checkout" && @env == :live
    return "#{service_url_base(service)}/checkout/v#{version}/#{action}"
  elsif version == nil
    return "#{service_url_base(service)}/#{action}"
  else
    return "#{service_url_base(service)}/v#{version}/#{action}"
  end
end

#service_url_base(service) ⇒ Object

base URL for API given service and @env



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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'lib/adyen/client.rb', line 55

def service_url_base(service)
  if @env == :mock
    @mock_service_url_base
  else
    case service
    when 'Checkout'
      url = "https://checkout-#{@env}.adyen.com"
      supports_live_url_prefix = true
    when 'Account', 'Fund', 'Notification', 'Hop'
      url = "https://cal-#{@env}.adyen.com/cal/services/#{service}"
      supports_live_url_prefix = false
    when 'Recurring', 'Payment', 'Payout', 'BinLookup', 'StoredValue', 'BalanceControlService'
      url = "https://pal-#{@env}.adyen.com/pal/servlet/#{service}"
      supports_live_url_prefix = true
    when 'PosTerminalManagement'
      url = "https://postfmapi-#{@env}.adyen.com/postfmapi/terminal"
      supports_live_url_prefix = false
    when 'DataProtectionService', 'DisputesService'
      url = "https://ca-#{@env}.adyen.com/ca/services/#{service}"
      supports_live_url_prefix = false
    when 'LegalEntityManagement'
      url = "https://kyc-#{@env}.adyen.com/lem"
      supports_live_url_prefix = false
    when 'BalancePlatform'
      url = "https://balanceplatform-api-#{@env}.adyen.com/bcl"
      supports_live_url_prefix = false
    when 'Transfers'
      url = "https://balanceplatform-api-#{@env}.adyen.com/btl"
      supports_live_url_prefix = false
    when 'Management'
      url = "https://management-#{@env}.adyen.com"
      supports_live_url_prefix = false
    when 'TerminalCloudAPI'
      url = if !terminal_region.nil?
        "https://terminal-api-#{@env}-#{terminal_region}.adyen.com"
      else
        "https://terminal-api-#{@env}.adyen.com"
      end
      supports_live_url_prefix = false
    else
      raise ArgumentError, 'Invalid service specified'
    end

    if @live_url_prefix.nil? && (@env == :live) && supports_live_url_prefix
      raise ArgumentError,
            "Please set Client.live_url_prefix to the portion \
      of your merchant-specific URL prior to '-[service]-live.adyenpayments.com'"
    end

    if @env == :live && supports_live_url_prefix
      url.insert(8, "#{@live_url_prefix}-")
      url['adyen.com'] = 'adyenpayments.com'
    end

    url
  end
end

#stored_value ⇒ Object 



275
276
277
 
# File 'lib/adyen/client.rb', line 275

def stored_value
  @stored_value ||= Adyen::StoredValue.new(self)
end

#terminal_cloud_api ⇒ Object 



283
284
285
 
# File 'lib/adyen/client.rb', line 283

def terminal_cloud_api
  @terminal_cloud_api ||= Adyen::TerminalCloudAPI.new(self)
end

#transfers ⇒ Object 



267
268
269
 
# File 'lib/adyen/client.rb', line 267

def transfers
  @transfers ||= Adyen::Transfers.new(self)
end