001/**
002 * Copyright (c) 2012, The University of Southampton and the individual contributors.
003 * All rights reserved.
004 *
005 * Redistribution and use in source and binary forms, with or without modification,
006 * are permitted provided that the following conditions are met:
007 *
008 *   *  Redistributions of source code must retain the above copyright notice,
009 *      this list of conditions and the following disclaimer.
010 *
011 *   *  Redistributions in binary form must reproduce the above copyright notice,
012 *      this list of conditions and the following disclaimer in the documentation
013 *      and/or other materials provided with the distribution.
014 *
015 *   *  Neither the name of the University of Southampton nor the names of its
016 *      contributors may be used to endorse or promote products derived from this
017 *      software without specific prior written permission.
018 *
019 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
020 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
021 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
022 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
023 * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
024 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
025 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
026 * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
027 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
028 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
029 */
030package org.openimaj.twitter.utils;
031
032import org.apache.log4j.Logger;
033import org.openimaj.util.api.auth.DefaultTokenFactory;
034import org.openimaj.util.api.auth.common.TwitterAPIToken;
035
036import twitter4j.Twitter;
037import twitter4j.TwitterException;
038import twitter4j.TwitterFactory;
039import twitter4j.conf.Configuration;
040import twitter4j.conf.ConfigurationBuilder;
041
042/**
043 * Create a Twitter4j instance
044 * 
045 * @author Sina Samangooei (ss@ecs.soton.ac.uk)
046 */
047public class Twitter4jUtil {
048
049        private static Logger logger = Logger.getLogger(Twitter4jUtil.class);
050
051        /**
052         * @return create a {@link Twitter} instance using the tokens from
053         *         {@link DefaultTokenFactory}
054         */
055        public static Twitter create() {
056                Twitter INSTANCE = null;
057                if (INSTANCE == null) {
058                        final Configuration config = makeConfiguration(DefaultTokenFactory.get(TwitterAPIToken.class));
059                        INSTANCE = new TwitterFactory(config).getInstance();
060                }
061                return INSTANCE;
062        }
063
064        private static Configuration makeConfiguration(TwitterAPIToken token) {
065                final ConfigurationBuilder cb = new ConfigurationBuilder()
066                                .setOAuthConsumerKey(token.consumerKey)
067                                .setOAuthConsumerSecret(token.consumerSecret)
068                                .setOAuthAccessToken(token.accessToken)
069                                .setOAuthAccessTokenSecret(token.accessSecret);
070                cb.setJSONStoreEnabled(true);
071
072                return cb.build();
073        }
074
075        /**
076         * Handle a twitter exception, waiting the appropriate amount of time if the
077         * API requests this behaviour
078         * 
079         * @param e
080         * @param errorWaitTime
081         * @return the errorWaitTime
082         */
083        public static long handleTwitterException(TwitterException e, long errorWaitTime) {
084                if (e.exceededRateLimitation()) {
085                        long retryAfter = e.getRetryAfter() * 1000;
086                        logger.debug(String.format("Rate limit exceeded, waiting %dms", retryAfter));
087                        if (retryAfter < 0) {
088                                retryAfter = errorWaitTime * 5;
089                        }
090                        return retryAfter;
091
092                } else {
093                        logger.error("Twitter Exception!", e);
094                        logger.error("Waiting a short period of time");
095                        return errorWaitTime;
096                }
097        }
098}