2.0.0

.docker/php/Dockerfile

@@ -0,0 +1,23 @@
+ARG PHP_IMAGE="php:8.3"
+FROM $PHP_IMAGE
+ARG PHP_IMAGE
+
+RUN apt-get update
+
+RUN apt autoremove -y
+RUN apt-get install libicu-dev zip -y --no-install-recommends
+RUN apt-get install libmcrypt-dev -y --no-install-recommends
+RUN apt-get install git unzip -y
+RUN docker-php-ext-install mysqli pdo_mysql bcmath
+
+COPY --from=composer:latest /usr/bin/composer /usr/bin/composer
+
+RUN apt-get install zlib1g-dev libzip-dev -y --no-install-recommends
+RUN docker-php-ext-install zip
+
+RUN pecl install xdebug
+RUN docker-php-ext-enable xdebug
+
+ENV XDEBUG_MODE=coverage
+
+RUN rm -rf /var/lib/apt/lists/*

.github/workflows/.github-actions.yml

@@ -0,0 +1,80 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - master
+      - dev
+    tags:
+      - 1.*
+      - 2.*
+  pull_request:
+    branches: [ master ]
+
+  workflow_dispatch:
+
+jobs:
+  phpcs:
+    strategy:
+      matrix:
+        version: ['8.1', '8.2', '8.3']
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup PHP with composer v2
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.version }}
+          tools: composer:v2
+
+      - name: Install composer packages
+        run: |
+          php -v
+          composer install --prefer-dist --no-ansi --no-interaction --no-progress --no-scripts
+
+      - name: Execute PHP_CodeSniffer
+        run: |
+          php -v
+          composer phpcs
+
+  phpunit:
+    strategy:
+      matrix:
+        version: ['8.1', '8.2', '8.3']
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.version }}
+          extensions: dom, curl, libxml, mbstring, zip, pcntl, pdo, sqlite, pdo_sqlite, mysql, mysqli, pdo_mysql, bcmath, intl, exif, iconv
+          coverage: xdebug
+
+      - name: Install composer packages
+        run: |
+          php -v
+          composer install --prefer-dist --no-ansi --no-interaction --no-progress --no-scripts
+
+      - name: Execute tests
+        run: |
+          php -v
+          ./vendor/phpunit/phpunit/phpunit --version
+          ./vendor/phpunit/phpunit/phpunit --coverage-clover=coverage.xml
+          export CODECOV_TOKEN=${{ secrets.CODECOV_TOKEN }}
+          bash <(curl -s https://codecov.io/bash) || echo 'Codecov failed to upload'
+
+      - name: Upload code coverage
+        run: |
+          export CODECOV_TOKEN=${{ secrets.CODECOV_TOKEN }}
+          bash <(curl -s https://codecov.io/bash) || echo 'Codecov failed to upload'

.gitignore

@@ -20,4 +20,6 @@ bootstrap/cache/
 !.vscode/settings.json
 !.vscode/tasks.json
 !.vscode/launch.json
-!.vscode/extensions.json
+!.vscode/extensions.json
+
+composer.lock

.gitlab-ci.yml

@@ -0,0 +1,130 @@
+stages:
+  - docker
+  - build
+  - lint
+  - test
+
+# ========= Anchors (Partials) =========
+.php_base: &php_base
+  image: $CI_REGISTRY_IMAGE/php:8.3
+  tags:
+    - docker
+
+.test_base: &test_base
+  stage: test
+  before_script:
+    - rm -rf vendor
+    - php -d memory_limit=-1 /usr/bin/composer require --dev phpunit/phpunit:^$PHPUNIT_VERSION
+    - php -d memory_limit=-1 /usr/bin/composer install
+  script:
+    - composer du
+    - composer test:coverage
+  artifacts:
+    when: on_failure
+    expire_in: 4 hours
+    paths:
+      - storage/logs/
+    reports:
+      junit: coverage/phpunit.junit.xml
+      coverage_report:
+        coverage_format: cobertura
+        path: coverage/cobertura.xml
+  coverage: /^\s*Lines:\s*\d+.\d+\%/
+  tags:
+    - docker
+
+.docker_base: &docker_base
+  stage: docker
+  image: docker:20.10.8-alpine3.14
+  services:
+    - docker:20.10.8-dind-alpine3.14
+  before_script:
+    - docker login -u $CI_REGISTRY_USER -p $CI_REGISTRY_PASSWORD $CI_REGISTRY
+  script:
+    - docker pull $CONTAINER_IMAGE:$PHP_VERSION || true
+    - docker build --cache-from $CONTAINER_IMAGE:$PHP_VERSION --build-arg PHP_IMAGE=php:$PHP_VERSION -t $CONTAINER_IMAGE:$PHP_VERSION ./.docker/$SERVICE_NAME
+    - docker push $CONTAINER_IMAGE:$PHP_VERSION
+  when: manual
+  tags:
+    - docker
+
+.docker_variables: &docker_variables
+  CONTAINER_IMAGE: $CI_REGISTRY_IMAGE/$SERVICE_NAME
+  DOCKER_DRIVER: devicemapper
+  DOCKER_TLS_CERTDIR: ''
+  GIT_STRATEGY: fetch
+  GIT_DEPTH: "1"
+
+# ======================
+# Docker jobs
+# ======================
+docker:php81:
+  <<: *docker_base
+  variables:
+    SERVICE_NAME: php
+    PHP_VERSION: "8.1"
+    <<: *docker_variables
+
+docker:php82:
+  <<: *docker_base
+  variables:
+    SERVICE_NAME: php
+    PHP_VERSION: "8.2"
+    <<: *docker_variables
+
+docker:php83:
+  <<: *docker_base
+  variables:
+    SERVICE_NAME: php
+    PHP_VERSION: "8.3"
+    <<: *docker_variables
+
+# ======================
+# Build jobs
+# ======================
+build:php:
+  <<: *php_base
+  stage: build
+  script:
+    - composer install
+  artifacts:
+    paths:
+      - vendor/
+    expire_in: 2 hours
+  cache:
+    paths:
+      - vendor
+    key: php
+
+# ======================
+# Lint jobs
+# ======================
+lint:php:
+  <<: *php_base
+  stage: lint
+  script:
+    - composer phpcs
+  dependencies:
+    - build:php
+  allow_failure: true
+
+# ======================
+# Test jobs
+# ======================
+test:php81:
+  <<: *test_base
+  image: $CI_REGISTRY_IMAGE/php:8.1
+  variables:
+    PHPUNIT_VERSION: "9.5"
+
+test:php82:
+  <<: *test_base
+  image: $CI_REGISTRY_IMAGE/php:8.2
+  variables:
+    PHPUNIT_VERSION: "9.5"
+
+test:php83:
+  <<: *test_base
+  image: $CI_REGISTRY_IMAGE/php:8.3
+  variables:
+    PHPUNIT_VERSION: "9.5"

CHANGELOG.md

@@ -15,3 +15,19 @@ This project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html
 
 ## [1.0.2] - 14-02-2022
 - Laravel 9 Support
+
+## [1.0.3] - 06-03-2023
+- Laravel 10 Support
+
+## [2.0.0] - 22-02-2024
+### Added
+- Autocomplete and get endpoint support.
+- Complete test coverage.
+
+### Changed
+- Refactored codebase, make use of `Http` facade to assist testing.
+- Moved core HTTP logic into `Laralabs\GetAddress\Http\Client` which provides `get()` and `post()`. Can be used if wanting to experiment with new endpoints or endpoints not supported by the package. 
+
+### Removed
+- Unused classes.
+

README.md

@@ -1,9 +1,7 @@
 <p align="center">
 <a href="https://packagist.org/packages/laralabs/get-address-io"><img src="https://poser.pugx.org/laralabs/get-address-io/version" alt="Stable Build" /></a>
-<a href="https://travis-ci.org/Laralabs/get-address-io"><img src="https://travis-ci.org/Laralabs/get-address-io.svg?branch=master" alt="Build Status"></a>
-<a href="https://styleci.io/repos/195806527"><img src="https://styleci.io/repos/195806527/shield?branch=master" alt="StyleCI"></a>
-<a href="https://codeclimate.com/github/Laralabs/get-address-io/maintainability"><img src="https://api.codeclimate.com/v1/badges/744992b1495722bd6839/maintainability" /></a>
-<a href="https://codeclimate.com/github/Laralabs/get-address-io/test_coverage"><img src="https://api.codeclimate.com/v1/badges/744992b1495722bd6839/test_coverage" /></a>
+<a href="https://github.com/Laralabs/get-address-io/actions"><img src="https://github.com/clnt/scrubber/actions/workflows/.github-actions.yml/badge.svg" alt="CI Status" /></a>
+<a href="https://codecov.io/gh/Laralabs/get-address-io"><img src="https://codecov.io/gh/Laralabs/get-address-io/branch/master/graph/badge.svg?token=S2VO0QHCP8"/></a>
 </p>
 
 # Laravel getAddress.io Package
@@ -35,22 +33,33 @@ php artisan migrate
 ### Usage
 A helper function and facade is available, choose your preferred method.
 
-Perform a lookup:
+The facade is located at `Laralabs\GetAddress\Facades\GetAddress`
+
+The endpoints currently supported are (support for other endpoints coming soon):
+- find
+- autocomplete
+- get
+
+Perform a lookup using the `find` endpoint:
 ```php
 $results = get_address()->find($postcode, $property);
 ```
 
-Perform an expanded lookup:
+The `$property` argument is optional, just searching for a postcode will return all results for that postcode and also cache the data if the cache has been enabled.
+
+Perform a looking using the `autocomplete` endpoint:
 ```php
-$results = get_address()->expand()->find($postcode, $property);
+$results = get_address()->autocomplete($searchTerm, ['top' => '20']);
 ```
 
-The `$property` argument is optional, just searching for a postcode will return all results for that postcode and also cache the data if the cache has been enabled.
+The second argument supports an array of parameters to send with the POST request, the example above shows setting the returned results to the maximum allowed of 20.
 
-## :pushpin: Todo
+Perform a lookup using the `get` endpoint:
+```php
+$results = get_address()->get($addressId);
+```
 
-- Admin Features.
-- Unit Tests.
+This is used with the `autocomplete` endpoint to return the full address information, the `$addressId` argument must be the ID returned from the autocomplete response.
 
 ## :speech_balloon: Support