Customer SDK for Android

repositories {
    mavenCentral()
    maven { url 'https://oss.sonatype.org/content/groups/public' }
}

dependencies {
    compile 'com.bringg:ordertrack:1.+'
}

public void onConnect();
public void onDisconnect();
public void onError(String message);
public void onAck(String event, boolean success, String error);

public BringgClient(Context context, RealTimeConnectionCallback connectionCallback, String devAccessToken, String merchantId)

/**
* connects the client to bringg real time servers.
* if in the middle of establishing a connection or is already connected - this does nothing.
*/
public void connect()
  
/**
* connects the client to bringg real time servers.
* if in the middle of establishing a connection or is already connected - this does nothing.
* used for signed-in customer usage.
*/
public void connect(String customer_access_token)

/**
* disconnects the client from real-time servers.
*/
public void disconnect()

/**
* subscribe to events on the order with the provided id.
* @param uuid - the uuid of the order we want to watch.
* @param orderStatusListener - the event handler for order update events.
* @throws RuntimeException if the uuid is null.
*/
public void watchOrder(String uuid, OrderStatusListener orderStatusListener)
  
  /**
* subscribe to events on the order with the provided id.
* @param orderUuid - the uuid of the order we want to watch.
* @param shareUuid - the uuid of the shared location associated with the order.
* @param orderStatusListener - the event handler for order update events.
* @throws RuntimeException if either of the uuids are null.
*/
public void watchOrder(String orderUuid, String shareUuid, OrderStatusListener orderStatusListener)

/**
* subscribe to events on the driver with the provided uuid.
* this method is for anonymous usage.
* @param driverUuid the uuid of the driver we want to watch.
* @param sharedUuid the uuid of the shared location object associated with the order.
* @param driverLocationListener the event handler for driver update events.
*/
public void watchDriver(String driverUuid, String sharedUuid, DriverLocationListener driverLocationListener)
  
/**
* subscribe to events on the driver with the provided uuid.
* this method is for signed in usage.
* @param driverUuid the uuid of the driver we want to watch.
* @param driverLocationListener the event handler for driver update events.
*/
public void watchDriver(String driverUuid, DriverLocationListener driverLocationListener)

/**
* subscribe to events on waypoint, mainly eta changes. 
*/
public void watchWayPoint(String orderUuid, long wayPointId, WayPointStatusListener wayPointStatusListener)

/**
* return true if in the current connection instance the client has asked to watch a driver.
*/
public boolean isWatchingDrivers()

/**
* return true if in the current connection instance the client has asked to watch an order.
*/
public boolean isWatchingOrders()

/**
* return true if client has been asked to watch waypoint
*/
public boolean isWatchingWayPoint()

/**
* @param rating (1-5)
* @param callback will be called on rating succes or failure.
*/
public void rate(int rating, OrderRateListener callback) throws IOException

public void onConnect();
public void onDisconnect();
public void onError(String message);
public void onAck(String event, boolean success, String error);

public void onOrderAssigned(Order order);
public void onOrderAccepted(Order order);
public void onOrderStarted(Order order);
public void onOrderArrived(Order order);
public void onOrderDone();
public void onOrderCanceled();

public void onLocationChanged(double lat, double lng);

import android.app.Activity;
import android.os.AsyncTask;
import android.os.Bundle;
import android.util.Log;

import com.bringg.ordertrack.callbacks.RealTimeConnectionCallback;
import com.bringg.ordertrack.event_listeners.DriverLocationListener;
import com.bringg.ordertrack.event_listeners.OrderStatusListener;
import com.bringg.ordertrack.http.BringgCustomerManager;

import org.json.JSONObject;

import java.io.IOException;

/**
 * this class shows a basic example of how to use the RealTimeClient class.
 * it implements the RealTimeConnectionCallback interface so we can respond to connection events.
 * it uses two example listeners that log the related events.
 */
public class ExampleBogusActivity extends Activity implements RealTimeConnectionCallback{

    private static final String TAG = "ClientExample";

    private static final String EXAMPLE_DEV_ACCESS_TOKEN = "aaaaa";
    private static final String EXAMPLE_UUID = "asdfg";
    private static final String EXAMPLE_SHARED_UUID = "asdfg";
    private static final String EXAMPLE_MERCHANT_ID = "-1100";


    private BringgClient bringgClient;
    private BringgCustomerManager customerManager;

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);

        // ... the usual ui stuff enters here

        // create an instance of the realTimeClient with our event handlers.
        bringgClient = new BringgClient(this, this, EXAMPLE_DEV_ACCESS_TOKEN);

        // create an instance of the bringg customer manager and provide it with your dev key.
        customerManager = BringgCustomerManager.getInstance(this);
        customerManager.setCredentials(EXAMPLE_DEV_ACCESS_TOKEN, EXAMPLE_MERCHANT_ID);

        // sign in the customer to bringg if not signed in already
        signCustomerToBringgOnce();

        // connect with credentials
        if (customerManager.isSignedIn()) {
            // connect the client to the real time endpoint.
            // this call is asynchronous so we use the onConnect callback which this class implements
            // to act after connection is established.
            bringgClient.connect(customerManager.getCredentials());
        }

        // note that if we did not sing in the customer we use the connect() method again after
        // successful sign in. see the signCustomerToBringgOnce() method.
    }

    @Override
    protected void onDestroy() {
        // it is very important to disconnect the client when we are done with it
        // so it will stop using battery and network.
        bringgClient.disconnect();

        super.onDestroy();
    }

    // =============================================
    // =============================================

    private static final String EXAMPLE_CONFIRMATION_CODE = "aaa";
    private static final String EXAMPLE_CUSTOMER_PHONE = "111";

    /**
     * sign in the customer to bringg and retrieve his access token to be used later.
     */
    private void signCustomerToBringgOnce(){
        if (!customerManager.isSignedIn())
            new AsyncTask<Void, Void, JSONObject>() {
                @Override
                protected JSONObject doInBackground(Void... voids) {
                    try {
                        // sign in using the customer's phone.
                        // we could use the customer's name instead or both.
                        return customerManager.signIn(
                                EXAMPLE_CUSTOMER_PHONE, null, EXAMPLE_CONFIRMATION_CODE, String.valueOf(EXAMPLE_MERCHANT_ID));
                    } catch (IOException e){
                        e.printStackTrace();
                        // do something with exception here
                        return null;
                    }
                }

                @Override
                protected void onPostExecute(JSONObject result) {
                    if (result != null){
                        if (result.has("error")) {
                            Log.e(TAG, result.optString("error"));
                        } else if (result.has("access_token")){
                            Log.i(TAG, "sign in succeeded");
                            // connect with the access token if not already connected
                            if (!bringgClient.isConnected())
                                bringgClient.connect(result.optString("access_token"));
                        }
                    }
                }
            }.execute();
    }

    // ============================================================================
    // ============= optional callbacks for handling connection events ============


    @Override
    public void onConnect() {
        Log.i(TAG, "connected");

        // tell the client to start listening for events related to the order with the given uuid.
        // any event will be handled by the orderStatusChangedListener.
        bringgClient.watchOrder(EXAMPLE_UUID, orderListener);
    }

    @Override
    public void onDisconnect() {
        Log.i(TAG, "disconnected");
    }

    @Override
    public void onError(String message) {
        Log.e(TAG, message);
    }

    @Override
    public void onAck(String event, boolean success, String error) {
        // can check here if broadcast for the event succeeded if we received an ack.
    }


    // ==========================================================================
    // ========================== event listeners ===============================

    private DriverLocationListener driverListener = new DriverLocationListener() {
        @Override
        public void onLocationChanged(double lat, double lng) {
            Log.i(TAG, "driver location: " + lat + ", " + lng);
        }
    };

    private OrderStatusListener orderListener = new OrderStatusListener() {
        @Override
        public void onOrderAssigned(Driver driver) {
            Log.i(TAG, "order assigned");
        }

        @Override
        public void onOrderAccepted(Driver driver) {
            Log.i(TAG, "order accepted");
        }

        @Override
        public void onOrderStarted(Driver driver) {
            Log.i(TAG, "order started");

            if (driver.uuid != null){
                // tell the client to start listening for events on the driver with the given id.
                // any event will be handled by the driverLocationListener.
                bringgClient.watchDriver(driver.uuid, EXAMPLE_SHARED_UUID, driverListener);
            }
        }

        @Override
        public void onOrderArrived() {
            Log.i(TAG, "order arrived");
        }

        @Override
        public void onOrderDone() {
            Log.i(TAG, "order done");
        }

        @Override
        public void onOrderCanceled() {
            Log.i(TAG, "order canceled");
        }
    };
}