InstagramAbstractProvider.java

/*
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance *
http://www.apache.org/licenses/LICENSE-2.0 *
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License. */

package org.apache.streams.instagram.provider;

import org.apache.streams.config.ComponentConfigurator;
import org.apache.streams.config.StreamsConfigurator;
import org.apache.streams.core.StreamsDatum;
import org.apache.streams.core.StreamsProvider;
import org.apache.streams.core.StreamsResultSet;
import org.apache.streams.instagram.api.Instagram;
import org.apache.streams.instagram.config.InstagramConfiguration;
import org.apache.streams.util.ComponentUtils;
import org.apache.streams.util.SerializationUtil;

import com.google.common.util.concurrent.Futures;
import com.google.common.util.concurrent.ListenableFuture;
import com.google.common.util.concurrent.ListeningExecutorService;
import com.google.common.util.concurrent.MoreExecutors;
import org.joda.time.DateTime;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import java.math.BigInteger;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Queue;
import java.util.Set;
import java.util.concurrent.ConcurrentLinkedQueue;
import java.util.concurrent.Executors;
import java.util.concurrent.atomic.AtomicBoolean;

/**
 * Instagram {@link org.apache.streams.core.StreamsProvider} that provides Instagram data for a group of users
 */
public abstract class InstagramAbstractProvider implements StreamsProvider {

  public static final String STREAMS_ID = "InstagramAbstractProvider";

  private static final Logger LOGGER = LoggerFactory.getLogger(InstagramAbstractProvider.class);

  private static final int MAX_BATCH_SIZE = 2000;

  protected InstagramConfiguration config;

  protected Instagram client;

  protected Queue<StreamsDatum> dataQueue;
  private ListeningExecutorService executorService;


  private List<ListenableFuture<Object>> futures = new ArrayList<>();

  private AtomicBoolean isCompleted;

  public InstagramAbstractProvider() {
    this.config = new ComponentConfigurator<>(InstagramConfiguration.class)
        .detectConfiguration(StreamsConfigurator.getConfig().getConfig("instagram"));
  }

  public InstagramAbstractProvider(InstagramConfiguration config) {
    this.config = SerializationUtil.cloneBySerialization(config);
  }

  @Override
  public String getId() {
    return STREAMS_ID;
  }

  @Override
  public void startStream() {
    InstagramDataCollector dataCollector = getInstagramDataCollector();
    this.executorService = MoreExecutors.listeningDecorator(Executors.newSingleThreadExecutor());
    ListenableFuture future = this.executorService.submit(dataCollector);
    this.futures.add(future);
    executorService.shutdown();
  }

  /**
   * Return the data collector to use to connect to instagram.
   * @return {@link InstagramDataCollector}
   */
  protected abstract InstagramDataCollector getInstagramDataCollector();


  @Override
  public StreamsResultSet readCurrent() {
    Queue<StreamsDatum> batch = new ConcurrentLinkedQueue<>();
    int count = 0;
    while (!this.dataQueue.isEmpty() && count < MAX_BATCH_SIZE) {
      ComponentUtils.offerUntilSuccess(ComponentUtils.pollWhileNotEmpty(this.dataQueue), batch);
      ++count;
    }
    return new StreamsResultSet(batch);
  }

  @Override
  public StreamsResultSet readNew(BigInteger sequence) {
    return null;
  }

  @Override
  public StreamsResultSet readRange(DateTime start, DateTime end) {
    return null;
  }

  @Override
  public void prepare(Object configurationObject) {
    this.dataQueue = new ConcurrentLinkedQueue<>();
    this.isCompleted = new AtomicBoolean(false);

    Objects.requireNonNull(config);
    Objects.requireNonNull(config.getOauth());
    Objects.requireNonNull(config.getOauth().getClientId());
    Objects.requireNonNull(config.getOauth().getClientSecret());
    Objects.requireNonNull(config.getOauth().getAccessToken());
    Objects.requireNonNull(config.getThreadsPerProvider());

    try {
      client = Instagram.getInstance(this.config);
    } catch (InstantiationException ex) {
      LOGGER.error("InstantiationException", ex);
    }

    Objects.requireNonNull(client);

  }

  @Override
  public void cleanUp() {
    try {
      ComponentUtils.shutdownExecutor(this.executorService, 5, 5);
    } finally {
      this.executorService = null;
    }
  }

  @Override
  public boolean isRunning() {
    if (dataQueue.isEmpty() && executorService.isTerminated() && Futures.allAsList(futures).isDone()) {
      LOGGER.info("Completed");
      isCompleted.set(true);
      LOGGER.info("Exiting");
    }
    return !isCompleted.get();
  }

}