Preparing new version. Pushing usable master. Missing some tests. No build for now. [ci skip]

Author: Swader

CHANGELOG.md

@@ -1,6 +1,13 @@
 #Changelog
 All notable changes will be documented in this file
 
+## 0.2 - May 2nd, 2015
+
+- added Discussion API
+- added basic Custom API - returns Wildcards by default
+- Discussion API is now returned as child of Article / Product, too
+- minor change in how URLs are built - trailing slash no longer enforced after base API URL
+
 ## 0.1.3 - April 21st, 2015
 
 - new Scrutinizer settings

README.md

@@ -31,7 +31,7 @@ phpunit
 
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details and [TODO](TODO.md) for ideas.
 
 ## Credits
 

TODO.md

@@ -4,17 +4,19 @@ Active todos, ordered by priority
 
 ## High
 
-- implement Discussion API
 - implement Crawlbot
 - implement Search API
 
 ## Medium
 
+- write usage example
 - add streaming to Crawlbot - make it stream the result (it constantly grows)
 - implement Video API (currently beta)
 - improve Custom API
 - improve Wildcard Entity - apply to Custom API
 
 ## Low
 
-- get more mock responses and test against them
+- work on PhpDoc consistency ($param type vs type $param)
+- get more mock responses and test against them
+- write example with custom EntityIterator (different Entity set for different API) and custom Entity (i.e. authorProfile, which parses some of the data and prepares for further use)

src/Abstracts/Api.php

@@ -91,7 +91,7 @@ public function call()
 
     public function buildUrl()
     {
-        $url = rtrim($this->apiUrl, '/') . '/';
+        $url = rtrim($this->apiUrl, '/');
 
         // Add Token
         $url .= '?token=' . $this->diffbot->getToken();

src/Abstracts/Entity.php

@@ -20,4 +20,18 @@ public function getData()
     {
         return $this->data;
     }
+
+    public function __get($name)
+    {
+        return (isset($this->data[$name])) ? $this->data[$name] : null;
+    }
+
+    public function __call($name, $arguments)
+    {
+        $isGetter = substr($name, 0, 3) == 'get';
+        if ($isGetter) {
+            $property = lcfirst(substr($name, 3, strlen($name) - 3));
+            return $this->$property;
+        }
+    }
 }

src/Api/Custom.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Swader\Diffbot\Api;
+
+use Swader\Diffbot\Abstracts\Api;
+
+class Custom extends Api
+{
+    /** @var string API URL to which to send the request */
+    protected $apiUrl = 'http://api.diffbot.com/v3';
+
+    public function __construct($url, $name)
+    {
+        parent::__construct($url);
+        $this->apiUrl .= '/' . trim($name);
+    }
+}

src/Api/Discussion.php

@@ -0,0 +1,45 @@
+<?php
+
+namespace Swader\Diffbot\Api;
+
+use Swader\Diffbot\Abstracts\Api;
+use Swader\Diffbot\Traits\StandardApi;
+
+class Discussion extends Api
+{
+    use StandardApi;
+
+    /** @var string API URL to which to send the request */
+    protected $apiUrl = 'http://api.diffbot.com/v3/discussion';
+
+    /**
+     * Set the maximum number of pages in a thread to automatically concatenate
+     * in a single response. Default = 1 (no concatenation). Set maxPages=all
+     * to retrieve all pages of a thread regardless of length. Each individual
+     * page will count as a separate API call.
+     *
+     * @param int|string $max Integer or "all"
+     * @return $this
+     */
+    public function setMaxPages($max = 1)
+    {
+        if ($max == 'all' || is_numeric($max)) {
+            $this->otherOptions['maxPages'] = $max;
+        }
+
+        return $this;
+    }
+
+    /**
+     * @see Swader\Diffbot\Entity\Discussion::getSentiment()
+     * @param $bool
+     * @return $this
+     */
+    public function setSentiment($bool)
+    {
+        $this->fieldSettings['sentiment'] = (bool)$bool;
+
+        return $this;
+    }
+
+}

src/Diffbot.php

@@ -2,11 +2,13 @@
 
 namespace Swader\Diffbot;
 
+use Swader\Diffbot\Api\Custom;
 use Swader\Diffbot\Exceptions\DiffbotException;
 use Swader\Diffbot\Api\Product;
 use Swader\Diffbot\Api\Image;
 use Swader\Diffbot\Api\Analyze;
 use Swader\Diffbot\Api\Article;
+use Swader\Diffbot\Api\Discussion;
 use GuzzleHttp\Client;
 use Swader\Diffbot\Factory\Entity;
 use Swader\Diffbot\Interfaces\EntityFactory;
@@ -52,7 +54,7 @@ public function __construct($token = null)
 
     /**
      * Sets the token for all future new instances
-     * @param $token string The API access token, as obtained on diffbot.com/dev
+     * @param string $token The API access token, as obtained on diffbot.com/dev
      * @return void
      */
     public static function setToken($token)
@@ -132,62 +134,100 @@ public function getEntityFactory()
     /**
      * Creates a Product API interface
      *
-     * @param $url string Url to analyze
+     * @param string $url Url to analyze
      * @return Product
      */
     public function createProductAPI($url)
     {
         $api = new Product($url);
         if (!$this->getHttpClient()) {
             $this->setHttpClient();
+            $this->setEntityFactory();
         }
         return $api->registerDiffbot($this);
     }
 
     /**
      * Creates an Article API interface
      *
-     * @param $url string Url to analyze
+     * @param string $url Url to analyze
      * @return Article
      */
     public function createArticleAPI($url)
     {
         $api = new Article($url);
         if (!$this->getHttpClient()) {
             $this->setHttpClient();
+            $this->setEntityFactory();
         }
         return $api->registerDiffbot($this);
     }
 
     /**
      * Creates an Image API interface
      *
-     * @param $url string Url to analyze
+     * @param string $url Url to analyze
      * @return Image
      */
     public function createImageAPI($url)
     {
         $api = new Image($url);
         if (!$this->getHttpClient()) {
             $this->setHttpClient();
+            $this->setEntityFactory();
         }
         return $api->registerDiffbot($this);
     }
 
     /**
      * Creates an Analyze API interface
      *
-     * @param $url string Url to analyze
+     * @param string $url Url to analyze
      * @return Analyze
      */
     public function createAnalyzeAPI($url)
     {
         $api = new Analyze($url);
         if (!$this->getHttpClient()) {
             $this->setHttpClient();
+            $this->setEntityFactory();
         }
         return $api->registerDiffbot($this);
     }
 
+    /**
+     * Creates an Discussion API interface
+     *
+     * @param string $url Url to analyze
+     * @return Discussion
+     */
+    public function createDiscussionAPI($url)
+    {
+        $api = new Discussion($url);
+        if (!$this->getHttpClient()) {
+            $this->setHttpClient();
+            $this->setEntityFactory();
+        }
+        return $api->registerDiffbot($this);
+    }
+
+    /**
+     * Creates a generic Custom API
+     *
+     * Does not have predefined Entity, so by default returns Wildcards
+     *
+     * @param string $url Url to analyze
+     * @param string $name Name of the custom API, required to finalize URL
+     * @return Custom
+     */
+    public function createCustomAPI($url, $name)
+    {
+        $api = new Custom($url, $name);
+        if (!$this->getHttpClient()) {
+            $this->setHttpClient();
+            $this->setEntityFactory();
+        }
+        return $api->registerDiffbot($this);
+    }
 
 }

src/Entity/Article.php

@@ -9,6 +9,17 @@ class Article extends Entity
 {
     use StandardEntity;
 
+    /** @var Discussion */
+    protected $discussion = null;
+
+    public function __construct(array $data)
+    {
+        parent::__construct($data);
+        if (isset($this->data['discussion'])) {
+            $this->discussion = new Discussion($this->data['discussion']);
+        }
+    }
+
     /**
      * Should always return "article"
      * @return string
@@ -181,4 +192,13 @@ public function getVideos()
     {
         return (isset($this->data['videos'])) ? $this->data['videos'] : [];
     }
+
+    /**
+     * Returns the Discussion entity - comments of the article
+     * @return Discussion
+     */
+    public function getDiscussion()
+    {
+        return $this->discussion;
+    }
 }