site_search 0.0.1

data/Gemfile

@@ -0,0 +1,10 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.3"
+gem "capybara", ">= 0.4.0"
+gem "launchy"
+gem "sqlite3"
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Gareth Allen
+
+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,107 @@
+# SiteSearch
+
+This gem provides a simple and extremely flexible way to include site-wide searching in Rack based web applications, such as Ruby on Rails.
+
+## Installation
+
+Install the latest stable release:
+
+	[sudo] gem install site_search
+
+In Rails, add it to your Gemfile:
+
+``` ruby
+gem 'site_search'
+```
+
+## Getting Started
+
+Start off by generating the required config and initializer files:
+
+    Rails 3
+
+	    rails generate site_search:google_custom_search
+
+	Rails 2.3
+
+	    ruby script/generate site_search:google_custom_search
+
+this should give you files in:
+
+	config/initializers/load_site_search_config.rb
+	config/google_custom_search.yml
+
+## Configuring SiteSearch
+
+SiteSearch currently only supports Google Custom Search and allows for multiple search engines to be configured and utilized.
+
+Edit the google_custom_search.yml file in config/
+
+``` yaml
+production:
+  api_key: "YOUR-API-KEY"
+  search_engines:
+    your_search_engine:
+        cx: "YOUR-CX-RECORD"
+```
+
+An initializer file is required to load the config settings, if you're using Rails, one is created for you:
+
+## Using SiteSearch
+
+In your controller create an instance of the GoogleSearch class by passing the name of the search engine and the search arguments:
+
+``` ruby
+@search = SiteSearch::GoogleSearch.new(:your_search_engine, params[:query_string])
+```
+
+You can then access the results in the view like so:
+
+``` ruby
+<% @search.results.each do |result| %>
+    <%= results.title %>
+    <%= result.text %>
+    <%= result.url %>
+<% end %>
+```
+
+You can also access the raw document that is received from the Google Custom Search API.
+
+``` ruby
+@search.raw
+```
+
+The GoogleSearch class also accepts a optional parameters, for example the alt parameter for specifying the format
+of the response, can either be json(default) or atom.
+
+``` ruby
+@search = SiteSearch::GoogleSearch.new(:your_search_engine, params[:query_string], {:alt=>'atom'})
+```
+
+## Contributing to SiteSearch
+
+Contributions are appreciated and pull requests are very welcome. Before submitting a pull request,
+please make sure that your changes are well tested.
+
+## License
+
+Copyright (c) 20011 Gareth Allen
+
+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/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SiteSearch'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/generators/site_search/USAGE

@@ -0,0 +1,3 @@
+Description:
+  The site_search:google_custom_search generator creates a google_custom_search.yml file in the config
+  directory. This is required for loading the api key and cx records for your custom searches.

data/lib/generators/site_search/google_custom_search_generator.rb

@@ -0,0 +1,12 @@
+module SiteSearch
+  module Generators
+    class GoogleCustomSearchGenerator < Rails::Generators::Base
+      source_root File.expand_path('../templates', __FILE__)
+
+      def generate_google_custom_search
+        copy_file "google_custom_search.yml", "config/google_custom_search.yml"
+        copy_file "load_site_search_config.rb", "config/initializers/load_site_search_config.rb"
+      end
+    end
+  end
+end

data/lib/generators/site_search/templates/google_custom_search.yml

@@ -0,0 +1,25 @@
+# Put your Google Custom Search API key and any search engines you have set up.
+
+development: &defaults
+  api_key: "YOUR-API-KEY"
+  search_engines:
+    my_search_engine:
+      cx: "CX-RECORD-FOR-MY-SEARCH-ENGINE"
+      #cref: "{optional}-YOUR-SEARCH-ENGINE-URL"
+      #lr: "{optional}-LANGUAGE-RESTRICTION"
+
+      # The following options can be supplied or overridden in the options hash
+      #num: "{optional}-NUM-OF-RESULTS-1-10(*default)"
+      #safe: "{optional}-high/medium/off(*default)"
+      #start: "{optional}start-index-between-1(*default)-101"
+      #filter: "{optional}-0(duplicates-off)/1(duplicated-on-*default)"
+      #alt: "{optional}-json(*default)/atom"
+
+production:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+
+

data/lib/generators/site_search/templates/load_site_search_config.rb

@@ -0,0 +1 @@
+GOOGLE_SEARCH_CONFIG = YAML.load_file("#{Rails.root}/config/google_custom_search.yml")[Rails.env]

data/lib/site_search/exceptions.rb

@@ -0,0 +1,30 @@
+module SiteSearch
+  # A general SiteSearch exception
+  class Error < StandardError; end
+
+  # The search engine could not be located due to an invalid cx record
+  class InvalidSearchRequest < Error; end
+
+  # The search engine has not been configured in the config yaml file
+  class UndefinedSearchEngine < Error; end
+
+  # The search engine has restricted access, likely cause is exceeding the Google Custom Search request limit
+  class ForbiddenAccessToSearchEngine < Error; end
+
+  # You can rescue from this error in the controller to display the error message provided or the default message
+  class NoResults < Error
+    attr_reader :query
+    attr_writer :default_message
+
+    def initialize(message = nil, query = nil)
+      @message = message
+      @query = query
+      @default_message = "No results for '#{@query}'"
+    end
+
+    def to_s
+      @message || @default_message
+    end
+  end
+
+end

data/lib/site_search/google_search.rb

@@ -0,0 +1,105 @@
+module SiteSearch
+  require 'uri'
+  require 'net/https'
+
+  class GoogleSearch
+    require 'json'
+    require 'rexml/document'
+    attr_reader :results, :total, :start_index, :raw
+
+    alias_method :raw?, :raw
+
+    def initialize(search_engine, query, options={})
+      raise NoResults.new if query.blank?
+      @query = escape_html(query).gsub(" ", '+')
+      @results = []
+      doc = get_document(set_uri(options, search_engine.to_s))
+      @raw = doc.body
+      case options[:alt]
+        when 'atom' then parse_atom(doc)
+        else parse_json(doc)
+      end
+    end
+
+    private
+    def escape_html(str)
+      str.gsub(/<\/?[^>]*>/, "")
+    end
+
+    def set_uri(options, search_engine)
+      raise(UndefinedSearchEngine, "'#{search_engine}' is undefined for #{self.class}") if !GOOGLE_SEARCH_CONFIG['search_engines'].has_key? search_engine
+
+      key = GOOGLE_SEARCH_CONFIG['api_key']
+      cx = GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['cx']
+
+      params = "key=#{key}&cx=#{cx}&q=#{@query}"
+
+      options_hash = {}
+
+      options_hash.store('cref', GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['cref'])
+      options_hash.store('lr', GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['lr'])
+      options_hash.store('num', options[:num] || GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['num'])
+      options_hash.store('safe', options[:safe] || GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['safe'])
+      options_hash.store('start', options[:start] || GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['start'])
+      options_hash.store('filter', options[:filter] || GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['filter'])
+      options_hash.store('alt', options[:alt] || GOOGLE_SEARCH_CONFIG['search_engines'][search_engine]['alt'])
+
+      options_hash.each do |k, v|
+        params = params + "&#{k}=#{v}" if v.present?
+      end
+
+      return URI.parse("https://www.googleapis.com/customsearch/v1?#{params}")
+    end
+
+    def get_document(uri)
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      return http.request(Net::HTTP::Get.new(uri.request_uri))
+    end
+
+    def parse_json(doc)
+      json = JSON.parse(doc.body)
+      case doc
+        when Net::HTTPSuccess
+        then
+          json['queries']['request'].each do |r|
+            @total =r['totalResults']
+            @start_index = r['startIndex']
+          end
+          raise NoResults.new(nil, @query) if @total.to_i < 1
+          items = json['items']
+          items.each do |item|
+            @results << ResultItem.new(item)
+          end
+        when Net::HTTPForbidden then raise ForbiddenAccessToSearchEngine, json['error']['message']
+        else raise InvalidSearchRequest, json['error']['message']
+      end
+    end
+
+    def parse_atom(doc)
+      atom = REXML::Document.new(doc.body)
+      case doc
+        when Net::HTTPSuccess
+        then
+          @total = atom.elements["//opensearch:totalResults"].text
+          raise NoResults.new(nil, @query) if @total.to_i < 1
+          @start_index = atom.elements["//opensearch:startIndex"].text
+          REXML::XPath.each(atom, "//entry").each do |el|
+            item = {}
+            item.store('link', el.elements["link"].attributes["href"])
+            item.store('displayLink', el.elements["link"].attributes["title"])
+            item.store('htmlSnippet', el.elements["summary"].text)
+            if item['htmlSnippet'].is_a? String
+              item.store('snippet', escape_html(item['htmlSnippet']))
+            end
+            @results << ResultItem.new(item)
+          end
+        when Net::HTTPForbidden then raise ForbiddenAccessToSearchEngine, atom.elements["//internalReason"].text
+        else raise InvalidSearchRequest, atom.elements["//internalReason"].text
+      end
+    end
+
+  end
+
+end

data/lib/site_search/result_item.rb

@@ -0,0 +1,12 @@
+class ResultItem
+  attr_reader :url, :text, :title, :html
+
+  # Creates attributes that can easily be accessed from the view
+  def initialize(item)
+    @url = item['link']
+    @text = item['snippet']
+    @title = item['displayLink']
+    @html = item['htmlSnippet']
+  end
+
+end

data/lib/site_search.rb

@@ -0,0 +1,3 @@
+require "site_search/google_search"
+require 'site_search/result_item'
+require "site_search/exceptions"

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: site_search
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Gareth Allen
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-08-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: SiteSearch allows for multiple Google Custom Search engines to be configured, and provides JSON and Atom formats
+email: gaz.allen12@gmail.co.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/generators/site_search/google_custom_search_generator.rb
+- lib/generators/site_search/templates/google_custom_search.yml
+- lib/generators/site_search/templates/load_site_search_config.rb
+- lib/generators/site_search/USAGE
+- lib/site_search/exceptions.rb
+- lib/site_search/google_search.rb
+- lib/site_search/result_item.rb
+- lib/site_search.rb
+- MIT-LICENSE
+- Rakefile
+- Gemfile
+- README.md
+has_rdoc: true
+homepage: http://github.com/garetha/site_search
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Provides site searching capabilities to rack applications using the Google Custom Search API
+test_files: []
+