jsapi 2.1.2 → 3.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (141) hide show
  1. checksums.yaml +4 -4
  2. data/lib/jsapi/client/base.rb +182 -0
  3. data/lib/jsapi/client/exceptions.rb +45 -0
  4. data/lib/jsapi/client/request.rb +204 -0
  5. data/lib/jsapi/client/response.rb +120 -0
  6. data/lib/jsapi/client/session/base.rb +61 -0
  7. data/lib/jsapi/client/session/logger.rb +52 -0
  8. data/lib/jsapi/client/session/single_request.rb +16 -0
  9. data/lib/jsapi/client/session/test/class_methods.rb +49 -0
  10. data/lib/jsapi/client/session/test/response.rb +56 -0
  11. data/lib/jsapi/client/session/test/spy.rb +43 -0
  12. data/lib/jsapi/client/session/test.rb +17 -0
  13. data/lib/jsapi/client/session.rb +6 -0
  14. data/lib/jsapi/client.rb +7 -0
  15. data/lib/jsapi/configuration.rb +2 -2
  16. data/lib/jsapi/controller/authentication/credentials/http/bearer.rb +5 -12
  17. data/lib/jsapi/controller/authentication/credentials.rb +4 -4
  18. data/lib/jsapi/controller/authentication.rb +3 -3
  19. data/lib/jsapi/controller/methods.rb +94 -126
  20. data/lib/jsapi/controller/parameters.rb +6 -6
  21. data/lib/jsapi/controller/response.rb +11 -10
  22. data/lib/jsapi/{meta/definitions.rb → definition/api.rb} +62 -40
  23. data/lib/jsapi/{meta → definition}/callable/symbol_evaluator.rb +1 -1
  24. data/lib/jsapi/{meta → definition}/callable/symbol_sequence_evaluator.rb +1 -1
  25. data/lib/jsapi/{meta → definition}/callable.rb +1 -1
  26. data/lib/jsapi/{meta → definition}/callback/base.rb +5 -5
  27. data/lib/jsapi/{meta → definition}/callback/reference.rb +1 -1
  28. data/lib/jsapi/{meta → definition}/callback.rb +1 -1
  29. data/lib/jsapi/{meta → definition}/contact.rb +1 -1
  30. data/lib/jsapi/{meta → definition}/content.rb +12 -13
  31. data/lib/jsapi/{meta → definition}/defaults.rb +1 -1
  32. data/lib/jsapi/{meta → definition}/example/base.rb +1 -1
  33. data/lib/jsapi/{meta → definition}/example/builder.rb +4 -4
  34. data/lib/jsapi/{meta → definition}/example/reference.rb +1 -1
  35. data/lib/jsapi/{meta → definition}/example.rb +1 -1
  36. data/lib/jsapi/{meta → definition}/existence.rb +1 -1
  37. data/lib/jsapi/{meta → definition}/external_documentation.rb +1 -1
  38. data/lib/jsapi/{meta → definition}/header/base.rb +1 -1
  39. data/lib/jsapi/{meta → definition}/header/reference.rb +1 -1
  40. data/lib/jsapi/{meta → definition}/header.rb +1 -1
  41. data/lib/jsapi/{meta → definition}/info.rb +1 -1
  42. data/lib/jsapi/{meta → definition}/license.rb +1 -1
  43. data/lib/jsapi/{meta → definition}/link/base.rb +1 -1
  44. data/lib/jsapi/{meta → definition}/link/reference.rb +1 -1
  45. data/lib/jsapi/{meta → definition}/link.rb +1 -1
  46. data/lib/jsapi/{meta → definition}/model/attributes/class_methods.rb +1 -1
  47. data/lib/jsapi/{meta → definition}/model/attributes/frozen_error.rb +1 -1
  48. data/lib/jsapi/{meta → definition}/model/attributes/type_caster.rb +2 -2
  49. data/lib/jsapi/{meta → definition}/model/attributes.rb +1 -1
  50. data/lib/jsapi/{meta → definition}/model/base.rb +1 -1
  51. data/lib/jsapi/{meta → definition}/model/reference.rb +11 -11
  52. data/lib/jsapi/{meta → definition}/model/wrappable.rb +3 -3
  53. data/lib/jsapi/{meta → definition}/model/wrapper.rb +5 -5
  54. data/lib/jsapi/{meta → definition}/oauth_flow.rb +1 -1
  55. data/lib/jsapi/{meta → definition}/openapi/extensions.rb +1 -1
  56. data/lib/jsapi/{meta → definition}/openapi/path_item.rb +5 -5
  57. data/lib/jsapi/{meta → definition}/openapi/version.rb +2 -2
  58. data/lib/jsapi/{meta → definition}/openapi.rb +1 -1
  59. data/lib/jsapi/{meta → definition}/operation.rb +108 -62
  60. data/lib/jsapi/{meta → definition}/parameter/base.rb +11 -11
  61. data/lib/jsapi/{meta → definition}/parameter/reference.rb +5 -5
  62. data/lib/jsapi/{meta → definition}/parameter/wrapper.rb +2 -2
  63. data/lib/jsapi/{meta → definition}/parameter.rb +1 -1
  64. data/lib/jsapi/{meta → definition}/path.rb +1 -1
  65. data/lib/jsapi/{meta → definition}/pathname.rb +1 -1
  66. data/lib/jsapi/{meta → definition}/property.rb +2 -2
  67. data/lib/jsapi/{meta → definition}/reference_error.rb +1 -1
  68. data/lib/jsapi/{meta → definition}/request_body/base.rb +1 -1
  69. data/lib/jsapi/{meta → definition}/request_body/reference.rb +1 -1
  70. data/lib/jsapi/{meta → definition}/request_body/wrapper.rb +2 -2
  71. data/lib/jsapi/{meta → definition}/request_body.rb +1 -1
  72. data/lib/jsapi/{meta → definition}/rescue_handler.rb +1 -1
  73. data/lib/jsapi/{meta → definition}/response/base.rb +4 -4
  74. data/lib/jsapi/{meta → definition}/response/reference.rb +1 -1
  75. data/lib/jsapi/{meta → definition}/response/wrapper.rb +17 -5
  76. data/lib/jsapi/{meta → definition}/response.rb +1 -1
  77. data/lib/jsapi/{meta → definition}/schema/additional_properties.rb +2 -2
  78. data/lib/jsapi/{meta → definition}/schema/array.rb +2 -2
  79. data/lib/jsapi/{meta → definition}/schema/base.rb +1 -1
  80. data/lib/jsapi/{meta → definition}/schema/boolean.rb +1 -1
  81. data/lib/jsapi/{meta → definition}/schema/boundary.rb +1 -1
  82. data/lib/jsapi/{meta → definition}/schema/conversion.rb +1 -1
  83. data/lib/jsapi/{meta → definition}/schema/discriminator.rb +1 -1
  84. data/lib/jsapi/{meta → definition}/schema/integer.rb +1 -1
  85. data/lib/jsapi/{meta → definition}/schema/number.rb +1 -1
  86. data/lib/jsapi/{meta → definition}/schema/numeric.rb +1 -1
  87. data/lib/jsapi/{meta → definition}/schema/object.rb +13 -13
  88. data/lib/jsapi/{meta → definition}/schema/reference.rb +1 -1
  89. data/lib/jsapi/{meta → definition}/schema/string.rb +1 -1
  90. data/lib/jsapi/{meta → definition}/schema/validation/base.rb +1 -1
  91. data/lib/jsapi/{meta → definition}/schema/validation/enum.rb +1 -1
  92. data/lib/jsapi/{meta → definition}/schema/validation/max_items.rb +1 -1
  93. data/lib/jsapi/{meta → definition}/schema/validation/max_length.rb +1 -1
  94. data/lib/jsapi/{meta → definition}/schema/validation/maximum.rb +1 -1
  95. data/lib/jsapi/{meta → definition}/schema/validation/min_items.rb +1 -1
  96. data/lib/jsapi/{meta → definition}/schema/validation/min_length.rb +1 -1
  97. data/lib/jsapi/{meta → definition}/schema/validation/minimum.rb +1 -1
  98. data/lib/jsapi/{meta → definition}/schema/validation/multiple_of.rb +1 -1
  99. data/lib/jsapi/{meta → definition}/schema/validation/pattern.rb +1 -1
  100. data/lib/jsapi/{meta → definition}/schema/wrapper.rb +18 -4
  101. data/lib/jsapi/{meta → definition}/schema.rb +5 -5
  102. data/lib/jsapi/{meta → definition}/security_requirement.rb +1 -1
  103. data/lib/jsapi/{meta → definition}/security_scheme/api_key.rb +1 -1
  104. data/lib/jsapi/{meta → definition}/security_scheme/base.rb +1 -1
  105. data/lib/jsapi/{meta → definition}/security_scheme/http/basic.rb +1 -1
  106. data/lib/jsapi/{meta → definition}/security_scheme/http/bearer.rb +1 -1
  107. data/lib/jsapi/{meta → definition}/security_scheme/http/other.rb +1 -1
  108. data/lib/jsapi/{meta → definition}/security_scheme/http.rb +1 -1
  109. data/lib/jsapi/{meta → definition}/security_scheme/mutual_tls.rb +1 -1
  110. data/lib/jsapi/{meta → definition}/security_scheme/oauth2.rb +1 -1
  111. data/lib/jsapi/{meta → definition}/security_scheme/open_id_connect.rb +1 -1
  112. data/lib/jsapi/{meta → definition}/security_scheme.rb +1 -1
  113. data/lib/jsapi/{meta → definition}/server.rb +24 -1
  114. data/lib/jsapi/{meta → definition}/server_variable.rb +1 -1
  115. data/lib/jsapi/{meta → definition}/tag.rb +1 -1
  116. data/lib/jsapi/definition.rb +33 -0
  117. data/lib/jsapi/dsl/{definitions.rb → api.rb} +48 -48
  118. data/lib/jsapi/dsl/base.rb +7 -7
  119. data/lib/jsapi/dsl/class_methods.rb +34 -32
  120. data/lib/jsapi/dsl/examples.rb +1 -1
  121. data/lib/jsapi/dsl/operation.rb +9 -7
  122. data/lib/jsapi/dsl/parameter.rb +1 -1
  123. data/lib/jsapi/dsl/path.rb +8 -6
  124. data/lib/jsapi/dsl/response.rb +5 -5
  125. data/lib/jsapi/dsl/schema.rb +17 -17
  126. data/lib/jsapi/dsl/shared_operation_methods.rb +11 -26
  127. data/lib/jsapi/dsl.rb +2 -2
  128. data/lib/jsapi/media/range.rb +1 -1
  129. data/lib/jsapi/media/type.rb +8 -9
  130. data/lib/jsapi/model/errors.rb +3 -3
  131. data/lib/jsapi/status/code.rb +20 -0
  132. data/lib/jsapi/support/messages.rb +27 -0
  133. data/lib/jsapi/support.rb +3 -0
  134. data/lib/jsapi/version.rb +1 -1
  135. data/lib/jsapi.rb +3 -3
  136. metadata +115 -102
  137. data/lib/jsapi/jsonify_error.rb +0 -17
  138. data/lib/jsapi/messages.rb +0 -19
  139. data/lib/jsapi/meta.rb +0 -38
  140. /data/lib/jsapi/{meta → definition}/model.rb +0 -0
  141. /data/lib/jsapi/{meta → definition}/schema/validation.rb +0 -0
@@ -0,0 +1,49 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Jsapi
4
+ module Client
5
+ module Session
6
+ module Test
7
+ module ClassMethods
8
+ # Stubs all sessions created in the passed block.
9
+ #
10
+ # Spying a single request session:
11
+ #
12
+ # Jsapi::Client::Session::SingleRequest.spy(200, '{}') do |spy|
13
+ # # Call operation
14
+ # assert_equal('...', spy.request.body)
15
+ # end
16
+ #
17
+ # Spying a session with multiple requests:
18
+ #
19
+ # Jsapi::Client::Session::Base.spy do |spy|
20
+ # spy.response_with(200, '{}')
21
+ # # Call operation
22
+ # assert_equal('...', spy.request.body)
23
+ #
24
+ # spy.response_with(400, '{}')
25
+ # # Call operation
26
+ # assert_equal('...', spy.request.body)
27
+ # end
28
+ def spy(...)
29
+ return unless block_given?
30
+
31
+ spy = Test::Spy.new(...)
32
+
33
+ klass = singleton_class
34
+ klass.alias_method(:__new__, :new)
35
+ klass.define_method(:new) { |*| spy }
36
+
37
+ begin
38
+ yield spy
39
+ ensure
40
+ klass.undef_method(:new)
41
+ klass.alias_method(:new, :__new__)
42
+ klass.undef_method(:__new__)
43
+ end
44
+ end
45
+ end
46
+ end
47
+ end
48
+ end
49
+ end
@@ -0,0 +1,56 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Jsapi
4
+ module Client
5
+ module Session
6
+ module Test
7
+ # Dummy HTTP response.
8
+ class Response
9
+ ##
10
+ # :attr_reader: body
11
+ # Mimics +body+ of Net::HTTPRespone.
12
+
13
+ ##
14
+ # :attr_reader: code
15
+ # Mimics +code+ of Net::HTTPRespone.
16
+
17
+ ##
18
+ # :attr_reader: headers
19
+ # The headers of the HTTP response as a hash.
20
+
21
+ ##
22
+ # :attr_reader: http_version
23
+ # The HTTP version, always <code>"1.1"</code>
24
+
25
+ attr_reader :body, :code, :headers, :http_version
26
+
27
+ # Creates a dummy HTTP response. The default status code is <code>"200"</code>.
28
+ def initialize(status_code = nil, body = nil, **headers)
29
+ @http_version = '1.1'
30
+ @code = Status::Code.from(status_code || :ok).to_s
31
+ @body = body&.to_s
32
+
33
+ @headers = headers.to_h do |key, value|
34
+ [key.to_s.dasherize, value.to_s]
35
+ end.freeze
36
+ end
37
+
38
+ # Mimics +content_type+ of Net::HTTPRespone.
39
+ def content_type
40
+ @headers['content-type']
41
+ end
42
+
43
+ # Mimics +each_header+ of Net::HTTPRespone.
44
+ def each_header(&block)
45
+ @headers.each(&block)
46
+ end
47
+
48
+ def inspect # :nodoc:
49
+ "#<#{self.class.name} code: #{code}, " \
50
+ "body: #{body.inspect}, headers: #{headers.inspect}>"
51
+ end
52
+ end
53
+ end
54
+ end
55
+ end
56
+ end
@@ -0,0 +1,43 @@
1
+ # frozen_string_literal: true
2
+
3
+ module Jsapi
4
+ module Client
5
+ module Session
6
+ module Test
7
+ # Spies an HTTP session.
8
+ class Spy
9
+ ##
10
+ # :attr_reader: request
11
+ # The last captured request.
12
+ attr_reader :request
13
+
14
+ def initialize(...)
15
+ @response = Response.new(...)
16
+ @finished = false
17
+ end
18
+
19
+ # Mimics +finish+ of Session::Base.
20
+ def finish
21
+ @finished = true
22
+ end
23
+
24
+ # Returns true if +finish+ has been called before.
25
+ def finished?
26
+ @finished == true
27
+ end
28
+
29
+ # Sets the response for subsequent calls.
30
+ def response_with(...)
31
+ @response = Response.new(...)
32
+ end
33
+
34
+ # Mimics +send_request+ of Session::Base.
35
+ def send_request(request)
36
+ @request = request
37
+ @response
38
+ end
39
+ end
40
+ end
41
+ end
42
+ end
43
+ end
@@ -0,0 +1,17 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'test/response'
4
+ require_relative 'test/spy'
5
+ require_relative 'test/class_methods'
6
+
7
+ module Jsapi
8
+ module Client
9
+ module Session
10
+ module Test
11
+ def self.included(base) # :nodoc:
12
+ base.extend(ClassMethods)
13
+ end
14
+ end
15
+ end
16
+ end
17
+ end
@@ -0,0 +1,6 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'session/test'
4
+ require_relative 'session/logger'
5
+ require_relative 'session/base'
6
+ require_relative 'session/single_request'
@@ -0,0 +1,7 @@
1
+ # frozen_string_literal: true
2
+
3
+ require_relative 'client/exceptions'
4
+ require_relative 'client/session'
5
+ require_relative 'client/request'
6
+ require_relative 'client/response'
7
+ require_relative 'client/base'
@@ -4,11 +4,11 @@ module Jsapi
4
4
  # Holds the \Jsapi configuration.
5
5
  class Configuration
6
6
  # The path where the API definitions are located relative to +Rails.root+.
7
- # The default is <code>"jsapi/api_defs"</code>.
7
+ # The default is <code>"jsapi"</code>.
8
8
  attr_accessor :api_defs_path
9
9
 
10
10
  def initialize # :nodoc:
11
- @api_defs_path = 'jsapi/api_defs'
11
+ @api_defs_path = 'jsapi'
12
12
  end
13
13
 
14
14
  # Returns the absolute +Pathname+ for +args+ within +api_defs_path+.
@@ -9,19 +9,12 @@ module Jsapi
9
9
  module HTTP
10
10
  # Holds a token passed according to \HTTP \Bearer \Authentication.
11
11
  class Bearer < Base
12
- # The decoded token.
13
- attr_reader :token
12
+ ##
13
+ # :attr_reader: token
14
+ # The token.
14
15
 
15
- def initialize(authorization)
16
- super
17
- @token =
18
- Base64.decode64(auth_param) \
19
- if auth_scheme == 'Bearer' && auth_param.present?
20
- end
21
-
22
- def well_formed? # :nodoc:
23
- !token.nil?
24
- end
16
+ # -
17
+ alias token auth_param
25
18
  end
26
19
  end
27
20
  end
@@ -13,7 +13,7 @@ module Jsapi
13
13
  # security scheme.
14
14
  def create(request, security_scheme)
15
15
  case security_scheme
16
- when Meta::SecurityScheme::APIKey
16
+ when Definition::SecurityScheme::APIKey
17
17
  name = security_scheme.name
18
18
  APIKey.new(
19
19
  case security_scheme.in
@@ -23,11 +23,11 @@ module Jsapi
23
23
  request.query_parameters[name]
24
24
  end
25
25
  )
26
- when Meta::SecurityScheme::HTTP::Basic
26
+ when Definition::SecurityScheme::HTTP::Basic
27
27
  HTTP::Basic.new(request.authorization)
28
- when Meta::SecurityScheme::HTTP::Bearer
28
+ when Definition::SecurityScheme::HTTP::Bearer
29
29
  HTTP::Bearer.new(request.authorization)
30
- when Meta::SecurityScheme::HTTP::Other
30
+ when Definition::SecurityScheme::HTTP::Other
31
31
  HTTP::Base.new(request.authorization)
32
32
  end
33
33
  end
@@ -31,9 +31,9 @@ module Jsapi
31
31
  # security schemes are satisfied.
32
32
  #
33
33
  # +operation_name+ can be omitted if the controller handles one operation only.
34
- # If the operation isn't defined, an OperationNotDefined exception is raised.
34
+ # If the operation does not exist, an OperationNotFound exception is raised.
35
35
  def api_authenticated?(operation_name = nil)
36
- _api_authenticated?(_api_operation(operation_name))
36
+ _api_authenticated?(api.find_operation!(operation_name))
37
37
  end
38
38
 
39
39
  private
@@ -49,7 +49,7 @@ module Jsapi
49
49
  next false unless authentication_handler
50
50
 
51
51
  # Find the appropriate security scheme
52
- security_scheme = api_definitions.find_security_scheme(scheme_name)
52
+ security_scheme = api.find_security_scheme(scheme_name)
53
53
  next false unless security_scheme
54
54
 
55
55
  # Create the credentials to be passed to the authenticator
@@ -4,26 +4,6 @@ require_relative 'methods/callbacks'
4
4
 
5
5
  module Jsapi
6
6
  module Controller
7
- # Raised when no operation with the specified name could be found.
8
- class OperationNotFound < StandardError
9
- def initialize(operation_name)
10
- super("operation not found: #{operation_name}")
11
- end
12
- end
13
-
14
- # Raised when no suitable response could be found.
15
- class ResponseNotFound < StandardError
16
- def initialize(operation, status)
17
- super(
18
- if operation.responses.none?
19
- "#{operation.name.inspect} has no responses"
20
- else
21
- "#{operation.name.inspect} has no response for status #{status}"
22
- end
23
- )
24
- end
25
- end
26
-
27
7
  # Raised when the current request could not be authenticated.
28
8
  class Unauthorized < StandardError
29
9
  def initialize # :nodoc:
@@ -49,7 +29,9 @@ module Jsapi
49
29
 
50
30
  # Overrides <code>Exception#message</code> to lazily generate the error message.
51
31
  def message
52
- "#{@params.errors.full_messages.map { |m| m.delete_suffix('.') }.join('. ')}."
32
+ @params.errors.full_messages.map do |message|
33
+ message.end_with?('.') ? message : "#{message}."
34
+ end.join(' ')
53
35
  end
54
36
  end
55
37
 
@@ -58,15 +40,17 @@ module Jsapi
58
40
  base.include(Callbacks)
59
41
  end
60
42
 
61
- # Returns the Meta::Definitions instance associated with the controller class. In
43
+ # Returns the Definition::API instance associated with the controller class. In
62
44
  # particular, this method can be used to create an OpenAPI document, for example:
63
45
  #
64
- # render(json: api_definitions.openapi_document)
46
+ # render(json: api.openapi_document)
65
47
  #
66
- def api_definitions
67
- self.class.api_definitions
48
+ def api
49
+ self.class.api
68
50
  end
69
51
 
52
+ alias api_definitions api
53
+
70
54
  ##
71
55
  # :method: api_operation
72
56
  # :args: operation_name = nil, omit: nil, status: nil, strong: false, &block
@@ -92,11 +76,10 @@ module Jsapi
92
76
  # end
93
77
  #
94
78
  # +operation_name+ can be omitted if the controller handles one operation only.
95
- #
96
- # If no operation could be found for +operation_name+, an OperationNotFound exception
97
- # is raised.
79
+ # If the operation does not exist, an OperationNotFound error is raised.
98
80
  #
99
81
  # +:status+ specifies the HTTP status code of the response to be produced.
82
+ # If no suitable response exists, a ResponseNotFound error is raised.
100
83
  #
101
84
  # If +:strong+ is +true+, parameters that can be mapped are accepted only. That means
102
85
  # that the model passed to the block is invalid if there are any request parameters
@@ -108,7 +91,7 @@ module Jsapi
108
91
  # - +:empty+ - All of the properties whose value is empty are omitted.
109
92
  # - +:nil+ - All of the properties whose value is +nil+ are omitted.
110
93
  #
111
- # Raises an Unauthorized exception if the Authentication module is included and the
94
+ # Raises an Unauthorized error if the Authentication module is included and the
112
95
  # current request could not be authenticated.
113
96
  #
114
97
  # See Callbacks::ClassMethods for possible callbacks.
@@ -117,8 +100,8 @@ module Jsapi
117
100
  # :method: api_operation!
118
101
  # :args: operation_name = nil, omit: nil, status: nil, strong: false, &block
119
102
  #
120
- # Like +api_operation+, except that a ParametersInvalid exception is raised
121
- # when request parameters are invalid.
103
+ # Like +api_operation+, except it raises a ParametersInvalid error when the request
104
+ # parameters are invalid.
122
105
  #
123
106
  # api_operation!('foo') do |api_params|
124
107
  # # ...
@@ -127,94 +110,97 @@ module Jsapi
127
110
  [true, false].each do |bang|
128
111
  define_method(bang ? :api_operation! : :api_operation) \
129
112
  do |operation_name = nil, omit: nil, status: nil, strong: false, &block|
130
- raise ArgumentError, Messages.invalid_value(
113
+ raise ArgumentError, Support::Messages.invalid_value(
131
114
  name: 'omit',
132
115
  value: omit,
133
116
  valid_values: %i[empty nil]
134
117
  ) if [nil, :empty, :nil].exclude?(omit)
135
118
 
136
- operation = _api_operation(operation_name)
137
- response_model = nil
119
+ operation = api.find_operation!(operation_name)
120
+ result = nil
121
+ response_definition = nil
138
122
 
139
- result = begin
140
- # Authenticate request first if Authentication is included
141
- if respond_to?(:_api_authenticated?, true)
142
- raise Unauthorized unless _api_authenticated?(operation)
123
+ bypassed = catch :bypass do
124
+ if result.nil?
125
+ # Authenticate request first if Authentication is included
126
+ if respond_to?(:_api_authenticated?, true)
127
+ raise Unauthorized unless _api_authenticated?(operation)
143
128
 
144
- _api_callback(:after_authentication, operation_name)
145
- end
129
+ _api_callback(:after_authentication, operation_name)
130
+ end
146
131
 
147
- status = Status::Code.from(status)
148
- response_model = _api_response_model(operation, status)
132
+ status = Status::Code.from(status)
133
+ response_definition = operation.find_response_for!(status)
149
134
 
150
- api_params = _api_params(operation, strong: strong)
135
+ api_params = _api_params(operation, strong: strong)
151
136
 
152
- if bang
153
- raise ParametersInvalid.new(api_params) if api_params.invalid?
137
+ if bang
138
+ raise ParametersInvalid.new(api_params) if api_params.invalid?
154
139
 
155
- _api_callback(:after_validation, operation_name, api_params)
140
+ _api_callback(:after_validation, operation_name, api_params)
141
+ end
142
+ result = block&.call(api_params)
143
+ break if performed?
156
144
  end
157
145
 
158
- block&.call(api_params)
146
+ # Produce response
147
+ media_type, content_definition =
148
+ response_definition
149
+ .media_type_and_content_for(*_api_accept)
150
+
151
+ status_code = status&.to_i
152
+ head(status_code) && break unless content_definition
153
+
154
+ content_type = media_type.to_s
155
+ result = _api_before_rendering(operation_name, result, api_params)
156
+
157
+ if (json_media_type = media_type.json?) || media_type.sequential_json?
158
+ api_response = Response.new(
159
+ result,
160
+ content_definition,
161
+ omit: omit,
162
+ locale: response_definition.locale
163
+ )
164
+ if json_media_type
165
+ render(json: api_response, status: status_code, content_type: content_type)
166
+ else
167
+ self.content_type = content_type
168
+ response.status = status_code
169
+ begin
170
+ response.stream.tap do |stream|
171
+ api_response.write_seq_json_to(stream, media_type)
172
+ ensure
173
+ stream.close
174
+ end
175
+ rescue StandardError => e
176
+ throw :bypass, e
177
+ end
178
+ end
179
+ elsif media_type == Media::Type::TEXT_PLAIN
180
+ render(plain: result.to_s, status: status_code, content_type: content_type)
181
+ end
182
+ nil
159
183
  rescue StandardError => e
160
- definitions = api_definitions
184
+ raise e if result.is_a?(Error)
161
185
 
162
- # Lookup a rescue handler
163
- rescue_handler = definitions.rescue_handler_for(e)
186
+ # Get rescue handler for the error
187
+ rescue_handler = api.rescue_handler_for(e)
164
188
  raise e if rescue_handler.nil?
165
189
 
166
- # Replace the status code and response model
190
+ # Set error status code and response definition
167
191
  status = rescue_handler.status_code
168
- response_model = operation.find_response(status)
169
- raise e if response_model.nil?
192
+ response_definition = operation.find_response_for(status)
193
+ raise e if response_definition.nil?
170
194
 
171
195
  # Call on_rescue callbacks
172
- definitions.on_rescue_callbacks.each do |callback|
196
+ api.on_rescue_callbacks.each do |callback|
173
197
  callback.respond_to?(:call) ? callback.call(e) : send(callback, e)
174
198
  end
175
199
 
176
- Error.new(e, status: status)
177
- end
178
- # Return if response body has already been rendered
179
- return if response_body
180
-
181
- # Produce response
182
- media_type, content_model = _api_media_type_and_content_model(response_model)
183
- status = status&.to_i
184
- return head(status) unless content_model
185
-
186
- result = _api_before_rendering(operation_name, result, api_params)
187
-
188
- if media_type == Media::Type::TEXT_PLAIN
189
- render(
190
- plain: result.to_s,
191
- status: status,
192
- content_type: media_type.to_s
193
- )
194
- elsif media_type.json? || media_type.json_seq?
195
- api_response = Response.new(
196
- result,
197
- content_model,
198
- omit: omit,
199
- locale: response_model.locale
200
- )
201
- if media_type.json?
202
- render(
203
- json: api_response,
204
- status: status,
205
- content_type: media_type.to_s
206
- )
207
- else
208
- self.content_type = media_type.to_s
209
- response.status = status
210
-
211
- response.stream.tap do |stream|
212
- api_response.write_json_seq_to(stream)
213
- ensure
214
- stream.close
215
- end
216
- end
200
+ result = Error.new(e, status: status)
201
+ retry
217
202
  end
203
+ raise bypassed if bypassed.is_a?(Exception)
218
204
  end
219
205
  end
220
206
 
@@ -225,8 +211,7 @@ module Jsapi
225
211
  #
226
212
  # +operation_name+ can be omitted if the controller handles one operation only.
227
213
  #
228
- # If no operation could be found for +operation_name+, an OperationNotFound exception
229
- # is raised.
214
+ # If the operation does not exist, an OperationNotFound error is raised.
230
215
  #
231
216
  # If +strong+ is +true+, parameters that can be mapped are accepted only. That means
232
217
  # that the model returned is invalid if there are any request parameters that can't be
@@ -234,20 +219,19 @@ module Jsapi
234
219
  #
235
220
  # Note that each call of +api_params+ returns a newly created instance.
236
221
  def api_params(operation_name = nil, strong: false)
237
- _api_params(_api_operation(operation_name), strong: strong)
222
+ _api_params(api.find_operation!(operation_name), strong: strong)
238
223
  end
239
224
 
240
- # Returns a Response to serialize the JSON representation of +result+ according to the
241
- # appropriate +response+ specification.
225
+ # Returns a Response to serialize the JSON representation of +result+ according to
226
+ # the appropriate +response+ specification.
242
227
  #
243
228
  # render(json: api_response(bar, 'foo', status: 200))
244
229
  #
245
230
  # +operation_name+ can be omitted if the controller handles one operation only.
246
- #
247
- # If no operation could be found for +operation_name+, an OperationNotFound exception
248
- # is raised.
231
+ # If the operation does not exist, an OperationNotFound error is raised.
249
232
  #
250
233
  # +:status+ specifies the HTTP status code of the response to be produced.
234
+ # If no suitable response exists, a ResponseNotFound error is raised.
251
235
  #
252
236
  # The +:omit+ option specifies on which conditions properties are omitted.
253
237
  # Possible values are:
@@ -255,37 +239,28 @@ module Jsapi
255
239
  # - +:empty+ - All of the properties whose value is empty are omitted.
256
240
  # - +:nil+ - All of the properties whose value is +nil+ are omitted.
257
241
  def api_response(result, operation_name = nil, omit: nil, status: nil)
258
- raise ArgumentError, Messages.invalid_value(
242
+ raise ArgumentError, Support::Messages.invalid_value(
259
243
  name: 'omit',
260
244
  value: omit,
261
245
  valid_values: %i[empty nil]
262
246
  ) if [nil, :empty, :nil].exclude?(omit)
263
247
 
264
248
  status = Status::Code.from(status)
265
- operation = _api_operation(operation_name)
266
- response_model = _api_response_model(operation, status)
249
+ operation = api.find_operation!(operation_name)
250
+ response_definition = operation.find_response_for!(status)
267
251
 
268
252
  Response.new(
269
253
  result,
270
- _api_media_type_and_content_model(response_model).second,
254
+ response_definition.content_for(*_api_accept),
271
255
  omit: omit,
272
- locale: response_model.locale
256
+ locale: response_definition.locale
273
257
  )
274
258
  end
275
259
 
276
260
  private
277
261
 
278
- def _api_media_type_and_content_model(response_model)
279
- response_model.media_type_and_content_for(
280
- *(request.headers['Accept']&.split(',').presence || [Media::Range::ALL])
281
- )
282
- end
283
-
284
- def _api_operation(operation_name)
285
- operation = api_definitions.find_operation(operation_name)
286
- return operation if operation
287
-
288
- raise OperationNotFound.new(operation_name)
262
+ def _api_accept
263
+ request.headers['Accept']&.split(',').presence || [Media::Range::ALL]
289
264
  end
290
265
 
291
266
  def _api_params(operation, strong:)
@@ -298,13 +273,6 @@ module Jsapi
298
273
  )
299
274
  )
300
275
  end
301
-
302
- def _api_response_model(operation, status)
303
- response_model = operation.find_response(status)
304
- return response_model if response_model
305
-
306
- raise ResponseNotFound.new(operation, status)
307
- end
308
276
  end
309
277
  end
310
278
  end
@@ -20,11 +20,11 @@ module Jsapi
20
20
  @params_to_be_validated = strong == true ? params.dup : {}
21
21
 
22
22
  # Parameters
23
- @raw_attributes = operation.parameters.transform_values do |parameter_model|
23
+ @raw_attributes = operation.parameters.transform_values do |parameter_definition|
24
24
  JSON.wrap(
25
- case parameter_model.in
25
+ case parameter_definition.in
26
26
  when 'header'
27
- request.headers[parameter_model.name]
27
+ request.headers[parameter_definition.name]
28
28
  when 'querystring'
29
29
  query_params = request.query_parameters
30
30
  keys = query_params.keys
@@ -32,11 +32,11 @@ module Jsapi
32
32
  unassigned_params.except!(*keys)
33
33
  @params_to_be_validated.except!(*keys)
34
34
 
35
- parameter_model.object? ? params.slice(*keys) : query_params.to_query
35
+ parameter_definition.object? ? params.slice(*keys) : query_params.to_query
36
36
  else
37
- unassigned_params.delete(parameter_model.name)
37
+ unassigned_params.delete(parameter_definition.name)
38
38
  end,
39
- parameter_model.schema,
39
+ parameter_definition.schema,
40
40
  context: :request
41
41
  )
42
42
  end