Class: RSolr::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/rsolr/client.rb

Defined Under Namespace

Modules: Context

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection, options = {}) ⇒ Client

Returns a new instance of Client.



5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
 
# File 'lib/rsolr/client.rb', line 5

def initialize connection, options = {}
  @proxy = @uri = nil
  @connection = connection
  unless false === options[:url]
    url = options[:url] ? options[:url].dup : 'http://127.0.0.1:8983/solr/'
    url << "/" unless url[-1] == ?/
    @uri = RSolr::Uri.create url
    if options[:proxy]
      proxy_url = options[:proxy].dup
      proxy_url << "/" unless proxy_url.nil? or proxy_url[-1] == ?/
      @proxy = RSolr::Uri.create proxy_url if proxy_url
    end
  end
  @options = options
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args) ⇒ Object (protected)

converts the method name for the solr request handler path.



278
279
280
281
282
283
284
 
# File 'lib/rsolr/client.rb', line 278

def method_missing name, *args
  if name.to_s =~ /^paginated?_(.+)$/
    paginate args[0], args[1], $1, *args[2..-1]
  else
    send_and_receive name, *args
  end
end

Instance Attribute Details

#connection ⇒ Object (readonly)

Returns the value of attribute connection.



3
4
5
 
# File 'lib/rsolr/client.rb', line 3

def connection
  @connection
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



3
4
5
 
# File 'lib/rsolr/client.rb', line 3

def options
  @options
end

#proxy ⇒ Object (readonly)

Returns the value of attribute proxy.



3
4
5
 
# File 'lib/rsolr/client.rb', line 3

def proxy
  @proxy
end

#uri ⇒ Object (readonly)

Returns the value of attribute uri.



3
4
5
 
# File 'lib/rsolr/client.rb', line 3

def uri
  @uri
end

Instance Method Details

#adapt_response(request, response) ⇒ Object

This method will evaluate the :body value if the params.params == :ruby … otherwise, the body is returned as is. The return object has methods attached, :request and :response. These methods give you access to the original request and response from the connection.

adapt_response will raise an InvalidRubyResponse if :wt == :ruby and the body couldn’t be evaluated.



265
266
267
268
269
270
271
272
273
 
# File 'lib/rsolr/client.rb', line 265

def adapt_response request, response
  raise "The response does not have the correct keys => :body, :headers, :status" unless
    %W(body headers status) == response.keys.map{|k|k.to_s}.sort
  raise RSolr::Error::Http.new request, response unless [200,302].include? response[:status]
  result = request[:params][:wt] == :ruby ? evaluate_ruby_response(request, response) : response[:body]
  result.extend Context
  result.request, result.response = request, response
  result.is_a?(Hash) ? result.extend(RSolr::Response) : result
end

#add(doc, opts = {}) ⇒ Object

add creates xml “add” documents and sends the xml data to the update method

wiki.apache.org/solr/UpdateXmlMessages#add.2BAC8-update

single record: solr.update(:id=>1, :name=>‘one’)

update using an array

solr.update(

[{:id=>1, :name=>'one'}, {:id=>2, :name=>'two'}],
:add_attributes => {:boost=>5.0, :commitWithin=>10}

)



85
86
87
88
 
# File 'lib/rsolr/client.rb', line 85

def add doc, opts = {}
  add_attributes = opts.delete :add_attributes
  update opts.merge(:data => xml.add(doc, add_attributes))
end

#base_request_uri ⇒ Object

returns the request uri object.



22
23
24
 
# File 'lib/rsolr/client.rb', line 22

def base_request_uri
  base_uri.request_uri if base_uri
end

#base_uri ⇒ Object

returns the uri proxy if present, otherwise just the uri object.



28
29
30
 
# File 'lib/rsolr/client.rb', line 28

def base_uri
  @proxy ? @proxy : @uri
end

#build_paginated_request(page, per_page, path, opts) ⇒ Object 



241
242
243
244
245
246
247
248
 
# File 'lib/rsolr/client.rb', line 241

def build_paginated_request page, per_page, path, opts
  per_page = per_page.to_s.to_i
  page = page.to_s.to_i-1
  page = page < 1 ? 0 : page
  opts[:params]["start"] = page * per_page
  opts[:params]["rows"] = per_page
  build_request path, opts
end

#build_request(path, opts) ⇒ Object

build_request accepts a path and options hash, then prepares a normalized hash to return for sending to a solr connection driver. build_request sets up the uri/query string and converts the data arg to form-urlencoded, if the data arg is a hash. returns a hash with the following keys:

:method
:params
:headers
:data
:uri
:path
:query



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/rsolr/client.rb', line 222

def build_request path, opts
  raise "path must be a string or symbol, not #{path.inspect}" unless [String,Symbol].include?(path.class)
  path = path.to_s
  opts[:proxy] = proxy unless proxy.nil?
  opts[:method] ||= :get
  raise "The :data option can only be used if :method => :post" if opts[:method] != :post and opts[:data]
  opts[:params] = opts[:params].nil? ? {:wt => :ruby} : {:wt => :ruby}.merge(opts[:params])
  query = RSolr::Uri.params_to_solr(opts[:params]) unless opts[:params].empty?
  opts[:query] = query
  if opts[:data].is_a? Hash
    opts[:data] = RSolr::Uri.params_to_solr opts[:data]
    opts[:headers] ||= {}
    opts[:headers]['Content-Type'] ||= 'application/x-www-form-urlencoded; charset=UTF-8'
  end
  opts[:path] = path
  opts[:uri] = base_uri.merge(path.to_s + (query ? "?#{query}" : "")) if base_uri
  opts
end

#commit(opts = {}) ⇒ Object

send “commit” xml with opts

wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22



94
95
96
97
 
# File 'lib/rsolr/client.rb', line 94

def commit opts = {}
  commit_attrs = opts.delete :commit_attributes
  update opts.merge(:data => xml.commit( commit_attrs ))
end

#delete_by_id(id, opts = {}) ⇒ Object

Delete one or many documents by id

solr.delete_by_id 10
solr.delete_by_id([12, 41, 199])



120
121
122
 
# File 'lib/rsolr/client.rb', line 120

def delete_by_id id, opts = {}
  update opts.merge(:data => xml.delete_by_id(id))
end

#delete_by_query(query, opts = {}) ⇒ Object

delete one or many documents by query.

wiki.apache.org/solr/UpdateXmlMessages#A.22delete.22_by_ID_and_by_Query

solr.delete_by_query 'available:0'
solr.delete_by_query ['quantity:0', 'manu:"FQ"']



130
131
132
 
# File 'lib/rsolr/client.rb', line 130

def delete_by_query query, opts = {}
  update opts.merge(:data => xml.delete_by_query(query))
end

#execute(request_context) ⇒ Object 



165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/rsolr/client.rb', line 165

def execute request_context

  raw_response = connection.execute self, request_context

  while retry_503?(request_context, raw_response)
    request_context[:retry_503] -= 1
    sleep retry_after(raw_response)
    raw_response = connection.execute self, request_context
  end

  adapt_response(request_context, raw_response) unless raw_response.nil?
end

#optimize(opts = {}) ⇒ Object

send “optimize” xml with opts.

wiki.apache.org/solr/UpdateXmlMessages#A.22commit.22_and_.22optimize.22



103
104
105
106
 
# File 'lib/rsolr/client.rb', line 103

def optimize opts = {}
  optimize_attributes = opts.delete :optimize_attributes
  update opts.merge(:data => xml.optimize(optimize_attributes))
end

#paginate(page, per_page, path, opts = nil) ⇒ Object

A paginated request method. Converts the page and per_page arguments into “rows” and “start”.



44
45
46
47
48
49
 
# File 'lib/rsolr/client.rb', line 44

def paginate page, per_page, path, opts = nil
  opts ||= {}
  opts[:params] ||= {}
  raise "'rows' or 'start' params should not be set when using +paginate+" if ["start", "rows"].include?(opts[:params].keys)
  execute build_paginated_request(page, per_page, path, opts)
end

#retry_503?(request_context, response) ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
181
182
183
184
185
186
187
188
 
# File 'lib/rsolr/client.rb', line 178

def retry_503?(request_context, response)
  return false if response.nil?
  status = response[:status] && response[:status].to_i
  return false unless status == 503
  retry_503 = request_context[:retry_503]
  return false unless retry_503 && retry_503 > 0
  retry_after_limit = request_context[:retry_after_limit] || 1
  retry_after = retry_after(response)
  return false unless retry_after && retry_after <= retry_after_limit
  true
end

#retry_after(response) ⇒ Object

Retry-After can be a relative number of seconds from now, or an RFC 1123 Date. If the latter, attempt to convert it to a relative time in seconds.



192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/rsolr/client.rb', line 192

def retry_after(response)
  retry_after = Array(response[:headers]['Retry-After'] || response[:headers]['retry-after']).flatten.first.to_s
  if retry_after =~ /\A[0-9]+\Z/
    retry_after = retry_after.to_i
  else
    begin
      retry_after_date = DateTime.parse(retry_after)
      retry_after = retry_after_date.to_time - Time.now
      retry_after = nil if retry_after < 0
    rescue ArgumentError => e
      retry_after = retry_after.to_i
    end
  end
  retry_after
end

#rollback(opts = {}) ⇒ Object

send </rollback>

wiki.apache.org/solr/UpdateXmlMessages#A.22rollback.22

NOTE: solr 1.4 only



113
114
115
 
# File 'lib/rsolr/client.rb', line 113

def rollback opts = {}
  update opts.merge(:data => xml.rollback)
end

#send_and_receive(path, opts) ⇒ Object

send_and_receive is the main request method responsible for sending requests to the connection object.

“path” : A string value that usually represents a solr request handler “opts” : A hash, which can contain the following keys:

:method : required - the http method (:get, :post or :head)
:params : optional - the query string params in hash form
:data : optional - post data -- if a hash is given, it's sent as "application/x-www-form-urlencoded; charset=UTF-8"
:headers : optional - hash of request headers

All other options are passed right along to the connection’s send_and_receive method (:get, :post, or :head)

send_and_receive returns either a string or hash on a successful ruby request. When the :params => :ruby, the response will be a hash, else a string.

creates a request context hash, sends it to the connection’s execute method which returns a simple hash, then passes the request/response into adapt_response.



156
157
158
159
160
161
162
 
# File 'lib/rsolr/client.rb', line 156

def send_and_receive path, opts
  request_context = build_request path, opts
  [:open_timeout, :read_timeout, :retry_503, :retry_after_limit].each do |k|
    request_context[k] = @options[k]
  end
  execute request_context
end

#update(opts = {}) ⇒ Object

POST XML messages to /update with optional params.

wiki.apache.org/solr/UpdateXmlMessages#add.2BAC8-update

If not set, opts will be set to a hash with the key ‘Content-Type’ set to ‘text/xml’

opts can/should contain:

:data - posted data
:headers - http headers
:params - solr query parameter hash



64
65
66
67
68
 
# File 'lib/rsolr/client.rb', line 64

def update opts = {}
  opts[:headers] ||= {}
  opts[:headers]['Content-Type'] ||= 'text/xml'
  post 'update', opts
end

#xml ⇒ Object

shortcut to RSolr::Xml::Generator



135
136
137
 
# File 'lib/rsolr/client.rb', line 135

def xml
  @xml ||= RSolr::Xml::Generator.new
end