soaspec 0.2.23 → 0.2.24
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +15 -15
- data/.gitlab-ci.yml +33 -33
- data/.rspec +3 -3
- data/.rubocop.yml +2 -2
- data/CODE_OF_CONDUCT.md +74 -74
- data/ChangeLog +577 -573
- data/Gemfile +6 -6
- data/LICENSE.txt +21 -21
- data/README.md +230 -230
- data/Rakefile +42 -42
- data/Todo.md +15 -15
- data/exe/soaspec +123 -123
- data/exe/xml_to_yaml_file +42 -42
- data/lib/soaspec.rb +101 -101
- data/lib/soaspec/core_ext/hash.rb +35 -35
- data/lib/soaspec/cucumber/generic_steps.rb +85 -85
- data/lib/soaspec/demo.rb +4 -4
- data/lib/soaspec/exchange/exchange.rb +111 -111
- data/lib/soaspec/exchange/exchange_extractor.rb +83 -83
- data/lib/soaspec/exchange/exchange_properties.rb +26 -26
- data/lib/soaspec/exchange/exchange_repeater.rb +19 -19
- data/lib/soaspec/exchange/request_builder.rb +68 -68
- data/lib/soaspec/exchange/variable_storer.rb +22 -22
- data/lib/soaspec/exchange_handlers/exchange_handler.rb +126 -126
- data/lib/soaspec/exchange_handlers/handler_accessors.rb +130 -130
- data/lib/soaspec/exchange_handlers/response_extractor.rb +82 -82
- data/lib/soaspec/exchange_handlers/rest_exchanger_factory.rb +109 -109
- data/lib/soaspec/exchange_handlers/rest_handler.rb +259 -259
- data/lib/soaspec/exchange_handlers/rest_methods.rb +44 -44
- data/lib/soaspec/exchange_handlers/rest_parameters.rb +86 -86
- data/lib/soaspec/exchange_handlers/rest_parameters_defaults.rb +21 -21
- data/lib/soaspec/exchange_handlers/soap_handler.rb +235 -235
- data/lib/soaspec/exe_helpers.rb +92 -92
- data/lib/soaspec/generate_server.rb +37 -37
- data/lib/soaspec/generator/.rspec.erb +5 -5
- data/lib/soaspec/generator/.travis.yml.erb +5 -5
- data/lib/soaspec/generator/Gemfile.erb +8 -8
- data/lib/soaspec/generator/README.md.erb +29 -29
- data/lib/soaspec/generator/Rakefile.erb +19 -19
- data/lib/soaspec/generator/config/data/default.yml.erb +2 -2
- data/lib/soaspec/generator/css/bootstrap.css +6833 -6833
- data/lib/soaspec/generator/generate_exchange.html.erb +35 -35
- data/lib/soaspec/generator/lib/blz_service.rb.erb +26 -26
- data/lib/soaspec/generator/lib/dynamic_class_content.rb.erb +12 -12
- data/lib/soaspec/generator/lib/new_rest_service.rb.erb +51 -51
- data/lib/soaspec/generator/lib/new_soap_service.rb.erb +29 -29
- data/lib/soaspec/generator/lib/package_service.rb.erb +2 -2
- data/lib/soaspec/generator/lib/shared_example.rb.erb +8 -8
- data/lib/soaspec/generator/spec/dynamic_soap_spec.rb.erb +12 -12
- data/lib/soaspec/generator/spec/rest_spec.rb.erb +9 -9
- data/lib/soaspec/generator/spec/soap_spec.rb.erb +51 -51
- data/lib/soaspec/generator/spec/spec_helper.rb.erb +23 -23
- data/lib/soaspec/generator/template/soap_template.xml +6 -6
- data/lib/soaspec/indifferent_hash.rb +7 -7
- data/lib/soaspec/interpreter.rb +39 -39
- data/lib/soaspec/matchers.rb +114 -114
- data/lib/soaspec/not_found_errors.rb +13 -13
- data/lib/soaspec/o_auth2.rb +128 -128
- data/lib/soaspec/soaspec_shared_examples.rb +24 -24
- data/lib/soaspec/spec_logger.rb +121 -121
- data/lib/soaspec/template_reader.rb +28 -28
- data/lib/soaspec/test_server/bank.wsdl +90 -90
- data/lib/soaspec/test_server/get_bank.rb +164 -164
- data/lib/soaspec/test_server/id_manager.rb +39 -39
- data/lib/soaspec/test_server/invoices.rb +27 -27
- data/lib/soaspec/test_server/namespace.xml +14 -14
- data/lib/soaspec/test_server/note.xml +5 -5
- data/lib/soaspec/test_server/puppy_service.rb +19 -19
- data/lib/soaspec/test_server/test_attribute.rb +12 -12
- data/lib/soaspec/test_server/test_namespace.rb +12 -12
- data/lib/soaspec/version.rb +4 -3
- data/lib/soaspec/virtual_server.rb +174 -174
- data/lib/soaspec/wait.rb +41 -41
- data/lib/soaspec/wsdl_generator.rb +215 -215
- data/soaspec.gemspec +53 -53
- data/test.wsdl +116 -116
- data/test.xml +10 -10
- data/test_wsdl.rb +41 -41
- metadata +3 -4
@@ -1,130 +1,130 @@
|
|
1
|
-
module Soaspec
|
2
|
-
# Describes methods test handlers use to easily set attributes
|
3
|
-
# Some are included in 'success scenarios' and to configure the request sent
|
4
|
-
module HandlerAccessors
|
5
|
-
# Defines expected_mandatory_elements method used in 'success_scenario' shared examples
|
6
|
-
# to indicate certain elements must be present
|
7
|
-
# @param [Array] elements Array of symbols specifying expected element names for 'success scenario' in snakecase
|
8
|
-
#
|
9
|
-
# @example Inside class
|
10
|
-
# mandatory_elements :GetWeatherResult
|
11
|
-
#
|
12
|
-
# Or for a list
|
13
|
-
#
|
14
|
-
# @example Inside class
|
15
|
-
# mandatory_elements [:GetWeatherResult, :GetResultStatus]
|
16
|
-
#
|
17
|
-
# In test
|
18
|
-
# describe Exchange(:name) do
|
19
|
-
# it_behaves_like 'success scenario' # Includes checks for mandatory elements
|
20
|
-
# end
|
21
|
-
def mandatory_elements(elements)
|
22
|
-
define_method('expected_mandatory_elements') do
|
23
|
-
return [elements] if elements.is_a?(String) || elements.is_a?(Symbol)
|
24
|
-
|
25
|
-
elements
|
26
|
-
end
|
27
|
-
end
|
28
|
-
|
29
|
-
# Defines mandatory xpaths value pairs to be included in 'success scenario' shared example
|
30
|
-
#
|
31
|
-
# @example Inside class
|
32
|
-
# mandatory_xpath_values '//xmlns:GetWeatherResult' => 'Data Not Found'
|
33
|
-
#
|
34
|
-
# @example In test
|
35
|
-
# describe Exchange(:name) do
|
36
|
-
# it_behaves_like 'success scenario' # Includes xpath pair validation
|
37
|
-
# end
|
38
|
-
#
|
39
|
-
# @param [Hash] xpath_value_pairs Hash of element => expected value that must appear
|
40
|
-
# in a successful response body
|
41
|
-
def mandatory_xpath_values(xpath_value_pairs)
|
42
|
-
raise ArgumentError('Hash of {xpath => expected values} expected ') unless xpath_value_pairs.is_a? Hash
|
43
|
-
|
44
|
-
define_method('expected_mandatory_xpath_values') { xpath_value_pairs }
|
45
|
-
end
|
46
|
-
|
47
|
-
# Defines mandatory json path value pairs to be included in 'success scenario' shared example
|
48
|
-
#
|
49
|
-
# @example Inside class
|
50
|
-
# mandatory_json_values '$..GetWeatherResult' => 'Found'
|
51
|
-
#
|
52
|
-
# @example In test
|
53
|
-
# describe Exchange(:name) do
|
54
|
-
# it_behaves_like 'success scenario' # Includes json pair validation
|
55
|
-
# end
|
56
|
-
#
|
57
|
-
# @param [Hash] json_value_pairs Hash of element => expected value that must appear
|
58
|
-
# in a successful response body
|
59
|
-
def mandatory_json_values(json_value_pairs)
|
60
|
-
raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
|
61
|
-
|
62
|
-
define_method('expected_mandatory_json_values') { json_value_pairs }
|
63
|
-
end
|
64
|
-
|
65
|
-
# Links a particular path to a meaningful method that can be accessed from Exchange class.
|
66
|
-
# This will use the 'value_from_path' method which
|
67
|
-
# should be implemented by each ExchangeHandler
|
68
|
-
# @param [String, Symbol] name Method name used to access element
|
69
|
-
# @param [String, Symbol] path Path to find object (e.g, XPath, JSONPath).
|
70
|
-
# For JSONPath a ',' can be put to get an element either path
|
71
|
-
def element(name, path)
|
72
|
-
define_method("__custom_path_#{name}") do |response|
|
73
|
-
value_from_path(response, path.to_s)
|
74
|
-
end
|
75
|
-
end
|
76
|
-
|
77
|
-
# Links an attribute to a meaningful method that can be accessed from Exchange class.
|
78
|
-
# This will use the 'value_from_path' method which
|
79
|
-
# should be implemented by each ExchangeHandler
|
80
|
-
# @param [String, Symbol] name Method name used to access attribute
|
81
|
-
# @param [String, nil, Hash] attribute Attribute name to extract from xml. If not set, this will default to @name
|
82
|
-
def attribute(name, attribute = nil)
|
83
|
-
attribute_used = attribute || name.to_s
|
84
|
-
define_method("__custom_path_#{name}") do |response|
|
85
|
-
value_from_path(response, 'implicit', attribute: attribute_used)
|
86
|
-
end
|
87
|
-
end
|
88
|
-
|
89
|
-
# All xpath will be done with XML that is converted to lower case
|
90
|
-
# You must then use lower case in the xpath's to obtain the desired values
|
91
|
-
# @param [Boolean] set Whether to convert all xml in response to lower case before performing XPath
|
92
|
-
def convert_to_lower(set)
|
93
|
-
return unless set
|
94
|
-
|
95
|
-
define_method('convert_to_lower?') { true }
|
96
|
-
end
|
97
|
-
|
98
|
-
# Whether to remove namespaces from response in Xpath assertion automatically
|
99
|
-
# For why this may not be a good thing in general see
|
100
|
-
# http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
|
101
|
-
# This will be overridden if xpath has a ':' in it
|
102
|
-
# @param [Boolean] set Whether to strip namespaces form XML response
|
103
|
-
def strip_namespaces(set)
|
104
|
-
return unless set
|
105
|
-
|
106
|
-
# Whether to remove namespaces in xpath assertion automatically
|
107
|
-
define_method('strip_namespaces?') { true }
|
108
|
-
end
|
109
|
-
|
110
|
-
# Set the default hash representing data to be used in making a request
|
111
|
-
# This will set the @request_option instance variable too
|
112
|
-
# @param [Hash] hash Default hash of request
|
113
|
-
def default_hash(hash)
|
114
|
-
define_method('default_hash_value') do
|
115
|
-
@request_option = :hash
|
116
|
-
Soaspec.always_use_keys? ? hash.transform_keys_to_symbols : hash
|
117
|
-
end
|
118
|
-
end
|
119
|
-
|
120
|
-
# Set the request option type and the template name
|
121
|
-
# Erb is used to parse the template file, executing Ruby code in `<%= %>` blocks to work out the final request
|
122
|
-
# @param [String] name Name of file inside 'template' folder excluding extension
|
123
|
-
def template_name(name)
|
124
|
-
define_method('template_name_value') do
|
125
|
-
@request_option = :template
|
126
|
-
name
|
127
|
-
end
|
128
|
-
end
|
129
|
-
end
|
130
|
-
end
|
1
|
+
module Soaspec
|
2
|
+
# Describes methods test handlers use to easily set attributes
|
3
|
+
# Some are included in 'success scenarios' and to configure the request sent
|
4
|
+
module HandlerAccessors
|
5
|
+
# Defines expected_mandatory_elements method used in 'success_scenario' shared examples
|
6
|
+
# to indicate certain elements must be present
|
7
|
+
# @param [Array] elements Array of symbols specifying expected element names for 'success scenario' in snakecase
|
8
|
+
#
|
9
|
+
# @example Inside class
|
10
|
+
# mandatory_elements :GetWeatherResult
|
11
|
+
#
|
12
|
+
# Or for a list
|
13
|
+
#
|
14
|
+
# @example Inside class
|
15
|
+
# mandatory_elements [:GetWeatherResult, :GetResultStatus]
|
16
|
+
#
|
17
|
+
# In test
|
18
|
+
# describe Exchange(:name) do
|
19
|
+
# it_behaves_like 'success scenario' # Includes checks for mandatory elements
|
20
|
+
# end
|
21
|
+
def mandatory_elements(elements)
|
22
|
+
define_method('expected_mandatory_elements') do
|
23
|
+
return [elements] if elements.is_a?(String) || elements.is_a?(Symbol)
|
24
|
+
|
25
|
+
elements
|
26
|
+
end
|
27
|
+
end
|
28
|
+
|
29
|
+
# Defines mandatory xpaths value pairs to be included in 'success scenario' shared example
|
30
|
+
#
|
31
|
+
# @example Inside class
|
32
|
+
# mandatory_xpath_values '//xmlns:GetWeatherResult' => 'Data Not Found'
|
33
|
+
#
|
34
|
+
# @example In test
|
35
|
+
# describe Exchange(:name) do
|
36
|
+
# it_behaves_like 'success scenario' # Includes xpath pair validation
|
37
|
+
# end
|
38
|
+
#
|
39
|
+
# @param [Hash] xpath_value_pairs Hash of element => expected value that must appear
|
40
|
+
# in a successful response body
|
41
|
+
def mandatory_xpath_values(xpath_value_pairs)
|
42
|
+
raise ArgumentError('Hash of {xpath => expected values} expected ') unless xpath_value_pairs.is_a? Hash
|
43
|
+
|
44
|
+
define_method('expected_mandatory_xpath_values') { xpath_value_pairs }
|
45
|
+
end
|
46
|
+
|
47
|
+
# Defines mandatory json path value pairs to be included in 'success scenario' shared example
|
48
|
+
#
|
49
|
+
# @example Inside class
|
50
|
+
# mandatory_json_values '$..GetWeatherResult' => 'Found'
|
51
|
+
#
|
52
|
+
# @example In test
|
53
|
+
# describe Exchange(:name) do
|
54
|
+
# it_behaves_like 'success scenario' # Includes json pair validation
|
55
|
+
# end
|
56
|
+
#
|
57
|
+
# @param [Hash] json_value_pairs Hash of element => expected value that must appear
|
58
|
+
# in a successful response body
|
59
|
+
def mandatory_json_values(json_value_pairs)
|
60
|
+
raise ArgumentError("Hash of {'jsonpath' => expected values} expected") unless json_value_pairs.is_a? Hash
|
61
|
+
|
62
|
+
define_method('expected_mandatory_json_values') { json_value_pairs }
|
63
|
+
end
|
64
|
+
|
65
|
+
# Links a particular path to a meaningful method that can be accessed from Exchange class.
|
66
|
+
# This will use the 'value_from_path' method which
|
67
|
+
# should be implemented by each ExchangeHandler
|
68
|
+
# @param [String, Symbol] name Method name used to access element
|
69
|
+
# @param [String, Symbol] path Path to find object (e.g, XPath, JSONPath).
|
70
|
+
# For JSONPath a ',' can be put to get an element either path
|
71
|
+
def element(name, path)
|
72
|
+
define_method("__custom_path_#{name}") do |response|
|
73
|
+
value_from_path(response, path.to_s)
|
74
|
+
end
|
75
|
+
end
|
76
|
+
|
77
|
+
# Links an attribute to a meaningful method that can be accessed from Exchange class.
|
78
|
+
# This will use the 'value_from_path' method which
|
79
|
+
# should be implemented by each ExchangeHandler
|
80
|
+
# @param [String, Symbol] name Method name used to access attribute
|
81
|
+
# @param [String, nil, Hash] attribute Attribute name to extract from xml. If not set, this will default to @name
|
82
|
+
def attribute(name, attribute = nil)
|
83
|
+
attribute_used = attribute || name.to_s
|
84
|
+
define_method("__custom_path_#{name}") do |response|
|
85
|
+
value_from_path(response, 'implicit', attribute: attribute_used)
|
86
|
+
end
|
87
|
+
end
|
88
|
+
|
89
|
+
# All xpath will be done with XML that is converted to lower case
|
90
|
+
# You must then use lower case in the xpath's to obtain the desired values
|
91
|
+
# @param [Boolean] set Whether to convert all xml in response to lower case before performing XPath
|
92
|
+
def convert_to_lower(set)
|
93
|
+
return unless set
|
94
|
+
|
95
|
+
define_method('convert_to_lower?') { true }
|
96
|
+
end
|
97
|
+
|
98
|
+
# Whether to remove namespaces from response in Xpath assertion automatically
|
99
|
+
# For why this may not be a good thing in general see
|
100
|
+
# http://tenderlovemaking.com/2009/04/23/namespaces-in-xml.html
|
101
|
+
# This will be overridden if xpath has a ':' in it
|
102
|
+
# @param [Boolean] set Whether to strip namespaces form XML response
|
103
|
+
def strip_namespaces(set)
|
104
|
+
return unless set
|
105
|
+
|
106
|
+
# Whether to remove namespaces in xpath assertion automatically
|
107
|
+
define_method('strip_namespaces?') { true }
|
108
|
+
end
|
109
|
+
|
110
|
+
# Set the default hash representing data to be used in making a request
|
111
|
+
# This will set the @request_option instance variable too
|
112
|
+
# @param [Hash] hash Default hash of request
|
113
|
+
def default_hash(hash)
|
114
|
+
define_method('default_hash_value') do
|
115
|
+
@request_option = :hash
|
116
|
+
Soaspec.always_use_keys? ? hash.transform_keys_to_symbols : hash
|
117
|
+
end
|
118
|
+
end
|
119
|
+
|
120
|
+
# Set the request option type and the template name
|
121
|
+
# Erb is used to parse the template file, executing Ruby code in `<%= %>` blocks to work out the final request
|
122
|
+
# @param [String] name Name of file inside 'template' folder excluding extension
|
123
|
+
def template_name(name)
|
124
|
+
define_method('template_name_value') do
|
125
|
+
@request_option = :template
|
126
|
+
name
|
127
|
+
end
|
128
|
+
end
|
129
|
+
end
|
130
|
+
end
|
@@ -1,82 +1,82 @@
|
|
1
|
-
module Soaspec
|
2
|
-
# Enables extracting a response according to type / path
|
3
|
-
module ResponseExtractor
|
4
|
-
# Convert XML or JSON response into a Hash. Doesn't accept empty body
|
5
|
-
# @param [String] response Response as a String (either in XML or JSON)
|
6
|
-
# @return [Hash] Extracted Hash from response
|
7
|
-
def extract_hash(response)
|
8
|
-
raise NoElementAtPath, "Empty Body. Can't assert on it" if response.body.empty?
|
9
|
-
|
10
|
-
case Interpreter.response_type_for response
|
11
|
-
when :xml then parse_xml(response.body.to_s)
|
12
|
-
when :json
|
13
|
-
converted = JSON.parse(response.body)
|
14
|
-
return converted.transform_keys_to_symbols if converted.is_a? Hash
|
15
|
-
return converted.map!(&:transform_keys_to_symbols) if converted.is_a? Array
|
16
|
-
|
17
|
-
raise 'Incorrect Type produced ' + converted.class
|
18
|
-
else
|
19
|
-
raise "Neither XML nor JSON detected. It is #{type}. Don't know how to parse It is #{response.body}"
|
20
|
-
end
|
21
|
-
end
|
22
|
-
|
23
|
-
# @param [Object] response Response object
|
24
|
-
# @return [Hash] Hash representing response body
|
25
|
-
def to_hash(response)
|
26
|
-
case Interpreter.response_type_for(response)
|
27
|
-
when :xml then IndifferentHash.new(parse_xml(response.body.to_s))
|
28
|
-
when :json
|
29
|
-
IndifferentHash.new(JSON.parse(response.body.to_s))
|
30
|
-
else
|
31
|
-
raise "Unable to interpret type of #{response.body}"
|
32
|
-
end
|
33
|
-
end
|
34
|
-
|
35
|
-
private
|
36
|
-
|
37
|
-
# @param [String] xml XML to convert
|
38
|
-
# @return [Hash] Hash representing XML
|
39
|
-
def parse_xml(xml)
|
40
|
-
parser = Nori.new(strip_namespaces: strip_namespaces?, convert_tags_to: ->(tag) { tag.snakecase.to_sym })
|
41
|
-
parser.parse(xml)
|
42
|
-
end
|
43
|
-
|
44
|
-
# This enables shortcut xpaths to be used. If no '/' is given, one is appended to the start of the path
|
45
|
-
# If attribute value is set then this is also adjusted
|
46
|
-
# @return [String] New Xpath adjusted according to any add ons
|
47
|
-
def prefix_xpath(xpath, attribute)
|
48
|
-
xpath = "//*[@#{attribute}]" unless attribute.nil?
|
49
|
-
if xpath[0] != '/'
|
50
|
-
xpath = convert_to_pascal_case(xpath) if pascal_keys?
|
51
|
-
xpath = '//' + xpath
|
52
|
-
end
|
53
|
-
xpath
|
54
|
-
end
|
55
|
-
|
56
|
-
# Convert snakecase to PascalCase
|
57
|
-
# @return [String] PascalCase converted path
|
58
|
-
def convert_to_pascal_case(key)
|
59
|
-
return key if /[[:upper:]]/ =~ key[0] # If first character already capital, don't do conversion
|
60
|
-
|
61
|
-
key.split('_').map(&:capitalize).join
|
62
|
-
end
|
63
|
-
|
64
|
-
# Find element with name specified or pascal case equivalent
|
65
|
-
# @return [String] String to find paths with pascal converted or given path
|
66
|
-
def add_pascal_path(json_path)
|
67
|
-
return json_path unless pascal_keys?
|
68
|
-
|
69
|
-
json_path.split(',').collect do |sub_path|
|
70
|
-
"#{sub_path},#{convert_to_pascal_case(sub_path)}"
|
71
|
-
end.join(',')
|
72
|
-
end
|
73
|
-
|
74
|
-
# @param [String] json_path Path set from Exchange
|
75
|
-
# @return [String] JSON Path
|
76
|
-
def prefix_json_path(json_path)
|
77
|
-
return json_path if json_path[0] == '$'
|
78
|
-
|
79
|
-
"$..#{json_path}"
|
80
|
-
end
|
81
|
-
end
|
82
|
-
end
|
1
|
+
module Soaspec
|
2
|
+
# Enables extracting a response according to type / path
|
3
|
+
module ResponseExtractor
|
4
|
+
# Convert XML or JSON response into a Hash. Doesn't accept empty body
|
5
|
+
# @param [String] response Response as a String (either in XML or JSON)
|
6
|
+
# @return [Hash] Extracted Hash from response
|
7
|
+
def extract_hash(response)
|
8
|
+
raise NoElementAtPath, "Empty Body. Can't assert on it" if response.body.empty?
|
9
|
+
|
10
|
+
case Interpreter.response_type_for response
|
11
|
+
when :xml then parse_xml(response.body.to_s)
|
12
|
+
when :json
|
13
|
+
converted = JSON.parse(response.body)
|
14
|
+
return converted.transform_keys_to_symbols if converted.is_a? Hash
|
15
|
+
return converted.map!(&:transform_keys_to_symbols) if converted.is_a? Array
|
16
|
+
|
17
|
+
raise 'Incorrect Type produced ' + converted.class
|
18
|
+
else
|
19
|
+
raise "Neither XML nor JSON detected. It is #{type}. Don't know how to parse It is #{response.body}"
|
20
|
+
end
|
21
|
+
end
|
22
|
+
|
23
|
+
# @param [Object] response Response object
|
24
|
+
# @return [Hash] Hash representing response body
|
25
|
+
def to_hash(response)
|
26
|
+
case Interpreter.response_type_for(response)
|
27
|
+
when :xml then IndifferentHash.new(parse_xml(response.body.to_s))
|
28
|
+
when :json
|
29
|
+
IndifferentHash.new(JSON.parse(response.body.to_s))
|
30
|
+
else
|
31
|
+
raise "Unable to interpret type of #{response.body}"
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
private
|
36
|
+
|
37
|
+
# @param [String] xml XML to convert
|
38
|
+
# @return [Hash] Hash representing XML
|
39
|
+
def parse_xml(xml)
|
40
|
+
parser = Nori.new(strip_namespaces: strip_namespaces?, convert_tags_to: ->(tag) { tag.snakecase.to_sym })
|
41
|
+
parser.parse(xml)
|
42
|
+
end
|
43
|
+
|
44
|
+
# This enables shortcut xpaths to be used. If no '/' is given, one is appended to the start of the path
|
45
|
+
# If attribute value is set then this is also adjusted
|
46
|
+
# @return [String] New Xpath adjusted according to any add ons
|
47
|
+
def prefix_xpath(xpath, attribute)
|
48
|
+
xpath = "//*[@#{attribute}]" unless attribute.nil?
|
49
|
+
if xpath[0] != '/'
|
50
|
+
xpath = convert_to_pascal_case(xpath) if pascal_keys?
|
51
|
+
xpath = '//' + xpath
|
52
|
+
end
|
53
|
+
xpath
|
54
|
+
end
|
55
|
+
|
56
|
+
# Convert snakecase to PascalCase
|
57
|
+
# @return [String] PascalCase converted path
|
58
|
+
def convert_to_pascal_case(key)
|
59
|
+
return key if /[[:upper:]]/ =~ key[0] # If first character already capital, don't do conversion
|
60
|
+
|
61
|
+
key.split('_').map(&:capitalize).join
|
62
|
+
end
|
63
|
+
|
64
|
+
# Find element with name specified or pascal case equivalent
|
65
|
+
# @return [String] String to find paths with pascal converted or given path
|
66
|
+
def add_pascal_path(json_path)
|
67
|
+
return json_path unless pascal_keys?
|
68
|
+
|
69
|
+
json_path.split(',').collect do |sub_path|
|
70
|
+
"#{sub_path},#{convert_to_pascal_case(sub_path)}"
|
71
|
+
end.join(',')
|
72
|
+
end
|
73
|
+
|
74
|
+
# @param [String] json_path Path set from Exchange
|
75
|
+
# @return [String] JSON Path
|
76
|
+
def prefix_json_path(json_path)
|
77
|
+
return json_path if json_path[0] == '$'
|
78
|
+
|
79
|
+
"$..#{json_path}"
|
80
|
+
end
|
81
|
+
end
|
82
|
+
end
|
@@ -1,109 +1,109 @@
|
|
1
|
-
module Soaspec
|
2
|
-
# Convenience methods for once off usage of a REST request
|
3
|
-
module RestExchangeFactory
|
4
|
-
# Make REST Exchange with 'post' method within this Handler context
|
5
|
-
# @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
|
6
|
-
# @option params [String] :name Name to appear in traffic logs
|
7
|
-
# @option params [Hash] :params Extra parameters (E.g. headers)
|
8
|
-
# @option params [String] :suburl URL appended to base_url of class
|
9
|
-
# @option params [Hash] :q Query for REST
|
10
|
-
# Following are for the body of the request
|
11
|
-
# @option params [Hash] :body Hash to be converted to JSON in request body
|
12
|
-
# @option params [String] :payload String to be passed directly in request body
|
13
|
-
# @option params [String] :template_name Path to file to be read via ERB and passed in request body
|
14
|
-
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
15
|
-
def post(params = {})
|
16
|
-
perform_exchange_with(:post, params)
|
17
|
-
end
|
18
|
-
|
19
|
-
# Make REST Exchange with 'patch' method within this Handler context
|
20
|
-
# @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
|
21
|
-
# @option params [String] :name Name to appear in traffic logs
|
22
|
-
# @option params [Hash] :params Extra parameters (E.g. headers)
|
23
|
-
# @option params [String] suburl URL appended to base_url of class
|
24
|
-
# @option params [Hash] :q Query for REST
|
25
|
-
# Following are for the body of the request
|
26
|
-
# @option params [Hash] :body Hash to be converted to JSON in request body
|
27
|
-
# @option params [String] :payload String to be passed directly in request body
|
28
|
-
# @option params [String] :template_name Path to file to be read via ERB and passed in request body
|
29
|
-
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
30
|
-
def patch(params)
|
31
|
-
perform_exchange_with(:patch, params)
|
32
|
-
end
|
33
|
-
|
34
|
-
# Make REST Exchange with 'put' method within this Handler context
|
35
|
-
# @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
|
36
|
-
# @option params [String] :name Name to appear in traffic logs
|
37
|
-
# @option params [Hash] :params Extra parameters (E.g. headers)
|
38
|
-
# @option params [String] :suburl URL appended to base_url of class
|
39
|
-
# @option params [Hash] :q Query for REST
|
40
|
-
# Following are for the body of the request
|
41
|
-
# @option params [Hash] :body Hash to be converted to JSON in request body
|
42
|
-
# @option params [String] :payload String to be passed directly in request body
|
43
|
-
# @option params [String] :template_name Path to file to be read via ERB and passed in request body
|
44
|
-
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
45
|
-
def put(params = {})
|
46
|
-
perform_exchange_with(:put, params)
|
47
|
-
end
|
48
|
-
|
49
|
-
# Make REST Exchange with 'get' method within this Handler context.
|
50
|
-
# If merely a string is passed it will be used as the URL appended to base_url (same as suburl). Otherwise a Hash is expected
|
51
|
-
# @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
|
52
|
-
# @option params [String] :name Name to appear in traffic logs
|
53
|
-
# @option params [String] :suburl URL appended to base_url of class
|
54
|
-
# @option params [Hash] :params Extra parameters (E.g. headers)
|
55
|
-
# @option params [Hash] :q Query for REST
|
56
|
-
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
57
|
-
def get(params = {})
|
58
|
-
perform_exchange_with(:get, params)
|
59
|
-
end
|
60
|
-
|
61
|
-
# Make REST Exchange with 'delete' method within this Handler context.
|
62
|
-
# If merely a string is passed it will be used as the URL appended to base_url (same as suburl). Otherwise a Hash is expected
|
63
|
-
# @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
|
64
|
-
# @option params [String] :name Name to appear in traffic logs
|
65
|
-
# @option params [String] :suburl URL appended to base_url of class
|
66
|
-
# @option params [Hash] :q Query for REST
|
67
|
-
# @option params [Hash] :params Extra parameters (E.g. headers)
|
68
|
-
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
69
|
-
def delete(params = {})
|
70
|
-
perform_exchange_with(:delete, params)
|
71
|
-
end
|
72
|
-
|
73
|
-
private
|
74
|
-
|
75
|
-
# Make REST Exchange within this Handler context
|
76
|
-
# @param [Symbol] rest_method HTTP rest method to use
|
77
|
-
# @param [Hash, String] params Exchange parameters.
|
78
|
-
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
79
|
-
def perform_exchange_with(rest_method, params = {})
|
80
|
-
params = determine_params_for(rest_method, params)
|
81
|
-
params[:name] ||= rest_method.to_s
|
82
|
-
exchange_params = { name: params[:name] }
|
83
|
-
if params[:template_name]
|
84
|
-
exchange_params[:template_name] = params[:template_name]
|
85
|
-
params.delete :template_name
|
86
|
-
end
|
87
|
-
new(exchange_params)
|
88
|
-
exchange = Exchange.new(params[:name], method: rest_method, **params)
|
89
|
-
yield exchange if block_given?
|
90
|
-
exchange
|
91
|
-
end
|
92
|
-
|
93
|
-
# @param [Symbol] method HTTP rest method to use
|
94
|
-
# @param [Hash, String] params Exchange parameters.
|
95
|
-
# @return [Hash] Exchange Parameters after setting shorthand parameters
|
96
|
-
def determine_params_for(method, params)
|
97
|
-
return params if params.is_a? Hash
|
98
|
-
|
99
|
-
case method
|
100
|
-
when :get, :delete
|
101
|
-
{ suburl: params.to_s }
|
102
|
-
when :post, :put, :patch
|
103
|
-
{ payload: params.to_s }
|
104
|
-
else
|
105
|
-
raise "'#{params}' needs to be a 'Hash' but is a #{params.class}"
|
106
|
-
end
|
107
|
-
end
|
108
|
-
end
|
109
|
-
end
|
1
|
+
module Soaspec
|
2
|
+
# Convenience methods for once off usage of a REST request
|
3
|
+
module RestExchangeFactory
|
4
|
+
# Make REST Exchange with 'post' method within this Handler context
|
5
|
+
# @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
|
6
|
+
# @option params [String] :name Name to appear in traffic logs
|
7
|
+
# @option params [Hash] :params Extra parameters (E.g. headers)
|
8
|
+
# @option params [String] :suburl URL appended to base_url of class
|
9
|
+
# @option params [Hash] :q Query for REST
|
10
|
+
# Following are for the body of the request
|
11
|
+
# @option params [Hash] :body Hash to be converted to JSON in request body
|
12
|
+
# @option params [String] :payload String to be passed directly in request body
|
13
|
+
# @option params [String] :template_name Path to file to be read via ERB and passed in request body
|
14
|
+
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
15
|
+
def post(params = {})
|
16
|
+
perform_exchange_with(:post, params)
|
17
|
+
end
|
18
|
+
|
19
|
+
# Make REST Exchange with 'patch' method within this Handler context
|
20
|
+
# @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
|
21
|
+
# @option params [String] :name Name to appear in traffic logs
|
22
|
+
# @option params [Hash] :params Extra parameters (E.g. headers)
|
23
|
+
# @option params [String] suburl URL appended to base_url of class
|
24
|
+
# @option params [Hash] :q Query for REST
|
25
|
+
# Following are for the body of the request
|
26
|
+
# @option params [Hash] :body Hash to be converted to JSON in request body
|
27
|
+
# @option params [String] :payload String to be passed directly in request body
|
28
|
+
# @option params [String] :template_name Path to file to be read via ERB and passed in request body
|
29
|
+
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
30
|
+
def patch(params)
|
31
|
+
perform_exchange_with(:patch, params)
|
32
|
+
end
|
33
|
+
|
34
|
+
# Make REST Exchange with 'put' method within this Handler context
|
35
|
+
# @param [Hash, String] params Exchange parameters. If String is used it will be for the request payload
|
36
|
+
# @option params [String] :name Name to appear in traffic logs
|
37
|
+
# @option params [Hash] :params Extra parameters (E.g. headers)
|
38
|
+
# @option params [String] :suburl URL appended to base_url of class
|
39
|
+
# @option params [Hash] :q Query for REST
|
40
|
+
# Following are for the body of the request
|
41
|
+
# @option params [Hash] :body Hash to be converted to JSON in request body
|
42
|
+
# @option params [String] :payload String to be passed directly in request body
|
43
|
+
# @option params [String] :template_name Path to file to be read via ERB and passed in request body
|
44
|
+
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
45
|
+
def put(params = {})
|
46
|
+
perform_exchange_with(:put, params)
|
47
|
+
end
|
48
|
+
|
49
|
+
# Make REST Exchange with 'get' method within this Handler context.
|
50
|
+
# If merely a string is passed it will be used as the URL appended to base_url (same as suburl). Otherwise a Hash is expected
|
51
|
+
# @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
|
52
|
+
# @option params [String] :name Name to appear in traffic logs
|
53
|
+
# @option params [String] :suburl URL appended to base_url of class
|
54
|
+
# @option params [Hash] :params Extra parameters (E.g. headers)
|
55
|
+
# @option params [Hash] :q Query for REST
|
56
|
+
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
57
|
+
def get(params = {})
|
58
|
+
perform_exchange_with(:get, params)
|
59
|
+
end
|
60
|
+
|
61
|
+
# Make REST Exchange with 'delete' method within this Handler context.
|
62
|
+
# If merely a string is passed it will be used as the URL appended to base_url (same as suburl). Otherwise a Hash is expected
|
63
|
+
# @param [Hash, String] params Exchange parameters. If String is used it will be for suburl
|
64
|
+
# @option params [String] :name Name to appear in traffic logs
|
65
|
+
# @option params [String] :suburl URL appended to base_url of class
|
66
|
+
# @option params [Hash] :q Query for REST
|
67
|
+
# @option params [Hash] :params Extra parameters (E.g. headers)
|
68
|
+
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
69
|
+
def delete(params = {})
|
70
|
+
perform_exchange_with(:delete, params)
|
71
|
+
end
|
72
|
+
|
73
|
+
private
|
74
|
+
|
75
|
+
# Make REST Exchange within this Handler context
|
76
|
+
# @param [Symbol] rest_method HTTP rest method to use
|
77
|
+
# @param [Hash, String] params Exchange parameters.
|
78
|
+
# @return [Exchange] Instance of Exchange class. Assertions are made by default on the response body
|
79
|
+
def perform_exchange_with(rest_method, params = {})
|
80
|
+
params = determine_params_for(rest_method, params)
|
81
|
+
params[:name] ||= rest_method.to_s
|
82
|
+
exchange_params = { name: params[:name] }
|
83
|
+
if params[:template_name]
|
84
|
+
exchange_params[:template_name] = params[:template_name]
|
85
|
+
params.delete :template_name
|
86
|
+
end
|
87
|
+
new(exchange_params)
|
88
|
+
exchange = Exchange.new(params[:name], method: rest_method, **params)
|
89
|
+
yield exchange if block_given?
|
90
|
+
exchange
|
91
|
+
end
|
92
|
+
|
93
|
+
# @param [Symbol] method HTTP rest method to use
|
94
|
+
# @param [Hash, String] params Exchange parameters.
|
95
|
+
# @return [Hash] Exchange Parameters after setting shorthand parameters
|
96
|
+
def determine_params_for(method, params)
|
97
|
+
return params if params.is_a? Hash
|
98
|
+
|
99
|
+
case method
|
100
|
+
when :get, :delete
|
101
|
+
{ suburl: params.to_s }
|
102
|
+
when :post, :put, :patch
|
103
|
+
{ payload: params.to_s }
|
104
|
+
else
|
105
|
+
raise "'#{params}' needs to be a 'Hash' but is a #{params.class}"
|
106
|
+
end
|
107
|
+
end
|
108
|
+
end
|
109
|
+
end
|