solr4r 0.0.1

data/README

@@ -0,0 +1,40 @@
+= solr4r - A Ruby client for Apache Solr
+
+== VERSION
+
+This documentation refers to solr4r version 0.0.1
+
+
+== DESCRIPTION
+
+TODO
+
+
+== LINKS
+
+Documentation:: http://blackwinter.github.com/solr4r
+Source code::   http://github.com/blackwinter/solr4r
+RubyGem::       http://rubygems.org/gems/solr4r
+
+
+== AUTHORS
+
+* Jens Wille <mailto:jens.wille@gmail.com>
+
+
+== LICENSE AND COPYRIGHT
+
+Copyright (C) 2014 Jens Wille
+
+solr4r is free software: you can redistribute it and/or modify it
+under the terms of the GNU Affero General Public License as published by
+the Free Software Foundation, either version 3 of the License, or (at your
+option) any later version.
+
+solr4r is distributed in the hope that it will be useful, but
+WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public
+License for more details.
+
+You should have received a copy of the GNU Affero General Public License
+along with solr4r. If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,23 @@
+require File.expand_path(%q{../lib/solr4r/version}, __FILE__)
+
+begin
+  require 'hen'
+
+  Hen.lay! {{
+    gem: {
+      name:         %q{solr4r},
+      version:      Solr4R::VERSION,
+      summary:      %q{A Ruby client for Apache Solr},
+      description:  %q{Access the Apache Solr search server from Ruby},
+      author:       %q{Jens Wille},
+      email:        %q{jens.wille@gmail.com},
+      license:      %q{AGPL-3.0},
+      homepage:     :blackwinter,
+      dependencies: { curb: ['~> 0.8', '> 0.8.5'], nokogiri: '~> 1.6' },
+
+      required_ruby_version: '>= 1.9.3'
+    }
+  }}
+rescue LoadError => err
+  warn "Please install the `hen' gem. (#{err})"
+end

data/TODO

@@ -0,0 +1,3 @@
+* request: https://github.com/taf2/curb/pull/196
+* documentation
+* specs

data/lib/solr4r/builder.rb

@@ -0,0 +1,291 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Mir is free software: you can redistribute it and/or modify it under the    #
+# terms of the GNU Affero General Public License as published by the Free     #
+# Software Foundation, either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# solr4r is distributed in the hope that it will be useful, but WITHOUT ANY   #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with solr4r. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+require 'nokogiri'
+
+module Solr4R
+
+  Document = Nokogiri::XML::Document
+
+  class Builder < Nokogiri::XML::Builder
+
+    DEFAULT_OPTIONS = {
+      encoding: 'UTF-8'
+    }
+
+    def initialize(options = {})
+      if block_given?
+        raise ArgumentError,
+          'block argument not supported, use options hash instead'
+      end
+
+      super(@options = DEFAULT_OPTIONS.merge(options))
+
+      @_solr_doc = @doc
+    end
+
+    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#add.2Freplace_documents].
+    #
+    # Examples:
+    #
+    #   # single document
+    #   add(employeeId: '05991', office: 'Bridgewater', skills: %w[Perl Java])
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <add>
+    #       <doc>
+    #         <field name="employeeId">05991</field>
+    #         <field name="office">Bridgewater</field>
+    #         <field name="skills">Perl</field>
+    #         <field name="skills">Java</field>
+    #       </doc>
+    #     </add>
+    #
+    #   # multiple documents
+    #   add([{ employeeId: '05992', office: 'Blackwater' }, { employeeId: '05993', skills: 'Ruby' }])
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <add>
+    #       <doc>
+    #         <field name="employeeId">05992</field>
+    #         <field name="office">Blackwater</field>
+    #       </doc>
+    #       <doc>
+    #         <field name="employeeId">05993</field>
+    #         <field name="skills">Ruby</field>
+    #       </doc>
+    #     </add>
+    #
+    #   # add attributes
+    #   add([id: 42, text: 'blah'], commitWithin: 23)
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <add commitWithin="23">
+    #       <doc>
+    #         <field name="id">42</field>
+    #         <field name="text">blah</field>
+    #       </doc>
+    #     </add>
+    #
+    #   # document attributes
+    #   add([[{ id: 42, text: 'blah' }, { boost: 10.0 }]])
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <add>
+    #       <doc boost="10.0">
+    #         <field name="id">42</field>
+    #         <field name="text">blah</field>
+    #       </doc>
+    #     </add>
+    #
+    #   # field attributes
+    #   add(id: 42, text: ['blah', boost: 2.0])
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <add>
+    #       <doc>
+    #         <field name="id">42</field>
+    #         <field boost="2.0" name="text">blah</field>
+    #       </doc>
+    #     </add>
+    #
+    #   # all attributes together
+    #   add([[{ id: 42, text: ['blah', boost: 2.0] }, { boost: 10.0 }]], commitWithin: 23)
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <add commitWithin="23">
+    #       <doc boost="10.0">
+    #         <field name="id">42</field>
+    #         <field boost="2.0" name="text">blah</field>
+    #       </doc>
+    #     </add>
+    def add(doc, attributes = {})
+      to_xml(:add, attributes) { |add_node|
+        doc = [doc] unless doc.is_a?(Array)
+        doc.each { |hash, doc_attributes|
+          doc_(doc_attributes) { |doc_node|
+            hash.each { |key, values|
+              values = values.is_a?(Array) ? values.dup : [values]
+
+              field_attributes = values.last.is_a?(Hash) ? values.pop : {}
+              field_attributes = field_attributes.merge(name: key)
+
+              values.each { |value| doc_node.field_(value, field_attributes) }
+            }
+          }
+        }
+      }
+    end
+
+    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
+    #
+    # Examples:
+    #
+    #   commit
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <commit/>
+    #
+    #   commit(softCommit: true)
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <commit softCommit="true"/>
+    def commit(attributes = {})
+      to_xml(:commit, attributes)
+    end
+
+    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22].
+    #
+    # Examples:
+    #
+    #   optimize
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <optimize/>
+    #
+    #   optimize(maxSegments: 42)
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <optimize maxSegments="42"/>
+    def optimize(attributes = {})
+      to_xml(:optimize, attributes)
+    end
+
+    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22rollback.22].
+    #
+    # Example:
+    #
+    #   rollback
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <rollback/>
+    def rollback
+      to_xml(:rollback)
+    end
+
+    # See Schema[http://wiki.apache.org/solr/UpdateXmlMessages#A.22delete.22_documents_by_ID_and_by_Query].
+    #
+    # Examples:
+    #
+    #   # single ID
+    #   delete(id: '05991')
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <id>05991</id>
+    #     </delete>
+    #
+    #   # multiple IDs
+    #   delete(id: %w[05991 06000])
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <id>05991</id>
+    #       <id>06000</id>
+    #     </delete>
+    #
+    #   # single query
+    #   delete(query: 'office:Bridgewater')
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <query>office:Bridgewater</query>
+    #     </delete>
+    #
+    #   # multiple queries
+    #   delete(query: %w[office:Bridgewater office:Osaka])
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <query>office:Bridgewater</query>
+    #       <query>office:Osaka</query>
+    #     </delete>
+    #
+    #   # query hash
+    #   delete(query: { office: 'Bridgewater', skills: 'Perl' })
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <query>office:Bridgewater</query>
+    #       <query>skills:Perl</query>
+    #     </delete>
+    #
+    #   # query hash with array
+    #   delete(query: { office: %w[Bridgewater Osaka] })
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <query>office:Bridgewater</query>
+    #       <query>office:Osaka</query>
+    #     </delete>
+    #
+    #   # both IDs and queries
+    #   delete(id: %w[05991 06000], query: { office: %w[Bridgewater Osaka] })
+    #
+    #     <?xml version="1.0" encoding="UTF-8"?>
+    #     <delete>
+    #       <id>05991</id>
+    #       <id>06000</id>
+    #       <query>office:Bridgewater</query>
+    #       <query>office:Osaka</query>
+    #     </delete>
+    def delete(hash)
+      to_xml(:delete) { |delete_node|
+        hash.each { |key, values|
+          values = [values] unless values.is_a?(Array)
+          values.each { |value|
+            ary = []
+
+            if value.is_a?(Hash)
+              value.each { |k, v| Array(v).each { |w| ary << "#{k}:#{w}" } }
+            else
+              ary << value
+            end
+
+            ary.each { |v| delete_node.method_missing(key, v) }
+          }
+        }
+      }
+    end
+
+    def inspect
+      '#<%s:0x%x @options=%p>' % [
+        self.class, object_id, @options
+      ]
+    end
+
+    private
+
+    def to_xml(name, attributes = {}, &block)
+      self.parent = self.doc = @_solr_doc.dup
+
+      method_missing(name, attributes, &block)
+
+      super(&nil)
+    end
+
+  end
+
+end

data/lib/solr4r/client.rb

@@ -0,0 +1,184 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Mir is free software: you can redistribute it and/or modify it under the    #
+# terms of the GNU Affero General Public License as published by the Free     #
+# Software Foundation, either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# solr4r is distributed in the hope that it will be useful, but WITHOUT ANY   #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with solr4r. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+require 'uri'
+
+module Solr4R
+
+  class Client
+
+    DEFAULT_HOST = 'localhost'
+    DEFAULT_PATH = 'solr/'
+    DEFAULT_PORT = 8983
+
+    DEFAULT_PARAMS = {
+      wt: :json
+    }
+
+    DEFAULT_ENDPOINTS = %w[select query spell suggest terms] <<
+      ['ping', path: 'admin/ping', method: :head] <<
+      ['dump', path: 'debug/dump']
+
+    DEFAULT_SELECT_PATH = 'select'
+
+    DEFAULT_UPDATE_PATH = 'update'
+
+    MATCH_ALL_QUERY = '*:*'
+
+    def initialize(options = {})
+      if options.is_a?(String)
+        url, options = options, {}
+      else
+        url = options.fetch(:url, default_url(options))
+      end
+
+      self.url, self.options = URI.parse(url), options
+
+      self.request = options.fetch(:request, Request.new)
+      self.builder = options.fetch(:builder, Builder.new)
+
+      self.default_params = options.fetch(:default_params, DEFAULT_PARAMS)
+
+      register_endpoints(options.fetch(:endpoints, DEFAULT_ENDPOINTS))
+    end
+
+    attr_accessor :url, :options, :request, :builder, :default_params
+
+    def register_endpoints(endpoints)
+      endpoints.each { |args| register_endpoint(*args) } if endpoints
+      self
+    end
+
+    def register_endpoint(path, options = {})
+      name, path = path, options.fetch(:path, path)
+
+      if error = invalid_endpoint?(name.to_s)
+        raise ArgumentError, "invalid endpoint: #{name} (#{error})"
+      else
+        define_singleton_method(name) { |_params = {}, _options = {}, &block|
+          send_request(path, options.merge(_options.merge(
+            params: options.fetch(:params, {}).merge(_params))), &block)
+        }
+      end
+
+      self
+    end
+
+    def get(path, params = {}, options = {}, &block)
+      send_request(path, options.merge(method: :get, params: params), &block)
+    end
+
+    def post(path, data = nil, options = {}, &block)
+      send_request(path, options.merge(method: :post, data: data), &block)
+    end
+
+    def head(path, params = {}, options = {}, &block)
+      send_request(path, options.merge(method: :head, params: params), &block)
+    end
+
+    def update(data, options = {}, path = DEFAULT_UPDATE_PATH, &block)
+      options = amend_options(options, :headers, 'Content-Type' => 'text/xml')
+      post(path, data, options, &block)
+    end
+
+    # See Builder#add.
+    def add(doc, attributes = {}, options = {}, &block)
+      update(builder.add(doc, attributes), options, &block)
+    end
+
+    # See Builder#commit.
+    def commit(attributes = {}, options = {}, &block)
+      update(builder.commit(attributes), options, &block)
+    end
+
+    # See Builder#optimize.
+    def optimize(attributes = {}, options = {}, &block)
+      update(builder.optimize(attributes), options, &block)
+    end
+
+    # See Builder#rollback.
+    def rollback(options = {}, &block)
+      update(builder.rollback, options, &block)
+    end
+
+    # See Builder#delete.
+    def delete(hash, options = {}, &block)
+      update(builder.delete(hash), options, &block)
+    end
+
+    # See #delete.
+    def delete_by_id(id, options = {}, &block)
+      delete({ id: id }, options, &block)
+    end
+
+    # See #delete.
+    def delete_by_query(query, options = {}, &block)
+      delete({ query: query }, options, &block)
+    end
+
+    # See #delete_by_query.
+    def delete_all!(options = {}, &block)
+      delete_by_query(MATCH_ALL_QUERY, options, &block)
+    end
+
+    def count(params = {}, options = {}, path = DEFAULT_SELECT_PATH, &block)
+      params = params.merge(rows: 0)
+      params[:q] ||= MATCH_ALL_QUERY
+      get(path, params, options, &block)
+    end
+
+    def inspect
+      '#<%s:0x%x @url=%p, @default_params=%p>' % [
+        self.class, object_id, url, default_params
+      ]
+    end
+
+    private
+
+    def default_url(options)
+      'http://%s:%d/%s' % [
+        options.fetch(:host, DEFAULT_HOST),
+        options.fetch(:port, DEFAULT_PORT),
+        options.fetch(:path, DEFAULT_PATH)
+      ]
+    end
+
+    def amend_options(options, key, value)
+      options.merge(key => value.merge(options.fetch(key, {})))
+    end
+
+    def send_request(path, options, &block)
+      options = amend_options(options, :params, default_params)
+      request.execute(URI.join(url, path), options, &block)
+    end
+
+    def invalid_endpoint?(name)
+      'method already defined' if respond_to?(name) || (
+        respond_to?(name, true) && !DEFAULT_ENDPOINTS.flatten.include?(name))
+    end
+
+  end
+
+end

data/lib/solr4r/request.rb

@@ -0,0 +1,122 @@
+# encoding: utf-8
+
+#--
+###############################################################################
+#                                                                             #
+# solr4r -- A Ruby client for Apache Solr                                     #
+#                                                                             #
+# Copyright (C) 2014 Jens Wille                                               #
+#                                                                             #
+# Mir is free software: you can redistribute it and/or modify it under the    #
+# terms of the GNU Affero General Public License as published by the Free     #
+# Software Foundation, either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# solr4r is distributed in the hope that it will be useful, but WITHOUT ANY   #
+# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS   #
+# FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for     #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU Affero General Public License    #
+# along with solr4r. If not, see <http://www.gnu.org/licenses/>.              #
+#                                                                             #
+###############################################################################
+#++
+
+require 'curl'
+
+module Solr4R
+
+  class Request < Curl::Easy
+
+    DEFAULT_VERB = :get
+
+    DEFAULT_USER_AGENT = "Solr4R/#{VERSION}"
+
+    RESPONSE_ATTRIBUTES = {
+      # request
+      headers:            :request_headers,
+      last_effective_url: :request_url,
+      post_body:          :post_body,
+      params:             :request_params,
+      verb:               :request_verb,
+
+      # response
+      body_str:           :response_body,
+      content_type:       :content_type,
+      header_str:         :response_header,
+      response_code:      :response_code
+    }
+
+    def initialize(options = {})
+      if block_given?
+        raise ArgumentError,
+          'block argument not supported, use options hash instead'
+      end
+
+      super()
+
+      self.options = options.merge(params: nil, verb: nil)
+      set_options
+    end
+
+    attr_accessor :options, :params, :verb
+
+    def execute(request_url, options = {}, &block)
+      prepare_request(request_url, options, &block)
+
+      send("http_#{verb}")
+
+      Response.new { |response|
+        RESPONSE_ATTRIBUTES.each { |attribute, key|
+          response.send("#{key}=", send(attribute))
+        }
+      }
+    end
+
+    def reset
+      super.tap {
+        set_options
+        headers['User-Agent'] ||= DEFAULT_USER_AGENT
+      }
+    end
+
+    def inspect
+      '#<%s:0x%x @options=%p, @verb=%p, @url=%p, @response_code=%p>' % [
+        self.class, object_id, options, verb, url, response_code
+      ]
+    end
+
+    private
+
+    def set_options
+      options.each { |key, value| send("#{key}=", value) }
+    end
+
+    def prepare_request(request_url, options)
+      reset
+
+      self.url = Curl.urlalize(request_url.to_s,
+        self.params = options.fetch(:params, {}))
+
+      case self.verb = options.fetch(:method, DEFAULT_VERB)
+        when :get, :head
+          # ok
+        when :post, :delete, :patch
+          self.post_body = Curl.postalize(options[:data])
+        when :put
+          self.put_data = Curl.postalize(options[:data])
+        else
+          raise ArgumentError, "verb not supported: #{verb}"
+      end
+
+      headers.update(options[:headers]) if options[:headers]
+
+      yield self if block_given?
+
+      self
+    end
+
+  end
+
+end