google-cse 1.0.1

data/.gitignore

@@ -0,0 +1,11 @@
+*.gem
+*.rbc
+.tmproj
+.bundle
+.config
+.rvmrc
+.rspec
+pkg
+rdoc
+spec/reports
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-18mode
+  - jruby-19mode
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in google-cse.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    google-cse (0.0.1)
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.1.3)
+    fuubar (1.1.0)
+      rspec (~> 2.0)
+      rspec-instafail (~> 0.2.0)
+      ruby-progressbar (~> 1.0.0)
+    json (1.7.6)
+    rspec (2.12.0)
+      rspec-core (~> 2.12.0)
+      rspec-expectations (~> 2.12.0)
+      rspec-mocks (~> 2.12.0)
+    rspec-core (2.12.2)
+    rspec-expectations (2.12.1)
+      diff-lcs (~> 1.1.3)
+    rspec-instafail (0.2.4)
+    rspec-mocks (2.12.2)
+    ruby-progressbar (1.0.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fuubar
+  google-cse!
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Achilles Charmpilas
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# google-cse [![Build Status](https://travis-ci.org/Achillefs/google-cse.png?branch=master)](https://travis-ci.org/Achillefs/google-cse)
+
+A wee Google CSE client. Use it to easily query your custom search engine. Supports image search.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'google-cse'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install google-cse
+
+## Usage
+
+Set it up:
+
+    require 'google_cse'
+	GoogleCSE::CX = 'a-cse-identifier'
+	GoogleCSE::KEY = 'a-googleapis-app-key'
+
+If you are on a rails app, you should stick the constants in an initializer
+
+Run a search and visit the first result, 'feeling lucky' style (on a mac):
+
+    g = GoogleCSE.search('Ian Kilminster')
+    `open -a Safari #{g.fetch.results.first.link}`
+
+Do the same for an image:
+
+	g = GoogleCSE.image_search('Ian Kilminster')
+	img = g.fetch.results.first.link
+	file = img.split('/').last
+	File.open(file,'w') {|f| f.write(open(img).read)} 
+    `open -a Preview #{file}`
+
+## Contributing
+
+  1. Fork it
+  2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Commit your changes (`git commit -am 'Add some feature'`)
+  4. Push to the branch (`git push origin my-new-feature`)
+  5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/google-cse.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'google_cse/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "google-cse"
+  gem.version       = GoogleCSE::VERSION
+  gem.authors       = ["Achilles Charmpilas"]
+  gem.email         = ["ac@humbuckercode.co.uk"]
+  gem.description   = %q{A wee Google CSE client}
+  gem.summary       = %q{A wee Google CSE client. Use it to easily query your custom search engine. Supports image search.}
+  gem.homepage      = "http://humbuckercode.co.uk/licks/gems/google-cse"
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+  
+  gem.add_dependency('json')
+  gem.add_development_dependency('rspec')
+  gem.add_development_dependency('fuubar')
+end

data/lib/google_cse.rb

@@ -0,0 +1,44 @@
+require "google_cse/query"
+require "google_cse/result"
+require "google_cse/version"
+
+module GoogleCSE
+  class MissingKey < StandardError
+    def initialize
+      super "You need to specify a Google CSE Key (GoogleCSE::KEY = 'my-key-goes-here')"
+    end
+  end
+  
+  class MissingCX < StandardError
+    def initialize
+      super "You need to specify a Google CSE CX (GoogleCSE::CX = 'my-cx-goes-here')"
+    end
+
+  end
+  
+  def self.search query, params = {}
+    query({:q => query}.merge(params))
+  end
+  
+  def self.image_search query, params = {}
+    query({:searchType => :image, :q => query}.merge(params))
+  end
+
+private
+  def self.query params
+    begin
+      Query.new(:params => default_params.merge(params))
+    rescue NameError => e
+      case e.message
+      when 'uninitialized constant GoogleCSE::CX' 
+        raise MissingCX
+      when 'uninitialized constant GoogleCSE::KEY'
+        raise MissingKey
+      end
+    end
+  end
+  
+  def self.default_params
+    { :cx => CX, :key => KEY }
+  end
+end

data/lib/google_cse/query.rb

@@ -0,0 +1,67 @@
+require 'json'
+require 'cgi'
+require 'open-uri'
+
+module GoogleCSE
+  class Query
+    @@endpoint = 'https://www.googleapis.com/customsearch/v1'
+    attr_accessor :params, :results, :info, :response, :current_index, :total, :per_page, :time
+  
+    def initialize opts = {}
+      opts.map {|k,v| send(:"#{k}=",v)}
+    end
+  
+    def search_uri
+      "#{@@endpoint}?#{params.map {|k,v|"#{k}=#{CGI.escape(v.to_s)}"}.join('&')}"
+    end
+  
+    def fetch
+      @response = JSON.parse(open(search_uri).read)
+      parse_response!
+      self
+    end
+  
+    def fetch!
+      fetch
+      nil
+    end
+    
+    def next
+      if next?
+        @params.merge!({:start => @next_page_params.first['startIndex']})
+        fetch        
+      end
+    end
+    
+    def previous
+      if previous?
+        @params.merge!({:start => @prev_page_params.first['startIndex']})
+        fetch
+      end
+    end
+    
+    def next?
+      !(@next_page_params.nil? || @next_page_params.empty?)
+    end
+    
+    def previous?
+      !(@prev_page_params.nil? || @prev_page_params.empty?)
+    end
+    
+    def page
+      (current_index / per_page.to_f).ceil
+    end
+    
+    def parse_response!
+      @results = @response['items'].map { |i| Result.new(i) }
+      @next_page_params = @response['queries']['nextPage']
+      @prev_page_params = @response['queries']['previousPage']
+      @info = @response['searchInformation']
+      @total = @info['totalResults'].to_i
+      @time = @info['searchTime'].to_f
+      @per_page = @response['queries']['request'].first['count'].to_i
+      @current_index = @response['queries']['request'].first['startIndex'].to_i
+      nil
+    end
+  end
+end

data/lib/google_cse/result.rb

@@ -0,0 +1,16 @@
+module GoogleCSE
+  class Result < Hash
+    def initialize(hash = {}, default = nil, &block)
+      default ? super(default) : super(&block)
+      update(hash)
+    end
+        
+    def method_missing name, *args, &block
+      if self.key?(name.to_s)
+        self[name.to_s]
+      else
+        super
+      end
+    end
+  end
+end

data/lib/google_cse/version.rb

@@ -0,0 +1,3 @@
+module GoogleCSE
+  VERSION = "1.0.1"
+end

data/spec/files/google_image_search.txt

@@ -0,0 +1,239 @@
+{
+ "kind": "customsearch#search",
+ "url": {
+  "type": "application/json",
+  "template": "https://www.googleapis.com/customsearch/v1?q={searchTerms}&num={count?}&start={startIndex?}&lr={language?}&safe={safe?}&cx={cx?}&cref={cref?}&sort={sort?}&filter={filter?}&gl={gl?}&cr={cr?}&googlehost={googleHost?}&c2coff={disableCnTwTranslation?}&hq={hq?}&hl={hl?}&siteSearch={siteSearch?}&siteSearchFilter={siteSearchFilter?}&exactTerms={exactTerms?}&excludeTerms={excludeTerms?}&linkSite={linkSite?}&orTerms={orTerms?}&relatedSite={relatedSite?}&dateRestrict={dateRestrict?}&lowRange={lowRange?}&highRange={highRange?}&searchType={searchType}&fileType={fileType?}&rights={rights?}&imgSize={imgSize?}&imgType={imgType?}&imgColorType={imgColorType?}&imgDominantColor={imgDominantColor?}&alt=json"
+ },
+ "queries": {
+  "nextPage": [
+   {
+    "title": "Google Custom Search - ian kilminster",
+    "totalResults": "72800",
+    "searchTerms": "ian kilminster",
+    "count": 10,
+    "startIndex": 11,
+    "inputEncoding": "utf8",
+    "outputEncoding": "utf8",
+    "safe": "off",
+    "cx": "004660295420853704579:8tths02yqhc",
+    "searchType": "image"
+   }
+  ],
+  "request": [
+   {
+    "title": "Google Custom Search - ian kilminster",
+    "totalResults": "72800",
+    "searchTerms": "ian kilminster",
+    "count": 10,
+    "startIndex": 1,
+    "inputEncoding": "utf8",
+    "outputEncoding": "utf8",
+    "safe": "off",
+    "cx": "004660295420853704579:8tths02yqhc",
+    "searchType": "image"
+   }
+  ]
+ },
+ "context": {
+  "title": "Xegesis Images"
+ },
+ "searchInformation": {
+  "searchTime": 0.375924,
+  "formattedSearchTime": "0.38",
+  "totalResults": "72800",
+  "formattedTotalResults": "72,800"
+ },
+ "items": [
+  {
+   "kind": "customsearch#result",
+   "title": "Celebrity picks for Derby Dead Pool 2013: K",
+   "htmlTitle": "Celebrity picks for Derby Dead Pool 2013: K",
+   "link": "http://www.derbydeadpool.co.uk/images/celebs/k/kilmii.jpg",
+   "displayLink": "www.derbydeadpool.co.uk",
+   "snippet": "[Picture of Ian Kilminster]",
+   "htmlSnippet": "[Picture of \u003cb\u003eIan Kilminster\u003c/b\u003e]",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://www.derbydeadpool.co.uk/deadpool2013/celebs_K.html",
+    "height": 150,
+    "width": 127,
+    "byteSize": 4291,
+    "thumbnailLink": "https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcTl-e4dlEB7YNXjHBozsY6OuasoeI9XRFV8EoBjV2JY__Oizoo4ohc6NXI",
+    "thumbnailHeight": 96,
+    "thumbnailWidth": 81
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "Motörhead's Lemmy in Nazi photoshoot scandal | Music | guardian.",
+   "htmlTitle": "Motörhead's Lemmy in Nazi photoshoot scandal | Music | guardian.",
+   "link": "http://static.guim.co.uk/sys-images/Music/Pix/pictures/2008/07/11/Lemmy372.jpg",
+   "displayLink": "www.guardian.co.uk",
+   "snippet": "Ian \"Lemmy\" Kilmister may",
+   "htmlSnippet": "\u003cb\u003eIan\u003c/b\u003e "Lemmy" \u003cb\u003eKilmister\u003c/b\u003e may",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://www.guardian.co.uk/music/2008/jul/11/news.culture",
+    "height": 192,
+    "width": 372,
+    "byteSize": 24316,
+    "thumbnailLink": "https://encrypted-tbn2.gstatic.com/images?q=tbn:ANd9GcTYAFrCLbG7UyIdwJplLpJSCrXRLeUHRleI9m6c0zW-wZjTgHe9hzq9GQ",
+    "thumbnailHeight": 63,
+    "thumbnailWidth": 122
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "Hard Rock, Pop, Heavy Metal 1980-",
+   "htmlTitle": "Hard Rock, Pop, Heavy Metal 1980-",
+   "link": "http://web.bryant.edu/~ehu/h364proj/sprg_98/guidice/1980s/motorhead.JPG",
+   "displayLink": "web.bryant.edu",
+   "snippet": "of the trio Ian Kilminster",
+   "htmlSnippet": "of the trio \u003cb\u003eIan Kilminster\u003c/b\u003e",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://web.bryant.edu/~ehu/h364proj/sprg_98/guidice/1980s/1980s.htm",
+    "height": 225,
+    "width": 302,
+    "byteSize": 65145,
+    "thumbnailLink": "https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcTWUpDFVdB-40rkzNzSl55MPTzqfKsFE8SxgGMsrn0VPlnc26WaoQiyfgw",
+    "thumbnailHeight": 86,
+    "thumbnailWidth": 116
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "This is my Hollywood!",
+   "htmlTitle": "This is my Hollywood!",
+   "link": "http://tampasm.tripod.com/Me/lemmy.jpg",
+   "displayLink": "tampasm.tripod.com",
+   "snippet": "IAN KILMINSTER!",
+   "htmlSnippet": "\u003cb\u003eIAN KILMINSTER\u003c/b\u003e!",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://tampasm.tripod.com/Me/me.htm",
+    "height": 340,
+    "width": 315,
+    "byteSize": 21970,
+    "thumbnailLink": "https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcTfVjkRW3OVVzZq6jRb9aIYG34aiVvX16SvOJz-95TSIr69_zyco7AHuR0",
+    "thumbnailHeight": 119,
+    "thumbnailWidth": 110
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "A-150-1226750-1233004263.jpeg",
+   "htmlTitle": "A-150-1226750-1233004263.jpeg",
+   "link": "http://s.discogss.com/image/A-150-1226750-1233004263.jpeg",
+   "displayLink": "www.discogs.com",
+   "snippet": "Ian Fraser Kilmister",
+   "htmlSnippet": "\u003cb\u003eIan\u003c/b\u003e Fraser \u003cb\u003eKilmister\u003c/b\u003e",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://www.discogs.com/artist/Ian+Fraser+Kilmister",
+    "height": 100,
+    "width": 150,
+    "byteSize": 3869,
+    "thumbnailLink": "https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcQfQxt-YGPiiX9CZK2TQEF2Ge1s-9qXoAj7Sp7yYCasLFCeZ0uAdW3xzg",
+    "thumbnailHeight": 64,
+    "thumbnailWidth": 96
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "Fame & Fortune: Jethro Tull's Ian Anderson - Telegraph",
+   "htmlTitle": "Fame & Fortune: Jethro Tull's \u003cb\u003eIan\u003c/b\u003e Anderson - Telegraph",
+   "link": "http://i.telegraph.co.uk/multimedia/archive/01470/PF-JethroTull_1470859c.jpg",
+   "displayLink": "www.telegraph.co.uk",
+   "snippet": "Ian Anderson of Jethro Tull",
+   "htmlSnippet": "\u003cb\u003eIan\u003c/b\u003e Anderson of Jethro Tull",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://www.telegraph.co.uk/finance/personalfinance/fameandfortune/6102159/Fame-and-Fortune-Jethro-Tulls-Ian-Anderson.html",
+    "height": 288,
+    "width": 460,
+    "byteSize": 25146,
+    "thumbnailLink": "https://encrypted-tbn2.gstatic.com/images?q=tbn:ANd9GcTwbZEWgH3YGAN0daw9cTG9LBmVEiA_aFNhK3K50GWDRmzSORZKt6gRocg",
+    "thumbnailHeight": 80,
+    "thumbnailWidth": 128
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "SibLINGSHOT ON THE BLEACHERS: December 2010",
+   "htmlTitle": "SibLINGSHOT ON THE BLEACHERS: December 2010",
+   "link": "http://3.bp.blogspot.com/_FKxj7S66vU4/TRev6mE7PrI/AAAAAAAAF3E/tuYtW02jMf4/s320/asshole",
+   "displayLink": "www.siblingshot.com",
+   "snippet": "Written by Ian Kilminster.",
+   "htmlSnippet": "Written by \u003cb\u003eIan Kilminster\u003c/b\u003e.",
+   "mime": "image/",
+   "fileFormat": "Image Document",
+   "image": {
+    "contextLink": "http://www.siblingshot.com/2010_12_01_archive.html",
+    "height": 320,
+    "width": 320,
+    "byteSize": 28365,
+    "thumbnailLink": "https://encrypted-tbn0.gstatic.com/images?q=tbn:ANd9GcSshKEPebT1AUpl65KlNUy-NwYdxl6X3Nk2FRJ4TAJ8abBXC6_bMJVZg6g",
+    "thumbnailHeight": 118,
+    "thumbnailWidth": 118
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "Lemmy bass tabs and techniques",
+   "htmlTitle": "Lemmy bass tabs and techniques",
+   "link": "http://www.guitarmagazine.co.uk/img_cache/tagged/400/716693b4-2937-11e0-9e31-002215530376.jpg",
+   "displayLink": "www.guitarmagazine.co.uk",
+   "snippet": "Born Ian Fraser Kilminster",
+   "htmlSnippet": "Born \u003cb\u003eIan\u003c/b\u003e Fraser \u003cb\u003eKilminster\u003c/b\u003e",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://www.guitarmagazine.co.uk/articles/lemmy-bass-tabs-and-techniques/",
+    "height": 574,
+    "width": 400,
+    "byteSize": 27523,
+    "thumbnailLink": "https://encrypted-tbn3.gstatic.com/images?q=tbn:ANd9GcRu7rPpgD_c6F_Dlupouoq1QUic2teJ2fVX1CdHlbbyYPfyy1MJoIPgoZsW",
+    "thumbnailHeight": 134,
+    "thumbnailWidth": 93
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "Experts | Wimborne Food Festival - October 27th & 28th 2012 | A ...",
+   "htmlTitle": "Experts | Wimborne Food Festival - October 27th & 28th 2012 | A \u003cb\u003e...\u003c/b\u003e",
+   "link": "http://www.wimbornefoodfestival.co.uk/images/expert-ian-gibbs.jpg",
+   "displayLink": "www.wimbornefoodfestival.co.uk",
+   "snippet": "Ian Gibbs",
+   "htmlSnippet": "\u003cb\u003eIan\u003c/b\u003e Gibbs",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://www.wimbornefoodfestival.co.uk/experts.php",
+    "height": 205,
+    "width": 150,
+    "byteSize": 18387,
+    "thumbnailLink": "https://encrypted-tbn2.gstatic.com/images?q=tbn:ANd9GcSBraI2afwJXWYLiaUljFpyM-CkkXJr8vULn31Rvp7iUc4CM7HSdySePw",
+    "thumbnailHeight": 105,
+    "thumbnailWidth": 77
+   }
+  },
+  {
+   "kind": "customsearch#result",
+   "title": "RockUnited Reviews",
+   "htmlTitle": "RockUnited Reviews",
+   "link": "http://www.rockunited.com/lemmythemovie.jpg",
+   "displayLink": "www.rockunited.com",
+   "snippet": "Ian Kilminster, Lemmy to you",
+   "htmlSnippet": "\u003cb\u003eIan Kilminster\u003c/b\u003e, Lemmy to you",
+   "mime": "image/jpeg",
+   "image": {
+    "contextLink": "http://www.rockunited.com/reviews2010_10_12.htm",
+    "height": 250,
+    "width": 175,
+    "byteSize": 13393,
+    "thumbnailLink": "https://encrypted-tbn1.gstatic.com/images?q=tbn:ANd9GcSQPkTAdf-vPnZzuK6h0h5ROVB9vUKE5Q53rOYNHp4lYj3FN-R5goSt7g",
+    "thumbnailHeight": 111,
+    "thumbnailWidth": 78
+   }
+  }
+ ]
+}