Merge pull request #22 from Linusp/misc

Misc

Author: Linusp

.github/workflows/pythonpackage.yml

@@ -9,7 +9,7 @@ jobs:
     strategy:
       max-parallel: 4
       matrix:
-        python-version: [2.7, 3.5, 3.6, 3.7]
+        python-version: [3.x]
 
     steps:
     - uses: actions/checkout@v1

CHANGELOG.md

@@ -1,10 +1,70 @@
 # CHANGELOG
 
+## v0.4.6
+
+Added
+
+- New methods:
+
+  - `InoreaderClient.remove_general_label`
+  - `InoreaderClient.remove_tag`
+  - `InoreaderClient.remove_read`
+  - `InoreaderClient.remove_starred`
+  - `InoreaderClient.remove_liked`
+
+  thanks to [tianchen zhong](https://github.com/cczhong11)
+
+Changed
+
+- Add param to `inoreader.main.get_client` for customizing the config file path, thanks to [tianchen zhong](https://github.com/cczhong11)
+- Command filter supported a new action `unstar`
+
+Fixed
+
+- Fix token in refresh_access_token method, thanks to [Torikova](https://github.com/Torikova)
+
 ## v0.4.5
 
 Changed
 
-- fix an error in `client.py`
+- Fix `InoreaderClient.__get_stream_contents`, thanks to [BeautyYuYanli](https://github.com/BeautyYuYanli)
+
+## v0.4.4
+
+Changed
+
+- Disable default app id and key due to abusion
+
+## v0.4.3
+
+Fixed
+
+- Fix endless loop bug in `InoreaderClient.fetch_articles`
+
+## v0.4.2
+
+Added
+
+- New functions:
+
+  - `inoreader.utils.download_image`
+
+- New methods:
+
+  - `InoreaderClient.fetch_articles`
+  - `InoreaderClient.fetch_starred`
+
+- New command: `fetch-starred`
+
+Changed
+
+- Optimized article content parsing
+
+## v0.4.1
+
+Added
+
+- New config `proxies`
 
 ## v0.4.0
 

inoreader/__init__.py

@@ -1,5 +1,4 @@
 # coding: utf-8
 from .client import InoreaderClient
 
-
 __all__ = ['InoreaderClient']

inoreader/article.py

@@ -1,13 +1,23 @@
 # coding: utf-8
 from __future__ import print_function, unicode_literals
 
-from .utils import normalize_whitespace, extract_text
+from .utils import extract_text, normalize_whitespace
 
 
 class Article(object):
-    def __init__(self, id, title, categories, link,
-                 published=None, content=None, author=None,
-                 feed_id=None, feed_title=None, feed_link=None):
+    def __init__(
+        self,
+        id,
+        title,
+        categories,
+        link,
+        published=None,
+        content=None,
+        author=None,
+        feed_id=None,
+        feed_title=None,
+        feed_link=None,
+    ):
         self.id = id
         self.title = normalize_whitespace(title)
         self.categories = categories
@@ -34,10 +44,12 @@ def from_json(cls, data):
         article_data['link'] = links[0] if links else ''
 
         # feed info
-        article_data.update({
-            'feed_id': data['origin']['streamId'],
-            'feed_title': normalize_whitespace(data['origin']['title']),
-            'feed_link': data['origin']['htmlUrl'],
-        })
+        article_data.update(
+            {
+                'feed_id': data['origin']['streamId'],
+                'feed_title': normalize_whitespace(data['origin']['title']),
+                'feed_link': data['origin']['htmlUrl'],
+            }
+        )
 
         return cls(**article_data)

inoreader/client.py

@@ -2,23 +2,24 @@
 from __future__ import print_function, unicode_literals
 
 import logging
-from uuid import uuid4
 from datetime import datetime
 from operator import itemgetter
-try:                            # python2
-    from urlparse import urljoin
+from uuid import uuid4
+
+try:  # python2
     from urllib import quote_plus
-except ImportError:             # python3
+
+    from urlparse import urljoin
+except ImportError:  # python3
     from urllib.parse import urljoin, quote_plus
 
 import requests
 
-from .consts import BASE_URL
-from .exception import NotLoginError, APIError
 from .article import Article
+from .consts import BASE_URL
+from .exception import APIError, NotLoginError
 from .subscription import Subscription
 
-
 LOGGER = logging.getLogger(__name__)
 
 
@@ -39,19 +40,22 @@ class InoreaderClient(object):
     LIKED_TAG = 'user/-/state/com.google/like'
     BROADCAST_TAG = 'user/-/state/com.google/broadcast'
 
-    def __init__(self, app_id, app_key, access_token, refresh_token,
-                 expires_at, config_manager=None):
+    def __init__(
+        self, app_id, app_key, access_token, refresh_token, expires_at, config_manager=None
+    ):
         self.app_id = app_id
         self.app_key = app_key
         self.access_token = access_token
         self.refresh_token = refresh_token
         self.expires_at = float(expires_at)
         self.session = requests.Session()
-        self.session.headers.update({
-            'AppId': self.app_id,
-            'AppKey': self.app_key,
-            'Authorization': 'Bearer {}'.format(self.access_token)
-        })
+        self.session.headers.update(
+            {
+                'AppId': self.app_id,
+                'AppKey': self.app_key,
+                'Authorization': 'Bearer {}'.format(self.access_token),
+            }
+        )
         self.config_manager = config_manager
         self.proxies = self.config_manager.proxies if config_manager else None
 
@@ -151,12 +155,7 @@ def __get_stream_contents(self, stream_id, continuation=''):
         self.check_token()
 
         url = urljoin(BASE_URL, self.STREAM_CONTENTS_PATH + quote_plus(stream_id))
-        params = {
-            'n': 50,            # default 20, max 1000
-            'r': '',
-            'c': continuation,
-            'output': 'json'
-        }
+        params = {'n': 50, 'r': '', 'c': continuation, 'output': 'json'}  # default 20, max 1000
         response = self.parse_response(self.session.post(url, params=params, proxies=self.proxies))
         if 'continuation' in response:
             return response['items'], response['continuation']
@@ -168,10 +167,7 @@ def fetch_articles(self, folder=None, tags=None, unread=True, starred=False, lim
 
         url = urljoin(BASE_URL, self.STREAM_CONTENTS_PATH)
         if folder:
-            url = urljoin(
-                url,
-                quote_plus(self.GENERAL_TAG_TEMPLATE.format(folder))
-            )
+            url = urljoin(url, quote_plus(self.GENERAL_TAG_TEMPLATE.format(folder)))
 
         params = {'c': str(uuid4())}
         if unread:
@@ -183,10 +179,13 @@ def fetch_articles(self, folder=None, tags=None, unread=True, starred=False, lim
         fetched_count = 0
         response = self.parse_response(self.session.post(url, params=params, proxies=self.proxies))
         for data in response['items']:
-            categories = set([
-                category.split('/')[-1] for category in data.get('categories', [])
-                if category.find('label') > 0
-            ])
+            categories = set(
+                [
+                    category.split('/')[-1]
+                    for category in data.get('categories', [])
+                    if category.find('label') > 0
+                ]
+            )
             if tags and not categories.issuperset(set(tags)):
                 continue
 
@@ -202,10 +201,13 @@ def fetch_articles(self, folder=None, tags=None, unread=True, starred=False, lim
                 self.session.post(url, params=params, proxies=self.proxies)
             )
             for data in response['items']:
-                categories = set([
-                    category.split('/')[-1] for category in data.get('categories', [])
-                    if category.find('label') > 0
-                ])
+                categories = set(
+                    [
+                        category.split('/')[-1]
+                        for category in data.get('categories', [])
+                        if category.find('label') > 0
+                    ]
+                )
                 if tags and not categories.issuperset(set(tags)):
                     continue
                 yield Article.from_json(data)
@@ -229,30 +231,22 @@ def add_general_label(self, articles, label):
         url = urljoin(BASE_URL, self.EDIT_TAG_PATH)
         for start in range(0, len(articles), 10):
             end = min(start + 10, len(articles))
-            params = {
-                'a': label,
-                'i': [articles[idx].id for idx in range(start, end)]
-            }
+            params = {'a': label, 'i': [articles[idx].id for idx in range(start, end)]}
             self.parse_response(
-                self.session.post(url, params=params, proxies=self.proxies),
-                json_data=False
+                self.session.post(url, params=params, proxies=self.proxies), json_data=False
             )
-            
+
     def remove_general_label(self, articles, label):
         self.check_token()
 
         url = urljoin(BASE_URL, self.EDIT_TAG_PATH)
         for start in range(0, len(articles), 10):
             end = min(start + 10, len(articles))
-            params = {
-                'r': label,
-                'i': [articles[idx].id for idx in range(start, end)]
-            }
+            params = {'r': label, 'i': [articles[idx].id for idx in range(start, end)]}
             self.parse_response(
-                self.session.post(url, params=params, proxies=self.proxies),
-                json_data=False
+                self.session.post(url, params=params, proxies=self.proxies), json_data=False
             )
-    
+
     def add_tag(self, articles, tag):
         self.add_general_label(articles, self.GENERAL_TAG_TEMPLATE.format(tag))
 
@@ -276,6 +270,6 @@ def remove_starred(self, articles):
 
     def remove_liked(self, articles):
         self.remove_general_label(articles, self.LIKED_TAG)
-        
+
     def broadcast(self, articles):
         self.add_general_label(articles, self.BROADCAST_TAG)

inoreader/config.py

@@ -1,14 +1,12 @@
 # coding: utf-8
 from __future__ import print_function, unicode_literals
 
+import codecs
 import os
 from configparser import ConfigParser
 
-import codecs
-
-
-class InoreaderConfigManager():
 
+class InoreaderConfigManager:
     def __init__(self, config_file):
         self.config_file = config_file
         self.data = {}

inoreader/filter.py

@@ -1,6 +1,5 @@
 import re
 
-
 _FILTERS = {}
 
 
@@ -17,7 +16,6 @@ def wrap(cls):
 
 @register_filter('include_any')
 class IncludeAnyFilter(object):
-
     def __init__(self, rules):
         self.rules = [re.compile(regexp, re.IGNORECASE) for regexp in rules]
 
@@ -31,7 +29,6 @@ def validate(self, text):
 
 @register_filter('include_all')
 class IncludeAllFilter(object):
-
     def __init__(self, rules):
         self.rules = [re.compile(regexp, re.IGNORECASE) for regexp in rules]
 
@@ -45,7 +42,6 @@ def validate(self, text):
 
 @register_filter('exclude')
 class ExcludeFilter(object):
-
     def __init__(self, rules):
         self.rules = [re.compile(regexp, re.IGNORECASE) for regexp in rules]