1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module ArrowFlight
class Client
# Authenticates by Basic authentication.
#
# @param user [String] User name to be used.
# @param password [String] Password to be used.
# @param options [ArrowFlight::CallOptions, Hash, nil] (nil)
# The options to be used.
#
# @return [ArrowFlight::CallOptions] The options that can be used
# for following calls. It includes Bearer token for @user.
#
# If @options is an ArrowFlight::CallOptions, the given @options
# is returned with Bearer token.
#
# If @options isn't an ArrowFlight::CallOptions, a new
# ArrowFlight::CallOptions is created and it's returned.
#
# @since 13.0.0
def authenticate_basic(user, password, options=nil)
unless options.is_a?(CallOptions)
options = CallOptions.try_convert(options)
end
options ||= CallOptions.new
_success, bearer_name, bearer_value =
authenticate_basic_token(user, password, options)
invalid_bearer = (bearer_name.empty? or bearer_value.empty?)
unless invalid_bearer
options.add_header(bearer_name, bearer_value)
end
options
end
alias_method :do_put_raw, :do_put
# Upload data to a Flight described by the given descriptor. The
# caller must call `#close` on the returned stream once they are
# done writing. Note that it's automatically done when you use
# block.
#
# The reader and writer are linked; closing the writer will also
# close the reader. Use GArrowFlight::StreamWriter#done_writing to
# only close the write side of the channel.
#
# @param descriptor [GArrowFlight::Descriptor] Descriptor to be uploaded.
# @param schema [GArrow::Schema] Schema of uploaded data.
# @param options [ArrowFlight::CallOptions, Hash, nil] (nil)
# The options to be used.
#
# @yieldparam writer [GArrowFlight::StreamWriter] The writer to upload
# data to the given descriptor.
#
# This is closed automatically after the given block is finished.
#
# @yieldparam reader [GArrowFlight::MetadataReader] The reader to read
# metadata from the server.
#
# @return [Array<GArrowFlight::MetadataReader, GArrowFlight::StreamWriter>, Object]
# The reader and the writer if block isn't given.
#
# The return value from block if block is given.
#
# @since 18.0.0
def do_put(descriptor, schema, options=nil)
result = do_put_raw(descriptor, schema, options)
reader = result.reader
writer = result.writer
if block_given?
begin
yield(reader, writer)
ensure
writer.close unless writer.closed?
end
else
return reader, writer
end
end
end
end
|
