From 092f60e41d1999e031ac4708c55ea2eee8e532ab Mon Sep 17 00:00:00 2001 From: bcanini <canini.16@osu.edu> Date: Mon, 11 Feb 2019 10:13:54 -0500 Subject: [PATCH] new module - twitter block --- composer.json | 1 + composer.lock | 65 +++- vendor/composer/installed.json | 65 ++++ web/modules/twitter_block/LICENSE.txt | 339 ++++++++++++++++++ web/modules/twitter_block/README.txt | 78 ++++ web/modules/twitter_block/composer.json | 7 + .../config/schema/twitter_block.schema.yml | 56 +++ .../src/Plugin/Block/TwitterBlock.php | 269 ++++++++++++++ .../src/Tests/TwitterBlockTest.php | 58 +++ .../twitter_block/twitter_block.info.yml | 12 + .../twitter_block/twitter_block.libraries.yml | 3 + .../twitter_block/twitter_block.module | 20 ++ 12 files changed, 972 insertions(+), 1 deletion(-) create mode 100644 web/modules/twitter_block/LICENSE.txt create mode 100644 web/modules/twitter_block/README.txt create mode 100644 web/modules/twitter_block/composer.json create mode 100644 web/modules/twitter_block/config/schema/twitter_block.schema.yml create mode 100644 web/modules/twitter_block/src/Plugin/Block/TwitterBlock.php create mode 100644 web/modules/twitter_block/src/Tests/TwitterBlockTest.php create mode 100644 web/modules/twitter_block/twitter_block.info.yml create mode 100644 web/modules/twitter_block/twitter_block.libraries.yml create mode 100644 web/modules/twitter_block/twitter_block.module diff --git a/composer.json b/composer.json index 5bd1c03440..440480482e 100644 --- a/composer.json +++ b/composer.json @@ -137,6 +137,7 @@ "drupal/superfish": "1.2", "drupal/svg_image": "1.8", "drupal/token": "1.5", + "drupal/twitter_block": "3.0-alpha0", "drupal/userprotect": "1.0", "drupal/video_embed_field": "2.0", "drupal/view_unpublished": "^1.0@alpha", diff --git a/composer.lock b/composer.lock index af63af7d52..81b26543f4 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file", "This file is @generated automatically" ], - "content-hash": "930b4b24df5a1782d5cd2a05de9ffda6", + "content-hash": "69a66388caf4a15e8bfb8680c7774d79", "packages": [ { "name": "alchemy/zippy", @@ -5871,6 +5871,69 @@ "source": "http://cgit.drupalcode.org/token" } }, + { + "name": "drupal/twitter_block", + "version": "3.0.0-alpha0", + "source": { + "type": "git", + "url": "https://git.drupal.org/project/twitter_block", + "reference": "8.x-3.0-alpha0" + }, + "dist": { + "type": "zip", + "url": "https://ftp.drupal.org/files/projects/twitter_block-8.x-3.0-alpha0.zip", + "reference": "8.x-3.0-alpha0", + "shasum": "f959bec1332f2bd45e813eefa3b982df4eb129bb" + }, + "require": { + "drupal/core": "*" + }, + "type": "drupal-module", + "extra": { + "branch-alias": { + "dev-3.x": "3.x-dev" + }, + "drupal": { + "version": "8.x-3.0-alpha0", + "datestamp": "1489574283", + "security-coverage": { + "status": "not-covered", + "message": "Alpha releases are not covered by Drupal security advisories." + } + } + }, + "notification-url": "https://packages.drupal.org/8/downloads", + "license": [ + "GPL-2.0+" + ], + "authors": [ + { + "name": "Devin Carlson", + "homepage": "https://www.drupal.org/user/290182" + }, + { + "name": "ZenDoodles", + "homepage": "https://www.drupal.org/user/226976" + }, + { + "name": "cweagans", + "homepage": "https://www.drupal.org/user/404732" + }, + { + "name": "naveenvalecha", + "homepage": "https://www.drupal.org/user/2665733" + }, + { + "name": "subhojit777", + "homepage": "https://www.drupal.org/user/1812492" + } + ], + "description": "Provides configurable blocks for a Twitter feed.", + "homepage": "http://drupal.org/project/twitter_block", + "support": { + "source": "http://cgit.drupalcode.org/twitter_block" + } + }, { "name": "drupal/userprotect", "version": "1.0.0", diff --git a/vendor/composer/installed.json b/vendor/composer/installed.json index fc78d53e27..60c5c44d62 100644 --- a/vendor/composer/installed.json +++ b/vendor/composer/installed.json @@ -6055,6 +6055,71 @@ "source": "http://cgit.drupalcode.org/token" } }, + { + "name": "drupal/twitter_block", + "version": "3.0.0-alpha0", + "version_normalized": "3.0.0.0-alpha", + "source": { + "type": "git", + "url": "https://git.drupal.org/project/twitter_block", + "reference": "8.x-3.0-alpha0" + }, + "dist": { + "type": "zip", + "url": "https://ftp.drupal.org/files/projects/twitter_block-8.x-3.0-alpha0.zip", + "reference": "8.x-3.0-alpha0", + "shasum": "f959bec1332f2bd45e813eefa3b982df4eb129bb" + }, + "require": { + "drupal/core": "*" + }, + "type": "drupal-module", + "extra": { + "branch-alias": { + "dev-3.x": "3.x-dev" + }, + "drupal": { + "version": "8.x-3.0-alpha0", + "datestamp": "1489574283", + "security-coverage": { + "status": "not-covered", + "message": "Alpha releases are not covered by Drupal security advisories." + } + } + }, + "installation-source": "dist", + "notification-url": "https://packages.drupal.org/8/downloads", + "license": [ + "GPL-2.0+" + ], + "authors": [ + { + "name": "Devin Carlson", + "homepage": "https://www.drupal.org/user/290182" + }, + { + "name": "ZenDoodles", + "homepage": "https://www.drupal.org/user/226976" + }, + { + "name": "cweagans", + "homepage": "https://www.drupal.org/user/404732" + }, + { + "name": "naveenvalecha", + "homepage": "https://www.drupal.org/user/2665733" + }, + { + "name": "subhojit777", + "homepage": "https://www.drupal.org/user/1812492" + } + ], + "description": "Provides configurable blocks for a Twitter feed.", + "homepage": "http://drupal.org/project/twitter_block", + "support": { + "source": "http://cgit.drupalcode.org/twitter_block" + } + }, { "name": "drupal/userprotect", "version": "1.0.0", diff --git a/web/modules/twitter_block/LICENSE.txt b/web/modules/twitter_block/LICENSE.txt new file mode 100644 index 0000000000..d159169d10 --- /dev/null +++ b/web/modules/twitter_block/LICENSE.txt @@ -0,0 +1,339 @@ + GNU GENERAL PUBLIC LICENSE + Version 2, June 1991 + + Copyright (C) 1989, 1991 Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The licenses for most software are designed to take away your +freedom to share and change it. By contrast, the GNU General Public +License is intended to guarantee your freedom to share and change free +software--to make sure the software is free for all its users. This +General Public License applies to most of the Free Software +Foundation's software and to any other program whose authors commit to +using it. (Some other Free Software Foundation software is covered by +the GNU Lesser General Public License instead.) You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +this service if you wish), that you receive source code or can get it +if you want it, that you can change the software or use pieces of it +in new free programs; and that you know you can do these things. + + To protect your rights, we need to make restrictions that forbid +anyone to deny you these rights or to ask you to surrender the rights. +These restrictions translate to certain responsibilities for you if you +distribute copies of the software, or if you modify it. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must give the recipients all the rights that +you have. You must make sure that they, too, receive or can get the +source code. And you must show them these terms so they know their +rights. + + We protect your rights with two steps: (1) copyright the software, and +(2) offer you this license which gives you legal permission to copy, +distribute and/or modify the software. + + Also, for each author's protection and ours, we want to make certain +that everyone understands that there is no warranty for this free +software. If the software is modified by someone else and passed on, we +want its recipients to know that what they have is not the original, so +that any problems introduced by others will not reflect on the original +authors' reputations. + + Finally, any free program is threatened constantly by software +patents. We wish to avoid the danger that redistributors of a free +program will individually obtain patent licenses, in effect making the +program proprietary. To prevent this, we have made it clear that any +patent must be licensed for everyone's free use or not licensed at all. + + The precise terms and conditions for copying, distribution and +modification follow. + + GNU GENERAL PUBLIC LICENSE + TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION + + 0. This License applies to any program or other work which contains +a notice placed by the copyright holder saying it may be distributed +under the terms of this General Public License. The "Program", below, +refers to any such program or work, and a "work based on the Program" +means either the Program or any derivative work under copyright law: +that is to say, a work containing the Program or a portion of it, +either verbatim or with modifications and/or translated into another +language. (Hereinafter, translation is included without limitation in +the term "modification".) Each licensee is addressed as "you". + +Activities other than copying, distribution and modification are not +covered by this License; they are outside its scope. The act of +running the Program is not restricted, and the output from the Program +is covered only if its contents constitute a work based on the +Program (independent of having been made by running the Program). +Whether that is true depends on what the Program does. + + 1. You may copy and distribute verbatim copies of the Program's +source code as you receive it, in any medium, provided that you +conspicuously and appropriately publish on each copy an appropriate +copyright notice and disclaimer of warranty; keep intact all the +notices that refer to this License and to the absence of any warranty; +and give any other recipients of the Program a copy of this License +along with the Program. + +You may charge a fee for the physical act of transferring a copy, and +you may at your option offer warranty protection in exchange for a fee. + + 2. You may modify your copy or copies of the Program or any portion +of it, thus forming a work based on the Program, and copy and +distribute such modifications or work under the terms of Section 1 +above, provided that you also meet all of these conditions: + + a) You must cause the modified files to carry prominent notices + stating that you changed the files and the date of any change. + + b) You must cause any work that you distribute or publish, that in + whole or in part contains or is derived from the Program or any + part thereof, to be licensed as a whole at no charge to all third + parties under the terms of this License. + + c) If the modified program normally reads commands interactively + when run, you must cause it, when started running for such + interactive use in the most ordinary way, to print or display an + announcement including an appropriate copyright notice and a + notice that there is no warranty (or else, saying that you provide + a warranty) and that users may redistribute the program under + these conditions, and telling the user how to view a copy of this + License. (Exception: if the Program itself is interactive but + does not normally print such an announcement, your work based on + the Program is not required to print an announcement.) + +These requirements apply to the modified work as a whole. If +identifiable sections of that work are not derived from the Program, +and can be reasonably considered independent and separate works in +themselves, then this License, and its terms, do not apply to those +sections when you distribute them as separate works. But when you +distribute the same sections as part of a whole which is a work based +on the Program, the distribution of the whole must be on the terms of +this License, whose permissions for other licensees extend to the +entire whole, and thus to each and every part regardless of who wrote it. + +Thus, it is not the intent of this section to claim rights or contest +your rights to work written entirely by you; rather, the intent is to +exercise the right to control the distribution of derivative or +collective works based on the Program. + +In addition, mere aggregation of another work not based on the Program +with the Program (or with a work based on the Program) on a volume of +a storage or distribution medium does not bring the other work under +the scope of this License. + + 3. You may copy and distribute the Program (or a work based on it, +under Section 2) in object code or executable form under the terms of +Sections 1 and 2 above provided that you also do one of the following: + + a) Accompany it with the complete corresponding machine-readable + source code, which must be distributed under the terms of Sections + 1 and 2 above on a medium customarily used for software interchange; or, + + b) Accompany it with a written offer, valid for at least three + years, to give any third party, for a charge no more than your + cost of physically performing source distribution, a complete + machine-readable copy of the corresponding source code, to be + distributed under the terms of Sections 1 and 2 above on a medium + customarily used for software interchange; or, + + c) Accompany it with the information you received as to the offer + to distribute corresponding source code. (This alternative is + allowed only for noncommercial distribution and only if you + received the program in object code or executable form with such + an offer, in accord with Subsection b above.) + +The source code for a work means the preferred form of the work for +making modifications to it. For an executable work, complete source +code means all the source code for all modules it contains, plus any +associated interface definition files, plus the scripts used to +control compilation and installation of the executable. However, as a +special exception, the source code distributed need not include +anything that is normally distributed (in either source or binary +form) with the major components (compiler, kernel, and so on) of the +operating system on which the executable runs, unless that component +itself accompanies the executable. + +If distribution of executable or object code is made by offering +access to copy from a designated place, then offering equivalent +access to copy the source code from the same place counts as +distribution of the source code, even though third parties are not +compelled to copy the source along with the object code. + + 4. You may not copy, modify, sublicense, or distribute the Program +except as expressly provided under this License. Any attempt +otherwise to copy, modify, sublicense or distribute the Program is +void, and will automatically terminate your rights under this License. +However, parties who have received copies, or rights, from you under +this License will not have their licenses terminated so long as such +parties remain in full compliance. + + 5. You are not required to accept this License, since you have not +signed it. However, nothing else grants you permission to modify or +distribute the Program or its derivative works. These actions are +prohibited by law if you do not accept this License. Therefore, by +modifying or distributing the Program (or any work based on the +Program), you indicate your acceptance of this License to do so, and +all its terms and conditions for copying, distributing or modifying +the Program or works based on it. + + 6. Each time you redistribute the Program (or any work based on the +Program), the recipient automatically receives a license from the +original licensor to copy, distribute or modify the Program subject to +these terms and conditions. You may not impose any further +restrictions on the recipients' exercise of the rights granted herein. +You are not responsible for enforcing compliance by third parties to +this License. + + 7. If, as a consequence of a court judgment or allegation of patent +infringement or for any other reason (not limited to patent issues), +conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot +distribute so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you +may not distribute the Program at all. For example, if a patent +license would not permit royalty-free redistribution of the Program by +all those who receive copies directly or indirectly through you, then +the only way you could satisfy both it and this License would be to +refrain entirely from distribution of the Program. + +If any portion of this section is held invalid or unenforceable under +any particular circumstance, the balance of the section is intended to +apply and the section as a whole is intended to apply in other +circumstances. + +It is not the purpose of this section to induce you to infringe any +patents or other property right claims or to contest validity of any +such claims; this section has the sole purpose of protecting the +integrity of the free software distribution system, which is +implemented by public license practices. Many people have made +generous contributions to the wide range of software distributed +through that system in reliance on consistent application of that +system; it is up to the author/donor to decide if he or she is willing +to distribute software through any other system and a licensee cannot +impose that choice. + +This section is intended to make thoroughly clear what is believed to +be a consequence of the rest of this License. + + 8. If the distribution and/or use of the Program is restricted in +certain countries either by patents or by copyrighted interfaces, the +original copyright holder who places the Program under this License +may add an explicit geographical distribution limitation excluding +those countries, so that distribution is permitted only in or among +countries not thus excluded. In such case, this License incorporates +the limitation as if written in the body of this License. + + 9. The Free Software Foundation may publish revised and/or new versions +of the General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + +Each version is given a distinguishing version number. If the Program +specifies a version number of this License which applies to it and "any +later version", you have the option of following the terms and conditions +either of that version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number of +this License, you may choose any version ever published by the Free Software +Foundation. + + 10. If you wish to incorporate parts of the Program into other free +programs whose distribution conditions are different, write to the author +to ask for permission. For software which is copyrighted by the Free +Software Foundation, write to the Free Software Foundation; we sometimes +make exceptions for this. Our decision will be guided by the two goals +of preserving the free status of all derivatives of our free software and +of promoting the sharing and reuse of software generally. + + NO WARRANTY + + 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY +FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN +OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES +PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED +OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS +TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE +PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, +REPAIR OR CORRECTION. + + 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR +REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, +INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING +OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED +TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY +YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER +PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE +POSSIBILITY OF SUCH DAMAGES. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +convey the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU General Public License as published by + the Free Software Foundation; either version 2 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along + with this program; if not, write to the Free Software Foundation, Inc., + 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. + +Also add information on how to contact you by electronic and paper mail. + +If the program is interactive, make it output a short notice like this +when it starts in an interactive mode: + + Gnomovision version 69, Copyright (C) year name of author + Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, the commands you use may +be called something other than `show w' and `show c'; they could even be +mouse-clicks or menu items--whatever suits your program. + +You should also get your employer (if you work as a programmer) or your +school, if any, to sign a "copyright disclaimer" for the program, if +necessary. Here is a sample; alter the names: + + Yoyodyne, Inc., hereby disclaims all copyright interest in the program + `Gnomovision' (which makes passes at compilers) written by James Hacker. + + <signature of Ty Coon>, 1 April 1989 + Ty Coon, President of Vice + +This General Public License does not permit incorporating your program into +proprietary programs. If your program is a subroutine library, you may +consider it more useful to permit linking proprietary applications with the +library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. diff --git a/web/modules/twitter_block/README.txt b/web/modules/twitter_block/README.txt new file mode 100644 index 0000000000..e32c2e9095 --- /dev/null +++ b/web/modules/twitter_block/README.txt @@ -0,0 +1,78 @@ +CONTENTS OF THIS FILE +--------------------- + + * Introduction + * Requirements + * Installation + * Permissions + * Usage + * Theming + +INTRODUCTION +------------ + +Current Maintainers: + + * ZenDoodles http://drupal.org/user/226976 + * cweagans http://drupal.org/user/404732 + * Devin Carlson http://drupal.org/user/290182 + * Naveen Valecha http://drupal.org/user/2665733 + +Twitter Block is a lightweight module which allows administrators to create +blocks which display embedded timelines. + +Twitter Block will never provide advanced Twitter integration such as OAuth +user authentication or the ability to tweet from Drupal. These capabilities are +provided by other modules such as Twitter (http://drupal.org/project/twitter). + +REQUIREMENTS +------------ + +Twitter Block has one dependency. + +Drupal core modules + * Block + +INSTALLATION +------------ + +Twitter Block can be installed via the standard Drupal installation process +(http://drupal.org/documentation/install/modules-themes/modules-8). + +PERMISSIONS +------------ + +The ability to create, edit and delete Twitter Block blocks relies on the block +module's "Administer blocks" permission. + +USAGE +----- + +Administrators can visit the Blocks administration page where they can create +new Twitter Block blocks and update or delete existing Twitter Block blocks. + +Administrators can also position Twitter Block blocks as they can with standard +or custom blocks provided by the core Block module. + +Each Twitter Block block requires a unique widget ID which determines, among +other things, the source (user timeline, favourites, list or search) of the +tweets to display. + +You can view a list of your existing embedded timeline widgets (and their +widget IDs) or create new embedded timeline widgets by visiting +https://twitter.com/settings/widgets (make sure that you're logged in). + +You can determine a widget's ID by editing it and inspecting the URL (which +should be in the form of https://twitter.com/settings/widgets/WIDGET_ID/edit) +or by looking at the widget's embed code (look for +data-widget-id="WIDGET_ID"). + +Theming +------- + +Embedded Timelines offer a number of customization options such as theme, layout +and border color but, due to the way embedded timelines are implemented, custom +theming using CSS can be difficult. + +To add custom CSS to embedded timelines check out the +(http://github.com/kevinburke/customize-twitter-1.1) Customize Twitter project. diff --git a/web/modules/twitter_block/composer.json b/web/modules/twitter_block/composer.json new file mode 100644 index 0000000000..d2b7689383 --- /dev/null +++ b/web/modules/twitter_block/composer.json @@ -0,0 +1,7 @@ +{ + "name": "drupal/twitter_block", + "type": "drupal-module", + "description": "Provides configurable blocks for a Twitter feed.", + "homepage": "http://drupal.org/project/twitter_block", + "license": "GPL-2.0+" +} diff --git a/web/modules/twitter_block/config/schema/twitter_block.schema.yml b/web/modules/twitter_block/config/schema/twitter_block.schema.yml new file mode 100644 index 0000000000..f078bd389f --- /dev/null +++ b/web/modules/twitter_block/config/schema/twitter_block.schema.yml @@ -0,0 +1,56 @@ +block.settings.twitter_block: + type: block_settings + label: 'Twitter block settings' + mapping: + username: + type: string + label: 'Username' + theme: + type: string + label: 'Theme' + link_color: + type: string + label: 'Link Color' + width: + type: string + label: 'Width' + height: + type: string + label: 'Height' + chrome: + type: mapping + label: 'Chrome' + mapping: + noheader: + type: string + label: 'Chrome Option' + nofooter: + type: string + label: 'Chrome Option' + noborders: + type: string + label: 'Chrome Option' + noscrollbar: + type: string + label: 'Chrome Option' + transparent: + type: string + label: 'Chrome Option' + border_color: + type: string + label: 'Border Color' + language: + type: string + label: 'Language' + tweet_limit: + type: string + label: 'Tweet Limit' + related: + type: string + label: 'Related' + polite: + type: string + label: 'Polite' + weight: + type: integer + label: 'Weight' diff --git a/web/modules/twitter_block/src/Plugin/Block/TwitterBlock.php b/web/modules/twitter_block/src/Plugin/Block/TwitterBlock.php new file mode 100644 index 0000000000..b6ad5c29ef --- /dev/null +++ b/web/modules/twitter_block/src/Plugin/Block/TwitterBlock.php @@ -0,0 +1,269 @@ +<?php + +namespace Drupal\twitter_block\Plugin\Block; + +use Drupal\Core\Block\BlockBase; +use Drupal\Core\Form\FormStateInterface; +use Drupal\Core\Url; + +/** + * Defines a twitter block block type. + * + * @Block( + * id = "twitter_block", + * admin_label = @Translation("Twitter block"), + * category = @Translation("Twitter"), + * ) + */ +class TwitterBlock extends BlockBase { + + /** + * {@inheritdoc} + */ + public function blockForm($form, FormStateInterface $form_state) { + + $config = $this->getConfiguration(); + + $form['username'] = [ + '#type' => 'textfield', + '#title' => $this->t('Username'), + '#default_value' => $config['username'], + '#required' => TRUE, + '#field_prefix' => '@', + ]; + $form['appearance'] = [ + '#type' => 'fieldset', + '#title' => $this->t('Appearance'), + ]; + $form['appearance']['theme'] = [ + '#type' => 'select', + '#title' => $this->t('Theme'), + '#default_value' => $config['theme'], + '#options' => [ + '' => $this->t('Default'), + 'dark' => $this->t('Dark'), + ], + '#description' => $this->t('Select a theme for the widget.'), + ]; + $form['appearance']['link_color'] = [ + '#type' => 'textfield', + '#title' => $this->t('Link color'), + '#default_value' => $config['link_color'], + '#maxlength' => 6, + '#size' => 6, + '#field_prefix' => '#', + '#description' => $this->t('Change the link color used by the widget. + Takes an %format hex format color. Note that some icons in the widget + will also appear this color.', ['%format' => 'abc123']), + ]; + $form['appearance']['border_color'] = [ + '#type' => 'textfield', + '#title' => $this->t('Border color'), + '#default_value' => $config['border_color'], + '#maxlength' => 6, + '#size' => 6, + '#field_prefix' => '#', + '#description' => $this->t('Change the border color used by the widget. + Takes an %format hex format color.', ['%format' => 'abc123']), + ]; + $form['appearance']['chrome'] = [ + '#type' => 'checkboxes', + '#title' => $this->t('Chrome'), + '#default_value' => $config['chrome'], + '#options' => [ + 'noheader' => $this->t('No header'), + 'nofooter' => $this->t('No footer'), + 'noborders' => $this->t('No borders'), + 'noscrollbar' => $this->t('No scrollbar'), + 'transparent' => $this->t('Transparent'), + ], + '#description' => $this->t('Control the widget layout and chrome.'), + ]; + $form['functionality'] = [ + '#type' => 'fieldset', + '#title' => $this->t('Functionality'), + ]; + $form['functionality']['related'] = [ + '#type' => 'textfield', + '#title' => $this->t('Related users'), + '#default_value' => $config['related'], + '#description' => $this->t('As per the Tweet and follow buttons, you may + provide a comma-separated list of user screen names as suggested + followers to a user after they reply, Retweet, or favorite a Tweet in the timeline.'), + ]; + $form['functionality']['tweet_limit'] = [ + '#type' => 'select', + '#title' => $this->t('Tweet limit'), + '#default_value' => $config['tweet_limit'], + '#options' => ['' => $this->t('Auto')] + [array_combine(range(1, 20), range(1, 20))], + '#description' => $this->t('Fix the size of a timeline to a preset number + of Tweets between 1 and 20. The timeline will render the specified number + of Tweets from the timeline, expanding the height of the widget to + display all Tweets without scrolling. Since the widget is of a fixed + size, it will not poll for updates when using this option.'), + ]; + $form['size'] = [ + '#type' => 'fieldset', + '#title' => $this->t('Size'), + '#description' => $this->t('Embedded timelines are flexible and adaptive, + functioning at a variety of dimensions ranging from wide to narrow, + and short to tall. The default dimensions for a timeline are 520×600px, + which can be overridden to fit the dimension requirements of your page. + Setting a width is not required, and by default the widget will shrink + to the width of its parent element in the page.'), + ]; + $form['size']['width'] = [ + '#type' => 'textfield', + '#title' => $this->t('Width'), + '#default_value' => $config['width'], + '#size' => 6, + '#field_suffix' => 'px', + '#description' => $this->t('Change the width of the widget.'), + ]; + $form['size']['height'] = [ + '#type' => 'textfield', + '#title' => $this->t('Height'), + '#default_value' => $config['height'], + '#size' => 6, + '#field_suffix' => 'px', + '#description' => $this->t('Change the height of the widget.'), + ]; + $form['size']['note'] = [ + '#type' => 'markup', + '#markup' => '<p>' . $this->t('The minimum width of a timeline is 180px + and the maximum is 520px. The minimum height is 200px.') . '</p>', + ]; + $form['accessibility'] = [ + '#type' => 'fieldset', + '#title' => $this->t('Accessibility'), + ]; + $form['accessibility']['language'] = [ + '#type' => 'textfield', + '#title' => $this->t('Language'), + '#default_value' => $config['language'], + '#maxlength' => 5, + '#size' => 5, + '#description' => $this->t('The widget language is detected from the page, + based on the language of your content. Enter a <a href="@website"> + language code</a> to manually override the language.', + ['@website' => 'http://www.w3.org/TR/html401/struct/dirlang.html#h-8.1.1']), + ]; + $form['accessibility']['polite'] = [ + '#type' => 'select', + '#title' => $this->t('ARIA politeness'), + '#options' => [ + 'polite' => $this->t('Polite'), + 'assertive' => $this->t('Assertive'), + ], + '#default_value' => $config['polite'], + '#description' => $this->t('ARIA is an accessibility system that aids people + using assistive technology interacting with dynamic web content. + <a href="@website">Read more about ARIA on W3C\'s website</a>. By + default, the embedded timeline uses the least obtrusive setting: + "polite". If you\'re using an embedded timeline as a primary source of + content on your page, you may wish to override this to the assertive + setting, using "assertive".', + ['@website' => 'http://www.w3.org/WAI/intro/aria.php']), + ]; + return $form; + } + + /** + * {@inheritdoc} + */ + public function blockSubmit($form, FormStateInterface $form_state) { + $this->setConfigurationValue('username', $form_state->getValue('username')); + foreach (['appearance', 'functionality', 'size', 'accessibility'] as $fieldset) { + $fieldset_values = $form_state->getValue($fieldset); + foreach ($fieldset_values as $key => $value) { + $this->setConfigurationValue($key, $value); + } + } + } + + /** + * {@inheritdoc} + */ + public function build() { + + $config = $this->getConfiguration(); + + $render['block'] = [ + '#type' => 'link', + '#title' => $this->t('Tweets by @@username', ['@username' => $config['username']]), + '#url' => Url::fromUri('https://twitter.com/' . $config['username']), + '#attributes' => [ + 'class' => ['twitter-timeline'], + ], + '#attached' => [ + 'library' => ['twitter_block/widgets'], + ], + ]; + + if (!empty($config['theme'])) { + $render['block']['#attributes']['data-theme'] = $config['theme']; + } + + if (!empty($config['link_color'])) { + $render['block']['#attributes']['data-link-color'] = '#' . $config['link_color']; + } + + if (!empty($config['width'])) { + $render['block']['#attributes']['data-width'] = $config['width']; + } + + if (!empty($config['height'])) { + $render['block']['#attributes']['data-height'] = $config['height']; + } + + if (!empty($config['chrome'])) { + $options = array_keys(array_filter($config['chrome'])); + + if (count($options)) { + $render['block']['#attributes']['data-chrome'] = implode(' ', $options); + } + } + + if (!empty($config['border_color'])) { + $render['block']['#attributes']['data-border-color'] = '#' . $config['border_color']; + } + + if (!empty($config['language'])) { + $render['block']['#attributes']['lang'] = $config['language']; + } + + if (!empty($config['tweet_limit'])) { + $render['block']['#attributes']['data-tweet-limit'] = $config['tweet_limit']; + } + + if (!empty($config['related'])) { + $render['block']['#attributes']['data-related'] = $config['related']; + } + + if (!empty($config['polite'])) { + $render['block']['#attributes']['aria-polite'] = $config['polite']; + } + + return $render; + } + + /** + * {@inheritdoc} + */ + public function defaultConfiguration() { + return [ + 'username' => '', + 'theme' => '', + 'link_color' => '', + 'width' => '', + 'height' => '', + 'chrome' => [], + 'border_color' => '', + 'language' => '', + 'tweet_limit' => '', + 'related' => '', + 'polite' => '', + ]; + } + +} diff --git a/web/modules/twitter_block/src/Tests/TwitterBlockTest.php b/web/modules/twitter_block/src/Tests/TwitterBlockTest.php new file mode 100644 index 0000000000..051e144e7d --- /dev/null +++ b/web/modules/twitter_block/src/Tests/TwitterBlockTest.php @@ -0,0 +1,58 @@ +<?php + +namespace Drupal\twitter_block\Tests; + +use Drupal\simpletest\WebTestBase; + +/** + * Tests if the twitter block is available. + * + * @group twitter_block + */ +class TwitterBlockTest extends WebTestBase { + + /** + * Modules to enable. + * + * @var array + */ + public static $modules = ['system_test', 'block', 'twitter_block']; + + /** + * {@inheritdoc} + */ + protected function setUp() { + parent::setUp(); + // Create and login user. + $admin_user = $this->drupalCreateUser(array( + 'administer blocks', 'administer site configuration', + 'access administration pages', + )); + $this->drupalLogin($admin_user); + } + + /** + * Test that the twitter block can be placed and works. + */ + public function testTwitterBlock() { + // Test availability of the twitter block in the admin "Place blocks" list. + \Drupal::service('theme_handler')->install(['bartik', 'seven', 'stark']); + $theme_settings = $this->config('system.theme'); + foreach (['bartik', 'seven', 'stark'] as $theme) { + $this->drupalGet('admin/structure/block/list/' . $theme); + // Configure and save the block. + $this->drupalPlaceBlock('twitter_block', array( + 'username' => 'drupal', + 'width' => 180, + 'height' => 200, + 'region' => 'content', + 'theme' => $theme, + )); + // Set the default theme and ensure the block is placed. + $theme_settings->set('default', $theme)->save(); + $this->drupalGet(''); + $this->assertText('Tweets by @drupal', 'Twitter block found'); + } + } + +} diff --git a/web/modules/twitter_block/twitter_block.info.yml b/web/modules/twitter_block/twitter_block.info.yml new file mode 100644 index 0000000000..575c369217 --- /dev/null +++ b/web/modules/twitter_block/twitter_block.info.yml @@ -0,0 +1,12 @@ +name: Twitter Block +type: module +description: 'Provides configurable blocks for a Twitter feed.' +# core: 8.x +dependencies: + - block + +# Information added by Drupal.org packaging script on 2017-03-15 +version: '8.x-3.0-alpha0' +core: '8.x' +project: 'twitter_block' +datestamp: 1489574287 diff --git a/web/modules/twitter_block/twitter_block.libraries.yml b/web/modules/twitter_block/twitter_block.libraries.yml new file mode 100644 index 0000000000..2db93af776 --- /dev/null +++ b/web/modules/twitter_block/twitter_block.libraries.yml @@ -0,0 +1,3 @@ +widgets: + js: + https://platform.twitter.com/widgets.js: { type: external } diff --git a/web/modules/twitter_block/twitter_block.module b/web/modules/twitter_block/twitter_block.module new file mode 100644 index 0000000000..071a51369d --- /dev/null +++ b/web/modules/twitter_block/twitter_block.module @@ -0,0 +1,20 @@ +<?php + +/** + * @file + * Provides configurable blocks for a Twitter feed. + */ + +use Drupal\Core\Routing\RouteMatchInterface; + +/** + * Implements hook_help(). + */ +function twitter_block_help($route_name, RouteMatchInterface $route_match) { + $help_text = ''; + switch ($route_name) { + case 'help.page.twitter_block': + $help_text = '<p>' . t('This module provides configurable blocks for a Twitter feed.') . '</p>'; + return $help_text; + } +} -- GitLab