SendGrid::mock() - Code Metrics - Inspection of "Added SendGrid::newInstance() and SendGrid::mock()" - stephanecoinon/sendgrid-activity - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( b4ceaf...dfafd4 )

by Stéphane

created 2019-08-05 21:43 UTC

SendGrid::mock() A

↳ Parent: SendGrid

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	9
rs	9.9666
c	0
b	0
f	0
cc	2
nc	2
nop	1

<?php

namespace StephaneCoinon\SendGridActivity;

use Http\Client\Common\Plugin\BaseUriPlugin;
use Http\Client\HttpClient;
use Http\Discovery\MessageFactoryDiscovery;
use Http\Discovery\UriFactoryDiscovery;
use StephaneCoinon\SendGridActivity\HttpClientFactory;
use StephaneCoinon\SendGridActivity\Integrations\Framework;
use StephaneCoinon\SendGridActivity\Requests\Request;
use StephaneCoinon\SendGridActivity\Support\Testing\ApiResponseFactory;

/**
 * SendGrid API client.
 */
class SendGrid
{
    /**
     * API base URL.
     *
     * @var string
     */
    protected $apiUrl = 'https://api.sendgrid.com';

    /**
     * API version.
     *
     * @var string
     */
    protected $apiVersion = 'v3';

    /**
     * Underlying HTTP client.
     *
     * @var \Http\Client\HttpClient
     */
    protected $client;

    /**
     * Message factory.
     *
     * @var \Http\Message\MessageFactory
     */
    protected $messageFactory;

    /**
     * Make a new ApiClient instance.
     *
     * If $client is null, a new HttpClient using $apiKey is instantiated.
     * If $apiKey is null, SENDGRID_API_KEY environment variable is used.
     * $apiKey is not used when $client is specified.
     *
     * @param null|string $apiKey
     * @param null|\Http\Client\HttpClient $client
     */
    public function __construct($apiKey = null, HttpClient $client = null)
    {
        $this->messageFactory = MessageFactoryDiscovery::find();
        $this->client = $client ?? HttpClientFactory::create(
            $apiKey ?? getenv('SENDGRID_API_KEY'),
            [
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
                new BaseUriPlugin(
                    UriFactoryDiscovery::find()->createUri($this->apiUrl)
                )
            ]
        );
    }

    /**
     *
     * @return self
     */

    /**
     * Get a new SendGrid instance.
     *
     * @param null|string $apiKey
     * @param null|\Http\Client\HttpClient $client
     * @return self
     */
    public static function newInstance($apiKey = null, HttpClient $client = null): self
    {
        return Framework::isLaravel()
            ? app(static::class)
            : new static($apiKey, $client);
    }

    /**
     * Static constructor to get a ApiClient instance with a given HTTP client.
     *
     * @param  \Http\Client\HttpClient $client
     * @return self
     */
    public static function newWithClient(HttpClient $client): self
    {
        return static::newInstance()->withClient($client);
    }

    /**
     * Get a new SendGrid instance with a mock client pre-loaded with HTTP responses.
     *
     * @param  array $responses
     * @return self
     */
    public static function mock(array $responses): self
    {
        $client = new \Http\Mock\Client;
        foreach ($responses as $response) {
            $client->addResponse((new ApiResponseFactory)->json()->build($response));
        }

        return static::newWithClient($client);
    }

    /**
     * Set the underlying HTTP client.
     *
     * @param  \Http\Client\HttpClient $client
     * @return self
     */
    public function withClient(HttpClient $client): self
    {
        $this->client = $client;

        return $this;
    }

    /**
     * Get underlying HTTP client.
     *
     * @return \Http\Client\HttpClient
     */
    public function getClient(): HttpClient
    {
        return $this->client;
    }

    /**
     * Make a "raw" HTTP request.
     *
     * JSON responses are automatically decoded.
     *
     * @param  string $method HTTP method
     * @param  string $url
     * @return string|array
     */
    public function requestRaw(string $method, string $url = '')
    {
        $response = $this->client->sendRequest(
            $this->messageFactory->createRequest(
                $method, "{$this->apiVersion}/{$url}"
            )
        );

        if ($response->getStatusCode() != 200) {
            var_dump(['request failed' => $response->getBody()->getContents()]); die();

            // throw new \Exception('Request failed');
        }

        $content = $response->getBody()->getContents();
        $contentType = $response->getHeader('Content-Type');
        $isJson = in_array('application/json', $contentType);

        return $isJson ? json_decode($content, true) : $content;
    }

    /**
     * Make a request using a Request instance.
     *
     * @param  Request $request
     * @return Response|Response[]
     */
    public function request(Request $request)
    {
        $responseModel = $request->getResponseModel();
        $response = $this->requestRaw(
            $request->getMethod(), $request->buildUrl()
        );

        return $responseModel::createFromApiResponse($response, [
            'api' => $this,
            'request' => $request,
        ]);
    }
}


1			<?php
2
3			namespace StephaneCoinon\SendGridActivity;
4
5			use Http\Client\Common\Plugin\BaseUriPlugin;
6			use Http\Client\HttpClient;
7			use Http\Discovery\MessageFactoryDiscovery;
8			use Http\Discovery\UriFactoryDiscovery;
9			use StephaneCoinon\SendGridActivity\HttpClientFactory;
10			use StephaneCoinon\SendGridActivity\Integrations\Framework;
11			use StephaneCoinon\SendGridActivity\Requests\Request;
12			use StephaneCoinon\SendGridActivity\Support\Testing\ApiResponseFactory;
13
14			/**
15			* SendGrid API client.
16			*/
17			class SendGrid
18			{
19			/**
20			* API base URL.
21			*
22			* @var string
23			*/
24			protected $apiUrl = 'https://api.sendgrid.com';
25
26			/**
27			* API version.
28			*
29			* @var string
30			*/
31			protected $apiVersion = 'v3';
32
33			/**
34			* Underlying HTTP client.
35			*
36			* @var \Http\Client\HttpClient
37			*/
38			protected $client;
39
40			/**
41			* Message factory.
42			*
43			* @var \Http\Message\MessageFactory
44			*/
45			protected $messageFactory;
46
47			/**
48			* Make a new ApiClient instance.
49			*
50			* If $client is null, a new HttpClient using $apiKey is instantiated.
51			* If $apiKey is null, SENDGRID_API_KEY environment variable is used.
52			* $apiKey is not used when $client is specified.
53			*
54			* @param null\|string $apiKey
55			* @param null\|\Http\Client\HttpClient $client
56			*/
57			public function __construct($apiKey = null, HttpClient $client = null)
58			{
59			$this->messageFactory = MessageFactoryDiscovery::find();
60			$this->client = $client ?? HttpClientFactory::create(
61			$apiKey ?? getenv('SENDGRID_API_KEY'),
62			[
			0 ignored issues – show Documentation introduced 2019-08-03 15:56 UTC by Report Bug Copy Issue Report `array(new \Http\Client\C...ateUri($this->apiUrl)))` is of type `array<integer,object<Htt...ugin\\BaseUriPlugin>"}>`, but the function expects a `array<integer,object<Ste...ndGridActivity\Plugin>>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
63			new BaseUriPlugin(
64			UriFactoryDiscovery::find()->createUri($this->apiUrl)
65			)
66			]
67			);
68			}
69
70			/**
71			*
72			* @return self
73			*/
74
75			/**
76			* Get a new SendGrid instance.
77			*
78			* @param null\|string $apiKey
79			* @param null\|\Http\Client\HttpClient $client
80			* @return self
81			*/
82			public static function newInstance($apiKey = null, HttpClient $client = null): self
83			{
84			return Framework::isLaravel()
85			? app(static::class)
86			: new static($apiKey, $client);
87			}
88
89			/**
90			* Static constructor to get a ApiClient instance with a given HTTP client.
91			*
92			* @param \Http\Client\HttpClient $client
93			* @return self
94			*/
95			public static function newWithClient(HttpClient $client): self
96			{
97			return static::newInstance()->withClient($client);
98			}
99
100			/**
101			* Get a new SendGrid instance with a mock client pre-loaded with HTTP responses.
102			*
103			* @param array $responses
104			* @return self
105			*/
106			public static function mock(array $responses): self
107			{
108			$client = new \Http\Mock\Client;
109			foreach ($responses as $response) {
110			$client->addResponse((new ApiResponseFactory)->json()->build($response));
111			}
112
113			return static::newWithClient($client);
114			}
115
116			/**
117			* Set the underlying HTTP client.
118			*
119			* @param \Http\Client\HttpClient $client
120			* @return self
121			*/
122			public function withClient(HttpClient $client): self
123			{
124			$this->client = $client;
125
126			return $this;
127			}
128
129			/**
130			* Get underlying HTTP client.
131			*
132			* @return \Http\Client\HttpClient
133			*/
134			public function getClient(): HttpClient
135			{
136			return $this->client;
137			}
138
139			/**
140			* Make a "raw" HTTP request.
141			*
142			* JSON responses are automatically decoded.
143			*
144			* @param string $method HTTP method
145			* @param string $url
146			* @return string\|array
147			*/
148			public function requestRaw(string $method, string $url = '')
149			{
150			$response = $this->client->sendRequest(
151			$this->messageFactory->createRequest(
152			$method, "{$this->apiVersion}/{$url}"
153			)
154			);
155
156			if ($response->getStatusCode() != 200) {
157			var_dump(['request failed' => $response->getBody()->getContents()]); die();
			0 ignored issues – show Security Debugging Code introduced 2019-08-03 15:56 UTC by Report Bug Copy Issue Report `var_dump(array('request ...ody()->getContents()));` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
158			// throw new \Exception('Request failed');
159			}
160
161			$content = $response->getBody()->getContents();
162			$contentType = $response->getHeader('Content-Type');
163			$isJson = in_array('application/json', $contentType);
164
165			return $isJson ? json_decode($content, true) : $content;
166			}
167
168			/**
169			* Make a request using a Request instance.
170			*
171			* @param Request $request
172			* @return Response\|Response[]
173			*/
174			public function request(Request $request)
175			{
176			$responseModel = $request->getResponseModel();
177			$response = $this->requestRaw(
178			$request->getMethod(), $request->buildUrl()
179			);
180
181			return $responseModel::createFromApiResponse($response, [
182			'api' => $this,
183			'request' => $request,
184			]);
185			}
186			}
187

stephanecoinon / sendgrid-activity

Push — master ( b4ceaf...dfafd4 )

SendGrid::mock() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like