emilong / hubot-google-images

A hubot script that interacts with the Google Images API

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

hubot-google-images

A hubot script that interacts with the Google Images API for greater productivity and lulz.

See src/google-images.coffee for full documentation.

Installation

In hubot project repo, run:

npm install hubot-google-images --save

Then add hubot-google-images to your external-scripts.json:

[
  "hubot-google-images"
]

Configuration

Custom Search Engine

Set environment variables HUBOT_GOOGLE_CSE_ID and HUBOT_GOOGLE_CSE_KEY to use the Google Custom Search API instead of the deprecated image search API.

You might want to use the custom search API if you have concerns about seeing NSFW images. The old Google image search API only has safe=active which is not as strict as safe=strict on the new API.

The Custom Search API provides up to 100 search queries per day for free. If you need more than that you'll have to pay.

CSE setup details

  1. Create a CSE via these instructions.
  2. Turn on images in Edit Search Engine > Setup > Basic > Image Search
  3. Get the CSE ID in Edit Search Engine > Setup > Basic > Details (via these instructions)
  4. Get the CSE KEY here https://code.google.com/apis/console
  5. Update your conf (and your modules if necessary)

Custom Mustachification Service

If you want to run you own instance instead of the default mustachify, you can add HUBOT_MUSTACHIFY_URL to your environment variables and provide your own url. More info and the source code of mustachify can be found at https://github.com/afeld/mustachio

Sample Interaction

user1>> hubot image me bananas
hubot>> http://upload.wikimedia.org/wikipedia/commons/4/4c/Bananas.jpg
user2>> hubot animate me it's happening
hubot>> http://i.kinja-img.com/gawker-media/image/upload/s--8U6TKXoi--/thfydh8egnt8he5esoz8.gif
user3>> hubot mustache me family portrait
hubot>> http://mustachify.me/1?src=http://www.daviddanielsphotography.com/wp-content/uploads/2013/03/Chowen-Family-Portraits-east-of-Park-City-13.jpg

About

A hubot script that interacts with the Google Images API


Languages

Language:CoffeeScript 78.0%Language:JavaScript 15.1%Language:Shell 7.0%