diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..2a5ddba --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +; This file is for unifying the coding style for different editors and IDEs. +; More information at https://editorconfig.org + +root = true + +[*] +charset = utf-8 +indent_size = 4 +indent_style = space +end_of_line = lf +insert_final_newline = true +trim_trailing_whitespace = true + +[*.md] +trim_trailing_whitespace = false + +[*.yml] +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..7d1de53 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,13 @@ +# Path-based git attributes +# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html + +# Ignore all test and documentation with "export-ignore". +/.gitattributes export-ignore +/.gitignore export-ignore +/.travis.yml export-ignore +/phpunit.xml.dist export-ignore +/tests export-ignore +/.editorconfig export-ignore +/.php.cs export-ignore +/.github export-ignore + diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5cad475 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +build +composer.lock +docs +vendor +coverage +.phpunit.result.cache +.idea +.php_cs.cache + diff --git a/.php_cs b/.php_cs new file mode 100644 index 0000000..6b6c913 --- /dev/null +++ b/.php_cs @@ -0,0 +1,38 @@ +notPath('bootstrap/*') + ->notPath('storage/*') + ->notPath('storage/*') + ->notPath('resources/view/mail/*') + ->in([ + __DIR__ . '/src', + __DIR__ . '/tests', + ]) + ->name('*.php') + ->notName('*.blade.php') + ->ignoreDotFiles(true) + ->ignoreVCS(true); + +return PhpCsFixer\Config::create() + ->setRules([ + '@PSR2' => true, + 'array_syntax' => ['syntax' => 'short'], + 'ordered_imports' => ['sortAlgorithm' => 'alpha'], + 'no_unused_imports' => true, + 'not_operator_with_successor_space' => true, + 'trailing_comma_in_multiline_array' => true, + 'phpdoc_scalar' => true, + 'unary_operator_spaces' => true, + 'binary_operator_spaces' => true, + 'blank_line_before_statement' => [ + 'statements' => ['break', 'continue', 'declare', 'return', 'throw', 'try'], + ], + 'phpdoc_single_line_var_spacing' => true, + 'phpdoc_var_without_name' => true, + 'method_argument_space' => [ + 'on_multiline' => 'ensure_fully_multiline', + 'keep_multiple_spaces_after_comma' => true, + ] + ]) + ->setFinder($finder); diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..b4ae1c4 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,55 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +Please read and understand the contribution guide before creating an issue or pull request. + +## Etiquette + +This project is open source, and as such, the maintainers give their free time to build and maintain the source code +held within. They make the code freely available in the hope that it will be of use to other developers. It would be +extremely unfair for them to suffer abuse or anger for their hard work. + +Please be considerate towards maintainers when raising issues or presenting pull requests. Let's show the +world that developers are civilized and selfless people. + +It's the duty of the maintainer to ensure that all submissions to the project are of sufficient +quality to benefit the project. Many developers have different skillsets, strengths, and weaknesses. Respect the maintainer's decision, and do not be upset or abusive if your submission is not used. + +## Viability + +When requesting or submitting new features, first consider whether it might be useful to others. Open +source projects are used by many developers, who may have entirely different needs to your own. Think about +whether or not your feature is likely to be used by other users of the project. + +## Procedure + +Before filing an issue: + +- Attempt to replicate the problem, to ensure that it wasn't a coincidental incident. +- Check to make sure your feature suggestion isn't already present within the project. +- Check the pull requests tab to ensure that the bug doesn't have a fix in progress. +- Check the pull requests tab to ensure that the feature isn't already in progress. + +Before submitting a pull request: + +- Check the codebase to ensure that your feature doesn't already exist. +- Check the pull requests to ensure that another person hasn't already submitted the feature or fix. + +## Requirements + +If the project maintainer has any additional requirements, you will find them listed here. + +- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - The easiest way to apply the conventions is to install [PHP Code Sniffer](https://pear.php.net/package/PHP_CodeSniffer). + +- **Add tests!** - Your patch won't be accepted if it doesn't have tests. + +- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date. + +- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org/). Randomly breaking public APIs is not an option. + +- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests. + +- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](https://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting. + +**Happy coding**! diff --git a/LICENSE.md b/LICENSE.md new file mode 100644 index 0000000..a8da885 --- /dev/null +++ b/LICENSE.md @@ -0,0 +1,21 @@ +The MIT License (MIT) + +Copyright (c) Roberto Butti + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in +all copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN +THE SOFTWARE. diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..a21ac75 --- /dev/null +++ b/composer.json @@ -0,0 +1,50 @@ +{ + "name": "hi-folks/laravel-dashboard-devto-tile", + "description": "Tile for Spatie Laravel Dashboard to list DEV.to articles", + "keywords": [ + "hi-folks", + "laravel-dashboard-devto-tile" + ], + "homepage": "https://github.com/hi-folks/laravel-dashboard-devto-tile", + "license": "MIT", + "authors": [ + { + "name": "Roberto Butti", + "role": "Developer" + } + ], + "require": { + "php": "^7.4", + "spatie/laravel-dashboard": "^1.0" + }, + "require-dev": { + "phpunit/phpunit": "^9.0" + }, + "autoload": { + "psr-4": { + "HiFolks\\DevtoTile\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "HiFolks\\DevtoTile\\Tests\\": "tests" + } + }, + "scripts": { + "test": "vendor/bin/phpunit", + "test-coverage": "vendor/bin/phpunit --coverage-html coverage", + "format": "vendor/bin/php-cs-fixer fix --allow-risky=yes" + }, + "config": { + "sort-packages": true + }, + "extra": { + "laravel": { + "providers": [ + "HiFolks\\DevtoTile\\DevtoTileServiceProvider" + ] + } + }, + "minimum-stability": "dev", + "prefer-stable": true +} diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..d019417 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,28 @@ + + + + + tests + + + + + src/ + + + + + + + + + diff --git a/resources/views/tile.blade.php b/resources/views/tile.blade.php new file mode 100644 index 0000000..d3dc3c8 --- /dev/null +++ b/resources/views/tile.blade.php @@ -0,0 +1,26 @@ + + +
DEV.TO Articles
+ +
+ + + + + + + + + + @foreach ($articles as $item) + + + + + + @endforeach + +
TitleViewsReactions
{{ $item["title"] }}{{ $item["page_views_count"] }}{{ $item["public_reactions_count"] }}
+
+ +
diff --git a/src/DevtoStore.php b/src/DevtoStore.php new file mode 100644 index 0000000..95937e4 --- /dev/null +++ b/src/DevtoStore.php @@ -0,0 +1,35 @@ +tile = Tile::firstOrCreateForName(self::TILE_NAME); + } + + public function setData(array $data): self + { + $this->tile->putData(self::TILE_KEY_ARTICLES, $data); + + return $this; + } + + public function getData(): array + { + return$this->tile->getData(self::TILE_KEY_ARTICLES) ?? []; + } +} diff --git a/src/DevtoTileComponent.php b/src/DevtoTileComponent.php new file mode 100644 index 0000000..1c83f0b --- /dev/null +++ b/src/DevtoTileComponent.php @@ -0,0 +1,25 @@ +position = $position; + } + + public function render() + { + return view('dashboard-devto-tile::tile', [ + 'articles' => DevtoStore::make()->getData(), + 'refreshIntervalInSeconds' => config('dashboard.tiles.devto.refresh_interval_in_seconds', 60), + + ]); + } +} diff --git a/src/DevtoTileServiceProvider.php b/src/DevtoTileServiceProvider.php new file mode 100644 index 0000000..e381be2 --- /dev/null +++ b/src/DevtoTileServiceProvider.php @@ -0,0 +1,26 @@ +app->runningInConsole()) { + $this->commands([ + FetchDataFromApiCommand::class, + ]); + } + + $this->publishes([ + __DIR__ . '/../resources/views' => resource_path('views/vendor/dashboard-devto-tile'), + ], 'dashboard-devto-tile-views'); + + $this->loadViewsFrom(__DIR__ . '/../resources/views', 'dashboard-devto-tile'); + + Livewire::component('devto-tile', DevtoTileComponent::class); + } +} diff --git a/src/FetchDataFromApiCommand.php b/src/FetchDataFromApiCommand.php new file mode 100644 index 0000000..f803496 --- /dev/null +++ b/src/FetchDataFromApiCommand.php @@ -0,0 +1,39 @@ +info('Fetching DEVto articles...'); + + $endpoint = "https://dev.to/api/articles/me/published"; + + + $token = config('dashboard.tiles.devto.configurations.default.api_key'); + $response = Http::withHeaders([ + 'api-key' => $token, + + ])->get($endpoint); + + $myData = $response->json(); + $sorted=[]; + if ($response->status() === 200) { + $sorted = array_reverse(Arr::sort($myData, function ($value) { + return $value['page_views_count']; + })); + DevtoStore::make()->setData($sorted); + } + + $this->info('All done, HTTP status:'. $response->status()); + } +} diff --git a/tests/ExampleTest.php b/tests/ExampleTest.php new file mode 100644 index 0000000..657dbe4 --- /dev/null +++ b/tests/ExampleTest.php @@ -0,0 +1,14 @@ +assertTrue(true); + } +}