amee 2.6.0 → 2.7.0

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem "activesupport", "~> 2.3.5"
+gem "json"
+gem "log4r"
+gem "nokogiri", "~> 1.4.3.1"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.6.4"
+  gem 'rspec', '1.3.0'
+  gem 'rcov'
+  gem 'rspec_spinner', '1.1.3'
+  gem 'activerecord', "~> 2.3.5" # To test Rails integration
+  gem 'flexmock'
+end

data/README

@@ -6,9 +6,9 @@ Licensed under the MIT license (See COPYING file for details)
 
 Author: James Smith (james@floppy.org.uk / http://www.floppy.org.uk)
 
-Homepage: http://github.com/Floppy/amee-ruby
+Homepage: http://github.com/AMEE/amee-ruby
 
-Documentation: http://docs.github.com/Floppy/amee-ruby
+Documentation: http://docs.github.com/AMEE/amee-ruby
 
 == INSTALLATION
 

data/Rakefile

@@ -0,0 +1,31 @@
+require 'rake'
+require 'spec'
+require 'spec/rake/spectask'
+require 'rake/rdoctask'
+require 'rubygems/specification'
+require 'rake/gempackagetask'
+
+task :default => [:spec]
+
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec,/usr,/Library']
+end
+
+Rake::RDocTask.new { |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.title    = "AMEE-Ruby - RDoc documentation"
+  rdoc.options << '--line-numbers' << '--inline-source' << '-A cattr_accessor=object'
+  rdoc.options << '--charset' << 'utf-8'
+  rdoc.rdoc_files.include('README', 'COPYING')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+}
+
+# Gem build task - load gemspec from file
+gemspec = File.read('amee-ruby.gemspec')
+spec = eval("#{gemspec}")
+Rake::GemPackageTask.new(spec) do |p|
+  p.gem_spec = spec
+end

data/VERSION

@@ -0,0 +1 @@
+2.7.0

data/amee-ruby.gemspec

@@ -0,0 +1,147 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{amee-ruby}
+  s.version = "2.7.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["James Smith"]
+  s.date = %q{2011-08-09}
+  s.default_executable = %q{ameesh}
+  s.email = %q{james@floppy.org.uk}
+  s.executables = ["ameesh"]
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "CHANGELOG",
+    "COPYING",
+    "Gemfile",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "amee-ruby.gemspec",
+    "amee.example.yml",
+    "bin/ameesh",
+    "cacert.pem",
+    "examples/create_profile.rb",
+    "examples/create_profile_item.rb",
+    "examples/list_profiles.rb",
+    "examples/view_data_category.rb",
+    "examples/view_data_item.rb",
+    "examples/view_profile_item.rb",
+    "init.rb",
+    "lib/amee.rb",
+    "lib/amee/collection.rb",
+    "lib/amee/connection.rb",
+    "lib/amee/data_category.rb",
+    "lib/amee/data_item.rb",
+    "lib/amee/data_item_value.rb",
+    "lib/amee/data_item_value_history.rb",
+    "lib/amee/data_object.rb",
+    "lib/amee/drill_down.rb",
+    "lib/amee/exceptions.rb",
+    "lib/amee/item_definition.rb",
+    "lib/amee/item_value_definition.rb",
+    "lib/amee/logger.rb",
+    "lib/amee/object.rb",
+    "lib/amee/pager.rb",
+    "lib/amee/parse_helper.rb",
+    "lib/amee/profile.rb",
+    "lib/amee/profile_category.rb",
+    "lib/amee/profile_item.rb",
+    "lib/amee/profile_item_value.rb",
+    "lib/amee/profile_object.rb",
+    "lib/amee/rails.rb",
+    "lib/amee/shell.rb",
+    "lib/amee/user.rb",
+    "rails/init.rb",
+    "spec/amee_spec.rb",
+    "spec/cache_spec.rb",
+    "spec/connection_spec.rb",
+    "spec/data_category_spec.rb",
+    "spec/data_item_spec.rb",
+    "spec/data_item_value_history_spec.rb",
+    "spec/data_item_value_spec.rb",
+    "spec/data_object_spec.rb",
+    "spec/drill_down_spec.rb",
+    "spec/fixtures/AD63A83B4D41.json",
+    "spec/fixtures/AD63A83B4D41.xml",
+    "spec/fixtures/create_item.json",
+    "spec/fixtures/create_item.xml",
+    "spec/fixtures/data.json",
+    "spec/fixtures/data.xml",
+    "spec/fixtures/data_home_energy_quantity.xml",
+    "spec/fixtures/data_home_energy_quantity_biodiesel.xml",
+    "spec/fixtures/data_transport_car_generic_drill_fuel_diesel.xml",
+    "spec/fixtures/empty.json",
+    "spec/fixtures/empty.xml",
+    "spec/fixtures/parse_test.xml",
+    "spec/fixtures/v0_data_transport_transport_drill_transportType_Car1.xml",
+    "spec/item_definition_spec.rb",
+    "spec/item_value_definition_spec.rb",
+    "spec/logger_spec.rb",
+    "spec/object_spec.rb",
+    "spec/parse_helper_spec.rb",
+    "spec/profile_category_spec.rb",
+    "spec/profile_item_spec.rb",
+    "spec/profile_item_value_spec.rb",
+    "spec/profile_object_spec.rb",
+    "spec/profile_spec.rb",
+    "spec/rails_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb",
+    "spec/user_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/Floppy/amee-ruby}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.6.2}
+  s.summary = %q{Ruby interface to the AMEE carbon calculator}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<activesupport>, ["~> 2.3.5"])
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+      s.add_runtime_dependency(%q<log4r>, [">= 0"])
+      s.add_runtime_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rspec>, ["= 1.3.0"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_development_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_development_dependency(%q<flexmock>, [">= 0"])
+    else
+      s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<log4r>, [">= 0"])
+      s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rspec>, ["= 1.3.0"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+      s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+      s.add_dependency(%q<flexmock>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<log4r>, [">= 0"])
+    s.add_dependency(%q<nokogiri>, ["~> 1.4.3.1"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rspec>, ["= 1.3.0"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<rspec_spinner>, ["= 1.1.3"])
+    s.add_dependency(%q<activerecord>, ["~> 2.3.5"])
+    s.add_dependency(%q<flexmock>, [">= 0"])
+  end
+end
+

data/examples/view_profile_item.rb

@@ -0,0 +1,32 @@
+dir = File.dirname(__FILE__) + '/../lib'
+$LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
+
+#require 'rubygems'
+require 'amee'
+require 'optparse'
+
+# Command-line options - get username, password, and server
+options = {}
+OptionParser.new do |opts|
+  opts.on("-u", "--username USERNAME", "AMEE username") do |u|
+    options[:username] = u
+  end  
+  opts.on("-p", "--password PASSWORD", "AMEE password") do |p|
+    options[:password] = p
+  end
+  opts.on("-s", "--server SERVER", "AMEE server") do |s|
+    options[:server] = s
+  end
+end.parse!
+
+# Connect
+connection = AMEE::Connection.new(options[:server], options[:username], options[:password])
+
+# Create a new profile item
+item = AMEE::Profile::Item.get(connection, ARGV[0])
+puts "loaded item #{item.name}"
+item.values.each do |x|
+  puts " - #{x[:name]}: #{x[:value]}"
+end
+puts " - total: #{item.total_amount}"
+

data/lib/amee.rb

@@ -29,7 +29,6 @@ class String
 end
 
 require 'amee/logger'
-require 'amee/version'
 require 'amee/exceptions'
 require 'amee/connection'
 require 'amee/parse_helper'

data/lib/amee/profile_item.rb

@@ -305,20 +305,41 @@ module AMEE
           options[:duration] = "PT#{options[:duration] * 86400}S"
         end
         # Send data to path
+        options.merge!(:representation => 'full') if (connection.version >= 2) && (get_item == true)
         options.merge! :dataItemUid => data_item_uid
+        # POST
         response = connection.post(path, options)
+        # Parse response
+        category = response.body.empty? ? nil : Category.parse(connection, response.body, options)
         if response['Location']
           location = response['Location'].match("https??://.*?(/.*)")[1]
         else
-          category = Category.parse(connection, response.body, nil)
           location = category.full_path + "/" + category.items[0][:path]
         end
         if get_item == true
-          get_options = {}
-          get_options[:returnUnit] = options[:returnUnit] if options[:returnUnit]
-          get_options[:returnPerUnit] = options[:returnPerUnit] if options[:returnPerUnit]
-          get_options[:format] = format if format
-          return AMEE::Profile::Item.get(connection, location, get_options)
+          if connection.version >= 2
+            item = category.items.first
+            item[:connection] = category.connection
+            item[:profile_uid] = category.profile_uid
+            item[:data_item_label] = item.delete(:dataItemLabel)
+            item[:data_item_uid] = item.delete(:dataItemUid)
+            item[:start_date] = item.delete(:startDate)
+            item[:end_date] = item.delete(:endDate)
+            item[:total_amount] = item.delete(:amount) || item.delete(:amountPerMonth)
+            item[:total_amount_unit] = item.delete(:amount_unit) || "kg/month"
+            values = []
+            item[:values].each do |k,v|
+              values << v.merge(:path => k.to_s)
+            end
+            item[:values] = values
+            return AMEE::Profile::Item.new(item)
+          else
+            get_options = {}
+            get_options[:returnUnit] = options[:returnUnit] if options[:returnUnit]
+            get_options[:returnPerUnit] = options[:returnPerUnit] if options[:returnPerUnit]
+            get_options[:format] = format if format
+            return AMEE::Profile::Item.get(connection, location, get_options)
+          end
         else
           return location
         end

data/spec/amee_spec.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "AMEE module" do
+
+  it "should cope if json gem isn't available" do
+    # Monkeypatch Kernel#require to make sure that require 'json'
+    # raises a LoadError
+    module Kernel
+      def require_with_mock(string)
+        raise LoadError.new if string == 'json' 
+        require_without_mock(string)
+      end
+      alias_method :require_without_mock, :require
+      alias_method :require, :require_with_mock
+    end
+    # Remove amee.rb from required file list so we can load it again
+    $".delete_if{|x| x.include? 'amee.rb'}
+    # Require file - require 'json' should throw a LoadError,
+    # but we should cope with it OK.
+    lambda {
+      require 'amee'
+    }.should_not raise_error
+  end
+  
+end

data/spec/cache_spec.rb

@@ -0,0 +1,152 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+require 'ostruct'
+
+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')
+    end
+
+  end
+
+  describe 'with caching' do
+
+    def setup_connection
+      @connection = AMEE::Connection.new("server.example.com", "username", "password", :cache => :memory_store)
+    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')
+    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')
+    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
+
+    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)
+      end
+      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'
+    end
+
+    describe 'and automatic invalidation' do
+
+      def test_invalidation_sequence(interactions)
+        flexmock(Net::HTTP).new_instances do |mock|
+          mock.should_receive(:start => nil)
+          interactions.each do |path, action, result|
+            mock.should_receive(: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
+          end
+        end
+      end
+
+      it "handles PUT requests" do
+        test_invalidation_sequence([
+          ["/parent/object", :get, true],
+          ["/parent", :get, true],
+          ["/parent/object/child", :get, true],
+          ["/parent/sibling", :get, true],
+          ["/uncle/cousin", :get, true],
+          ["/uncle", :get, true],
+          ["/parent/object", :put, true],
+          ["/parent/object", :get, true],
+          ["/parent", :get, true],
+          ["/parent/object/child", :get, true],
+          ["/parent/sibling", :get, true],
+          ["/uncle/cousin", :get, false],
+          ["/uncle", :get, false],
+        ])
+      end
+
+      it "handles POST requests" do
+        test_invalidation_sequence([
+          ["/parent/object", :get, true],
+          ["/parent", :get, true],
+          ["/parent/object/child", :get, true],
+          ["/parent/sibling", :get, true],
+          ["/uncle/cousin", :get, true],
+          ["/uncle", :get, true],
+          ["/parent/object", :post, true],
+          ["/parent/object", :get, true],
+          ["/parent", :get, false],
+          ["/parent/object/child", :get, true],
+          ["/parent/sibling", :get, false],
+          ["/uncle/cousin", :get, false],
+          ["/uncle", :get, false],
+        ])
+      end
+
+      it "handles DELETE requests" do
+        test_invalidation_sequence([
+          ["/parent/object", :get, true],
+          ["/parent", :get, true],
+          ["/parent/object/child", :get, true],
+          ["/parent/sibling", :get, true],
+          ["/uncle/cousin", :get, true],
+          ["/uncle", :get, true],
+          ["/parent/object", :delete, true],
+          ["/parent/object", :get, true],
+          ["/parent", :get, true],
+          ["/parent/object/child", :get, true],
+          ["/parent/sibling", :get, true],
+          ["/uncle/cousin", :get, false],
+          ["/uncle", :get, false],
+        ])
+      end
+
+    end
+    
+  end
+
+end