Class: AMEE::Profile::Item

Inherits:
Object show all
Defined in:
lib/amee/profile_item.rb

Instance Attribute Summary collapse

Attributes inherited from Object

#profile_date, #profile_uid

Attributes inherited from Object

#connection, #created, #modified, #name, #path, #uid

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#full_path

Methods inherited from Object

#expire_cache, get_and_parse

Methods included from ParseHelper

#load_xml_doc, #node_value, #xmlpathpreamble

Constructor Details

#initialize(data = {}) ⇒ Item

Returns a new instance of Item.



11
12
13
14
15
16
17
18
19
20
21
 
# File 'lib/amee/profile_item.rb', line 11

def initialize(data = {})
  @values = data ? data[:values] : []
  @total_amount = data[:total_amount]
  @total_amount_unit = data[:total_amount_unit]
  @amounts = data[:amounts] || []
  @notes = data[:notes] || []
  @start_date = data[:start_date] || data[:valid_from]
  @end_date = data[:end_date] || (data[:end] == true ? @start_date : nil )
  @data_item_uid = data[:data_item_uid]
  super
end

Instance Attribute Details

#amounts ⇒ Object (readonly)

Returns the value of attribute amounts.



26
27
28
 
# File 'lib/amee/profile_item.rb', line 26

def amounts
  @amounts
end

#data_item_uid ⇒ Object (readonly)

Returns the value of attribute data_item_uid.



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

def data_item_uid
  @data_item_uid
end

#end_date ⇒ Object (readonly)

Returns the value of attribute end_date.



29
30
31
 
# File 'lib/amee/profile_item.rb', line 29

def end_date
  @end_date
end

#notes ⇒ Object (readonly)

Returns the value of attribute notes.



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

def notes
  @notes
end

#start_date ⇒ Object (readonly)

Returns the value of attribute start_date.



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

def start_date
  @start_date
end

#total_amount ⇒ Object (readonly)

Returns the value of attribute total_amount.



24
25
26
 
# File 'lib/amee/profile_item.rb', line 24

def total_amount
  @total_amount
end

#total_amount_unit ⇒ Object (readonly)

Returns the value of attribute total_amount_unit.



25
26
27
 
# File 'lib/amee/profile_item.rb', line 25

def total_amount_unit
  @total_amount_unit
end

#values ⇒ Object (readonly)

Returns the value of attribute values.



23
24
25
 
# File 'lib/amee/profile_item.rb', line 23

def values
  @values
end

Class Method Details

.create(category, data_item_uid, options = {}) ⇒ Object 



288
289
290
 
# File 'lib/amee/profile_item.rb', line 288

def self.create(category, data_item_uid, options = {})
  create_without_category(category.connection, category.full_path, data_item_uid, options)
end

.create_batch(category, items, options = {}) ⇒ Object 



357
358
359
 
# File 'lib/amee/profile_item.rb', line 357

def self.create_batch(category, items, options = {})
  create_batch_without_category(category.connection, category.full_path, items)
end

.create_batch_without_category(connection, category_path, items, options = {}) ⇒ Object 



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
 
# File 'lib/amee/profile_item.rb', line 361

def self.create_batch_without_category(connection, category_path, items, options = {})
  if connection.format == :json
    options.merge! :profileItems => items
    post_data = options.to_json
  else
  options.merge!({:ProfileItems => items})
  post_data = options.to_xml(:root => "ProfileCategory", :skip_types => true, :skip_nil => true)
  end
  # Post to category
  response = connection.raw_post(category_path, post_data).body
  # Send back a category object containing all the created items
  unless response.empty?
    return AMEE::Profile::Category.parse_batch(connection, response)
  else
    return true
  end
end

.create_without_category(connection, path, data_item_uid, options = {}) ⇒ Object 



292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/amee/profile_item.rb', line 292

def self.create_without_category(connection, path, data_item_uid, options = {})
  # Do we want to automatically fetch the item afterwards?
  get_item = options.delete(:get_item)
  get_item = true if get_item.nil?
  # Store format if set
  format = options[:format]
  unless options.is_a?(Hash)
    raise AMEE::ArgumentError.new("Third argument must be a hash of options!")
  end
  # Set dates
  if options[:start_date] && connection.version < 2
    options[:validFrom] = options[:start_date].amee1_date
  elsif options[:start_date] && connection.version >= 2
    options[:startDate] = options[:start_date].xmlschema
  end
  if options[:end_date] && connection.version >= 2
    options[:endDate] = options[:end_date].xmlschema
  end
  if options[:duration] && connection.version >= 2
    options[:duration] = "PT#{options[:duration] * 86400}S"
  end
  # Send data to path
  options.merge!(:representation => 'full') if (connection.version >= 2) && (get_item == true)
  options.merge! :dataItemUid => data_item_uid
  # POST
  response = connection.post(path, options)
  # Parse response
  category = response.body.empty? ? nil : Category.parse(connection, response.body, options)
  if response.headers_hash.has_key?('Location') && response.headers_hash['Location']
    location = response.headers_hash['Location'].match("https??://.*?(/.*)")[1]
  else
    location = category.full_path + "/" + category.items[0][:path]
  end
  if get_item == true
    if connection.version >= 2
      item = category.items.first
      item[:connection] = category.connection
      item[:profile_uid] = category.profile_uid
      item[:data_item_label] = item.delete(:dataItemLabel)
      item[:data_item_uid] = item.delete(:dataItemUid)
      item[:start_date] = item.delete(:startDate)
      item[:end_date] = item.delete(:endDate)
      item[:total_amount] = item.delete(:amount) || item.delete(:amountPerMonth)
      item[:total_amount_unit] = item.delete(:amount_unit) || "kg/month"
      values = []
      item[:values].each do |k,v|
        values << v.merge(:path => k.to_s)
      end
      item[:values] = values
      item[:path] = category.path + '/' + item[:path]
      return AMEE::Profile::Item.new(item)
    else
      get_options = {}
      get_options[:returnUnit] = options[:returnUnit] if options[:returnUnit]
      get_options[:returnPerUnit] = options[:returnPerUnit] if options[:returnPerUnit]
      get_options[:format] = format if format
      return AMEE::Profile::Item.get(connection, location, get_options)
    end
  else
    return location
  end
rescue
  raise AMEE::BadData.new("Couldn't create ProfileItem. Check that your information is correct.\n#{response}")
end

.delete(connection, path) ⇒ Object 



435
436
437
438
439
 
# File 'lib/amee/profile_item.rb', line 435

def self.delete(connection, path)
  connection.delete(path)
rescue
  raise AMEE::BadData.new("Couldn't delete ProfileItem. Check that your information is correct.")
end

.from_json(json) ⇒ Object 



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/amee/profile_item.rb', line 44

def self.from_json(json)
  # Parse json
  doc = JSON.parse(json)
  data = {}
  data[:profile_uid] = doc['profile']['uid']
  data[:data_item_uid] = doc['profileItem']['dataItem']['uid']
  data[:uid] = doc['profileItem']['uid']
  data[:name] = doc['profileItem']['name']
  data[:path] = doc['path']
  data[:total_amount] = doc['profileItem']['amountPerMonth']
  data[:total_amount_unit] = "kg/month"
  data[:valid_from] = DateTime.strptime(doc['profileItem']['validFrom'], "%Y%m%d")
  data[:end] = doc['profileItem']['end'] == "false" ? false : true
  data[:values] = []
  doc['profileItem']['itemValues'].each do |item|
    value_data = {}
    item.each_pair do |key,value|
      case key
        when 'name', 'path', 'uid', 'value'
          value_data[key.downcase.to_sym] = value
      end
    end
    data[:values] << value_data
  end
  # Create object
  Item.new(data)
rescue
  raise AMEE::BadData.new("Couldn't load ProfileItem from JSON data. Check that your URL is correct.\n#{json}")
end

.from_v2_atom(response) ⇒ Object 



215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/amee/profile_item.rb', line 215

def self.from_v2_atom(response)
  # Parse XML
  doc = REXML::Document.new(response)
  data = {}
  data[:profile_uid] = REXML::XPath.first(doc, "/entry/@xml:base").to_s.match("/profiles/(.*?)/")[1]
  #data[:data_item_uid] = REXML::XPath.first(doc, "/Resources/ProfileItemResource/DataItem/@uid").to_s
  data[:uid] = REXML::XPath.first(doc, "/entry/id").text.match("urn:item:(.*)")[1]
  data[:name] = REXML::XPath.first(doc, '/entry/title').text
  data[:path] = REXML::XPath.first(doc, "/entry/@xml:base").to_s.match("/profiles/.*?(/.*)")[1]
  data[:total_amount] = REXML::XPath.first(doc, '/entry/amee:amount').text.to_f rescue nil
  data[:total_amount_unit] = REXML::XPath.first(doc, '/entry/amee:amount/@unit').to_s rescue nil
  data[:start_date] = DateTime.parse(REXML::XPath.first(doc, "/entry/amee:startDate").text)
  data[:end_date] = DateTime.parse(REXML::XPath.first(doc, "/entry/amee:endDate").text) rescue nil
  data[:values] = []
  REXML::XPath.each(doc, '/entry/amee:itemValue') do |item|
    value_data = {}
    value_data[:name] = item.elements['amee:name'].text
    value_data[:value] = item.elements['amee:value'].text unless item.elements['amee:value'].text == "N/A"
    value_data[:path] = item.elements['link'].attributes['href'].to_s
    value_data[:unit] = item.elements['amee:unit'].text rescue nil
    value_data[:per_unit] = item.elements['amee:perUnit'].text rescue nil
    data[:values] << value_data
  end
  # Create object
  Item.new(data)
rescue
  raise AMEE::BadData.new("Couldn't load ProfileItem from V2 ATOM data. Check that your URL is correct.\n#{response}")
end

.from_v2_json(json) ⇒ Object 



74
75
76
77
78
79
80
81
82
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
 
# File 'lib/amee/profile_item.rb', line 74

def self.from_v2_json(json)
  # Parse json
  doc = JSON.parse(json)
  data = {}
  data[:profile_uid] = doc['profile']['uid']
  data[:data_item_uid] = doc['profileItem']['dataItem']['uid']
  data[:uid] = doc['profileItem']['uid']
  data[:name] = doc['profileItem']['name']
  data[:path] = doc['path']
  data[:total_amount] = doc['profileItem']['amount']['value'].to_f
  data[:total_amount_unit] = doc['profileItem']['amount']['unit']
  data[:start_date] = DateTime.parse(doc['profileItem']['startDate'])
  data[:end_date] = DateTime.parse(doc['profileItem']['endDate']) rescue nil
  data[:values] = []
  doc['profileItem']['itemValues'].each do |item|
    value_data = {}
    item.each_pair do |key,value|
      case key
        when 'name', 'path', 'uid', 'value', 'unit'
          value_data[key.downcase.to_sym] = value
        when 'perUnit'
          value_data[:per_unit] = value
      end
    end
    data[:values] << value_data
  end
  if doc['profileItem']['amounts']
    if doc['profileItem']['amounts']['amount']
      data[:amounts] = doc['profileItem']['amounts']['amount'].map do |item|
        {
          :type => item['type'],
          :value => item['value'].to_f,
          :unit => item['unit'],
          :per_unit => item['perUnit'],
          :default => (item['default'] == 'true'),
        }
      end
    end
    if doc['profileItem']['amounts']['note']
      data[:notes] = doc['profileItem']['amounts']['note'].map do |item|
        {
          :type => item['type'],
          :value => item['value'],
        }
      end
    end
  end
  # Create object
  Item.new(data)
rescue
  raise AMEE::BadData.new("Couldn't load ProfileItem from V2 JSON data. Check that your URL is correct.\n#{json}")
end

.from_v2_xml(xml) ⇒ Object 



164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/amee/profile_item.rb', line 164

def self.from_v2_xml(xml)
  # Parse XML
  @doc = load_xml_doc(xml)
  data = {}
  data[:profile_uid] = x 'Profile/@uid'
  data[:data_item_uid] = x 'DataItem/@uid'
  data[:uid] = x 'ProfileItem/@uid'
  data[:name] = x 'ProfileItem/Name'
  data[:path] = x('Path') || ""
  data[:total_amount] = x('ProfileItem/Amount').to_f rescue nil
  data[:total_amount_unit] = x 'ProfileItem/Amount/@unit' rescue nil
  data[:start_date] = DateTime.parse(x 'ProfileItem/StartDate')
  data[:end_date] = DateTime.parse(x 'ProfileItem/EndDate') rescue nil
  data[:values] = []
  @doc.xpath("#{xmlpathpreamble}ProfileItem/ItemValues/ItemValue").each do |item|
    value_data = {}
    item.elements.each do |element|
      key = element.name
      value = element.text
      case key
        when 'Name', 'Path', 'Value', 'Unit'
          value_data[key.downcase.to_sym] = value.blank? ? nil : value
        when 'PerUnit'
          value_data[:per_unit] = value
      end
    end
    value_data[:uid] = item.attributes['uid'].to_s
    data[:values] << value_data
  end
  data[:amounts] = @doc.xpath('/Resources/ProfileItemResource/ProfileItem/Amounts/Amount').map do |item|
    x = {
      :type => item.attribute('type').value,
      :value => item.text.to_f,
      :unit => item.attribute('unit').value,
    }
    x[:per_unit] = item.attribute('perUnit').value if item.attribute('perUnit')
    x[:default] = (item.attribute('default').value == 'true') if item.attribute('default')
    x
  end
  data[:notes] = @doc.xpath('/Resources/ProfileItemResource/ProfileItem/Amounts/Note').map do |item|
    {
      :type => item.attribute('type').value,
      :value => item.text,
    }
  end
  # Create object
  Item.new(data)
rescue
  raise AMEE::BadData.new("Couldn't load ProfileItem from V2 XML data. Check that your URL is correct.\n#{xml}")
end

.from_xml(xml) ⇒ Object 



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
157
158
 
# File 'lib/amee/profile_item.rb', line 127

def self.from_xml(xml)
  # Parse XML
  doc = REXML::Document.new(xml)
  data = {}
  data[:profile_uid] = REXML::XPath.first(doc, "/Resources/ProfileItemResource/Profile/@uid").to_s
  data[:data_item_uid] = REXML::XPath.first(doc, "/Resources/ProfileItemResource/DataItem/@uid").to_s
  data[:uid] = REXML::XPath.first(doc, "/Resources/ProfileItemResource/ProfileItem/@uid").to_s
  data[:name] = REXML::XPath.first(doc, '/Resources/ProfileItemResource/ProfileItem/Name').text
  data[:path] = REXML::XPath.first(doc, '/Resources/ProfileItemResource/Path').text || ""
  data[:total_amount] = REXML::XPath.first(doc, '/Resources/ProfileItemResource/ProfileItem/AmountPerMonth').text.to_f rescue nil
  data[:total_amount_unit] = "kg/month"
  data[:valid_from] = DateTime.strptime(REXML::XPath.first(doc, "/Resources/ProfileItemResource/ProfileItem/ValidFrom").text, "%Y%m%d")
  data[:end] = REXML::XPath.first(doc, '/Resources/ProfileItemResource/ProfileItem/End').text == "false" ? false : true
  data[:values] = []
  REXML::XPath.each(doc, '/Resources/ProfileItemResource/ProfileItem/ItemValues/ItemValue') do |item|
    value_data = {}
    item.elements.each do |element|
      key = element.name
      value = element.text
      case key
        when 'Name', 'Path', 'Value'
          value_data[key.downcase.to_sym] = value
      end
    end
    value_data[:uid] = item.attributes['uid'].to_s
    data[:values] << value_data
  end
  # Create object
  Item.new(data)
rescue
  raise AMEE::BadData.new("Couldn't load ProfileItem from XML data. Check that your URL is correct.\n#{xml}")
end

.get(connection, path, options = {}) ⇒ Object 



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/amee/profile_item.rb', line 263

def self.get(connection, path, options = {})
  unless options.is_a?(Hash)
    raise AMEE::ArgumentError.new("Third argument must be a hash of options!")
  end
  # Convert to AMEE options
  if options[:start_date] && category.connection.version < 2
    options[:profileDate] = options[:start_date].amee1_month
  elsif options[:start_date] && category.connection.version >= 2
    options[:startDate] = options[:start_date].xmlschema
  end
  options.delete(:start_date)
  if options[:end_date] && category.connection.version >= 2
    options[:endDate] = options[:end_date].xmlschema
  end
  options.delete(:end_date)
  if options[:duration] && category.connection.version >= 2
    options[:duration] = "PT#{options[:duration] * 86400}S"
  end
  # Load data from path
  response = connection.get(path, options).body
  return Item.parse(connection, response)
rescue
  raise AMEE::BadData.new("Couldn't load ProfileItem. Check that your URL is correct.\n#{response}")
end

.parse(connection, response) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# File 'lib/amee/profile_item.rb', line 244

def self.parse(connection, response)
  # Parse data from response
  if response.is_v2_json?
    item = Item.from_v2_json(response)
  elsif response.is_json?
    item = Item.from_json(response)
  elsif response.is_v2_atom?
    item = Item.from_v2_atom(response)
  elsif response.is_v2_xml?
    item = Item.from_v2_xml(response)
  else
    item = Item.from_xml(response)
  end
  # Store connection in object for future use
  item.connection = connection
  # Done
  return item
end

.update(connection, path, options = {}) ⇒ Object 



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/amee/profile_item.rb', line 379

def self.update(connection, path, options = {})
  # Do we want to automatically fetch the item afterwards?
  get_item = options.delete(:get_item)
  get_item = true if get_item.nil?
  # Set dates
  if options[:start_date] && connection.version < 2
    options[:validFrom] = options[:start_date].amee1_date
  elsif options[:start_date] && connection.version >= 2
    options[:startDate] = options[:start_date].xmlschema
  end
  options.delete(:start_date)
  if options[:end_date] && connection.version >= 2
    options[:endDate] = options[:end_date].xmlschema
  end
  options.delete(:end_date)
  if options[:duration] && connection.version >= 2
    options[:duration] = "PT#{options[:duration] * 86400}S"
  end
  options.merge!(:representation => 'full') if (connection.version >= 2) && (get_item == true)
  # Go
  response = connection.put(path, options)
  if get_item
    if response.body.empty?
      return Item.get(connection, path)
    else
      return Item.parse(connection, response.body)
    end
  end
rescue
  raise AMEE::BadData.new("Couldn't update ProfileItem. Check that your information is correct.\n#{response}")
end

.update_batch(category, items) ⇒ Object 



415
416
417
 
# File 'lib/amee/profile_item.rb', line 415

def self.update_batch(category, items)
  update_batch_without_category(category.connection, category.full_path, items)
end

.update_batch_without_category(connection, category_path, items) ⇒ Object 



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/amee/profile_item.rb', line 419

def self.update_batch_without_category(connection, category_path, items)
  if connection.format == :json
    put_data = ({:profileItems => items}).to_json
  else
    put_data = ({:ProfileItems => items}).to_xml(:root => "ProfileCategory", :skip_types => true, :skip_nil => true)
  end
  # Post to category
  response = connection.raw_put(category_path, put_data).body
  # Send back a category object containing all the created items
  unless response.empty?
    return AMEE::Profile::Category.parse(connection, response, nil)
  else
    return true
  end
end

.xmlpathpreamble ⇒ Object 



160
161
162
 
# File 'lib/amee/profile_item.rb', line 160

def self.xmlpathpreamble
  "/Resources/ProfileItemResource/"
end

Instance Method Details

#duration ⇒ Object 



40
41
42
 
# File 'lib/amee/profile_item.rb', line 40

def duration
  end_date.nil? ? nil : (end_date - start_date).to_f
end

#end ⇒ Object 



36
37
38
 
# File 'lib/amee/profile_item.rb', line 36

def end
  end_date.nil? ? false : start_date == end_date
end

#update(options = {}) ⇒ Object 



411
412
413
 
# File 'lib/amee/profile_item.rb', line 411

def update(options = {})
  AMEE::Profile::Item.update(connection, full_path, options)
end

#valid_from ⇒ Object

V1 compatibility



33
34
35
 
# File 'lib/amee/profile_item.rb', line 33

def valid_from
  start_date
end

#value(name_or_path) ⇒ Object 



441
442
443
444
 
# File 'lib/amee/profile_item.rb', line 441

def value(name_or_path)
  val = values.find{ |x| x[:name] == name_or_path || x[:path] == name_or_path}
  val ? val[:value] : nil
end