#---------------------------------------------------------------
# ____                   _ _         ____  _
#|  _ \ ___  _   _  __ _| | |_ _   _/ ___|| |__   __ _ _ __ ___
#| |_) / _ \| | | |/ _` | | __| | | \___ \| '_ \ / _` | '__/ _ \
#|  _ < (_) | |_| | (_| | | |_| |_| |___) | | | | (_| | | |  __/
#|_| \_\___/ \__, |\__,_|_|\__|\__, |____/|_| |_|\__,_|_|  \___|
#            |___/             |___/
#
# Copyright (C) 2013 RoyaltyShare, Inc.   All Rights Reserved
#---------------------------------------------------------------
package RPS::Import::Cargo::v1;

use lib '/app/tools/rps/lib';
use base 'RPS::Import::Importer';

sub _fieldMap {
    {
        dateBegin        => 'H',
        dateEnd          => 'H',
        productType      => 'D',
        serviceProductID => 'B',
        artistName       => 'E',
        upc              => 'C',
        currencyCode     => 'V',
        albumName        => 'F',
        sales            => 'N',    # SOLD_QTY
        returns          => 'W',    # NEG_SALE_QTY
        totalRevenue     => 'Q',
    };
}

sub _headerIdentifier { ( artistName => 'ARTIST' ) }

sub physical { 1 }

sub channel { RPS::File::Sale::CHANNEL_RETAIL }

sub priceLevel { RPS::File::Sale::PLEVEL_UNKNOWN }

sub countryCode { 'DE' }

sub productType {
    my $self = shift;
    my $type = $self->_getByFieldName('productType');

    if ( $type =~ /^CD$/i ) {
        return RPS::File::Sale::TYPE_CD;
    } elsif ( $type =~ /^LP$/i ) {
        return RPS::File::Sale::TYPE_LP;
    }
    $self->fail("Unable to get product type from '$type'");
}

sub sales {
    my $self    = shift;
    my $sales   = $self->_getByFieldName('sales');
    my $revenue = $self->_getByFieldName('totalRevenue');
    return ( $sales >= 0 && $revenue > 0 ) ? $sales : 0;
}

sub salesRevenue {
    my $self    = shift;
    my $revenue = $self->_getByFieldName('totalRevenue');
    return ( $revenue >= 0 ) ? $revenue : 0;
}

sub returns {
    my $self  = shift;
    my $sales = $self->_getByFieldName('returns');
    return abs($sales);
}

sub returnsRevenue {
    my $self    = shift;
    my $revenue = $self->_getByFieldName('totalRevenue');
    return ( $revenue < 0 ) ? abs($revenue) : 0;
}

sub _isValidSaleRecord {
    my $self = shift;

    my $sales   = $self->_getByFieldName('sales');
    my $returns = $self->_getByFieldName('returns');
    my $revenue = $self->_getByFieldName('totalRevenue');

    # skip if no sales, returns and revenue
    #
    return 0 if ( 0 == $sales && 0 == $returns && 0 == $revenue );

    # The line is valid if it has sales or returns, and has an album title
    #
    return ( ( $self->sales != 0 || $self->returns != 0 ) && $self->albumName );
}

###
1;    # Play nicely.
###