Module: Endeca

Extended by:
Benchmarking, Logging
Defined in:
lib/endeca.rb,
lib/endeca/map.rb,
lib/endeca/logging.rb,
lib/endeca/readers.rb,
lib/endeca/request.rb,
lib/endeca/document.rb,
lib/endeca/dimension.rb,
lib/endeca/breadcrumb.rb,
lib/endeca/refinement.rb,
lib/endeca/breadcrumbs.rb,
lib/endeca/transformer.rb,
lib/endeca/benchmarking.rb,
lib/endeca/document_collection.rb,
lib/endeca/refinement_dimension.rb

Defined Under Namespace

Modules: Benchmarking, Breadcrumbs, Logging, Readers, Transformer Classes: Breadcrumb, Dimension, Document, DocumentCollection, Map, ReaderError, Refinement, RefinementDimension, Request, RequestError

Constant Summary collapse

VERSION =

:stopdoc:

'1.5.3'

Class Attribute Summary collapse

Class Method Summary collapse

Methods included from Benchmarking

bm, increase_metric

Methods included from Logging

log

Class Attribute Details

.logger ⇒ Object

Returns the value of attribute logger.



27
28
29
 
# File 'lib/endeca.rb', line 27

def logger
  @logger
end

.timeout ⇒ Object

Returns the value of attribute timeout.



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

def timeout
  @timeout
end

Class Method Details

.benchmark? ⇒ Boolean

Returns:

  • (Boolean) 


34
35
36
 
# File 'lib/endeca.rb', line 34

def benchmark?
  ENV['ENDECA_BENCHMARK'] == 'true'
end

.debug? ⇒ Boolean

Returns:

  • (Boolean) 


30
31
32
 
# File 'lib/endeca.rb', line 30

def debug?
  ENV['ENDECA_DEBUG'] == 'true' 
end

.escape(str) ⇒ Object

Endeca URIs require colons to be escaped



46
47
48
 
# File 'lib/endeca.rb', line 46

def self.escape(str)
  URI.escape(str, /[^-_.!~*'()a-zA-Z\d;\/?@&=+$,\[\]]/n)
end

.version ⇒ Object

Returns the version string for the library.



20
21
22
 
# File 'lib/endeca.rb', line 20

def self.version
  VERSION
end