Merge pull request #40 from vinicinbgs/feat/#39

feat: #39 update document api

.gitignore

@@ -9,4 +9,10 @@ package-lock.json
 /tests/Bootstrap.php
 phpunit.xml
 .phpunit.result.cache
-coverage/
+coverage/
+.phpdoc
+Gemfile.lock
+_site
+.jekyll-cache
+phpDocumentor.phar
+phpdoc/

.vscode/launch.json

@@ -1,35 +1,21 @@
 {
-  // Use IntelliSense to learn about possible attributes.
-  // Hover to view descriptions of existing attributes.
-  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Listen for Xdebug",
-      "type": "php",
-      "request": "launch",
-      "pathMappings": {
-        "${workspaceFolder}/tests/": "${workspaceFolder}/tests"
-      }
-    },
-    {
-      "name": "Launch Built-in web server",
-      "type": "php",
-      "request": "launch",
-      "runtimeArgs": [
-        "-dxdebug.mode=debug",
-        "-dxdebug.start_with_request=yes",
-        "-S",
-        "localhost:0"
-      ],
-      "program": "",
-      "cwd": "${workspaceRoot}",
-      "port": 9003,
-      "serverReadyAction": {
-        "pattern": "Development Server \\(http://localhost:([0-9]+)\\) started",
-        "uriFormat": "http://localhost:%s",
-        "action": "openExternally"
-      }
-    }
-  ]
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Listen for Xdebug",
+            "type": "php",
+            "request": "launch",
+            "pathMappings": {
+                "${workspaceFolder}/tests/": "${workspaceFolder}/tests"
+            },
+            "runtimeArgs": [
+                "-dxdebug.mode=debug",
+                "-dxdebug.start_with_request=yes",
+                "-dxdebug.client_port=9003"
+            ]
+        }
+    ]
 }

Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "jekyll"
+
+group :jekyll_plugins do
+  gem "jekyll-feed"
+  gem "jekyll-seo-tag"
+  gem "jekyll-theme-cayman"
+end

Makefile

@@ -0,0 +1,21 @@
+.PHONY: phpdoc-install
+phpdoc-install:
+	@echo "Installing phpDocumentor..."
+	curl -Lo phpDocumentor.phar https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.4.3/phpDocumentor.phar
+
+.PHONY: phpdoc-generate
+phpdoc-generate:
+	rm -Rf .phpdoc
+	@echo "Generating phpDocumentor documentation..."
+	php phpDocumentor.phar run -d ./src -t phpdoc --setting=graphs.enabled=true
+	@echo "phpdoc/index.html"
+
+.PHONY: ruby-install
+ruby-install:
+	@echo "Installing Ruby dependencies..."
+	bundle install
+
+.PHONY: jekyll-serve
+jekyll-serve:
+	@echo "Building Jekyll site..."
+	bundle exec jekyll serve -s ./docs/

README.md

@@ -24,7 +24,9 @@ composer require vinicinbgs/autentique-v2
 
 # Tests
 The tests are _**integrated directly with Autentique API**_, so you need to set your `.env` file based on `.env.example` Make sure you have set the `AUTENTIQUE_TOKEN`, `AUTENTIQUE_URL` and `AUTENTIQUE_DEV_MODE` to `true` for `SANDBOX MODE` or `false` to `PRODUCTION MODE`.
+
 ```bash
 composer test
+composer test -- --filter ApiTest
 ```
 

composer.json

@@ -10,8 +10,10 @@
     ],
     "scripts": {
         "test": "XDEBUG_MODE=coverage vendor/bin/phpunit tests --coverage-text",
+        "test-filter": "XDEBUG_CONFIG=\"idekey=VSCODE\" vendor/bin/phpunit --filter",
         "test-coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --coverage-html coverage/",
-        "load": "composer dumpautoload"
+        "load": "composer dumpautoload",
+        "phpdoc": "php phpDocumentor.phar run -d ./src -t phpdoc --setting=graphs.enabled=true"
     },
     "homepage": "https://github.com/vinicinbgs/autentique-v2",
     "license": "MIT",
@@ -29,7 +31,8 @@
     },
     "require-dev": {
         "phpunit/phpunit": "^9.5",
-        "vlucas/phpdotenv": "^5.4.1"
+        "vlucas/phpdotenv": "^5.4.1",
+        "mockery/mockery": "2.0.x-dev"
     },
     "autoload": {
         "classmap": [