summaryrefslogtreecommitdiff
path: root/plugins/Irc/extlib/phergie/Phergie/Plugin/BeerScore.php
blob: 16c671f683d5d4264315562ae3b68d056fb4402f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
<?php
/**
 * Phergie 
 *
 * PHP version 5
 *
 * LICENSE
 *
 * This source file is subject to the new BSD license that is bundled
 * with this package in the file LICENSE.
 * It is also available through the world-wide-web at this URL:
 * http://phergie.org/license
 *
 * @category  Phergie 
 * @package   Phergie_Plugin_BeerScore
 * @author    Phergie Development Team <team@phergie.org> 
 * @copyright 2008-2010 Phergie Development Team (http://phergie.org)
 * @license   http://phergie.org/license New BSD License
 * @link      http://pear.phergie.org/package/Phergie_Plugin_BeerScore
 */

/**
 * Handles incoming requests for beer scores.
 *
 * @category Phergie 
 * @package  Phergie_Plugin_BeerScore
 * @author   Phergie Development Team <team@phergie.org> 
 * @license  http://phergie.org/license New BSD License
 * @link     http://pear.phergie.org/package/Phergie_Plugin_BeerScore
 * @uses     Phergie_Plugin_Http pear.phergie.org
 */
class Phergie_Plugin_BeerScore extends Phergie_Plugin_Abstract
{
    /**
     * Score result type
     *
     * @const string
     */
    const TYPE_SCORE = 'SCORE';

    /**
     * Search result type
     *
     * @const string
     */
    const TYPE_SEARCH = 'SEARCH';

    /**
     * Refine result type
     *
     * @const type
     */
    const TYPE_REFINE = 'REFINE';

    /**
     * Base API URL
     *
     * @const string
     */
    const API_BASE_URL = 'http://caedmon.net/beerscore/';

    /**
     * HTTP plugin
     *
     * @var Phergie_Plugin_Http
     */
    protected $http;

    /** 
     * Checks for dependencies.
     *
     * @return void
     */
    public function onLoad()
    {
        $this->http = $this->getPluginHandler()->getPlugin('Http');
    }

    /**
     * Handles beerscore commands.
     *
     * @param string $searchstring String to use in seaching for beer scores
     *
     * @return void
     */
    public function onCommandBeerscore($searchstring)
    {
        $event = $this->getEvent();
        $target = $event->getNick();
        $source = $event->getSource();

        $apiurl = self::API_BASE_URL . rawurlencode($searchstring);
        $response = $this->http->get($apiurl);

        if ($response->isError()) {
            $this->doNotice($target, 'Score not found (or failed to contact API)');
            return;
        }

        $result = $response->getContent();
        switch ($result->type) {
        case self::TYPE_SCORE:
            // small enough number to get scores
            foreach ($result->beer as $beer) {
                if ($beer->score === -1) {
                    $score = '(not rated)';
                } else {
                    $score = $beer->score;
                }
                $str 
                    = "{$target}: rating for {$beer->name}" . 
                    " = {$score} ({$beer->url})";
                $this->doPrivmsg($source, $str);
            }
            break;

        case self::TYPE_SEARCH:
            // only beer names, no scores
            $str = '';
            $found = 0;
            foreach ($result->beer as $beer) {
                if (isset($beer->score)) {
                    ++$found;
                    if ($beer->score === -1) {
                        $score = '(not rated)';
                    } else {
                        $score = $beer->score;
                    }
                    $str 
                        = "{$target}: rating for {$beer->name}" . 
                        " = {$score} ({$beer->url})";
                    $this->doPrivmsg($source, $str);
                } else {
                    $str .= "({$beer->name} -> {$beer->url}) ";
                }
            }
            $foundnum = $result->num - $found;
            $more = $found ? 'more ' : '';
            $str = "{$target}: {$foundnum} {$more}results... {$str}";
            $this->doPrivmsg($source, $str);
            break;

        case self::TYPE_REFINE:
            // Too many results; only output search URL
            if ($result->num < 100) {
                $num = $result->num;
            } else {
                $num = 'at least 100';
            }
            $resultsword = (($result->num > 1) ? 'results' : 'result');
            $str = "{$target}: {$num} {$resultsword}; {$result->searchurl}";
            $this->doPrivmsg($source, $str);
            break;
        }
    }
}