<?php
/**
 * Signup Controller Tests.
 *
 * @group signup
 * @group signups
 * @group members
 */
class BP_Tests_Signup_REST_Controller extends BP_Test_REST_Controller_Testcase {
	protected $signup_id;
	protected $signup_allowed;
	protected $handle     = 'signup';
	protected $controller = 'BP_Members_Signup_REST_Controller';

	public function set_up() {
		// This currently NEEDs to run before the parent::set_up().
		if ( is_multisite() ) {
			$this->signup_allowed = get_site_option( 'registration' );
			update_site_option( 'registration', 'all' );
		} else {
			$this->signup_allowed = bp_get_option( 'users_can_register' );
		}
		bp_update_option( 'users_can_register', 1 );

		parent::set_up();

		$this->signup_id = $this->create_signup();
	}

	public function tear_down() {
		if ( is_multisite() ) {
			update_site_option( 'registration', $this->signup_allowed );
		} else {
			bp_update_option( 'users_can_register', $this->signup_allowed );
		}

		parent::tear_down();
	}

	public function test_register_routes() {
		$routes = $this->server->get_routes();

		// Main.
		$this->assertArrayHasKey( $this->endpoint_url, $routes );
		$this->assertCount( 2, $routes[ $this->endpoint_url ] );

		// Single.
		$this->assertArrayHasKey( $this->endpoint_url . '/(?P<id>[\w-]+)', $routes );
		$this->assertCount( 2, $routes[ $this->endpoint_url . '/(?P<id>[\w-]+)' ] );
		$this->assertCount( 1, $routes[ $this->endpoint_url . '/activate/(?P<activation_key>[\w-]+)' ] );
		$this->assertCount( 1, $routes[ $this->endpoint_url . '/resend' ] );
	}

	/**
	 * @group get_items
	 */
	public function test_get_items() {
		wp_set_current_user( $this->user );

		$s1     = $this->create_signup();
		$signup = $this->endpoint->get_signup_object( $s1 );

		$request = new WP_REST_Request( 'GET', $this->endpoint_url );
		$request->set_param( 'context', 'view' );
		$request->set_query_params( array( 'include' => $s1 ) );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$all_data = $response->get_data();
		$this->check_signup_data( $signup, $all_data[0] );
	}

	/**
	 * @group get_items
	 */
	public function test_get_paginated_items() {
		wp_set_current_user( $this->user );

		$s1 = $this->create_signup();
		$s2 = $this->create_signup();
		$s3 = $this->create_signup();
		$s4 = $this->create_signup();

		$request = new WP_REST_Request( 'GET', $this->endpoint_url );
		$request->set_query_params(
			array(
				'include' => array( $s1, $s2, $s3, $s4 ),
				'number'  => 2,
			)
		);

		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$headers = $response->get_headers();

		$this->assertSame( 4, $headers['X-WP-Total'] );
		$this->assertSame( 2, $headers['X-WP-TotalPages'] );
	}

	/**
	 * @group get_items
	 */
	public function test_get_items_user_not_logged_in() {
		$request = new WP_REST_Request( 'GET', $this->endpoint_url );
		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_authorization_required', $response, rest_authorization_required_code() );
	}

	/**
	 * @group get_items
	 */
	public function test_get_items_unauthorized_user() {
		$u = static::factory()->user->create();

		wp_set_current_user( $u );

		$request = new WP_REST_Request( 'GET', $this->endpoint_url );
		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_authorization_required', $response, rest_authorization_required_code() );
	}

	/**
	 * @group get_item
	 */
	public function test_get_item() {
		wp_set_current_user( $this->user );

		$signup = $this->endpoint->get_signup_object( $this->signup_id );
		$this->assertSame( $this->signup_id, $signup->id );

		$request = new WP_REST_Request( 'GET', sprintf( $this->endpoint_url . '/%d', $this->signup_id ) );
		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$all_data = $response->get_data();

		$this->check_signup_data( $signup, $all_data );
	}

	/**
	 * @group get_item
	 */
	public function test_get_item_with_invalid_signup_id() {
		wp_set_current_user( $this->user );

		$request = new WP_REST_Request( 'GET', sprintf( $this->endpoint_url . '/%d', REST_TESTS_IMPOSSIBLY_HIGH_NUMBER ) );
		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_invalid_id', $response, 404 );
	}

	/**
	 * @group get_item
	 */
	public function test_get_item_user_not_logged_in() {
		$request = new WP_REST_Request( 'GET', sprintf( $this->endpoint_url . '/%s', $this->signup_id ) );
		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_authorization_required', $response, rest_authorization_required_code() );
	}

	/**
	 * @group get_item
	 */
	public function test_get_item_unauthorized_user() {
		$u = static::factory()->user->create();

		wp_set_current_user( $u );

		$request = new WP_REST_Request( 'GET', sprintf( $this->endpoint_url . '/%s', $this->signup_id ) );
		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_authorization_required', $response, rest_authorization_required_code() );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item() {
		$request = new WP_REST_Request( 'POST', $this->endpoint_url );

		$params = $this->set_signup_data();
		$request->set_body_params( $params );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$signup = $response->get_data();

		$this->assertSame( $signup['user_login'], $params['user_login'] );
		$this->assertSame( $signup['user_email'], $params['user_email'] );
		$this->assertTrue( ! isset( $signup['activation_key'] ) );
	}

	/**
	 * @group create_item
	 */
	public function test_creating_multiple_pending_accounts_with_different_usernames() {
		$request = new WP_REST_Request( 'POST', $this->endpoint_url );
		$suffix  = strtolower( wp_generate_password( 12, false, false ) );
		$email   = 'signup-test-user-' . $suffix . '@example.com';

		$params = $this->set_signup_data(
			array(
				'user_login' => 'signuptestuserone' . $suffix,
				'user_email' => $email,
			)
		);
		$request->set_body_params( $params );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status(), wp_json_encode( $response->get_data() ) );

		$signup = $response->get_data();

		$this->assertSame( $signup['user_login'], $params['user_login'] );
		$this->assertSame( $signup['user_email'], $params['user_email'] );
		$this->assertTrue( ! isset( $signup['activation_key'] ) );

		// Test with the same email.
		$params = $this->set_signup_data(
			array(
				'user_login' => 'signuptestusertwo' . $suffix,
				'user_email' => $email,
			)
		);
		$request->set_body_params( $params );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_signup_validation_failed', $response, 500, 'This user\'s email is already registered.' );

		// Test with a different email.
		$params = $this->set_signup_data(
			array(
				'user_login' => 'signuptestusertwo' . $suffix,
				'user_email' => 'signup-test-user-two-' . $suffix . '@example.com',
			)
		);
		$request->set_body_params( $params );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item_with_signup_fields() {
		$g1 = $this->bp::factory()->xprofile_group->create();

		$f1 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'textbox',
				'name'           => 'field1',
			)
		);

		$f2 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'checkbox',
				'name'           => 'field2',
			)
		);

		bp_xprofile_update_field_meta( $f1, 'signup_position', 2 );
		bp_xprofile_update_field_meta( $f2, 'signup_position', 3 );

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 1',
			)
		);

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 2',
			)
		);

		$fullname_field_id = bp_xprofile_fullname_field_id();

		$request = new WP_REST_Request( 'POST', $this->endpoint_url );
		$params  = $this->set_signup_data(
			array(
				'signup_field_data' => array(
					array(
						'field_id'   => $f1,
						'value'      => 'Field 1 Value',
						'visibility' => 'public',
					),
					array(
						'field_id'   => $f2,
						'value'      => 'Option 2, Option 1,',
						'visibility' => 'public',
					),
					array(
						'field_id'   => $fullname_field_id,
						'value'      => 'New User',
						'visibility' => 'public',
					),
				),
			)
		);
		$request->set_body_params( $params );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$signup = $response->get_data();

		$this->assertSame( $signup['user_email'], $params['user_email'] );

		// Check the textbox field.
		$this->assertSame( $signup['meta'][ 'field_' . $f1 ], $params['signup_field_data'][0]['value'] );
		$this->assertSame( $signup['meta'][ 'field_' . $f1 . '_visibility' ], $params['signup_field_data'][0]['visibility'] );

		// Check the checkbox field.
		$this->assertSame( $signup['meta'][ 'field_' . $f2 ], array_map( 'trim', explode( ', ', $params['signup_field_data'][1]['value'] ) ) );
		$this->assertSame( $signup['meta'][ 'field_' . $f2 . '_visibility' ], $params['signup_field_data'][1]['visibility'] );

		$field_ids = wp_parse_id_list( explode( ',', $signup['meta']['profile_field_ids'] ) );

		$this->assertCount( 3, $field_ids );
		$this->assertContains( $fullname_field_id, $field_ids );
		$this->assertContains( $f1, $field_ids );
		$this->assertContains( $f2, $field_ids );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item_without_the_required_field_name_field() {
		$g1 = $this->bp::factory()->xprofile_group->create();

		$f1 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'textbox',
				'name'           => 'field1',
			)
		);

		$f2 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'checkbox',
				'name'           => 'field2',
			)
		);

		bp_xprofile_update_field_meta( $f1, 'signup_position', 2 );
		bp_xprofile_update_field_meta( $f2, 'signup_position', 3 );

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 1',
			)
		);

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 2',
			)
		);

		$request = new WP_REST_Request( 'POST', $this->endpoint_url );
		$request->set_param( 'context', 'edit' );
		$params = $this->set_signup_data(
			array(
				'signup_field_data' => array(
					array(
						'field_id'   => $f1,
						'value'      => 'Field 1 Value',
						'visibility' => 'public',
					),
					array(
						'field_id'   => $f2,
						'value'      => 'Option 1, Option 2',
						'visibility' => 'public',
					),
				),
			)
		);

		$request->set_body_params( $params );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_signup_field_required', $response, 500 );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item_without_a_custom_required_field_name_field() {
		$g1 = $this->bp::factory()->xprofile_group->create();

		$f1 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'textbox',
				'name'           => 'field1',
				'is_required'    => true,
			)
		);

		$f2 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'checkbox',
				'name'           => 'field2',
			)
		);

		bp_xprofile_update_field_meta( $f1, 'signup_position', 2 );
		bp_xprofile_update_field_meta( $f2, 'signup_position', 3 );

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 1',
			)
		);

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 2',
			)
		);

		$request = new WP_REST_Request( 'POST', $this->endpoint_url );
		$request->set_param( 'context', 'edit' );
		$params = $this->set_signup_data(
			array(
				'signup_field_data' => array(
					// Missing the required field.
					array(
						'field_id'   => $f2,
						'value'      => 'Option 1, Option 2',
						'visibility' => 'public',
					),
					array(
						'field_id'   => bp_xprofile_fullname_field_id(),
						'value'      => 'Test User',
						'visibility' => 'public',
					),
				),
			)
		);

		$request->set_body_params( $params );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_signup_field_required', $response, 500 );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item_a_custom_required_field_name_field_value_missing() {
		$g1 = $this->bp::factory()->xprofile_group->create();

		$f1 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'textbox',
				'name'           => 'field1',
				'is_required'    => true,
			)
		);

		$f2 = $this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'type'           => 'checkbox',
				'name'           => 'field2',
			)
		);

		bp_xprofile_update_field_meta( $f1, 'signup_position', 2 );
		bp_xprofile_update_field_meta( $f2, 'signup_position', 3 );

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 1',
			)
		);

		$this->bp::factory()->xprofile_field->create(
			array(
				'field_group_id' => $g1,
				'parent_id'      => $f2,
				'type'           => 'option',
				'name'           => 'Option 2',
			)
		);

		$request = new WP_REST_Request( 'POST', $this->endpoint_url );

		$params = $this->set_signup_data(
			array(
				'signup_field_data' => array(
					array(
						'field_id' => $f1,
						'value'    => '', // <-- missing value.
					),
					array(
						'field_id' => $f2,
						'value'    => 'Option 1, Option 2',
					),
					array(
						'field_id' => bp_xprofile_fullname_field_id(),
						'value'    => 'Test User',
					),
				),
			)
		);

		$request->set_body_params( $params );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_signup_field_required', $response, 500 );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item_without_the_default_required_field_value() {
		$request = new WP_REST_Request( 'POST', $this->endpoint_url );
		$request->set_param( 'context', 'edit' );
		$data   = array(
			array(
				'field_id'   => bp_xprofile_fullname_field_id(),
				'value'      => '',
				'visibility' => 'public',
			),
		);
		$params = $this->set_signup_data( array( 'signup_field_data' => $data ) );
		$request->set_body_params( $params );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_signup_field_required', $response, 500 );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item_without_the_signup_field_data_param() {
		$request = new WP_REST_Request( 'POST', $this->endpoint_url );
		$request->set_param( 'context', 'edit' );
		$params = $this->set_signup_data( array( 'signup_field_data' => array() ) );
		$request->set_body_params( $params );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'rest_invalid_param', $response, 400 );
	}

	/**
	 * @group create_item
	 */
	public function test_create_item_unauthorized_password() {
		$request = new WP_REST_Request( 'POST', $this->endpoint_url );
		$request->set_param( 'context', 'edit' );
		$params = $this->set_signup_data( array( 'password' => '\\Antislash' ) );
		$request->set_body_params( $params );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'rest_user_invalid_password', $response, 400 );
	}

	/**
	 * @group activate_item
	 */
	public function test_update_item() {
		$s1     = $this->create_signup();
		$signup = new BP_Signup( $s1 );

		$request = new WP_REST_Request( 'PUT', sprintf( $this->endpoint_url . '/activate/%s', $signup->activation_key ) );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$all_data = $response->get_data();

		$this->check_signup_data( $signup, $all_data );
	}

	/**
	 * @group activate_item
	 */
	public function test_update_item_invalid_invalid_activation_key() {
		$request = new WP_REST_Request( 'PUT', sprintf( $this->endpoint_url . '/activate/%s', 'randomkey' ) );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_invalid_activation_key', $response, 404 );
	}

	/**
	 * @group delete_item
	 */
	public function test_delete_item() {
		wp_set_current_user( $this->user );

		$signup = $this->endpoint->get_signup_object( $this->signup_id );
		$this->assertSame( $this->signup_id, $signup->id );

		$request = new WP_REST_Request( 'DELETE', sprintf( $this->endpoint_url . '/%d', $this->signup_id ) );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$deleted = $response->get_data();

		$this->assertTrue( $deleted['deleted'] );
	}

	/**
	 * @group delete_item
	 */
	public function test_delete_item_invalid_signup_id() {
		wp_set_current_user( $this->user );

		$request = new WP_REST_Request( 'DELETE', sprintf( $this->endpoint_url . '/%d', REST_TESTS_IMPOSSIBLY_HIGH_NUMBER ) );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_invalid_id', $response, 404 );
	}

	/**
	 * @group delete_item
	 */
	public function test_delete_item_user_not_logged_in() {
		$request = new WP_REST_Request( 'DELETE', sprintf( $this->endpoint_url . '/%d', $this->signup_id ) );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_authorization_required', $response, rest_authorization_required_code() );
	}

	/**
	 * @group delete_item
	 */
	public function test_delete_item_unauthorized_user() {
		$u = static::factory()->user->create();
		wp_set_current_user( $u );

		$request = new WP_REST_Request( 'DELETE', sprintf( $this->endpoint_url . '/%d', $this->signup_id ) );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_authorization_required', $response, rest_authorization_required_code() );
	}

	/**
	 * @group resend_item
	 */
	public function test_resend_activation_email() {
		$signup_id = $this->create_signup();

		$request = new WP_REST_Request( 'PUT', $this->endpoint_url . '/resend' );
		$request->set_param( 'id', $signup_id );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$all_data = $response->get_data();

		$this->assertTrue( $all_data['sent'] );
	}

	/**
	 * @group resend_item
	 */
	public function test_resend_activation_email_to_active_signup() {
		$signup_id = $this->create_signup();
		$signup    = new BP_Signup( $signup_id );

		bp_core_activate_signup( $signup->activation_key );

		$request = new WP_REST_Request( 'PUT', $this->endpoint_url . '/resend' );
		$request->set_param( 'id', $signup_id );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		if ( is_multisite() ) {
			$this->assertSame( 200, $response->get_status() );

			$all_data = $response->get_data();

			$this->assertTrue( $all_data['sent'] );
		} else {
			$this->assertErrorResponse( 'bp_rest_signup_resend_activation_email_fail', $response, 500 );
		}
	}

	/**
	 * @group resend_item
	 */
	public function test_resend_activation_email_to_locked_signup() {
		$signup_id = $this->create_signup();

		BP_Signup::resend( $signup_id );

		$request = new WP_REST_Request( 'PUT', $this->endpoint_url . '/resend' );
		$request->set_param( 'id', $signup_id );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 500, $response->get_status() );

		$error_code = 'bp_rest_signup_resend_activation_email_fail';
		$error      = $response->as_error();
		$message    = $error->get_error_message( $error_code );

		$this->assertErrorResponse( $error_code, $response, 500 );
		$this->assertSame(
			$message,
			"You've reached the limit for resending your account activation email. Please wait a few minutes and try again. If you continue to experience issues, contact support for assistance."
		);
	}

	/**
	 * @group resend_item
	 */
	public function test_resend_activation_email_to_locked_signup_with_hook() {
		$signup_id = $this->create_signup();

		BP_Signup::resend( $signup_id );

		add_filter( 'bp_core_signup_resend_activation_lock_time', '__return_zero' );

		$request = new WP_REST_Request( 'PUT', $this->endpoint_url . '/resend' );
		$request->set_param( 'id', $signup_id );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$all_data = $response->get_data();

		$this->assertTrue( $all_data['sent'] );

		remove_filter( 'bp_core_signup_resend_activation_lock_time', '__return_zero' );
	}

	/**
	 * @group resend_item
	 */
	public function test_resend_activation_email_invalid_signup_id() {
		$request = new WP_REST_Request( 'PUT', $this->endpoint_url . '/resend' );
		$request->set_param( 'id', REST_TESTS_IMPOSSIBLY_HIGH_NUMBER );
		$request->set_param( 'context', 'edit' );
		$response = $this->server->dispatch( $request );

		$this->assertErrorResponse( 'bp_rest_invalid_id', $response, 404 );
	}

	public function test_prepare_item() {
		wp_set_current_user( $this->user );

		$signup = $this->endpoint->get_signup_object( $this->signup_id );
		$this->assertSame( $this->signup_id, $signup->id );

		$request = new WP_REST_Request( 'GET', sprintf( $this->endpoint_url . '/%d', $this->signup_id ) );
		$request->set_param( 'context', 'view' );
		$response = $this->server->dispatch( $request );

		$this->assertSame( 200, $response->get_status() );

		$all_data = $response->get_data();

		$this->check_signup_data( $signup, $all_data );
	}

	protected function set_signup_data( $args = array() ) {
		return wp_parse_args(
			$args,
			array(
				'user_login'        => 'newnuser',
				'user_email'        => 'new.user@example.com',
				'password'          => 'password',
				'signup_field_data' => array(
					array(
						'field_id'   => bp_xprofile_fullname_field_id(),
						'value'      => 'New User',
						'visibility' => 'public',
					),
				),
			)
		);
	}

	protected function create_signup() {
		return $this->bp::factory()->signup->create(
			array(
				'user_login'     => 'user' . wp_rand( 1, 20 ),
				'user_email'     => sprintf( 'user%d@example.com', wp_rand( 1, 20 ) ),
				'registered'     => bp_core_current_time(),
				'activation_key' => wp_generate_password( 32, false ),
				'meta'           => array(
					'field_1' => 'Foo Bar',
				),
			)
		);
	}

	protected function check_signup_data( $signup, $data ) {
		$this->assertSame( $signup->id, $data['id'] );
		$this->assertSame( $signup->user_login, $data['user_login'] );
		$this->assertSame(
			bp_rest_prepare_date_response( $signup->registered, get_date_from_gmt( $signup->registered ) ),
			$data['registered']
		);
		$this->assertSame( bp_rest_prepare_date_response( $signup->registered ), $data['registered_gmt'] );
	}

	public function test_get_item_schema() {
		$request    = new WP_REST_Request( 'OPTIONS', sprintf( $this->endpoint_url . '/%d', $this->signup_id ) );
		$response   = $this->server->dispatch( $request );
		$data       = $response->get_data();
		$properties = $data['schema']['properties'];

		if ( is_multisite() ) {
			$this->assertCount( 15, $properties );
		} else {
			$this->assertCount( 11, $properties );
		}

		$this->assertArrayHasKey( 'id', $properties );
		$this->assertArrayHasKey( 'user_login', $properties );
		$this->assertArrayHasKey( 'registered', $properties );
		$this->assertArrayHasKey( 'registered_gmt', $properties );
		$this->assertArrayHasKey( 'activation_key', $properties );
		$this->assertArrayHasKey( 'user_email', $properties );
		$this->assertArrayHasKey( 'date_sent', $properties );
		$this->assertArrayHasKey( 'date_sent_gmt', $properties );
		$this->assertArrayHasKey( 'count_sent', $properties );
		$this->assertArrayHasKey( 'meta', $properties );

		if ( is_multisite() ) {
			$this->assertArrayHasKey( 'site_language', $properties );
			$this->assertArrayHasKey( 'site_public', $properties );
			$this->assertArrayHasKey( 'site_title', $properties );
			$this->assertArrayHasKey( 'site_name', $properties );
		}
	}

	public function test_context_param() {
		// Collection.
		$request  = new WP_REST_Request( 'OPTIONS', $this->endpoint_url );
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertSame( 'view', $data['endpoints'][0]['args']['context']['default'] );
		$this->assertSame( array( 'view', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );

		// Single.
		$request  = new WP_REST_Request( 'OPTIONS', sprintf( $this->endpoint_url . '/%d', $this->signup_id ) );
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertSame( 'view', $data['endpoints'][0]['args']['context']['default'] );
		$this->assertSame( array( 'view', 'edit' ), $data['endpoints'][0]['args']['context']['enum'] );
	}

	public function test_bp_rest_api_signup_disabled_feature_dispatch_error() {
		// Disable signups registration.
		bp_update_option( 'users_can_register', 0 );

		if  ( is_multisite() ) {
			update_site_option( 'registration', '' );
		}

		$request  = new WP_REST_Request( 'OPTIONS', $this->endpoint_url );
		$response = $this->server->dispatch( $request );
		$data     = $response->get_data();

		$this->assertSame( 403, $response->get_status() );
		$this->assertSame(
			$data['message'],
			'BuddyPress: The user signup feature is currently disabled. Please activate this feature to proceed.'
		);
	}
}