Larachimp::logResponse() - Code Metrics - Inspection of "Tweaked the docs." - diegocaprioli/larachimp - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6b9497...87098f )

by Diego

created 2017-06-29 12:53 UTC

Larachimp::logResponse() A

↳ Parent: Larachimp

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	3
CRAP Score	1

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	3
cts	3
cp	1
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	1
crap	1

<?php namespace DiegoCaprioli\Larachimp\Services;

use DiegoCaprioli\Larachimp\Traits\BasicLogging;
use \GuzzleHttp\Client;
use \Illuminate\Contracts\Logging\Log;
use \Illuminate\Support\Collection;

/**
 * Handles the basic interaction with Mailchimp v3 API
 */
class Larachimp {

    /**
     * Base URI for Mailchimp API v3
     *
     * @var string
     */
    protected $baseuri;

    /**
     * @var string
     */
    protected $apikey;

    /**
     * The connection options
     * @var array
     */
    protected $options;

    /**
     * @var \GuzzleHttp\Client
     */
    protected $client;   

    /**
     * Make this class use a logger and it's basic methods
     */
    use BasicLogging;

    /**
     * Creates a new Larachimp instance
     * 
     * @param Log The logger instance to use
     */
    public function __construct(Log $log = null)
    {
        $this->log = $log;
    }

    /**
     * Initializes the instance with the proper configuration values
     * 
     * @param  string $apikey The API key to the Mailchimp API
     * @param  string $baseuri The base URI to use for the requests. Make sure it has a trailing/ending "/"
     * @param  array $clientOptions The options array in the Guzzle Client expected format          *
     * @see http://guzzle3.readthedocs.io/docs.html Guzzle Docs
     */
    public function initialize($apikey = '', $baseuri = '', $clientOptions = [])
    {        
        $this->apikey = $apikey;
        $this->baseuri = $baseuri;
        $this->client = new Client($clientOptions);        
        $this->options['headers'] = [
            'Authorization' => 'apikey ' . $this->apikey
        ];
    }

    /**
     * If there's a logger defined, it logs the request made
     * 
     * @param  string $method
     * @param  string $resource
     * @param  array $options
     */
    protected function logRequest($method, $resource, array $options = [])
    {   
        $this->logInfo('Mailchimp API Request = ' . var_export([
            compact('resource', 'method', 'options')
        ], true));        
    }


    /**
     * If there's a logger defined, it logs the response returned
     * 
     * @param mixed $response
     */
    protected function logResponse($response)
    {
        $this->logInfo('Mailchimp API Response = ' . var_export($response, true));
    }

    /**
     * Makes a simple API request to Mailchimp. 
     * It uses the base URI used when initializing this service class, and 
     * concatenates the $resource to form the URL of the request.
     * The optional $options array are the standar Guzzle Client request options.
     * The request will automatically include an option setting the 'headers' to
     * use the Authorization API KEY as configured.
     * Finally calls the request method of the Guzzle client using $method, the 
     * generated URL of the request, and the $options.
     * 
     * @param  string $resource The resource
     * @param  string $method The request method (GET, POST, PATCH, PUT, DELETE)
     * @param  array $options An array of request options, as accepted by Guzzle Client request method
     * @return mixed The json_decode'd version of the response body 
     * @see http://developer.mailchimp.com/documentation/mailchimp/guides/get-started-with-mailchimp-api-3/ Mailchimp API v3 Reference
     * @see http://guzzle3.readthedocs.io/docs.html Guzzle Docs
     */
    public function request($method, $resource, array $options = [])
    {

        if (empty($this->apikey)) {
            throw new \Exception("You must initialize the Larachimp instance by calling the initialize() method before attempting any request.");
        }

        $options = array_merge($this->options, $options);

        $resource = $this->baseuri . $resource;

        $this->logRequest($method, $resource, $options);

        try {
            $response = $this->client->request($method, $resource, $options);
        } catch (\GuzzleHttp\Exception\ClientException $e) {

            $this->logError(
                "A \GuzzleHttp\Exception\ClientException has been thrown. Request: " .
                var_export($e->getRequest(), true) . 
                " - Response: " . var_export($e->getResponse()->getBody()->getContents(), true)
            );
            throw $e;            
        }
        
        $responseContents = $response->getBody()->getContents(); 
        $this->logResponse($responseContents);
        $decodedResponse = json_decode($responseContents);
        
        return $decodedResponse;

    }

    /**
     * Makes a simple GET API request to Mailchimp. 
     * 
     * @param  string $resource The resource     
     * @param  array $options An array of request options, as accepted by Guzzle Client request method
     * @return mixed The json_decode'd version of the response body 
     * @see    Larachimp::request()
     */
    public function get($resource, array $options = [])
    {
        return $this->request('GET', $resource, $options);
    }

    /**
     * Makes a simple POST API request to Mailchimp. 
     * 
     * @param  string $resource The resource     
     * @param  array $options An array of request options, as accepted by Guzzle Client request method
     * @return mixed The json_decode'd version of the response body 
     * @see    Larachimp::request()
     */
    public function post($resource, array $options = [])
    {
        return $this->request('POST', $resource, $options);
    }

    /**
     * Makes a simple PATCH API request to Mailchimp. 
     * 
     * @param  string $resource The resource     
     * @param  array $options An array of request options, as accepted by Guzzle Client request method
     * @return mixed The json_decode'd version of the response body 
     * @see    Larachimp::request()
     */
    public function patch($resource, array $options = [])
    {
        return $this->request('PATCH', $resource, $options);
    }

    /**
     * Makes a simple PUT API request to Mailchimp. 
     * 
     * @param  string $resource The resource     
     * @param  array $options An array of request options, as accepted by Guzzle Client request method
     * @return mixed The json_decode'd version of the response body 
     * @see    Larachimp::request()
     */
    public function put($resource, array $options = [])
    {
        return $this->request('PUT', $resource, $options);
    }

    /**
     * Makes a simple DELETE API request to Mailchimp. 
     * 
     * @param  string $resource The resource     
     * @param  array $options An array of request options, as accepted by Guzzle Client request method
     * @return mixed The json_decode'd version of the response body 
     * @see    Larachimp::request()
     */
    public function delete($resource, array $options = [])
    {
        return $this->request('DELETE', $resource, $options);
    }


}

1		<?php namespace DiegoCaprioli\Larachimp\Services;
2
3		use DiegoCaprioli\Larachimp\Traits\BasicLogging;
4		use \GuzzleHttp\Client;
5		use \Illuminate\Contracts\Logging\Log;
6		use \Illuminate\Support\Collection;
7
8		/**
9		* Handles the basic interaction with Mailchimp v3 API
10		*/
11		class Larachimp {
12
13		/**
14		* Base URI for Mailchimp API v3
15		*
16		* @var string
17		*/
18		protected $baseuri;
19
20		/**
21		* @var string
22		*/
23		protected $apikey;
24
25		/**
26		* The connection options
27		* @var array
28		*/
29		protected $options;
30
31		/**
32		* @var \GuzzleHttp\Client
33		*/
34		protected $client;
35
36		/**
37		* Make this class use a logger and it's basic methods
38		*/
39		use BasicLogging;
40
41		/**
42		* Creates a new Larachimp instance
43		*
44		* @param Log The logger instance to use
45		*/
46	6	public function __construct(Log $log = null)
47		{
48	6	$this->log = $log;
49	6	}
50
51		/**
52		* Initializes the instance with the proper configuration values
53		*
54		* @param string $apikey The API key to the Mailchimp API
55		* @param string $baseuri The base URI to use for the requests. Make sure it has a trailing/ending "/"
56		* @param array $clientOptions The options array in the Guzzle Client expected format *
57		* @see http://guzzle3.readthedocs.io/docs.html Guzzle Docs
58		*/
59	6	public function initialize($apikey = '', $baseuri = '', $clientOptions = [])
60		{
61	6	$this->apikey = $apikey;
62	6	$this->baseuri = $baseuri;
63	6	$this->client = new Client($clientOptions);
64	6	$this->options['headers'] = [
65	6	'Authorization' => 'apikey ' . $this->apikey
66	6	];
67	6	}
68
69		/**
70		* If there's a logger defined, it logs the request made
71		*
72		* @param string $method
73		* @param string $resource
74		* @param array $options
75		*/
76	6	protected function logRequest($method, $resource, array $options = [])
77		{
78	6	$this->logInfo('Mailchimp API Request = ' . var_export([
79	6	compact('resource', 'method', 'options')
80	6	], true));
81	6	}
82
83
84		/**
85		* If there's a logger defined, it logs the response returned
86		*
87		* @param mixed $response
88		*/
89	6	protected function logResponse($response)
90		{
91	6	$this->logInfo('Mailchimp API Response = ' . var_export($response, true));
92	6	}
93
94		/**
95		* Makes a simple API request to Mailchimp.
96		* It uses the base URI used when initializing this service class, and
97		* concatenates the $resource to form the URL of the request.
98		* The optional $options array are the standar Guzzle Client request options.
99		* The request will automatically include an option setting the 'headers' to
100		* use the Authorization API KEY as configured.
101		* Finally calls the request method of the Guzzle client using $method, the
102		* generated URL of the request, and the $options.
103		*
104		* @param string $resource The resource
105		* @param string $method The request method (GET, POST, PATCH, PUT, DELETE)
106		* @param array $options An array of request options, as accepted by Guzzle Client request method
107		* @return mixed The json_decode'd version of the response body
108		* @see http://developer.mailchimp.com/documentation/mailchimp/guides/get-started-with-mailchimp-api-3/ Mailchimp API v3 Reference
109		* @see http://guzzle3.readthedocs.io/docs.html Guzzle Docs
110		*/
111	6	public function request($method, $resource, array $options = [])
112		{
113
114	6	if (empty($this->apikey)) {
115		throw new \Exception("You must initialize the Larachimp instance by calling the initialize() method before attempting any request.");
116		}
117
118	6	$options = array_merge($this->options, $options);
119
120	6	$resource = $this->baseuri . $resource;
121
122	6	$this->logRequest($method, $resource, $options);
123
124		try {
125	6	$response = $this->client->request($method, $resource, $options);
126	6	} catch (\GuzzleHttp\Exception\ClientException $e) {
127
128		$this->logError(
129		"A \GuzzleHttp\Exception\ClientException has been thrown. Request: " .
130	1	var_export($e->getRequest(), true) .
131		" - Response: " . var_export($e->getResponse()->getBody()->getContents(), true)
132		);
133		throw $e;
134		}
135
136	6	$responseContents = $response->getBody()->getContents();
137	6	$this->logResponse($responseContents);
138	6	$decodedResponse = json_decode($responseContents);
139
140	6	return $decodedResponse;
141
142		}
143
144		/**
145		* Makes a simple GET API request to Mailchimp.
146		*
147		* @param string $resource The resource
148		* @param array $options An array of request options, as accepted by Guzzle Client request method
149		* @return mixed The json_decode'd version of the response body
150		* @see Larachimp::request()
151		*/
152	6	public function get($resource, array $options = [])
153		{
154	6	return $this->request('GET', $resource, $options);
155		}
156
157		/**
158		* Makes a simple POST API request to Mailchimp.
159		*
160		* @param string $resource The resource
161		* @param array $options An array of request options, as accepted by Guzzle Client request method
162		* @return mixed The json_decode'd version of the response body
163		* @see Larachimp::request()
164		*/
165	5	public function post($resource, array $options = [])
166		{
167	5	return $this->request('POST', $resource, $options);
168		}
169
170		/**
171		* Makes a simple PATCH API request to Mailchimp.
172		*
173		* @param string $resource The resource
174		* @param array $options An array of request options, as accepted by Guzzle Client request method
175		* @return mixed The json_decode'd version of the response body
176		* @see Larachimp::request()
177		*/
178	1	public function patch($resource, array $options = [])
179		{
180	1	return $this->request('PATCH', $resource, $options);
181		}
182
183		/**
184		* Makes a simple PUT API request to Mailchimp.
185		*
186		* @param string $resource The resource
187		* @param array $options An array of request options, as accepted by Guzzle Client request method
188		* @return mixed The json_decode'd version of the response body
189		* @see Larachimp::request()
190		*/
191		public function put($resource, array $options = [])
192		{
193		return $this->request('PUT', $resource, $options);
194		}
195
196		/**
197		* Makes a simple DELETE API request to Mailchimp.
198		*
199		* @param string $resource The resource
200		* @param array $options An array of request options, as accepted by Guzzle Client request method
201		* @return mixed The json_decode'd version of the response body
202		* @see Larachimp::request()
203		*/
204	5	public function delete($resource, array $options = [])
205		{
206	5	return $this->request('DELETE', $resource, $options);
207		}
208
209
210		}

diegocaprioli / larachimp

Push — master ( 6b9497...87098f )

Larachimp::logResponse() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like