Module: Inquisitio

Defined in:
lib/inquisitio.rb,
lib/inquisitio/facets.rb,
lib/inquisitio/logger.rb,
lib/inquisitio/indexer.rb,
lib/inquisitio/results.rb,
lib/inquisitio/version.rb,
lib/inquisitio/document.rb,
lib/inquisitio/searcher.rb,
lib/inquisitio/configuration.rb,
lib/inquisitio/inquisitio_error.rb,
lib/inquisitio/search_url_builder.rb

Defined Under Namespace

Classes: Configuration, Document, Facets, Indexer, InquisitioConfigurationError, InquisitioError, Logger, Results, SearchUrlBuilder, Searcher

Constant Summary collapse

VERSION = 
'2.1.2'

Class Method Summary collapse

Class Method Details

.config ⇒ Object

Inquisitio configuration settings.

Settings should be set in an initializer or using some other method that insures they are set before any Inquisitio code is used. They can be set as followed:

Inquisitio.config.access_key = "my-access-key"

The following settings are allowed:

  • :access_key - The AWS access key

  • :secret_key - The AWS secret key

  • :queue_region - The AWS region is included in.

  • :logger - A logger object that responds to puts.



30
31
32
33
34
35
36
37
 
# File 'lib/inquisitio.rb', line 30

def self.config
  @config ||= Configuration.new
  if block_given?
    yield @config
  else
    @config
  end
end

.index(documents) ⇒ Object

Index a batch of documents.

Parameters:

  • documents. (Array) —

    A list of Documents to index.



77
78
79
 
# File 'lib/inquisitio.rb', line 77

def self.index(documents)
  Indexer.index([documents])
end

.page(page) ⇒ Object

Specify a page number. Defaults to 1

Parameters:

  • query —

    The page number.



56
57
58
 
# File 'lib/inquisitio.rb', line 56

def self.page(page)
  Searcher.page(page)
end

.per(num) ⇒ Object

Specify the amount of results you want back

Parameters:

  • query —

    The amount of results.



63
64
65
 
# File 'lib/inquisitio.rb', line 63

def self.per(num)
  Searcher.per(num)
end

.returns(num) ⇒ Object

Specify which fields you want returned.

Parameters:

  • query —

    A string or array specifying the fields



70
71
72
 
# File 'lib/inquisitio.rb', line 70

def self.returns(num)
  Searcher.returns(num)
end

.search ⇒ Object

Exectues the generated query and returns self.

Parameters:

  • query —

    The search query.



42
43
44
 
# File 'lib/inquisitio.rb', line 42

def self.search
  Searcher.search
end

.where(query) ⇒ Object

Specify a condition as either a string, an array, or a hash.

Parameters:

  • query —

    The search query.



49
50
51
 
# File 'lib/inquisitio.rb', line 49

def self.where(query)
  Searcher.where(query)
end