HttpPlayback::setPlaybackOptions() - Code Metrics - Inspection of "Extracting code for more readability" - Garethp/php-ews - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 35728e...5c8980 )

by Gareth

created 2016-05-11 14:22 UTC

HttpPlayback::setPlaybackOptions() A

↳ Parent: HttpPlayback

Complexity

Conditions	4
Paths	8

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	14
CRAP Score	4

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	19
ccs	14
cts	14
cp	1
rs	9.2
cc	4
eloc	10
nc	8
nop	1
crap	4

<?php

namespace garethp\ews\HttpPlayback;

use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use GuzzleHttp\Handler\MockHandler;
use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Psr7\Response;
use GuzzleHttp\Client;

class HttpPlayback
{
    protected $mode = 'live';

    protected $callList = [];

    protected $recordLocation;

    protected $recordFileName = 'saveState.json';

    private $shutdownRegistered = false;

    private static $instances = [];

    /**
     * @var Client
     */
    private $client;

    public static function getInstance($options = [])
    {
        foreach (self::$instances as $instance) {
            if ($instance['options'] == $options) {
                return $instance['instance'];
            }
        }

        $instance = new static();
        $instance->setPlaybackOptions($options);
        self::$instances[] = [
            'instance' => $instance,
            'options' => $options
        ];

        return $instance;
    }

    public function setPlaybackOptions($options = [])
    {
        $options = array_replace_recursive(
            ['mode' => null, 'recordLocation' => null, 'recordFileName' => null],
            $options
        );

        if ($options['mode'] !== null) {
            $this->mode = $options['mode'];
        }

        if ($options['recordLocation'] !== null) {
            $this->recordLocation = $options['recordLocation'];
        }

        if ($options['recordFileName'] !== null) {
            $this->recordFileName = $options['recordFileName'];
        }
    }

    /**
     * Get the client for making calls
     *
     * @return Client
     */
    public function getHttpClient()
    {
        if ($this->client !== null) {
            return $this->client;
        }

        $handler = HandlerStack::create();

        if ($this->mode == 'record') {
            $history = Middleware::history($this->callList);
            $handler->push($history);
        } elseif ($this->mode == 'playback') {
            $recordings = $this->getRecordings();
            $mockHandler = new MockHandler($this->arrayToResponses($recordings));
            $handler = HandlerStack::create($mockHandler);
        }

        $this->registerShutdown();
        $this->client = new Client(['handler' => $handler]);

        return $this->client;
    }

    /**
     * Sets the client
     *
     * @param Client $client
     * @return $this
     */
    public function setHttpClient($client)
    {
        $this->client = $client;

        return $this;
    }

    public function getRecordLocation()
    {
        if (!$this->recordLocation) {
            $dir = __DIR__;
            $dirPos = strrpos($dir, "src/API");
            $dir = substr($dir, 0, $dirPos);

            $this->recordLocation = $dir.'Resources/recordings/';
        }

        return $this->recordLocation;
    }

    public function getRecordFilePath()
    {
        $path = $this->getRecordLocation() . $this->recordFileName;
        $path = str_replace("\\", "/", $path);

        return $path;
    }

    public function getRecordings()
    {
        $saveLocation = $this->getRecordFilePath();
        $records = json_decode(file_get_contents($saveLocation), true);

        return $records;
    }

    public function endRecord()
    {
        if ($this->mode != 'record') {
            return;
        }

        $saveList = $this->responsesToArray($this->callList);

        $saveLocation = $this->getRecordFilePath();
        $folder = pathinfo($saveLocation)['dirname'];
        if (!is_dir($folder)) {
            mkdir($folder, 0777, true);
        }

        file_put_contents($saveLocation, json_encode($saveList));
    }

    protected function registerShutdown()
    {
        if (!$this->shutdownRegistered) {
            register_shutdown_function(array($this, 'endRecord'));
            $this->shutdownRegistered = true;
        }
    }

    /**
     * @param $responses
     * @return array
     */
    protected function responsesToArray($responses)
    {
        $array = [];
        foreach ($responses as $item) {
            /** @var Response $response */
            $response = $item['response'];

            if (!isset($item['error'])) {
                $save = [
                    'error' => false,
                    'statusCode' => $response->getStatusCode(),
                    'headers' => $response->getHeaders(),
                    'body' => $response->getBody()->__toString()
                ];
            } else {
                $save = [
                    'error' => true,
                    'errorClass' => get_class($item['error']),
                    'errorMessage' => $item['error']->getMessage(),
                    'request' => [
                        'method' => $item['request']->getMethod(),
                        'uri' => $item['request']->getUri()->__toString(),
                        'headers' => $item['request']->getHeaders(),
                        'body' => $item['request']->getBody()->__toString()
                    ]
                ];
            }
            $array[] = $save;
        }

        return $array;
    }

    /**
     * @param $items
     * @return Response[]
     */
    protected function arrayToResponses($items)
    {
        $mockedResponses = [];
        foreach ($items as $item) {
            if (!$item['error']) {
                $mockedResponses[] = new Response($item['statusCode'], $item['headers'], $item['body']);
            } else {
                $errorClass = $item['errorClass'];
                $request = new Request(
                    $item['request']['method'],
                    $item['request']['uri'],
                    $item['request']['headers'],
                    $item['request']['body']
                );
                $mockedResponses[] = new $errorClass($item['errorMessage'], $request);
            }
        }

        return $mockedResponses;
    }
}


1		<?php
2
3		namespace garethp\ews\HttpPlayback;
4
5		use GuzzleHttp\HandlerStack;
6		use GuzzleHttp\Middleware;
7		use GuzzleHttp\Handler\MockHandler;
8		use GuzzleHttp\Psr7\Request;
9		use GuzzleHttp\Psr7\Response;
10		use GuzzleHttp\Client;
11
12		class HttpPlayback
13		{
14		protected $mode = 'live';
15
16		protected $callList = [];
17
18		protected $recordLocation;
19
20		protected $recordFileName = 'saveState.json';
21
22		private $shutdownRegistered = false;
23
24		private static $instances = [];
25
26		/**
27		* @var Client
28		*/
29		private $client;
30
31	33	public static function getInstance($options = [])
32		{
33	33	foreach (self::$instances as $instance) {
34	33	if ($instance['options'] == $options) {
35	16	return $instance['instance'];
36		}
37	33	}
38
39	29	$instance = new static();
40	29	$instance->setPlaybackOptions($options);
41	29	self::$instances[] = [
42	29	'instance' => $instance,
43		'options' => $options
44	29	];
45
46	29	return $instance;
47		}
48
49	30	public function setPlaybackOptions($options = [])
50		{
51	30	$options = array_replace_recursive(
52	30	['mode' => null, 'recordLocation' => null, 'recordFileName' => null],
53		$options
54	30	);
55
56	30	if ($options['mode'] !== null) {
57	30	$this->mode = $options['mode'];
58	30	}
59
60	30	if ($options['recordLocation'] !== null) {
61	1	$this->recordLocation = $options['recordLocation'];
62	1	}
63
64	30	if ($options['recordFileName'] !== null) {
65	30	$this->recordFileName = $options['recordFileName'];
66	30	}
67	30	}
68
69		/**
70		* Get the client for making calls
71		*
72		* @return Client
73		*/
74	26	public function getHttpClient()
75		{
76	26	if ($this->client !== null) {
77	25	return $this->client;
78		}
79
80	26	$handler = HandlerStack::create();
81
82	26	if ($this->mode == 'record') {
83		$history = Middleware::history($this->callList);
84		$handler->push($history);
85	26	} elseif ($this->mode == 'playback') {
86	26	$recordings = $this->getRecordings();
87	26	$mockHandler = new MockHandler($this->arrayToResponses($recordings));
88	26	$handler = HandlerStack::create($mockHandler);
89	26	}
90
91	26	$this->registerShutdown();
92	26	$this->client = new Client(['handler' => $handler]);
93
94	26	return $this->client;
95		}
96
97		/**
98		* Sets the client
99		*
100		* @param Client $client
101		* @return $this
102		*/
103		public function setHttpClient($client)
104		{
105		$this->client = $client;
106
107		return $this;
108		}
109
110	27	public function getRecordLocation()
111		{
112	27	if (!$this->recordLocation) {
113	26	$dir = __DIR__;
114	26	$dirPos = strrpos($dir, "src/API");
115	26	$dir = substr($dir, 0, $dirPos);
116
117	26	$this->recordLocation = $dir.'Resources/recordings/';
118	26	}
119
120	27	return $this->recordLocation;
121		}
122
123	27	public function getRecordFilePath()
124		{
125	27	$path = $this->getRecordLocation() . $this->recordFileName;
126	27	$path = str_replace("\\", "/", $path);
127
128	27	return $path;
129		}
130
131	26	public function getRecordings()
132		{
133	26	$saveLocation = $this->getRecordFilePath();
134	26	$records = json_decode(file_get_contents($saveLocation), true);
135
136	26	return $records;
137		}
138
139	1	public function endRecord()
140		{
141	1	if ($this->mode != 'record') {
142	1	return;
143		}
144
145	1	$saveList = $this->responsesToArray($this->callList);
146
147	1	$saveLocation = $this->getRecordFilePath();
148	1	$folder = pathinfo($saveLocation)['dirname'];
149	1	if (!is_dir($folder)) {
150	1	mkdir($folder, 0777, true);
151	1	}
152
153	1	file_put_contents($saveLocation, json_encode($saveList));
154	1	}
155
156	26	protected function registerShutdown()
157		{
158	26	if (!$this->shutdownRegistered) {
159	26	register_shutdown_function(array($this, 'endRecord'));
160	26	$this->shutdownRegistered = true;
161	26	}
162	26	}
163
164		/**
165		* @param $responses
166		* @return array
167		*/
168	1	protected function responsesToArray($responses)
169		{
170	1	$array = [];
171	1	foreach ($responses as $item) {
172		/** @var Response $response */
173		$response = $item['response'];
174
175		if (!isset($item['error'])) {
176		$save = [
177		'error' => false,
178		'statusCode' => $response->getStatusCode(),
179		'headers' => $response->getHeaders(),
180		'body' => $response->getBody()->__toString()
181		];
182		} else {
183		$save = [
184		'error' => true,
185		'errorClass' => get_class($item['error']),
186		'errorMessage' => $item['error']->getMessage(),
187		'request' => [
188		'method' => $item['request']->getMethod(),
189		'uri' => $item['request']->getUri()->__toString(),
190		'headers' => $item['request']->getHeaders(),
191		'body' => $item['request']->getBody()->__toString()
192		]
193		];
194		}
195		$array[] = $save;
196	1	}
197
198	1	return $array;
199		}
200
201		/**
202		* @param $items
203		* @return Response[]
204		*/
205	26	protected function arrayToResponses($items)
206		{
207	26	$mockedResponses = [];
208	26	foreach ($items as $item) {
209	26	if (!$item['error']) {
210	25	$mockedResponses[] = new Response($item['statusCode'], $item['headers'], $item['body']);
211	25	} else {
212	2	$errorClass = $item['errorClass'];
213	2	$request = new Request(
214	2	$item['request']['method'],
215	2	$item['request']['uri'],
216	2	$item['request']['headers'],
217	2	$item['request']['body']
218	2	);
219	2	$mockedResponses[] = new $errorClass($item['errorMessage'], $request);
220		}
221	26	}
222
223	26	return $mockedResponses;
224		}
225		}
226

Garethp / php-ews

Push — master ( 35728e...5c8980 )

HttpPlayback::setPlaybackOptions() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like