dezi-client 1.0.0

data/lib/dezi/client.rb

@@ -0,0 +1,262 @@
+# DeziClient is a Ruby client for the Dezi search platform.
+# 
+# Copyright 2013 by Peter Karman
+# 
+# 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.
+
+# dependencies
+require 'rubygems'
+require 'rest_client'
+require 'uri'
+require 'json'
+require 'pathname'
+require 'mime/types'
+
+# related classes
+require File.dirname(__FILE__) + '/response'
+require File.dirname(__FILE__) + '/doc'
+
+# DeziClient is a Ruby client for indexing and searching documents
+# with the Dezi REST search platform. See http://dezi.org/ for details
+# on the server.
+#
+# See the test/test_dezi_client.rb for full example.
+#
+# Usage:
+#
+#  client = DeziClient.new(
+#       :server     => 'http://localhost:5000',
+#       :username   => 'foo',
+#       :password   => 'secret',
+#  )
+#
+#  doc = 'some/path/file.html'
+#  response = client.add(doc)   # DeziResponse returned
+#  if !response.is_success
+#     raise "Failed to add #{doc} to server"
+#  end
+#
+#  # if Dezi server has auto_commit==false
+#  # then must call commit()
+#  client.commit()
+#
+#  response = client.search('q' => 'search string')  # DeziResponse returned
+#  if !response.is_success
+#     raise "Failed to search"
+#  end
+#
+#  response.results.each |result|
+#     puts "result: #{result.uri}"
+#  end
+#
+# Related classes: DeziResponse and DeziDoc
+#
+
+class DeziClient
+
+    # attributes
+    attr_accessor :server
+    attr_accessor :about_server
+    attr_accessor :search_uri
+    attr_accessor :index_uri
+    attr_accessor :commit_uri
+    attr_accessor :rollback_uri
+    attr_accessor :fields
+    attr_accessor :facets
+    attr_accessor :last_response
+    attr_accessor :debug
+    attr_accessor :user_agent
+    
+    def version
+        return '1.0.0'
+    end
+    
+    def initialize(args)
+        @debug = ENV['DEZI_DEBUG']
+        
+        if (args.has_key? :server)
+            @server = args[:server]
+        else 
+            @server = 'http://localhost:5000'
+        end
+
+        # sanity check
+        begin
+            uri = URI.parse(@server)
+        rescue URI::InvalidURIError => err
+            raise "Bad :server value " + err
+        end
+        if (!uri.host || !uri.port)
+            raise "Bad :server value " + @server
+        end
+        
+        if (args.has_key? :username and args.has_key? :password)
+            @un = args[:username]
+            @pw = args[:password]
+        end
+        
+        if (args.has_key? :user_agent)
+            @user_agent = args[:user_agent]
+        else
+            @user_agent = 'dezi-client-ruby/'+version()
+        end
+        
+        if (args.has_key? :search and args.has_key? :index)
+            @search_uri = @server + args[:search]
+            @index_uri  = @server + args[:index]
+        else
+            response = RestClient.get @server, :accept => :json, :user_agent => @user_agent
+
+            if response.code != 200
+                raise "Bad about response from server #{@server}: " . response.to_str
+            end
+        
+            @about_server = JSON.parse(response.to_str)
+            if @debug
+                #puts @about_server.inspect
+            end
+        
+            @search_uri = @about_server['search']
+            @index_uri  = @about_server['index']
+            @commit_uri = @about_server['commit']
+            @rollback_uri = @about_server['rollback']
+            @fields     = @about_server['fields']
+            @facets     = @about_server['facets']
+        end
+        
+        @searcher   = RestClient::Resource.new( @search_uri )
+        
+    end
+    
+    private
+    
+    def _put_doc(doc, uri=nil, content_type=nil)
+        body_buf = ""
+                
+        if (doc.is_a?(DeziDoc))
+            body_buf = doc.as_string()
+            if (uri == nil)
+                uri = doc.uri
+            end
+            if (content_type == nil)
+                content_type = doc.mime_type
+            end
+            
+        elsif (Pathname.new(doc).exist?)
+            file = File.new(doc, 'r')
+            body_buf = file.read()
+            if (uri == nil)
+                uri = doc
+            end
+            
+        else
+            body_buf = doc
+            if (uri == nil)
+                raise "uri required"
+            end
+            
+        end
+        
+        if (!content_type or !content_type.length)
+            content_type = MIME::Types.type_for(uri)[0]
+        end
+        
+        server_uri = '/' + uri
+        if (@debug)
+            puts "uri=#{uri}"
+            puts "body=#{body_buf}"
+            puts "content_type="#{content_type}"
+        end
+        
+        resource = RestClient::Resource.new(@index_uri + server_uri, @un, @pw)
+        resp = resource.post( body_buf, 
+            :accept => :json, 
+            :content_type => content_type, 
+            :user_agent => @user_agent
+        )
+            
+        return DeziResponse.new(resp)
+    end
+    
+    public
+
+    # add() takes an initial argument of "doc" which can be a DeziDoc object,
+    # a string representing a Pathname, or a string representing the content of a document.
+    # If "doc" represents the content of a document, additional arguments
+    # "uri" and "content_type" are required.
+    
+    def add(doc, uri=nil, content_type=nil)
+        return _put_doc(doc, uri, content_type)
+    end
+    
+    # update() takes an initial argument of "doc" which can be a DeziDoc object,
+    # a string representing a Pathname, or a string representing the content of a document.
+    # If "doc" represents the content of a document, additional arguments
+    # "uri" and "content_type" are required.
+    
+    def update(doc, uri=nil, content_type=nil)
+        return _put_doc(doc, uri, content_type)
+    end
+    
+    def delete(uri)
+        doc_uri = @index_uri + '/' + uri
+        resource = RestClient::Resource.new(doc_uri, @un, @pw)
+        resp = resource.delete(:accept => :json, :user_agent => @user_agent)
+        return DeziResponse.new(resp)
+    end
+    
+    # commit() and rollback() are only relevant if the Dezi server
+    # has "auto_commit" turned off.
+     
+    def commit()
+        ua = RestClient::Resource.new( @commit_uri, @un, @pw )
+        resp = ua.post('/', :accept => :json, :user_agent => @user_agent)
+        return DeziResponse.new(resp)
+    end
+    
+    # commit() and rollback() are only relevant if the Dezi server
+    # has "auto_commit" turned off.
+    
+    def rollback()
+        ua = RestClient::Resource.new( @rollback_uri, @un, @pw )
+        resp = ua.post('/', :accept => :json, :user_agent => @user_agent)
+        return DeziResponse.new(resp)
+    end
+    
+    def search(params)
+        if (!params.has_key?("q"))
+            raise "'q' param required"
+        end
+        
+        resp = @searcher.get(
+            :params => params, 
+            :accept => :json, 
+            :user_agent => @user_agent
+        )
+        dr = DeziResponse.new(resp)
+        if (!dr.is_success())
+            @last_response = dr
+            return false
+        else
+            return dr
+        end
+    
+    end
+    
+end

data/lib/dezi/doc.rb

@@ -0,0 +1,69 @@
+# DeziDoc is part of a Ruby client for the Dezi search platform.
+# 
+# Copyright 2013 by Peter Karman
+# 
+# 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.
+
+require 'rubygems'
+require 'xmlsimple'
+
+class DeziDoc
+
+    attr_accessor   :mime_type
+    attr_accessor   :summary
+    attr_accessor   :title
+    attr_accessor   :content
+    attr_accessor   :uri
+    attr_accessor   :mtime
+    attr_accessor   :size
+    attr_accessor   :score
+    attr_accessor   :fields
+    
+    def initialize(args)
+        @fields = {}
+        args.each {|k,v| send("#{k}=",v)}
+    end
+    
+    def set_field(args)
+        args.each {|k,v| @fields[k] = v}
+        @mime_type = 'application/xml'
+    end
+    
+    def get_field(fname)
+        if @fields.has_key?(fname)
+            return @fields[fname]
+        else
+            return nil
+        end
+    end
+    
+    def as_string()
+        #puts "fields.length=" + @fields.length.to_s
+        if @fields.length > 0
+            return self.as_xml()
+        else
+            return @content
+        end
+    end
+    
+    def as_xml()
+        return XmlSimple.xml_out(@fields, {'rootname' => 'doc', 'noattr' => true})
+    end
+
+end

data/lib/dezi/response.rb

@@ -0,0 +1,100 @@
+# DeziResponse is part of a Ruby client for the Dezi search platform.
+# 
+# Copyright 2013 by Peter Karman
+# 
+# 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.
+
+require 'rubygems'
+require 'json'
+
+class DeziResponse
+
+    # most attributes are assigned dynamically in initialize().
+    # Try:
+    #  
+    #  puts response.inspect
+    #
+    # to see them.
+    
+    attr_accessor :results
+    
+    def initialize(http_resp)
+        @http_resp = http_resp
+        
+        #warn http_resp.headers.inspect
+        #warn "code=" + http_resp.code.to_s
+        
+        @is_ok = false
+        if (http_resp.code.to_s =~ /^2\d\d/)
+            @is_ok = true
+        end
+        
+        if (!@is_ok)
+            return
+        end
+        
+        #warn "is_ok=#{@is_ok}"
+        
+        body = JSON.parse(http_resp.to_s)
+        
+        #warn body.inspect
+        
+        # set body keys as attributes in the object
+        body.each {|k,v|
+        
+            # results are special
+            if k == 'results'
+                next
+            end
+        
+            # create the attribute
+            self.instance_eval { class << self; self end }.send(:attr_accessor, k)
+            
+            # assign the value
+            send("#{k}=",v)
+        }
+        
+        if !body.has_key?('results')
+            return
+        end
+        
+        # make each result Hash into a DeziDoc object
+        @results = []
+        body['results'].each {|r|
+            result = r
+            result['fields'] = {}
+            @fields.each {|f|
+                result['fields'][f] = r.delete(f)
+            }
+        
+            doc = DeziDoc.new(result)
+            @results.push(doc)
+        }
+        
+    end
+    
+    def status()
+        return @http_resp.code.to_s
+    end
+    
+    def is_success()
+        return @is_ok
+    end
+
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: dezi-client
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Peter Karman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2013-01-08 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rest-client
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: xml-simple
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+description: Ruby client for the Dezi search engine. See http://dezi.org/
+email: karpet@dezi.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/dezi/client.rb
+- lib/dezi/doc.rb
+- lib/dezi/response.rb
+has_rdoc: true
+homepage: https://github.com/karpet/dezi-client-ruby
+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: nowarning
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby client for the Dezi search engine
+test_files: []
+