Module: Soaspec::RestAccessors

Included in:
RestHandler
Defined in:
lib/soaspec/exchange_handlers/rest_handler.rb

Overview

Accessors specific to REST handler

Instance Method Summary collapse

Instance Method Details

#base_url(url) ⇒ Object

Defines method ‘base_url_value’ containing base URL used in REST requests

Parameters:

  • url (String) —

    Base Url to use in REST requests. Suburl is appended to this



19
20
21
22
23
 
# File 'lib/soaspec/exchange_handlers/rest_handler.rb', line 19

def base_url(url)
  define_method('base_url_value') do
    url
  end
end

#headers(headers) ⇒ Object

Parameters:

  • headers (Hash) —

    Hash of REST headers used in RestClient



90
91
92
93
94
 
# File 'lib/soaspec/exchange_handlers/rest_handler.rb', line 90

def headers(headers)
  define_method('rest_client_headers') do
    headers
  end
end

#oauth2(client_id: nil, client_secret: nil, token_url: nil, username: nil, password: nil, security_token: nil) ⇒ Object

Will create access_token method based on passed parameters



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/soaspec/exchange_handlers/rest_handler.rb', line 26

def oauth2(client_id: nil, client_secret: nil, token_url: nil, username: nil, password: nil, security_token: nil)
  define_method('oauth_response') do
    response = if password && username && security_token
                 RestClient.post(
                     token_url,
                     {
                         grant_type: 'password',
                         client_id: client_id,
                         client_secret: client_secret,
                         username: username,
                         password: (password + security_token),
                         multipart: true
                     },
                     cache_control: 'no_cache',
                     verify_ssl: false
                 )
               elsif password && username
                 RestClient.post(
                     token_url,
                     {
                         grant_type: 'password',
                         client_id: client_id,
                         client_secret: client_secret,
                         username: username,
                         password: password,
                         multipart: true
                     },
                     cache_control: 'no_cache',
                     verify_ssl: false
                 )
               else
                 RestClient.post(
                     token_url,
                     {
                         grant_type: 'client_credentials',
                         client_id: client_id,
                         client_secret: client_secret
                     },
                     cache_control: 'no_cache',
                     verify_ssl: false
                 )
               end
    JSON.parse(response)
  end

  define_method('access_token') do
    oauth_response['access_token']
  end
  define_method('instance_url') do
    oauth_response['instance_url']
  end
end

#oauth2_file(path_to_filename) ⇒ Object

Pass path to YAML file containing OAuth2 parameters

Parameters:

  • path_to_filename (String) —

    Will have Soaspec.credentials_folder appended to it if set



81
82
83
84
85
86
87
 
# File 'lib/soaspec/exchange_handlers/rest_handler.rb', line 81

def oauth2_file(path_to_filename)
  full_path = Soaspec.credentials_folder ? File.join(Soaspec.credentials_folder, path_to_filename + '.yml') : path_to_filename + '.yml'
  file_hash = eval(ERB.new(YAML.load_file(full_path).to_s).result(binding))
  raise 'File at ' + full_path + ' is not a hash ' unless file_hash.is_a? Hash
  oauth_hash = file_hash.transform_keys_to_symbols
  oauth2 **oauth_hash
end