amee 3.1.2 → 3.2.0

data/CHANGELOG.txt

@@ -1,5 +1,8 @@
 = Changelog
 
+== 3.2.0
+* Add algorithm details to ItemDefinitions
+
 == 4.1.3 (also 3.1.2 for Rails 2)
 * Documentation update
 

data/VERSION

@@ -1 +1 @@
-3.1.2
+3.2.0

data/amee.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee}
-  s.version = "3.1.2"
+  s.version = "3.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["James Smith", "James Hetherington", "Andrew Hill", "Andrew Berkeley"]
-  s.date = %q{2011-10-04}
+  s.date = %q{2011-11-10}
   s.default_executable = %q{ameesh}
   s.email = %q{james@floppy.org.uk}
   s.executables = ["ameesh"]

data/lib/amee/v3/connection.rb

@@ -3,6 +3,11 @@
 
 module AMEE
   class Connection
+
+    def self.api_version
+      '3'
+    end
+      
     def v3_connection
       @v3_http ||= begin
         @v3_http = Net::HTTP.new(v3_hostname, @port)

data/lib/amee/v3/item_definition.rb

@@ -9,11 +9,12 @@ module AMEE
 
       def initialize_with_v3(data = {})
         @usages = data[:usages] || []
+        @algorithms = data[:algorithms] || {}
         initialize_without_v3(data)
       end
       alias_method_chain :initialize, :v3
 
-      attr_accessor :usages
+      attr_accessor :usages, :algorithms
 
       def self.metaxmlpathpreamble
         '/Representation/ItemDefinition/'
@@ -25,7 +26,7 @@ module AMEE
 
       def self.v3_get(connection, uid, options={})
         # Load data from path
-        response = connection.v3_get("/#{AMEE_API_VERSION}/definitions/#{uid};full", options)
+        response = connection.v3_get("/#{AMEE::Connection.api_version}/definitions/#{uid};full", options)
         # Parse response
         item_definition = ItemDefinition.parse(connection, response, false)
         # Done
@@ -45,6 +46,11 @@ module AMEE
         data[:name] = x 'Name', :doc => doc, :meta => true
         data[:drillDown] = x('DrillDown', :doc => doc, :meta => true).split(",") rescue nil
         data[:usages] = [(x 'Usages/Usage/Name', :doc => doc, :meta => true)].flatten.delete_if{|x| x.nil?}
+        data[:algorithms] = begin
+          names = [(x 'Algorithms/Algorithm/Name', :doc => doc, :meta => true)].flatten.delete_if{|x| x.nil?}
+          uids = [(x 'Algorithms/Algorithm/@uid', :doc => doc, :meta => true)].flatten.delete_if{|x| x.nil?}
+          Hash[names.zip(uids)]
+        end
         # Create object
         ItemDefinition.new(data)
       rescue
@@ -59,11 +65,11 @@ module AMEE
           :usages => @usages.join(','),
           :name => @name
         }
-        @connection.v3_put("/#{AMEE_API_VERSION}/definitions/#{@uid}",save_options)
+        @connection.v3_put("/#{AMEE::Connection.api_version}/definitions/#{@uid}",save_options)
       end
 
       def expire_cache_with_v3
-        @connection.expire_matching("/#{AMEE_API_VERSION}/definitions/#{@uid}.*")
+        @connection.expire_matching("/#{AMEE::Connection.api_version}/definitions/#{@uid}.*")
         expire_cache_without_v3
       end
       alias_method_chain :expire_cache, :v3

data/lib/amee/v3/item_value_definition.rb

@@ -13,7 +13,7 @@ module AMEE
       alias_method_chain :initialize, :v3
 
       def metapath
-        "/#{AMEE_API_VERSION}/definitions/#{itemdefuid}/values/#{uid};wikiDoc;usages"
+        "/#{AMEE::Connection.api_version}/definitions/#{itemdefuid}/values/#{uid};wikiDoc;usages"
       end
       def metaxmlpathpreamble
         '/Representation/ItemValueDefinition/'
@@ -89,7 +89,7 @@ EOF
       end
 
       def expire_cache_with_v3
-        @connection.expire_matching("/#{AMEE_API_VERSION}/definitions/#{itemdefuid}/values/#{uid}.*")
+        @connection.expire_matching("/#{AMEE::Connection.api_version}/definitions/#{itemdefuid}/values/#{uid}.*")
         expire_cache_without_v3
       end
       alias_method_chain :expire_cache, :v3

data/lib/amee/v3/item_value_definition_list.rb

@@ -13,7 +13,7 @@ module AMEE
       alias_method_chain :initialize, :v3
 
       def collectionpath
-        "/#{AMEE_API_VERSION}/definitions/#{@uid}/values;full"
+        "/#{AMEE::Connection.api_version}/definitions/#{@uid}/values;full"
       end
 
       def xmlcollectorpath

data/lib/amee/v3/return_value_definition.rb

@@ -15,7 +15,7 @@ module AMEE
         ReturnValueDefinition
       end
       def collectionpath
-        "/#{AMEE_API_VERSION}/definitions/#{@uid}/returnvalues;full"
+        "/#{AMEE::Connection.api_version}/definitions/#{@uid}/returnvalues;full"
       end
 
       def jsoncollector
@@ -138,7 +138,7 @@ module AMEE
  
 
       def self.load(connection,itemdefuid,ivduid,options={})
-        ReturnValueDefinition.get(connection,"/#{AMEE_API_VERSION}/definitions/#{itemdefuid}/returnvalues/#{ivduid};full",options)
+        ReturnValueDefinition.get(connection,"/#{AMEE::Connection.api_version}/definitions/#{itemdefuid}/returnvalues/#{ivduid};full",options)
       end
 
       def reload(connection)
@@ -178,7 +178,7 @@ module AMEE
         end
         
         options.merge!(:returnobj=>true)
-        response = connection.v3_post("/#{AMEE_API_VERSION}/definitions/#{itemdefuid}/returnvalues", options)
+        response = connection.v3_post("/#{AMEE::Connection.api_version}/definitions/#{itemdefuid}/returnvalues", options)
         return ReturnValueDefinition.load(connection,itemdefuid , response['Location'].split('/')[7])
       rescue
         raise AMEE::BadData.new("Couldn't create ReturnValueDefinition. Check that your information is correct.\n#{response}")
@@ -189,7 +189,7 @@ module AMEE
         # Deleting takes a while... up the timeout to 120 seconds temporarily
         t = connection.timeout
         connection.timeout = 120
-        connection.v3_delete("/#{AMEE_API_VERSION}/definitions/#{itemdefuid}/returnvalues/" + return_value_definition.uid)
+        connection.v3_delete("/#{AMEE::Connection.api_version}/definitions/#{itemdefuid}/returnvalues/" + return_value_definition.uid)
         connection.timeout = t
       rescue
         raise AMEE::BadData.new("Couldn't delete ReturnValueDefinition. Check that your information is correct.")

data/lib/amee/v3.rb

@@ -1,8 +1,6 @@
 # Copyright (C) 2008-2011 AMEE UK Ltd. - http://www.amee.com
 # Released as Open Source Software under the BSD 3-Clause license. See LICENSE.txt for details.
 
-AMEE_API_VERSION = '3.3'
-
 require 'amee/v3/meta_helper'
 require 'amee/v3/collection'
 require 'amee/v3/connection'

data/spec/data_category_spec.rb

@@ -127,7 +127,7 @@ describe AMEE::Data::Category, "with an authenticated XML connection" do
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0)
     connection.should_receive(:get).with("/data/transport/plane/generic", {:itemsPerPage => 10}).and_return(flexmock(:body => '<?xml version="1.0" encoding="UTF-8"?><Resources><DataCategoryResource><Path>/transport/plane/generic</Path><DataCategory created="2007-08-01 09:00:23.0" modified="2007-08-01 09:00:23.0" uid="FBA97B70DBDF"><Name>Generic</Name><Path>generic</Path><Environment uid="5F5887BCF726"/><DataCategory uid="6F3692D81CD9"><Name>Plane</Name><Path>plane</Path></DataCategory><ItemDefinition uid="441BF4BEA15B"/></DataCategory><Children><DataCategories/><DataItems><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="AD63A83B4D41"><kgCO2PerPassengerJourney>0</kgCO2PerPassengerJourney><type>domestic</type><label>domestic</label><size>-</size><path>AD63A83B4D41</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0.158</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="FFC7A05D54AD"><kgCO2PerPassengerJourney>73</kgCO2PerPassengerJourney><type>domestic</type><label>domestic, one way</label><size>one way</size><path>FFC7A05D54AD</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="F5498AD6FC75"><kgCO2PerPassengerJourney>146</kgCO2PerPassengerJourney><type>domestic</type><label>domestic, return</label><size>return</size><path>F5498AD6FC75</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="7D4220DF72F9"><kgCO2PerPassengerJourney>0</kgCO2PerPassengerJourney><type>long haul</type><label>long haul</label><size>-</size><path>7D4220DF72F9</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0.105</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="46117F6C0B7E"><kgCO2PerPassengerJourney>801</kgCO2PerPassengerJourney><type>long haul</type><label>long haul, one way</label><size>one way</size><path>46117F6C0B7E</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="96D538B1B246"><kgCO2PerPassengerJourney>1602</kgCO2PerPassengerJourney><type>long haul</type><label>long haul, return</label><size>return</size><path>96D538B1B246</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="9DA419052FDF"><kgCO2PerPassengerJourney>0</kgCO2PerPassengerJourney><type>short haul</type><label>short haul</label><size>-</size><path>9DA419052FDF</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0.13</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="84B4A14C7424"><kgCO2PerPassengerJourney>170</kgCO2PerPassengerJourney><type>short haul</type><label>short haul, one way</label><size>one way</size><path>84B4A14C7424</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0</kgCO2PerPassengerKm></DataItem><DataItem created="2007-08-01 09:00:41.0" modified="2007-08-01 09:00:41.0" uid="8DA1BEAA1013"><kgCO2PerPassengerJourney>340</kgCO2PerPassengerJourney><type>short haul</type><label>short haul, return</label><size>return</size><path>8DA1BEAA1013</path><source>DfT INAS Division, 29 March 2007</source><kgCO2PerPassengerKm>0</kgCO2PerPassengerKm></DataItem></DataItems><Pager><Start>0</Start><From>1</From><To>9</To><Items>9</Items><CurrentPage>1</CurrentPage><RequestedPage>1</RequestedPage><NextPage>-1</NextPage><PreviousPage>-1</PreviousPage><LastPage>1</LastPage><ItemsPerPage>10</ItemsPerPage><ItemsFound>9</ItemsFound></Pager></Children></DataCategoryResource></Resources>'))
-    connection.should_receive(:v3_get).with("/3.3/definitions/441BF4BEA15B;full",{}).and_return(fixture('itemdef_441BF4BEA15B.xml')).once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/441BF4BEA15B;full",{}).and_return(fixture('itemdef_441BF4BEA15B.xml')).once
     @data = AMEE::Data::Category.get(connection, "/data/transport/plane/generic")
     @data.uid.should == "FBA97B70DBDF"
     @data.itemdef.should == "441BF4BEA15B"

data/spec/fixtures/itemdef.xml

@@ -14,7 +14,12 @@
                 <Name>usageOther</Name>
             </Usage>
         </Usages>
+        <Algorithms>
+            <Algorithm uid="D4E4779CA7AB">
+                <Name>default</Name>
+            </Algorithm>
+        </Algorithms>
     </ItemDefinition>
     <Status>OK</Status>
-    <Version>3.1.0</Version>
+    <Version>3.6.0</Version>
 </Representation>

data/spec/fixtures/itemdef_441BF4BEA15B.xml

@@ -1,14 +1,22 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <Representation>
-    <ItemDefinition created="2007-07-27T07:30:44Z" modified="2010-08-24T17:17:01Z" status="ACTIVE" uid="441BF4BEA15B">
-        <Name>Plane Generic</Name>
-        <DrillDown>type,size</DrillDown>
-        <Usages>
-            <Usage present="true">
-                <Name>default</Name>
-            </Usage>
-        </Usages>
-    </ItemDefinition>
-    <Status>OK</Status>
-    <Version>3.1.0</Version>
-</Representation>
+  <ItemDefinition created="2007-07-27T07:30:44Z" modified="2011-08-17T08:09:06Z" status="ACTIVE" uid="441BF4BEA15B">
+    <Name>Plane Generic</Name>
+    <DrillDown>type,size</DrillDown>
+    <Usages>
+      <Usage present="true">
+        <Name>default</Name>
+      </Usage>
+    </Usages>
+    <Algorithms>
+      <Algorithm uid="EC4B78451B43">
+        <Name>default</Name>
+      </Algorithm>
+      <Algorithm uid="595AF9E4E1E5">
+        <Name>perMonth</Name>
+      </Algorithm>
+    </Algorithms>
+  </ItemDefinition>
+  <Status>OK</Status>
+  <Version>3.6.0</Version>
+</Representation>

data/spec/item_definition_spec.rb

@@ -35,7 +35,7 @@ describe AMEE::Admin::ItemDefinition, "with an authenticated connection" do
 
   it "should parse XML correctly" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214;full", {}).and_return(fixture('BD88D30D1214.xml'))
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214;full", {}).and_return(fixture('BD88D30D1214.xml'))
     @data = AMEE::Admin::ItemDefinition.load(connection,"BD88D30D1214")
     @data.uid.should == "BD88D30D1214"
     @data.created.should == DateTime.new(2007,7,27,7,30,44)
@@ -47,7 +47,7 @@ describe AMEE::Admin::ItemDefinition, "with an authenticated connection" do
 
   it "should parse JSON correctly" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214;full", {}).and_return(fixture('BD88D30D1214.xml'))
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214;full", {}).and_return(fixture('BD88D30D1214.xml'))
     @data = AMEE::Admin::ItemDefinition.load(connection,"BD88D30D1214")
     @data.uid.should == "BD88D30D1214"
     @data.created.should == DateTime.new(2007,7,27,7,30,44)
@@ -59,9 +59,9 @@ describe AMEE::Admin::ItemDefinition, "with an authenticated connection" do
 
   it "should be able to load an item value definition list" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214;full", {}).and_return(fixture('BD88D30D1214.xml'))
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214;full", {}).and_return(fixture('BD88D30D1214.xml'))
     connection.should_receive(:retries).and_return(0).once
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
     @data = AMEE::Admin::ItemDefinition.load(connection,"BD88D30D1214")
     @data.uid.should == "BD88D30D1214"
     @list=@data.item_value_definition_list

data/spec/item_value_definition_spec.rb

@@ -35,7 +35,7 @@ describe AMEE::Admin::ItemValueDefinitionList, "with an authenticated connection
    it "should parse XML correctly" do
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
     @data = AMEE::Admin::ItemValueDefinitionList.new(connection,"BD88D30D1214")
     @data.length.should==15
     @data.first.uid.should=='9813267B616E'
@@ -51,7 +51,7 @@ describe AMEE::Admin::ItemValueDefinitionList, "with an authenticated connection
    it "should apply block filter correctly" do
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
     @data = AMEE::Admin::ItemValueDefinitionList.new(connection,"BD88D30D1214") do |x|
       x.uid == 'A8A212610A57' ? x : nil
     end
@@ -69,7 +69,7 @@ describe AMEE::Admin::ItemValueDefinitionList, "with an authenticated connection
   it "should parse JSON correctly" do
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(fixture('ivdlist_BD88D30D1214.xml')).once
     @data = AMEE::Admin::ItemValueDefinitionList.new(connection,"BD88D30D1214")
     @data.length.should==15
     @data.first.uid.should=='9813267B616E'
@@ -86,8 +86,8 @@ describe AMEE::Admin::ItemValueDefinitionList, "with an authenticated connection
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
     xml = '<?xml version="1.0" encoding="UTF-8"?><Resources></Resources>'
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(xml)
-    connection.should_receive(:expire).with("/3.3/definitions/BD88D30D1214/values;full").once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(xml)
+    connection.should_receive(:expire).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full").once
     lambda{AMEE::Admin::ItemValueDefinitionList.new(connection, "BD88D30D1214")}.should raise_error(AMEE::BadData)
   end
 
@@ -95,15 +95,15 @@ describe AMEE::Admin::ItemValueDefinitionList, "with an authenticated connection
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
     json = '{}'
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(json)
-    connection.should_receive(:expire).with("/3.3/definitions/BD88D30D1214/values;full").once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_return(json)
+    connection.should_receive(:expire).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full").once
     lambda{AMEE::Admin::ItemValueDefinitionList.new(connection, "BD88D30D1214")}.should raise_error(AMEE::BadData)
   end
 
   it "should fail gracefully on other errors" do
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
-    connection.should_receive(:v3_get).with("/3.3/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_raise(Timeout::Error)
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/BD88D30D1214/values;full", {:resultStart=>0, :resultLimit=>10}).and_raise(Timeout::Error)
     lambda{AMEE::Admin::ItemValueDefinitionList.new(connection, "BD88D30D1214")}.should raise_error(Timeout::Error)
   end
 end

data/spec/v3/connection_spec.rb

@@ -26,7 +26,7 @@ describe AMEE::Connection do
       mock.should_receive(:finish => nil)
       mock
     }
-    @c.v3_get("/#{AMEE_API_VERSION}/categories/SomeCategory").should == "OK"
+    @c.v3_get("/#{AMEE::Connection.api_version}/categories/SomeCategory").should == "OK"
   end
 
   it "should be able to get from meta server" do
@@ -35,7 +35,7 @@ describe AMEE::Connection do
       mock.should_receive(:request).and_return(flexmock(:code => '200', :body => "OK"))
       mock.should_receive(:finish => nil)
     end
-    @c.v3_get("/#{AMEE_API_VERSION}/categories/SomeCategory").should == "OK"
+    @c.v3_get("/#{AMEE::Connection.api_version}/categories/SomeCategory").should == "OK"
   end
 
   it "should be able to handle failed gets from meta server" do
@@ -45,8 +45,8 @@ describe AMEE::Connection do
       mock.should_receive(:finish => nil)
     end
     lambda {
-      @c.v3_get("/#{AMEE_API_VERSION}/categories/SomeCategory").should == nil
-    }.should raise_error(AMEE::NotFound, "The URL was not found on the server.\nRequest: GET /#{AMEE_API_VERSION}/categories/SomeCategory")
+      @c.v3_get("/#{AMEE::Connection.api_version}/categories/SomeCategory").should == nil
+    }.should raise_error(AMEE::NotFound, "The URL was not found on the server.\nRequest: GET /#{AMEE::Connection.api_version}/categories/SomeCategory")
   end
 
   it "should be able to post to meta server" do
@@ -55,7 +55,7 @@ describe AMEE::Connection do
       mock.should_receive(:request).and_return(flexmock(:code => '200', :body => "OK"))
       mock.should_receive(:finish => nil)
     end
-    @c.v3_put("/#{AMEE_API_VERSION}/categories/SomeCategory", {:arg => "test"}).should == "OK"
+    @c.v3_put("/#{AMEE::Connection.api_version}/categories/SomeCategory", {:arg => "test"}).should == "OK"
   end
 
   it "should be able to handle failed gets from meta server" do
@@ -65,7 +65,7 @@ describe AMEE::Connection do
       mock.should_receive(:finish => nil)
     end
     lambda {
-      @c.v3_put("/#{AMEE_API_VERSION}/categories/SomeCategory", {:arg => "test"}).should == "OK"
+      @c.v3_put("/#{AMEE::Connection.api_version}/categories/SomeCategory", {:arg => "test"}).should == "OK"
     }.should raise_error
   end
 
@@ -120,7 +120,7 @@ describe AMEE::Connection, "with retry enabled" do
         mock.should_receive(:finish => nil)
       end
       lambda {
-        @c.v3_get("/#{AMEE_API_VERSION}/categories/SomeCategory")
+        @c.v3_get("/#{AMEE::Connection.api_version}/categories/SomeCategory")
       }.should_not raise_error        
     end
 
@@ -131,7 +131,7 @@ describe AMEE::Connection, "with retry enabled" do
         mock.should_receive(:finish => nil)
       end
       lambda {
-        @c.v3_get("/#{AMEE_API_VERSION}/categories/SomeCategory")
+        @c.v3_get("/#{AMEE::Connection.api_version}/categories/SomeCategory")
       }.should raise_error(e)
     end
   end
@@ -150,7 +150,7 @@ describe AMEE::Connection, "with retry enabled" do
         mock.should_receive(:finish => nil)
       end
       lambda {
-        @c.v3_get("/#{AMEE_API_VERSION}/categories/SomeCategory")
+        @c.v3_get("/#{AMEE::Connection.api_version}/categories/SomeCategory")
       }.should_not raise_error        
     end
 
@@ -161,7 +161,7 @@ describe AMEE::Connection, "with retry enabled" do
         mock.should_receive(:finish => nil)
       end
       lambda {
-        @c.v3_get("/#{AMEE_API_VERSION}/categories/SomeCategory")
+        @c.v3_get("/#{AMEE::Connection.api_version}/categories/SomeCategory")
       }.should raise_error(AMEE::ConnectionFailed)
     end
   end  

data/spec/v3/item_definition_spec.rb

@@ -19,7 +19,7 @@ describe AMEE::Admin::ItemDefinition, "with an authenticated v3 connection" do
 
   it "should parse XML correctly" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef.xml'))
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef.xml'))
     @data = AMEE::Admin::ItemDefinition.load(connection,"472D78F6584E")
     @data.uid.should == "472D78F6584E"
     @data.created.should == DateTime.new(2009,8,31,12,41,18)
@@ -27,27 +27,29 @@ describe AMEE::Admin::ItemDefinition, "with an authenticated v3 connection" do
     @data.name.should == "Power Stations And Stuff"
     @data.drill_downs.should == %w{state county metroArea city zipCode plantName powWowWow}
     @data.usages.should == ['usageOne', 'usageThree', 'usageOther']
+    @data.algorithms['default'].should eql "D4E4779CA7AB"
   end
 
-  it "should parse XML correctly if there are no usages" do
+  it "should parse XML correctly if there are no usages or algorithms" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef_no_usages.xml'))
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef_no_usages.xml'))
     @data = AMEE::Admin::ItemDefinition.load(connection,"472D78F6584E")
     @data.usages.should == []
+    @data.algorithms.should == {}
   end
 
   it "should parse XML correctly if there is just one usage" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef_one_usage.xml'))
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef_one_usage.xml'))
     @data = AMEE::Admin::ItemDefinition.load(connection,"472D78F6584E")
     @data.usages.should == ['usageOne']
   end
 
   it "should be able to load an item value definition list" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef.xml')).once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E;full", {}).and_return(fixture('itemdef.xml')).once
     connection.should_receive(:retries).and_return(0).once
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E/values;full", {:resultStart => 0, :resultLimit => 10}).and_return(fixture('ivdlist.xml')).once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E/values;full", {:resultStart => 0, :resultLimit => 10}).and_return(fixture('ivdlist.xml')).once
     @data = AMEE::Admin::ItemDefinition.load(connection,"472D78F6584E")
     @data.uid.should == "472D78F6584E"
     @list=@data.item_value_definition_list
@@ -77,20 +79,20 @@ describe AMEE::Admin::ItemDefinition, "with an authenticated v3 connection" do
   it "should fail gracefully with incorrect data" do
     connection = flexmock "connection"
     xml = '<?xml version="1.0" encoding="UTF-8"?><Resources>'
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E;full", {}).and_return(xml)
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E;full", {}).and_return(xml)
     lambda{AMEE::Admin::ItemDefinition.load(connection, "472D78F6584E")}.should raise_error(AMEE::BadData)
   end
 
   it "should fail gracefully on other errors" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E;full", {}).and_raise("unidentified error")
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E;full", {}).and_raise("unidentified error")
     lambda{AMEE::Admin::ItemDefinition.load(connection, "472D78F6584E")}.should raise_error(AMEE::BadData)
   end
 
   it "should support updating" do
     connection = flexmock "connection"
-    connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E;full", {}).and_return('<?xml version="1.0" encoding="UTF-8" standalone="no"?><Representation><ItemDefinition created="2009-08-31T12:41:18Z" modified="2010-08-13T14:54:33Z" status="ACTIVE" uid="472D78F6584E"><Name>Power Stations And Stuff</Name><DrillDown>state,county,metroArea,city,zipCode,plantName,powWowWow</DrillDown><Usages><Usage present="true"><Name>usageOne</Name></Usage><Usage present="true"><Name>usageThree</Name></Usage><Usage present="false"><Name>usageOther</Name></Usage></Usages></ItemDefinition><Status>OK</Status><Version>#{AMEE_API_VERSION}.0</Version></Representation>').once
-    connection.should_receive(:v3_put).with("/#{AMEE_API_VERSION}/definitions/472D78F6584E", :usages => 'usageOther,usageThree,usageOne', :name => 'Power Stations And Stuff').once
+    connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E;full", {}).and_return('<?xml version="1.0" encoding="UTF-8" standalone="no"?><Representation><ItemDefinition created="2009-08-31T12:41:18Z" modified="2010-08-13T14:54:33Z" status="ACTIVE" uid="472D78F6584E"><Name>Power Stations And Stuff</Name><DrillDown>state,county,metroArea,city,zipCode,plantName,powWowWow</DrillDown><Usages><Usage present="true"><Name>usageOne</Name></Usage><Usage present="true"><Name>usageThree</Name></Usage><Usage present="false"><Name>usageOther</Name></Usage></Usages></ItemDefinition><Status>OK</Status><Version>#{AMEE::Connection.api_version}.0</Version></Representation>').once
+    connection.should_receive(:v3_put).with("/#{AMEE::Connection.api_version}/definitions/472D78F6584E", :usages => 'usageOther,usageThree,usageOne', :name => 'Power Stations And Stuff').once
     @data = AMEE::Admin::ItemDefinition.load(connection,"472D78F6584E")
     @data.usages.should == ['usageOne', 'usageThree', 'usageOther']
     @data.usages.reverse!

data/spec/v3/item_value_definition_spec.rb

@@ -12,14 +12,14 @@ describe AMEE::Admin::ItemValueDefinition, "with an authenticated XML connection
   end
 
   it "should set metadata" do
-    @connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/PQR/values/ABC;wikiDoc;usages").
+    @connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/PQR/values/ABC;wikiDoc;usages").
       and_return(<<HERE
 #{XMLPreamble}
 <Representation>
 </Representation>
 HERE
       ).once
-    @connection.should_receive(:v3_put).with("/#{AMEE_API_VERSION}/definitions/PQR/values/ABC;wikiDoc;usages",
+    @connection.should_receive(:v3_put).with("/#{AMEE::Connection.api_version}/definitions/PQR/values/ABC;wikiDoc;usages",
       :body => <<EOF
 #{XMLPreamble}
 <ItemValueDefinition>
@@ -37,7 +37,7 @@ HERE
 </ItemValueDefinition>
 EOF
 ).once
-    @connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/PQR/values/ABC;wikiDoc;usages").
+    @connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/PQR/values/ABC;wikiDoc;usages").
       and_return(<<HERE
 #{XMLPreamble}
 <Representation>
@@ -51,7 +51,7 @@ HERE
   end
 
   it "should get metadata" do
-    @connection.should_receive(:v3_get).with("/#{AMEE_API_VERSION}/definitions/PQR/values/ABC;wikiDoc;usages").
+    @connection.should_receive(:v3_get).with("/#{AMEE::Connection.api_version}/definitions/PQR/values/ABC;wikiDoc;usages").
       and_return(<<HERE
 #{XMLPreamble}
 <Representation>
@@ -87,7 +87,7 @@ HERE
     <FromProfile>false</FromProfile>
   </ItemValueDefinition>
   <Status>OK</Status>
-  <Version>#{AMEE_API_VERSION}.0</Version>
+  <Version>#{AMEE::Connection.api_version}.0</Version>
 </Representation>
 HERE
     ).once

data/spec/v3/return_value_definition_spec.rb

@@ -31,7 +31,7 @@ describe AMEE::Admin::ReturnValueDefinition, "with an authenticated XML connecti
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
     connection.should_receive(:v3_get).
-      with("/#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues;full", {:resultLimit=>10, :resultStart=>0}).
+      with("/#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues;full", {:resultLimit=>10, :resultStart=>0}).
       and_return(fixture('return_value_definition_list.xml')).once
     list=AMEE::Admin::ReturnValueDefinitionList.new(connection,Testcativduid)
     list.should have(3).items
@@ -40,7 +40,7 @@ describe AMEE::Admin::ReturnValueDefinition, "with an authenticated XML connecti
     connection = flexmock "connection"
     connection.should_receive(:retries).and_return(0).once
     connection.should_receive(:v3_get).
-      with("/#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues;full", {:resultLimit=>10, :resultStart=>0}).
+      with("/#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues;full", {:resultLimit=>10, :resultStart=>0}).
       and_return(fixture('empty_return_value_definition_list.xml')).once
     list=AMEE::Admin::ReturnValueDefinitionList.new(connection,Testcativduid)
     list.should have(0).items
@@ -48,13 +48,13 @@ describe AMEE::Admin::ReturnValueDefinition, "with an authenticated XML connecti
   it "should create a return value definition" do
     connection = flexmock "connection"
     connection.should_receive(:v3_get).
-      with("/#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid};full", {}).
+      with("/#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid};full", {}).
       and_return(fixture('return_value_definition.xml')).once
     connection.should_receive(:v3_post).
-      with("/#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues",  
+      with("/#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues",  
       {:type=>"CO2", :valueDefinition=>"45433E48B39F",
         :returnobj=>true, :unit=>"kg", :perUnit=>"month"}).
-      and_return({'Location'=>"///#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid}"}).once
+      and_return({'Location'=>"///#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid}"}).once
     rvd=AMEE::Admin::ReturnValueDefinition.create(connection,Testcativduid,
       :type=>'CO2',:unit=>'kg',:perUnit=>'month')
     
@@ -66,7 +66,7 @@ describe AMEE::Admin::ReturnValueDefinition, "with an authenticated XML connecti
   it "should read a return value definition" do
     connection = flexmock "connection"
     connection.should_receive(:v3_get).
-      with("/#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid};full", {}).
+      with("/#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid};full", {}).
       and_return(fixture('return_value_definition.xml')).once
     rvd=AMEE::Admin::ReturnValueDefinition.load(connection,Testcativduid,Testrvduid)
    
@@ -78,10 +78,10 @@ describe AMEE::Admin::ReturnValueDefinition, "with an authenticated XML connecti
   it "should delete a return value definition" do
     connection = flexmock "connection"
     connection.should_receive(:v3_get).
-      with("/#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid};full", {}).
+      with("/#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid};full", {}).
       and_return(fixture('return_value_definition.xml')).once
     connection.should_receive(:v3_delete).
-      with("/#{AMEE_API_VERSION}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid}").once
+      with("/#{AMEE::Connection.api_version}/definitions/#{Testcativduid}/returnvalues/#{Testrvduid}").once
     connection.should_receive(:timeout=)
      connection.should_receive(:timeout)
     rvd=AMEE::Admin::ReturnValueDefinition.load(connection,Testcativduid,Testrvduid)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amee
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 15
   prerelease: 
   segments: 
   - 3
-  - 1
   - 2
-  version: 3.1.2
+  - 0
+  version: 3.2.0
 platform: ruby
 authors: 
 - James Smith
@@ -18,12 +18,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-04 00:00:00 +01:00
+date: 2011-11-10 00:00:00 +00:00
 default_executable: ameesh
 dependencies: 
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :runtime
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -35,11 +34,11 @@ dependencies:
         - 3
         - 5
         version: 2.3.5
+  type: :runtime
   name: activesupport
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :runtime
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -49,11 +48,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :runtime
   name: json
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :runtime
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -63,11 +62,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :runtime
   name: log4r
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :runtime
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -80,11 +79,11 @@ dependencies:
         - 3
         - 1
         version: 1.4.3.1
+  type: :runtime
   name: nokogiri
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -96,11 +95,11 @@ dependencies:
         - 0
         - 0
         version: 1.0.0
+  type: :development
   name: bundler
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -112,11 +111,11 @@ dependencies:
         - 6
         - 4
         version: 1.6.4
+  type: :development
   name: jeweler
   version_requirements: *id006
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
   requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -128,11 +127,11 @@ dependencies:
         - 3
         - 0
         version: 1.3.0
+  type: :development
   name: rspec
   version_requirements: *id007
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
   requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -142,11 +141,11 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :development
   name: rcov
   version_requirements: *id008
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
   requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -158,11 +157,11 @@ dependencies:
         - 1
         - 3
         version: 1.1.3
+  type: :development
   name: rspec_spinner
   version_requirements: *id009
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
   requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -174,11 +173,11 @@ dependencies:
         - 3
         - 5
         version: 2.3.5
+  type: :development
   name: activerecord
   version_requirements: *id010
 - !ruby/object:Gem::Dependency 
   prerelease: false
-  type: :development
   requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
@@ -188,6 +187,7 @@ dependencies:
         segments: 
         - 0
         version: "0"
+  type: :development
   name: flexmock
   version_requirements: *id011
 description: