Module: GSolr::Ext::Client

Defined in:
lib/gsolr_ext/client.rb

Instance Method Summary collapse

Instance Method Details

#find(*args) ⇒ Object

TWO modes of arguments:

<request-handler-path>, <solr-params-hash> OR <solr-params-hash>

The default request-handler-path is /select

If a hash is used for solr params, all of the normal GSolr::Ext::Request mappings are available (everything else gets passed to solr). Returns a new GSolr::Ext::Response::Base object.



15
16
17
18
19
20
21
22
23
 
# File 'lib/gsolr_ext/client.rb', line 15

def find *args
  # remove the handler arg - the first, if it is a string OR set default
  path = args.first.is_a?(String) ? args.shift : '/select'
  # remove the params - the first, if it is a Hash OR set default
  params = args.first.kind_of?(Hash) ? args.shift : {}
  # send path, map params and send the rest of the args along
  response = self.request path, GSolr::Ext::Request.map(params), *args
  GSolr::Ext::Response::Base.new(response, path, params)
end

#luke(*args) ⇒ Object

TWO modes of arguments:

<request-handler-path>, <solr-params-hash> OR <solr-params-hash>

The default request-handler-path is /admin/luke The default params are numTerms=0

Returns a new Mash object.



35
36
37
38
39
40
 
# File 'lib/gsolr_ext/client.rb', line 35

def luke *args
  path = args.first.is_a?(String) ? args.shift : '/admin/luke'
  params = args.pop || {}
  params['numTerms'] ||= 0
  self.request(path, params).to_mash
end

#ping(*args) ⇒ Object

sends request to /admin/ping



43
44
45
46
47
 
# File 'lib/gsolr_ext/client.rb', line 43

def ping *args
  path = args.first.is_a?(String) ? args.shift : '/admin/ping'
  params = args.pop || {}
  self.request(path, params).to_mash
end

#ping? ⇒ Boolean

Ping the server and make sure it is alright

solr.ping?

It returns true if the server pings and the status is OK It returns false otherwise – which probably cannot happen Or raises an exception if there is a failure to connect or the ping service is not activated in the solr server

The default configuration point of the PingRequestHandler in the solr server of ‘/admin/ping’ is assumed.

Returns:

  • (Boolean) 


60
61
62
 
# File 'lib/gsolr_ext/client.rb', line 60

def ping?
  ping['status'] == 'OK'
end