Initial commit

Author: philwc

.gitignore

@@ -0,0 +1,4 @@
+vendor
+.phplint-cache
+.phpunit.result.cache
+.idea

.idea/vcs.xml

@@ -0,0 +1,12 @@
+language: php
+
+php:
+  - 7.1
+  - 7.2
+
+before_script:
+  - composer self-update
+  - composer install
+
+script:
+  - composer run-script check

.travis.yml

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Phil Wright- Christie
+
+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.

LICENCE.md

@@ -0,0 +1,96 @@
+# Dark Sky API Client
+
+This is a simple client to talk to the Dark Sky API.
+
+To get started, you will need to get a secret key from Dark Sky: https://darksky.net/dev/account.
+
+This package makes use of HTTP adapters to connect to the API. Two are included out of the box,
+a Guzzle adapter and a Simple adapter (using `file_get_contents`). If you have specialised
+connection needs, simply implement the `ClientAdapterInterface` and pass to the client factory.
+
+This package is also able to make use of a PSR-16 caching adapter to cache calls from the API.
+Simply pass a relevant cache service (see https://packagist.org/providers/psr/simple-cache-implementation) 
+to the client factory to use. No caching is provided out of the box.
+
+Finally, this is able to make use of a PSR-3 logger. Set your logger using `ClientFactory::setLogger($log);`.
+
+This is all shown in the Advanced Usage below.
+
+## Usage
+
+Install the package using composer:
+
+```bash
+composer require philwc/dark-sky
+```
+
+### Simple Usage
+```php
+require_once __DIR__ . '/vendor/autoload.php';
+
+$client = philwc\DarkSky\ClientFactory::get(
+    philwc\DarkSky\ClientFactory::FORECAST, 
+    getenv('SECRET_KEY')
+);
+
+$weather = $client->simpleRetrieve(53.4808, 2.2426);
+
+echo $weather->getCurrently()->getSummary() . PHP_EOL;
+echo $weather->getCurrently()->getIcon()->toString() . PHP_EOL;
+```
+
+### Advanced Usage
+```php
+require_once __DIR__ . '/vendor/autoload.php';
+
+$log = new Monolog\Logger('test');
+$log->pushHandler(new Monolog\Handler\ErrorLogHandler());
+
+philwc\DarkSky\ClientFactory::setLogger($log);
+
+$client = philwc\DarkSky\ClientFactory::get(
+    philwc\DarkSky\ClientFactory::FORECAST, 
+    getenv('SECRET_KEY'), 
+    new Cache\Adapter\PHPArray\ArrayCachePool(), 
+    new philwc\DarkSky\ClientAdapter\SimpleAdapter()
+);
+
+$weather = $client->simpleRetrieve(53.4808, 2.2426);
+
+echo $weather->getCurrently()->getSummary() . PHP_EOL;
+echo $weather->getCurrently()->getIcon()->toString() . PHP_EOL;
+
+// This second call will now be retrieved from the cache
+$weather = $client->simpleRetrieve(53.4808, 2.2426);
+
+echo $weather->getCurrently()->getSummary() . PHP_EOL;
+echo $weather->getCurrently()->getIcon()->toString() . PHP_EOL;
+```
+
+In addition to using the `simpleRetrieve` method on the client, 
+you can use the `retrieve` method. This requires strict typing to validate 
+your values. Internally, `simpleRetrieve` uses `retrieve`.
+
+```php
+...
+$weather = $client->retrieve(new Latitude(53.4808), new Longitude(2.2426));
+
+echo $weather->getCurrently()->getSummary() . PHP_EOL;
+echo $weather->getCurrently()->getIcon()->toString() . PHP_EOL;
+``` 
+
+Finally, to use the `TimeMachineClient` set the appropriate option on the `ClientFactory`
+
+```php
+$client = philwc\DarkSky\ClientFactory::get(
+    philwc\DarkSky\ClientFactory::TIME_MACHINE, 
+    getenv('SECRET_KEY')
+);
+```
+
+The calls to `retrieve` and `simpleRetrieve` now require a timestamp:
+
+```php
+$weather = $client->simpleRetrieve(53.4808, 2.2426, 1514764800);
+$weather = $client->retrieve(new Latitude(53.4808), new Longitude(2.2426), new DateTimeImmutable('2018-01-01 00:00:00'));
+```

README.md

@@ -0,0 +1,48 @@
+{
+  "name": "philwc/dark-sky",
+  "description": "A simple client to talk to the Dark Sky API.",
+  "license": "MIT",
+  "type": "library",
+  "require": {
+    "php": ">=7.1",
+    "ext-json": "*",
+    "php-ds/php-ds": "^1.2",
+    "beberlei/assert": "^3.0",
+    "guzzlehttp/psr7": "^1.4",
+    "psr/simple-cache": "^1.0",
+    "psr/log": "^1.0"
+  },
+  "suggest": {
+    "guzzlehttp/guzzle": "Allows for better handling of http connections",
+    "psr/simple-cache-implementation": "Allows for caching results"
+  },
+  "require-dev": {
+    "phpunit/phpunit": "^7.3",
+    "squizlabs/php_codesniffer": "^3.3",
+    "guzzlehttp/guzzle": "^6.3",
+    "cache/array-adapter": "^1.0",
+    "monolog/monolog": "^1.23",
+    "overtrue/phplint": "^1.0"
+  },
+  "authors": [
+    {
+      "name": "Phil Wright- Christie",
+      "email": "[email protected]"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "philwc\\DarkSky\\": "src/"
+    }
+  },
+  "scripts": {
+    "test": "phpunit",
+    "cs": "phpcs",
+    "lint": "phplint ./ --exclude=vendor --extensions=php,tpl",
+    "check": [
+      "@lint",
+      "@cs",
+      "@test"
+    ]
+  }
+}