Skip to content

Commit 04170f1

Browse files
l4nosl4nos
committed
Version 1 General Release
0 parents  commit 04170f1

28 files changed

+3928
-0
lines changed

‎.github/workflows/tests.yml‎

Lines changed: 92 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,92 @@
1+
name: Tests
2+
3+
on:
4+
push:
5+
branches: [main, master]
6+
pull_request:
7+
branches: [main, master]
8+
9+
jobs:
10+
test:
11+
runs-on: ${{ matrix.os }}
12+
strategy:
13+
fail-fast: true
14+
matrix:
15+
os: [ubuntu-latest]
16+
php: [8.1, 8.2, 8.3]
17+
laravel: [10.*, 11.*]
18+
stability: [prefer-lowest, prefer-stable]
19+
include:
20+
- laravel: 10.*
21+
testbench: 8.*
22+
- laravel: 11.*
23+
testbench: 9.*
24+
25+
name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
26+
27+
steps:
28+
- name: Checkout code
29+
uses: actions/checkout@v4
30+
31+
- name: Setup PHP
32+
uses: shivammathur/setup-php@v2
33+
with:
34+
php-version: ${{ matrix.php }}
35+
extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
36+
coverage: none
37+
38+
- name: Setup problem matchers
39+
run: |
40+
echo "::add-matcher::${{ runner.tool_cache }}/php.json"
41+
echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
42+
43+
- name: Install dependencies
44+
run: |
45+
composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" --no-interaction --no-update
46+
composer update --${{ matrix.stability }} --prefer-dist --no-interaction
47+
48+
- name: List Installed Dependencies
49+
run: composer show -D
50+
51+
- name: Execute tests
52+
run: vendor/bin/pest --ci
53+
54+
static-analysis:
55+
name: Static Analysis
56+
runs-on: ubuntu-latest
57+
steps:
58+
- name: Checkout code
59+
uses: actions/checkout@v4
60+
61+
- name: Setup PHP
62+
uses: shivammathur/setup-php@v2
63+
with:
64+
php-version: '8.3'
65+
extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
66+
coverage: none
67+
68+
- name: Install dependencies
69+
run: composer update --prefer-stable --prefer-dist --no-interaction
70+
71+
- name: Run PHPStan
72+
run: ./vendor/bin/phpstan analyse
73+
74+
code-style:
75+
name: Code Style
76+
runs-on: ubuntu-latest
77+
steps:
78+
- name: Checkout code
79+
uses: actions/checkout@v4
80+
81+
- name: Setup PHP
82+
uses: shivammathur/setup-php@v2
83+
with:
84+
php-version: '8.3'
85+
extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, bcmath, soap, intl, gd, exif, iconv, imagick, fileinfo
86+
coverage: none
87+
88+
- name: Install dependencies
89+
run: composer update --prefer-stable --prefer-dist --no-interaction
90+
91+
- name: Run Laravel Pint
92+
run: ./vendor/bin/pint --test

‎.gitignore‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# Composer
2+
/vendor/
3+
composer.lock
4+
5+
# IDE
6+
.idea/
7+
.vscode/
8+
*.swp
9+
*.swo
10+
*~
11+
.DS_Store
12+
13+
# Testing
14+
.phpunit.result.cache
15+
.phpunit.cache/
16+
coverage/
17+
phpunit.xml.bak
18+
.env.testing
19+
20+
# Build artifacts
21+
build/
22+
dist/
23+
*.log
24+
25+
# Laravel specific
26+
.env
27+
.env.backup
28+
.env.production
29+
30+
# PHP CS Fixer
31+
.php-cs-fixer.cache
32+
.php_cs.cache
33+
34+
# PHPStan
35+
phpstan.neon.dist
36+
37+
# Node
38+
node_modules/
39+
npm-debug.log
40+
yarn-error.log
41+
42+
# Documentation
43+
docs/_build/

‎LICENSE.md‎

Lines changed: 107 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
# The MIT License (MIT)
2+
3+
Copyright (c) 2024 L4nos <[email protected]>
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in
13+
all copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21+
THE SOFTWARE.
22+
23+
## Additional Terms and Disclaimers
24+
25+
### Third-Party API Integration
26+
27+
This software package ("Laravel Property Data") is designed solely as an integration library for the PropertyData API service (https://propertydata.co.uk). The authors and contributors of this package:
28+
29+
1. **DO NOT** own, operate, or control the PropertyData API
30+
2. **DO NOT** claim any ownership rights over the PropertyData API or its data
31+
3. **ARE NOT** affiliated with, endorsed by, or partners with PropertyData or its parent company
32+
4. **ARE NOT** responsible for the PropertyData API's availability, functionality, or terms of service
33+
34+
### Data Accuracy and Liability Disclaimer
35+
36+
**IMPORTANT**: The authors and contributors of this package expressly disclaim any and all liability for:
37+
38+
1. **Data Accuracy**: The accuracy, completeness, timeliness, or reliability of any data retrieved through the PropertyData API
39+
2. **Data Defects**: Any errors, omissions, inaccuracies, or defects in the data provided by the PropertyData API
40+
3. **Financial Decisions**: Any financial, investment, or business decisions made based on data obtained through this package
41+
4. **Property Valuations**: The accuracy of property valuations, market assessments, or any financial calculations provided by the API
42+
5. **Legal Compliance**: Ensuring that your use of the data complies with applicable laws and regulations
43+
6. **API Changes**: Any changes to the PropertyData API that may affect the functionality of this package
44+
7. **Service Interruptions**: Any loss or damage resulting from PropertyData API downtime or service interruptions
45+
46+
### Limitation of Liability
47+
48+
IN NO EVENT SHALL THE AUTHORS, COPYRIGHT HOLDERS, OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; BUSINESS INTERRUPTION; LOSS OF PROPERTY VALUE; INCORRECT PROPERTY VALUATIONS; OR FAILED PROPERTY TRANSACTIONS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE OR THE DATA IT RETRIEVES, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
49+
50+
### Indemnification
51+
52+
By using this software, you agree to indemnify, defend, and hold harmless the authors, copyright holders, and contributors from and against any and all claims, liabilities, damages, losses, costs, expenses, or fees (including reasonable attorneys' fees) arising from:
53+
54+
1. Your use of this software
55+
2. Your use of data obtained through the PropertyData API
56+
3. Any decisions or actions taken based on such data
57+
4. Your violation of any applicable laws or regulations
58+
5. Your violation of PropertyData's terms of service
59+
60+
### User Responsibilities
61+
62+
Users of this package are solely responsible for:
63+
64+
1. **API Credentials**: Obtaining and maintaining valid API credentials from PropertyData
65+
2. **Terms Compliance**: Complying with PropertyData's terms of service, privacy policy, and usage limitations
66+
3. **Data Usage**: Ensuring lawful and appropriate use of all data obtained through the API
67+
4. **Due Diligence**: Independently verifying any critical data before making important decisions
68+
5. **Legal Compliance**: Complying with all applicable laws regarding data protection, privacy, and property information
69+
70+
### No Professional Advice
71+
72+
This software and any data retrieved through it DO NOT constitute:
73+
74+
1. Professional property valuation services
75+
2. Legal advice
76+
3. Financial or investment advice
77+
4. Surveying services
78+
5. Real estate agency services
79+
80+
Always consult qualified professionals for property valuations, legal matters, and investment decisions.
81+
82+
### Modifications and Updates
83+
84+
The authors reserve the right to modify this software but assume no obligation to:
85+
86+
1. Maintain compatibility with future versions of the PropertyData API
87+
2. Provide updates or bug fixes
88+
3. Provide support or documentation
89+
4. Ensure continued functionality
90+
91+
### Severability
92+
93+
If any provision of this license is held to be unenforceable or invalid, such provision shall be struck and the remaining provisions shall be enforced to the fullest extent under law.
94+
95+
### Governing Law
96+
97+
This license shall be governed by and construed in accordance with the laws of the jurisdiction in which the copyright holder resides, without regard to its conflict of law provisions.
98+
99+
### Acceptance
100+
101+
By using this software, you acknowledge that you have read, understood, and agree to be bound by these terms and disclaimers.
102+
103+
---
104+
105+
**For PropertyData API support and documentation, visit: https://propertydata.co.uk**
106+
107+
**This is an independent package and is not affiliated with PropertyData.**

0 commit comments

Comments
 (0)