Metadata-Version: 2.4
Name: redturtle.rssservice
Version: 2.2.2
Summary: An add-on for Plone
Home-page: https://github.com/collective/redturtle.rssservice
Author: RedTurtle
Author-email: sviluppo@redturtle.it
License: GPL version 2
Project-URL: PyPI, https://pypi.python.org/pypi/redturtle.rssservice
Project-URL: Source, https://github.com/collective/redturtle.rssservice
Project-URL: Tracker, https://github.com/collective/redturtle.rssservice/issues
Keywords: Python Plone
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Framework :: Plone
Classifier: Framework :: Plone :: Addon
Classifier: Framework :: Plone :: 5.2
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: GNU General Public License v2 (GPLv2)
Requires-Python: >3.6
License-File: LICENSE.GPL
License-File: LICENSE.rst
Requires-Dist: setuptools
Requires-Dist: z3c.jbot
Requires-Dist: plone.api>=1.8.4
Requires-Dist: plone.restapi
Requires-Dist: plone.app.dexterity
Requires-Dist: feedparser
Provides-Extra: test
Requires-Dist: plone.app.testing; extra == "test"
Requires-Dist: plone.testing>=5.0.0; extra == "test"
Requires-Dist: plone.app.contenttypes; extra == "test"
Requires-Dist: plone.app.robotframework[debug]; extra == "test"
Requires-Dist: collective.MockMailHost; extra == "test"
Requires-Dist: requests_mock; extra == "test"
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: license-file
Dynamic: project-url
Dynamic: provides-extra
Dynamic: requires-dist
Dynamic: requires-python
Dynamic: summary

.. This README is meant for consumption by humans and pypi. Pypi can render rst files so please do not use Sphinx features.
   If you want to learn more about writing documentation, please check out: http://docs.plone.org/about/documentation_styleguide.html
   This text does not appear on pypi or github. It is a comment.

.. image:: https://img.shields.io/pypi/v/redturtle.rssservice.svg
    :target: https://pypi.org/project/redturtle.rssservice/
    :alt: Latest Version

.. image:: https://img.shields.io/pypi/pyversions/redturtle.rssservice.svg?style=plastic
    :target: https://pypi.org/project/redturtle.rssservice/
    :alt: Supported - Python Versions

.. image:: https://img.shields.io/pypi/dm/redturtle.rssservice.svg
    :target: https://pypi.org/project/redturtle.rssservice/
    :alt: Number of PyPI downloads

.. image:: https://img.shields.io/pypi/l/redturtle.rssservice.svg
    :target: https://pypi.org/project/redturtle.rssservice/
    :alt: License

.. image:: https://github.com/RedTurtle/redturtle.rssservice/actions/workflows/test.yml/badge.svg
    :target: https://github.com/RedTurtle/redturtle.rssservice/actions
    :alt: Tests

.. image:: https://coveralls.io/repos/github/RedTurtle/redturtle.rssservice/badge.svg?branch=master
    :target: https://coveralls.io/github/RedTurtle/redturtle.rssservice?branch=master
    :alt: Coverage

=====================
Redturtle RSS Service
=====================

This package add support to retrieve RSS feeds from external sources.

Usage
=====


RSS block
---------

There is a service "**@rss_mixer_data**" that accept a block id, and return a list of sorted feeds by date.

This service only accept GET calls and accept following parameters:

- block: the id of the rssBlock with the feeds

The endpoint should be called on the context that has the rssBlock that you want to show.


For example::

    > curl -i -X GET http://localhost:8080/Plone/example-page/@rss_mixer_data?block=123456789 -H 'Accept: application/json' -H 'Content-Type: application/json'


Will reply with something like this::

    [
        {
            "source": "Foo site",
            "contentSnippet": "some description 2",
            "title": "Foo News 2",
            "date": "Thu, 1 Apr 2020 10:44:01 +0200",
            "url": "http://test.com/foo-news-2"
        },
        {
            "source": "",
            "contentSnippet": "some description 2",
            "title": "Bar News 2",
            "date": "Thu, 1 Apr 2020 10:44:01 +0200",
            "url": "http://test.com/bar-news-2"
        },
        {
            "source": "Foo site",
            "contentSnippet": "some description",
            "title": "Foo News 1",
            "date": "Thu, 2 Apr 2020 10:44:01 +0200",
            "url": "http://test.com/foo-news-1"
        },
        {
            "source": "",
            "contentSnippet": "some description",
            "title": "Bar News 1",
            "date": "Thu, 2 Apr 2020 10:44:01 +0200",
            "url": "http://test.com/bar-news-1"
        }
    ]

This endpoint works with `volto-rss-block <https://github.com/RedTurtle/volto-rss-block/>`_ plugin.

Retrieve timeout
----------------

There is a 5s default timeout for retrieve RSS feeds.

You can override it with an environment variable: **RSS_SERVICE_TIMEOUT**

Set User-Agent
--------------

You can override the default ``User-Agent`` for the requests to get feeds by setting an environment variable: **RSS_USER_AGENT**

Installation
============

Install redturtle.rssservice by adding it to your buildout::

    [buildout]

    ...

    eggs =
        redturtle.rssservice


and then running ``bin/buildout``

Resilience
==========

To make the product more resilient against external feed disruptions, it is possible to use an external proxy/cache service. The service is utilized in the following format:

```
http://proxyservice/http://feedurl
```

The product includes a built-in proxy/cache implementation that can be used. After installing the product, you can use it by running the following process:

```
bin/rssmixer-proxy --port 8000 --ttl 1200
```

And eventually set the environment variable `RSSMIXER_PROXY` to `http://127.0.0.1:8000` according to the port used for the proxy.

Contribute
==========

- Issue Tracker: https://github.com/RedTurtle/redturtle.rssservice/issues
- Source Code: https://github.com/RedTurtle/redturtle.rssservice


Support
=======

If you are having issues, please let us know.
We have a mailing list located at: sviluppo@redturtle.it


License
=======

The project is licensed under the GPLv2.


Contributors
============

- RedTurtle, sviluppo@redturtle.it


Changelog
=========

2.2.2 (2026-10-05)
------------------

- Fix proxycache url replace
  [mamico]
- Refactor proxycache server: thread-safety, atomic writes, background thread deduplication, ThreadingHTTPServer, and anti-SSRF URL validation.
  [mamico]


2.2.1 (2023-07-12)
------------------

- Handle case when feed url is an internal url with resolveuid.
  [cekk]
- Do not print exception on log, but use warning because it's handled.
  [cekk]

2.2.0 (2023-03-21)
------------------

- Allow configuring the User-Agent for the requests to get feeds,
  via the REQUESTS_USER_AGENT environment variable.
  [davisagli]


2.1.0 (2023-03-10)
------------------

- Customizable timeout.
  [cekk]
- Return 404 if block not found instead BadRequest.
  [cekk]
- Handle site root blocks in plone 6.
  [cekk]


2.0.0 (2022-04-07)
------------------

- Remove unused and unsafe endpoint.
  [cekk]
- Now @rss_mixer_data accept GET calls (see README for more infos).
  [cekk]


1.0.3 (2022-03-22)
------------------

- Allow to use cateogry in rss feed.
  [lucabel]


1.0.2 (2022-03-04)
------------------

- Allow dates with wrong date format (eg. a date range)
  [lucabel]


1.0.1 (2021-12-02)
------------------

- Fix python version in setup.py
  [cekk]

1.0.0 (2021-10-13)
------------------

- Add @rss_mixer_data endpoint.
  [cekk]


0.1.0 (2020-04-08)
------------------

- Initial release.
  [cekk]
