IdAShellCmdMailTest.java

/*
 * Copyright © 2023 Mark Raynsford <code@io7m.com> https://www.io7m.com
 *
 * Permission to use, copy, modify, and/or distribute this software for any
 * purpose with or without fee is hereby granted, provided that the above
 * copyright notice and this permission notice appear in all copies.
 *
 * THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
 * WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
 * SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
 * WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
 * ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR
 * IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
 */

package com.io7m.idstore.shell.admin.internal;

import com.io7m.idstore.admin_client.api.IdAClientSynchronousType;
import com.io7m.idstore.model.IdEmail;
import com.io7m.idstore.model.IdShortHumanToken;
import com.io7m.idstore.protocol.admin.IdACommandMailTest;
import com.io7m.idstore.protocol.admin.IdAResponseMailTest;
import com.io7m.quarrel.core.QCommandContextType;
import com.io7m.quarrel.core.QCommandMetadata;
import com.io7m.quarrel.core.QParameterNamed01;
import com.io7m.quarrel.core.QParameterNamed1;
import com.io7m.quarrel.core.QParameterNamedType;
import com.io7m.quarrel.core.QStringType.QConstant;

import java.util.List;
import java.util.Optional;

/**
 * "mail-test"
 */

public final class IdAShellCmdMailTest
  extends IdAShellCmdAbstract<IdACommandMailTest, IdAResponseMailTest>
{
  private static final QParameterNamed1<IdEmail> EMAIL =
    new QParameterNamed1<>(
      "--email",
      List.of(),
      new QConstant("The target email."),
      Optional.empty(),
      IdEmail.class
    );

  private static final QParameterNamed01<IdShortHumanToken> TOKEN =
    new QParameterNamed01<>(
      "--token",
      List.of(),
      new QConstant("The short token."),
      Optional.empty(),
      IdShortHumanToken.class
    );

  /**
   * Construct a command.
   *
   * @param inClient The client
   */

  public IdAShellCmdMailTest(
    final IdAClientSynchronousType inClient)
  {
    super(
      inClient,
      new QCommandMetadata(
        "mail-test",
        new QConstant("Send a test email."),
        Optional.empty()
      ),
      IdACommandMailTest.class,
      IdAResponseMailTest.class
    );
  }

  @Override
  public List<QParameterNamedType<?>> onListNamedParameters()
  {
    return List.of(EMAIL, TOKEN);
  }

  @Override
  protected IdACommandMailTest onCreateCommand(
    final QCommandContextType context)
  {
    return new IdACommandMailTest(
      context.parameterValue(EMAIL),
      context.parameterValue(TOKEN)
        .orElseGet(IdShortHumanToken::generate)
    );
  }

  @Override
  protected void onFormatResponse(
    final QCommandContextType context,
    final IdAResponseMailTest response)
  {
    final var output = context.output();
    output.println("Mail sent successfully.");
    output.println("Token: " + response.token().value());
  }
}