Release v1.0.0 (#1)

Author: mhdcodes

.github/workflows/ci.yml

@@ -10,9 +10,9 @@ jobs:
             matrix:
                 os: [ubuntu-latest, windows-latest]
                 php: [8.0, 7.4]
-                stability: [prefer-lowest, prefer-stable]
+                stability: [prefer-stable]
 
-        name: P${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
+        name: PHP${{ matrix.php }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
         steps:
             - name: Checkout code
@@ -33,4 +33,4 @@ jobs:
               run: composer update --${{ matrix.stability }} --prefer-dist --no-interaction
 
             - name: Execute tests
-              run: vendor/bin/phpunit
+              run: vendor/bin/pest

.gitignore

@@ -0,0 +1,11 @@
+.idea
+.php_cs
+.php_cs.cache
+.phpunit.result.cache
+build
+coverage
+psalm.xml
+testbench.yaml
+vendor
+.php-cs-fixer.cache
+.phpunit.cache

CHANGELOG.md

@@ -2,6 +2,6 @@
 
 All notable changes to `pest-plugin-vcr` will be documented in this file
 
-## 1.0.0 - 2021-08-28
+## 1.0.0 - 2021-08-29
 
 - initial release

README.md

@@ -2,7 +2,7 @@
 
 [![Latest Version on Packagist](https://img.shields.io/packagist/v/phpjuice/pest-plugin-vcr.svg?style=flat-square)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)
 [![Total Downloads](https://img.shields.io/packagist/dt/phpjuice/pest-plugin-vcr.svg?style=flat-square)](https://packagist.org/packages/phpjuice/pest-plugin-vcr)
-![GitHub Actions](https://github.com/phpjuice/pest-plugin-vcr/actions/workflows/main.yml/badge.svg)
+![GitHub Actions](https://github.com/phpjuice/pest-plugin-vcr/actions/workflows/ci.yml/badge.svg)
 
 Integrates Pest with PHP-VCR using plugins.
 
@@ -16,12 +16,35 @@ composer require phpjuice/pest-plugin-vcr --dev
 
 ## Usage
 
+To make this plugin functionality available, we need to let Pest know that it should use it. 
+
+We will do this by adding the following to your `Pest.php`:
+
 ```php
 use PHPJuice\PestPluginVcr\PestPluginVcr;
 
 Pest\Plugin::uses(PestPluginVcr::class);
 ```
 
+## Example
+
+The following testsuite, will first send a request to `pestphp.com` and 
+Record your test suite's HTTP interactions into a cassette and replay them 
+during future test runs for fast, deterministic, accurate tests...
+
+```php
+it('records requests to pestphp.com', function () {
+
+    vcrTurnOn('pestphp.com');
+
+    $result = file_get_contents('https://pestphp.com/');
+
+    expect($result)
+        ->toBe('Hello from pestphp.');
+
+    vcrTurnOff();
+});
+```
 ### Testing
 
 ```bash
@@ -38,11 +61,10 @@ Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
 
 ### Security
 
-If you discover any security related issues, please email mohammed@amalyet.com instead of using the issue tracker.
+If you discover any security related issues, reach out to me @tsd_mohammed instead of using the issue tracker.
 
 ## Credits
 
-- [Mohammed](https://github.com/phpjuice)
 - [All Contributors](../../contributors)
 
 ## License

bootstrap/autoload.php

@@ -0,0 +1,15 @@
+<?php
+
+/**
+ * Register The Auto Loader
+ *
+ * We are using our custom bootstrap file for phpunit,
+ * in order for vcr to mock curl calls.
+ * @see http://php-vcr.github.io/documentation/installation/
+ */
+require __DIR__.'/../vendor/autoload.php';
+
+use VCR\VCR;
+
+VCR::configure()->setCassettePath(__DIR__."/../tests/cassettes");
+VCR::turnOn();

composer.json

@@ -16,24 +16,34 @@
     }
   ],
   "require": {
-    "php": "^7.4|^8.0"
+    "php": "^7.4|^8.0",
+    "php-vcr/php-vcr": "^1.5"
   },
   "require-dev": {
+    "ext-curl": "*",
+    "filp/whoops": "^2.9",
+    "pestphp/pest": "^1.17",
     "phpunit/phpunit": "^9.0"
   },
   "autoload": {
     "psr-4": {
       "PHPJuice\\PestPluginVcr\\": "src"
-    }
+    },
+    "files": [
+      "src/PestPluginVcr.php"
+    ]
   },
   "autoload-dev": {
     "psr-4": {
       "PHPJuice\\PestPluginVcr\\Tests\\": "tests"
-    }
+    },
+    "files": [
+      "vendor/filp/whoops/src/Whoops/Util/Misc.php"
+    ]
   },
   "scripts": {
-    "test": "vendor/bin/phpunit",
-    "test-coverage": "vendor/bin/phpunit --coverage-html coverage"
+    "test": "vendor/bin/pest",
+    "test-coverage": "XDEBUG_MODE=coverage vendor/bin/pest --coverage"
   },
   "config": {
     "sort-packages": true