First public release of basic APIs

Author: vagrant

CHANGELOG.md

@@ -1,19 +1,6 @@
 #Changelog
-All Notable changes to `:package_name` will be documented in this file
+All notable changes will be documented in this file
 
-## NEXT - YYYY-MM-DD
+## 0.1 - April 20th, 2015
 
-### Added
-- Nothing
-
-### Deprecated
-- Nothing
-
-### Fixed
-- Nothing
-
-### Remove
-- Nothing
-
-### Security
-- Nothing
+Initial public release.

CONTRIBUTING.md

@@ -1,9 +1,7 @@
 # Contributing
 
 Contributions are **welcome** and will be fully **credited**.
-
-We accept contributions via Pull Requests on [Github](https://github.com/thephpleague/:package_name).
-
+Send Pull Requests or open issues please.
 
 ## Pull Requests
 
@@ -25,7 +23,7 @@ We accept contributions via Pull Requests on [Github](https://github.com/thephpl
 ## Running Tests
 
 ``` bash
-$ phpunit
+phpunit
 ```
 
 

LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License (MIT)
 
-Copyright (c) 2013 :author_name <:author_email>
+Copyright (c) 2015 Bruno Skvorc (@bitfalls)
 
 > Permission is hereby granted, free of charge, to any person obtaining a copy
 > of this software and associated documentation files (the "Software"), to deal

README.md

@@ -44,4 +44,4 @@ Please see [CONTRIBUTING](https://github.com/thephpleague/:package_name/blob/mas
 
 ## License
 
-The MIT License (MIT). Please see [License File](LICENSE.md) for more information.
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

composer.json

@@ -34,7 +34,7 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "1.0-dev"
+            "dev-master": "0.2-dev"
         }
     }
 }

src/Abstracts/Api.php

@@ -22,6 +22,9 @@ abstract class Api implements \Swader\Diffbot\Interfaces\Api
     /** @var array Settings on which optional fields to fetch */
     protected $fieldSettings = [];
 
+    /** @var array Other API specific options */
+    protected $otherOptions = [];
+
     /** @var  Diffbot The parent class which spawned this one */
     protected $diffbot;
 
@@ -101,6 +104,11 @@ public function buildUrl()
             $url .= '&fields=' . $fieldString;
         }
 
+        // Add Other Options
+        foreach ($this->otherOptions as $option => $value) {
+            $url .= '&'.$option . '=' . $value;
+        }
+
         return $url;
     }
 

src/Api/Analyze.php

@@ -11,4 +11,39 @@ class Analyze extends Api
 
     /** @var string API URL to which to send the request */
     protected $apiUrl = 'http://api.diffbot.com/v3/analyze';
+
+    /**
+     * If set to false, will not extract article comments in a Discussion
+     * entity embedded in the Article / Product entity. By default, it will.
+     * @param bool $bool
+     * @return $this
+     */
+    public function setDiscussion($bool = true)
+    {
+        $this->otherOptions['discussion'] = ($bool) ? 'true' : 'false';
+
+        return $this;
+    }
+
+    /**
+     * By default the Analyze API will fully extract all pages that match an
+     * existing Automatic API -- articles, products or image pages. Set mode
+     * to a specific page-type (e.g., mode=article) to extract content only
+     * from that specific page-type. All other pages will simply return the
+     * default Analyze fields.
+     *
+     * @param string $mode article, product or image
+     * @return $this
+     */
+    public function setMode($mode)
+    {
+        if (!in_array($mode, ['article', 'product', 'image'])) {
+            $error = 'Only "article", "product" and "image" modes supported.';
+            throw new \InvalidArgumentException($error);
+        }
+        $this->otherOptions['mode'] = $mode;
+
+        return $this;
+    }
+
 }

src/Api/Article.php

@@ -11,4 +11,57 @@ class Article extends Api
 
     /** @var string API URL to which to send the request */
     protected $apiUrl = 'http://api.diffbot.com/v3/article';
+
+    /**
+     * @see Swader\Diffbot\Entity\Article::getSentiment()
+     * @param $bool
+     * @return $this
+     */
+    public function setSentiment($bool)
+    {
+        $this->fieldSettings['sentiment'] = (bool)$bool;
+
+        return $this;
+    }
+
+    /**
+     * If set to false, Diffbot will not auto-concat several pages of a
+     * multi-page article into one. Defaults to true, max 20 pages.
+     *
+     * @see http://support.diffbot.com/automatic-apis/handling-multiple-page-articles/
+     * @param bool $bool
+     * @return $this
+     */
+    public function setPaging($bool = true)
+    {
+        $this->otherOptions['paging'] = ($bool) ? 'true' : 'false';
+
+        return $this;
+    }
+
+    /**
+     * Set the maximum number of automatically-generated tags to return.
+     * By default a maximum of five tags will be returned.
+     * @param int $max
+     * @return $this
+     */
+    public function setMaxTags($max = 5)
+    {
+        $this->otherOptions['maxTags'] = (int)$max;
+
+        return $this;
+    }
+
+    /**
+     * If set to false, will not extract article comments in a Discussion
+     * entity embedded in the Article entity. By default, it will.
+     * @param bool $bool
+     * @return $this
+     */
+    public function setDiscussion($bool = true)
+    {
+        $this->otherOptions['discussion'] = ($bool) ? 'true' : 'false';
+
+        return $this;
+    }
 }

src/Api/Image.php

@@ -16,29 +16,35 @@ class Image extends Api
      * Tells the API call to return the mentions field
      * @see https://www.diffbot.com/dev/docs/image/
      * @param $bool
+     * @return $this
      */
     public function setMentions($bool)
     {
         $this->fieldSettings['mentions'] = (bool)$bool;
+        return $this;
     }
 
     /**
      * Sets the API call to return the faces field
      * @see https://www.diffbot.com/dev/docs/image/
      * @param $bool
+     * @return $this
      */
     public function setFaces($bool)
     {
         $this->fieldSettings['faces'] = (bool)$bool;
+        return $this;
     }
 
     /**
      * Sets the API call to return the ocr field.
      * @see https://www.diffbot.com/dev/docs/image/
      * @param $bool
+     * @return $this
      */
     public function setOcr($bool)
     {
         $this->fieldSettings['ocr'] = (bool)$bool;
+        return $this;
     }
 }

src/Api/Product.php

@@ -11,4 +11,53 @@ class Product extends Api
 
     /** @var string API URL to which to send the request */
     protected $apiUrl = 'http://api.diffbot.com/v3/product';
+
+    /**
+     * If set to false, will not extract article comments in a Discussion
+     * entity embedded in the Product entity. By default, it will.
+     * @param bool $bool
+     * @return $this
+     */
+    public function setDiscussion($bool = true)
+    {
+        $this->otherOptions['discussion'] = ($bool) ? 'true' : 'false';
+
+        return $this;
+    }
+
+    /**
+     * @see Swader\Diffbot\Entity\Product::getColors()
+     * @param $bool
+     * @return $this
+     */
+    public function setColors($bool)
+    {
+        $this->fieldSettings['colors'] = (bool)$bool;
+
+        return $this;
+    }
+
+    /**
+     * @see Swader\Diffbot\Entity\Product::getSize()
+     * @param $bool
+     * @return $this
+     */
+    public function setSize($bool)
+    {
+        $this->fieldSettings['size'] = (bool)$bool;
+
+        return $this;
+    }
+
+    /**
+     * @see Swader\Diffbot\Entity\Product::isAvailable()
+     * @param $bool
+     * @return $this
+     */
+    public function setAvailability($bool)
+    {
+        $this->fieldSettings['availability'] = (bool)$bool;
+
+        return $this;
+    }
 }

src/Entity/Article.php

@@ -51,11 +51,11 @@ public function getDate()
 
     /**
      * Returns the full name of the author, as signed on the article's page
-     * @return string
+     * @return string | null
      */
     public function getAuthor()
     {
-        return $this->data['author'];
+        return (isset($this->data['author'])) ? $this->data['author'] : null;
     }
 
     /**
@@ -112,6 +112,16 @@ public function getNextPages()
         return (isset($this->data['nextPages'])) ? $this->data['nextPages'] : [];
     }
 
+    /**
+     * Returns the sentiment score of the analyzed article text, a value randing from
+     * -1.0 (very negative) to 1.0 (very positive).
+     * @return float|null
+     */
+    public function getSentiment()
+    {
+        return (isset($this->data['sentiment'])) ? $this->data['sentiment'] : null;
+    }
+
     /**
      * Returns an array of images found in the page's content.
      *
@@ -167,17 +177,8 @@ public function getImages()
      *
      * @return array
      */
-    public function getVideos() {
-        return (isset($this->data['images'])) ? $this->data['images'] : [];
-    }
-
-    /**
-     * An internal identifier for Diffbot, used for indexing in their databases
-     * @return string
-     */
-    public function getDiffbotUri()
+    public function getVideos()
     {
-        return $this->data['diffbotUri'];
+        return (isset($this->data['videos'])) ? $this->data['videos'] : [];
     }
-
 }