Preparing 1.1.0 release

ericsizemore · Dec 28, 2023 · 51b57c6 · 51b57c6
1 parent c2b789e
commit 51b57c6
Show file tree

Hide file tree

Showing 16 changed files with 2,265 additions and 73 deletions.
diff --git a/.gitattributes b/.gitattributes
@@ -0,0 +1,13 @@
+# Set the default behavior, in case people don't have core.autocrlf set.
+* text eol=lf
+
+# Ignore all test and documentation with "export-ignore".
+/.github            export-ignore
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore
+/composer.lock      export-ignore
+/mkdocs.yml         export-ignore
+/phpstan.neon       export-ignore
+/phpunit.xml        export-ignore
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,10 +2,21 @@
 A not so exhaustive list of changes for each release.
 
 For a more detailed listing of changes between each version, 
-you can use the following url: https://github.com/ericsizemore/librariesio/compare/v1.0.0...v1.0.1. 
+you can use the following url: https://github.com/ericsizemore/librariesio/compare/v1.0.0...v1.1.0. 
 
 Simply replace the version numbers depending on which set of changes you wish to see.
 
+### 1.1.0 (2023-12-29)
+
+  * Added `subscription()` to handle adding, updating, checking and removing a subscription to a project.
+  * Updated `makeRequest()` with a `$method` parameter to handle post, put, and delete requests in addition to get.
+  * Visibility changed to `protected` for:
+    * endpointParameters()
+    * processEndpointFormat()
+    * verifyEndpointOptions()
+  * Converted line endings to linux, some files snuck through with Windows line endings
+  * Documentation updated
+
 ### 1.0.0 (2023-12-25)
 
   * Initial release
diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md
@@ -1,4 +1,3 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

diff --git a/README.md b/README.md
@@ -16,7 +16,6 @@
 This project was born from the desire to expand my knowledge of API's and GuzzleHttp. My implementation is far from perfect, so I am open to any and all feedback that one may wish to provide.
 
 * The Libraries.io API has the ability for pagination, however it is not yet fully implemented in this library.
-* The `subscriptions` endpoint (adding, updating, or deleting subscriptions) is not yet implemented.
 
 ## Installation
 
@@ -72,6 +71,13 @@ LibrariesIO splits the different endpoints based on their "component":
         * repository_contributions
         * subscriptions
         * user
+  * Esi\LibrariesIO\LibrariesIO::subscription()
+    * takes an 'endpoint' parameter to specify which subset you are looking for.
+      * Current endpoints are:
+        * subscribe
+        * check
+        * update
+        * unsubscribe
 
 Each 'subset' has their own required options. Check the documentation (currently WIP) for more information.
 
@@ -123,7 +129,7 @@ No actual calls are made to the libraries.io API while performing tests. Instead
 
 ## Documentation
 
-The [docs](docs/) folder or online [here](https://www.secondversion.com/docs/librariesio/).
+The `docs/` folder or online [here](https://www.secondversion.com/docs/librariesio/).
 
 ## About
 

diff --git a/SECURITY.md b/SECURITY.md
@@ -4,6 +4,7 @@
 
 | Version | Supported          |
 |---------|--------------------|
+| 1.1.x   | :white_check_mark: |
 | 1.0.x   | :white_check_mark: |
 
 ## Reporting a Vulnerability

diff --git a/composer.json b/composer.json
@@ -1,8 +1,8 @@
 {
     "name": "esi/librariesio",
     "description": "LibrariesIO - A simple API wrapper/client for the Libraries.io API.",
-    "type": "library",
     "license": "MIT",
+    "type": "library",
     "keywords": [
         "api",
         "api-client",
@@ -18,40 +18,42 @@
             "homepage": "https://www.secondversion.com/"
         }
     ],
+    "support": {
+        "issues": "https://github.com/ericsizemore/librariesio/issues",
+        "forum": "https://github.com/ericsizemore/librariesio/discussions",
+        "source": "https://github.com/ericsizemore/librariesio/tree/master",
+        "security": "https://github.com/ericsizemore/librariesio/security/policy"
+    },
     "require": {
         "php": "^8.2 <8.5",
         "guzzlehttp/guzzle": "^7.0 <8.0",
         "kevinrob/guzzle-cache-middleware": "^5.1 <6.0",
         "symfony/cache": "^7.0"
     },
     "require-dev": {
-        "phpstan/phpstan": "^1.11",
+        "phpstan/phpstan": "^1.11 <2.0",
+        "phpstan/phpstan-phpunit": "^1.4",
         "phpstan/phpstan-strict-rules": "^1.6",
-        "phpunit/phpunit": "^10.5",
-        "phpstan/phpstan-phpunit": "^1.4"
+        "phpunit/phpunit": "^10.5"
     },
+    "minimum-stability": "dev",
     "autoload": {
-        "psr-4": { "Esi\\LibrariesIO\\": "src/" }
+        "psr-4": {
+            "Esi\\LibrariesIO\\": "src/"
+        }
     },
     "autoload-dev": {
         "psr-4": {
             "Esi\\LibrariesIO\\Tests\\": "tests/src/"
         }
     },
-	"support": {
-		"issues": "https://github.com/ericsizemore/librariesio/issues",
-		"forum": "https://github.com/ericsizemore/librariesio/discussions",
-		"source": "https://github.com/ericsizemore/librariesio/tree/master",
-		"security": "https://github.com/ericsizemore/librariesio/security/policy"
-	},
-    "scripts": {
-        "test": "vendor/bin/phpunit --coverage-clover=build/logs/clover.xml --coverage-html=build/logs/coverage --display-deprecations --display-warnings --globals-backup",
-        "phpstan": "vendor/bin/phpstan analyse -c phpstan.neon"
-    },
-    "minimum-stability": "dev",
     "extra": {
         "branch-alias": {
             "dev-master": "1.0-dev"
         }
+    },
+    "scripts": {
+        "phpstan": "vendor/bin/phpstan analyse -c phpstan.neon",
+        "test": "vendor/bin/phpunit --coverage-clover=build/logs/clover.xml --coverage-html=build/logs/coverage --display-deprecations --display-warnings --globals-backup"
     }
 }
diff --git a/composer.lock b/composer.lock
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -2,10 +2,21 @@
 A not so exhaustive list of changes for each release.
 
 For a more detailed listing of changes between each version, 
-you can use the following url: https://github.com/ericsizemore/librariesio/compare/v1.0.0...v1.0.1. 
+you can use the following url: https://github.com/ericsizemore/librariesio/compare/v1.0.0...v1.1.0. 
 
 Simply replace the version numbers depending on which set of changes you wish to see.
 
+### 1.1.0 (2023-12-29)
+
+  * Added `subscription()` to handle adding, updating, checking and removing a subscription to a project.
+  * Updated `makeRequest()` with a `$method` parameter to handle post, put, and delete requests in addition to get.
+  * Visibility changed to `protected` for:
+    * endpointParameters()
+    * processEndpointFormat()
+    * verifyEndpointOptions()
+  * Converted line endings to linux, some files snuck through with Windows line endings
+  * Documentation updated
+
 ### 1.0.0 (2023-12-25)
 
   * Initial release
diff --git a/docs/code-of-conduct.md b/docs/code-of-conduct.md
@@ -1,4 +1,3 @@
-
 # Contributor Covenant Code of Conduct
 
 ## Our Pledge

diff --git a/docs/index.md b/docs/index.md
@@ -16,7 +16,6 @@
 This project was born from the desire to expand my knowledge of API's and GuzzleHttp. My implementation is far from perfect, so I am open to any and all feedback that one may wish to provide.
 
 * The Libraries.io API has the ability for pagination, however it is not yet fully implemented in this library.
-* The `subscriptions` endpoint (adding, updating, or deleting subscriptions) is not yet implemented.
 
 ## Installation
 
@@ -72,6 +71,13 @@ LibrariesIO splits the different endpoints based on their "component":
         * repository_contributions
         * subscriptions
         * user
+  * Esi\LibrariesIO\LibrariesIO::subscription()
+    * takes an 'endpoint' parameter to specify which subset you are looking for.
+      * Current endpoints are:
+        * subscribe
+        * check
+        * update
+        * unsubscribe
 
 Each 'subset' has their own required options. Check the documentation (currently WIP) for more information.
 

diff --git a/docs/security.md b/docs/security.md
@@ -4,6 +4,7 @@
 
 | Version | Supported          |
 |---------|--------------------|
+| 1.1.x   | :white_check_mark: |
 | 1.0.x   | :white_check_mark: |
 
 ## Reporting a Vulnerability