HipChat::url() - Code Metrics - Inspection of "Allow Token overrides" - laravel-notification-channels/hipchat - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#17)

unknown

created 2017-02-19 23:39 UTC

HipChat::url() A

↳ Parent: HipChat

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

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

<?php

namespace NotificationChannels\HipChat;

use GuzzleHttp\Psr7\Request;
use GuzzleHttp\Client as HttpClient;
use GuzzleHttp\Psr7\MultipartStream;
use function GuzzleHttp\Psr7\stream_for;
use function GuzzleHttp\Psr7\modify_request;

class HipChat
{
    /** @var string */
    protected $token;

    /** @var HttpClient */
    protected $http;

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

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

    /**
     * @param HttpClient $http
     * @param string $token
     * @param string|null $url
     */
    public function __construct(HttpClient $http, $url, $token, $room)
    {
        $this->http = $http;
        $this->url = rtrim($url ?: 'https://api.hipchat.com', '/');
        $this->token = $token;
        $this->room = $room;
    }

    /**
     * Returns default room id or name.
     *
     * @return string
     */
    public function room()
    {
        return $this->room;
    }

    /**
     * Returns HipChat base url.
     *
     * @return string
     */
    public function url()
    {
        return $this->url;
    }

    /**
     * Set the HipChat token to use.
     *
     * @param string
     */
    public function token($token)
    {
        $this->token = $token;
    }

    /**
     * Send a message.
     *
     * @param string|int $to
     * @param array $message
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function sendMessage($to, $message)
    {
        $url = $this->url.'/v2/room/'.urlencode($to).'/notification';

        return $this->post($url, [
            'headers' => $this->getHeaders(),
            'json' => $message,
        ]);
    }

    /**
     * Share a file.
     *
     * @param string|int $to
     * @param array $file
     * @return \Psr\Http\Message\ResponseInterface
     */
    public function shareFile($to, $file)
    {
        $parts[] = [
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
            'headers' => [
                'Content-Type' => $file['file_type'] ?: 'application/octet-stream',
            ],
            'name' => 'file',
            'contents' => stream_for($file['content']),
            'filename' => $file['filename'] ?: 'untitled',
        ];

        if (! empty($file['message'])) {
            $parts[] = [
                'headers' => [
                    'Content-Type' => 'application/json',
                ],
                'name' => 'metadata',
                'contents' => json_encode(['message' => $file['message']]),
            ];
        }

        $url = $this->url.'/v2/room/'.urlencode($to).'/share/file';

        return $this->postMultipartRelated($url, [
            'headers' => $this->getHeaders(),
            'multipart' => $parts,
        ]);
    }

    /**
     * Make a simple post request.
     *
     * @param string $url
     * @param array $options
     * @return \Psr\Http\Message\ResponseInterface
     */
    protected function post($url, $options)
    {
        return $this->http->post($url, $options);
    }

    /**
     * Make a multipart/related request.
     * Unfortunately Guzzle doesn't support multipart/related requests out of the box.
     *
     * @param $url
     * @param $options
     * @return \Psr\Http\Message\ResponseInterface
     */
    protected function postMultipartRelated($url, $options)
    {
        $headers = isset($options['headers']) ? $options['headers'] : [];

        $body = new MultipartStream($options['multipart']);

        $version = isset($options['version']) ? $options['version'] : '1.1';

        $request = new Request('POST', $url, $headers, $body, $version);

        $changeContentType['set_headers']['Content-Type'] = 'multipart/related; boundary='.$request->getBody()->getBoundary();
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}

        $request = modify_request($request, $changeContentType);

        return $this->http->send($request);
    }

    /**
     * Get common request headers.
     *
     * @return array
     */
    protected function getHeaders()
    {
        return [
            'Authorization' => 'Bearer '.$this->token,
        ];
    }
}


1			<?php
2
3			namespace NotificationChannels\HipChat;
4
5			use GuzzleHttp\Psr7\Request;
6			use GuzzleHttp\Client as HttpClient;
7			use GuzzleHttp\Psr7\MultipartStream;
8			use function GuzzleHttp\Psr7\stream_for;
9			use function GuzzleHttp\Psr7\modify_request;
10
11			class HipChat
12			{
13			/** @var string */
14			protected $token;
15
16			/** @var HttpClient */
17			protected $http;
18
19			/** @var string */
20			protected $url;
21
22			/** @var string */
23			protected $room;
24
25			/**
26			* @param HttpClient $http
27			* @param string $token
28			* @param string\|null $url
29			*/
30			public function __construct(HttpClient $http, $url, $token, $room)
31			{
32			$this->http = $http;
33			$this->url = rtrim($url ?: 'https://api.hipchat.com', '/');
34			$this->token = $token;
35			$this->room = $room;
36			}
37
38			/**
39			* Returns default room id or name.
40			*
41			* @return string
42			*/
43			public function room()
44			{
45			return $this->room;
46			}
47
48			/**
49			* Returns HipChat base url.
50			*
51			* @return string
52			*/
53			public function url()
54			{
55			return $this->url;
56			}
57
58			/**
59			* Set the HipChat token to use.
60			*
61			* @param string
62			*/
63			public function token($token)
64			{
65			$this->token = $token;
66			}
67
68			/**
69			* Send a message.
70			*
71			* @param string\|int $to
72			* @param array $message
73			* @return \Psr\Http\Message\ResponseInterface
74			*/
75			public function sendMessage($to, $message)
76			{
77			$url = $this->url.'/v2/room/'.urlencode($to).'/notification';
78
79			return $this->post($url, [
80			'headers' => $this->getHeaders(),
81			'json' => $message,
82			]);
83			}
84
85			/**
86			* Share a file.
87			*
88			* @param string\|int $to
89			* @param array $file
90			* @return \Psr\Http\Message\ResponseInterface
91			*/
92			public function shareFile($to, $file)
93			{
94			$parts[] = [
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-08-16 21:19 UTC by Report Bug Copy Issue Report `$parts` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$parts = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
95			'headers' => [
96			'Content-Type' => $file['file_type'] ?: 'application/octet-stream',
97			],
98			'name' => 'file',
99			'contents' => stream_for($file['content']),
100			'filename' => $file['filename'] ?: 'untitled',
101			];
102
103			if (! empty($file['message'])) {
104			$parts[] = [
105			'headers' => [
106			'Content-Type' => 'application/json',
107			],
108			'name' => 'metadata',
109			'contents' => json_encode(['message' => $file['message']]),
110			];
111			}
112
113			$url = $this->url.'/v2/room/'.urlencode($to).'/share/file';
114
115			return $this->postMultipartRelated($url, [
116			'headers' => $this->getHeaders(),
117			'multipart' => $parts,
118			]);
119			}
120
121			/**
122			* Make a simple post request.
123			*
124			* @param string $url
125			* @param array $options
126			* @return \Psr\Http\Message\ResponseInterface
127			*/
128			protected function post($url, $options)
129			{
130			return $this->http->post($url, $options);
131			}
132
133			/**
134			* Make a multipart/related request.
135			* Unfortunately Guzzle doesn't support multipart/related requests out of the box.
136			*
137			* @param $url
138			* @param $options
139			* @return \Psr\Http\Message\ResponseInterface
140			*/
141			protected function postMultipartRelated($url, $options)
142			{
143			$headers = isset($options['headers']) ? $options['headers'] : [];
144
145			$body = new MultipartStream($options['multipart']);
146
147			$version = isset($options['version']) ? $options['version'] : '1.1';
148
149			$request = new Request('POST', $url, $headers, $body, $version);
150
151			$changeContentType['set_headers']['Content-Type'] = 'multipart/related; boundary='.$request->getBody()->getBoundary();
			0 ignored issues – show Coding Style Comprehensibility introduced 2016-08-16 21:19 UTC by Report Bug Copy Issue Report `$changeContentType` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$changeContentType = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
152
153			$request = modify_request($request, $changeContentType);
154
155			return $this->http->send($request);
156			}
157
158			/**
159			* Get common request headers.
160			*
161			* @return array
162			*/
163			protected function getHeaders()
164			{
165			return [
166			'Authorization' => 'Bearer '.$this->token,
167			];
168			}
169			}
170

laravel-notification-channels / hipchat

Pull Request — master (#17)

HipChat::url() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like