Merge pull request #2 from hmerritt/v1.0.0

Major rewrite of entire API

Author: hmerritt

composer.json

@@ -1,7 +1,7 @@
 {
     "name": "hmerritt/imdb-api",
     "description": "IMDB API that can fetch film data and search results",
-    "keywords": ["imdb", "api", "films", "search"],
+    "keywords": ["imdb", "api", "film", "movie", "search"],
     "license": "Apache-2.0",
     "authors": [
         {
@@ -16,11 +16,11 @@
         "tmarois/filebase": "^1.0"
     },
     "require-dev": {
-		    "phpunit/phpunit": "6.*"
+        "phpunit/phpunit": "9.0"
     },
     "autoload": {
         "psr-4": {
-            "hmerritt\\Imdb\\": "src/"
+            "hmerritt\\": "src/"
         }
     }
 }

phpunit.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+|--------------------------------------------------------------------------
+| Register The Composer Auto Loader
+|--------------------------------------------------------------------------
+|
+| Composer provides a convenient, automatically generated class loader
+| for our application. We just need to utilize it! We'll require it
+| into the script here so that we do not have to worry about the
+| loading of any our classes "manually". Feels great to relax.
+|
+*/
+
+require __DIR__.'/vendor/autoload.php';
+
+/*
+|--------------------------------------------------------------------------
+| Set The Default Timezone
+|--------------------------------------------------------------------------
+|
+| Here we will set the default timezone for PHP. PHP is notoriously mean
+| if the timezone is not explicitly set. This will be used by each of
+| the PHP date and date-time functions throughout the application.
+|
+*/
+
+date_default_timezone_set('UTC');

phpunit.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<phpunit backupGlobals="false"
+	backupStaticAttributes="false"
+	bootstrap="phpunit.php"
+	colors="true"
+	convertErrorsToExceptions="true"
+	convertNoticesToExceptions="true"
+	convertWarningsToExceptions="true"
+	processIsolation="false"
+	stopOnFailure="false"
+>
+	<testsuites>
+		<testsuite name="Repository Test Suite">
+			<directory>./tests/</directory>
+		</testsuite>
+	</testsuites>
+
+	<filter>
+		<whitelist addUncoveredFilesFromWhitelist="false">
+			<directory suffix=".php">src</directory>
+			<exclude>
+				<directory suffix=".php">vendor</directory>
+			</exclude>
+		</whitelist>
+	</filter>
+</phpunit>

src/Cache.php

@@ -0,0 +1,90 @@
+<?php
+namespace hmerritt;
+
+/**
+*  Class Cache
+*
+*
+* @package hmerritt/imdb-api
+* @author Harry Merritt
+*/
+class Cache
+{
+
+    function __construct()
+    {
+        /**
+         * Initiate cache database
+         *
+         * @var \Filebase\Database
+         */
+        $this->cache = new \Filebase\Database([
+            'dir'            => __DIR__ . DIRECTORY_SEPARATOR . 'cache/films/',
+            'backupLocation' => __DIR__ . DIRECTORY_SEPARATOR . 'cache/films/backups/',
+            'format'         => \Filebase\Format\Json::class,
+            'cache'          => true,
+            'cache_expires'  => 31540000,
+            'pretty'         => false
+        ]);
+    }
+
+    /**
+     * Add (or modify) an item in the cache
+     *
+     * @param string $key
+     * @param string $value
+     * @return bool
+     */
+    public function add(string $key, $value)
+    {
+        $file = $this->get($key);
+        $file->film = $value;
+        $file->save();
+        return true;
+    }
+
+    /**
+     * Counts all files in the cache
+     *
+     * @return int
+     */
+    public function count(): int
+    {
+        return $this->cache->count();
+    }
+
+    /**
+     * Deletes an item from the cache
+     *
+     * @return bool
+     */
+    public function delete(string $key): bool
+    {
+        $file = $this->get($key);
+        $file->delete();
+        return true;
+    }
+
+    /**
+     * Get an item from the cache
+     *
+     * @param string $key
+     * @return object
+     */
+    public function get(string $key): object
+    {
+        return $this->cache->get($key);
+    }
+
+    /**
+     * Check if an item exists in the cache
+     *
+     * @param string $key
+     * @return bool
+     */
+    public function has(string $key): bool
+    {
+        return $this->cache->has($key);
+    }
+
+}

src/Dom.php

@@ -0,0 +1,61 @@
+<?php
+namespace hmerritt;
+
+/**
+*  Class Dom
+*
+*
+* @package hmerritt/imdb-api
+* @author Harry Merritt
+*/
+class Dom
+{
+
+    /**
+     * Fetch and parse the DOM of a remote site
+     *
+     * @param string $url
+     *
+     * @return \PHPHtmlParser\Dom
+     */
+    public function fetch(string $url, array $options)
+    {
+        $dom = new \PHPHtmlParser\Dom;
+        $dom->loadFromUrl($url, [
+            "curlHeaders" => $options["curlHeaders"]
+        ]);
+        return $dom;
+    }
+
+    /**
+     * Find object within DOM (if it exists) and reutrn an attribute
+     *
+     * @param object $dom
+     * @param string $selection
+     *
+     * @return array|object
+     */
+    public function find(object $dom, string $selection)
+    {
+        $found = $dom->find($selection);
+        if (count($found) > 0) {
+            return $found;
+        }
+        else {
+            return $this->emptyElement();
+        }
+    }
+
+    /**
+     * Create and parse an empty html string as a DOM element
+     *
+     * @return \PHPHtmlParser\Dom
+     */
+    private function emptyElement()
+    {
+        $dom = new \PHPHtmlParser\Dom;
+        $dom->load('<a emptyElement="true" src="" href="" data-video=""></a>');
+        return $dom;
+    }
+
+}