├── .gitignore
├── logo.png
├── src
    ├── Providers
    │   ├── Exceptions
    │   │   ├── ErrorFetchingTwitter.php
    │   │   ├── InvalidTwitterConfiguration.php
    │   │   └── DefaultException.php
    │   ├── SocialNetworks
    │   │   ├── ProviderInterface.php
    │   │   ├── Validators
    │   │   │   └── TwitterValidator.php
    │   │   └── TwitterProvider.php
    │   ├── Sentiment
    │   │   ├── SentimentProviderInterface.php
    │   │   └── SentimentProvider.php
    │   ├── SocialNetwork.php
    │   ├── DataModels
    │   │   └── SentimentResponse.php
    │   └── SentimentAnalytics.php
    └── SentimentThermometer.php
├── examples
    └── index.php
├── composer.json
├── LICENSE
└── README.md


/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor/
2 | 


--------------------------------------------------------------------------------
/logo.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/isfonzar/sentiment-thermometer/HEAD/logo.png


--------------------------------------------------------------------------------
/src/Providers/Exceptions/ErrorFetchingTwitter.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 |     namespace iiiicaro\SentimentThermometer\Providers\Exceptions;
4 | 
5 |     class ErrorFetchingTwitter extends DefaultException
6 |     {
7 | 
8 |     }


--------------------------------------------------------------------------------
/src/Providers/Exceptions/InvalidTwitterConfiguration.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 |     namespace iiiicaro\SentimentThermometer\Providers\Exceptions;
4 | 
5 |     class InvalidTwitterConfiguration extends DefaultException
6 |     {
7 | 
8 |     }


--------------------------------------------------------------------------------
/src/Providers/SocialNetworks/ProviderInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 |     namespace iiiicaro\SentimentThermometer\Providers\SocialNetworks;
4 | 
5 |     interface ProviderInterface
6 |     {
7 |         public function getByKeyword($keyword);
8 |     }


--------------------------------------------------------------------------------
/src/Providers/Sentiment/SentimentProviderInterface.php:
--------------------------------------------------------------------------------
1 | <?php
2 | 
3 |     namespace iiiicaro\SentimentThermometer\Providers\Sentiment;
4 | 
5 |     interface SentimentProviderInterface
6 |     {
7 |         public function score($sentence);
8 |     }


--------------------------------------------------------------------------------
/src/Providers/Exceptions/DefaultException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer\Providers\Exceptions;
 4 | 
 5 |     abstract class DefaultException extends \Exception
 6 |     {
 7 |         /**
 8 |          * @var null|string
 9 |          */
10 |         public $message;
11 | 
12 |         /**
13 |          * ErrorFetchingTwitter constructor.
14 |          *
15 |          * @param null|string $message
16 |          */
17 |         public function __construct($message = null)
18 |         {
19 |             $this->message = $message;
20 |         }
21 |     }


--------------------------------------------------------------------------------
/examples/index.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     require(__DIR__ . '/../vendor/autoload.php');
 4 | 
 5 |     use iiiicaro\SentimentThermometer\SentimentThermometer;
 6 | 
 7 |     $config = [
 8 |         'twitter' => [
 9 |             'consumer_key' => 'CONSUMER_KEY_HERE',
10 |             'consumer_secret' => 'CONSUMER_SECRET_HERE',
11 |             'type' => 'recent',
12 |             'count' => '100'
13 |         ]
14 |     ];
15 | 
16 |     $sentimentThermometer = new SentimentThermometer($config);
17 | 
18 |     $thermomether = $sentimentThermometer->get('Donald Trump');
19 | 
20 |     print_r($thermomether);


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "iiiicaro/sentiment-thermometer",
 3 |     "description": "Measure the sentiment around a word, name, sentence or hashtag using social networks.",
 4 |     "type": "library",
 5 |     "require": {
 6 |         "jwhennessey/phpinsight": "v2.0.9",
 7 |         "abraham/twitteroauth": "v0.7.2"
 8 |     },
 9 |     "license": "MIT",
10 |     "authors": [
11 |         {
12 |             "name": "icaro",
13 |             "email": "icaro.isf@gmail.com"
14 |         }
15 |     ],
16 |     "autoload": {
17 |         "psr-4": {
18 |             "iiiicaro\\SentimentThermometer\\": "src/"
19 |         }
20 |     }
21 | }
22 | 


--------------------------------------------------------------------------------
/src/Providers/Sentiment/SentimentProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer\Providers\Sentiment;
 4 | 
 5 |     use PHPInsight\Sentiment;
 6 | 
 7 |     class SentimentProvider implements SentimentProviderInterface
 8 |     {
 9 |         /**
10 |          * @var \PHPInsight\Sentiment
11 |          */
12 |         private $sentiment;
13 | 
14 |         /**
15 |          * SentimentProvider constructor.
16 |          */
17 |         public function __construct()
18 |         {
19 |             $this->sentiment = new Sentiment();
20 |         }
21 | 
22 |         /**
23 |          * @param $sentence
24 |          *
25 |          * @return int
26 |          */
27 |         public function score($sentence)
28 |         {
29 |             return $this->sentiment->score($sentence);
30 |         }
31 |     }


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | MIT License
 2 | 
 3 | Copyright (c) 2017 Icaro Souza Fonzar
 4 | 
 5 | Permission is hereby granted, free of charge, to any person obtaining a copy
 6 | of this software and associated documentation files (the "Software"), to deal
 7 | in the Software without restriction, including without limitation the rights
 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 | 
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 | 
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 | 


--------------------------------------------------------------------------------
/src/Providers/SocialNetwork.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer\Providers;
 4 | 
 5 |     use iiiicaro\SentimentThermometer\Providers\SocialNetworks\ProviderInterface;
 6 |     use iiiicaro\SentimentThermometer\Providers\SocialNetworks\TwitterProvider;
 7 | 
 8 |     class SocialNetwork
 9 |     {
10 |         /**
11 |          * @var null|TwitterProvider
12 |          */
13 |         private $twitterProvider;
14 | 
15 |         /**
16 |          * @var array
17 |          */
18 |         private $settings;
19 | 
20 |         /**
21 |          * SocialNetwork constructor.
22 |          *
23 |          * @param array $settings
24 |          */
25 |         public function __construct($settings)
26 |         {
27 |             $this->settings = $settings;
28 |         }
29 | 
30 |         /**
31 |          * @param $keyword
32 |          *
33 |          * @return array
34 |          */
35 |         public function get($keyword)
36 |         {
37 |             $response = [];
38 | 
39 |             if (!empty($this->twitterProvider))
40 |             {
41 |                 $results = $this->twitterProvider->getByKeyword($keyword);
42 | 
43 |                 $response = array_merge($response, $results);
44 |             }
45 | 
46 |             return $response;
47 |         }
48 | 
49 |         /**
50 |          * @param \iiiicaro\SentimentThermometer\Providers\SocialNetworks\ProviderInterface $twitterProvider
51 |          */
52 |         public function setTwitter(ProviderInterface $twitterProvider)
53 |         {
54 |             $this->twitterProvider = $twitterProvider;
55 |         }
56 |     }


--------------------------------------------------------------------------------
/src/SentimentThermometer.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer;
 4 | 
 5 |     use iiiicaro\SentimentThermometer\Providers\Sentiment\SentimentProvider;
 6 |     use iiiicaro\SentimentThermometer\Providers\SentimentAnalytics;
 7 |     use iiiicaro\SentimentThermometer\Providers\SocialNetwork;
 8 |     use iiiicaro\SentimentThermometer\Providers\SocialNetworks\TwitterProvider;
 9 | 
10 |     class SentimentThermometer
11 |     {
12 |         /**
13 |          * @var \iiiicaro\SentimentThermometer\Providers\SocialNetwork
14 |          */
15 |         private $socialNetwork;
16 | 
17 |         /**
18 |          * @var \iiiicaro\SentimentThermometer\Providers\SentimentAnalytics
19 |          */
20 |         private $sentimentAnalytics;
21 | 
22 |         /**
23 |          * SentimentThermometer constructor.
24 |          *
25 |          * @param array $settings
26 |          */
27 |         public function __construct($settings)
28 |         {
29 |             $this->socialNetwork = new SocialNetwork($settings);
30 |             $this->socialNetwork->setTwitter(new TwitterProvider($settings));
31 | 
32 |             $this->sentimentAnalytics = new SentimentAnalytics(new SentimentProvider());
33 |         }
34 | 
35 |         /**
36 |          * @param $keyword
37 |          *
38 |          * @return \iiiicaro\SentimentThermometer\Providers\DataModels\SentimentResponse
39 |          */
40 |         public function get($keyword)
41 |         {
42 |             $results = $this->socialNetwork->get($keyword);
43 | 
44 |             $results = $this->sentimentAnalytics->analyze($results);
45 | 
46 |             return $results;
47 |         }
48 |     }


--------------------------------------------------------------------------------
/src/Providers/DataModels/SentimentResponse.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer\Providers\DataModels;
 4 | 
 5 |     class SentimentResponse
 6 |     {
 7 |         /**
 8 |          * @var float
 9 |          */
10 |         public $positive = 0.0;
11 | 
12 |         /**
13 |          * @var float
14 |          */
15 |         public $negative = 0.0;
16 | 
17 |         /**
18 |          * @var float
19 |          */
20 |         public $neutral = 0.0;
21 | 
22 |         /**
23 |          * @param float $positive
24 |          *
25 |          * @return SentimentResponse
26 |          */
27 |         public function sumPositive($positive)
28 |         {
29 |             $this->positive += $positive;
30 | 
31 |             return $this;
32 |         }
33 | 
34 |         /**
35 |          * @param float $negative
36 |          *
37 |          * @return SentimentResponse
38 |          */
39 |         public function sumNegative($negative)
40 |         {
41 |             $this->negative += $negative;
42 | 
43 |             return $this;
44 |         }
45 | 
46 |         /**
47 |          * @param float $neutral
48 |          *
49 |          * @return SentimentResponse
50 |          */
51 |         public function sumNeutral($neutral)
52 |         {
53 |             $this->neutral += $neutral;
54 | 
55 |             return $this;
56 |         }
57 | 
58 |         /**
59 |          * @param int $divisor
60 |          *
61 |          * @return SentimentResponse
62 |          */
63 |         public function divideAllFields($divisor)
64 |         {
65 |             $this->positive = $this->positive / $divisor;
66 |             $this->negative = $this->negative / $divisor;
67 |             $this->neutral = $this->neutral / $divisor;
68 | 
69 |             return $this;
70 |         }
71 |     }


--------------------------------------------------------------------------------
/src/Providers/SentimentAnalytics.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer\Providers;
 4 | 
 5 |     use iiiicaro\SentimentThermometer\Providers\Sentiment\SentimentProviderInterface;
 6 |     use iiiicaro\SentimentThermometer\Providers\DataModels\SentimentResponse;
 7 | 
 8 |     class SentimentAnalytics
 9 |     {
10 |         /**
11 |          * @var \PHPInsight\Sentiment
12 |          */
13 |         private $sentimentProvider;
14 | 
15 |         /**
16 |          * SentimentAnalytics constructor.
17 |          *
18 |          * @param \iiiicaro\SentimentThermometer\Providers\Sentiment\SentimentProviderInterface $sentimentProvider
19 |          */
20 |         public function __construct(SentimentProviderInterface $sentimentProvider)
21 |         {
22 |             $this->sentimentProvider = $sentimentProvider;
23 |         }
24 | 
25 |         /**
26 |          * @param $results
27 |          *
28 |          * @return \iiiicaro\SentimentThermometer\Providers\DataModels\SentimentResponse
29 |          */
30 |         public function analyze($results)
31 |         {
32 |             $sentimentResponse = new SentimentResponse();
33 | 
34 |             if (empty($results))
35 |             {
36 |                 return $sentimentResponse;
37 |             }
38 | 
39 |             foreach ($results as $sentence)
40 |             {
41 |                 $sentenceAnalysis = $this->sentimentProvider->score($sentence);
42 | 
43 |                 $sentimentResponse
44 |                     ->sumPositive($sentenceAnalysis['pos'])
45 |                     ->sumNegative($sentenceAnalysis['neg'])
46 |                     ->sumNeutral($sentenceAnalysis['neu']);
47 |             }
48 | 
49 |             $sentimentResponse->divideAllFields(count($results));
50 | 
51 |             return $sentimentResponse;
52 |         }
53 |     }


--------------------------------------------------------------------------------
/src/Providers/SocialNetworks/Validators/TwitterValidator.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer\Providers\SocialNetworks\Validators;
 4 | 
 5 |     use iiiicaro\SentimentThermometer\Providers\Exceptions\InvalidTwitterConfiguration;
 6 | 
 7 |     class TwitterValidator
 8 |     {
 9 |         /**
10 |          * TwitterValidator constructor.
11 |          *
12 |          * @param $settings
13 |          *
14 |          * @throws \iiiicaro\SentimentThermometer\Providers\Exceptions\InvalidTwitterConfiguration
15 |          */
16 |         public function __construct($settings)
17 |         {
18 |             if (empty($settings))
19 |             {
20 |                 throw new InvalidTwitterConfiguration('Twitter settings missing.');
21 |             }
22 | 
23 |             if (!$this->validateConsumerKey($settings))
24 |             {
25 |                 throw new InvalidTwitterConfiguration('Twitter consumer key missing.');
26 |             }
27 | 
28 |             if (!$this->validateConsumerSecret($settings))
29 |             {
30 |                 throw new InvalidTwitterConfiguration('Twitter consumer secret missing.');
31 |             }
32 |         }
33 | 
34 |         /**
35 |          * @param $settings
36 |          *
37 |          * @return bool
38 |          */
39 |         private function validateConsumerKey($settings)
40 |         {
41 |             if (empty($settings['consumer_key']))
42 |             {
43 |                 return false;
44 |             }
45 | 
46 |             return true;
47 |         }
48 | 
49 |         /**
50 |          * @param $settings
51 |          *
52 |          * @return bool
53 |          */
54 |         private function validateConsumerSecret($settings)
55 |         {
56 |             if (empty($settings['consumer_key']))
57 |             {
58 |                 return false;
59 |             }
60 | 
61 |             return true;
62 |         }
63 |     }


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | <p align="center"><img src="https://cdn.rawgit.com/iiiicaro/sentiment-thermometer/30e4f410/logo.png"></p>
 2 | 
 3 | <p align="center">
 4 | <a href="https://packagist.org/packages/iiiicaro/sentiment-thermometer"><img src="https://img.shields.io/badge/Language-PHP-brightgreen.svg" alt="Language"></a>
 5 | <a href="https://packagist.org/packages/iiiicaro/sentiment-thermometer"><img src="https://img.shields.io/badge/License-MIT-blue.svg" alt="License"></a>
 6 | <a href="https://packagist.org/packages/iiiicaro/sentiment-thermometer"><img src="https://img.shields.io/badge/Version-1.0-brightgreen.svg" alt="Latest Stable Version"></a>
 7 | </p>
 8 | 
 9 | ## About Sentiment Thermometer
10 | Sentiment Thermometer is a library and tool to measure the sentiment around a word, name, sentence or hashtag using social networks.
11 | 
12 | ![](http://i.imgur.com/UZyHxN1.gif)
13 | 
14 | ## Features
15 | 
16 | - Fully integrated with twitter feed
17 | - Positive/negative/neutral analysis
18 | - EASY to incorporate on your projects
19 | - CUSTOMIZE to your needs
20 | - STUPIDLY [EASY TO USE](https://github.com/iiiicaro/SentimentThermometer#usage)
21 | - Very fast start up and response time
22 | 
23 | ## Installation
24 | 
25 | ### Composer
26 | 
27 | ```bash
28 | $ composer require iiiicaro/sentiment-thermometer 
29 | ```
30 | 
31 | ## Usage
32 | 
33 | ### Basic usage
34 | 
35 | ```php
36 | <?php
37 | 
38 | require(__DIR__ . '/../vendor/autoload.php');
39 | 
40 | use iiiicaro\SentimentThermometer\SentimentThermometer;
41 | 
42 | $config = [
43 |     'twitter' => [
44 |         'consumer_key' => 'CONSUMER_KEY_HERE',
45 |         'consumer_secret' => 'CONSUMER_SECRET_HERE',
46 |     ]
47 | ];
48 | 
49 | $sentimentThermometer = new SentimentThermometer($config);
50 | $thermomether = $sentimentThermometer->get('Donald Trump');
51 | 
52 | print_r($thermomether);
53 | ```
54 | 
55 | ## Contributing
56 | 
57 | ### Bug Reports & Feature Requests
58 | 
59 | Please use the [issue tracker](https://github.com/iiiicaro/sentiment-thermometer/issues) to report any bugs or feature requests.
60 | 
61 | ## Social Coding
62 | 
63 | 1. Create an issue to discuss about your idea
64 | 2. [Fork it] (https://github.com/iiiicaro/sentiment-thermometer/fork)
65 | 3. Create your feature branch (`git checkout -b my-new-feature`)
66 | 4. Commit your changes (`git commit -am 'Add some feature'`)
67 | 5. Push to the branch (`git push origin my-new-feature`)
68 | 6. Create a new Pull Request
69 | 7. Profit! :white_check_mark:
70 | 


--------------------------------------------------------------------------------
/src/Providers/SocialNetworks/TwitterProvider.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 |     namespace iiiicaro\SentimentThermometer\Providers\SocialNetworks;
 4 | 
 5 |     use Abraham\TwitterOAuth\TwitterOAuth;
 6 |     use iiiicaro\SentimentThermometer\Providers\Exceptions\ErrorFetchingTwitter;
 7 |     use iiiicaro\SentimentThermometer\Providers\Exceptions\InvalidTwitterConfiguration;
 8 |     use iiiicaro\SentimentThermometer\Providers\SocialNetworks\Validators\TwitterValidator;
 9 | 
10 |     class TwitterProvider implements ProviderInterface
11 |     {
12 |         /**
13 |          * @var \Abraham\TwitterOAuth\TwitterOAuth
14 |          */
15 |         private $twitterProvider;
16 | 
17 |         /**
18 |          * @var int
19 |          */
20 |         private $amount;
21 | 
22 |         /**
23 |          * @var string
24 |          */
25 |         private $type;
26 | 
27 |         /**
28 |          * TwitterProvider constructor.
29 |          *
30 |          * @param $settings
31 |          *
32 |          * @throws \iiiicaro\SentimentThermometer\Providers\Exceptions\InvalidTwitterConfiguration
33 |          */
34 |         public function __construct($settings)
35 |         {
36 |             if (empty($settings['twitter']))
37 |             {
38 |                 throw new InvalidTwitterConfiguration('Twitter settings not found.');
39 |             }
40 | 
41 |             $settings = $settings['twitter'];
42 | 
43 |             $twitterValidator = new TwitterValidator($settings);
44 | 
45 |             if ($twitterValidator instanceof \Exception)
46 |             {
47 |                 throw new InvalidTwitterConfiguration($twitterValidator->getMessage());
48 |             }
49 | 
50 |             $this->twitterProvider = new TwitterOAuth($settings['consumer_key'], $settings['consumer_secret']);
51 | 
52 |             $this->amount = isset($settings['count']) ? $settings['count'] : 50;
53 |             $this->type   = isset($settings['type']) ? $settings['type'] : 'recent';
54 |         }
55 | 
56 |         /**
57 |          * @param $keyword
58 |          *
59 |          * @return array
60 |          */
61 |         public function getByKeyword($keyword)
62 |         {
63 |             $results = $this->twitterProvider->get("search/tweets", [
64 |                 "q"           => $keyword,
65 |                 "result_type" => $this->type,
66 |                 "count"       => $this->amount,
67 |             ]);
68 | 
69 |             return $this->processResults($results);
70 |         }
71 | 
72 |         /**
73 |          * @param $results
74 |          *
75 |          * @return array
76 |          * @throws \iiiicaro\SentimentThermometer\Providers\Exceptions\ErrorFetchingTwitter
77 |          */
78 |         private function processResults($results)
79 |         {
80 |             if (!empty($results->errors))
81 |             {
82 |                 throw new ErrorFetchingTwitter();
83 |             }
84 | 
85 |             $response = [];
86 | 
87 |             foreach ($results->statuses as $tweet)
88 |             {
89 |                 $response[] = $tweet->text;
90 |             }
91 | 
92 |             return $response;
93 |         }
94 |     }


--------------------------------------------------------------------------------