Class: Neo4j::Server::CypherResponse
- Inherits:
-
Object
- Object
- Neo4j::Server::CypherResponse
show all
- Defined in:
- lib/neo4j-server/cypher_response.rb
Defined Under Namespace
Classes: ConstraintViolationError, HashEnumeration, ResponseError
Constant Summary
collapse
- EMPTY_STRING =
''
- RETRYABLE_ERROR_STATUSES =
%w(DeadlockDetectedException AcquireLockTimeoutException ExternalResourceFailureException UnknownFailureException)
- CONSTRAINT_ERROR =
'Neo.ClientError.Schema.ConstraintViolation'
Instance Attribute Summary collapse
Class Method Summary
collapse
Instance Method Summary
collapse
Constructor Details
#initialize(response, uncommited = false) ⇒ CypherResponse
Returns a new instance of CypherResponse.
125
126
127
128
|
# File 'lib/neo4j-server/cypher_response.rb', line 125
def initialize(response, uncommited = false)
@response = response
@uncommited = uncommited
end
|
Instance Attribute Details
#columns ⇒ Object
Returns the value of attribute columns.
4
5
6
|
# File 'lib/neo4j-server/cypher_response.rb', line 4
def columns
@columns
end
|
#data ⇒ Object
Returns the value of attribute data.
4
5
6
|
# File 'lib/neo4j-server/cypher_response.rb', line 4
def data
@data
end
|
#error_code ⇒ Object
Returns the value of attribute error_code.
4
5
6
|
# File 'lib/neo4j-server/cypher_response.rb', line 4
def error_code
@error_code
end
|
#error_msg ⇒ Object
Returns the value of attribute error_msg.
4
5
6
|
# File 'lib/neo4j-server/cypher_response.rb', line 4
def error_msg
@error_msg
end
|
#error_status ⇒ Object
Returns the value of attribute error_status.
4
5
6
|
# File 'lib/neo4j-server/cypher_response.rb', line 4
def error_status
@error_status
end
|
#response ⇒ Object
Returns the value of attribute response.
4
5
6
|
# File 'lib/neo4j-server/cypher_response.rb', line 4
def response
@response
end
|
#struct ⇒ Object
Returns the value of attribute struct.
123
124
125
|
# File 'lib/neo4j-server/cypher_response.rb', line 123
def struct
@struct
end
|
Class Method Details
.create_with_no_tx(response) ⇒ Object
222
223
224
225
226
227
228
229
230
231
|
# File 'lib/neo4j-server/cypher_response.rb', line 222
def self.create_with_no_tx(response)
case response.status
when 200
new(response).set_data(response.body)
when 400
new(response).set_error(response.body)
else
fail "Unknown response code #{response.status} for #{response.env[:url]}"
end
end
|
.create_with_tx(response) ⇒ Object
233
234
235
236
237
238
239
240
|
# File 'lib/neo4j-server/cypher_response.rb', line 233
def self.create_with_tx(response)
fail "Unknown response code #{response.status} for #{response.request_uri}" unless response.status == 200
new(response, true).tap do |cr|
body = response.body
body[:errors].empty? ? cr.set_data(body[:results].first) : cr.set_error(body[:errors].first)
end
end
|
.id_from_url(url) ⇒ Object
257
258
259
|
# File 'lib/neo4j-server/cypher_response.rb', line 257
def id_from_url(url)
url.split('/')[-1].to_i
end
|
Instance Method Details
#add_entity_id(data) ⇒ Object
150
151
152
153
154
155
156
157
|
# File 'lib/neo4j-server/cypher_response.rb', line 150
def add_entity_id(data)
data[:id] = if data[:metadata] && data[:metadata][:id]
data[:metadata][:id]
else
self.class.id_from_url(data[:self])
end
data
end
|
#add_transaction_entity_id ⇒ Object
159
160
161
162
|
# File 'lib/neo4j-server/cypher_response.rb', line 159
def add_transaction_entity_id
mapped_rest_data[:id] = mapped_rest_data[:self].split('/').last.to_i
mapped_rest_data
end
|
#constraint_error? ⇒ Boolean
212
213
214
|
# File 'lib/neo4j-server/cypher_response.rb', line 212
def constraint_error?
@error_code == CONSTRAINT_ERROR || @error_msg.include?('already exists with')
end
|
#data? ⇒ Boolean
174
175
176
|
# File 'lib/neo4j-server/cypher_response.rb', line 174
def data?
!response.body[:data].nil?
end
|
#each_data_row ⇒ Object
182
183
184
185
186
187
188
|
# File 'lib/neo4j-server/cypher_response.rb', line 182
def each_data_row
if @uncommited
data.each { |r| yield r[:row] }
else
data.each { |r| yield r }
end
end
|
#entity_data(id = nil) ⇒ Object
130
131
132
133
134
135
136
137
138
|
# File 'lib/neo4j-server/cypher_response.rb', line 130
def entity_data(id = nil)
if @uncommited
data = @data.first[:row].first
data.is_a?(Hash) ? {data: data, id: id} : data
else
data = @data[0][0]
data.is_a?(Hash) ? add_entity_id(data) : data
end
end
|
#error? ⇒ Boolean
164
165
166
|
# File 'lib/neo4j-server/cypher_response.rb', line 164
def error?
!!@error
end
|
#first_data ⇒ Object
140
141
142
143
144
145
146
147
148
|
# File 'lib/neo4j-server/cypher_response.rb', line 140
def first_data
if @uncommited
@data.first[:row].first
else
data = @data[0][0]
data.is_a?(Hash) ? add_entity_id(data) : data
end
end
|
#hash_value_as_object(value, session) ⇒ Object
88
89
90
91
92
93
94
95
96
97
98
99
100
101
|
# File 'lib/neo4j-server/cypher_response.rb', line 88
def hash_value_as_object(value, session)
data = case
when transaction_response?
add_transaction_entity_id
mapped_rest_data
when value[:labels] || value[:type]
add_entity_id(value)
value
else
return value
end
basic_obj = (node?(value) ? CypherNode : CypherRelationship).new(session, data)
unwrapped? ? basic_obj : basic_obj.wrapper
end
|
#looks_like_an_object?(value) ⇒ Boolean
103
104
105
106
107
108
109
|
# File 'lib/neo4j-server/cypher_response.rb', line 103
def looks_like_an_object?(value)
if transaction_response?
mapped_rest_data[:outgoing_relationships] || (mapped_rest_data[:start] && mapped_rest_data[:properties])
else
value[:labels] || value[:type]
end
end
|
#map_row_value(value, session) ⇒ Object
78
79
80
81
82
83
84
85
86
|
# File 'lib/neo4j-server/cypher_response.rb', line 78
def map_row_value(value, session)
if value.is_a?(Hash) && looks_like_an_object?(value)
hash_value_as_object(value, session)
elsif value.is_a?(Array)
value.map! { |v| map_row_value(v, session) }
else
value
end
end
|
#node?(value) ⇒ Boolean
119
120
121
|
# File 'lib/neo4j-server/cypher_response.rb', line 119
def node?(value)
transaction_response? ? !mapped_rest_data[:start] : value[:labels]
end
|
#raise_cypher_error ⇒ Object
216
217
218
219
|
# File 'lib/neo4j-server/cypher_response.rb', line 216
def raise_cypher_error
fail 'Tried to raise error without an error' unless @error
fail Neo4j::Session::CypherError.new(@error_msg, @error_code, @error_status)
end
|
#raise_error ⇒ Object
206
207
208
209
210
|
# File 'lib/neo4j-server/cypher_response.rb', line 206
def raise_error
fail 'Tried to raise error without an error' unless @error
error_class = constraint_error? ? ConstraintViolationError : ResponseError
fail error_class.new(@error_msg, @error_status, @error_code)
end
|
#raise_unless_response_code(code) ⇒ Object
178
179
180
|
# File 'lib/neo4j-server/cypher_response.rb', line 178
def raise_unless_response_code(code)
fail "Response code #{response.status}, expected #{code} for #{response.[:location]}, #{response.body}" unless response.status == code
end
|
#rest_data ⇒ Object
246
247
248
249
|
# File 'lib/neo4j-server/cypher_response.rb', line 246
def rest_data
@result_index = @row_index = 0
mapped_rest_data
end
|
#rest_data_with_id ⇒ Object
251
252
253
254
|
# File 'lib/neo4j-server/cypher_response.rb', line 251
def rest_data_with_id
rest_data[:id] = mapped_rest_data[:self].split('/').last.to_i
rest_data
end
|
#retryable_error? ⇒ Boolean
169
170
171
172
|
# File 'lib/neo4j-server/cypher_response.rb', line 169
def retryable_error?
return unless error?
RETRYABLE_ERROR_STATUSES.include?(@error_status)
end
|
#row_pair_in_struct(row, session) ⇒ Object
69
70
71
72
73
74
75
76
|
# File 'lib/neo4j-server/cypher_response.rb', line 69
def row_pair_in_struct(row, session)
@struct.new.tap do |result|
row.each_pair do |column, value|
result[column] = map_row_value(value, session)
@row_index += 1
end
end
end
|
#set_data(response) ⇒ Object
190
191
192
193
194
195
|
# File 'lib/neo4j-server/cypher_response.rb', line 190
def set_data(response)
@data = response[:data]
@columns = response[:columns]
@struct = @columns.empty? ? Object.new : Struct.new(*@columns.map(&:to_sym))
self
end
|
#set_error(error) ⇒ Object
197
198
199
200
201
202
203
|
# File 'lib/neo4j-server/cypher_response.rb', line 197
def set_error(error)
@error = true
@error_msg = error[:message]
@error_status = error[:status] || error[:exception] || error[:code]
@error_code = error[:code] || error[:fullname]
self
end
|
#to_node_enumeration(cypher = EMPTY_STRING, session = Neo4j::Session.current) ⇒ Object
58
59
60
61
62
63
64
65
66
67
|
# File 'lib/neo4j-server/cypher_response.rb', line 58
def to_node_enumeration(cypher = EMPTY_STRING, session = Neo4j::Session.current)
Enumerator.new do |yielder|
@result_index = 0
to_struct_enumeration(cypher).each do |row|
@row_index = 0
yielder << row_pair_in_struct(row, session)
@result_index += 1
end
end
end
|
#to_struct_enumeration(cypher = EMPTY_STRING) ⇒ Object
#transaction_response? ⇒ Boolean
242
243
244
|
# File 'lib/neo4j-server/cypher_response.rb', line 242
def transaction_response?
response.respond_to?(:body) && !response.body[:commit].nil?
end
|
#unwrapped! ⇒ Object
111
112
113
|
# File 'lib/neo4j-server/cypher_response.rb', line 111
def unwrapped!
@_unwrapped_obj = true
end
|
#unwrapped? ⇒ Boolean
115
116
117
|
# File 'lib/neo4j-server/cypher_response.rb', line 115
def unwrapped?
!!@_unwrapped_obj
end
|