Twitter v2 API Bridge

[quickwick]

I've spent the past week or so learning PHP and re-writing the TwitterBridge to use the v2 API. It works great for me, and I'd like to share, but first I have some questions/concerns.

Usage of the v2 API requires a Twitter Developer account and a unique API key. Unlike the current TwitterBridge, or the v1.1 API rewrite being performed by @arnd-s , the v2 API endpoints cannot be accessed using the standard dummy bearer key.

Question 1: Is it acceptable to have a Bridge that requires additional configuration on the part of the end users? In this case, making a Twitter Dev account and generating a unique API access key.

Question 2: If Yes to question 1, what would be the best way to store and retrieve that API key? Currently I have it hard-coded into the .php file, but that's only for me. I assume the proper way to do it is to have the .php file read the key from another file (eg. a .cfg or .ini file), which the end users will need to modify to add their personal key. What should that file be called, and where should it go?

Question 3: Assuming positive responses to Question 1 & 2, should this Bridge be submitted as a new Bridge? eg. TwitterV2Bridge. The current TwitterBridge (or at least, the v1.1 update currently in progress) mostly works. It doesn't work entirely for me, but I believe it's due to faults/limitations in the v1.1 API, which is what prompted my work on the v2 API. I don't want to replace the v1.1 API bridge, since it's easier to use and is perfectly fine for many people, but I want to make the v2 API bridge available for those who want it.

[em92]

Is it acceptable to have a Bridge that requires additional configuration on the part of the end users? In this case, making a Twitter Dev account and generating a unique API access key.

Yes, it is acceptable, if there would be also instructions how to configure this bridge. In general working bridge without additional configuration is more preferred.

If Yes to question 1, what would be the best way to store and retrieve that API key?

I will explain with example of InstagramBridge.

1. Defining configuration vars:
   

   rss-bridge/bridges/InstagramBridge.php

   Lines 9 to 16 in 0cf9da9

   	const CONFIGURATION = array(
   	'session_id' => array(
   	'required' => false,
   	),
   	'cache_timeout' => array(
   	'required' => false,
   	),
   	);

2. To retrieve them, use
   

   rss-bridge/bridges/InstagramBridge.php

   Line 69 in 0cf9da9

   $sessionId = $this->getOption('session_id');

3. To store them, in config.ini.php add those lines

[InstagramBridge]
session_id = %sessionid from step 1%
cache_timeout = %cache timeout in seconds%

Question 3: Assuming positive responses to Question 1 & 2, should this Bridge be submitted as a new Bridge?

Yes. In original TwitterBridge I would add some comment to note about existing TwitterBridgeV2. Also in new bridge, it would be good to explain which use-cases new bridge solves, but original does not.

[quickwick]

Excellent, thank you so much!

I'll make those changes for config.ini.php, go through the contributing style guide to make sure I am compliant, then figure out how to git branch and make a pull request.

[quickwick]

Where would I put the bridge configuration instructions? In the DESCRIPTION? In a comment block at the top of the Bridge file? Somewhere else?

[em92]

Where would I put the bridge configuration instructions?

doc/bridges/TwitterBridgeV2.rst. Like here

doc/bridges/InstagramBridge.rst

In top comments of TwitterBridgeV2 I would add a note, that it this bridge has instructions.