From 858deacdbdfd9fe598038eb7c7020804bcc8001d Mon Sep 17 00:00:00 2001 From: thejmitchener Date: Fri, 22 Mar 2024 13:55:10 -0400 Subject: [PATCH] Update package name, author, and description. --- CHANGELOG.md | 2 +- LICENSE.md | 2 +- README.md | 63 ++- composer.json | 34 +- config/cloudflare-cache.php | 17 + config/skeleton.php | 6 - configure.php | 366 ------------------ database/factories/ModelFactory.php | 19 - .../migrations/create_skeleton_table.php.stub | 19 - phpstan-baseline.neon | 0 phpstan.neon.dist | 14 - phpunit.xml.dist | 2 +- resources/views/.gitkeep | 0 src/CloudflareCache.php | 60 +++ src/CloudflareCacheInterface.php | 8 + src/CloudflareCacheServiceProvider.php | 53 +++ src/Commands/SkeletonCommand.php | 19 - .../CloudflareCacheRequestException.php | 16 + src/Facades/CloudflareCache.php | 19 + src/Facades/Skeleton.php | 16 - src/Services/CloudflareService.php | 40 ++ src/Services/CloudflareServiceInterface.php | 13 + src/Skeleton.php | 7 - src/SkeletonServiceProvider.php | 25 -- tests/ExampleTest.php | 5 - tests/Pest.php | 2 +- tests/TestCase.php | 19 +- tests/Unit/CloudflareServiceTest.php | 25 ++ 28 files changed, 307 insertions(+), 564 deletions(-) create mode 100644 config/cloudflare-cache.php delete mode 100644 config/skeleton.php delete mode 100644 configure.php delete mode 100644 database/factories/ModelFactory.php delete mode 100644 database/migrations/create_skeleton_table.php.stub delete mode 100644 phpstan-baseline.neon delete mode 100644 phpstan.neon.dist delete mode 100644 resources/views/.gitkeep create mode 100755 src/CloudflareCache.php create mode 100644 src/CloudflareCacheInterface.php create mode 100644 src/CloudflareCacheServiceProvider.php delete mode 100644 src/Commands/SkeletonCommand.php create mode 100644 src/Exceptions/CloudflareCacheRequestException.php create mode 100644 src/Facades/CloudflareCache.php delete mode 100644 src/Facades/Skeleton.php create mode 100644 src/Services/CloudflareService.php create mode 100644 src/Services/CloudflareServiceInterface.php delete mode 100755 src/Skeleton.php delete mode 100644 src/SkeletonServiceProvider.php delete mode 100644 tests/ExampleTest.php create mode 100644 tests/Unit/CloudflareServiceTest.php diff --git a/CHANGELOG.md b/CHANGELOG.md index 87b3242..2f293db 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,3 @@ # Changelog -All notable changes to `:package_name` will be documented in this file. +All notable changes to `laravel-cloudflare-cache` will be documented in this file. diff --git a/LICENSE.md b/LICENSE.md index 58c9ad4..27fee67 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ The MIT License (MIT) -Copyright (c) :vendor_name +Copyright (c) fuelviews Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index f27e501..f9d5f22 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,55 @@ -# :package_description - -[![Latest Version on Packagist](https://img.shields.io/packagist/v/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug) -[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3Arun-tests+branch%3Amain) -[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/:vendor_slug/:package_slug/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/:vendor_slug/:package_slug/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) -[![Total Downloads](https://img.shields.io/packagist/dt/:vendor_slug/:package_slug.svg?style=flat-square)](https://packagist.org/packages/:vendor_slug/:package_slug) - ---- -This repo can be used to scaffold a Laravel package. Follow these steps to get started: - -1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton. -2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files. -3. Have fun creating your package. -4. If you need help creating a package, consider picking up our Laravel Package Training video course. ---- - -This is where your description should go. Limit it to a paragraph or two. Consider adding a small example. +# Fuelviews cloudflare cache package -## Installation +[![Latest Version on Packagist](https://img.shields.io/packagist/v/fuelviews/laravel-cloudflare-cache.svg?style=flat-square)](https://packagist.org/packages/fuelviews/laravel-cloudflare-cache) +[![GitHub Tests Action Status](https://img.shields.io/github/actions/workflow/status/fuelviews/laravel-cloudflare-cache/run-tests.yml?branch=main&label=tests&style=flat-square)](https://github.com/fuelviews/laravel-cloudflare-cache/actions?query=workflow%3Arun-tests+branch%3Amain) +[![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/fuelviews/laravel-cloudflare-cache/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/fuelviews/laravel-cloudflare-cache/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain) +[![Total Downloads](https://img.shields.io/packagist/dt/fuelviews/laravel-cloudflare-cache.svg?style=flat-square)](https://packagist.org/packages/fuelviews/laravel-cloudflare-cache) -You can install the package via composer: +The Fuelviews cloudflare cache package for laravel offers an efficient way to manage cloudflare's cache directly from your Laravel application, streamlining the purge process to ensure your content remains fresh. -```bash -composer require :vendor_slug/:package_slug -``` +## Installation -You can publish and run the migrations with: +You can install the package via composer: ```bash -php artisan vendor:publish --tag=":package_slug-migrations" -php artisan migrate +composer require fuelviews/laravel-cloudflare-cache ``` You can publish the config file with: ```bash -php artisan vendor:publish --tag=":package_slug-config" +php artisan vendor:publish --tag="cloudflare-cache-config" ``` This is the contents of the published config file: ```php + env('CLOUDFLARE_CACHE_KEY'), + + /** + * zone_id of your site on cloudflare dashboard. + */ + 'identifier' => env('CLOUDFLARE_CACHE_IDENTIFIER'), + + 'debug' => env('CLOUDFLARE_CACHE_DEBUG', false), ]; -``` - -Optionally, you can publish the views using -```bash -php artisan vendor:publish --tag=":package_slug-views" ``` ## Usage +Purges everything + ```php -$variable = new VendorName\Skeleton(); -echo $variable->echoPhrase('Hello, VendorName!'); +CloudflareCache::purgeEverything() ``` ## Testing @@ -79,6 +74,8 @@ Please review [our security policy](../../security/policy) on how to report secu - [Thejmitchener](https://github.com/thejmitchener) - [Fuelviews](https://github.com/fuelviews) +- [Yediyuz](https://github.com/yediyuz) +- [Mertasan](https://github.com/mertasan) - [All Contributors](../../contributors) ## Support us diff --git a/composer.json b/composer.json index 65e9908..078eb49 100644 --- a/composer.json +++ b/composer.json @@ -1,53 +1,49 @@ { - "name": ":vendor_slug/:package_slug", - "description": ":package_description", + "name": "fuelviews/laravel-cloudflare-cache", + "description": "Fuelviews cloudflare cache package", "keywords": [ - ":vendor_name", + "fuelviews", "laravel", - ":package_slug" + "laravel-cloudflare-cache" ], - "homepage": "https://github.com/:vendor_slug/:package_slug", + "homepage": "https://github.com/fuelviews/laravel-cloudflare-cache", "license": "MIT", "authors": [ { - "name": ":author_name", - "email": "author@domain.com", + "name": "Joshua Mitchener", + "email": "support@fuelviews.com", "role": "Developer" } ], "require": { "php": "^8.2", + "guzzlehttp/guzzle": "^7.8", "spatie/laravel-package-tools": "^1.16", + "illuminate/routing": "^10.10|^11.0", "illuminate/contracts": "^10.0||^11.0" }, "require-dev": { "laravel/pint": "^1.14", "nunomaduro/collision": "^8.1.1||^7.10.0", - "larastan/larastan": "^2.9", "orchestra/testbench": "^9.0.0||^8.22.0", "pestphp/pest": "^2.34", "pestphp/pest-plugin-arch": "^2.7", - "pestphp/pest-plugin-laravel": "^2.3", - "phpstan/extension-installer": "^1.3", - "phpstan/phpstan-deprecation-rules": "^1.1", - "phpstan/phpstan-phpunit": "^1.3", - "spatie/laravel-ray": "^1.35" + "pestphp/pest-plugin-laravel": "^2.3" }, "autoload": { "psr-4": { - "VendorName\\Skeleton\\": "src/", - "VendorName\\Skeleton\\Database\\Factories\\": "database/factories/" + "Fuelviews\\CloudflareCache\\": "src/" } }, "autoload-dev": { "psr-4": { - "VendorName\\Skeleton\\Tests\\": "tests/", + "Fuelviews\\CloudflareCache\\Tests\\": "tests/", "Workbench\\App\\": "workbench/app/" } }, "scripts": { "post-autoload-dump": "@composer run prepare", - "clear": "@php vendor/bin/testbench package:purge-skeleton --ansi", + "clear": "@php vendor/bin/testbench package:purge-laravel-cloudflare-cache --ansi", "prepare": "@php vendor/bin/testbench package:discover --ansi", "build": [ "@composer run prepare", @@ -73,10 +69,10 @@ "extra": { "laravel": { "providers": [ - "VendorName\\Skeleton\\SkeletonServiceProvider" + "Fuelviews\\CloudflareCache\\CloudflareCacheServiceProvider" ], "aliases": { - "Skeleton": "VendorName\\Skeleton\\Facades\\Skeleton" + "CloudflareCache": "Fuelviews\\CloudflareCache\\Facades\\CloudflareCache" } } }, diff --git a/config/cloudflare-cache.php b/config/cloudflare-cache.php new file mode 100644 index 0000000..d2e74a0 --- /dev/null +++ b/config/cloudflare-cache.php @@ -0,0 +1,17 @@ + env('CLOUDFLARE_CACHE_KEY'), + + /** + * zone_id of your site on cloudflare dashboard. + */ + 'identifier' => env('CLOUDFLARE_CACHE_IDENTIFIER'), + + 'debug' => env('CLOUDFLARE_CACHE_DEBUG', false), +]; diff --git a/config/skeleton.php b/config/skeleton.php deleted file mode 100644 index 7e74186..0000000 --- a/config/skeleton.php +++ /dev/null @@ -1,6 +0,0 @@ - $version) { - if (in_array($name, $names, true)) { - unset($data['require-dev'][$name]); - } - } - - file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)); -} - -function remove_composer_script($scriptName) -{ - $data = json_decode(file_get_contents(__DIR__.'/composer.json'), true); - - foreach ($data['scripts'] as $name => $script) { - if ($scriptName === $name) { - unset($data['scripts'][$name]); - break; - } - } - - file_put_contents(__DIR__.'/composer.json', json_encode($data, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE)); -} - -function remove_readme_paragraphs(string $file): void -{ - $contents = file_get_contents($file); - - file_put_contents( - $file, - preg_replace('/.*/s', '', $contents) ?: $contents - ); -} - -function safeUnlink(string $filename) -{ - if (file_exists($filename) && is_file($filename)) { - unlink($filename); - } -} - -function determineSeparator(string $path): string -{ - return str_replace('/', DIRECTORY_SEPARATOR, $path); -} - -function replaceForWindows(): array -{ - return preg_split('/\\r\\n|\\r|\\n/', run('dir /S /B * | findstr /v /i .git\ | findstr /v /i vendor | findstr /v /i '.basename(__FILE__).' | findstr /r /i /M /F:/ ":author :vendor :package VendorName skeleton migration_table_name vendor_name vendor_slug author@domain.com"')); -} - -function replaceForAllOtherOSes(): array -{ - return explode(PHP_EOL, run('grep -E -r -l -i ":author|:vendor|:package|VendorName|skeleton|migration_table_name|vendor_name|vendor_slug|author@domain.com" --exclude-dir=vendor ./* ./.github/* | grep -v '.basename(__FILE__))); -} - -function getGitHubApiEndpoint(string $endpoint): ?stdClass -{ - try { - $curl = curl_init("https://api.github.com/{$endpoint}"); - curl_setopt_array($curl, [ - CURLOPT_RETURNTRANSFER => true, - CURLOPT_FOLLOWLOCATION => true, - CURLOPT_HTTPGET => true, - CURLOPT_HTTPHEADER => [ - 'User-Agent: spatie-configure-script/1.0', - ], - ]); - - $response = curl_exec($curl); - $statusCode = curl_getinfo($curl, CURLINFO_HTTP_CODE); - - curl_close($curl); - - if ($statusCode === 200) { - return json_decode($response); - } - } catch (Exception $e) { - // ignore - } - - return null; -} - -function searchCommitsForGitHubUsername(): string -{ - $authorName = strtolower(trim(shell_exec('git config user.name'))); - - $committersRaw = shell_exec("git log --author='@users.noreply.github.com' --pretty='%an:%ae' --reverse"); - $committersLines = explode("\n", $committersRaw ?? ''); - $committers = array_filter(array_map(function ($line) use ($authorName) { - $line = trim($line); - [$name, $email] = explode(':', $line) + [null, null]; - - return [ - 'name' => $name, - 'email' => $email, - 'isMatch' => strtolower($name) === $authorName && ! str_contains($name, '[bot]'), - ]; - }, $committersLines), fn ($item) => $item['isMatch']); - - if (empty($committers)) { - return ''; - } - - $firstCommitter = reset($committers); - - return explode('@', $firstCommitter['email'])[0] ?? ''; -} - -function guessGitHubUsernameUsingCli() -{ - try { - if (preg_match('/ogged in to github\.com as ([a-zA-Z-_]+).+/', shell_exec('gh auth status -h github.com 2>&1'), $matches)) { - return $matches[1]; - } - } catch (Exception $e) { - // ignore - } - - return ''; -} - -function guessGitHubUsername(): string -{ - $username = searchCommitsForGitHubUsername(); - if (! empty($username)) { - return $username; - } - - $username = guessGitHubUsernameUsingCli(); - if (! empty($username)) { - return $username; - } - - // fall back to using the username from the git remote - $remoteUrl = shell_exec('git config remote.origin.url'); - $remoteUrlParts = explode('/', str_replace(':', '/', trim($remoteUrl))); - - return $remoteUrlParts[1] ?? ''; -} - -function guessGitHubVendorInfo($authorName, $username): array -{ - $remoteUrl = shell_exec('git config remote.origin.url'); - $remoteUrlParts = explode('/', str_replace(':', '/', trim($remoteUrl))); - - $response = getGitHubApiEndpoint("orgs/{$remoteUrlParts[1]}"); - - if ($response === null) { - return [$authorName, $username]; - } - - return [$response->name ?? $authorName, $response->login ?? $username]; -} - -$gitName = run('git config user.name'); -$authorName = ask('Author name', $gitName); - -$gitEmail = run('git config user.email'); -$authorEmail = ask('Author email', $gitEmail); -$authorUsername = ask('Author username', guessGitHubUsername()); - -$guessGitHubVendorInfo = guessGitHubVendorInfo($authorName, $authorUsername); - -$vendorName = ask('Vendor name', $guessGitHubVendorInfo[0]); -$vendorUsername = ask('Vendor username', $guessGitHubVendorInfo[1] ?? slugify($vendorName)); -$vendorSlug = slugify($vendorUsername); - -$vendorNamespace = str_replace('-', '', ucwords($vendorName)); -$vendorNamespace = ask('Vendor namespace', $vendorNamespace); - -$currentDirectory = getcwd(); -$folderName = basename($currentDirectory); - -$packageName = ask('Package name', $folderName); -$packageSlug = slugify($packageName); -$packageSlugWithoutPrefix = remove_prefix('laravel-', $packageSlug); - -$className = title_case($packageName); -$className = ask('Class name', $className); -$variableName = lcfirst($className); -$description = ask('Package description', "This is my package {$packageSlug}"); - -$usePhpStan = confirm('Enable PhpStan?', true); -$useLaravelPint = confirm('Enable Laravel Pint?', true); -$useDependabot = confirm('Enable Dependabot?', true); -$useLaravelRay = confirm('Use Ray for debugging?', true); -$useUpdateChangelogWorkflow = confirm('Use automatic changelog updater workflow?', true); - -writeln('------'); -writeln("Author : {$authorName} ({$authorUsername}, {$authorEmail})"); -writeln("Vendor : {$vendorName} ({$vendorSlug})"); -writeln("Package : {$packageSlug} <{$description}>"); -writeln("Namespace : {$vendorNamespace}\\{$className}"); -writeln("Class name : {$className}"); -writeln('---'); -writeln('Packages & Utilities'); -writeln('Use Laravel/Pint : '.($useLaravelPint ? 'yes' : 'no')); -writeln('Use Larastan/PhpStan : '.($usePhpStan ? 'yes' : 'no')); -writeln('Use Dependabot : '.($useDependabot ? 'yes' : 'no')); -writeln('Use Ray App : '.($useLaravelRay ? 'yes' : 'no')); -writeln('Use Auto-Changelog : '.($useUpdateChangelogWorkflow ? 'yes' : 'no')); -writeln('------'); - -writeln('This script will replace the above values in all relevant files in the project directory.'); - -if (! confirm('Modify files?', true)) { - exit(1); -} - -$files = (str_starts_with(strtoupper(PHP_OS), 'WIN') ? replaceForWindows() : replaceForAllOtherOSes()); - -foreach ($files as $file) { - replace_in_file($file, [ - ':author_name' => $authorName, - ':author_username' => $authorUsername, - 'author@domain.com' => $authorEmail, - ':vendor_name' => $vendorName, - ':vendor_slug' => $vendorSlug, - 'VendorName' => $vendorNamespace, - ':package_name' => $packageName, - ':package_slug' => $packageSlug, - ':package_slug_without_prefix' => $packageSlugWithoutPrefix, - 'Skeleton' => $className, - 'skeleton' => $packageSlug, - 'migration_table_name' => title_snake($packageSlug), - 'variable' => $variableName, - ':package_description' => $description, - ]); - - match (true) { - str_contains($file, determineSeparator('src/Skeleton.php')) => rename($file, determineSeparator('./src/'.$className.'.php')), - str_contains($file, determineSeparator('src/SkeletonServiceProvider.php')) => rename($file, determineSeparator('./src/'.$className.'ServiceProvider.php')), - str_contains($file, determineSeparator('src/Facades/Skeleton.php')) => rename($file, determineSeparator('./src/Facades/'.$className.'.php')), - str_contains($file, determineSeparator('src/Commands/SkeletonCommand.php')) => rename($file, determineSeparator('./src/Commands/'.$className.'Command.php')), - str_contains($file, determineSeparator('database/migrations/create_skeleton_table.php.stub')) => rename($file, determineSeparator('./database/migrations/create_'.title_snake($packageSlugWithoutPrefix).'_table.php.stub')), - str_contains($file, determineSeparator('config/skeleton.php')) => rename($file, determineSeparator('./config/'.$packageSlugWithoutPrefix.'.php')), - str_contains($file, 'README.md') => remove_readme_paragraphs($file), - default => [], - }; -} - -if (! $useLaravelPint) { - safeUnlink(__DIR__.'/.github/workflows/fix-php-code-style-issues.yml'); - safeUnlink(__DIR__.'/pint.json'); -} - -if (! $usePhpStan) { - safeUnlink(__DIR__.'/phpstan.neon.dist'); - safeUnlink(__DIR__.'/phpstan-baseline.neon'); - safeUnlink(__DIR__.'/.github/workflows/phpstan.yml'); - - remove_composer_deps([ - 'phpstan/extension-installer', - 'phpstan/phpstan-deprecation-rules', - 'phpstan/phpstan-phpunit', - 'larastan/larastan', - ]); - - remove_composer_script('phpstan'); -} - -if (! $useDependabot) { - safeUnlink(__DIR__.'/.github/dependabot.yml'); - safeUnlink(__DIR__.'/.github/workflows/dependabot-auto-merge.yml'); -} - -if (! $useLaravelRay) { - remove_composer_deps(['spatie/laravel-ray']); -} - -if (! $useUpdateChangelogWorkflow) { - safeUnlink(__DIR__.'/.github/workflows/update-changelog.yml'); -} - -confirm('Execute `composer install` and run tests?') && run('composer install && composer test'); - -confirm('Let this script delete itself?', true) && unlink(__FILE__); diff --git a/database/factories/ModelFactory.php b/database/factories/ModelFactory.php deleted file mode 100644 index c51604f..0000000 --- a/database/factories/ModelFactory.php +++ /dev/null @@ -1,19 +0,0 @@ -id(); - - // add fields - - $table->timestamps(); - }); - } -}; diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon deleted file mode 100644 index e69de29..0000000 diff --git a/phpstan.neon.dist b/phpstan.neon.dist deleted file mode 100644 index 489fa4e..0000000 --- a/phpstan.neon.dist +++ /dev/null @@ -1,14 +0,0 @@ -includes: - - phpstan-baseline.neon - -parameters: - level: 5 - paths: - - src - - config - - database - tmpDir: build/phpstan - checkOctaneCompatibility: true - checkModelProperties: true - checkMissingIterableValueType: false - diff --git a/phpunit.xml.dist b/phpunit.xml.dist index 4c61042..4713732 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -16,7 +16,7 @@ backupStaticProperties="false" > - + tests diff --git a/resources/views/.gitkeep b/resources/views/.gitkeep deleted file mode 100644 index e69de29..0000000 diff --git a/src/CloudflareCache.php b/src/CloudflareCache.php new file mode 100755 index 0000000..db7f814 --- /dev/null +++ b/src/CloudflareCache.php @@ -0,0 +1,60 @@ +|true> $options + */ + protected function purge(array $options = []): bool|string + { + $purgeRequest = $this->service->post('/purge_cache', $options); + + $responseData = $purgeRequest->json(); + + if (! $purgeRequest->successful()) { + throw CloudflareCacheRequestException::requestError($purgeRequest->status(), $responseData['errors'][0]['message'] ?? '-', $responseData['errors'][0]['code'] ?? null); + } + + if (! ($responseData['success'] ?? false)) { + return false; + } + + return $responseData['result']['id']; + } + + public function purgeEverything(): bool|string + { + return $this->purge([ + 'purge_everything' => true, + ]); + } + + public function isActive(): bool + { + if (app()->runningUnitTests()) { + return true; + } + + if (! config('cloudflare-cache.api_key') + || ! config('cloudflare-cache.identifier') + ) { + return false; + } + + if (config('cloudflare-cache.debug')) { + return true; + } + + return app()->isProduction(); + } +} diff --git a/src/CloudflareCacheInterface.php b/src/CloudflareCacheInterface.php new file mode 100644 index 0000000..5c7eab2 --- /dev/null +++ b/src/CloudflareCacheInterface.php @@ -0,0 +1,8 @@ +name('laravel-cloudflare-cache') + ->hasConfigFile(); + } + + public function packageRegistered(): void + { + $this->registerClient() + ->registerCloudflareCache(); + } + + public function registerClient(): static + { + $this->app->bind('cloudflare-cache.client', function ($app): Factory { + return $app[Factory::class]; + }); + + $this->app->singleton(CloudflareServiceInterface::class, function ($app): CloudflareService { + return new CloudflareService( + $app->make('cloudflare-cache.client'), + config('cloudflare-cache.api_key'), + config('cloudflare-cache.identifier'), + ); + }); + + return $this; + } + + public function registerCloudflareCache(): void + { + $this->app->bind(CloudflareCacheInterface::class, function ($app): CloudflareCache { + return new CloudflareCache( + $app->make(CloudflareServiceInterface::class) + ); + }); + + $this->app->alias(CloudflareCacheInterface::class, 'cloudflare-cache'); + } +} diff --git a/src/Commands/SkeletonCommand.php b/src/Commands/SkeletonCommand.php deleted file mode 100644 index 3e5f628..0000000 --- a/src/Commands/SkeletonCommand.php +++ /dev/null @@ -1,19 +0,0 @@ -comment('All done'); - - return self::SUCCESS; - } -} diff --git a/src/Exceptions/CloudflareCacheRequestException.php b/src/Exceptions/CloudflareCacheRequestException.php new file mode 100644 index 0000000..b159340 --- /dev/null +++ b/src/Exceptions/CloudflareCacheRequestException.php @@ -0,0 +1,16 @@ +client->withHeaders([ + 'Authorization' => 'Bearer '.$this->apiKey, + 'Content-Type' => 'application/json', + ]); + } + + public function getBaseUrl(string $endpoint): string + { + return 'https://api.cloudflare.com/client/v4/zones/'.$this->identifier.'/'.ltrim($endpoint, '/'); + } + + /** + * @param string[]|array|string[][] $data + */ + public function post(string $endpoint, array $data = []): Response + { + return $this->request()->post($this->getBaseUrl($endpoint), $data); + } +} diff --git a/src/Services/CloudflareServiceInterface.php b/src/Services/CloudflareServiceInterface.php new file mode 100644 index 0000000..dd263cb --- /dev/null +++ b/src/Services/CloudflareServiceInterface.php @@ -0,0 +1,13 @@ +|string[][] $data + */ + public function post(string $endpoint, array $data = []): Response; +} diff --git a/src/Skeleton.php b/src/Skeleton.php deleted file mode 100755 index 66fab60..0000000 --- a/src/Skeleton.php +++ /dev/null @@ -1,7 +0,0 @@ -name('skeleton') - ->hasConfigFile() - ->hasViews() - ->hasMigration('create_skeleton_table') - ->hasCommand(SkeletonCommand::class); - } -} diff --git a/tests/ExampleTest.php b/tests/ExampleTest.php deleted file mode 100644 index 5d36321..0000000 --- a/tests/ExampleTest.php +++ /dev/null @@ -1,5 +0,0 @@ -toBeTrue(); -}); diff --git a/tests/Pest.php b/tests/Pest.php index 7fe1500..9447252 100644 --- a/tests/Pest.php +++ b/tests/Pest.php @@ -1,5 +1,5 @@ in(__DIR__); diff --git a/tests/TestCase.php b/tests/TestCase.php index d04fb0c..4e94d0e 100644 --- a/tests/TestCase.php +++ b/tests/TestCase.php @@ -1,10 +1,10 @@ 'VendorName\\Skeleton\\Database\\Factories\\'.class_basename($modelName).'Factory' - ); } protected function getPackageProviders($app) { return [ - SkeletonServiceProvider::class, + CloudflareCacheServiceProvider::class, ]; } public function getEnvironmentSetUp($app) { - config()->set('database.default', 'testing'); + config()->set('app.key', 'base64:'.base64_encode(Encrypter::generateKey(config()['app.cipher']))); - /* - $migration = include __DIR__.'/../database/migrations/create_skeleton_table.php.stub'; - $migration->up(); - */ + config()->set('cloudflare-cache.api_key', ''); + config()->set('cloudflare-cache.identifier', ''); } } diff --git a/tests/Unit/CloudflareServiceTest.php b/tests/Unit/CloudflareServiceTest.php new file mode 100644 index 0000000..d90ad04 --- /dev/null +++ b/tests/Unit/CloudflareServiceTest.php @@ -0,0 +1,25 @@ +make(\Fuelviews\CloudflareCache\Services\CloudflareServiceInterface::class); + $service->post('purge_cache'); + + Http::assertSentCount(1); + Http::assertSent(function (Request $request, Response $response) { + $this->assertTrue($request->hasHeader('Authorization')); + $this->assertTrue($request->hasHeader('Content-Type')); + $this->assertSame($request->url(), 'https://api.cloudflare.com/client/v4/zones//purge_cache'); + + expect($response) + ->status() + ->toBe(200); + + return $request; + }); +});