/
search.coffee
156 lines (137 loc) · 5.6 KB
/
search.coffee
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
# Description
# Universal Search Engine
#
# Currently supports:
# - Google Custom Search
# - Bing Search API
# - Azure Marketplace - Bing Search API v2
# - Microsoft Cognitive Services - Bing Search API v5
#
# Configuration:
# GOOGLE_API_KEY
# GOOGLE_CUSTOM_SEARCH
# BING_SEARCH_API_KEY
# USE_BING_V5
#
# Commands:
# hubot <search|google> <query> - Queries Google Custom Search for <query>, and returns the first 5 results
# hubot bing <query> - Queries Bing Search API for <query>, and returns the first 5 results
#
# Author:
# MrSaints
GOOGLE_API_KEY = process.env.GOOGLE_API_KEY
GOOGLE_CUSTOM_SEARCH = process.env.GOOGLE_CUSTOM_SEARCH
BING_SEARCH_API_KEY = process.env.BING_SEARCH_API_KEY
USE_BING_V5 = process.env.USE_BING_V5
MAX_RESULTS = process.env.MAX_SEARCH_RESULTS or 5
DEF_SERVER_ERROR = "I'm unable to process your request at this time due to a server error. Please try again later."
class ISearch
constructor: (@robot) ->
search: (query, cb) ->
if query.length < 1
cb "Please provide a valid search query."
@_search query, (err, httpRes, body) =>
@robot.logger.debug "hubot-search: #{body}"
if err or (httpRes.statusCode isnt 200 and err = "server did not return HTTP 200")
@robot.logger.error "hubot-search: #{err} (#{httpRes.statusCode})"
else
try
data = JSON.parse body
if not @_hasResults(data)
cb "No results were found using search query: \"#{query}\". Please try a different query."
else
cb @_format(data)
return
catch error
@robot.logger.error "hubot-search: #{error}"
cb DEF_SERVER_ERROR
_search: (query, cb) ->
@robot.logger.error "_search is not implemented"
_hasResults: (data) ->
@robot.logger.error "_hasResults is not implemented"
_format: (data) ->
@robot.logger.error "_format is not implemented"
# Google Custom Search
class GoogleSearch extends ISearch
_search: (query, cb) ->
@robot.logger.info "hubot-search: using Google Custom Search"
params =
key: GOOGLE_API_KEY
cx: GOOGLE_CUSTOM_SEARCH
num: MAX_RESULTS
q: query
@robot.http("https://www.googleapis.com/customsearch/v1")
.header("content-type", "application/json")
.query(params)
.get() cb
_hasResults: (data) ->
data.searchInformation.totalResults > 0
_format: (data) ->
results = ""
for result, i in data.items
results += "#{i+1}. #{result.title}: #{result.snippet} (#{result.link})\n"
results += "About #{data.searchInformation.formattedTotalResults} results (#{data.searchInformation.formattedSearchTime} seconds)."
results
# Azure Marketplace - Bing Search API v2
class BingSearch extends ISearch
_search: (query, cb) ->
@robot.logger.info "hubot-search: using Azure Marketplace - Bing Search API v2 (Web Results Only)"
opts =
auth: "#{BING_SEARCH_API_KEY}:#{BING_SEARCH_API_KEY}"
params =
$format: "json"
$top: MAX_RESULTS
Query: "'#{query}'"
# @robot.logger.debug "hubot-search: Bing Search API v2 params : #{params}"
@robot.http("https://api.datamarket.azure.com/Bing/SearchWeb/v1/Web", opts)
.header("content-type", "application/json")
.query(params)
.get() cb
_hasResults: (data) ->
data.d?.results?.length > 0
_format: (data) ->
results = ""
for result, i in data.d.results
results += "#{i+1}. #{result.Title}: #{result.Description} (#{result.Url})\n"
results
# Microsoft Cognitive Services - Bing Search API v5
class BingSearchV5 extends ISearch
_search: (query, cb) ->
@robot.logger.info "hubot-search: using Microsoft Cognitive Services - Bing Search API v5 (Web only)"
params =
q: query
count: MAX_RESULTS
@robot.http("https://api.cognitive.microsoft.com/bing/v5.0/search")
.header("content-type", "application/json")
.header("Ocp-Apim-Subscription-Key", BING_SEARCH_API_KEY)
.query(params)
.get() cb
_hasResults: (data) ->
data.webPages?.totalEstimatedMatches > 0
_format: (data) ->
results = ""
for result, i in data.webPages.value
results += "#{i+1}. #{result.name}: #{result.snippet} (#{result.url})\n"
results
module.exports = (robot) ->
# Listener: Google Custom Search
if GOOGLE_API_KEY? and GOOGLE_CUSTOM_SEARCH?
google = new GoogleSearch robot
robot.respond /(search|google) (.+)/i, id: "search.google", (res) =>
q = res.match[2]
google.search q, (results) =>
res.send results
else
robot.logger.warning "hubot-search: Missing GOOGLE_API_KEY or GOOGLE_CUSTOM_SEARCH in environment. Google Custom Search will not be available."
# Listener: Bing Search API
if BING_SEARCH_API_KEY?
bing = new BingSearch robot
# Use Bing Search API v5 if enabled, otherwise use legacy v2
if USE_BING_V5?
bing = new BingSearchV5 robot
robot.respond /bing (.+)/i, id: "search.bing", (res) =>
q = res.match[1]
bing.search q, (results) =>
res.send results
else
robot.logger.warning "hubot-search: Missing BING_SEARCH_API_KEY in environment. Bing Search API will not be available."