batopa / chirp

src/Chirp.php

<?php
/**
 * This file is part of Chirp package
 *
 * Copyright (c) 2015 Alberto Pagliarini
 *
 * Licensed under the MIT license
 * https://github.com/batopa/chirp/blob/master/LICENSE
 */
namespace Bato\Chirp;

use Bato\Chirp\Utility\Parser;
use MongoDB\Client;
use Abraham\TwitterOAuth\TwitterOAuth;

/**
 * Chirp Class
 *
 * Help to create a cache for Twitter using MongoDB
 *
 */
class Chirp
{

    /**
     * The Database object
     *
     * @var \MongoDB\Database
     */
    private $db = null;

    /**
     * The instance of TwitterOAuth
     *
     * @var \Abraham\TwitterOAuth\TwitterOAuth
     */
    private $twitter;

    /**
     * Constructor
     *
     * Passing $twitterAuthConf and/or $mongoConf  it tries to setup them
     *
     * $twitterAuthConf must contain
     * - consumer_key
     * - consumer_secret
     * - oauth_access_token
     * - oauth_access_token_secret
     *
     * $mongoConf must contain
     *  - db: the name of mongo database to use
     *
     *  and can contain
     * - uri
     * - uriOptions
     * - driverOptions
     *
     * used for MongoDB connection
     *
     * @see \MongoDB\Client for $mongoConf
     * @param array $twitterAuthConf
     * @param array $mongoDbConf
     */
    public function __construct(array $twitterAuthConf = array(), array $mongoDbConf = array())
    {
        if (!empty($twitterAuthConf)) {
            $this->setupTwitter($twitterAuthConf);
        }
        if (!empty($mongoDbConf)) {
            $this->setupMongoDb($mongoDbConf);
        }
    }

    /**
     * Setup TwitterOAuth
     *
     * $twitterAuthConf must contain
     * - consumer_key
     * - consumer_secret
     * - oauth_access_token
     * - oauth_access_token_secret
     *
     * @param array $twitterAuthConf
     * @return $this
     */
    public function setupTwitter(array $twitterAuthConf)
    {
        $twitterAuthConf += [
            'consumer_key' => null,
            'consumer_secret' => null,
            'oauth_access_token' => null,
            'oauth_access_token_secret' => null
        ];
        $this->twitter = new TwitterOAuth(
            $twitterAuthConf['consumer_key'],
            $twitterAuthConf['consumer_secret'],
            $twitterAuthConf['oauth_access_token'],
            $twitterAuthConf['oauth_access_token_secret']
        );
        $this->twitter->setDecodeJsonAsArray(true);
        return $this;
    }

    /**
     * Setup MongoDB connection
     *
     * $mongoDbConf must contain
     *  - db: the name of mongo database to use
     *
     *  and can contain
     * - uri
     * - uriOptions
     * - driverOptions
     *
     * @see \MongoDB\Client for $mongoConf
     * @param array $mongoDbConf
     * @return $this
     */
    public function setupMongoDb(array $mongoDbConf)
    {
        $mongoDbConf += [
            'uri' => 'mongodb://localhost:27017',
            'uriOptions' => [],
            'driverOptions' => [],
            'db' => ''
        ];
        $client = new Client($mongoDbConf['uri'], $mongoDbConf['uriOptions'], $mongoDbConf['driverOptions']);
        $this->db = $client->selectDatabase($mongoDbConf['db']);
        return $this;
    }

    /**
     * Return TwitterOAuth instance
     *
     * @return \Abraham\TwitterOAuth\TwitterOAuth
     */
    public function getTwitter()
    {
        if (empty($this->twitter)) {
            throw new \RuntimeException(
                'You have to setup twitter before use it. See \Bato\Chirp\Chirp::setupTwitter()'
            );
        }
        return $this->twitter;
    }

    /**
     * Return the instance of MongoDB database
     *
     * @return \MongoDB\Database
     */
    public function getDb()
    {
        if (empty($this->db)) {
            throw new \RuntimeException(
                'You have to setup MongoDB connection before use it. See \Bato\Chirp\Chirp::setupMongoDb()'
            );
        }
        return $this->db;
    }

    /**
     * Starting from twitter endpoint return the related collection
     * It replaces "/" with "-" after removing trailing "/", for example:
     *
     * endpoint "statuses/user_timeline" corresponds to "statuses-user_timeline" collection
     *
     * @param string $endpoint [description]
     * @return \MongoDB\Collection
     */
    public function getCollection($endpoint)
    {
        $name = Parser::normalize($endpoint);
        return $this->getDb()
            ->selectCollection($name);
    }

    /**
     * Perform a Twitter request
     *
     * @param string $endpoint the endpoint for example 'statuses/user_timeline'
     * @param array $query an array that specify query string to use with the endpoint
     * @param string $requestMethod the http request method
     * @return array
     */
    public function request($endpoint, $query = [], $requestMethod = 'get')
    {
        $validMethods = ['get', 'post', 'put', 'delete'];
        $requestMethod = strtolower($requestMethod);
        if (!in_array($requestMethod, $validMethods)) {
            throw new \UnexpectedValueException('Unsupported http request method ' . $requestMethod);
        }
        $response = $this->getTwitter()
            ->{$requestMethod}($endpoint, $query);

        return $response;
    }

    /**
     * Read results from a collection (default self::collection)
     * using $filter to filter results
     *
     * If $options['limit'] = 1 return a \MongoDB\BSONDocument object
     * else return an array or a cursor depending from $options['returnType']
     *
     * @param string $endpoint
     * @param array $filter
     * @param array $options
     * @return object|array
     */
    public function read($endpoint, array $filter = [], array $options = [])
    {
        $options += ['returnType' => 'array'];
        $collection = $this->getCollection($endpoint);
        // delegate to MongoDB\Collection::findOne()
        if (isset($options['limit']) && $options['limit'] === 1) {
            return $collection->findOne($filter, $options);
        }
        $cursor = $collection->find($filter, $options);
        return ($options['returnType'] == 'array') ? iterator_to_array($cursor) : $cursor;
    }

    /**
     * Perform twitter request and save results in db.
     *
     * Possible $options are:
     * - query: an array used for compose query string
     * - grep: an array used for look up. Results matching the grep criteria will be saved.
     *         Example
     *         ```
     *         [
     *             'key_to_look_up' => ['match1', 'match2'],
     *             'other_key_to_look_up' => ['match3']
     *         ]
     *         ```
     * - require: an array of string of keys required.
     *            Only results with those fields will be saved.
     *            Use point separtated string to go deep in results, for example
     *            `'key1.key2.key3'` checks against`[ 'key1' => ['key2' => ['key3' => 'some_value']]] `
     *
     * @param string $endpoint the twitter endpoint for example 'statuses/user_timeline'
     * @param array $options
     * @return array
     */
    public function write($endpoint, array $options = [])
    {
        $options = $this->prepareWriteOptions($options);
        $response = $this->request($endpoint, $options['query']);
        if (empty($response)) {
            return ['saved' => [], 'read'=> []];
        }

        if (array_key_exists('errors', $response)) {
            return $response;
        }

        $collection = $this->getCollection($endpoint);
        $tweets = $this->filterToSave($response, $collection, $options);
        if (!empty($tweets)) {
            $collection->insertMany($tweets);
        }

        return [
            'saved' => $tweets,
            'read'=> $response
        ];
    }

    /**
     * Check and return $options to be used in self::write()
     *
     * @param array $options
     * @return array
     */
    private function prepareWriteOptions($options)
    {
        $options += [
            'query' => [],
            'grep' => [],
            'require' => []
        ];
        foreach (['query', 'grep', 'require'] as $test) {
            if (!is_array($options[$test])) {
                throw new \UnexpectedValueException('"' . $test . '" option must be an array');
            }
        }
        $options['query'] = array_filter($options['query']);
        return $options;
    }

    /**
     * Given an array of tweets and a collection
     * return the tweets that missing from the collection
     *
     * @see self::write() for $options
     * @param array $tweets
     * @param \MongoDB\Collection $collection
     * @param array $options
     * @return array
     */
    private function filterToSave(array $tweets, \MongoDB\Collection $collection, array $options)
    {
        $toSave = [];
        foreach ($tweets as $key => $tweet) {
            if (!Parser::match($tweet, $options)) {
                continue;
            }

            $countTweets = $collection->count(['id_str' => $tweet['id_str']]);

The method MongoDB\Collection::count() has been deprecated with message: 1.4

            if ($countTweets === 0) {
                $toSave[] = $tweet;
            }
        }
        return $toSave;
    }
}