PhoneNumberAssert.java

package fr.sii.ogham.assertion.sms;

import static fr.sii.ogham.assertion.AssertionHelper.assertThat;
import static fr.sii.ogham.assertion.OghamAssertions.usingContext;

import java.util.List;

import org.hamcrest.Matcher;
import org.jsmpp.bean.NumberingPlanIndicator;
import org.jsmpp.bean.TypeOfNumber;

import fr.sii.ogham.assertion.HasParent;

public class PhoneNumberAssert<P> extends HasParent<P> {
	/**
	 * The list of phone numbers that will be used for assertions
	 */
	private final List<PhoneNumberWithContext> actual;

	public PhoneNumberAssert(List<PhoneNumberWithContext> actual, P parent) {
		super(parent);
		this.actual = actual;
	}

	/**
	 * Make assertions on a phone number.
	 * 
	 * <pre>
	 * .receivedMessages().message(0).to()
	 *    .number(is("+33102030405"))
	 * </pre>
	 * 
	 * Will check if the recipient phone number of the first message is exactly
	 * "+33102030405".
	 * 
	 * <pre>
	 * .receivedMessages().forEach().to()
	 *    .number(is("+33102030405"))
	 * </pre>
	 * 
	 * Will check if the recipient phone number of every message is exactly
	 * "+33102030405".
	 * 
	 * @param matcher
	 *            the assertion to apply on the phone number
	 * @return the fluent API for chaining assertions on received message(s)
	 */
	public PhoneNumberAssert<P> number(Matcher<String> matcher) {
		String message = "number of ${numberName} of message ${messageIndex}";
		for (PhoneNumberWithContext numberWithContext : actual) {
			PhoneNumberInfo number = numberWithContext.getNumber();
			assertThat(number.getAddress(), usingContext(message, numberWithContext, matcher));
		}
		return this;
	}

	/**
	 * Make assertions on a phone number.
	 * 
	 * <pre>
	 * .receivedMessages().message(0).to()
	 *    .typeOfNumber(is(TypeOfNumber.INTERNATIONAL))
	 * </pre>
	 * 
	 * Will check if the recipient phone number type of the first message is an
	 * international number.
	 * 
	 * <pre>
	 * .receivedMessages().forEach().to()
	 *    .typeOfNumber(is(TypeOfNumber.INTERNATIONAL))
	 * </pre>
	 * 
	 * Will check if the recipient phone number type of every message is an
	 * international number.
	 * 
	 * @param matcher
	 *            the assertion to apply on the type of number
	 * @return the fluent API for chaining assertions on received message(s)
	 */
	public PhoneNumberAssert<P> typeOfNumber(Matcher<TypeOfNumber> matcher) {
		String message = "TypeOfNumber of ${numberName} of message ${messageIndex}";
		for (PhoneNumberWithContext numberWithContext : actual) {
			PhoneNumberInfo number = numberWithContext.getNumber();
			assertThat(TypeOfNumber.valueOf(number.getTon()), usingContext(message, numberWithContext, matcher));
		}
		return this;
	}

	/**
	 * Make assertions on a phone number.
	 * 
	 * <pre>
	 * .receivedMessages().message(0).to()
	 *    .numberingPlanIndicator(is(NumberingPlanIndicator.ISDN))
	 * </pre>
	 * 
	 * Will check if the numbering plan indicator of the recipient phone number
	 * of the first message is NumberingPlanIndicator.ISDN.
	 * 
	 * <pre>
	 * .receivedMessages().forEach().to()
	 *    .numberingPlanIndicator(is(NumberingPlanIndicator.ISDN))
	 * </pre>
	 * 
	 * Will check if the numbering plan indicator of the recipient phone number
	 * of every message is NumberingPlanIndicator.ISDN.
	 * 
	 * @param matcher
	 *            the assertion to apply on the numbering plan indicator
	 * @return the fluent API for chaining assertions on received message(s)
	 */
	public PhoneNumberAssert<P> numberingPlanIndicator(Matcher<NumberingPlanIndicator> matcher) {
		String message = "NumberPlanIndicator of ${numberName} of message ${messageIndex}";
		for (PhoneNumberWithContext numberWithContext : actual) {
			PhoneNumberInfo number = numberWithContext.getNumber();
			assertThat(NumberingPlanIndicator.valueOf(number.getNpi()), usingContext(message, numberWithContext, matcher));
		}
		return this;
	}
}