documentation-elasticsearch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 4d1d3cb0ccddd456ac76d3338a004f915100ccb9
+  data.tar.gz: b336c03b271ab6563d3c5d4a35f78f8cceb4ae97
+SHA512:
+  metadata.gz: 302a6c63c579cd2107dd01f87939e91219e3563747cb164b4f4c23f2f7676b2a865154aed48932f1845fc238525476a095d974d40d9b5091d9e1e83e41477182
+  data.tar.gz: 5cc74e6b96db6d63164afb0ca6c721721cc903447a4a903aabd3e18639c03a2f0b13da3ba4ab7c5388602edcdf7445552481d3d335b519bde679b68b75f00e40

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 aTech Media Limited.
+
+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/lib/documentation/searchers/elasticsearch.rb

@@ -0,0 +1,95 @@
+module Documentation
+  module Searchers
+    class Elasticsearch < Documentation::Searchers::Abstract
+    
+      def setup
+        require 'elasticsearch'
+      end
+      
+      def index(page)
+        client.index(:index => index_name, :type => 'page', :id => page.id, :body => page_to_hash(page))
+      end
+      
+      def delete(page)
+        client.delete(:index => index_name, :type => 'page', :id => page.id)
+      rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
+        false
+      end
+      
+      def reset
+        client.indices.delete(:index => index_name)
+      end
+      
+      def search(query, options = {})
+        # Default options
+        options[:page]      ||= 1
+        options[:per_page]  ||= 15
+        
+        # Prepare our query
+        body = {
+          :query => {
+            :simple_query_string => {:query => query,  :fields => [:title, :content]}
+          }
+        }
+        # Get the total number of results
+        count = client.count(:index => index_name, :body => body)
+
+        # Get some actual results for the requested page
+        result = client.search(:index => index_name, :body => body.merge({
+          :from => (options[:page].to_i - 1) * options[:per_page].to_i,
+          :size => options[:per_page].to_i,
+          :highlight => {
+            :pre_tags => ["{{{"],
+            :post_tags => ["}}}"],
+            :fields => {:content => {}}
+          }
+        }))
+        
+        # Create a result object to be returned
+        search_result                 = Documentation::SearchResult.new
+        search_result.page            = options[:page].to_i
+        search_result.per_page        = options[:per_page].to_i
+        search_result.total_results   = count['count'].to_i
+        search_result.query           = query
+        search_result.time            = result['took']
+        search_result.raw_results     = result['hits']['hits'].inject(Hash.new) do |hash, hit|
+          hash[hit['_id'].to_i] = {
+            :score => hit['_score'],
+            :highlights => hit['highlight'] && hit['highlight']['content']
+          }
+          hash
+        end
+        
+        # Return it
+        search_result
+      rescue ::Elasticsearch::Transport::Transport::Errors::NotFound
+        Documentation::SearchResult.new
+      end
+      
+      private
+      
+      def index_name
+        options[:index_name] || 'pages'
+      end
+      
+      def page_to_hash(page)
+        {
+          :id => page.id,
+          :title => page.title,
+          :permalink => page.permalink,
+          :full_permalink => page.full_permalink,
+          :content => page.content,
+          :created_at => page.created_at,
+          :updated_at => page.updated_at
+        }
+      end
+      
+      private
+      
+      def client
+        @client ||= ::Elasticsearch::Client.new(options[:client] || {})
+      end
+      
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: documentation-elasticsearch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: documentation
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: elasticsearch
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Adds support for Elasticsearch to the Documentation gem
+email:
+- adam@atechmedia.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- lib/documentation/searchers/elasticsearch.rb
+homepage: http://adamcooke.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: An Elasticsearch module for the Documentation gem
+test_files: []
+has_rdoc: