v1.0.0

.docker/services/nginx/default.conf

@@ -0,0 +1,33 @@
+server {
+    listen 80;
+    listen [::]:80;
+    server_name example.com;
+    root /app/public;
+
+    add_header X-Frame-Options "SAMEORIGIN";
+    add_header X-Content-Type-Options "nosniff";
+
+    index index.php;
+
+    charset utf-8;
+
+    location / {
+        root /app/public;
+        try_files $uri $uri/ /index.php?$query_string;
+    }
+
+    location = /favicon.ico { access_log off; log_not_found off; }
+    location = /robots.txt  { access_log off; log_not_found off; }
+
+    error_page 404 /index.php;
+
+    location ~ \.php$ {
+        fastcgi_pass php:9000;
+        fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
+        include fastcgi_params;
+    }
+
+    location ~ /\.(?!well-known).* {
+        deny all;
+    }
+}

.docker/services/php/Dockerfile

@@ -0,0 +1,41 @@
+FROM php:8.3-fpm
+
+ARG user=a
+ARG uid=1000
+
+# Install system dependencies
+RUN apt-get update && apt-get install -y \
+    git \
+    curl \
+    libpng-dev \
+    libonig-dev \
+    libxml2-dev \
+    libzip-dev \
+    zip \
+    libcurl4-openssl-dev \
+    pkg-config \
+    libssl-dev \
+    unzip \
+    gnupg \
+    wget
+
+# Clear cache
+RUN apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# Install PHP extensions
+RUN pecl install xdebug && docker-php-ext-enable xdebug
+RUN pecl install redis && docker-php-ext-enable redis
+RUN docker-php-ext-install pdo pdo_mysql zip mbstring intl sockets bcmath opcache
+
+# Get latest Composer
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+# Create system user to run Composer
+RUN useradd -G www-data,root -u $uid -d /home/$user $user
+RUN mkdir -p /home/$user/.composer && \
+    chown -R $user:$user /home/$user
+
+# Set working directory
+WORKDIR /app
+
+USER $user

.docker/services/php/ini/error_reporting.ini

@@ -0,0 +1 @@
+error_reporting=E_ALL

.docker/services/php/ini/opcache.ini

@@ -0,0 +1,13 @@
+zend_extension=opcache
+
+[opcache]
+opcache.enable=1
+; 0 means it will check on every request
+; 0 is irrelevant if opcache.validate_timestamps=0 which is desirable in production
+opcache.revalidate_freq=0
+opcache.validate_timestamps=1
+opcache.max_accelerated_files=10000
+opcache.memory_consumption=192
+opcache.max_wasted_percentage=10
+opcache.interned_strings_buffer=16
+opcache.fast_shutdown=1

.docker/services/php/ini/xdebug.ini

@@ -0,0 +1,7 @@
+zend_extension=xdebug
+
+[xdebug]
+xdebug.discover_client_host=true
+xdebug.max_nesting_level=250
+xdebug.mode=coverage,debug
+xdebug.log_level=0

.dockerignore

@@ -0,0 +1,7 @@
+.git
+.docker
+.dockerignore
+docker-compose.yml
+.idea
+.phpunit.result.cache
+Makefile

.editorconfig

@@ -0,0 +1,15 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[*.{yml,yaml}]
+indent_size = 2

.env.example

@@ -0,0 +1,41 @@
+APP_NAME=wic_api
+APP_ENV=local
+APP_KEY=
+APP_DEBUG=0
+APP_URL=http://localhost
+APP_PORT=8080
+APP_TIMEZONE=UTC
+
+XDEBUG_SESSION=PHPSTORM
+XDEBUG_IDE_KEY=PHPSTORM
+XDEBUG_SERVER_NAME=localhost
+XDEBUG_CLIENT_HOST=host.docker.internal
+XDEBUG_START_WITH_REQUEST=trigger # yes | no | trigger
+
+LOG_CHANNEL=stack
+
+CACHE_DRIVER=redis
+
+# Depends on APP_NAME value
+# {APP_NAME}_redis
+REDIS_HOST=wic_api_redis
+REDIS_PORT=6379
+REDIS_PASSWORD=password
+
+QUEUE_CONNECTION=sync
+
+USE_RANDOM_USER_AGENT=1
+DEFAULT_USER_AGENT='Mozilla/5.0 (Linux; Android 13; SM-G998B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Mobile Safari/537.36'
+
+# callfilter.app
+CF_PROVIDER=1
+# callinsider.com.ua
+CI_PROVIDER=1
+# kto-zvonil.com.ua
+KC_PROVIDER=1
+# ktozvonil.net
+KZ_PROVIDER=1
+# slick.ly
+SL_PROVIDER=1
+# telefonnyjdovidnyk.com.ua
+TD_PROVIDER=1

.env.github-actions-testing

@@ -0,0 +1,17 @@
+APP_DEBUG=0
+
+USE_RANDOM_USER_AGENT=1
+DEFAULT_USER_AGENT='Mozilla/5.0 (Linux; Android 13; SM-G998B) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/112.0.0.0 Mobile Safari/537.36'
+
+# callfilter.app
+CF_PROVIDER=1
+# callinsider.com.ua
+CI_PROVIDER=1
+# kto-zvonil.com.ua
+KC_PROVIDER=1
+# ktozvonil.net
+KZ_PROVIDER=1
+# slick.ly
+SL_PROVIDER=1
+# telefonnyjdovidnyk.com.ua
+TD_PROVIDER=1

.github/workflows/coding-style.yml

@@ -0,0 +1,43 @@
+name: coding-style
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  coding-style:
+    name: PHPStan + PHP_CodeSniffer
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    services:
+      redis:
+        image: redis:latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v2
+
+      - name: Generate ApiTesterActions.php
+        run: |
+          vendor/bin/codecept build
+          composer dump-autoload
+
+      - name: PHPStan
+        run: ./vendor/bin/phpstan --no-progress --memory-limit=256M
+
+      - name: PHP_CodeSniffer
+        run: ./vendor/bin/phpcs --no-cache

.github/workflows/tests.yml

@@ -0,0 +1,49 @@
+name: tests
+
+on:
+  push:
+    branches:
+      - main
+      - dev
+  pull_request:
+    branches:
+      - main
+      - dev
+
+jobs:
+  tests:
+    name: PHPUnit + Code coverage
+    runs-on: ubuntu-latest
+    continue-on-error: false
+    services:
+      redis:
+        image: redis:latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup php
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: 8.3
+          coverage: xdebug
+
+      - name: Install dependencies
+        uses: ramsey/composer-install@v2
+
+      - name: Init .env
+        run: cp .env.github-actions-testing .env
+
+      - name: PHPUnit + Code coverage
+        run: vendor/bin/phpunit --coverage-clover ./tests/_output/clover.xml
+
+#      - name: Coveralls.io
+#        env:
+#          COVERALLS_REPO_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#        run: |
+#          composer require php-coveralls/php-coveralls -n
+#          vendor/bin/php-coveralls --coverage_clover=./tests/_output/clover.xml -v --json_path=./tests/_output/coveralls-upload.json
+
+      - name: Codeception
+        run: vendor/bin/codecept run

.gitignore

@@ -0,0 +1,16 @@
+/.idea/
+storage
+.env
+.phpunit.result.cache
+.phpunit.cache
+/tests/_output
+!/tests/_output/.gitkeep
+phpstan.neon
+/vendor/
+/storage/
+!/storage/app/.gitkeep
+!/storage/framework/cache/.gitkeep
+!/storage/framework/views/.gitkeep
+!/storage/logs/.gitkeep
+!/.phpstorm.meta.php
+/public/doc

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Anton Petrenko
+
+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.