Floppy-amee 2.0.16 → 2.0.17

data/README

@@ -8,6 +8,8 @@ Author: James Smith (james@floppy.org.uk / http://www.floppy.org.uk)
 
 Homepage: http://github.com/Floppy/amee-ruby
 
+Documentation: http://docs.github.com/Floppy/amee-ruby
+
 == INSTALLATION
 
 1) Enable gems from github, if you haven't already done so (rubygems >= 1.2): 

data/lib/amee/data_category.rb

@@ -110,6 +110,58 @@ module AMEE
         AMEE::Data::DrillDown.get(connection, "#{full_path}/drill")
       end
 
+      def item(options)
+        # Search fields - from most specific to least specific
+        item = items.find{ |x| (x[:uid] && x[:uid] == options[:uid]) ||
+                               (x[:name] && x[:name] == options[:name]) ||
+                               (x[:path] && x[:path] == options[:path]) ||
+                               (x[:label] && x[:label] == options[:label]) }
+        # Pass through some options
+        new_opts = {}
+        new_opts[:format] = options[:format] if options[:format]
+        item ? AMEE::Data::Item.get(connection, "#{full_path}/#{item[:path]}", new_opts) : nil
+      end
+
+      def self.create(category, options = {})
+
+        connection = category.connection
+        path = category.full_path
+        
+        # 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
+        # Send data to path
+        options[:newObjectType] = "DC"
+        response = connection.post(path, options)
+        if response['Location']
+          location = response['Location'].match("http://.*?(/.*)")[1]
+        else
+          category = Category.parse(connection, response.body)
+          location = category.full_path
+        end
+        if get_item == true
+          get_options = {}
+          get_options[:format] = format if format
+          return AMEE::Data::Category.get(connection, location, get_options)
+        else
+          return location
+        end
+      rescue
+        raise AMEE::BadData.new("Couldn't create DataCategory. Check that your information is correct.")
+      end
+
+     def self.delete(connection, path)
+       connection.delete(path)
+     rescue
+       raise AMEE::BadData.new("Couldn't delete DataCategory. Check that your information is correct.")
+     end
+       
     end
   end
 end

data/lib/amee/data_item.rb

@@ -8,6 +8,7 @@ module AMEE
         @label = data[:label]
         @item_definition = data[:item_definition]
         @total_amount = data[:total_amount]
+        @total_amount_unit = data[:total_amount_unit]
         super
       end
 
@@ -16,6 +17,7 @@ module AMEE
       attr_reader :label
       attr_reader :item_definition
       attr_reader :total_amount
+      attr_reader :total_amount_unit
 
       def self.from_json(json)
         # Read JSON
@@ -28,7 +30,14 @@ module AMEE
         data[:path] = doc['path']
         data[:label] = doc['dataItem']['label']
         data[:item_definition] = doc['dataItem']['itemDefinition']['uid']
-        data[:total_amount] = doc['amountPerMonth'] rescue nil
+        # Read v2 total
+        data[:total_amount] = doc['amount']['value'] rescue nil
+        data[:total_amount_unit] = doc['amount']['unit'] rescue nil
+        # Read v1 total
+        if data[:total_amount].nil?
+          data[:total_amount] = doc['amountPerMonth'] rescue nil
+          data[:total_amount_unit] = "kg/month"
+        end
         # Get values
         data[:values] = []
         doc['dataItem']['itemValues'].each do |value|
@@ -64,7 +73,14 @@ module AMEE
         data[:path] = (REXML::XPath.first(doc, '/Resources/DataItemResource/Path') || REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/path')).text
         data[:label] = (REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/Label') || REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/label')).text
         data[:item_definition] = REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/ItemDefinition/@uid').to_s
-        data[:total_amount] = REXML::XPath.first(doc, '/Resources/DataItemResource/AmountPerMonth').text.to_f rescue nil
+        # Read v2 total
+        data[:total_amount] = REXML::XPath.first(doc, '/Resources/DataItemResource/Amount').text.to_f rescue nil
+        data[:total_amount_unit] = REXML::XPath.first(doc, '/Resources/DataItemResource/Amount/@unit').to_s rescue nil
+        # Read v1 total
+        if data[:total_amount].nil?
+          data[:total_amount] = REXML::XPath.first(doc, '/Resources/DataItemResource/AmountPerMonth').text.to_f rescue nil
+          data[:total_amount_unit] = "kg/month"
+        end
         # Get values
         data[:values] = []
         REXML::XPath.each(doc, '/Resources/DataItemResource/DataItem/ItemValues/ItemValue') do |value|
@@ -107,6 +123,72 @@ module AMEE
         raise AMEE::BadData.new("Couldn't load DataItem. Check that your URL is correct.")
       end
 
+      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!({:DataItems => items})
+        post_data = options.to_xml(:root => "DataCategory", :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::Data::Category.parse(connection, response)
+        else
+          return true
+        end
+      end
+
+      def self.create(category, options = {})
+        create_without_category(category.connection, category.full_path, options)
+      end
+
+      def self.create_without_category(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?
+        # 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
+        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
+        # Create a data item!
+        options[:newObjectType] = "DI"
+        # Send data to path
+        response = connection.post(path, options)
+#        if response['Location']
+#          location = response['Location'].match("http://.*?(/.*)")[1]
+#        else
+#          category = Category.parse(connection, response.body)
+#          location = category.full_path + "/" + category.items[0][:path]
+#        end
+#        if get_item == true
+#          get_options = {}
+#          get_options[:format] = format if format
+#          return AMEE::Data::Item.get(connection, location, get_options)
+#        else
+#          return location
+#        end
+      rescue
+        raise AMEE::BadData.new("Couldn't create DataItem. Check that your information is correct.")
+      end
+
       def update(options = {})
         response = connection.put(full_path, options).body
       rescue

data/lib/amee/item_definition.rb

@@ -1,5 +1,49 @@
 module AMEE
   module Admin
+
+    class ItemDefinitionList < Array
+
+      def initialize(connection, options = {})
+        # Load data from path
+        response = connection.get('/definitions/itemDefinitions', options).body
+        # Parse data from response
+        if response.is_json?
+          # Read JSON
+          doc = JSON.parse(response)
+          @pager = AMEE::Pager.from_json(doc['pager'])
+          doc['itemDefinitions'].each do |p|
+            data = {}
+            data[:uid] = p['uid']
+            data[:name] = p['name']
+            # Create ItemDefinition
+            item_definition = ItemDefinition.new(data)
+            # Store in array
+            self << item_definition
+          end
+        else
+          # Read XML
+          doc = REXML::Document.new(response)
+          @pager = AMEE::Pager.from_xml(REXML::XPath.first(doc, '/Resources/ItemDefinitionsResource/Pager'))
+          REXML::XPath.each(doc, '/Resources/ItemDefinitionsResource/ItemDefinitions/ItemDefinition') do |p|
+            data = {}
+            data[:uid] = p.attributes['uid'].to_s
+            data[:name] = p.elements['Name'].text || data[:uid]
+            # Create ItemDefinition
+            item_definition = ItemDefinition.new(data)
+            # Store connection in ItemDefinition object
+            item_definition.connection = connection
+            # Store in array
+            self << item_definition
+          end
+        end
+      rescue
+        raise AMEE::BadData.new("Couldn't load ItemDefinition list.")
+      end
+
+      attr_reader :pager
+
+    end
+
     class ItemDefinition < AMEE::Object
 
       def initialize(data = {})
@@ -9,6 +53,23 @@ module AMEE
 
       attr_reader :name
 
+      def self.list(connection)
+        ItemDefinitionList.new(connection)
+      end
+
+      def self.parse(connection, response, is_list = true)
+        # Parse data from response
+        if response.is_json?
+          item_definition = ItemDefinition.from_json(response)
+        else
+          item_definition = ItemDefinition.from_xml(response, is_list)
+        end
+        # Store connection in object for future use
+        item_definition.connection = connection
+        # Done
+        return item_definition
+      end
+
       def self.from_json(json)
         # Read JSON
         doc = JSON.parse(json)
@@ -22,15 +83,16 @@ module AMEE
       rescue
         raise AMEE::BadData.new("Couldn't load ItemDefinition from JSON. Check that your URL is correct.")
       end
-      
-      def self.from_xml(xml)
+
+      def self.from_xml(xml, is_list = true)
+        prefix = is_list ? "/Resources/ItemDefinitionsResource/" : "/Resources/ItemDefinitionResource/"
         # Parse data from response into hash
         doc = REXML::Document.new(xml)
         data = {}
-        data[:uid] = REXML::XPath.first(doc, "/Resources/ItemDefinitionResource/ItemDefinition/@uid").to_s
-        data[:created] = DateTime.parse(REXML::XPath.first(doc, "/Resources/ItemDefinitionResource/ItemDefinition/@created").to_s)
-        data[:modified] = DateTime.parse(REXML::XPath.first(doc, "/Resources/ItemDefinitionResource/ItemDefinition/@modified").to_s)
-        data[:name] = REXML::XPath.first(doc, '/Resources/ItemDefinitionResource/ItemDefinition/Name').text
+        data[:uid] = REXML::XPath.first(doc, prefix + "ItemDefinition/@uid").to_s
+        data[:created] = DateTime.parse(REXML::XPath.first(doc, prefix + "ItemDefinition/@created").to_s)
+        data[:modified] = DateTime.parse(REXML::XPath.first(doc, prefix + "ItemDefinition/@modified").to_s)
+        data[:name] = REXML::XPath.first(doc, prefix + "ItemDefinition/Name").text
         # Create object
         ItemDefinition.new(data)
       rescue
@@ -40,14 +102,8 @@ module AMEE
       def self.get(connection, path, options = {})
         # Load data from path
         response = connection.get(path, options).body
-        # Parse data from response
-        if response.is_json?
-          item_definition = ItemDefinition.from_json(response)
-        else
-          item_definition = ItemDefinition.from_xml(response)
-        end
-        # Store connection in object for future use
-        item_definition.connection = connection
+        # Parse response
+        item_definition = ItemDefinition.parse(connection, response, false)
         # Done
         return item_definition
       rescue
@@ -60,6 +116,32 @@ module AMEE
         raise AMEE::BadData.new("Couldn't update ItemDefinition. Check that your information is correct.")
       end
 
+      def self.create(connection, options = {})
+        unless options.is_a?(Hash)
+          raise AMEE::ArgumentError.new("Second argument must be a hash of options!")
+        end
+        # Send data
+        response = connection.post("/definitions/itemDefinitions", options).body
+        # Parse response
+        item_definition = ItemDefinition.parse(connection, response)
+        # Get the ItemDefinition again
+        return ItemDefinition.get(connection, "/definitions/itemDefinitions/" + item_definition.uid)
+      rescue
+        raise AMEE::BadData.new("Couldn't create ItemDefinition. Check that your information is correct.")
+      end
+
+      def self.delete(connection, item_definition)
+        # Deleting takes a while... up the timeout to 120 seconds temporarily
+        t = connection.timeout
+        connection.timeout = 120
+        connection.delete("/definitions/itemDefinitions/" + item_definition.uid)
+        connection.timeout = t
+      rescue
+        raise AMEE::BadData.new("Couldn't delete ProfileItem. Check that your information is correct.")
+      end
+
     end
+
   end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Floppy-amee
 version: !ruby/object:Gem::Version 
-  version: 2.0.16
+  version: 2.0.17
 platform: ruby
 authors: 
 - James Smith