survos/news-api-bundle

Symfony bundle for interacting with NewsApiCDN using https://github.com/ToshY/NewsApiNet-PHP

dev-main 2024-12-22 13:31 UTC

Requires

• php: ^8.3
• jcobhams/newsapi: *@dev
• symfony/config: ^6.4 || ^7.1
• symfony/dependency-injection: ^6.4 || ^7.1
• symfony/http-kernel: ^6.4 || ^7.1
• twig/twig: ^3.4
• zenstruck/bytes: ^1.0
• zenstruck/console-extra: ^1.4

Requires (Dev)

• phpstan/phpstan: ^2.0
• phpunit/phpunit: ^11.4
• survos/simple-datatables-bundle: ^1.5
• symfony/browser-kit: ^6.4 || ^7.1
• symfony/framework-bundle: ^6.4 || ^7.1
• symfony/http-client: ^6.4 || ^7.1
• symfony/phpunit-bridge: ^6.4 || ^7.1
• symfony/twig-bundle: ^6.4 || ^7.1
• symfony/var-dumper: ^6.4 || ^7.1
• symfony/yaml: ^6.4 || ^7.1

Suggests

• survos/simple-datatables-bundle: searchable/sortable tables when browsing

MIT

• symfony
• symfony-ux

README

A Symfony bundle to interact with NewsApiCDN via the NewsApi-PHP library.

Still under development, feedback welcome!

Quickstart

symfony new news-api-demo --webapp && cd news-api-demo
composer require survos/news-api-bundle

Installation

Go to https://newsapi.com and get a key.

Create a new Symfony project.

symfony new news-api-demo --webapp && cd news-api-demo
composer require survos/news-api-bundle
bin/console news-api:config <api-key> >> .env.local 
bin/console news-api:list

You can browse interactively with the basic admin controller.

composer require survos/simple-datatables-bundle
symfony server:start -d
symfony open:local --path=/news-api/zones

Or edit .env.local and add your API key.

As each storage zone has its own passwords and id, these need to be configured individually in survos_news-api.yaml. Rather than tediously configuring each zone by cutting and pasting, we can use the first utility to dump the configuration with just the main api key. This saves you from having to go to https://dash.news-api.net/storage and go to each storage zone, then click on it and select "FTP and ApiAccess" and selecting each key.

bin/console news-api:config <api-key> 

Note: use --filter to limit to the zones to a regex (@todo)

You can skip passing the api key on the command line by defining it as an environment variable, etc.

echo "NEWS_API_KEY=api-key >> .env.local

This command dumps the packages/config/survos_news-api.yaml file with references to the environment variables, which are also dumped and should be added to .env.local. If your application only reads from news-api, you can remove the password environment variables, it is only used during writing. You can also remove the main api key if your application doesn't need it in production.

Open .env.local and replace the values.

Your application now has a bare-bones controller located at /admin/news-api, you may want to secure this route in security.yaml, or configure it in config/routes/survos_news-api.yaml.

You also have access to a command line interface.

bin/console news-api:list 

+------------- museado/ -----+--------+
| ObjectName     | Path      | Length |
+----------------+-----------+--------+
| photos finales | /museado/ | 0      |
+----------------+-----------+--------+