summaryrefslogtreecommitdiff
path: root/addons/website_twitter/models
diff options
context:
space:
mode:
authorstephanchrst <stephanchrst@gmail.com>2022-05-10 21:51:50 +0700
committerstephanchrst <stephanchrst@gmail.com>2022-05-10 21:51:50 +0700
commit3751379f1e9a4c215fb6eb898b4ccc67659b9ace (patch)
treea44932296ef4a9b71d5f010906253d8c53727726 /addons/website_twitter/models
parent0a15094050bfde69a06d6eff798e9a8ddf2b8c21 (diff)
initial commit 2
Diffstat (limited to 'addons/website_twitter/models')
-rw-r--r--addons/website_twitter/models/__init__.py6
-rw-r--r--addons/website_twitter/models/res_config_settings.py84
-rw-r--r--addons/website_twitter/models/website_twitter.py89
-rw-r--r--addons/website_twitter/models/website_twitter_tweet.py19
4 files changed, 198 insertions, 0 deletions
diff --git a/addons/website_twitter/models/__init__.py b/addons/website_twitter/models/__init__.py
new file mode 100644
index 00000000..037801e8
--- /dev/null
+++ b/addons/website_twitter/models/__init__.py
@@ -0,0 +1,6 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from . import website_twitter
+from . import res_config_settings
+from . import website_twitter_tweet
diff --git a/addons/website_twitter/models/res_config_settings.py b/addons/website_twitter/models/res_config_settings.py
new file mode 100644
index 00000000..14b6ec5a
--- /dev/null
+++ b/addons/website_twitter/models/res_config_settings.py
@@ -0,0 +1,84 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+import logging
+
+import requests
+
+from odoo import api, fields, models, _, _lt
+from odoo.exceptions import UserError
+
+_logger = logging.getLogger(__name__)
+
+TWITTER_EXCEPTION = {
+ 304: _lt('There was no new data to return.'),
+ 400: _lt('The request was invalid or cannot be otherwise served. Requests without authentication are considered invalid and will yield this response.'),
+ 401: _lt('Authentication credentials were missing or incorrect. Maybe screen name tweets are protected.'),
+ 403: _lt('The request is understood, but it has been refused or access is not allowed. Please check your Twitter API Key and Secret.'),
+ 429: _lt('Request cannot be served due to the applications rate limit having been exhausted for the resource.'),
+ 500: _lt('Twitter seems broken. Please retry later. You may consider posting an issue on Twitter forums to get help.'),
+ 502: _lt('Twitter is down or being upgraded.'),
+ 503: _lt('The Twitter servers are up, but overloaded with requests. Try again later.'),
+ 504: _lt('The Twitter servers are up, but the request could not be serviced due to some failure within our stack. Try again later.')
+}
+
+
+class ResConfigSettings(models.TransientModel):
+ _inherit = 'res.config.settings'
+
+ twitter_api_key = fields.Char(
+ related='website_id.twitter_api_key', readonly=False,
+ string='API Key',
+ help='Twitter API key you can get it from https://apps.twitter.com/')
+ twitter_api_secret = fields.Char(
+ related='website_id.twitter_api_secret', readonly=False,
+ string='API secret',
+ help='Twitter API secret you can get it from https://apps.twitter.com/')
+ twitter_screen_name = fields.Char(
+ related='website_id.twitter_screen_name', readonly=False,
+ string='Favorites From',
+ help='Screen Name of the Twitter Account from which you want to load favorites.'
+ 'It does not have to match the API Key/Secret.')
+ twitter_server_uri = fields.Char(string='Twitter server uri', readonly=True)
+
+ def _get_twitter_exception_message(self, error_code):
+ if error_code in TWITTER_EXCEPTION:
+ return TWITTER_EXCEPTION[error_code]
+ else:
+ return _('HTTP Error: Something is misconfigured')
+
+ def _check_twitter_authorization(self):
+ try:
+ self.website_id.fetch_favorite_tweets()
+
+ except requests.HTTPError as e:
+ _logger.info("%s - %s" % (e.response.status_code, e.response.reason), exc_info=True)
+ raise UserError("%s - %s" % (e.response.status_code, e.response.reason) + ':' + self._get_twitter_exception_message(e.response.status_code))
+ except IOError:
+ _logger.info('We failed to reach a twitter server.', exc_info=True)
+ raise UserError(_('Internet connection refused: We failed to reach a twitter server.'))
+ except Exception:
+ _logger.info('Please double-check your Twitter API Key and Secret!', exc_info=True)
+ raise UserError(_('Twitter authorization error! Please double-check your Twitter API Key and Secret!'))
+
+ @api.model
+ def create(self, vals):
+ TwitterConfig = super(ResConfigSettings, self).create(vals)
+ if vals.get('twitter_api_key') or vals.get('twitter_api_secret') or vals.get('twitter_screen_name'):
+ TwitterConfig._check_twitter_authorization()
+ return TwitterConfig
+
+ def write(self, vals):
+ TwitterConfig = super(ResConfigSettings, self).write(vals)
+ if vals.get('twitter_api_key') or vals.get('twitter_api_secret') or vals.get('twitter_screen_name'):
+ self._check_twitter_authorization()
+ return TwitterConfig
+
+ @api.model
+ def get_values(self):
+ res = super(ResConfigSettings, self).get_values()
+ Params = self.env['ir.config_parameter'].sudo()
+ res.update({
+ 'twitter_server_uri': '%s/' % Params.get_param('web.base.url', default='http://yourcompany.odoo.com'),
+ })
+ return res
diff --git a/addons/website_twitter/models/website_twitter.py b/addons/website_twitter/models/website_twitter.py
new file mode 100644
index 00000000..f7de7330
--- /dev/null
+++ b/addons/website_twitter/models/website_twitter.py
@@ -0,0 +1,89 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+import json
+import logging
+
+import requests
+from odoo import api, fields, models
+
+API_ENDPOINT = 'https://api.twitter.com'
+API_VERSION = '1.1'
+REQUEST_TOKEN_URL = '%s/oauth2/token' % API_ENDPOINT
+REQUEST_FAVORITE_LIST_URL = '%s/%s/favorites/list.json' % (API_ENDPOINT, API_VERSION)
+URLOPEN_TIMEOUT = 10
+
+_logger = logging.getLogger(__name__)
+
+
+class WebsiteTwitter(models.Model):
+ _inherit = 'website'
+
+ twitter_api_key = fields.Char(string='Twitter API key', help='Twitter API Key')
+ twitter_api_secret = fields.Char(string='Twitter API secret', help='Twitter API Secret')
+ twitter_screen_name = fields.Char(string='Get favorites from this screen name')
+
+ @api.model
+ def _request(self, website, url, params=None):
+ """Send an authenticated request to the Twitter API."""
+ access_token = self._get_access_token(website)
+ try:
+ request = requests.get(url, params=params, headers={'Authorization': 'Bearer %s' % access_token}, timeout=URLOPEN_TIMEOUT)
+ request.raise_for_status()
+ return request.json()
+ except requests.HTTPError as e:
+ _logger.debug("Twitter API request failed with code: %r, msg: %r, content: %r",
+ e.response.status_code, e.response.reason, e.response.content)
+ raise
+
+ @api.model
+ def _refresh_favorite_tweets(self):
+ ''' called by cron job '''
+ website = self.env['website'].search([('twitter_api_key', '!=', False),
+ ('twitter_api_secret', '!=', False),
+ ('twitter_screen_name', '!=', False)])
+ _logger.debug("Refreshing tweets for website IDs: %r", website.ids)
+ website.fetch_favorite_tweets()
+
+ def fetch_favorite_tweets(self):
+ WebsiteTweets = self.env['website.twitter.tweet']
+ tweet_ids = []
+ for website in self:
+ if not all((website.twitter_api_key, website.twitter_api_secret, website.twitter_screen_name)):
+ _logger.debug("Skip fetching favorite tweets for unconfigured website %s", website)
+ continue
+ params = {'screen_name': website.twitter_screen_name}
+ last_tweet = WebsiteTweets.search([('website_id', '=', website.id),
+ ('screen_name', '=', website.twitter_screen_name)],
+ limit=1, order='tweet_id desc')
+ if last_tweet:
+ params['since_id'] = int(last_tweet.tweet_id)
+ _logger.debug("Fetching favorite tweets using params %r", params)
+ response = self._request(website, REQUEST_FAVORITE_LIST_URL, params=params)
+ for tweet_dict in response:
+ tweet_id = tweet_dict['id'] # unsigned 64-bit snowflake ID
+ tweet_ids = WebsiteTweets.search([('tweet_id', '=', tweet_id)]).ids
+ if not tweet_ids:
+ new_tweet = WebsiteTweets.create(
+ {
+ 'website_id': website.id,
+ 'tweet': json.dumps(tweet_dict),
+ 'tweet_id': tweet_id, # stored in NUMERIC PG field
+ 'screen_name': website.twitter_screen_name,
+ })
+ _logger.debug("Found new favorite: %r, %r", tweet_id, tweet_dict)
+ tweet_ids.append(new_tweet.id)
+ return tweet_ids
+
+ def _get_access_token(self, website):
+ """Obtain a bearer token."""
+ r = requests.post(
+ REQUEST_TOKEN_URL,
+ data={'grant_type': 'client_credentials',},
+ auth=(website.twitter_api_key, website.twitter_api_secret),
+ timeout=URLOPEN_TIMEOUT,
+ )
+ r.raise_for_status()
+ data = r.json()
+ access_token = data['access_token']
+ return access_token
diff --git a/addons/website_twitter/models/website_twitter_tweet.py b/addons/website_twitter/models/website_twitter_tweet.py
new file mode 100644
index 00000000..6fa6fb15
--- /dev/null
+++ b/addons/website_twitter/models/website_twitter_tweet.py
@@ -0,0 +1,19 @@
+# -*- coding: utf-8 -*-
+# Part of Odoo. See LICENSE file for full copyright and licensing details.
+
+from odoo import fields, models
+
+
+class WebsiteTwitterTweet(models.Model):
+ _name = 'website.twitter.tweet'
+ _description = 'Website Twitter'
+
+ website_id = fields.Many2one('website', string='Website', ondelete='cascade')
+ screen_name = fields.Char(string='Screen Name')
+ tweet = fields.Text(string='Tweets')
+
+ # Twitter IDs are 64-bit unsigned ints, so we need to store them in
+ # unlimited precision NUMERIC columns, which can be done with a
+ # float field. Used digits=(0,0) to indicate unlimited.
+ # Using VARCHAR would work too but would have sorting problems.
+ tweet_id = fields.Float(string='Tweet ID', digits=(0, 0)) # Twitter