GorkaLaucirica\HipchatAPIv2Client\API\RoomAPI

Complexity

Total Complexity

18

Size/Duplication

Total Lines	232
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	4

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getRooms()	0	10	2
A	getRoom()	0	6	1
A	getRecentHistory()	0	10	2
A	createRoom()	0	6	1
A	updateRoom()	0	4	1
A	deleteRoom()	0	4	1
A	sendRoomNotification()	0	5	1
A	addMember()	0	4	1
A	removeMember()	0	4	1
A	inviteUser()	0	4	1
A	setTopic()	0	4	1
A	createWebhook()	0	6	1
A	deleteWebhook()	0	4	1
A	getAllWebhooks()	0	10	2

<?php

namespace GorkaLaucirica\HipchatAPIv2Client\API;

use GorkaLaucirica\HipchatAPIv2Client\Client;
use GorkaLaucirica\HipchatAPIv2Client\Model\Message;
use GorkaLaucirica\HipchatAPIv2Client\Model\Room;
use GorkaLaucirica\HipchatAPIv2Client\Model\Webhook;


class RoomAPI
{
    /** @var Client */
    protected $client;

    /**
     * Room api constructor
     *
     * @param Client $client that will be used to connect the server
     */
    public function __construct(Client $client)
    {
        $this->client = $client;
    }

    /**
     * List non-archived rooms for this group
     * More info: https://www.hipchat.com/docs/apiv2/method/get_all_rooms
     *
     * @param array $params Query string parameter(s), for example: array('max-results' => 30)
     *
     * @return array
     */
    public function getRooms($params = array())
    {
        $response = $this->client->get("/v2/room", $params);

        $rooms = array();
        foreach ($response['items'] as $response) {
            $rooms[] = new Room($response);
        }
        return $rooms;
    }

    /**
     * Gets room by id or name
     * More info: https://www.hipchat.com/docs/apiv2/method/get_room
     *
     * @param string $id The id or name of the room
     *
     * @return Room
     */
    public function getRoom($id)
    {
        $response = $this->client->get("/v2/room/$id");

        return new Room($response);
    }

    /**
     * Fetch latest chat history for this room.
     * More info: https://www.hipchat.com/docs/apiv2/method/view_recent_room_history
     *
     * @param string $id The id or name of the room
     * @param array $params Query string parameter(s), for example: array('max-results' => 30)
     *
     * @return array
     */
    public function getRecentHistory($id, $params = array())
    {
        $response = $this->client->get(sprintf('/v2/room/%s/history/latest', $id), $params);

        $messages = array();
        foreach ($response['items'] as $response) {
            $messages[] = new Message($response);
        }
        return $messages;
    }

    /**
     * Creates a room
     * More info: https://www.hipchat.com/docs/apiv2/method/create_room
     *
     * @param Room $room New room to be persisted
     *
     * @return integer Just created room id
     */
    public function createRoom(Room $room)
    {
        $response = $this->client->post("/v2/room", $room->toJson());

        return $response['id'];
    }

    /**
     * Updates a room
     * More info: https://www.hipchat.com/docs/apiv2/method/update_room
     *
     * @param Room $room Existing room to be updated
     *
     * @return void
     */
    public function updateRoom(Room $room)
    {
        $this->client->put(sprintf("/v2/room/%s", $room->getId()), $room->toJson());
    }

    /**
     * Deletes a room and kicks the current participants.
     * More info: https://www.hipchat.com/docs/apiv2/method/delete_room
     *
     * @param string $id The id or name of the room.
     *
     * @return void
     */
    public function deleteRoom($id)
    {
        $this->client->delete(sprintf('/v2/room/%s', $id));
    }

    /**
     * Send a room a notification
     * More info: https://www.hipchat.com/docs/apiv2/method/send_room_notification
     *
     * @param string $id The id or name of the room
     * @param Message $message The message to be sent
     *
     * @return void
     */
    public function sendRoomNotification($id, Message $message)
    {
        $id = rawurlencode($id);
        $this->client->post("/v2/room/$id/notification", $message->toJson());
    }

    /**
     * Adds a member to a private room
     * More info: https://www.hipchat.com/docs/apiv2/method/add_member
     *
     * @param string $roomId The id or name of the room
     * @param string $memberId The id, email address, or mention name (beginning with an '@') of the user
     *
     * @return void
     */
    public function addMember($roomId, $memberId)
    {
        $this->client->put(sprintf('/v2/room/%s/member/%s', $roomId, $memberId));
    }

    /**
     * Removes a member from a private room.
     * More info: https://www.hipchat.com/docs/apiv2/method/remove_member
     *
     * @param string $roomId The id, email address, or mention name (beginning with an '@') of the user
     * @param string $memberId The id or name of the room
     *
     * @return void
     */
    public function removeMember($roomId, $memberId)
    {
        $this->client->delete(sprintf('/v2/room/%s/member/%s', $roomId, $memberId));
    }

    /**
     * Invites a member to a public room
     * More info: https://www.hipchat.com/docs/apiv2/method/invite_user
     *
     * @param string $roomId The id or name of the room
     * @param string $memberId The id, email address, or mention name (beginning with an '@') of the user
     * @param string $reason The message displayed to a user when they are invited
     *
     * @return void
     */
    public function inviteUser($roomId, $memberId, $reason)
    {
        $this->client->post(sprintf('/v2/room/%s/invite/%s', $roomId, $memberId), array('reason' => $reason));
    }

    /**
     * Set a topic on a room
     * More info: https://www.hipchat.com/docs/apiv2/method/set_topic
     *
     * @param string $roomId The id or name of the room
     * @param string $topic The topic to be set
     *
     * @return void
     */
    public function setTopic($roomId, $topic)
    {
        $this->client->put(sprintf('/v2/room/%s/topic', $roomId), array('topic' => $topic));
    }

    /**
     * Creates a new webhook
     * More info: https://www.hipchat.com/docs/apiv2/method/create_webhook
     *
     * @param string $roomId The id or name of the room
     * @param Webhook $webhook The webhook to create
     *
     * @return int Just created webhook id
     */
    public function createWebhook($roomId, Webhook $webhook)
    {
        $response = $this->client->post(sprintf('/v2/room/%s/webhook', $roomId), $webhook->toJson());

        return $response['id'];
    }

    /**
     * Deletes a new webhook
     * More info: https://www.hipchat.com/docs/apiv2/method/delete_webhook
     *
     * @param string $roomId The id or name of the room
     * @param string $webhookId The id of the webhook to delete
     *
     * @return void
     */
    public function deleteWebhook($roomId, $webhookId)
    {
        $this->client->delete(sprintf('/v2/room/%s/webhook/%s', $roomId, $webhookId));
    }

    /**
     * Gets all webhooks for this room
     * More info: https://www.hipchat.com/docs/apiv2/method/get_all_webhooks
     *
     * @param string $roomId The id or name of the room
     *
     * @TODO should return a Collection
     * @return array Array of Webhook
     */
    public function getAllWebhooks($roomId)
    {
        $webhooks = array();
        $response = $this->client->get(sprintf('/v2/room/%s/webhook', $roomId));
        foreach ($response['items'] as $item) {
            $webhooks[] = new Webhook($item);
        }

        return $webhooks;
    }
}