NaturalHistoryMuseum / ckanext-twitter / 75

pending completion

Build # 75

Build Type

Pull #8

travis-ci-com

Committed by

web-flow

Commit Message

<a href="https://github.com/NaturalHistoryMuseum/ckanext-twitter/commit/<a class=hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/<a class="double-link" href="https://git"><a class=hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/<a class="double-link" href="https://git"><a class=hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/<a class="double-link" href="https://git"><a class=hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/e3d01835777fd6449ac3a9712e60a07857e1fdcc">e3d018357">&lt;a href=&quot;https://github.com/NaturalHistoryMuseum/ckanext-twitter/commit/</a><a class="double-link" href="https://github.com/NaturalHistoryMuseum/ckanext-twitter/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/&lt;a class=&quot;double-link&quot; href=&quot;https://git">&lt;a class=</a>hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/e3d01835777fd6449ac3a9712e60a07857e1fdcc">e3d018357</a><a href="https://github.com/NaturalHistoryMuseum/ckanext-twitter/commit/e3d01835777fd6449ac3a9712e60a07857e1fdcc">&quot;&gt;&amp;lt;a href=&amp;quot;https://github.com/NaturalHistoryMuseum/ckanext-twitter/commit/&lt;/a&gt;&lt;a class=&quot;double-link&quot; href=&quot;https://github.com/NaturalHistoryMuseum/ckanext-twitter/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/&amp;lt;a class=&amp;quot;double-link&amp;quot; href=&amp;quot;https://git&quot;&gt;&amp;lt;a class=&lt;/a&gt;hub.com/NaturalHistoryMuseum/ckanext-twitter/commit/e3d01835777fd6449ac3a9712e60a07857e1fdcc&quot;&gt;e3d018357&lt;/a&gt;&lt;a href=&quot;https://github.com/NaturalHistoryMuseum/ckanext-twitter/commit/e3d01835777fd6449ac3a9712e60a07857e1fdcc&quot;&gt;&amp;quot;&amp;gt;&amp;amp;lt;a href=&amp;amp;quot;https://github.com/NaturalHistoryMuseum/ckanext-twitter/comm... (continued)

Pull Request Pull Request #8: CKAN 2.9.x upgrade

Run Details

80 of 80 new or added lines in 7 files covered. (100.0%)

212 of 245 relevant lines covered (86.53%)

0.87 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

76.6

/ckanext/twitter/lib/twitter_api.py

#!/usr/bin/env python
# encoding: utf-8
#
# This file is part of ckanext-twitter
# Created by the Natural History Museum in London, UK

import logging
from contextlib import suppress

import oauth2

from ckanext.twitter.lib import cache_helpers, config_helpers

logger = logging.getLogger('ckanext.twitter')


@cache_helpers.cache_manager.cache('twitter', 'client')
def twitter_client():
    '''
    Attempts to create a client for accessing the twitter API using the credentials specified in the
    configuration file. Does not test for success. Caches the resulting client in the 'twitter'
    cache.

    :return: oauth2.Client
    '''
    consumer_key, consumer_secret, token_key, token_secret = \
        config_helpers.twitter_get_credentials()
    consumer = oauth2.Consumer(consumer_key, consumer_secret)
    token = oauth2.Token(token_key, token_secret)
    client = oauth2.Client(consumer, token)
    return client


def twitter_authenticate():
    '''
    Verifies that the client is able to connect to the twitter API.
    Refreshes any unauthenticated cached client.
    :return: boolean
    '''
    authenticated = False
    while not authenticated:
        client = twitter_client()
        url = 'https://api.twitter.com/1.1/account/verify_credentials.json'
        response, content = client.request(url, 'GET')
        authenticated = response.status == 200
        if not authenticated:
            # if the client isn't in the cache we don't care
            with suppress(KeyError):
                cache_helpers.cache_manager.invalidate(twitter_client)
            break
    if authenticated:
        if any([c.startswith('no-') and c.endswith('-set') for c in
                config_helpers.twitter_get_credentials()]):
            authenticated = False
    return authenticated


def post_tweet(tweet_text, pkg_id):
    '''
    Attempts to post the tweet. Returns a boolean success variable and a
    message describing the reason for the failure/success in posting the tweet.
    :param tweet_text: The text to post. This is passed in rather than
    generated inside the method to allow users to change the tweet before
    posting (if enabled).
    :param pkg_id: The package ID (for caching).
    :return: boolean, str
    '''
    if config_helpers.twitter_is_debug():
        logger.debug(f'Not posted (debug): {tweet_text}')
        return False, 'debug'

    # if not enough time has passed since the last tweet
    if not cache_helpers.expired(pkg_id):
        logger.debug(f'Not posted (insufficient rest period): {tweet_text}')
        return False, 'insufficient rest period'

    # if we can't authenticate
    if not twitter_authenticate():
        logger.debug(f'Not posted (not authenticated): {tweet_text}')
        return False, 'not authenticated'

    # try to actually post
    client = twitter_client()
    url = 'https://api.twitter.com/1.1/statuses/update.json'
    params = {
        'status': tweet_text
    }
    request = oauth2.Request(method='POST', url=url, parameters=params)
    postdata = request.to_postdata()
    response, content = client.request(url, 'POST', postdata)
    if response.status == 200:
        cache_helpers.cache(pkg_id)
        logger.debug(f'Posted successfully: {tweet_text}')
    else:
        logger.debug(f'Not posted (tweet unsuccessful): {tweet_text}')
    return response.status == 200, f'{response.status} {response.reason}'

1	#!/usr/bin/env python
2	# encoding: utf-8
3	#
4	# This file is part of ckanext-twitter
5	# Created by the Natural History Museum in London, UK
6
7	import logging	1✔
8	from contextlib import suppress	1✔
9
10	import oauth2	1✔
11
12	from ckanext.twitter.lib import cache_helpers, config_helpers	1✔
13
14	logger = logging.getLogger('ckanext.twitter')	1✔
15
16
17	@cache_helpers.cache_manager.cache('twitter', 'client')	1✔
18	def twitter_client():
19	'''
20	Attempts to create a client for accessing the twitter API using the credentials specified in the
21	configuration file. Does not test for success. Caches the resulting client in the 'twitter'
22	cache.
23
24	:return: oauth2.Client
25	'''
26	consumer_key, consumer_secret, token_key, token_secret = \	1✔
27	config_helpers.twitter_get_credentials()
28	consumer = oauth2.Consumer(consumer_key, consumer_secret)	1✔
29	token = oauth2.Token(token_key, token_secret)	1✔
30	client = oauth2.Client(consumer, token)	1✔
31	return client	1✔
32
33
34	def twitter_authenticate():	1✔
35	'''
36	Verifies that the client is able to connect to the twitter API.
37	Refreshes any unauthenticated cached client.
38	:return: boolean
39	'''
40	authenticated = False	1✔
41	while not authenticated:	1✔
42	client = twitter_client()	1✔
43	url = 'https://api.twitter.com/1.1/account/verify_credentials.json'	1✔
44	response, content = client.request(url, 'GET')	1✔
45	authenticated = response.status == 200	1✔
46	if not authenticated:	1✔
47	# if the client isn't in the cache we don't care
48	with suppress(KeyError):	1✔
49	cache_helpers.cache_manager.invalidate(twitter_client)	1✔
50	break	1✔
51	if authenticated:	1✔
52	if any([c.startswith('no-') and c.endswith('-set') for c in	1✔
53	config_helpers.twitter_get_credentials()]):
54	authenticated = False	1✔
55	return authenticated	1✔
56
57
58	def post_tweet(tweet_text, pkg_id):	1✔
59	'''
60	Attempts to post the tweet. Returns a boolean success variable and a
61	message describing the reason for the failure/success in posting the tweet.
62	:param tweet_text: The text to post. This is passed in rather than
63	generated inside the method to allow users to change the tweet before
64	posting (if enabled).
65	:param pkg_id: The package ID (for caching).
66	:return: boolean, str
67	'''
68	if config_helpers.twitter_is_debug():	1✔
69	logger.debug(f'Not posted (debug): {tweet_text}')	1✔
70	return False, 'debug'	1✔
71
72	# if not enough time has passed since the last tweet
73	if not cache_helpers.expired(pkg_id):	1✔
74	logger.debug(f'Not posted (insufficient rest period): {tweet_text}')	1✔
75	return False, 'insufficient rest period'	1✔
76
77	# if we can't authenticate
78	if not twitter_authenticate():	1✔
79	logger.debug(f'Not posted (not authenticated): {tweet_text}')	1✔
80	return False, 'not authenticated'	1✔
81
82	# try to actually post
83	client = twitter_client()	×
84	url = 'https://api.twitter.com/1.1/statuses/update.json'	×
85	params = {	×
86	'status': tweet_text
87	}
88	request = oauth2.Request(method='POST', url=url, parameters=params)	×
89	postdata = request.to_postdata()	×
90	response, content = client.request(url, 'POST', postdata)	×
91	if response.status == 200:	×
92	cache_helpers.cache(pkg_id)	×
93	logger.debug(f'Posted successfully: {tweet_text}')	×
94	else:
95	logger.debug(f'Not posted (tweet unsuccessful): {tweet_text}')	×
96	return response.status == 200, f'{response.status} {response.reason}'	×

NaturalHistoryMuseum / ckanext-twitter / 75

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous