CreditCardFixture.java

/*
 * Copyright (C) 2014 SCVNGR, Inc. d/b/a LevelUp
 *
 * Licensed 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.
 */
package com.scvngr.levelup.core.model;

import android.support.annotation.NonNull;

import com.scvngr.levelup.core.model.factory.json.CreditCardJsonFactory;

import net.jcip.annotations.ThreadSafe;

import org.json.JSONException;
import org.json.JSONObject;

/**
 * Fixture for {@link CreditCard}s.
 */
@ThreadSafe
public final class CreditCardFixture {

    /**
     * @param creditCardId the ID of the credit card.
     * @return A minimal {@link CreditCard} model.
     */
    @NonNull
    public static CreditCard getMinimalModel(final int creditCardId) {
        try {
            return new CreditCardJsonFactory().from(getValidJsonObject(creditCardId));
        } catch (final JSONException e) {
            throw new AssertionError(e.getMessage());
        }
    }

    /**
     * @return A full {@link CreditCard} model.
     */
    @NonNull
    public static CreditCard getFullModel() {
        return getFullModel(0, false);
    }

    /**
     * @param creditCardId the ID to set for the created {@link CreditCard}.
     * @return A full {@link CreditCard} model.
     */
    @NonNull
    public static CreditCard getFullModel(final int creditCardId) {
        return getFullModel(creditCardId, false);
    }

    /**
     * @param creditCardId the ID of the credit card.
     * @param promoted if the card should be marked as promoted or not.
     * @return A full {@link CreditCard} model.
     */
    @NonNull
    public static CreditCard getFullModel(final int creditCardId, final boolean promoted) {
        return new CreditCard(111111L, true, "description", "06",
                "2012", creditCardId, "9999",
                promoted, "type");
    }

    /**
     * Gets a valid base JSON object.
     *
     * @param serverId the ID of the object on the server.
     * @return a {@link JSONObject} with all the {@link CreditCard} required fields.
     */
    @NonNull
    public static JSONObject getValidJsonObject(final int serverId) {
        final JSONObject object = new JSONObject();

        try {
            object.put(CreditCardJsonFactory.JsonKeys.ID, serverId);
        } catch (final JSONException e) {
            throw new AssertionError(e);
        }

        return object;
    }

    /**
     * Gets a valid base JSON object.
     *
     * @return a {@link JSONObject} with all the {@link CreditCard} required fields.
     */
    @NonNull
    public static JSONObject getValidJsonObject() {
        return getValidJsonObject(1);
    }

    /**
     * Gets a valid full JSON object.
     *
     * @param promoted if the card is promoted or not.
     * @return a {@link JSONObject} with all the {@link CreditCard} fields.
     */
    @NonNull
    public static JSONObject getFullJsonObject(final boolean promoted) {
        return getFullJsonObject(1, promoted);
    }

    /**
     * Gets a valid full JSON object.
     *
     * @param serverId the ID of the object on the server.
     * @param promoted if the card is promoted or not.
     * @return a {@link JSONObject} with all the {@link CreditCard} fields.
     */
    @NonNull
    public static JSONObject getFullJsonObject(final int serverId, final boolean promoted) {
        final JSONObject object = getValidJsonObject(serverId);

        try {
            object.put(CreditCardJsonFactory.JsonKeys.BIN, 111111L);
            object.put(CreditCardJsonFactory.JsonKeys.DEBIT, true);
            object.put(CreditCardJsonFactory.JsonKeys.DESCRIPTION, "description");
            object.put(CreditCardJsonFactory.JsonKeys.EXPIRATION_MONTH, "01");
            object.put(CreditCardJsonFactory.JsonKeys.EXPIRATION_YEAR, "1999");
            object.put(CreditCardJsonFactory.JsonKeys.LAST_4, "last_4");
            object.put(CreditCardJsonFactory.JsonKeys.PROMOTED, promoted);
            object.put(CreditCardJsonFactory.JsonKeys.TYPE, "type");
        } catch (final JSONException e) {
            throw new AssertionError(e);
        }

        return object;
    }

    /**
     * Private constructor prevents instantiation.
     *
     * @throws UnsupportedOperationException because this class cannot be instantiated.
     */
    private CreditCardFixture() {
        throw new UnsupportedOperationException("This class is non-instantiable");
    }
}