def test_send_blurbs(transport: str = 'grpc'):
client = MessagingClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = messaging.CreateBlurbRequest()
requests = [request]
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(
type(client._transport.send_blurbs),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = messaging.SendBlurbsResponse(
names=['names_value'],
)
response = client.send_blurbs(iter(requests))
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert next(args[0]) == request
# Establish that the response is the type that we expect.
assert isinstance(response, messaging.SendBlurbsResponse)
assert response.names == ['names_value']
def test_create_blurb(transport: str = 'grpc'):
client = MessagingClient(
credentials=credentials.AnonymousCredentials(),
transport=transport,
)
# Everything is optional in proto3 as far as the runtime is concerned,
# and we are mocking out the actual API, so just send an empty request.
request = messaging.CreateBlurbRequest()
# Mock the actual call within the gRPC stub, and fake the request.
with mock.patch.object(type(client._transport.create_blurb),
'__call__') as call:
# Designate an appropriate return value for the call.
call.return_value = messaging.Blurb(
name='name_value',
user='******',
text='text_value',
image=b'image_blob',
)
response = client.create_blurb(request)
# Establish that the underlying gRPC stub method was called.
assert len(call.mock_calls) == 1
_, args, _ = call.mock_calls[0]
assert args[0] == request
# Establish that the response is the type that we expect.
assert isinstance(response, messaging.Blurb)
assert response.name == 'name_value'
assert response.user == 'user_value'
assert response.text == 'text_value'
assert response.image == b'image_blob'
def test_create_blurb_flattened_error():
client = MessagingClient(credentials=credentials.AnonymousCredentials(), )
# Attempting to call a method with both a request object and flattened
# fields is an error.
with pytest.raises(ValueError):
client.create_blurb(
messaging.CreateBlurbRequest(),
parent='parent_value',
user='******',
text='text_value',
image=b'image_blob',
)
def send_blurbs(
self,
request: messaging.CreateBlurbRequest = None,
*,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> messaging.SendBlurbsResponse:
r"""This is a stream to create multiple blurbs. If an
invalid blurb is requested to be created, the stream
will close with an error.
Args:
request (:class:`~.messaging.CreateBlurbRequest`):
The request object. The request message for the
google.showcase.v1beta1.Messaging\CreateBlurb method.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
~.messaging.SendBlurbsResponse:
The response message for the
google.showcase.v1beta1.Messaging\SendBlurbs
method.
"""
# Create or coerce a protobuf request object.
request = messaging.CreateBlurbRequest(request)
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(
self._transport.send_blurbs,
default_timeout=None,
client_info=_client_info,
)
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response
def create_blurb(
self,
request: messaging.CreateBlurbRequest = None,
*,
parent: str = None,
user: str = None,
text: str = None,
image: bytes = None,
retry: retries.Retry = gapic_v1.method.DEFAULT,
timeout: float = None,
metadata: Sequence[Tuple[str, str]] = (),
) -> messaging.Blurb:
r"""Creates a blurb. If the parent is a room, the blurb
is understood to be a message in that room. If the
parent is a profile, the blurb is understood to be a
post on the profile.
Args:
request (:class:`~.messaging.CreateBlurbRequest`):
The request object. The request message for the
google.showcase.v1beta1.Messaging\CreateBlurb method.
parent (:class:`str`):
The resource name of the chat room or
user profile that this blurb will be
tied to.
This corresponds to the ``parent`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
user (:class:`str`):
The resource name of the blurb's
author.
This corresponds to the ``blurb.user`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
text (:class:`str`):
The textual content of this blurb.
This corresponds to the ``blurb.text`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
image (:class:`bytes`):
The image content of this blurb.
This corresponds to the ``blurb.image`` field
on the ``request`` instance; if ``request`` is provided, this
should not be set.
retry (google.api_core.retry.Retry): Designation of what errors, if any,
should be retried.
timeout (float): The timeout for this request.
metadata (Sequence[Tuple[str, str]]): Strings which should be
sent along with the request as metadata.
Returns:
~.messaging.Blurb:
This protocol buffer message
represents a blurb sent to a chat room
or posted on a user profile.
"""
# Create or coerce a protobuf request object.
# Sanity check: If we got a request object, we should *not* have
# gotten any keyword arguments that map to the request.
if request is not None and any([parent, user, text, image]):
raise ValueError('If the `request` argument is set, then none of '
'the individual field arguments should be set.')
# If we have keyword arguments corresponding to fields on the
# request, apply these.
request = messaging.CreateBlurbRequest(request)
if parent is not None:
request.parent = parent
if user is not None:
request.blurb.user = user
if text is not None:
request.blurb.text = text
if image is not None:
request.blurb.image = image
# Wrap the RPC method; this adds retry and timeout information,
# and friendly error handling.
rpc = gapic_v1.method.wrap_method(
self._transport.create_blurb,
default_timeout=None,
client_info=_client_info,
)
# Send the request.
response = rpc(
request,
retry=retry,
timeout=timeout,
metadata=metadata,
)
# Done; return the response.
return response