amee 2.0.31 → 2.0.32

data/lib/amee/data_item_value.rb

@@ -1,4 +1,5 @@
 module AMEE
+  Epoch=DateTime.parse(Time.at(0).xmlschema).utc
   module Data
     class ItemValue < AMEE::Data::Object
 
@@ -34,17 +35,29 @@ module AMEE
         @from_data
       end
       
-      def start_date
-        @start_date
+      attr_accessor :start_date
+      attr_accessor :uid
+
+      def uid_path
+        # create a path which is safe for DIVHs by using the UID if one is avai
+        if uid
+          @path.split(/\//)[0..-2].push(uid).join('/')
+        else
+          @path
+        end
       end
-      
+
+      def full_uid_path
+        "/data#{uid_path}"
+      end
+
       def self.from_json(json, path)
         # Read JSON
-        doc = JSON.parse(json)['itemValue']
+        doc = json.is_a?(String) ? JSON.parse(json)['itemValue'] : json
         data = {}
         data[:uid] = doc['uid']
-        data[:created] = DateTime.parse(doc['created'])
-        data[:modified] = DateTime.parse(doc['modified'])
+        data[:created] = DateTime.parse(doc['created']) rescue nil
+        data[:modified] = DateTime.parse(doc['modified']) rescue nil
         data[:name] = doc['name']
         data[:path] = path.gsub(/^\/data/, '')
         data[:value] = doc['value']
@@ -58,22 +71,27 @@ module AMEE
       
       def self.from_xml(xml, path)
         # Read XML
-        doc = REXML::Document.new(xml)
+        doc = xml.is_a?(String) ? REXML::Document.new(xml) : xml
         data = {}
-        data[:uid] = REXML::XPath.first(doc, "/Resources/DataItemValueResource/ItemValue/@uid").to_s
-        data[:created] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataItemValueResource/ItemValue/@Created").to_s)
-        data[:modified] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataItemValueResource/ItemValue/@Modified").to_s)
-        data[:name] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/Name').text
-        data[:path] = path.gsub(/^\/data/, '')
-        data[:value] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/Value').text
-        data[:type] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/ItemValueDefinition/ValueDefinition/ValueType').text
-        data[:from_profile] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/ItemValueDefinition/FromProfile').text == "true" ? true : false
-        data[:from_data] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/ItemValueDefinition/FromData').text == "true" ? true : false
-        data[:start_date] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataItemValueResource/ItemValue/StartDate").text) rescue nil
-        # Create object
-        ItemValue.new(data)
-      rescue
-        raise AMEE::BadData.new("Couldn't load DataItemValue from XML. Check that your URL is correct.\n#{xml}")
+        if REXML::XPath.match(doc,"descendant-or-self::ItemValue").length>1
+          raise AMEE::BadData.new("Couldn't load DataItemValue from XML. This is an item value history.\n#{xml}")
+        end
+        begin
+          data[:uid] = REXML::XPath.first(doc, "descendant-or-self::ItemValue/@uid").to_s
+          data[:created] = DateTime.parse(REXML::XPath.first(doc, "descendant-or-self::ItemValue/@Created").to_s) rescue nil
+          data[:modified] = DateTime.parse(REXML::XPath.first(doc, "descendant-or-self::ItemValue/@Modified").to_s) rescue nil
+          data[:name] = REXML::XPath.first(doc, 'descendant-or-self::ItemValue/Name').text
+          data[:path] = path.gsub(/^\/data/, '')
+          data[:value] = REXML::XPath.first(doc, 'descendant-or-self::ItemValue/Value').text
+          data[:type] = REXML::XPath.first(doc, 'descendant-or-self::ItemValue/ItemValueDefinition/ValueDefinition/ValueType').text
+          data[:from_profile] =  false
+          data[:from_data] = true
+          data[:start_date] = DateTime.parse(REXML::XPath.first(doc, "descendant-or-self::ItemValue/StartDate").text) rescue nil
+          # Create object
+          ItemValue.new(data)
+        rescue
+          raise AMEE::BadData.new("Couldn't load DataItemValue from XML. Check that your URL is correct.\n#{xml}")
+        end
       end
 
       def self.get(connection, path)
@@ -89,7 +107,32 @@ module AMEE
       end
 
       def save!
-        response = @connection.put(full_path, :value => value).body
+        if start_date
+          ItemValue.update(connection,full_uid_path,:value=>value,
+            :start_date=>start_date,:get_item=>false)
+        else
+          ItemValue.update(connection,full_uid_path,:value=>value,:get_item=>false)
+        end
+      end
+
+      def delete!
+        raise AMEE::BadData.new("Cannot delete initial value for time series") if start_date==AMEE::Epoch
+        ItemValue.delete @connection,full_uid_path
+      end
+
+      def create!
+        data_item_path=path.split(/\//)[0..-2].join('/')
+        data_item=AMEE::Data::Item.new
+        data_item.path=data_item_path
+        data_item.connection=connection
+        data_item.connection or raise "No connection to AMEE available"
+        if start_date
+          ItemValue.create(data_item,:start_date=>start_date,
+            @path.split(/\//).pop.to_sym => value,:get_item=>false)
+        else
+          ItemValue.create(data_item,
+            @path.split(/\//).pop.to_sym => value,:get_item=>false)
+        end
       end
 
       def self.parse(connection, response, path) 
@@ -107,6 +150,7 @@ module AMEE
       end
       
       def self.create(data_item, options = {})
+
         # Do we want to automatically fetch the item afterwards?
         get_item = options.delete(:get_item)
         get_item = true if get_item.nil?
@@ -115,15 +159,15 @@ module AMEE
         unless options.is_a?(Hash)
           raise AMEE::ArgumentError.new("Third argument must be a hash of options!")
         end
+  
         # Set startDate
         if (options[:start_date])
           options[:startDate] = options[:start_date].xmlschema
           options.delete(:start_date)
         end
-      
+
         response = data_item.connection.post(data_item.full_path, options)
         location = response['Location'].match("http://.*?(/.*)")[1]
-
         if get_item == true
           get_options = {}
           get_options[:format] = format if format
@@ -139,6 +183,11 @@ module AMEE
         # Do we want to automatically fetch the item afterwards?
         get_item = options.delete(:get_item)
         get_item = true if get_item.nil?
+        # Set startDate
+        if (options[:start_date])
+          options[:startDate] = options[:start_date].xmlschema if options[:start_date]!=Epoch
+          options.delete(:start_date)
+        end
         # Go
         response = connection.put(path, options)
         if get_item
@@ -155,11 +204,12 @@ module AMEE
       def update(options = {})
         AMEE::Data::ItemValue.update(connection, full_path, options)
       end
-      
+
+
       def self.delete(connection, path)
         connection.delete(path)
-      rescue
-        raise AMEE::BadData.new("Couldn't delete DataItemValue. Check that your information is correct.")
+        rescue
+         raise AMEE::BadData.new("Couldn't delete DataItemValue. Check that your information is correct.")
       end      
     
     end

data/lib/amee/data_item_value_history.rb

@@ -0,0 +1,167 @@
+require 'set'
+
+module AMEE
+  module Data
+    class ItemValueHistory
+
+      def initialize(data = {})
+        @type = data ? data[:type] : nil
+        @path = data ? data[:path] : nil
+        @connection = data ? data[:connection] : nil
+        @values=data&&data[:values] ? data[:values] : []
+        self.series=data[:series] if data[:series]
+      end
+
+      attr_accessor :values
+      attr_accessor :path # the IV path corresponding to the series, without the /data
+      
+      def full_path
+        "/data#{path}"
+      end
+
+      def series
+        values.map {|x|
+          [x.start_date.utc,x.value]
+        }.sort {|x,y|
+          x[0]<=>y[0]
+        }
+      end
+
+      def times
+        values.map {|x|
+          x.start_date.utc
+        }
+      end
+
+      def series=(newseries)
+        raise AMEE::BadData.new("Series must have initial (Epoch) value") unless newseries.any?{|x| x[0]==Epoch}
+        @values=newseries.map{|x|
+          AMEE::Data::ItemValue.new(:value=>x[1],
+            :start_date=>x[0],
+            :path=>path,
+            :connection=>connection,
+            :type=>type
+          )
+        }
+      end
+
+      def value_at(time)
+        selected=values.select{|x| x.start_date==time}
+        raise AMEE::BadData.new("Multiple data item values matching one time.") if selected.length >1
+        raise AMEE::BadData.new("No data item value for that time #{time}.") if selected.length ==0
+        selected[0]
+      end
+
+      def values_at(times)
+        times.map{|x| value_at(x)}
+      end
+
+      def connection=(con)
+        @connection=con
+        @values.each{|x| x.connection=con}
+      end
+
+      attr_reader :connection
+      attr_reader :type
+
+      def self.from_json(json, path)
+        # Read JSON
+        data = {}
+        data[:path] = path.gsub(/^\/data/, '')
+        doc = JSON.parse(json)['itemValues']
+        doc=[JSON.parse(json)['itemValue']] unless doc
+        data[:values]=doc.map do |json_item_value|
+          ItemValue.from_json(json_item_value,path)
+        end
+        data[:type]=data[:values][0].type
+        # Create object
+        ItemValueHistory.new(data)
+      rescue
+        raise AMEE::BadData.new("Couldn't load DataItemValueHistory from JSON. Check that your URL is correct.\n#{json}")
+      end
+      
+      def self.from_xml(xml, path)
+        # Read XML
+        data = {}
+        data[:path] = path.gsub(/^\/data/, '')
+        doc = REXML::Document.new(xml)
+        valuedocs=REXML::XPath.match(doc, '//ItemValue')
+        raise  if valuedocs.length==0
+        data[:values] = valuedocs.map do |xml_item_value|
+          ItemValue.from_xml(xml_item_value,path)
+        end
+        data[:type]=data[:values][0].type
+        # Create object
+        ItemValueHistory.new(data)
+      rescue
+        raise AMEE::BadData.new("Couldn't load DataItemValueHistory from XML. Check that your URL is correct.\n#{xml}")
+      end
+
+      def self.get(connection, path)
+        # Load data from path
+        response = connection.get(path,:valuesPerPage=>2).body
+        # Parse data from response
+        data = {}
+        value = ItemValueHistory.parse(connection, response, path)
+        # Done
+        return value
+      rescue
+        raise AMEE::BadData.new("Couldn't load DataItemValueHistory. Check that your URL is correct.")
+      end
+
+      def save!
+        raise AMEE::BadData.new("Can't save without a path") unless @path
+        raise AMEE::BadData.new("Can't save without a connection") unless @connection
+        origin=ItemValueHistory.get(connection,full_path)
+        changes=compare(origin)
+        changes[:updates].each do |update|
+          # we've decided to identify these, but the version in the thing to be
+          # saved is probably home made, so copy over the uid
+          update.uid=origin.value_at(update.start_date).uid
+          update.save!
+        end
+        changes[:insertions].each do |insertion|
+          insertion.create!
+        end
+        changes[:deletions].each do |deletion|
+          deletion.delete!
+        end
+      end
+
+      def delete!
+         # deprecated, as DI cannot exist without at least one point
+        raise AMEE::NotSupported.new("Cannot delete all of history: at least one data point must always exist.")
+      end
+
+      def create!
+        # deprecated, as DI cannot exist without at least one point
+        raise AMEE::NotSupported.new("Cannot create a Data Item Value History from scratch: at least one data point must exist when the DI is created")
+      end
+
+      def self.parse(connection, response, path) 
+        if response.is_json?
+          history = ItemValueHistory.from_json(response, path)
+        else
+          history = ItemValueHistory.from_xml(response, path)
+        end
+        # Store connection in object for future use
+        history.connection = connection
+        # Done
+        return history
+      rescue
+        raise AMEE::BadData.new("Couldn't load DataItemValueHistory. Check that your URL is correct.\n#{response}")
+      end
+
+      def compare(origin)
+        new=Set.new(times)
+        old=Set.new(origin.times)
+        {
+          :insertions=>values_at(new-old),
+          :deletions=>origin.values_at(old-new),
+          :updates=>values_at(old&new)
+        }
+      end
+
+    end
+  end
+end

data/lib/amee/data_object.rb

@@ -1,9 +1,10 @@
 module AMEE
   module Data
     class Object < AMEE::Object
-    
+
+      attr_accessor :path
       def full_path
-        "/data#{@path}"
+        "/data#{path}"
       end
 
     end

data/lib/amee/exceptions.rb

@@ -23,5 +23,7 @@ module AMEE
 
   class UnknownError < Exception
   end
-  
+
+  class NotSupported < Exception
+  end
 end

data/lib/amee/object.rb

@@ -7,7 +7,7 @@ module AMEE
       @modified = data ? data[:modified] : @created
       @path = data ? data[:path] : nil
       @name = data ? data[:name] : nil
-      @connection = nil
+      @connection = data ? data[:connection] : nil
     end
     
     attr_accessor :connection

data/lib/amee.rb

@@ -1,5 +1,5 @@
 require 'rexml/document'
-require 'activesupport'
+require 'active_support'
 
 # We don't NEED the JSON gem, but if it's available, use it.
 begin
@@ -35,6 +35,7 @@ require 'amee/profile_object'
 require 'amee/data_category'
 require 'amee/data_item'
 require 'amee/data_item_value'
+require 'amee/data_item_value_history'
 require 'amee/profile'
 require 'amee/profile_category'
 require 'amee/profile_item'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: amee
 version: !ruby/object:Gem::Version 
-  version: 2.0.31
+  version: 2.0.32
 platform: ruby
 authors: 
 - James Smith
@@ -9,13 +9,23 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-11 00:00:00 +00:00
+date: 2010-02-26 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
   type: :runtime
   version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
@@ -23,7 +33,7 @@ dependencies:
         version: "0"
     version: 
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: rspec_spinner
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -55,6 +65,7 @@ files:
 - lib/amee/version.rb
 - lib/amee/data_category.rb
 - lib/amee/data_item_value.rb
+- lib/amee/data_item_value_history.rb
 - lib/amee/data_object.rb
 - lib/amee/object.rb
 - lib/amee/shell.rb