Initial commit

.github/workflows/run_tests.yml

@@ -0,0 +1,92 @@
+name: Run Tests
+
+on:
+  push:
+    branches: [master]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        php-versions: [ '7.4', '8.0', '8.1', '8.2', '8.3' ]
+
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-versions }}
+
+      - name: Validate composer.json and composer.lock
+        working-directory: .
+        run: composer validate --strict
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v4
+        with:
+          path: ./vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        working-directory: .
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run Unit test suite
+        working-directory: .
+        run: ./vendor/bin/phpunit --testsuite "Project Test Suite" --do-not-cache-result
+
+      - name: Run phpstan
+        working-directory: .
+        run: ./vendor/bin/phpstan
+
+      - name: Run psalm
+        working-directory: .
+        run: ./vendor/bin/psalm
+
+  coverage:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+
+      - name: Cache Composer packages
+        id: composer-cache
+        uses: actions/cache@v4
+        with:
+          path: ./vendor
+          key: ${{ runner.os }}-php-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-php-
+
+      - name: Install dependencies
+        working-directory: .
+        run: composer install --prefer-dist --no-progress
+
+      - name: Run code coverage
+        working-directory: .
+        run: php -d xdebug.mode=coverage ./vendor/bin/phpunit --testsuite "Project Test Suite" --do-not-cache-result --coverage-clover clover.xml
+
+      - name: Make code coverage badge
+        uses: timkrase/phpunit-coverage-badge@v1.2.1
+        with:
+          coverage_badge_path: output/coverage.svg
+          push_badge: false
+
+      - name: Git push to image-data branch
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          publish_dir: ./output
+          publish_branch: badges
+          github_token: ${{ secrets.PRIVATE_TOKEN }}
+          user_name: 'github-actions[bot]'
+          user_email: 'github-actions[bot]@users.noreply.github.com'

.gitignore

@@ -0,0 +1,5 @@
+# vendor
+.phpunit.result.cache
+.php-cs-fixer.cache
+coverage
+languages/*~

.php-cs-fixer.php

@@ -0,0 +1,164 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+$rules = [
+    'array_indentation' => true,
+    'array_syntax' => ['syntax' => 'short'],
+    'binary_operator_spaces' => [
+        'default' => 'single_space',
+        'operators' => ['=>' => null],
+    ],
+    'blank_line_after_namespace' => true,
+    'blank_line_after_opening_tag' => true,
+    'blank_line_before_statement' => [
+        'statements' => ['return'],
+    ],
+    'braces' => true,
+    'cast_spaces' => true,
+    'class_attributes_separation' => [
+        'elements' => [
+            'const' => 'none',
+            'method' => 'one',
+            'property' => 'one',
+            'trait_import' => 'none',
+        ],
+    ],
+    'class_definition' => [
+        'multi_line_extends_each_single_line' => true,
+        'single_item_single_line' => true,
+        'single_line' => true,
+    ],
+    'concat_space' => [
+        'spacing' => 'one',
+    ],
+    'constant_case' => ['case' => 'lower'],
+    'declare_equal_normalize' => true,
+    'elseif' => true,
+    'encoding' => true,
+    'full_opening_tag' => true,
+    'fully_qualified_strict_types' => true, // added by Shift
+    'function_declaration' => true,
+    'function_typehint_space' => true,
+    'general_phpdoc_tag_rename' => true,
+    'heredoc_to_nowdoc' => true,
+    'include' => true,
+    'increment_style' => ['style' => 'post'],
+    'indentation_type' => true,
+    'linebreak_after_opening_tag' => true,
+    'line_ending' => true,
+    'lowercase_cast' => true,
+    'lowercase_keywords' => true,
+    'lowercase_static_reference' => true, // added from Symfony
+    'magic_method_casing' => true, // added from Symfony
+    'magic_constant_casing' => true,
+    'method_argument_space' => [
+        'on_multiline' => 'ignore',
+    ],
+    'multiline_whitespace_before_semicolons' => [
+        'strategy' => 'no_multi_line',
+    ],
+    'native_function_casing' => true,
+    'no_alias_functions' => true,
+    'no_extra_blank_lines' => [
+        'tokens' => [
+            'extra',
+            'throw',
+            'use',
+        ],
+    ],
+    'no_blank_lines_after_class_opening' => true,
+    'no_blank_lines_after_phpdoc' => true,
+    'no_closing_tag' => true,
+    'no_empty_phpdoc' => true,
+    'no_empty_statement' => true,
+    'no_leading_import_slash' => true,
+    'no_leading_namespace_whitespace' => true,
+    'no_mixed_echo_print' => [
+        'use' => 'echo',
+    ],
+    'no_multiline_whitespace_around_double_arrow' => true,
+    'no_short_bool_cast' => true,
+    'no_singleline_whitespace_before_semicolons' => true,
+    'no_spaces_after_function_name' => true,
+    'no_spaces_around_offset' => [
+        'positions' => ['inside', 'outside'],
+    ],
+    'no_spaces_inside_parenthesis' => true,
+    'no_trailing_comma_in_list_call' => true,
+    'no_trailing_comma_in_singleline_array' => true,
+    'no_trailing_whitespace' => true,
+    'no_trailing_whitespace_in_comment' => true,
+    'no_unneeded_control_parentheses' => [
+        'statements' => ['break', 'clone', 'continue', 'echo_print', 'return', 'switch_case', 'yield'],
+    ],
+    'no_unreachable_default_argument_value' => true,
+    'no_useless_return' => true,
+    'no_whitespace_before_comma_in_array' => true,
+    'no_whitespace_in_blank_line' => true,
+    'normalize_index_brace' => true,
+    'not_operator_with_successor_space' => false,
+    'object_operator_without_whitespace' => true,
+    'ordered_imports' => ['sort_algorithm' => 'alpha'],
+    'psr_autoloading' => true,
+    'phpdoc_indent' => true,
+    'phpdoc_inline_tag_normalizer' => true,
+    'phpdoc_no_access' => true,
+    'phpdoc_no_package' => true,
+    'phpdoc_no_useless_inheritdoc' => true,
+    'phpdoc_scalar' => true,
+    'phpdoc_single_line_var_spacing' => true,
+    'phpdoc_summary' => false,
+    'phpdoc_to_comment' => false, // override to preserve user preference
+    'phpdoc_tag_type' => true,
+    'phpdoc_trim' => true,
+    'phpdoc_types' => true,
+    'phpdoc_var_without_name' => true,
+    'self_accessor' => true,
+    'short_scalar_cast' => true,
+    'simplified_null_return' => false, // disabled as "risky"
+    'single_blank_line_at_eof' => true,
+    'single_blank_line_before_namespace' => true,
+    'single_class_element_per_statement' => [
+        'elements' => ['const', 'property'],
+    ],
+    'single_import_per_statement' => true,
+    'single_line_after_imports' => true,
+    'single_line_comment_style' => [
+        'comment_types' => ['hash'],
+    ],
+    'single_quote' => true,
+    'space_after_semicolon' => true,
+    'standardize_not_equals' => true,
+    'switch_case_semicolon_to_colon' => true,
+    'switch_case_space' => true,
+    'ternary_operator_spaces' => true,
+    'trailing_comma_in_multiline' => ['elements' => ['arrays']],
+    'trim_array_spaces' => true,
+    'unary_operator_spaces' => true,
+    'visibility_required' => [
+        'elements' => ['method', 'property'],
+    ],
+    'whitespace_after_comma_in_array' => true,
+];
+
+
+$finder = Finder::create()
+    ->in([
+        __DIR__ . '/src',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->exclude([
+        __DIR__ . '/src/templates',
+    ])
+    // ->notName('templates/*')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return (new Config)
+    ->setFinder($finder)
+    ->setRules($rules)
+    ->setRiskyAllowed(true)
+    ->setUsingCache(true);

README.md

@@ -0,0 +1,130 @@
+# News Data IO
+
+[![Run Tests](https://github.com/krollobrocket/newsdata-io/actions/workflows/run_tests.yml/badge.svg?branch=master)](https://github.com/krollobrocket/newsdata-io/actions/workflows/run_tests.yml)
+[![Coverage](https://raw.githubusercontent.com/krollobrocket/newsdata-io/badges/coverage.svg)](https://raw.githubusercontent.com/krollobrocket/newsdata-io/badges/coverage.svg)
+
+## Unfortunately I am not able to get a free account from newsdata.io for development and for this reason I am not able to implement support for the premium endpoints.
+
+**Contributors:** cyclonecode \
+**Donate link:** https://www.buymeacoffee.com/cyclonecode \
+**Tags:** news, article, feed \
+**Requires at least:** 5.3 \
+**Tested up to:** 6.6.1 \
+**Requires PHP:** 7.4 \
+**Stable tag:** 1.0.0 \
+**License:** GPLv2 or later \
+**License URI:** http://www.gnu.org/licenses/gpl-2.0.html
+
+This plugin display a news feed fetched from newsdata.io.
+
+## Description
+
+This plugin is developed by [Cyclonecode](https://profiles.wordpress.org/cyclonecode) and can be used to display a news feed fetched from newsdata.io.
+
+First you need to get an API key from newsdata.io by following the steps as described here: [How to get the NewsData.io API key](https://newsdata.io/documentation/#get-newdata-api-keyhttps://newsdata.io/documentation/#get-newdata-api-key).
+
+If you have questions or perhaps some idea on things that should be added you can also try [slack](https://join.slack.com/t/cyclonecode/shared_invite/zt-6bdtbdab-n9QaMLM~exHP19zFDPN~AQ).
+
+### Shortcode
+
+The shortcode **[newsdata-io]** can either be used by adding it to the content field of any post or page or by using the **do_shortcode** function in one of your templates.
+
+Shortcode attributes:
+
+- size
+
+Number of news. This value cannot be larger than 10 when using a free api key, otherwise the maximum is 50.
+
+- q
+
+Search news articles for specific keywords or phrases present in the news title, content, URL, meta keywords and meta description.
+This attribute cannot be combined with the qInMeta or qInTitle attributes.
+
+- qInTitle
+
+Search news articles for specific keywords or phrases present in the news titles only.
+This attribute cannot be combined with the q or qInMeta attributes.
+
+- qInMeta
+
+Search news articles for specific keywords or phrases present in the news titles, URL, meta keywords and meta description only.
+This attribute cannot be combined with the q or qInTitle attributes.
+
+- country
+
+Search the news articles from a specific country. You can add up to 5 countries in a single query.
+
+- category
+
+Search the news articles for a specific category. You can add up to 5 categories in a single query.
+
+- excludeCategory
+
+You can exclude specific categories to search for news articles. You can exclude up to 5 categories in a single query.
+
+- language
+
+Search the news articles for a specific language. You can add up to 5 languages in a single query.
+
+- domain
+
+Search the news articles for specific domains or news sources. You can add up to 5 domains in a single query.
+
+- excludeDomain
+
+You can exclude specific domains or news sources to search the news articles. You can exclude up to 5 domains in a single query.
+
+- domainUrl
+
+Search the news articles for specific domains or news sources. You can add up to 5 domains in a single query.
+
+- priorityDomain
+
+Search the news articles only from top news domains. Valid values are top, medium and low.
+
+- image
+
+Only fetch news articles with or without an image.
+
+- video
+
+Only fetch news articles with or without a video.
+
+Here is an example using all of the above attributes (notice that some of the attributes cannot be combined; this is just an example):
+
+`[newsdata-io size=5 q="Donald" qInTitle="Trump" qInMeta="Donald duck" country="us,gb,dk" category="sports,technology" excludeCategory="crime,domestic" language="sv,en" domain="bbc" excludeDomain="example" domainUrl="bbc.com" priorityDomain="top" image=1 video=0]`
+
+**Notice** that all shortcode attributes are optional and that they **must** be on a single line.
+Default values is taken from the plugins settings page.
+
+## Improvements
+
+If you have any ideas for improvements, don't hesitate to email me at cyclonecode@gmail.com or send me a message on [slack](https://join.slack.com/t/cyclonecode/shared_invite/zt-6bdtbdab-n9QaMLM~exHP19zFDPN~AQ).
+
+## Support
+
+If you run into any trouble, don’t hesitate to add a new topic under the support section:
+[https://wordpress.org/support/plugin/newsdata-io](https://wordpress.org/support/plugin/newsdata-io)
+
+You can also try contacting me on [slack](https://join.slack.com/t/cyclonecode/shared_invite/zt-6bdtbdab-n9QaMLM~exHP19zFDPN~AQ).
+
+## Installation
+
+1. Upload newsdata-io to the **/wp-content/plugins/** directory,
+2. Activate the plugin through the **Plugins** menu in WordPress.
+3. Add your Api Key and configure the plugin at **/wp-admin/admin.php?page=newsdata-io** in WordPress.
+4. You can then add a shortcode in order to display the news listing.
+
+## Frequently Asked Questions
+
+## Upgrade Notice
+
+## Screenshots
+
+### 1. A basic news listing.
+
+[missing image]
+
+
+## Changelog
+