TriggerWebhooksJob::resolveCallable() - Code Metrics - Inspection of "Added a max_attempts config value." - mpociot/captainhook - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 11e78a...b54f99 )

by Marcel

created 2016-05-25 09:14 UTC

TriggerWebhooksJob::resolveCallable() A

↳ Parent: TriggerWebhooksJob

Complexity

Conditions	3
Paths	3

Size

Total Lines	14
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	1	Features	1

Metric	Value
c	2
b	1
f	1
dl	0
loc	14
rs	9.4285
cc	3
eloc	8
nc	3
nop	2

<?php

namespace Mpociot\CaptainHook\Jobs;

use GuzzleHttp\Client;
use GuzzleHttp\Middleware;
use GuzzleHttp\Promise\PromiseInterface;
use Illuminate\Bus\Queueable;
use Illuminate\Contracts\Bus\SelfHandling;
use Illuminate\Support\Str;
use Mpociot\CaptainHook\WebhookLog;
use Illuminate\Queue\SerializesModels;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Illuminate\Queue\InteractsWithQueue;
use Illuminate\Contracts\Queue\ShouldQueue;

class TriggerWebhooksJob implements SelfHandling, ShouldQueue

{
    use Queueable, InteractsWithQueue, SerializesModels;

    /**
     * All the webhooks that should be executed.
     *
     * @var array|\Illuminate\Support\Collection
     */
    protected $webhooks;

    /**
     * The event data to be posted to our hooks.
     *
     * @var mixed
     */
    protected $eventData;

    /**
     * Create a new job instance.
     *
     * @param array|\Illuminate\Support\Collection $webhooks
     * @param mixed $eventData
     */
    public function __construct($webhooks, $eventData)
    {
        $this->eventData = $eventData;
        $this->webhooks = $webhooks;
    }

    /**
     * Resolves a string or callable to a valid callable.
     * @param string|callable $transformer
     * @param $defaultMethodName
     * @return callable
     */
    private function resolveCallable($transformer, $defaultMethodName)
    {
        if (is_string($transformer)) {
            return function () use ($transformer, $defaultMethodName) {
                list($class, $method) = Str::parseCallback($transformer, $defaultMethodName);

                return call_user_func_array([app($class), $method], func_get_args());
            };
        } elseif (is_callable($transformer)) {
            return $transformer;
        }

        return function () {};
    }

    /**
     * Execute the job.
     *
     * @return void
     */
    public function handle()
    {
        $config = app('Illuminate\Contracts\Config\Repository');
        $client = app(Client::class);

        if ($config->get('captain_hook.log.max_attempts', -1) !== -1 && $this->attempts() > $config->get('captain_hook.log.max_attempts')) {
            return;
        }

        $logging = $config->get('captain_hook.log.active');
        $transformer = $this->resolveCallable($config->get('captain_hook.transformer'), 'transform');
        $responseCallback = $this->resolveCallable($config->get('captain_hook.response_callback'), 'handle');

        foreach ($this->webhooks as $webhook) {
            if ($logging) {
                if ($config->get('captain_hook.log.storage_quantity') != -1 &&
                    $webhook->logs()->count() >= $config->get('captain_hook.log.storage_quantity')) {
                    $webhook->logs()->orderBy('updated_at', 'asc')->first()->delete();
                }
                $log = new WebhookLog([
                    'webhook_id' => $webhook['id'],
                    'url' => $webhook['url'],
                ]);
                $middleware = Middleware::tap(function (RequestInterface $request, $options) use ($log) {

                    $log->payload_format = isset($request->getHeader('Content-Type')[0]) ? $request->getHeader('Content-Type')[0] : null;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                    $log->payload = $request->getBody()->getContents();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                }, function ($request, $options, PromiseInterface $response) use ($log, $webhook, $responseCallback) {
                    $response->then(function (ResponseInterface $response) use ($log, $webhook, $responseCallback) {
                        $log->status = $response->getStatusCode();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                        $log->response = $response->getBody()->getContents();
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}
                        $log->response_format = $log->payload_format = isset($response->getHeader('Content-Type')[0]) ? $response->getHeader('Content-Type')[0] : null;
<?php

/**
 * @property int $x
 * @property int $y
 * @property string $text
 */
class MyLabel
{
    private $properties;

    private $allowedProperties = array('x', 'y', 'text');

    public function __get($name)
    {
        if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) {
            return $properties[$name];
        } else {
            return null;
        }
    }

    public function __set($name, $value)
    {
        if (in_array($name, $this->allowedProperties)) {
            $properties[$name] = $value;
        } else {
            throw new \LogicException("Property $name is not defined.");
        }
    }

}

                        $log->save();

                        // Retry this job if the webhook response didn't give us a HTTP 200 OK
                        if ($response->getStatusCode() >= 300 || $response->getStatusCode() < 200 ) {
                            $this->release(30);
                        }

                        $responseCallback($webhook, $response);
                    });
                });

                $client->post($webhook['url'], [
                    'exceptions' => false,
                    'body' => $transformer($this->eventData, $webhook),
                    'verify' => false,
                    'handler' => $middleware($client->getConfig('handler')),
                ]);
            } else {
                $client->post($webhook['url'], [
                    'exceptions' => false,
                    'body' => $transformer($this->eventData, $webhook),
                    'verify' => false,
                    'timeout' => 10,
                ]);
            }
        }
    }
}


1			<?php
2
3			namespace Mpociot\CaptainHook\Jobs;
4
5			use GuzzleHttp\Client;
6			use GuzzleHttp\Middleware;
7			use GuzzleHttp\Promise\PromiseInterface;
8			use Illuminate\Bus\Queueable;
9			use Illuminate\Contracts\Bus\SelfHandling;
10			use Illuminate\Support\Str;
11			use Mpociot\CaptainHook\WebhookLog;
12			use Illuminate\Queue\SerializesModels;
13			use Psr\Http\Message\RequestInterface;
14			use Psr\Http\Message\ResponseInterface;
15			use Illuminate\Queue\InteractsWithQueue;
16			use Illuminate\Contracts\Queue\ShouldQueue;
17
18			class TriggerWebhooksJob implements SelfHandling, ShouldQueue
			0 ignored issues – show Deprecated Code introduced 2016-02-16 22:49 UTC by Report Bug Copy Issue Report The interface `Illuminate\Contracts\Bus\SelfHandling` has been deprecated with message: since version 5.2. Remove from jobs since self-handling is default. This class, trait or interface has been deprecated. The supplier of the file has supplied an explanatory message. The explanatory message should give you some clue as to whether and when the type will be removed from the class and what other constant to use instead. Loading history...
19			{
20			use Queueable, InteractsWithQueue, SerializesModels;
21
22			/**
23			* All the webhooks that should be executed.
24			*
25			* @var array\|\Illuminate\Support\Collection
26			*/
27			protected $webhooks;
28
29			/**
30			* The event data to be posted to our hooks.
31			*
32			* @var mixed
33			*/
34			protected $eventData;
35
36			/**
37			* Create a new job instance.
38			*
39			* @param array\|\Illuminate\Support\Collection $webhooks
40			* @param mixed $eventData
41			*/
42			public function __construct($webhooks, $eventData)
43			{
44			$this->eventData = $eventData;
45			$this->webhooks = $webhooks;
46			}
47
48			/**
49			* Resolves a string or callable to a valid callable.
50			* @param string\|callable $transformer
51			* @param $defaultMethodName
52			* @return callable
53			*/
54			private function resolveCallable($transformer, $defaultMethodName)
55			{
56			if (is_string($transformer)) {
57			return function () use ($transformer, $defaultMethodName) {
58			list($class, $method) = Str::parseCallback($transformer, $defaultMethodName);
59
60			return call_user_func_array([app($class), $method], func_get_args());
61			};
62			} elseif (is_callable($transformer)) {
63			return $transformer;
64			}
65
66			return function () {};
67			}
68
69			/**
70			* Execute the job.
71			*
72			* @return void
73			*/
74			public function handle()
75			{
76			$config = app('Illuminate\Contracts\Config\Repository');
77			$client = app(Client::class);
78
79			if ($config->get('captain_hook.log.max_attempts', -1) !== -1 && $this->attempts() > $config->get('captain_hook.log.max_attempts')) {
80			return;
81			}
82
83			$logging = $config->get('captain_hook.log.active');
84			$transformer = $this->resolveCallable($config->get('captain_hook.transformer'), 'transform');
85			$responseCallback = $this->resolveCallable($config->get('captain_hook.response_callback'), 'handle');
86
87			foreach ($this->webhooks as $webhook) {
88			if ($logging) {
89			if ($config->get('captain_hook.log.storage_quantity') != -1 &&
90			$webhook->logs()->count() >= $config->get('captain_hook.log.storage_quantity')) {
91			$webhook->logs()->orderBy('updated_at', 'asc')->first()->delete();
92			}
93			$log = new WebhookLog([
94			'webhook_id' => $webhook['id'],
95			'url' => $webhook['url'],
96			]);
97			$middleware = Middleware::tap(function (RequestInterface $request, $options) use ($log) {
			0 ignored issues – show Unused Code introduced 2016-01-26 13:55 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
98			$log->payload_format = isset($request->getHeader('Content-Type')[0]) ? $request->getHeader('Content-Type')[0] : null;
			0 ignored issues – show Documentation introduced 2016-01-26 21:31 UTC by Report Bug Copy Issue Report The property `payload_format` does not exist on `object<Mpociot\CaptainHook\WebhookLog>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
99			$log->payload = $request->getBody()->getContents();
			0 ignored issues – show Documentation introduced 2016-01-26 21:31 UTC by Report Bug Copy Issue Report The property `payload` does not exist on `object<Mpociot\CaptainHook\WebhookLog>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
100			}, function ($request, $options, PromiseInterface $response) use ($log, $webhook, $responseCallback) {
101			$response->then(function (ResponseInterface $response) use ($log, $webhook, $responseCallback) {
102			$log->status = $response->getStatusCode();
			0 ignored issues – show Documentation introduced 2016-01-26 21:31 UTC by Report Bug Copy Issue Report The property `status` does not exist on `object<Mpociot\CaptainHook\WebhookLog>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
103			$log->response = $response->getBody()->getContents();
			0 ignored issues – show Documentation introduced 2016-01-26 21:31 UTC by Report Bug Copy Issue Report The property `response` does not exist on `object<Mpociot\CaptainHook\WebhookLog>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
104			$log->response_format = $log->payload_format = isset($response->getHeader('Content-Type')[0]) ? $response->getHeader('Content-Type')[0] : null;
			0 ignored issues – show Documentation introduced 2016-01-26 21:31 UTC by Report Bug Copy Issue Report The property `response_format` does not exist on `object<Mpociot\CaptainHook\WebhookLog>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /** * @property int $x * @property int $y * @property string $text / class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history... Documentation introduced 2016-01-26 21:31 UTC by Report Bug Copy Issue Report The property `payload_format` does not exist on `object<Mpociot\CaptainHook\WebhookLog>`. Since you implemented `__set`, maybe consider adding a @property annotation. Since your code implements the magic setter `_set`, this function will be called for any write access on an undefined variable. You can add the `@property` annotation to your class or interface to document the existence of this variable. <?php /* * @property int $x * @property int $y * @property string $text */ class MyLabel { private $properties; private $allowedProperties = array('x', 'y', 'text'); public function __get($name) { if (isset($properties[$name]) && in_array($name, $this->allowedProperties)) { return $properties[$name]; } else { return null; } } public function __set($name, $value) { if (in_array($name, $this->allowedProperties)) { $properties[$name] = $value; } else { throw new \LogicException("Property $name is not defined."); } } } Since the property has write access only, you can use the @property-write annotation instead. Of course, you may also just have mistyped another name, in which case you should fix the error. See also the PhpDoc documentation for @property. Loading history...
105
106			$log->save();
107
108			// Retry this job if the webhook response didn't give us a HTTP 200 OK
109			if ($response->getStatusCode() >= 300 \|\| $response->getStatusCode() < 200 ) {
110			$this->release(30);
111			}
112
113			$responseCallback($webhook, $response);
114			});
115			});
116
117			$client->post($webhook['url'], [
118			'exceptions' => false,
119			'body' => $transformer($this->eventData, $webhook),
120			'verify' => false,
121			'handler' => $middleware($client->getConfig('handler')),
122			]);
123			} else {
124			$client->post($webhook['url'], [
125			'exceptions' => false,
126			'body' => $transformer($this->eventData, $webhook),
127			'verify' => false,
128			'timeout' => 10,
129			]);
130			}
131			}
132			}
133			}
134

mpociot / captainhook

Push — master ( 11e78a...b54f99 )

TriggerWebhooksJob::resolveCallable() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like