adpay.iface package

This package provides web interface functionality.

The responsibility break down is:

  • adpay.iface.consts is the module hosting configuration
  • adpay.iface.proto provides JSON object validation for input and output
  • adpay.iface.server provides JSON-RPC server functionality
  • adpay.iface.utils provides main, “controller” logic

adpay.iface.server module

class adpay.iface.server.AdPayIfaceServer[source]

Bases: fastjsonrpc.server.JSONRPCServer

JSON-RPC endpoint.

jsonrpc_add_events(**kwargs)[source]

JSON-RPC add_events method handler.

Parameters:events – Variable number of events.
Returns:True
jsonrpc_campaign_delete(**kwargs)[source]

JSON-RPC campaign_delete method handler.

Parameters:campaign_ids – Variable number of campaign identifiers.
Returns:True
jsonrpc_campaign_update(**kwargs)[source]

JSON-RPC campaign_update method handler.

Parameters:campaigns – Variable number of campaigns.
Returns:True
jsonrpc_debug_force_payment_recalculation(**kwargs)[source]

Force payments recalculation.

Returns:True or False (if disabled)
jsonrpc_get_payments(**kwargs)[source]

JSON-RPC get_payments method handler

Return payments for events from 1hour started before timestamp.

Parameters:payment_request – Payment request
Returns:Response in JSON.
adpay.iface.server.configure_iface(port=8012, host='127.0.0.1')[source]

Set up Twisted reactor to listen on TCP.

Parameters:port – Listening port.
Returns:Listening reactor.

adpay.iface.utils module

exception adpay.iface.utils.PaymentsNotCalculatedException[source]

Bases: exceptions.Exception

adpay.iface.utils.add_event(*args, **kwargs)[source]

Insert (create or update) event object into the database.

Update keywords and view statistics (for user value method)

Parameters:eventobj – Event object
Returns:
adpay.iface.utils.create_or_update_campaign(*args, **kwargs)[source]

Create or update campaign. Removes old banners and adds new ones.

Parameters:cmpobj –
Returns:
adpay.iface.utils.delete_campaign(*args, **kwargs)[source]

Remove campaign.

Parameters:campaign_id –
Returns:
adpay.iface.utils.get_payments(*args, **kwargs)[source]

Fetch the payments from the database.

May raise a PaymentsNotCalculatedException if payments are not ready yet.

Parameters:pay_request – Payment request.
Returns:List of payments.