Class: UR::Product

Inherits:
Object
  • Object
show all
Defined in:
lib/ur/product.rb,
lib/ur/product/storage.rb,
lib/ur/product/distribution_event.rb,
lib/ur/product/related_product_id.rb

Overview

A product can be a tv show, a radio program or even a website

Defined Under Namespace

Classes: DistributionEvent, RelatedProductId, Storage

Constant Summary collapse

ASSETS_URL = 
'http://assets.ur.se'

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data) ⇒ Product

Returns a new instance of Product.



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'lib/ur/product.rb', line 23

def initialize(data)
  unless !data['status'].nil? && data['status'] == 404
    product_data = data.include?('product') ? data['product'] : data
    relations = data.include?('relations') ? data['relations'] : []
    populate(product_data, relations)
    
    self.class.define_boolean_methods([
      'distribution_events', 'storages', 'typical_age_ranges', 'languages',
      'duration', 'difficulty', 'producing_company', 'production_year', 
      'obsolete_order_id', 'sli', 'sli_sub', 'sab', 'sao', 'fao'
    ])
    self.class.define_relation_boolean_methods([
      'siblings', 'packageseries', 'packageusageseries', 'website', 
      'packagedvd', 'packagecd', 'programtv', 'programradio', 
      'trailertrailer'
    ])
    def ok?; true; end
  else
    def ok?; false; end
  end
end

Instance Attribute Details

#aspect_ratio ⇒ Object (readonly)

Returns the value of attribute aspect_ratio.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def aspect_ratio
  @aspect_ratio
end

#created_at ⇒ Object (readonly)

Returns the value of attribute created_at.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def created_at
  @created_at
end

#description ⇒ Object (readonly)

Returns the value of attribute description.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def description
  @description
end

#difficulty ⇒ Object (readonly)

Returns the value of attribute difficulty.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def difficulty
  @difficulty
end

#distribution_events ⇒ Object (readonly)

Returns the value of attribute distribution_events.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def distribution_events
  @distribution_events
end

#duration ⇒ Object (readonly)

Returns the value of attribute duration.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def duration
  @duration
end

#easy_to_read_description ⇒ Object (readonly)

Returns the value of attribute easy_to_read_description.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def easy_to_read_description
  @easy_to_read_description
end

#fao ⇒ Object (readonly)

Returns the value of attribute fao.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def fao
  @fao
end

#format ⇒ Object (readonly)

Returns the value of attribute format.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def format
  @format
end

#languages ⇒ Object (readonly)

Returns the value of attribute languages.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def languages
  @languages
end

#main_title ⇒ Object (readonly)

Returns the value of attribute main_title.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def main_title
  @main_title
end

#modified_at ⇒ Object (readonly)

Returns the value of attribute modified_at.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def modified_at
  @modified_at
end

#obsolete_order_id ⇒ Object (readonly)

Returns the value of attribute obsolete_order_id.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def obsolete_order_id
  @obsolete_order_id
end

#producing_company ⇒ Object (readonly)

Returns the value of attribute producing_company.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def producing_company
  @producing_company
end

#product_sub_type ⇒ Object (readonly)

Returns the value of attribute product_sub_type.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def product_sub_type
  @product_sub_type
end

#product_type ⇒ Object (readonly)

Returns the value of attribute product_type.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def product_type
  @product_type
end

#production_year ⇒ Object (readonly)

Returns the value of attribute production_year.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def production_year
  @production_year
end

#publication_date ⇒ Object (readonly)

Returns the value of attribute publication_date.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def publication_date
  @publication_date
end

#related_product_ids ⇒ Object (readonly)

Returns the value of attribute related_product_ids.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def related_product_ids
  @related_product_ids
end

#related_products ⇒ Object (readonly)

Returns the value of attribute related_products.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def related_products
  @related_products
end

#remainder_of_title ⇒ Object (readonly)

Returns the value of attribute remainder_of_title.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def remainder_of_title
  @remainder_of_title
end

#sab ⇒ Object (readonly)

Returns the value of attribute sab.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def sab
  @sab
end

#sao ⇒ Object (readonly)

Returns the value of attribute sao.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def sao
  @sao
end

#sli ⇒ Object (readonly)

Returns the value of attribute sli.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def sli
  @sli
end

#sli_sub ⇒ Object (readonly)

Returns the value of attribute sli_sub.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def sli_sub
  @sli_sub
end

#status ⇒ Object (readonly)

Returns the value of attribute status.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def status
  @status
end

#storages ⇒ Object (readonly)

Returns the value of attribute storages.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def storages
  @storages
end

#title ⇒ Object (readonly)

Returns the value of attribute title.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def title
  @title
end

#typical_age_ranges ⇒ Object (readonly)

Returns the value of attribute typical_age_ranges.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def typical_age_ranges
  @typical_age_ranges
end

#ur_product_id ⇒ Object (readonly)

Returns the value of attribute ur_product_id.



13
14
15
 
# File 'lib/ur/product.rb', line 13

def ur_product_id
  @ur_product_id
end

Class Method Details

.define_boolean_methods(names) ⇒ Object 



56
57
58
59
60
61
62
63
 
# File 'lib/ur/product.rb', line 56

def self.define_boolean_methods(names)
  names.each do |name|
    define_method("has_#{name}?") do
      instance_variable = instance_variable_get("@#{name}")            
      !(instance_variable.nil? || instance_variable.to_s.empty?)
    end
  end
end

.define_relation_accessor(name) ⇒ Object 



76
77
78
79
80
 
# File 'lib/ur/product.rb', line 76

def self.define_relation_accessor(name)
  define_method(name) do
    instance_variable_get("@related_products")[name]
  end
end

.define_relation_boolean_methods(names) ⇒ Object 



65
66
67
68
69
70
71
72
73
74
 
# File 'lib/ur/product.rb', line 65

def self.define_relation_boolean_methods(names)
  names.each do |name|
    define_method("has_#{name}?") do
      related_products = instance_variable_get("@related_products")
      (!related_products.nil? && 
        (!related_products[name].nil? && 
          !related_products[name].to_s.empty?))
    end
  end
end

.find(id) ⇒ Object 



45
46
47
48
49
50
 
# File 'lib/ur/product.rb', line 45

def self.find(id)
  data = MetadataCache.find(id)
  
  (data.instance_of?(Array)) ? 
    data.map { |d| Product.new(d) } : Product.new(data)
end

.search(solr_params) ⇒ Object 



52
53
54
 
# File 'lib/ur/product.rb', line 52

def self.search(solr_params)
  UR::Search.new(solr_params)
end

Instance Method Details

#available_on_avc? ⇒ Boolean

Returns:

  • (Boolean) 


158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/ur/product.rb', line 158

def available_on_avc?
  return @available_on_avc unless @available_on_avc.nil?
  @available_on_avc = false
  
  distribution_events.each do |event|
    if event.receiving_agent_group == 'avc'
      @available_on_avc = event.active?
      break
    end
  end
  
  @available_on_avc
end

#broadcasts ⇒ Object 



172
173
174
175
176
177
178
179
180
181
182
 
# File 'lib/ur/product.rb', line 172

def broadcasts
  return @broadcasts unless @broadcasts.nil?
  @broadcasts = []
  
  distribution_events.each do |event|
    @broadcasts << event if event.event_type == 'broadcast'
  end
  
  @broadcasts = @broadcasts.sort_by { |broadcast| broadcast.start_date }
  @broadcasts
end

#documents ⇒ Object 



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# File 'lib/ur/product.rb', line 184

def documents
  return @docs unless @docs.nil?
  @docs = []
  
  [
    'textteacherguide', 
    'textstudyguide', 
    'textscript', 
    'textworksheet',
    'texttasks', 
    'texttext'
  ].each do |name|
    @docs << @related_products[name] if !@related_products[name].nil?
  end
  
  @docs.flatten!
end

#full_type ⇒ Object 



221
222
223
224
 
# File 'lib/ur/product.rb', line 221

def full_type
  broadcast_format = (product_type == 'package') ? "-#{format}" : ''
  (product_sub_type.nil?) ? product_type : "#{product_type}#{product_sub_type}#{broadcast_format}"
end

#get_storage_location(format) ⇒ Object 



247
248
249
250
 
# File 'lib/ur/product.rb', line 247

def get_storage_location(format)
  storage = storages.map { |s| s if s.storage_format == format }.compact
  storage.empty? ? false : storage.first.location
end

#has_documents? ⇒ Boolean

Returns:

  • (Boolean) 


202
203
204
 
# File 'lib/ur/product.rb', line 202

def has_documents?
  (!documents.nil? && documents.size > 0)
end

#has_image?(number = 1, size = '') ⇒ Boolean

Returns:

  • (Boolean) 


230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/ur/product.rb', line 230

def has_image?(number = 1, size = '')
  return @has_image if !@has_image.nil?
  
  begin
    url = "#{ASSETS_URL}/id/#{ur_product_id}/images/#{number}#{size}.jpg"
    @has_image = (RestClient.head(url).headers[:x_ur_http_status] == "200")
  rescue RestClient::ResourceNotFound
    @has_image = false
  end
  
  @has_image
end

#has_relations? ⇒ Boolean

Returns:

  • (Boolean) 


243
244
245
 
# File 'lib/ur/product.rb', line 243

def has_relations?
  (!@related_products.nil? && @related_products.size > 0)
end

#has_url? ⇒ Boolean

Returns:

  • (Boolean) 


276
277
278
 
# File 'lib/ur/product.rb', line 276

def has_url?
  (url)
end

#humanized_duration ⇒ Object 



206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/ur/product.rb', line 206

def humanized_duration
  if matched = duration.match(/^(\d\d):(\d\d):(\d\d)/)
    (full,h,m,s) = matched.to_a
    if h == '00' && m != '00'
      "#{m.to_i} minuter"
    elsif h == '00'
      'Under en minut'
    else
      "#{h.to_i}:#{m}"
    end
  else
    duration
  end
end

#image_url(number = 1, size = '') ⇒ Object 



226
227
228
 
# File 'lib/ur/product.rb', line 226

def image_url(number = 1, size = '')
  "#{ASSETS_URL}/id/#{ur_product_id}/images/#{number}#{size}.jpg"
end

#media_id ⇒ Object 



252
253
254
255
256
 
# File 'lib/ur/product.rb', line 252

def media_id
  @media_id ||= (get_storage_location('genericvideo') || 
                 get_storage_location('genericaudio'))
  @media_id
end

#populate(product_data, relations) ⇒ Object

Populate the object



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
 
# File 'lib/ur/product.rb', line 83

def populate(product_data, relations)
  # Handle the fields
  standard_fields = [
    'id', 'obsoleteorderid', 'status', 'language', 
    'title.sv', 'maintitle.sv', 'remainderoftitle.sv',
    'description.sv', 'easytoreaddescription.sv',
    'productionyear', 'producingcompany',
    'created', 'modified', 'pubdate', 
    'format', 'duration', 'aspect_ratio',
    'product_type', 'product_sub_type', 
    'typicalagerange', 'difficulty', 
    'sli', 'sli_sub', 'sab', 'sao', 'fao'
  ]
  
  field_names = lambda do |name|
    renamed = { 
      'id' => 'ur_product_id',
      'maintitle' => 'main_title',
      'remainderoftitle' => 'remainder_of_title',
      'easytoreaddescription' => 'easy_to_read_description',
      'producingcompany' => 'producing_company',
      'created' => 'created_at',
      'modified' => 'modified_at',
      'pubdate' => 'publication_date',
      'obsoleteorderid' => 'obsolete_order_id',
      'typicalagerange' => 'typical_age_ranges',
      'productionyear' => 'production_year',
      'language' => 'languages'
    }
    (renamed.keys.include?(name)) ? renamed[name] : name
  end
  
  standard_fields.each do |field|
    field,lang = field.split('.')
    
    if lang.nil?
      value = product_data[field]
    elsif !product_data[field].nil?
      value = product_data[field][lang]
    end
    
    if ['pubdate', 'created', 'modified'].include? field
      value = Time.parse(value)
    end
    
    instance_variable_set("@#{field_names.call(field)}", value)
  end
  
  # Handle the data structures
  [
    ['distributionevent', 'distribution_events', UR::Product::DistributionEvent],
    ['storage', 'storages', UR::Product::Storage],
    ['relation_haspart', 'related_product_ids', UR::Product::RelatedProductId],
  ].each do |name, variable, structure_class|
    data = product_data[name]
    instance_variable_set("@#{variable}", (!data.nil? && data.size > 0) ? 
      data.map { |d| structure_class.new d } : [])
  end
  
  # Handle the relations
  @related_products = {}
  if relations.size > 0
    @has_relations = true
    relations.each do |name, products|
      @related_products[name] = []
      
      products.each do |related_product_data|
        @related_products[name] << Product.new(related_product_data)
      end
      
      self.class.define_relation_accessor(name)
    end
  end
end

#short_title ⇒ Object 



280
281
282
283
284
285
286
 
# File 'lib/ur/product.rb', line 280

def short_title
  if !remainder_of_title.nil?
    remainder_of_title
  else
    title
  end
end

#url ⇒ Object 



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/ur/product.rb', line 258

def url
  return @url unless @url.nil?
  
  if product_type == 'website'
    @url = get_storage_location('url')
  elsif respond_to?(:website) && website.respond_to?(:first)
    if website.first.nil?
      @url = false
    else
      @url = website.first.get_storage_location('url')
    end
  else
    @url = false
  end

  @url
end