ci(security-enhancement): add MIT license and setup dependency review (…

…#22)
apimatic · Feb 16, 2023 · d352600 · d352600
1 parent 2dcd333
commit d352600
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 41 deletions.
diff --git a/.github/workflows/dependency-review.yml b/.github/workflows/dependency-review.yml
@@ -0,0 +1,20 @@
+# Dependency Review Action
+#
+# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
+#
+# Source repository: https://github.com/actions/dependency-review-action
+# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
+name: 'Dependency Review'
+on: [pull_request]
+
+permissions:
+  contents: read
+
+jobs:
+  dependency-review:
+    runs-on: ubuntu-latest
+    steps:
+      - name: 'Checkout Repository'
+        uses: actions/checkout@v3
+      - name: 'Dependency Review'
+        uses: actions/dependency-review-action@v2
diff --git a/LICENSE b/LICENSE
@@ -1,26 +1,21 @@
-APIMATIC REFERENCE SOURCE LICENSE
-
-This license governs the use of the accompanying software. If you use the software, you accept this license. If you do not accept the license, do not use the software.
-
-1. Definitions
-The terms "reproduce," "reproduction" and "distribution" have the same meaning here as under U.S. copyright law.
-
-"You" means the licensee of the software.
-
-"Your company" means the company you worked for when you downloaded the software.
-
-"Reference use" means the use of the software within your company as a reference, in read-only form, for the sole purposes of debugging your products, maintaining your products, or enhancing the interoperability of your products with the software, and specifically excludes the right to distribute the software outside of your company.
-
-"Licensed patents" means any Licensor patent claims which read directly on the software as distributed by the Licensor under this license.
-
-2. Grant of Rights
-(A) Copyright Grant- Subject to the terms of this license, the Licensor grants you a non-transferable, non-exclusive, worldwide, royalty-free copyright license to reproduce the software for reference use.
-
-(B) Patent Grant- Subject to the terms of this license, the Licensor grants you a non-transferable, non-exclusive, worldwide, royalty-free patent license under licensed patents for reference use.
-
-3. Limitations
-(A) No Trademark License- This license does not grant you any rights to use the Licensor's name, logo, or trademarks.
-
-(B) If you begin patent litigation against the Licensor over patents that you think may apply to the software (including a cross-claim or counterclaim in a lawsuit), your license to the software ends automatically.
-
-(C) The software is licensed "as-is." You bear the risk of using it. The Licensor gives no express warranties, guarantees or conditions. You may have additional consumer rights under your local laws which this license cannot change. To the extent permitted under your local laws, the Licensor excludes the implied warranties of merchantability, fitness for a particular purpose and non-infringement.
+MIT License
+
+Copyright (c) 2023 APIMatic Ltd
+
+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.
diff --git a/README.md b/README.md
@@ -23,18 +23,18 @@ composer require "apimatic/core"
 ```
 
 ## Request
-| Name                                                                        | Description                                                           |
-|-----------------------------------------------------------------------------|-----------------------------------------------------------------------|
-| [`AdditionalFormParams`](src/Request/Parameters/AdditionalFormParams.php)   | Used to add additional form params to a request                       |
-| [`AdditionalFormParams`](src/Request/Parameters/AdditionalHeaderParams.php) | Used to add additional header params to a request                     |
-| [`AdditionalQueryParams`](src/Request/Parameters/AdditionalQueryParams.php) | Used to add additional query params to a request                      |
-| [`BodyParam`](src/Request/Parameters/BodyParam.php)                         | Body parameter class                                                  |
-| [`FormParam`](src/Request/Parameters/FormParam.php)                         | Form parameter class                                                  |
-| [`HeaderParam`](src/Request/Parameters/HeaderParam.php)                     | Header parameter class                                                |
-| [`QueryParam`](src/Request/Parameters/QueryParam.php)                       | Query parameter class                                                 |
-| [`TemplateParam`](src/Request/Parameters/TemplateParam.php)                 | Template parameter class                                              |
-| [`RequestBuilder`](src/Request/RequestBuilder.php)                          | Used to instantiate a new Request object with the properties provided |
-| [`Request`](src/Request/Request.php)                                        | Request class for an API call                                         |
+| Name                                                                         | Description                                                           |
+|------------------------------------------------------------------------------|-----------------------------------------------------------------------|
+| [`AdditionalFormParams`](src/Request/Parameters/AdditionalFormParams.php)    | Used to add additional form params to a request                       |
+| [`AdditionalHeaderParams`](src/Request/Parameters/AdditionalHeaderParams.php)| Used to add additional header params to a request                     |
+| [`AdditionalQueryParams`](src/Request/Parameters/AdditionalQueryParams.php)  | Used to add additional query params to a request                      |
+| [`BodyParam`](src/Request/Parameters/BodyParam.php)                          | Body parameter class                                                  |
+| [`FormParam`](src/Request/Parameters/FormParam.php)                          | Form parameter class                                                  |
+| [`HeaderParam`](src/Request/Parameters/HeaderParam.php)                      | Header parameter class                                                |
+| [`QueryParam`](src/Request/Parameters/QueryParam.php)                        | Query parameter class                                                 |
+| [`TemplateParam`](src/Request/Parameters/TemplateParam.php)                  | Template parameter class                                              |
+| [`RequestBuilder`](src/Request/RequestBuilder.php)                           | Used to instantiate a new Request object with the properties provided |
+| [`Request`](src/Request/Request.php)                                         | Request class for an API call                                         |
 
 ## Response
 | Name                                                                        | Description                                                                           |
@@ -64,5 +64,5 @@ composer require "apimatic/core"
 [packagist-downloads]: https://img.shields.io/packagist/dm/apimatic/core.svg?style=flat
 [test-badge]: https://github.com/apimatic/core-lib-php/actions/workflows/test.yml/badge.svg
 [test-url]: https://github.com/apimatic/core-lib-php/actions/workflows/test.yml
-[license-badge]: https://img.shields.io/badge/licence-APIMATIC-blue
+[license-badge]: https://img.shields.io/badge/licence-MIT-blue
 [license-url]: LICENSE
diff --git a/composer.json b/composer.json
@@ -7,7 +7,7 @@
     "core",
     "CoreLib"
   ],
-  "license": "proprietary",
+  "license": "MIT",
   "type": "library",
   "homepage": "https://github.com/apimatic/core-lib-php",
   "require": {
@@ -42,4 +42,4 @@
     "lint-test": "phpcs --standard=phpcs-ruleset.xml tests/",
     "lint": ["@lint-src", "@lint-test"]
   }
-}
+}