Refactorz

Author: Josh Freeman

cli

@@ -0,0 +1,18 @@
+#!/usr/bin/env php
+<?php
+// composer auto loader
+require __DIR__ . '/vendor/autoload.php';
+
+$option = isset($argv[1]) ? trim($argv[1]) : false;
+$arg1   = isset($argv[2]) ? trim($argv[2]) : false;
+
+// setup xivapi
+$api = new \XIVAPI\XIVAPI();
+
+// set env key
+$api->environment->key('my_api_key');
+
+// do commands
+$results = $api->search->find('fire shard')->results();
+
+print_r($results);

example.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace XIVAPI\Api;
+
+use GuzzleHttp\RequestOptions;
+use XIVAPI\Guzzle\Guzzle;
+
+class Search extends Guzzle
+{
+    const ENDPOINT = '/search';
+
+    private $options = [
+        'indexes'       => null,
+        'string'        => null,
+        'string_column' => null,
+        'string_algo'   => null,
+        'page'          => null,
+        'sort_field'    => null,
+        'sort_order'    => null,
+        'limit'         => null,
+        'columns'       => null,
+        'bool'          => null,
+        'filters'       => [],
+    ];
+
+    public function __construct()
+    {
+        $this->options = (Object)$this->options;
+    }
+
+    public function results()
+    {
+        $options = [
+            RequestOptions::QUERY => []
+        ];
+
+        foreach ($this->options as $field => $value) {
+            if (empty($value)) {
+                continue;
+            }
+
+            $options[RequestOptions::QUERY][$field] = $value;
+        }
+
+        return $this->get(self::ENDPOINT, $options);
+    }
+
+    public function indexes(array $indexes): Search
+    {
+        $this->options->indexes = implode(',', $indexes);
+        return $this;
+    }
+
+    public function find(string $string): Search
+    {
+        $this->options->string = trim($string);
+        return $this;
+    }
+
+    public function findColumn(string $column): Search
+    {
+        $this->options->string_column = trim($column);
+        return $this;
+    }
+
+    public function algorithm(string $searchStringAlgorithm): Search
+    {
+        $this->options->string_algo = trim($searchStringAlgorithm);
+        return $this;
+    }
+
+    public function page(int $number): Search
+    {
+        $this->options->page = $number;
+        return $this;
+    }
+
+    public function sort(string $field, string $order): Search
+    {
+        $this->options->sort_field = $field;
+        $this->options->sort_order = $order;
+        return $this;
+    }
+
+    public function limit(int $limit): Search
+    {
+        $this->options->limit = $limit;
+        return $this;
+    }
+
+    public function columns(array $columns): Search
+    {
+        $this->options->columns = implode(',', $columns);
+        return $this;
+    }
+
+    public function bool(string $bool): Search
+    {
+        $this->options->bool = $bool;
+        return $this;
+    }
+
+    public function filter(string $field, $value, string $operand): Search
+    {
+        $this->options->filters[] = "${field}{$operand}{$value}";
+        return $this;
+    }
+}

src/XIVAPI/Api/Search.php

@@ -0,0 +1,12 @@
+<?php
+
+namespace XIVAPI\Api;
+
+class SearchFilters
+{
+    const EQUAL_TO                  = '=';
+    const GREATER_THAN              = '>';
+    const GREATER_THAN_OR_EQUAL_TO  = '>=';
+    const LESS_THAN                 = '>';
+    const LESS_THAN_OR_EQUAL_TO     = '>=';
+}

src/XIVAPI/Api/SearchFilters.php

@@ -0,0 +1,19 @@
+<?php
+
+namespace XIVAPI\Api;
+
+class SearchStringAlgorithms
+{
+    const CUSTOM               = 'custom';
+    const WILDCARD             = 'wildcard';
+    const WILDCARD_PLUS        = 'wildcard_plus';
+    const FUZZY                = 'fuzzy';
+    const TERM                 = 'term';
+    const PREFIX               = 'prefix';
+    const MATCH                = 'match';
+    const MATCH_PHRASE         = 'match_phrase';
+    const MATCH_PHRASE_PREFIX  = 'match_phrase_prefix';
+    const MULTI_MATCH          = 'multi_match';
+    const QUERY_STRING         = 'query_string';
+    const SIMILAR              = 'similar';
+}

src/XIVAPI/Api/SearchStringAlgorithms.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace XIVAPI\Common;
+
+/**
+ * Set environment variables
+ */
+class Environment
+{
+    const XIVAPI_KEY = 'XIVAPI_KEY';
+
+    public function key(string $key):  Environment
+    {
+        putenv(self::XIVAPI_KEY .'='. $key);
+        return $this;
+    }
+}

src/XIVAPI/Common/Environment.php

@@ -4,6 +4,8 @@
 
 use GuzzleHttp\Client;
 use GuzzleHttp\Exception\ClientException;
+use GuzzleHttp\RequestOptions;
+use XIVAPI\Common\Environment;
 
 class Guzzle
 {
@@ -14,6 +16,10 @@ class Guzzle
 
     public function query($method, $apiEndpoint, $options = [])
     {
+        if ($key = getenv(Environment::XIVAPI_KEY)) {
+            $options[RequestOptions::QUERY]['key'] = $key;
+        }
+
         $client = new Client([
             'base_uri'  => self::ENDPOINT_PROD,
             'timeout'   => self::TIMEOUT,

src/XIVAPI/Guzzle/Guzzle.php

@@ -2,14 +2,19 @@
 
 namespace XIVAPI;
 
-use XIVAPI\Services\Content;
+use XIVAPI\Api\Search;
+use XIVAPI\Common\Environment;
 
 class XIVAPI
 {
-    public $content;
+    /** @var Environment */
+    public $environment;
+    /** @var Search */
+    public $search;
 
     public function __construct()
     {
-        $this->content = new Content();
+        $this->environment = new Environment();
+        $this->search = new Search();
     }
 }