Merge pull request #14 from RomainGoncalves/allow-for-http-auth

Allow for passing curl options

Author: vedmant

README.md

@@ -78,6 +78,21 @@ This function accepts 2 parameters however, the second parameter is optional.  T
 This will return to you the SimplePie object with the RSS feed in it.
 See [SimplePie](http://simplepie.org/api/index.html) API for all available methods.
 
+#### Passing curl options
+You can also pass specific curl options per `read()` calls. You can pass these options, as an `array` as the 3rd parameter. The list of options can be found on the [PHP Manual](https://www.php.net/manual/en/function.curl-setopt.php).
+
+Example:
+```php
+// You need to log in to the rss endpoint with a Digest auth
+$options = [
+    'curl_options' => [
+    CURLOPT_HTTPAUTH => CURLAUTH_DIGEST,
+    CURLOPT_USERPWD => 'username:password'
+]];
+
+$f = FeedReader::read('https://news.google.com/news/rss', 'default', $options);
+```
+
 ## License
 
 Feed Reader is free software distributed under the terms of the MIT license

src/FeedReader.php

@@ -28,9 +28,10 @@ public function __construct(Container $app)
      *
      * @param        $url
      * @param string $configuration
+     * @param array  $options
      * @return SimplePie
      */
-    public function read($url, $configuration = 'default')
+    public function read($url, $configuration = 'default', array $options = [])
     {
         // Setup the object
         $sp = $this->app->make(SimplePie::class);
@@ -62,6 +63,11 @@ public function read($url, $configuration = 'default')
             ]);
         }
 
+        // If the user passes manual curl options, let's add them
+        if (isset($options['curl_options'])) {
+            $sp->set_curl_options($options['curl_options']);
+        }
+
         // Set the feed URL
         $sp->set_feed_url($url);
 

tests/Unit/FeedReaderTest.php

@@ -30,6 +30,28 @@ public function testReadRss()
         $this->assertEquals('FeedForAll Sample Feed', $rss->get_title());
         $this->assertObjectHasAttribute('term', $rss->get_category());
         $this->assertEquals(9, $rss->get_item_quantity());
+        // No curl options passed
+        $this->assertEquals([], $rss->curl_options);
+
+        self::$process->stop();
+    }
+
+    public function testReadRssWithOptions()
+    {
+        self::$process = new Process(['php', '-S', 'localhost:8123', '-t', './tests/resources']);
+        self::$process->start();
+        usleep(500000);
+
+        /** @var SimplePie $rss */
+        $rss = FeedReaderFacade::read('http://localhost:8123/rss.xml', null, ['curl_options' => [
+            CURLOPT_HTTPAUTH => CURLAUTH_DIGEST,
+            CURLOPT_USERPWD => 'username:password'
+        ]]);
+
+        $this->assertEquals([
+            107 => 2,
+            10005 => "username:password"
+        ], $rss->curl_options);
 
         self::$process->stop();
     }