├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── composer.json ├── phpunit.xml.dist ├── src ├── ConnectLimitExceededException.php ├── Connection.php ├── Location │ ├── Box.php │ ├── Circle.php │ ├── Collection.php │ └── LocationInterface.php ├── Monitor.php ├── Oauth.php ├── StreamReader.php ├── StreamingBird.php ├── Stub │ └── TwitterStream.php └── TwitterException.php └── tests ├── ConnectionTest.php ├── Location ├── BoxTest.php ├── CircleTest.php └── CollectionTest.php ├── MonitorTest.php ├── OauthTest.php ├── Resources ├── bin │ └── stub-success.php └── stream.txt └── StreamReaderTest.php /.gitignore: -------------------------------------------------------------------------------- 1 | composer.lock 2 | vendor -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: php 2 | php: 3 | - '5.6' 4 | - '7.0' 5 | - 'nightly' 6 | - 'hhvm' 7 | 8 | before_install: 9 | - composer self-update 10 | 11 | install: 12 | - composer --prefer-dist -n install 13 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 2, June 1991 3 | 4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc., 5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA 6 | Everyone is permitted to copy and distribute verbatim copies 7 | of this license document, but changing it is not allowed. 8 | 9 | Preamble 10 | 11 | The licenses for most software are designed to take away your 12 | freedom to share and change it. By contrast, the GNU General Public 13 | License is intended to guarantee your freedom to share and change free 14 | software--to make sure the software is free for all its users. This 15 | General Public License applies to most of the Free Software 16 | Foundation's software and to any other program whose authors commit to 17 | using it. (Some other Free Software Foundation software is covered by 18 | the GNU Lesser General Public License instead.) You can apply it to 19 | your programs, too. 20 | 21 | When we speak of free software, we are referring to freedom, not 22 | price. Our General Public Licenses are designed to make sure that you 23 | have the freedom to distribute copies of free software (and charge for 24 | this service if you wish), that you receive source code or can get it 25 | if you want it, that you can change the software or use pieces of it 26 | in new free programs; and that you know you can do these things. 27 | 28 | To protect your rights, we need to make restrictions that forbid 29 | anyone to deny you these rights or to ask you to surrender the rights. 30 | These restrictions translate to certain responsibilities for you if you 31 | distribute copies of the software, or if you modify it. 32 | 33 | For example, if you distribute copies of such a program, whether 34 | gratis or for a fee, you must give the recipients all the rights that 35 | you have. You must make sure that they, too, receive or can get the 36 | source code. And you must show them these terms so they know their 37 | rights. 38 | 39 | We protect your rights with two steps: (1) copyright the software, and 40 | (2) offer you this license which gives you legal permission to copy, 41 | distribute and/or modify the software. 42 | 43 | Also, for each author's protection and ours, we want to make certain 44 | that everyone understands that there is no warranty for this free 45 | software. If the software is modified by someone else and passed on, we 46 | want its recipients to know that what they have is not the original, so 47 | that any problems introduced by others will not reflect on the original 48 | authors' reputations. 49 | 50 | Finally, any free program is threatened constantly by software 51 | patents. We wish to avoid the danger that redistributors of a free 52 | program will individually obtain patent licenses, in effect making the 53 | program proprietary. To prevent this, we have made it clear that any 54 | patent must be licensed for everyone's free use or not licensed at all. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | GNU GENERAL PUBLIC LICENSE 60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION 61 | 62 | 0. This License applies to any program or other work which contains 63 | a notice placed by the copyright holder saying it may be distributed 64 | under the terms of this General Public License. The "Program", below, 65 | refers to any such program or work, and a "work based on the Program" 66 | means either the Program or any derivative work under copyright law: 67 | that is to say, a work containing the Program or a portion of it, 68 | either verbatim or with modifications and/or translated into another 69 | language. (Hereinafter, translation is included without limitation in 70 | the term "modification".) Each licensee is addressed as "you". 71 | 72 | Activities other than copying, distribution and modification are not 73 | covered by this License; they are outside its scope. The act of 74 | running the Program is not restricted, and the output from the Program 75 | is covered only if its contents constitute a work based on the 76 | Program (independent of having been made by running the Program). 77 | Whether that is true depends on what the Program does. 78 | 79 | 1. You may copy and distribute verbatim copies of the Program's 80 | source code as you receive it, in any medium, provided that you 81 | conspicuously and appropriately publish on each copy an appropriate 82 | copyright notice and disclaimer of warranty; keep intact all the 83 | notices that refer to this License and to the absence of any warranty; 84 | and give any other recipients of the Program a copy of this License 85 | along with the Program. 86 | 87 | You may charge a fee for the physical act of transferring a copy, and 88 | you may at your option offer warranty protection in exchange for a fee. 89 | 90 | 2. You may modify your copy or copies of the Program or any portion 91 | of it, thus forming a work based on the Program, and copy and 92 | distribute such modifications or work under the terms of Section 1 93 | above, provided that you also meet all of these conditions: 94 | 95 | a) You must cause the modified files to carry prominent notices 96 | stating that you changed the files and the date of any change. 97 | 98 | b) You must cause any work that you distribute or publish, that in 99 | whole or in part contains or is derived from the Program or any 100 | part thereof, to be licensed as a whole at no charge to all third 101 | parties under the terms of this License. 102 | 103 | c) If the modified program normally reads commands interactively 104 | when run, you must cause it, when started running for such 105 | interactive use in the most ordinary way, to print or display an 106 | announcement including an appropriate copyright notice and a 107 | notice that there is no warranty (or else, saying that you provide 108 | a warranty) and that users may redistribute the program under 109 | these conditions, and telling the user how to view a copy of this 110 | License. (Exception: if the Program itself is interactive but 111 | does not normally print such an announcement, your work based on 112 | the Program is not required to print an announcement.) 113 | 114 | These requirements apply to the modified work as a whole. If 115 | identifiable sections of that work are not derived from the Program, 116 | and can be reasonably considered independent and separate works in 117 | themselves, then this License, and its terms, do not apply to those 118 | sections when you distribute them as separate works. But when you 119 | distribute the same sections as part of a whole which is a work based 120 | on the Program, the distribution of the whole must be on the terms of 121 | this License, whose permissions for other licensees extend to the 122 | entire whole, and thus to each and every part regardless of who wrote it. 123 | 124 | Thus, it is not the intent of this section to claim rights or contest 125 | your rights to work written entirely by you; rather, the intent is to 126 | exercise the right to control the distribution of derivative or 127 | collective works based on the Program. 128 | 129 | In addition, mere aggregation of another work not based on the Program 130 | with the Program (or with a work based on the Program) on a volume of 131 | a storage or distribution medium does not bring the other work under 132 | the scope of this License. 133 | 134 | 3. You may copy and distribute the Program (or a work based on it, 135 | under Section 2) in object code or executable form under the terms of 136 | Sections 1 and 2 above provided that you also do one of the following: 137 | 138 | a) Accompany it with the complete corresponding machine-readable 139 | source code, which must be distributed under the terms of Sections 140 | 1 and 2 above on a medium customarily used for software interchange; or, 141 | 142 | b) Accompany it with a written offer, valid for at least three 143 | years, to give any third party, for a charge no more than your 144 | cost of physically performing source distribution, a complete 145 | machine-readable copy of the corresponding source code, to be 146 | distributed under the terms of Sections 1 and 2 above on a medium 147 | customarily used for software interchange; or, 148 | 149 | c) Accompany it with the information you received as to the offer 150 | to distribute corresponding source code. (This alternative is 151 | allowed only for noncommercial distribution and only if you 152 | received the program in object code or executable form with such 153 | an offer, in accord with Subsection b above.) 154 | 155 | The source code for a work means the preferred form of the work for 156 | making modifications to it. For an executable work, complete source 157 | code means all the source code for all modules it contains, plus any 158 | associated interface definition files, plus the scripts used to 159 | control compilation and installation of the executable. However, as a 160 | special exception, the source code distributed need not include 161 | anything that is normally distributed (in either source or binary 162 | form) with the major components (compiler, kernel, and so on) of the 163 | operating system on which the executable runs, unless that component 164 | itself accompanies the executable. 165 | 166 | If distribution of executable or object code is made by offering 167 | access to copy from a designated place, then offering equivalent 168 | access to copy the source code from the same place counts as 169 | distribution of the source code, even though third parties are not 170 | compelled to copy the source along with the object code. 171 | 172 | 4. You may not copy, modify, sublicense, or distribute the Program 173 | except as expressly provided under this License. Any attempt 174 | otherwise to copy, modify, sublicense or distribute the Program is 175 | void, and will automatically terminate your rights under this License. 176 | However, parties who have received copies, or rights, from you under 177 | this License will not have their licenses terminated so long as such 178 | parties remain in full compliance. 179 | 180 | 5. You are not required to accept this License, since you have not 181 | signed it. However, nothing else grants you permission to modify or 182 | distribute the Program or its derivative works. These actions are 183 | prohibited by law if you do not accept this License. Therefore, by 184 | modifying or distributing the Program (or any work based on the 185 | Program), you indicate your acceptance of this License to do so, and 186 | all its terms and conditions for copying, distributing or modifying 187 | the Program or works based on it. 188 | 189 | 6. Each time you redistribute the Program (or any work based on the 190 | Program), the recipient automatically receives a license from the 191 | original licensor to copy, distribute or modify the Program subject to 192 | these terms and conditions. You may not impose any further 193 | restrictions on the recipients' exercise of the rights granted herein. 194 | You are not responsible for enforcing compliance by third parties to 195 | this License. 196 | 197 | 7. If, as a consequence of a court judgment or allegation of patent 198 | infringement or for any other reason (not limited to patent issues), 199 | conditions are imposed on you (whether by court order, agreement or 200 | otherwise) that contradict the conditions of this License, they do not 201 | excuse you from the conditions of this License. If you cannot 202 | distribute so as to satisfy simultaneously your obligations under this 203 | License and any other pertinent obligations, then as a consequence you 204 | may not distribute the Program at all. For example, if a patent 205 | license would not permit royalty-free redistribution of the Program by 206 | all those who receive copies directly or indirectly through you, then 207 | the only way you could satisfy both it and this License would be to 208 | refrain entirely from distribution of the Program. 209 | 210 | If any portion of this section is held invalid or unenforceable under 211 | any particular circumstance, the balance of the section is intended to 212 | apply and the section as a whole is intended to apply in other 213 | circumstances. 214 | 215 | It is not the purpose of this section to induce you to infringe any 216 | patents or other property right claims or to contest validity of any 217 | such claims; this section has the sole purpose of protecting the 218 | integrity of the free software distribution system, which is 219 | implemented by public license practices. Many people have made 220 | generous contributions to the wide range of software distributed 221 | through that system in reliance on consistent application of that 222 | system; it is up to the author/donor to decide if he or she is willing 223 | to distribute software through any other system and a licensee cannot 224 | impose that choice. 225 | 226 | This section is intended to make thoroughly clear what is believed to 227 | be a consequence of the rest of this License. 228 | 229 | 8. If the distribution and/or use of the Program is restricted in 230 | certain countries either by patents or by copyrighted interfaces, the 231 | original copyright holder who places the Program under this License 232 | may add an explicit geographical distribution limitation excluding 233 | those countries, so that distribution is permitted only in or among 234 | countries not thus excluded. In such case, this License incorporates 235 | the limitation as if written in the body of this License. 236 | 237 | 9. The Free Software Foundation may publish revised and/or new versions 238 | of the General Public License from time to time. Such new versions will 239 | be similar in spirit to the present version, but may differ in detail to 240 | address new problems or concerns. 241 | 242 | Each version is given a distinguishing version number. If the Program 243 | specifies a version number of this License which applies to it and "any 244 | later version", you have the option of following the terms and conditions 245 | either of that version or of any later version published by the Free 246 | Software Foundation. If the Program does not specify a version number of 247 | this License, you may choose any version ever published by the Free Software 248 | Foundation. 249 | 250 | 10. If you wish to incorporate parts of the Program into other free 251 | programs whose distribution conditions are different, write to the author 252 | to ask for permission. For software which is copyrighted by the Free 253 | Software Foundation, write to the Free Software Foundation; we sometimes 254 | make exceptions for this. Our decision will be guided by the two goals 255 | of preserving the free status of all derivatives of our free software and 256 | of promoting the sharing and reuse of software generally. 257 | 258 | NO WARRANTY 259 | 260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY 261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN 262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES 263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED 264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS 266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE 267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, 268 | REPAIR OR CORRECTION. 269 | 270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR 272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, 273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING 274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED 275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY 276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER 277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE 278 | POSSIBILITY OF SUCH DAMAGES. 279 | 280 | END OF TERMS AND CONDITIONS 281 | 282 | How to Apply These Terms to Your New Programs 283 | 284 | If you develop a new program, and you want it to be of the greatest 285 | possible use to the public, the best way to achieve this is to make it 286 | free software which everyone can redistribute and change under these terms. 287 | 288 | To do so, attach the following notices to the program. It is safest 289 | to attach them to the start of each source file to most effectively 290 | convey the exclusion of warranty; and each file should have at least 291 | the "copyright" line and a pointer to where the full notice is found. 292 | 293 | {description} 294 | Copyright (C) {year} {fullname} 295 | 296 | This program is free software; you can redistribute it and/or modify 297 | it under the terms of the GNU General Public License as published by 298 | the Free Software Foundation; either version 2 of the License, or 299 | (at your option) any later version. 300 | 301 | This program is distributed in the hope that it will be useful, 302 | but WITHOUT ANY WARRANTY; without even the implied warranty of 303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 304 | GNU General Public License for more details. 305 | 306 | You should have received a copy of the GNU General Public License along 307 | with this program; if not, write to the Free Software Foundation, Inc., 308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. 309 | 310 | Also add information on how to contact you by electronic and paper mail. 311 | 312 | If the program is interactive, make it output a short notice like this 313 | when it starts in an interactive mode: 314 | 315 | Gnomovision version 69, Copyright (C) year name of author 316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 317 | This is free software, and you are welcome to redistribute it 318 | under certain conditions; type `show c' for details. 319 | 320 | The hypothetical commands `show w' and `show c' should show the appropriate 321 | parts of the General Public License. Of course, the commands you use may 322 | be called something other than `show w' and `show c'; they could even be 323 | mouse-clicks or menu items--whatever suits your program. 324 | 325 | You should also get your employer (if you work as a programmer) or your 326 | school, if any, to sign a "copyright disclaimer" for the program, if 327 | necessary. Here is a sample; alter the names: 328 | 329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program 330 | `Gnomovision' (which makes passes at compilers) written by James Hacker. 331 | 332 | {signature of Ty Coon}, 1 April 1989 333 | Ty Coon, President of Vice 334 | 335 | This General Public License does not permit incorporating your program into 336 | proprietary programs. If your program is a subroutine library, you may 337 | consider it more useful to permit linking proprietary applications with the 338 | library. If this is what you want to do, use the GNU Lesser General 339 | Public License instead of this License. 340 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | StreamingBird is an automatically tested, PSR-4 compliant client for Twitter's streaming API. 2 | 3 | [![Build Status](https://travis-ci.org/OwlyCode/StreamingBird.svg?branch=master)](https://travis-ci.org/OwlyCode/StreamingBird) 4 | 5 | How to install 6 | -------------- 7 | 8 | With composer : `composer require owlycode/streaming-bird`. 9 | 10 | Example usage 11 | ------------- 12 | 13 | ```php 14 | use OwlyCode\StreamingBird\StreamReader; 15 | use OwlyCode\StreamingBird\StreamingBird; 16 | 17 | // Change these with yours. 18 | $oauthToken = 'my token'; 19 | $oauthSecret = 'secret'; 20 | $consumerKey = 'my key'; 21 | $consumerSecret = 'secret'; 22 | 23 | $bird = new StreamingBird($consumerKey, $consumerSecret, $oauthToken, $oauthSecret); 24 | 25 | $bird 26 | ->createStreamReader(StreamReader::METHOD_FILTER) 27 | ->setTrack(['hello', 'hola', 'bonjour']) // Fetch every tweet containing one of the following words 28 | ->consume(function ($tweet) { // Now we provide a callback to execute on every received tweet. 29 | echo '------------------------' . "\n"; 30 | echo $tweet['text'] . "\n"; 31 | }) 32 | ; 33 | 34 | ``` 35 | 36 | Monitoring 37 | ---------- 38 | 39 | StreamingBird comes with some statistics about the stream that you can access. At the moment 40 | it is an early approach with few informations but it is meant to grow in the future. 41 | 42 | ```php 43 | $reader->consume(function ($tweet, $monitor) use ($output) { 44 | echo '------------------------' . "\n"; 45 | echo $monitor->get('tweets') . "\n"; // The total number of received tweets 46 | echo $monitor->get('idle_time') . "\n"; // Elapsed seconds between the last two tweets. 47 | echo $monitor->get('max_idle_time') . "\n"; // The maximum idle time since the beginning. 48 | echo $tweet['text'] . "\n"; 49 | }); 50 | ``` 51 | 52 | Running the tests 53 | ----------------- 54 | 55 | Simply run : 56 | 57 | ```bash 58 | composer install 59 | ./bin/vendor/phpunit 60 | ``` -------------------------------------------------------------------------------- /composer.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "owlycode/streaming-bird", 3 | "description": "A PHP client for the Twitter Streaming APIs inspired from Phirehose.", 4 | "keywords": ["php", "twitter", "streaming", "api"], 5 | "type": "library", 6 | "homepage": "https://github.com/OwlyCode/StreamingBird", 7 | "license": "LGPL-2.0-only", 8 | "authors": [ 9 | { 10 | "name": "OwlyCode", 11 | "email": "tmaindron@gmail.com" 12 | } 13 | ], 14 | "require": { 15 | "php": "~5.6|~7.0" 16 | }, 17 | "require-dev": { 18 | "phpunit/phpunit": "~4.7", 19 | "symfony/process": "~3.0" 20 | }, 21 | "autoload": { 22 | "psr-4": { 23 | "OwlyCode\\StreamingBird\\": "src/", 24 | "OwlyCode\\StreamingBird\\Tests\\": "tests/" 25 | } 26 | } 27 | } 28 | -------------------------------------------------------------------------------- /phpunit.xml.dist: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | tests 17 | 18 | 19 | 20 | 21 | 22 | src 23 | 24 | 25 | 26 | -------------------------------------------------------------------------------- /src/ConnectLimitExceededException.php: -------------------------------------------------------------------------------- 1 | buffer = ''; 34 | 35 | @$this->connection = fsockopen($host, $port, $errNo, $errStr, $timeout); 36 | 37 | while (!$this->connection || !is_resource($this->connection)) { 38 | $attempts--; 39 | 40 | if ($attempts <= 0) { 41 | throw new ConnectLimitExceededException($errStr, $errNo); 42 | } 43 | 44 | sleep(self::RETRY_TIME); 45 | @$this->connection = fsockopen($host, $port, $errNo, $errStr, $timeout); 46 | } 47 | } 48 | 49 | /** 50 | * @param string $url 51 | * @param array $params 52 | * @param string $credentials 53 | */ 54 | public function authenticate($url, array $params, $credentials) 55 | { 56 | stream_set_blocking($this->connection, 1); 57 | 58 | $urlParts = parse_url($url); 59 | $postData = http_build_query($params, null, '&', PHP_QUERY_RFC3986); 60 | 61 | $streamHeaders = "POST " . $urlParts['path'] . " HTTP/1.1\r\n"; 62 | $streamHeaders.= "Host: " . $urlParts['host'] . "\r\n"; 63 | $streamHeaders.= "Connection: Close\r\n"; 64 | $streamHeaders.= "Content-type: application/x-www-form-urlencoded\r\n"; 65 | $streamHeaders.= "Content-length: " . strlen($postData) . "\r\n"; 66 | $streamHeaders.= "Accept: */*\r\n"; 67 | $streamHeaders.= 'Authorization: ' . $credentials . "\r\n"; 68 | $streamHeaders.= 'User-Agent: ' . self::USER_AGENT . "\r\n"; 69 | $streamHeaders.= "\r\n"; 70 | $streamHeaders.= $postData . "\r\n"; 71 | $streamHeaders.= "\r\n"; 72 | 73 | fwrite($this->connection, $streamHeaders); 74 | 75 | list($httpVer, $httpCode, $httpMessage) = preg_split('/\s+/', trim(fgets($this->connection, 1024)), 3); 76 | 77 | $respHeaders = $respBody = ''; 78 | $isChunking = false; 79 | 80 | while ($hLine = trim(fgets($this->connection, 4096))) { 81 | 82 | $respHeaders .= $hLine."\n"; 83 | if (strtolower($hLine) == 'transfer-encoding: chunked') { 84 | $isChunking = true; 85 | } 86 | } 87 | 88 | if ($httpCode != 200) { 89 | while ($bLine = trim(fgets($this->connection, 4096))) { 90 | $respBody .= $bLine; 91 | } 92 | 93 | throw new TwitterException(sprintf('Twitter API responsed a "%s" status code.', $httpCode)); 94 | } elseif (!$isChunking) { 95 | throw new TwitterException("Twitter did not send a chunking header. Is this really HTTP/1.1? Here are headers:\n$respHeaders"); //TODO: rather crude! 96 | } 97 | 98 | stream_set_blocking($this->connection, 0); 99 | } 100 | 101 | /** 102 | * @param callable $callback 103 | * @param integer $timeout 104 | */ 105 | public function read(callable $callback, $timeout = 5) 106 | { 107 | $this->pool = [$this->connection]; 108 | 109 | while ($this->connection !== null && !feof($this->connection) && stream_select($this->pool, $fdw, $fde, $timeout) !== false) { 110 | 111 | // @todo safeguard no tweets but connection OK. (reconnect) 112 | 113 | $this->pool = [$this->connection]; 114 | 115 | $chunkInfo = trim(fgets($this->connection)); 116 | 117 | if (!$chunkInfo) { 118 | continue; 119 | } 120 | 121 | $len = hexdec($chunkInfo) + 2; 122 | $streamInput = ''; 123 | 124 | while (!feof($this->connection)) { 125 | $streamInput .= fread($this->connection, $len-strlen($streamInput)); 126 | 127 | if (strlen($streamInput)>=$len) { 128 | break; 129 | } 130 | } 131 | 132 | $this->buffer .= substr($streamInput, 0, -2); 133 | 134 | $data = json_decode($this->buffer, true); 135 | 136 | if ($data) { 137 | call_user_func($callback, $data); 138 | $this->buffer = ''; 139 | } 140 | } 141 | } 142 | 143 | public function close() 144 | { 145 | if (is_resource($this->connection)) { 146 | fclose($this->connection); 147 | } 148 | 149 | $this->connection = null; 150 | } 151 | } 152 | -------------------------------------------------------------------------------- /src/Location/Box.php: -------------------------------------------------------------------------------- 1 | minLon = $minLon; 36 | $this->minLat = $minLat; 37 | $this->maxLon = $maxLon; 38 | $this->maxLat = $maxLat; 39 | } 40 | 41 | /** 42 | * {@inheritDoc} 43 | */ 44 | public function getBoundingBox() 45 | { 46 | return [$this->minLon, $this->minLat, $this->maxLon, $this->maxLat]; 47 | } 48 | } 49 | -------------------------------------------------------------------------------- /src/Location/Circle.php: -------------------------------------------------------------------------------- 1 | longitude = $longitude; 32 | $this->latitude = $latitude; 33 | $this->radius = $radius; 34 | } 35 | 36 | /** 37 | * {@inheritDoc} 38 | */ 39 | public function getBoundingBox() 40 | { 41 | // Calc bounding boxes 42 | $maxLat = round($this->latitude + rad2deg($this->radius / self::EARTH_RADIUS_KM), 2); 43 | $minLat = round($this->latitude - rad2deg($this->radius / self::EARTH_RADIUS_KM), 2); 44 | 45 | // Compensate for degrees longitude getting smaller with increasing latitude 46 | $maxLon = round($this->longitude + rad2deg($this->radius / self::EARTH_RADIUS_KM / cos(deg2rad($this->latitude))), 2); 47 | $minLon = round($this->longitude - rad2deg($this->radius / self::EARTH_RADIUS_KM / cos(deg2rad($this->latitude))), 2); 48 | 49 | return [$minLon, $minLat, $maxLon, $maxLat]; 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /src/Location/Collection.php: -------------------------------------------------------------------------------- 1 | locations = $locations; 18 | } 19 | 20 | /** 21 | * {@inheritDoc} 22 | */ 23 | public function getBoundingBox() 24 | { 25 | $box = []; 26 | 27 | foreach ($this->locations as $location) { 28 | $box = array_merge($box, $location->getBoundingBox()); 29 | } 30 | 31 | return $box; 32 | } 33 | } 34 | -------------------------------------------------------------------------------- /src/Location/LocationInterface.php: -------------------------------------------------------------------------------- 1 | stats[$name] = [ 32 | 'type' => $type, 33 | 'value' => $type === self::TYPE_COUNT ? 0 : $value, 34 | 'originalValue' => $type === self::TYPE_COUNT ? 0 : $value, 35 | 'count' => 0 36 | ]; 37 | } 38 | 39 | /** 40 | * @return string 41 | */ 42 | public function getAllAsString() 43 | { 44 | return implode("\n", array_map(function ($name, $data) { 45 | return sprintf('%s = %s', $name, $data['value']); 46 | }, array_keys($this->stats), $this->stats)); 47 | } 48 | 49 | /** 50 | * @param string $name 51 | * 52 | * @return float|int 53 | */ 54 | public function get($name) 55 | { 56 | if (!$this->has($name)) { 57 | throw new \RuntimeException(sprintf('Cannot get non existing dimension "%s"', $name)); 58 | } 59 | 60 | return $this->stats[$name]['value']; 61 | } 62 | 63 | /** 64 | * @param string $name 65 | * @param float|int $value 66 | */ 67 | public function stat($name, $value) 68 | { 69 | if (!$this->has($name)) { 70 | throw new \RuntimeException(sprintf('Cannot add stat for non existing dimension "%s"', $name)); 71 | } 72 | 73 | switch ($this->stats[$name]['type']) { 74 | case self::TYPE_LAST: 75 | $this->stats[$name]['value'] = $value; 76 | break; 77 | case self::TYPE_COUNT: 78 | $this->stats[$name]['value']++; 79 | break; 80 | case self::TYPE_AVG: 81 | $this->stats[$name]['value'] = ($this->stats[$name]['value']*$this->stats[$name]['count'] + $value) / ($this->stats[$name]['count'] + 1); 82 | break; 83 | case self::TYPE_MIN: 84 | $this->stats[$name]['value'] = min($this->stats[$name]['value'], $value); 85 | break; 86 | case self::TYPE_MAX: 87 | $this->stats[$name]['value'] = max($this->stats[$name]['value'], $value); 88 | break; 89 | } 90 | 91 | $this->stats[$name]['count']++; 92 | } 93 | 94 | /** 95 | * @param string $name 96 | */ 97 | public function clear($name) 98 | { 99 | $this->stats[$name]['value'] = $this->stats[$name]['originalValue']; 100 | $this->stats[$name]['count'] = 0; 101 | } 102 | 103 | /** 104 | * @param string $name 105 | * @return boolean 106 | */ 107 | public function has($name) 108 | { 109 | return array_key_exists($name, $this->stats); 110 | } 111 | } 112 | -------------------------------------------------------------------------------- /src/Oauth.php: -------------------------------------------------------------------------------- 1 | consumerKey = $consumerKey; 36 | $this->consumerSecret = $consumerSecret; 37 | $this->oauthToken = $oauthToken; 38 | $this->oauthSecret = $oauthSecret; 39 | } 40 | 41 | /** 42 | * @param string $url 43 | * @param array $params 44 | * 45 | * @return string 46 | */ 47 | public function getAuthorizationHeader($url, array $params, array $overrides = []) 48 | { 49 | $headers = $this->prepareHeaders('POST', $url, $params, $overrides); 50 | 51 | $headers = implode(',', array_map(function($name, $value){ 52 | return sprintf('%s="%s"', $name, $value); 53 | }, array_keys($headers), $headers)); 54 | 55 | return sprintf('OAuth realm="",%s', $headers); 56 | } 57 | 58 | /** 59 | * Prepares oauth headers for a given request. 60 | * 61 | * @param string $method 62 | * @param string $url 63 | * @param array $params 64 | * 65 | * @return array 66 | */ 67 | protected function prepareHeaders($method, $url, array $params, array $overrides = []) 68 | { 69 | $oauth = array_merge([ 70 | 'oauth_consumer_key' => $this->consumerKey, 71 | 'oauth_nonce' => md5(uniqid(rand(), true)), 72 | 'oauth_signature_method' => 'HMAC-SHA1', 73 | 'oauth_timestamp' => time(), 74 | 'oauth_version' => '1.0A', 75 | 'oauth_token' => $this->oauthToken, 76 | ], $overrides); 77 | 78 | foreach ($oauth as $k => $v) { 79 | $oauth[$k] = rawurlencode($v); 80 | } 81 | 82 | foreach ($params as $k => $v) { 83 | $params[$k] = rawurlencode($v); 84 | } 85 | 86 | $sigParams = array_merge($oauth, $params); 87 | ksort($sigParams); 88 | 89 | $oauth['oauth_signature'] = rawurlencode($this->generateSignature($method, $url, $sigParams)); 90 | 91 | return $oauth; 92 | } 93 | 94 | /** 95 | * See https://dev.twitter.com/oauth/overview/creating-signatures 96 | * 97 | * @param string $method 98 | * @param string $url 99 | * @param array $params 100 | * 101 | * @return string 102 | */ 103 | protected function generateSignature($method, $url, array $params) 104 | { 105 | $concat = implode('&', array_map(function($name, $value){ 106 | return sprintf('%s=%s', $name, $value); 107 | }, array_keys($params), $params)); 108 | 109 | $concatenatedParams = rawurlencode($concat); 110 | 111 | // normalize url 112 | $urlParts = parse_url($url); 113 | $scheme = strtolower($urlParts['scheme']); 114 | $host = strtolower($urlParts['host']); 115 | $port = isset($urlParts['port']) ? intval($urlParts['port']) : 0; 116 | $retval = strtolower($scheme) . '://' . strtolower($host); 117 | 118 | if (!empty($port) && (($scheme === 'http' && $port != 80) || ($scheme === 'https' && $port != 443))) { 119 | $retval .= ":{$port}"; 120 | } 121 | 122 | $retval .= $urlParts['path']; 123 | 124 | if (!empty($urlParts['query'])) { 125 | $retval .= "?{$urlParts['query']}"; 126 | } 127 | 128 | $normalizedUrl = rawurlencode($retval); 129 | $signatureBaseString = "{$method}&{$normalizedUrl}&{$concatenatedParams}"; 130 | # sign the signature string 131 | $key = rawurlencode($this->consumerSecret) . '&' . rawurlencode($this->oauthSecret); 132 | 133 | return base64_encode(hash_hmac('sha1', $signatureBaseString, $key, true)); 134 | } 135 | } 136 | -------------------------------------------------------------------------------- /src/StreamReader.php: -------------------------------------------------------------------------------- 1 | 'https://sitestream.twitter.com/1.1/site.json', 19 | 'user' => 'https://userstream.twitter.com/2/user.json', 20 | 'filter' => 'https://stream.twitter.com/1.1/statuses/filter.json', 21 | 'sample' => 'https://stream.twitter.com/1.1/statuses/sample.json', 22 | 'retweet' => 'https://stream.twitter.com/1.1/statuses/retweet.json', 23 | 'firehose' => 'https://stream.twitter.com/1.1/statuses/firehose.json', 24 | 'links' => 'https://stream.twitter.com/1.1/statuses/links.json' 25 | ]; 26 | 27 | /** 28 | * @var Connection 29 | */ 30 | private $connection; 31 | 32 | /** 33 | * @var Oauth 34 | */ 35 | private $oauth; 36 | 37 | /** 38 | * @var Monitor 39 | */ 40 | private $monitor; 41 | 42 | /** 43 | * @var bool 44 | */ 45 | private $running; 46 | 47 | /** 48 | * @internal Moved from being a const to a variable, because some methods (user and site) need to change it. 49 | */ 50 | protected $baseUrl = 'https://stream.twitter.com/1.1/statuses/'; 51 | 52 | protected $method; 53 | protected $count; //Can be -150,000 to 150,000. @see http://dev.twitter.com/pages/streaming_api_methods#count 54 | protected $followIds; 55 | protected $trackWords; 56 | protected $location; 57 | 58 | /** 59 | * @param Connection $connection 60 | * @param Oauth $oauth 61 | * @param string $method 62 | * @param boolean $lang 63 | */ 64 | public function __construct(Connection $connection, Oauth $oauth, $method = AbstractStream::METHOD_SAMPLE, $lang = false) 65 | { 66 | $this->monitor = new Monitor(); 67 | 68 | $this->monitor->register(Monitor::TYPE_MAX, 'max_idle_time', 0); 69 | $this->monitor->register(Monitor::TYPE_LAST, 'idle_time', 0); 70 | $this->monitor->register(Monitor::TYPE_COUNT, 'tweets'); 71 | 72 | $this->oauth = $oauth; 73 | $this->method = $method; 74 | $this->lang = $lang; 75 | 76 | $this->connection = $connection; 77 | } 78 | 79 | /** 80 | * Consume from the streaming API. 81 | * 82 | * Will retry on any connection loss. 83 | * 84 | * @param callable $handler 85 | */ 86 | public function consume(callable $handler) 87 | { 88 | $this->running = true; 89 | 90 | while ($this->running) { 91 | $this->consumeOnce($handler); 92 | } 93 | } 94 | 95 | public function stop() 96 | { 97 | $this->connection->close(); 98 | $this->running = false; 99 | } 100 | 101 | /** 102 | * Consume from the streaming API. 103 | * 104 | * Will not retry on connection loss. 105 | * 106 | * @param callable $handler 107 | */ 108 | protected function consumeOnce(callable $handler) 109 | { 110 | $this->connection = $this->connect(); 111 | 112 | $lastStreamActivity = time(); 113 | 114 | $this->connection->read(function ($tweet) use (&$lastStreamActivity, $handler) { 115 | $idle = (time() - $lastStreamActivity); 116 | 117 | $this->monitor->stat('max_idle_time', $idle); 118 | $this->monitor->stat('idle_time', $idle); 119 | $this->monitor->stat('tweets', 1); 120 | 121 | $lastStreamActivity = time(); 122 | 123 | call_user_func($handler, $tweet, $this->monitor); 124 | }); 125 | 126 | $this->connection->close(); 127 | } 128 | 129 | /** 130 | * @param int $timeout 131 | * @param int $attempts 132 | * 133 | * @return Connection 134 | */ 135 | protected function connect($timeout = 5, $attempts = 10) 136 | { 137 | $url = $this->endpoints[$this->method]; 138 | $urlParts = parse_url($url); 139 | $scheme = $urlParts['scheme'] == 'https' ? 'ssl://' : 'tcp://'; 140 | $port = $urlParts['scheme'] == 'https' ? 443 : 80; 141 | 142 | $requestParams = []; 143 | 144 | if ($this->lang) { 145 | $requestParams['language'] = $this->lang; 146 | } 147 | 148 | if (($this->method === self::METHOD_FILTER || $this->method === self::METHOD_USER) && count($this->trackWords) > 0) { 149 | $requestParams['track'] = implode(',', $this->trackWords); 150 | } 151 | if (($this->method === self::METHOD_FILTER || $this->method === self::METHOD_SITE) && count($this->followIds) > 0) { 152 | $requestParams['follow'] = implode(',', $this->followIds); 153 | } 154 | 155 | if ($this->method === self::METHOD_FILTER && $this->location) { 156 | $requestParams['locations'] = implode(',', $this->location->getBoundingBox()); 157 | } 158 | 159 | if ($this->count <> 0) { 160 | $requestParams['count'] = $this->count; 161 | } 162 | 163 | $this->connection->open($scheme . $urlParts['host'], $port, $timeout, $attempts); 164 | $this->connection->authenticate($url, $requestParams, $this->oauth->getAuthorizationHeader($url, $requestParams)); 165 | 166 | return $this->connection; 167 | } 168 | 169 | /** 170 | * @return Monitor 171 | */ 172 | public function getMonitor() 173 | { 174 | return $this->monitor; 175 | } 176 | 177 | /** 178 | * @param string $host 179 | */ 180 | public function setHostPort($port) 181 | { 182 | $this->hostPort = $port; 183 | 184 | return $this; 185 | } 186 | 187 | /** 188 | * @param int $port 189 | */ 190 | public function setSecureHostPort($port) 191 | { 192 | $this->secureHostPort = $port; 193 | 194 | return $this; 195 | } 196 | 197 | /** 198 | * Returns public statuses from or in reply to a set of users. Mentions ("Hello @user!") and implicit replies 199 | * ("@user Hello!" created without pressing the reply button) are not matched. It is up to you to find the integer 200 | * IDs of each twitter user. 201 | * Applies to: METHOD_FILTER 202 | * 203 | * @param array $userIds Array of Twitter integer userIDs 204 | */ 205 | public function setFollow(array $userIds = []) 206 | { 207 | sort($userIds); 208 | 209 | $this->followIds = $userIds; 210 | 211 | return $this; 212 | } 213 | 214 | /** 215 | * Returns an array of followed Twitter userIds (integers) 216 | * 217 | * @return array 218 | */ 219 | public function getFollow() 220 | { 221 | return $this->followIds; 222 | } 223 | 224 | /** 225 | * Specifies keywords to track. Track keywords are case-insensitive logical ORs. Terms are exact-matched, ignoring 226 | * punctuation. Phrases, keywords with spaces, are not supported. Queries are subject to Track Limitations. 227 | * Applies to: METHOD_FILTER 228 | * 229 | * See: http://apiwiki.twitter.com/Streaming-API-Documentation#TrackLimiting 230 | * 231 | * @param array $trackWords 232 | */ 233 | public function setTrack(array $trackWords = []) 234 | { 235 | sort($trackWords); // Non-optimal, but necessary 236 | 237 | $this->trackWords = $trackWords; 238 | 239 | return $this; 240 | } 241 | 242 | /** 243 | * @return array 244 | */ 245 | public function getTrack() 246 | { 247 | return $this->trackWords; 248 | } 249 | 250 | /** 251 | * @param LocationInterface $location 252 | */ 253 | public function setLocation(LocationInterface $location) 254 | { 255 | $this->location = $location; 256 | 257 | return $this; 258 | } 259 | 260 | /** 261 | * @return LocationInterface 262 | */ 263 | public function getLocation() 264 | { 265 | return $this->location; 266 | } 267 | 268 | /** 269 | * Sets the number of previous statuses to stream before transitioning to the live stream. Applies only to firehose 270 | * and filter + track methods. This is generally used internally and should not be needed by client applications. 271 | * Applies to: METHOD_FILTER, METHOD_FIREHOSE, METHOD_LINKS 272 | * 273 | * @param int $count 274 | */ 275 | public function setCount($count) 276 | { 277 | $this->count = $count; 278 | 279 | return $this; 280 | } 281 | 282 | /** 283 | * Restricts tweets to the given language, given by an ISO 639-1 code (http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). 284 | * 285 | * @param string $lang 286 | */ 287 | public function setLang($lang) 288 | { 289 | $this->lang = $lang; 290 | 291 | return $this; 292 | } 293 | 294 | /** 295 | * Returns the ISO 639-1 code formatted language string of the current setting. (http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes). 296 | * 297 | * @param string $lang 298 | */ 299 | public function getLang() 300 | { 301 | return $this->lang; 302 | } 303 | } 304 | -------------------------------------------------------------------------------- /src/StreamingBird.php: -------------------------------------------------------------------------------- 1 | consumerKey = $consumerKey; 36 | $this->consumerSecret = $consumerSecret; 37 | $this->oauthToken = $oauthToken; 38 | $this->oauthSecret = $oauthSecret; 39 | } 40 | 41 | /** 42 | * @param string $method 43 | * 44 | * @return StreamReader 45 | */ 46 | public function createStreamReader($method) 47 | { 48 | // Let's instantiate the Oauth signature handler and the stream reader. 49 | $oauth = new Oauth($this->consumerKey, $this->consumerSecret, $this->oauthToken, $this->oauthSecret); 50 | 51 | return new StreamReader(new Connection(), $oauth, $method); 52 | } 53 | } 54 | -------------------------------------------------------------------------------- /src/Stub/TwitterStream.php: -------------------------------------------------------------------------------- 1 | address = $address; 25 | $this->port = $port; 26 | 27 | $this->acceptOauth(); 28 | } 29 | 30 | public function acceptOauth() 31 | { 32 | $this->oauth = "HTTP/1.1 200 OK 33 | Transfer-Encoding: chunked 34 | Content-Type: application/json"; 35 | } 36 | 37 | public function import($path) 38 | { 39 | $this->stream = explode("\n", file_get_contents($path)); 40 | } 41 | 42 | public function start() 43 | { 44 | $this->run = true; 45 | 46 | if (($server = @socket_create(AF_INET, SOCK_STREAM, SOL_TCP)) === false) { 47 | throw new \RuntimeException(sprintf('Failed to create socket : "%s"', socket_strerror(socket_last_error()))); 48 | } 49 | 50 | if (@socket_bind($server, $this->address, $this->port) === false) { 51 | throw new \RuntimeException(sprintf('Failed to bind socket : "%s"', socket_strerror(socket_last_error($server)))); 52 | } 53 | 54 | if (@socket_listen($server, 5) === false) { 55 | throw new \RuntimeException(sprintf('Failed to listen on socket : "%s"', socket_strerror(socket_last_error($server)))); 56 | } 57 | 58 | if (($client = @socket_accept($server)) === false) { 59 | throw new \RuntimeException(sprintf('Failed to accept socket : "%s"', socket_strerror(socket_last_error($server)))); 60 | } 61 | 62 | do { 63 | if (false === ($buf = socket_read($client, 2048))) { 64 | throw new \RuntimeException(sprintf('Failed to read socket : "%s"', socket_strerror(socket_last_error($server)))); 65 | } 66 | 67 | if (strpos($buf, 'POST /auth') === 0) { 68 | socket_write($client, $this->oauth."\r\n\r\n", strlen($this->oauth."\r\n\r\n")); 69 | 70 | foreach ($this->stream as $line) { 71 | $size = dechex(strlen($line)); 72 | socket_write($client, $size."\r\n", strlen($size."\r\n")); 73 | socket_write($client, $line."\r\n", strlen($line."\r\n")); 74 | } 75 | 76 | usleep(500000); 77 | $this->close(); 78 | } 79 | } while ($this->run); 80 | 81 | socket_close($client); 82 | socket_close($server); 83 | } 84 | 85 | public function close() 86 | { 87 | $this->run = false; 88 | } 89 | } 90 | -------------------------------------------------------------------------------- /src/TwitterException.php: -------------------------------------------------------------------------------- 1 | runServer('success'); 18 | 19 | $connection = new Connection(); 20 | 21 | $connection->open('127.0.0.1', 9999, 2, 1); 22 | $connection->authenticate('http://stub/auth', ['key' => '123'], 'CREDENTIALS'); 23 | 24 | $readCount = 0; 25 | 26 | $connection->read(function ($tweet) use (&$readCount) { 27 | $this->assertArrayHasKey('foo', $tweet); 28 | $readCount++; 29 | }); 30 | 31 | $this->assertSame(3, $readCount); 32 | } 33 | 34 | /** 35 | * @param string $name 36 | */ 37 | protected function runServer($name) 38 | { 39 | $this->server = new Process(sprintf('php %s/Resources/bin/stub-%s.php', __DIR__, $name)); 40 | $this->server->start(); 41 | sleep(1); 42 | } 43 | 44 | protected function tearDown() 45 | { 46 | if ($this->server) { 47 | $this->server->stop(); 48 | $this->server = null; 49 | } 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /tests/Location/BoxTest.php: -------------------------------------------------------------------------------- 1 | assertSame([0,0,10,10], $box->getBoundingBox()); 14 | } 15 | } 16 | -------------------------------------------------------------------------------- /tests/Location/CircleTest.php: -------------------------------------------------------------------------------- 1 | assertSame([ 14 | -0.90000000000000002, 15 | -0.90000000000000002, 16 | 0.90000000000000002, 17 | 0.90000000000000002 18 | ], $circle->getBoundingBox()); 19 | } 20 | } 21 | -------------------------------------------------------------------------------- /tests/Location/CollectionTest.php: -------------------------------------------------------------------------------- 1 | assertSame([0,0,10,10,20,20,30,30], $collection->getBoundingBox()); 18 | } 19 | } 20 | -------------------------------------------------------------------------------- /tests/MonitorTest.php: -------------------------------------------------------------------------------- 1 | register(Monitor::TYPE_COUNT, 'foo'); 13 | 14 | $this->assertSame(0, $monitor->get('foo')); 15 | 16 | $monitor->stat('foo', 1); 17 | $monitor->stat('foo', 1); 18 | 19 | $this->assertSame(2, $monitor->get('foo')); 20 | 21 | $monitor->clear('foo'); 22 | 23 | $this->assertSame(0, $monitor->get('foo')); 24 | } 25 | 26 | public function testLast() 27 | { 28 | $monitor = new Monitor(); 29 | $monitor->register(Monitor::TYPE_LAST, 'foo', 42); 30 | 31 | $this->assertSame(42, $monitor->get('foo')); 32 | 33 | $monitor->stat('foo', 1337); 34 | 35 | $this->assertSame(1337, $monitor->get('foo')); 36 | 37 | $monitor->clear('foo'); 38 | 39 | $this->assertSame(42, $monitor->get('foo')); 40 | } 41 | 42 | public function testMax() 43 | { 44 | $monitor = new Monitor(); 45 | $monitor->register(Monitor::TYPE_MAX, 'foo'); 46 | 47 | $this->assertSame(0, $monitor->get('foo')); 48 | 49 | $monitor->stat('foo', 3); 50 | $monitor->stat('foo', 10); 51 | $monitor->stat('foo', 5); 52 | 53 | $this->assertSame(10, $monitor->get('foo')); 54 | 55 | $monitor->clear('foo'); 56 | 57 | $this->assertSame(0, $monitor->get('foo')); 58 | } 59 | 60 | public function testMin() 61 | { 62 | $monitor = new Monitor(); 63 | $monitor->register(Monitor::TYPE_MIN, 'foo'); 64 | 65 | $this->assertSame(PHP_INT_MAX, $monitor->get('foo')); 66 | 67 | $monitor->stat('foo', 3); 68 | $monitor->stat('foo', 10); 69 | $monitor->stat('foo', 5); 70 | 71 | $this->assertSame(3, $monitor->get('foo')); 72 | 73 | $monitor->clear('foo'); 74 | 75 | $this->assertSame(PHP_INT_MAX, $monitor->get('foo')); 76 | } 77 | 78 | public function testAvg() 79 | { 80 | $monitor = new Monitor(); 81 | $monitor->register(Monitor::TYPE_AVG, 'foo'); 82 | 83 | $this->assertSame(0, $monitor->get('foo')); 84 | 85 | $monitor->stat('foo', 0); 86 | $monitor->stat('foo', 10); 87 | $monitor->stat('foo', 10); 88 | $monitor->stat('foo', 10); 89 | 90 | $this->assertSame(7.5, $monitor->get('foo')); 91 | 92 | $monitor->clear('foo'); 93 | 94 | $this->assertSame(0, $monitor->get('foo')); 95 | } 96 | 97 | public function testGetAllAsString() 98 | { 99 | $monitor = new Monitor(); 100 | $monitor->register(Monitor::TYPE_AVG, 'foo'); 101 | $monitor->register(Monitor::TYPE_MAX, 'bar', 42); 102 | 103 | $this->assertSame("foo = 0\nbar = 42", $monitor->getAllAsString()); 104 | } 105 | 106 | /** 107 | * @expectedException \RuntimeException 108 | * @expectedExceptionMessage Cannot get non existing dimension "foo" 109 | */ 110 | public function testGetNonExistingDimension() 111 | { 112 | $monitor = new Monitor(); 113 | $monitor->get('foo'); 114 | } 115 | 116 | /** 117 | * @expectedException \RuntimeException 118 | * @expectedExceptionMessage Cannot add stat for non existing dimension "foo" 119 | */ 120 | public function testStatNonExistingDimension() 121 | { 122 | $monitor = new Monitor(); 123 | $monitor->stat('foo', 1); 124 | } 125 | } 126 | -------------------------------------------------------------------------------- /tests/OauthTest.php: -------------------------------------------------------------------------------- 1 | assertSame($headers, $oauth->getAuthorizationHeader('http://bird.com/stream/users', [ 'sort' => 'date' ], [ 20 | 'oauth_nonce' => 'foo', 21 | 'oauth_timestamp' => 1458246915 22 | ])); 23 | } 24 | } 25 | 26 | -------------------------------------------------------------------------------- /tests/Resources/bin/stub-success.php: -------------------------------------------------------------------------------- 1 | #!/usr/bin/php 2 | import(__DIR__ . '/../stream.txt'); 10 | $stub->start(); 11 | -------------------------------------------------------------------------------- /tests/Resources/stream.txt: -------------------------------------------------------------------------------- 1 | {"foo":"bar"} 2 | {"foo":"baz"} 3 | {"foo":"foobar"} -------------------------------------------------------------------------------- /tests/StreamReaderTest.php: -------------------------------------------------------------------------------- 1 | getConnection(); 14 | $oauth = $this->getOauth(); 15 | 16 | $oauth 17 | ->expects($this->once()) 18 | ->method('getAuthorizationHeader') 19 | ->with('https://stream.twitter.com/1.1/statuses/filter.json', [ 'track' => 'hello', 'follow' => '1,2', 'locations' => '0,0,1,1' ]) 20 | ->willReturn('CREDENTIALS') 21 | ; 22 | 23 | $connection 24 | ->expects($this->once()) 25 | ->method('open') 26 | ->with('ssl://stream.twitter.com', 443, 5, 10); 27 | ; 28 | 29 | $connection 30 | ->expects($this->once()) 31 | ->method('authenticate') 32 | ->with('https://stream.twitter.com/1.1/statuses/filter.json', [ 'track' => 'hello', 'follow' => '1,2', 'locations' => '0,0,1,1' ], 'CREDENTIALS'); 33 | ; 34 | 35 | $connection 36 | ->expects($this->once()) 37 | ->method('read') 38 | ->will($this->returnCallback(function (callable $callable) { 39 | sleep(1); 40 | call_user_func($callable, ['text' => 'a tweet']); 41 | })); 42 | ; 43 | 44 | $reader = new StreamReader($connection, $oauth, StreamReader::METHOD_FILTER); 45 | 46 | $reader->setTrack(['hello']); 47 | $reader->setFollow([ 1, 2 ]); 48 | $reader->setLocation(new Box(0,0, 1, 1)); 49 | 50 | $reader->consume(function ($tweet) use ($reader, &$used) { 51 | $used = true; 52 | $this->assertSame('a tweet', $tweet['text']); 53 | $reader->stop(); 54 | }); 55 | 56 | $this->assertSame(1, $reader->getMonitor()->get('tweets')); 57 | $this->assertSame(1, $reader->getMonitor()->get('max_idle_time')); 58 | $this->assertSame(1, $reader->getMonitor()->get('idle_time')); 59 | 60 | $this->assertTrue($used); 61 | } 62 | 63 | public function getConnection() 64 | { 65 | return $this 66 | ->getMockBuilder('OwlyCode\StreamingBird\Connection') 67 | ->disableOriginalConstructor() 68 | ->getMock() 69 | ; 70 | } 71 | 72 | public function getOauth() 73 | { 74 | return $this 75 | ->getMockBuilder('OwlyCode\StreamingBird\Oauth') 76 | ->disableOriginalConstructor() 77 | ->getMock() 78 | ; 79 | } 80 | } 81 | --------------------------------------------------------------------------------