org.killbill.billing.invoice.usage.SubscriptionConsumableInArrear Maven / Gradle / Ivy
/*
* Copyright 2014 The Billing Project, LLC
*
* Ning licenses this file to you 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 org.killbill.billing.invoice.usage;
import java.util.Collections;
import java.util.Comparator;
import java.util.HashMap;
import java.util.HashSet;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.UUID;
import org.joda.time.LocalDate;
import org.killbill.billing.catalog.api.BillingMode;
import org.killbill.billing.catalog.api.CatalogApiException;
import org.killbill.billing.catalog.api.Usage;
import org.killbill.billing.catalog.api.UsageType;
import org.killbill.billing.invoice.api.InvoiceItem;
import org.killbill.billing.invoice.usage.ContiguousIntervalConsumableInArrear.ConsumableInArrearItemsAndNextNotificationDate;
import org.killbill.billing.junction.BillingEvent;
import org.killbill.billing.usage.RawUsage;
import org.killbill.billing.util.AccountDateAndTimeZoneContext;
import com.google.common.annotations.VisibleForTesting;
import com.google.common.base.Function;
import com.google.common.base.Predicate;
import com.google.common.collect.Collections2;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.Iterables;
import com.google.common.collect.Lists;
import com.google.common.collect.Ordering;
/**
* There is one such class created for each subscriptionId referenced in the billingEvents.
*/
public class SubscriptionConsumableInArrear {
private static final Comparator RAW_USAGE_DATE_COMPARATOR = new Comparator() {
@Override
public int compare(final RawUsage o1, final RawUsage o2) {
int compared = o1.getDate().compareTo(o2.getDate());
if (compared != 0) {
return compared;
} else {
compared = o1.getUnitType().compareTo(o2.getUnitType());
if (compared != 0) {
return compared;
} else {
return o1.hashCode() != o2.hashCode() ? o1.hashCode() - o2.hashCode() : 0;
}
}
}
};
private final UUID accountId;
private final UUID invoiceId;
private final List subscriptionBillingEvents;
private final LocalDate targetDate;
private final List rawSubscriptionUsage;
private final LocalDate rawUsageStartDate;
private final AccountDateAndTimeZoneContext dateAndTimeZoneContext;
public SubscriptionConsumableInArrear(final UUID accountId,
final UUID invoiceId,
final List subscriptionBillingEvents,
final List rawUsage,
final LocalDate targetDate,
final LocalDate rawUsageStartDate,
final AccountDateAndTimeZoneContext dateAndTimeZoneContext) {
this.accountId = accountId;
this.invoiceId = invoiceId;
this.subscriptionBillingEvents = subscriptionBillingEvents;
this.targetDate = targetDate;
this.rawUsageStartDate = rawUsageStartDate;
this.dateAndTimeZoneContext= dateAndTimeZoneContext;
// Extract raw usage for that subscription and sort it by date
this.rawSubscriptionUsage = Ordering.from(RAW_USAGE_DATE_COMPARATOR).sortedCopy(Iterables.filter(rawUsage, new Predicate() {
@Override
public boolean apply(final RawUsage input) {
return input.getSubscriptionId().equals(subscriptionBillingEvents.get(0).getSubscription().getId());
}
}));
}
/**
* Based on billing events, (@code existingUsage} and targetDate, figure out what remains to be billed.
*
* @param existingUsage the existing on disk usage items.
* @return
* @throws CatalogApiException
*/
public SubscriptionConsumableInArrearItemsAndNextNotificationDate computeMissingUsageInvoiceItems(final List existingUsage) throws CatalogApiException {
final SubscriptionConsumableInArrearItemsAndNextNotificationDate result = new SubscriptionConsumableInArrearItemsAndNextNotificationDate();
final List billingEventTransitionTimePeriods = computeInArrearUsageInterval();
for (ContiguousIntervalConsumableInArrear usageInterval : billingEventTransitionTimePeriods) {
result.addConsumableInArrearItemsAndNextNotificationDate(usageInterval.getUsage().getName(), usageInterval.computeMissingItemsAndNextNotificationDate(existingUsage));
}
return result;
}
@VisibleForTesting
List computeInArrearUsageInterval() {
final List usageIntervals = Lists.newLinkedList();
final Map inFlightInArrearUsageIntervals = new HashMap();
final Set allSeenUsage = new HashSet();
for (BillingEvent event : subscriptionBillingEvents) {
// Extract all in arrear /consumable usage section for that billing event.
final List usages = findConsumableInArrearUsages(event);
allSeenUsage.addAll(Collections2.transform(usages, new Function() {
@Override
public String apply(final Usage input) {
return input.getName();
}
}));
// All inflight usage interval are candidates to be closed unless we see that current billing event referencing the same usage section.
final Set toBeClosed = new HashSet(allSeenUsage);
for (Usage usage : usages) {
// Add inflight usage interval if non existent
ContiguousIntervalConsumableInArrear existingInterval = inFlightInArrearUsageIntervals.get(usage.getName());
if (existingInterval == null) {
existingInterval = new ContiguousIntervalConsumableInArrear(usage, accountId, invoiceId, rawSubscriptionUsage, targetDate, rawUsageStartDate, dateAndTimeZoneContext);
inFlightInArrearUsageIntervals.put(usage.getName(), existingInterval);
}
// Add billing event for that usage interval
existingInterval.addBillingEvent(event);
// Remove usage interval for toBeClosed set
toBeClosed.remove(usage.getName());
}
// Build the usage interval that are no longer referenced
for (String usageName : toBeClosed) {
final ContiguousIntervalConsumableInArrear interval = inFlightInArrearUsageIntervals.remove(usageName);
if (interval != null) {
interval.addBillingEvent(event);
usageIntervals.add(interval.build(true));
}
}
}
for (String usageName : inFlightInArrearUsageIntervals.keySet()) {
usageIntervals.add(inFlightInArrearUsageIntervals.get(usageName).build(false));
}
inFlightInArrearUsageIntervals.clear();
return usageIntervals;
}
List findConsumableInArrearUsages(final BillingEvent event) {
if (event.getUsages().size() == 0) {
return Collections.emptyList();
}
final List result = Lists.newArrayList();
for (Usage usage : event.getUsages()) {
if (usage.getUsageType() != UsageType.CONSUMABLE ||
usage.getBillingMode() != BillingMode.IN_ARREAR) {
continue;
}
result.add(usage);
}
return result;
}
public class SubscriptionConsumableInArrearItemsAndNextNotificationDate {
private List invoiceItems;
private Map perUsageNotificationDates;
public SubscriptionConsumableInArrearItemsAndNextNotificationDate() {
this.invoiceItems = null;
this.perUsageNotificationDates = null;
}
public void addConsumableInArrearItemsAndNextNotificationDate(final String usageName, final ConsumableInArrearItemsAndNextNotificationDate input) {
if (!input.getInvoiceItems().isEmpty()) {
if (invoiceItems == null) {
invoiceItems = new LinkedList();
}
invoiceItems.addAll(input.getInvoiceItems());
}
if (input.getNextNotificationDate() != null) {
if (perUsageNotificationDates == null) {
perUsageNotificationDates = new HashMap();
}
perUsageNotificationDates.put(usageName, input.getNextNotificationDate());
}
}
public List getInvoiceItems() {
return invoiceItems != null ? invoiceItems : ImmutableList.of();
}
public Map getPerUsageNotificationDates() {
return perUsageNotificationDates != null ? perUsageNotificationDates : ImmutableMap.of();
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy