amee 4.3.2 → 4.4.0

data/lib/amee/data_category.rb

@@ -168,8 +168,8 @@ module AMEE
         # Send data to path
         options[:newObjectType] = "DC"
         response = connection.post(path, options)
-        if response['Location']
-          location = response['Location'].match("https??://.*?(/.*)")[1]
+        if response.headers_hash.has_key?('Location') && response.headers_hash['Location']
+          location = response.headers_hash['Location'].match("https??://.*?(/.*)")[1]
         else
           category = Category.parse(connection, response.body)
           location = category.full_path

data/lib/amee/data_item.rb

@@ -14,6 +14,8 @@ module AMEE
         @item_definition_uid = data[:item_definition]
         @total_amount = data[:total_amount]
         @total_amount_unit = data[:total_amount_unit]
+        @amounts = data[:amounts] || []
+        @notes = data[:notes] || []
         @start_date = data[:start_date]
         @category_uid = data[:category_uid]
         super
@@ -24,6 +26,8 @@ module AMEE
       attr_reader :label
       attr_reader :total_amount
       attr_reader :total_amount_unit
+      attr_reader :amounts
+      attr_reader :notes
       attr_reader :start_date
       attr_reader :category_uid
       attr_reader :item_definition_uid
@@ -55,6 +59,28 @@ module AMEE
             data[:total_amount] = doc['amountPerMonth'] rescue nil
             data[:total_amount_unit] = "kg/month"
           end
+          # Read amounts
+          if doc['amounts']
+            if doc['amounts']['amount']
+              data[:amounts] = doc['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['amounts']['note']
+              data[:notes] = doc['amounts']['note'].map do |item|
+                {
+                  :type => item['type'],
+                  :value => item['value'],
+                }
+              end
+            end
+          end
           # Get values
           data[:values] = []
           doc['dataItem']['itemValues'].each do |value|
@@ -103,6 +129,23 @@ module AMEE
             data[:total_amount] = REXML::XPath.first(doc, '/Resources/DataItemResource/AmountPerMonth').text.to_f rescue nil
             data[:total_amount_unit] = "kg/month"
           end
+          data[:amounts] = []
+          REXML::XPath.each(doc,'/Resources/DataItemResource/Amounts/Amount') do |amount|
+            amount_data = {}
+            amount_data[:type] = amount.attribute('type').value
+            amount_data[:value] = amount.text.to_f
+            amount_data[:unit] = amount.attribute('unit').value
+            amount_data[:per_unit] = amount.attribute('perUnit').value if amount.attribute('perUnit')
+            amount_data[:default] = (amount.attribute('default').value == 'true') if amount.attribute('default')
+            data[:amounts] << amount_data
+          end
+          data[:notes] = []
+          REXML::XPath.each(doc,'/Resources/DataItemResource/Amounts/Note') do |note|
+            note_data = {}
+            note_data[:type] = note.attribute('type').value
+            note_data[:value] = note.text
+            data[:notes] << note_data
+          end
           # Get values
           data[:values] = []
           REXML::XPath.each(doc, '/Resources/DataItemResource/DataItem/ItemValues/ItemValue') do |value|
@@ -188,8 +231,8 @@ module AMEE
         options[:newObjectType] = "DI"
         # Send data to path
         response = connection.post(path, options)
-        if response['Location']
-          location = response['Location'].match("https??://.*?(/.*)")[1]
+        if response.headers_hash.has_key?('Location') && response.headers_hash['Location']
+          location = response.headers_hash['Location'].match("https??://.*?(/.*)")[1]
         else
           category = Category.parse(connection, response.body)
           location = category.full_path + "/" + category.items[0][:path]

data/lib/amee/data_item_value.rb

@@ -175,7 +175,7 @@ module AMEE
         end
 
         response = data_item.connection.post(data_item.full_path, options)
-        location = response['Location'].match("https??://.*?(/.*)")[1]
+        location = response.headers_hash['Location'].match("https??://.*?(/.*)")[1]
         if get_item == true
           get_options = {}
           get_options[:format] = format if format

data/lib/amee/exceptions.rb

@@ -20,7 +20,7 @@ module AMEE
       end
     end
   end
-  
+
   class BadRequest < Exception
   end
 
@@ -32,7 +32,10 @@ module AMEE
 
   class ConnectionFailed < Exception
   end
-  
+
+  class TimeOut < Exception
+  end
+    
   class NotFound < Exception
   end
   

data/lib/amee/parse_helper.rb

@@ -2,6 +2,7 @@
 # Released as Open Source Software under the BSD 3-Clause license. See LICENSE.txt for details.
 
 module ParseHelper
+  
   def x(xpath,options = {})
     doc = options[:doc] || @doc
     preamble = options[:meta] == true ? metaxmlpathpreamble : xmlpathpreamble
@@ -36,6 +37,7 @@ module ParseHelper
   def xmlpathpreamble
     ''
   end
+  
   def load_xml_doc(xml)
     doc = Nokogiri.XML(xml) { |config| config.strict }
     doc.remove_namespaces!

data/lib/amee/profile_item.rb

@@ -1,6 +1,9 @@
 # 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.
 
+require 'active_support/core_ext/hash/conversions'
+require 'active_support/inflector'
+
 module AMEE
   module Profile
     class Item < AMEE::Profile::Object
@@ -314,8 +317,8 @@ module AMEE
         response = connection.post(path, options)
         # Parse response
         category = response.body.empty? ? nil : Category.parse(connection, response.body, options)
-        if response['Location']
-          location = response['Location'].match("https??://.*?(/.*)")[1]
+        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
@@ -335,6 +338,7 @@ module AMEE
               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 = {}

data/lib/amee/v3/connection.rb

@@ -6,61 +6,97 @@ require 'active_support/core_ext/string'
 module AMEE
   class Connection
 
+    # API version used in URLs
     def self.api_version
       '3'
     end
-      
-    def v3_connection
-      @v3_http ||= begin
-        @v3_http = Net::HTTP.new(v3_hostname, @port)
-        if @ssl == true
-          @v3_http.use_ssl = true
-          if File.exists? RootCA
-            @v3_http.ca_file = RootCA
-            @v3_http.verify_mode = OpenSSL::SSL::VERIFY_PEER
-            @v3_http.verify_depth = 5
-          end
-        end
-        @v3_http.set_debug_output($stdout) if @debug
-        @v3_http
-      end
-    end    
+
+    # Perform a GET request
+    # options hash should contain query parameters
     def v3_get(path, options = {})
-      # Create URL parameters
-      unless options.empty?
-        path += "?" + options.map { |x| "#{CGI::escape(x[0].to_s)}=#{CGI::escape(x[1].to_s)}" }.join('&')
-      end
-      cache(path) { v3_request(Net::HTTP::Get.new(path)) }
+      # Create request parameters
+      get_params = {
+        :method => "get"
+      }
+      get_params[:params] = options unless options.empty?
+      # Send request (with caching)
+      v3_do_request(get_params, path, :cache => true)
     end
+
+    # Perform a PUT request
+    # options hash should contain request body parameters
     def v3_put(path, options = {})
+      # Expire cached objects from parent on down
       expire_matching "#{parent_path(path)}.*"
-      put = Net::HTTP::Put.new(path)
-      if options[:body]
-        put.body = options[:body]
-        put['Content-Type'] = content_type :xml if options[:body].is_xml?
-        put['Content-Type'] = content_type :json if options[:body].is_json?
-      else
-        put.set_form_data(options)
+      # Create request parameters
+      put_params = { 
+        :method => "put",
+        :body => options[:body] ? options[:body] : form_encode(options)
+      }
+      if options[:content_type]
+        put_params[:headers] = {
+          :'Content-Type' => content_type(options[:content_type])
+        }
       end
-      v3_request put
+      # Request
+      v3_do_request(put_params, path)
     end
+
+    # Perform a POST request
+    # options hash should contain request body parameters
+    # It can also contain a :returnobj parameter which will cause
+    # a full reponse object to be returned instead of just the body
     def v3_post(path, options = {})
+      # Expire cached objects from here on down
       expire_matching "#{raw_path(path)}.*"
-      post = Net::HTTP::Post.new(path)
-      returnobj=options.delete(:returnobj) || false
-      post.set_form_data(options)
-      v3_request post,returnobj
+      # Get 'return full response object' flag
+      return_obj = options.delete(:returnobj) || false
+      # Create request parameters
+      post_params = {
+        :method => "post",
+        :body => form_encode(options)
+      }
+      if options[:content_type]
+        post_params[:headers] = {
+          :'Content-Type' => content_type(options[:content_type])
+        }
+      end
+      # Request
+      v3_do_request(post_params, path, :return_obj => return_obj)
     end
-     def v3_delete(path, options = {})
+
+    # Perform a POST request
+    def v3_delete(path)
+      # Expire cached objects from here on down
       expire_matching "#{parent_path(path)}.*"
-      delete = Net::HTTP::Delete.new(path)
-      v3_request delete
-    end
-    def v3_auth
-      # now the same as v2, i.e.
-      [@username,@password]
+      # Create request parameters
+      delete_params = { 
+        :method => "delete" 
+      }
+      # Request
+      v3_do_request(delete_params, path)
     end
+
     private
+    
+    # Default request parameters
+    def v3_defaults
+      {
+        :verbose => DEBUG,
+        :follow_location => true,
+        :username => @username,
+        :password => @password
+      }
+    end
+
+    # Wrap up parameters into a request and execute it
+    def v3_do_request(params, path, options = {})
+      req = Typhoeus::Request.new("https://#{v3_hostname}#{path}", v3_defaults.merge(params))
+      response = do_request(req, :xml, options)
+      options[:return_obj]==true ? response : response.body
+    end
+    
+    # Work out v3 hostname corresponding to v2 hostname
     def v3_hostname
       unless @server.starts_with?("platform-api-")
         if @server.starts_with?("platform-")
@@ -72,35 +108,6 @@ module AMEE
         @server
       end
     end
-    def v3_request(req,returnobj=false)
-      # Open HTTP connection
-      v3_connection.start
-      # Set auth
-      req.basic_auth *v3_auth
-      # Do request
-      timethen=Time.now
-      response = send_request(v3_connection, req, :xml)
-      Logger.log.debug("Requested #{req.class} at #{req.path} with #{req.body}, taking #{(Time.now-timethen)*1000} miliseconds")
-      v3_response_ok? response, req
-      returnobj ? response : response.body
-    ensure
-      v3_connection.finish if v3_connection.started?
-    end
- 
-    def v3_response_ok?(response, request)
-      case response.code
-        when '200', '201', '204'
-          return true
-        when '404'
-          raise AMEE::NotFound.new("The URL was not found on the server.\nRequest: #{request.method} #{request.path}")
-        when '403'
-          raise AMEE::PermissionDenied.new("You do not have permission to perform the requested operation.\nRequest: #{request.method} #{request.path}\n#{request.body}\Response: #{response.body}")
-        when '401'
-          raise AMEE::AuthFailed.new("Authentication failed. Please check your username and password.")
-        when '400'
-          raise AMEE::BadRequest.new("Bad request. This is probably due to malformed input data.\nRequest: #{request.method} #{request.path}\n#{request.body}\Response: #{response.body}")
-      end
-      raise AMEE::UnknownError.new("An error occurred while talking to AMEE: HTTP response code #{response.code}.\nRequest: #{request.method} #{request.path}\n#{request.body}\Response: #{response.body}")
-    end
+      
   end
 end

data/lib/amee/v3/item_value_definition.rb

@@ -50,7 +50,7 @@ EOF
   </Usages>
 </ItemValueDefinition>
 EOF
-        {:body => str}
+        {:body => str, :content_type => :xml}
       end
       def usages
         @usages.keys

data/lib/amee/v3/return_value_definition.rb

@@ -179,7 +179,7 @@ module AMEE
         
         options.merge!(:returnobj=>true)
         response = connection.v3_post("/#{AMEE::Connection.api_version}/definitions/#{itemdefuid}/returnvalues", options)
-        return ReturnValueDefinition.load(connection,itemdefuid , response['Location'].split('/')[7])
+        return ReturnValueDefinition.load(connection,itemdefuid , response.headers_hash['Location'].split('/')[7])
       rescue
         raise AMEE::BadData.new("Couldn't create ReturnValueDefinition. Check that your information is correct.\n#{response}")
       end

data/spec/cache_spec.rb

@@ -9,14 +9,35 @@ describe AMEE::Connection do
   describe 'without caching' do
 
     it "doesn't cache GET requests" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).twice.and_return(flexmock(:code => '200', :body => fixture('data_home_energy_quantity.xml')))
-        mock.should_receive(:finish => nil)
-      end
-      @connection = AMEE::Connection.new("server.example.com", "username", "password")
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+      VCR.use_cassette("AMEE_Connection_Caching_Off/logging_in") do
+        @connection = AMEE::Connection.new("stage.amee.com", "amee_ruby_vcr_v2", "8nkj8rm7")
+      end
+
+      VCR.use_cassette("AMEE_Connection_Caching_Off/authenticating") do
+        @connection.authenticate
+      end
+      
+      VCR.use_cassette("AMEE_Connection_Caching_Off/first_request") do
+        @first_response = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+      end
+
+      VCR.use_cassette("AMEE_Connection_Caching_Off/second_request") do
+        @second_response = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+      end
+    
+      # We're checking to see if we actually have a returned object.
+      # If there's no response in the VCR cassette, then we can't build the object
+      # to check if it responds to the methods below
+      @first_response.should respond_to(:uid)
+      @first_response.should respond_to(:name)
+
+      # Likewise with the second response. There needs to be a yaml file to read from to
+      # build the object. 
+      File.exists?('cassettes/AMEE_Connection_Caching_Off/second_request.yml').should be true
+      # Then we check for the same content to see we can build the object needed.
+      @second_response.should respond_to(:uid)
+      @second_response.should respond_to(:name)
+
     end
 
   end
@@ -24,61 +45,86 @@ describe AMEE::Connection do
   describe 'with caching' do
 
     def setup_connection
-      @connection = AMEE::Connection.new("server.example.com", "username", "password", :cache => :memory_store)
+      VCR.use_cassette("AMEE_Connection_Caching_On/logging_in") do
+        @connection = AMEE::Connection.new("stage.amee.com", "amee_ruby_vcr_v2", "8nkj8rm7", :cache => :memory_store)
+      end
+
+      VCR.use_cassette("AMEE_Connection_Caching_On/authenticating") do
+        @connection.authenticate
+      end
+      
+      VCR.use_cassette("AMEE_Connection_Caching_On/first_request") do
+        @first_response = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+      end
     end
 
     it "caches GET requests" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).once.and_return(OpenStruct.new(:code => '200', :body => fixture('data_home_energy_quantity.xml')))
-        mock.should_receive(:finish => nil)
-      end
+
       setup_connection
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+
+      VCR.use_cassette("AMEE_Connection_Caching_On/second_request") do
+        @second_response = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+      end
+
+      # We're checking to see if we actually have a returned object.
+      # If there's no response in the VCR cassette, then we can't build the object
+      # to check if it responds to the methods below
+      @first_response.should respond_to(:uid)
+      @first_response.should respond_to(:name)
+
+      # Likewise with the second response. When caching is on, we don't want to see a second 
+      # request being recorded, but we still want to see the object being built
+      File.exists?('cassettes/AMEE_Connection_Caching_On/second_request.yml').should be false
+      # Then we check for the same content to see we can build the object needed.
+      @second_response.should respond_to(:uid)
+      @second_response.should respond_to(:name)
     end
 
     it "allows complete cache clear" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).twice.and_return(OpenStruct.new(:code => '200', :body => fixture('data_home_energy_quantity.xml')))
-        mock.should_receive(:finish => nil)
-      end
+
       setup_connection
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
       @connection.expire_all
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+
+      VCR.use_cassette("AMEE_Connection_Caching_clear_all/second_request") do
+        @second_response = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
+      end
+
+      File.exists?('cassettes/AMEE_Connection_Caching_clear_all/second_request.yml').should be true      
+      @second_response.should respond_to(:uid)
+      @second_response.should respond_to(:name)
     end
 
     it "allows manual cache expiry for objects" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).twice.and_return(OpenStruct.new(:code => '200', :body => fixture('data_home_energy_quantity.xml')))
-        mock.should_receive(:finish => nil)
-      end
       setup_connection
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
-      c.expire_cache
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
-    end
+      @first_response.expire_cache
 
-    it "object expiry invalidates objectes further down the tree" do
-      flexmock(Net::HTTP).new_instances do |mock|
-        mock.should_receive(:start => nil)
-        mock.should_receive(:request).once.and_return(OpenStruct.new(:code => '200', :body => fixture('data_home_energy_quantity.xml')))
-        mock.should_receive(:request).twice.and_return(OpenStruct.new(:code => '200', :body => fixture('data_home_energy_quantity_biodiesel.xml')))
-        mock.should_receive(:finish => nil)
+      VCR.use_cassette("AMEE_Connection_Caching_clear_manually/second_request") do
+        @second_response = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
       end
+
+      File.exists?('cassettes/AMEE_Connection_Caching_clear_manually/second_request.yml').should be true      
+      @second_response.should respond_to(:uid)
+      @second_response.should respond_to(:name)
+    end
+
+    it "object expiry invalidates objects further down the tree" do
       setup_connection
-      c = AMEE::Data::Category.get(@connection, '/data/home/energy/quantity')
-      i = c.item :label => 'biodiesel'
-      c.expire_cache
-      i = c.item :label => 'biodiesel'
+      
+      VCR.use_cassette("AMEE_Connection_Caching_further_down_tree/second_request") do
+        @second_response = @first_response.item :label => 'biodiesel'
+        @first_response.expire_cache
+        @third_response = @first_response.item :label => 'biodiesel'
+      end
+
+      File.exists?('cassettes/AMEE_Connection_Caching_further_down_tree/second_request.yml').should be true      
+      @second_response.label.should == "biodiesel"
+      @third_response.label.should == "biodiesel"
+
     end
     
     it "removes special characters from cache keys, include slashes" do
       setup_connection
-      @connection.send(:cache_key, "/%cache/$4/%20test").should eql 'server.example.com_cache_4_20test'
+      @connection.send(:cache_key, "/%cache/$4/%20test").should eql 'stage.amee.com_cache_4_20test'
     end
     
     it "trims cache keys to correct length for filenames, allowing for lock extension" do
@@ -99,14 +145,12 @@ describe AMEE::Connection do
     describe 'and automatic invalidation' do
 
       def test_invalidation_sequence(interactions)
-        flexmock(Net::HTTP).new_instances do |mock|
-          mock.should_receive(:start => nil)
+        setup_connection
+        flexmock(@connection) do |mock|
           interactions.each do |path, action, result|
-            mock.should_receive(:request).once.and_return(OpenStruct.new(:code => '200', :body => path)) if result
+            mock.should_receive(:run_request).once.and_return(OpenStruct.new(:code => '200', :body => path)) if result
           end
-          mock.should_receive(:finish => nil)
         end
-        setup_connection
         interactions.each do |path, action, result|
           if action
             @connection.send(action, path).body.should == path
@@ -115,14 +159,18 @@ describe AMEE::Connection do
       end
 
       it "handles PUT requests" do
+        VCR.use_cassette("AMEE_Connection_Caching/automatic_invalidation_for_put") do
         test_invalidation_sequence([
+          # Fill the cache
           ["/parent/object", :get, true],
           ["/parent", :get, true],
           ["/parent/object/child", :get, true],
           ["/parent/sibling", :get, true],
           ["/uncle/cousin", :get, true],
           ["/uncle", :get, true],
+          # Do a PUT
           ["/parent/object", :put, true],
+          # Check that cache is cleared in the right places
           ["/parent/object", :get, true],
           ["/parent", :get, true],
           ["/parent/object/child", :get, true],
@@ -130,17 +178,22 @@ describe AMEE::Connection do
           ["/uncle/cousin", :get, false],
           ["/uncle", :get, false],
         ])
+        end
       end
 
       it "handles POST requests" do
+        VCR.use_cassette("AMEE_Connection_Caching/automatic_invalidation_for_post") do
         test_invalidation_sequence([
+          # Fill the cache
           ["/parent/object", :get, true],
           ["/parent", :get, true],
           ["/parent/object/child", :get, true],
           ["/parent/sibling", :get, true],
           ["/uncle/cousin", :get, true],
           ["/uncle", :get, true],
+          # Do a POST
           ["/parent/object", :post, true],
+          # Check that cache is cleared in the right places
           ["/parent/object", :get, true],
           ["/parent", :get, false],
           ["/parent/object/child", :get, true],
@@ -149,16 +202,21 @@ describe AMEE::Connection do
           ["/uncle", :get, false],
         ])
       end
+      end
 
       it "handles DELETE requests" do
+        VCR.use_cassette("AMEE_Connection_Caching/automatic_invalidation_for_delete") do
         test_invalidation_sequence([
+          # Fill the cache
           ["/parent/object", :get, true],
           ["/parent", :get, true],
           ["/parent/object/child", :get, true],
           ["/parent/sibling", :get, true],
           ["/uncle/cousin", :get, true],
           ["/uncle", :get, true],
+          # Do a DELETE
           ["/parent/object", :delete, true],
+          # Check that cache is cleared in the right places
           ["/parent/object", :get, true],
           ["/parent", :get, true],
           ["/parent/object/child", :get, true],
@@ -167,6 +225,7 @@ describe AMEE::Connection do
           ["/uncle", :get, false],
         ])
       end
+      end
 
     end