File Coverage

lib/Net/Amazon/RemoteCart.pm

Criterion	Covered	Total	%
statement	10	12	83.3
branch			n/a
condition			n/a
subroutine	4	4	100.0
pod			n/a
total	14	16	87.5

package Net::Amazon::RemoteCart;

use 5.006;


use strict;
use warnings;
#use diagnostics;

use Net::Amazon;
use Net::Amazon::Response;
use Net::Amazon::Request;
###use Data::Dumper;
use Log::Log4perl qw(:easy);

our $VERSION = '0.02';

use base qw( Net::Amazon );


sub new {
    my($class, %options) = @_;

    if(! exists $options{token}) {
        die "Mandatory parameter 'token' not defined";
    }

    if(! exists $options{affiliate_id}) {
        $options{affiliate_id} = "webservices-20";
    }

    my $self = {
	token => $options{token},
	affiliate_id => $options{affiliate_id},
    };

    # Optional attributes
    $self->{locale}  = $options{locale} if exists $options{locale};
    $self->{cart_id}  = $options{cart_id} if exists $options{cart_id};
    $self->{hmac} = $options{hmac} if $options{hmac};
    $self->{purchase_url} =  $options{purchase_url} if $options{purchase_url};

    #Set items only if passed as a hash ref
    $self->{items} = $options{items} if ref $options{items} eq 'HASH';

    # Set similar_products only if passed as array ref
    $self->{similar_products} = $options{similar_products} if ref $options{similar_products} eq 'ARRAY';

    # Set items only if passed as a hash ref
    # will hold the raw xmlrefreturned by the latest request
    #$self->{xmlref} = $options{xmlref} if ref $options{xmlref} eq 'HASH';

    $self->{f} = 'xml'; # Always the same
    $self->{sims} = 'true'; # Always the same


    $class->SUPER::help_xml_simple_choose_a_parser();

    bless $self, ref($class) || $class;

    # Make accessors for various params
    for my $attr ( qw( locale cart_id hmac purchase_url similar_products ) ) {
        $class->SUPER::make_accessor($attr);
    }

    return $self;
}



#==========================================================
# synchronize the local instance with Amazon's remote cart
#==========================================================
sub sync {
##    my $self = shift;
    my ($self, %params) = @_;

    if ( exists  $params{cart_id} ) {
	$self->{cart_id} = $params{cart_id};
    }

    if ( exists  $params{hmac} ) {
	$self->{hmac} = $params{hmac};
    }

    if(! exists $self->{cart_id}) {
        die 'Mandatory parameter "cart_id" not defined. $cart->cart_id(mycartid)';
    }

    if(! exists $self->{hmac}) {
        die 'Mandatory parameter "hmac" not defined. $cart->hmac(myhmac)';
    }

    my %req_params;
    $req_params{"Shopping-Cart"} = 'get';

    my $res = $self->_request(\%req_params);
    return $res;
}


#==========================================================
# remove items from cart
#==========================================================
sub remove {
    my ($self, @items) = @_;

    if(! exists $self->{cart_id}) {
        die 'Mandatory parameter "cart_id" not defined. Use $cart->cart_id(mycartid)';
    }

    if(! exists $self->{hmac}) {
        die 'Mandatory parameter "hmac" not defined. Use $cart->hmac(myhmac)';
    }

    my (%params, $remove);

    foreach my $asin (@items ){
	my $item_id = $self->{items}{$asin}{item_id};
	next unless $item_id;
	$params{"Item.$item_id"} = 0;
    }

    $params{ShoppingCart} = 'remove';
    my $res = $self->_request(\%params);

    return $res;
}


#==========================================================
# empty the cart
#==========================================================
sub clear {
    my $self = shift;

    if(! exists $self->{cart_id}) {
        die 'Mandatory parameter "cart_id" not defined. Use $cart->cart_id(mycartid)';
    }

    if(! exists $self->{hmac}) {
        die 'Mandatory parameter "hmac" not defined. Use $cart->hmac(myhmac)';
    }

    my (%params, $remove);

    $params{ShoppingCart} = 'clear';
    my $res = $self->_request(\%params);

    return $res;
}




#==========================================================
# change quantities
#==========================================================
sub modify {
    my ($self, %items) = @_;

    unless ( exists $self->{cart_id} && exists $self->{hmac} ){
	die "Cannot modify non-existent cart (i.e. that has no cart_id or hmac)";
    }

    my (@remove_items, %params, $modify, $remove, $res);


    foreach my $asin (keys %items ){
	# If the quantity is set to 0, we'll remove the item
	if ($items{$asin} == 0) {
	    push @remove_items, $asin;
	    $remove = 1;

	} elsif  (exists $self->{items}{$asin} ){
	    my $item_id = $self->{items}{$asin}{item_id};
	    $params{"Item.$item_id"} = $items{$asin};
	    $modify = 1;
	}
    }

    if ( $remove ){
	$res = $self->remove(@remove_items);
 	return $res unless $res->status;
    }

    if ( $modify ){
	$params{ShoppingCart} = 'modify';
	$res = $self->_request(\%params);
 	#return $res unless $res->status;
	#$res->status || die "Failed to modify items in cart: ", join(", ", @{$res->messages}), "\n";
    }
    return $res;

}



#===========================================================
# put stuff in the cart
#===========================================================
sub add {
    my ($self, %items) = @_;

    my (%modify_items, %params, $modify, $add, $res);


    foreach my $asin (keys %items ){
	# If the item was already in the cart, increase the quantity by the requested num
	if ($self->{items}{$asin} ){
	    $modify_items{$asin} = $items{$asin} + $self->{items}{$asin}{quantity};
	    $modify = 1;
	} else {
	    $params{"Asin.$asin"} = $items{$asin};
	    $add = 1;
	}
    }

    if ( $modify ){
	$res = $self->modify(%modify_items);
 	return $res unless $res->status;
    }

    if ( $add ){

	$params{ShoppingCart} = 'add';
	$res = $self->_request(\%params);
 	return $res unless $res->status;
	#$res->status || die "Failed to add items to cart: ", join(", ", @{$res->messages}), "\n";
    }

    return $res;
}




#=================================================
# return an array ref of hashrefs containing
# data about the cart items
#=================================================
sub get_items {
    my $self = shift;
    my @items = values %{$self->{items}};
    return \@items;
}



#===============================================
# First update the cart data from Amzn
# return an array ref of hashrefs containing
# data about the cart items
#===============================================
sub get_items_online {
    my $self = shift;
    $self->sync;
    my @items = values %{$self->{items}};
    return \@items;
}



#=================================================
# Get a hashref of data for a single item
# based on its ASIN
#=================================================
sub get_item {
    my ($self, $asin) = @_;
    return $self->{items}{$asin};
}





#===========================================================
# calculate the total cost of the items in the cart
#===========================================================
sub total_cost {
    my $self = shift;

    return $self->{total_cost} if exists $self->{total_cost};

    my $items = $self->get_items();
    # Assume it's impossible to have more than one currency in the same cart
    my $currency ;
    my $total = 0;
    foreach ( @{ $items } ){
	my $val;
	($currency, $val) = split /\s+/, $_->{our_price};
	$total += $_->{quantity} * $val;
    }

    # format the total val based on currency
    unless ($currency eq 'JPY'){
	$total = sprintf ("%.2f", $total);
    }
    return "$currency $total";
}



#===========================================================
# Get the total cost of the items in the cart, formatted
# for HTML display
#===========================================================
sub total_cost_fmt {
    my $self = shift;

    return $self->{total_cost_fmt} if exists $self->{total_cost_fmt};

    return _price_format($self->total_cost());
}



#==========================================================
# fixes decimals based on currency and changes curency to
# HTML compatible symbol
#==========================================================
sub _price_format {
    my $str = shift;

    return unless defined $str;

    my ($currency, $val) = split /\s+/, $str;

    # format the total val based on currency
    unless ($currency eq 'JPY'){
	$val = sprintf ("%.2f", $val);
    }

    # Format the currency
    if ($currency eq 'USD') {
	$currency = '$';
    } elsif ($currency eq 'GBP'){
	$currency = '£';
    } elsif ($currency eq 'EUR'){
	$currency = '&euro';
    } elsif ($currency eq 'JPY'){
	$currency = '¥';
    } else {
	$currency = "$currency ";
    }

  return "$currency$val";

}




##################################################
# Slightly altered version of the request method in Amazon.pm
sub _request {
##################################################
    my($self, $params) = @_;

    my $url  = URI->new($self->intl_url(Net::Amazon::Request::amzn_xml_url()));

    my $ref;
    my $res = Net::Amazon::Response->new();

    {
       #$params->{locale} = $self->{locale} if $self->{locale};

	# Add the cart_id and hmac if they exist, meaning this isn't the first
	# request for this cart object
	$params->{CartId} = $self->{cart_id} if exists $self->{cart_id};
	$params->{Hmac} = $self->{hmac} if exists $self->{hmac};

	# The f and sims params are always req'd so let's put em in here
	$params->{f} = 'xml';
	$params->{sims} =  'true';

        $url->query_form(
            'dev-t' => $self->{token},
            't'     => $self->{affiliate_id},
            %$params,
        );

        my $urlstr = $url->as_string;

        DEBUG(sub { "URL string [ " . $urlstr . "]" });

        my $xml = $self->fetch_url($urlstr, $res);

        if(!defined $xml) {
            return $res;
        }

        DEBUG(sub { "Received [ " . $xml . "]" });

        my $xs = XML::Simple->new();
        $ref = $xs->XMLin($xml);

        DEBUG(sub { Data::Dumper::Dumper($ref) });

        if(! defined $ref) {
            ERROR("Invalid XML");
            $res->messages( [ "Invalid XML" ]);
            $res->status("");
            return $res;
        }

        if(exists $ref->{ErrorMsg}) {

	    if (ref($ref->{ErrorMsg}) eq "ARRAY") {
	      # multiple errors, set arrary ref
	      $res->messages( $ref->{ErrorMsg} );
	    } else {
	      # single error, create array
	      $res->messages( [ $ref->{ErrorMsg} ] );
            }
            ERROR("Fetch Error: " . $res->message );
            $res->status("");
            return $res;
        }

	# Update the cart data based on the returned xml
	$self->_update_cart_data($ref);

        # We're gonna fall out of this loop here.
    }

    $res->status(1);
    return $res;
}



#===========================================================
# reload the data returned from an Amazon request into
# the cart obj
#===========================================================
sub _update_cart_data {
    my ($self, $xmlref) = @_;

    $self->{xmlref} = $xmlref;
    $self->{cart_id} = $xmlref->{ShoppingCart}{CartId};
    $self->{hmac} = $xmlref->{ShoppingCart}{HMAC};
    $self->{purchase_url} = $xmlref->{ShoppingCart}{PurchaseUrl};
    $self->{similar_products} = $xmlref->{ShoppingCart}{SimilarProducts}{Product}; #yeah, really

    my $items = {};
    my @items;

    # If there is only one item, {ShoppingCart}{Items}{Item} will be
    # a hash. If more than one, it will be an array ref. We always want
    # an array.
    if ( ref $xmlref->{ShoppingCart}{Items}{Item} eq 'ARRAY' ){
	@items = @{ $xmlref->{ShoppingCart}{Items}{Item} };
    }else{
	$items[0] = $xmlref->{ShoppingCart}{Items}{Item};
    }

    foreach my $item (@items) {
	my $asin = $item->{Asin} or next;

	if ( exists $items->{$asin} ) {
	    $items->{$asin}{quantity} += $item->{Quantity};
	} else {
	    $items->{$asin} = {
		asin => $item->{Asin},
		quantity => $item->{Quantity},
		item_id => $item->{ItemId},
		product_name => $item->{ProductName},
		merchant_sku => $item->{MerchantSku}, # Haven't yet seen this param for real
		list_price => $item->{ListPrice},
		list_price_fmt => &_price_format($item->{ListPrice}),
		our_price => $item->{OurPrice},
		our_price_fmt => &_price_format($item->{OurPrice}),
	    };
	}
    }

    $self->{items} = $items;
    $self->{total_cost} = $self->total_cost();
    $self->{total_cost_fmt} = &_price_format($self->{total_cost});
}



1;

__END__