Class: Europeana::Blacklight::Response

Inherits:
HashWithIndifferentAccess
  • Object
show all
Includes:
Facets, MoreLikeThis, Pagination
Defined in:
lib/europeana/blacklight/response.rb,
lib/europeana/blacklight/response/facets.rb,
lib/europeana/blacklight/response/pagination.rb,
lib/europeana/blacklight/response/more_like_this.rb

Overview

Europeana API response for BL

Defined Under Namespace

Modules: Facets, MoreLikeThis, Pagination

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from MoreLikeThis

#more_like, #more_like_this

Methods included from Facets

#aggregations, #facet_fields, #facet_queries

Methods included from Pagination

#limit_value, #max_pages, #model_name, #next_page, #offset_value, #prev_page, #total_count, #total_pages

Constructor Details

#initialize(data, request_params, options = {}) ⇒ Response

Returns a new instance of Response.



19
20
21
22
23
24
 
# File 'lib/europeana/blacklight/response.rb', line 19

def initialize(data, request_params, options = {})
  super(force_to_utf8(data))
  @request_params = request_params
  self.document_model = options[:document_model] || Document
  self.blacklight_config = options[:blacklight_config]
end

Instance Attribute Details

#blacklight_config ⇒ Object

Returns the value of attribute blacklight_config.



17
18
19
 
# File 'lib/europeana/blacklight/response.rb', line 17

def blacklight_config
  @blacklight_config
end

#document_model ⇒ Object

Returns the value of attribute document_model.



17
18
19
 
# File 'lib/europeana/blacklight/response.rb', line 17

def document_model
  @document_model
end

#request_params ⇒ Object (readonly)

Returns the value of attribute request_params.



16
17
18
 
# File 'lib/europeana/blacklight/response.rb', line 16

def request_params
  @request_params
end

Instance Method Details

#documents ⇒ Object Also known as: docs 



43
44
45
46
47
 
# File 'lib/europeana/blacklight/response.rb', line 43

def documents
  @documents ||= (self.key?('object') ? [self['object']] : (self['items'] || [])).collect do |doc|
    document_model.new(doc, self)
  end
end

#empty? ⇒ Boolean

Returns:

  • (Boolean) 


74
75
76
 
# File 'lib/europeana/blacklight/response.rb', line 74

def empty?
  total == 0
end

#export_formats ⇒ Object 



62
63
64
 
# File 'lib/europeana/blacklight/response.rb', line 62

def export_formats
  documents.map { |x| x.export_formats.keys }.flatten.uniq
end

#group(_key) ⇒ Object 



54
55
56
 
# File 'lib/europeana/blacklight/response.rb', line 54

def group(_key)
  nil
end

#grouped ⇒ Object 



50
51
52
 
# File 'lib/europeana/blacklight/response.rb', line 50

def grouped
  []
end

#grouped? ⇒ Boolean

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/europeana/blacklight/response.rb', line 58

def grouped?
  false
end

#params ⇒ Object 



31
32
33
 
# File 'lib/europeana/blacklight/response.rb', line 31

def params
  self['params'] ? self['params'] : request_params
end

#rows ⇒ Object 



35
36
37
 
# File 'lib/europeana/blacklight/response.rb', line 35

def rows
  params[:rows].to_i
end

#sort ⇒ Object 



39
40
41
 
# File 'lib/europeana/blacklight/response.rb', line 39

def sort
  params[:sort]
end

#start ⇒ Object 



70
71
72
 
# File 'lib/europeana/blacklight/response.rb', line 70

def start
  params[:start].to_s.to_i - 1
end

#total ⇒ Object 



66
67
68
 
# File 'lib/europeana/blacklight/response.rb', line 66

def total
  self[:totalResults].to_s.to_i
end

#update(other_hash) ⇒ Object 



26
27
28
29
 
# File 'lib/europeana/blacklight/response.rb', line 26

def update(other_hash)
  other_hash.each_pair { |key, value| self[key] = value }
  self
end