common/auction_events.h

/* auction_events.h                                                -*- C++ -*-
   Jeremy Barnes, 30 May 2012
   Copyright (c) 2012 Datacratic.  All rights reserved.

   PAuctionEvent and related classes
*/


#pragma once

#include "jml/db/persistent.h"
#include "soa/types/date.h"
#include "soa/types/id.h"

#include "bids.h"
#include "account_key.h"
#include "auction.h"
#include "bid_request.h"
#include "currency.h"
#include "json_holder.h"


namespace RTBKIT {

/*****************************************************************************/
/* SUBMITTED AUCTION EVENT                                                   */
/*****************************************************************************/

struct SubmittedAuctionEvent {
    Id auctionId;                  
    Id adSpotId;                   
    Date lossTimeout;              
    JsonHolder augmentations;      
    std::shared_ptr<BidRequest> bidRequest;  
    std::string bidRequestStr;     
    Auction::Response bidResponse; 
    std::string bidRequestStrFormat;  

    void serialize(ML::DB::Store_Writer & store) const;
    void reconstitute(ML::DB::Store_Reader & store);
};


/*****************************************************************************/
/* POST AUCTION EVENT TYPE                                                   */
/*****************************************************************************/

enum PostAuctionEventType {
    PAE_INVALID,
    PAE_WIN,
    PAE_LOSS,
    PAE_CAMPAIGN_EVENT
};

const char * print(PostAuctionEventType type);

COMPACT_PERSISTENT_ENUM_DECL(PostAuctionEventType);


/*****************************************************************************/
/* POST AUCTION EVENT                                                        */
/*****************************************************************************/

struct PostAuctionEvent {
    PostAuctionEvent();
    PostAuctionEvent(Json::Value const & json);

    PostAuctionEventType type;
    std::string label; /* for campaign events */
    Datacratic::Id auctionId;
    Datacratic::Id adSpotId;
    Datacratic::Date timestamp;
    JsonHolder metadata;
    AccountKey account;
    Amount winPrice;
    UserIds uids;
    SegmentList channels;
    Date bidTimestamp;

    Json::Value toJson() const;

    void serialize(ML::DB::Store_Writer & store) const;
    void reconstitute(ML::DB::Store_Reader & store);

    std::string print() const;
};

std::ostream &
operator << (std::ostream & stream, const PostAuctionEvent & event);

ML::DB::Store_Writer & operator
    << (ML::DB::Store_Writer & store,
        std::shared_ptr<PostAuctionEvent> event);
ML::DB::Store_Reader & operator
    >> (ML::DB::Store_Reader & store,
        std::shared_ptr<PostAuctionEvent> & event);


/******************************************************************************/
/* CAMPAIGN EVENTS                                                            */
/******************************************************************************/

struct CampaignEvent
{
    CampaignEvent(const std::string & label = "", Date time = Date(),
            const JsonHolder & meta = JsonHolder())
        : label_(label), time_(time), meta_(meta)
    {}

    Json::Value toJson() const;
    static CampaignEvent fromJson(const Json::Value & jsonValue);

    void serialize(ML::DB::Store_Writer & store) const;
    void reconstitute(ML::DB::Store_Reader & store);

    std::string label_;
    Date time_;
    JsonHolder meta_;
};


struct CampaignEvents : public std::vector<CampaignEvent>
{
    bool hasEvent(const std::string & label) const;
    void setEvent(const std::string & label,
                          Date eventTime,
                          const JsonHolder & eventMeta);

    Json::Value toJson() const;
    static CampaignEvents fromJson(const Json::Value&);
};


/******************************************************************************/
/* DELIVERY EVENTS                                                            */
/******************************************************************************/

struct DeliveryEvent
{
    std::string event;
    Date timestamp;

    Id auctionId;
    Id spotId;
    int spotIndex;

    std::shared_ptr<BidRequest> bidRequest;
    std::string augmentations;


    // \todo Annoyingly similar but cleaner version of Auction::Response
    struct Bid
    {
        Bid() : present(false) {}
        bool present;

        Date time;                    

        // Information about the actual bid
        Auction::Price price;     
        int tagId;                
        AccountKey account;       
        bool test;                

        // Information about the agent who did the bidding
        std::string agent;        
        Bids bids;                
        std::string meta;         


        int creativeId;           
        std::string creativeName; 

        // Information about the status of the bid (what happened to it)
        Auction::WinLoss localStatus; 

        static Bid fromJson(const Json::Value&);
        Json::Value toJson() const;
    } bid;


    struct Win
    {
        Win() : present(false) {}
        bool present;

        Date time;                
        BidStatus reportedStatus; 
        Amount price;             
        std::string meta;         

        static Win fromJson(const Json::Value&);
        Json::Value toJson() const;
    } win;


    CampaignEvents campaignEvents;

    Json::Value impressionToJson() const;
    Json::Value clickToJson() const;


    struct Visit
    {
        Date time;            
        SegmentList channels; 
        std::string meta;     

        static Visit fromJson(const Json::Value&);
        Json::Value toJson() const;
    };

    std::vector<Visit> visits;
    Json::Value visitsToJson() const;

    static DeliveryEvent parse(const std::vector<std::string>&);
};


} // namespace RTBKIT