amee 3.2.1 → 4.0.0

data/CHANGELOG.txt

@@ -1,28 +1,5 @@
 = Changelog
 
-== 3.2.1
-* Add algorithm details to ItemDefinitions
-* Bugfix when using AMEE::Rails.connection from locations other than Rails.root
-
-== 3.2.0
-* Add algorithm details to ItemDefinitions
-
-== 4.1.3 (also 3.1.2 for Rails 2)
-* Documentation update
-
-== 4.1.2 (also 3.1.1 for Rails 2)
-* Fix bug in initialisation of AMEE::Rails#connection from configuration.
-
-== 4.1.1
- * Configuration bugfix
-
-== 4.1.0 (also 3.1.0 for Rails 2)
- * Add option to set connection details using environment variables, for
-   instance in Heroku deployments.
-
-== 4.0.0
- * Rails 3 support. Rails 2 apps will not work with this version.
-
 == 3.0.0
  * Add some pre-release functionality for AMEEconnect v3 in order to support 
    AMEEappkit gems.
@@ -66,4 +43,4 @@
     * Include accessors from other objects
  * Internal improvements including
     * Improved paging support
-    * Tidier code for collections
+    * Tidier code for collections

data/Gemfile

@@ -1,18 +1,17 @@
 source "http://rubygems.org"
 
-gem "activesupport", "~> 2.3.5"
+gem "activesupport", "~> 3.0.10"
 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 'rspec', '2.6.0'
+  gem 'flexmock', '> 0.8.6'
+  gem 'memcache-client'
   gem 'rcov'
-  gem 'rspec_spinner', '1.1.3'
-  gem 'activerecord', "~> 2.3.5" # To test Rails integration
-  gem 'flexmock'
-end
+  gem 'rdoc'
+  gem 'activerecord', "~> 3.0.10" # To test Rails integration
+end

data/Gemfile.lock

@@ -1,37 +1,56 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    activerecord (2.3.12)
-      activesupport (= 2.3.12)
-    activesupport (2.3.12)
+    activemodel (3.0.10)
+      activesupport (= 3.0.10)
+      builder (~> 2.1.2)
+      i18n (~> 0.5.0)
+    activerecord (3.0.10)
+      activemodel (= 3.0.10)
+      activesupport (= 3.0.10)
+      arel (~> 2.0.10)
+      tzinfo (~> 0.3.23)
+    activesupport (3.0.10)
+    arel (2.0.10)
+    builder (2.1.2)
+    diff-lcs (1.1.3)
     flexmock (0.9.0)
     git (1.2.5)
+    i18n (0.5.0)
     jeweler (1.6.4)
       bundler (~> 1.0)
       git (>= 1.2.5)
       rake
-    json (1.5.3)
+    json (1.5.4)
     log4r (1.1.9)
+    memcache-client (1.8.5)
     nokogiri (1.4.3.1)
     rake (0.9.2)
-    rcov (0.9.9)
-    rspec (1.3.0)
-    rspec_spinner (1.1.3)
-      rtui
-    rtui (0.2.2)
+    rcov (0.9.10)
+    rdoc (3.9.4)
+    rspec (2.6.0)
+      rspec-core (~> 2.6.0)
+      rspec-expectations (~> 2.6.0)
+      rspec-mocks (~> 2.6.0)
+    rspec-core (2.6.4)
+    rspec-expectations (2.6.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.6.0)
+    tzinfo (0.3.29)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  activerecord (~> 2.3.5)
-  activesupport (~> 2.3.5)
+  activerecord (~> 3.0.10)
+  activesupport (~> 3.0.10)
   bundler (~> 1.0.0)
-  flexmock
+  flexmock (> 0.8.6)
   jeweler (~> 1.6.4)
   json
   log4r
+  memcache-client
   nokogiri (~> 1.4.3.1)
   rcov
-  rspec (= 1.3.0)
-  rspec_spinner (= 1.1.3)
+  rdoc
+  rspec (= 2.6.0)

data/README.txt

@@ -19,14 +19,22 @@ Documentation: http://rubydoc.info/gems/amee/frames
 
 == REQUIREMENTS
 
-If you are using Rails, note that version 4.x of this gem supports Rails 3 apps 
-only. If you are using Rails 2, you should stay with version 3.x. See the 'Rails'
-section below for more details.
-
 'Nokogiri' is used for XML parsing, and requires libxml2. See
 http://nokogiri.org/tutorials/installing_nokogiri.html for instructions if you
 have problems installing.
 
+== IMPORTANT CHANGES when upgrading to 2.2.0 and above
+
+SSL connections are now supported, and are used BY DEFAULT.If you do not want to
+use SSL, you can disable it using the ":ssl => false" option to Connection.new, or
+by adding "ssl: false" to your amee.yml if you are using Rails.
+
+== IMPORTANT CHANGES when upgrading beyond 2.0.25
+
+If you are using the $amee connection in your Rails apps, this is now deprecated
+and will be removed in future releases. See the "Rails" section below for details 
+of what you should use instead.
+
 == USAGE
 
 Currently, you can read DataCategories, DataItems and DataItemValues. See 
@@ -58,13 +66,11 @@ this interface yet.
 
 == RAILS
 
-This gem can also be used as a Rails plugin.
-
-Rails 2: add the following to environment.rb:
-    config.gem "amee", :version => '~> 3.1'
+This gem can also be used as a Rails plugin. You can either extract it into
+vendor/plugins, or use the new-style config.gem command in environment.rb. For
+example:
 
-Rails 3: add the following to your Gemfile:
-    gem "amee", '~> 4.1'
+    config.gem "amee", :version => '~> 2.2.0'
 
 If you copy amee.example.yml from the gem source directory to amee.yml in your
 app's config directory, a persistent AMEE connection will be available from 
@@ -76,10 +82,6 @@ also use the global_amee_connection function to access the same global connectio
 If you do not use this facility, you will have to create your own connection
 objects and manage them yourself, which you can do using AMEE::Connection#new
 
-Instead of using an amee.yml file, you can set ENV['AMEE_USERNAME'], ENV['AMEE_PASSWORD']
-and ENV['AMEE_SERVER'] to achieve the same effect. This is useful for deploying
-to environments like Heroku, for instance.
-
 There is a helper for ActiveRecord models which should be linked to an AMEE profile.
 By adding:
 
@@ -116,4 +118,20 @@ change the number of retry attempts, 3 is just used as an example above.
 
 The Connection object also allows a timeout to be set for requests. By default this is
 set to 60 seconds, but if you want to provide a different value (30 seconds for 
-instance), pass ':timeout => 30' to AMEE::Connection.new, or 'timeout: 30' in amee.yml.
+instance), pass ':timeout => 30' to AMEE::Connection.new, or 'timeout: 30' in amee.yml.
+
+== UPGRADING TO VERSION > 2
+
+There are a few changes to the API exposed by this gem for version 2. The main
+ones are:
+
+1) AMEE::Connection#new takes a hash of options instead of an explicit parameter list.
+   Whereas before you would have used new(server, username, password, use_json, enable_cache, enable_debug)
+   you would now use new(server, username, password, :format => :json, :enable_caching => true, :enable_debug => true)
+
+2) Many get functions take a hash of options instead of explicit date and itemsPerPage parameters.
+   get(... , :start_date => {your_date}, :itemsPerPage => 20)
+
+3) total_amount_per_month functions have been replaced with total_amount. There are also
+   total_amount_unit and total_amount_per_unit functions which give the units that the total
+   amount is in.

data/Rakefile

@@ -10,16 +10,14 @@ rescue Bundler::BundlerError => e
   exit e.status_code
 end
 require 'rake'
-require 'spec'
-require 'spec/rake/spectask'
+require 'rspec'
+require 'rspec/core/rake_task'
 
 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,/*ruby*,']
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  # Put spec opts in a file named .rspec in root
 end
 
 require 'jeweler'
@@ -70,29 +68,17 @@ Jeweler::Tasks.new do |gem|
 end
 Jeweler::RubygemsDotOrgTasks.new
 
-require 'rake/testtask'
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-end
-
 require 'rcov/rcovtask'
-Rcov::RcovTask.new do |test|
-  test.libs << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.verbose = true
-  test.rcov_opts << '--exclude "gems/*"'
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
 end
 
-task :default => :test
-
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "amee-ruby #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+require 'rdoc/task'
+RDoc::Task.new do |rd|
+  rd.title = "AMEE Ruby"
+  rd.rdoc_dir = 'doc'
+  rd.main = "README"
+  rd.rdoc_files.include("README", "lib/**/*.rb")
 end

data/VERSION

@@ -1 +1 @@
-3.2.1
+4.0.0

data/amee.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee}
-  s.version = "3.2.1"
+  s.version = "4.0.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-11-16}
+  s.date = %q{2011-09-28}
   s.default_executable = %q{ameesh}
   s.email = %q{james@floppy.org.uk}
   s.executables = ["ameesh"]
@@ -36,12 +36,9 @@ Gem::Specification.new do |s|
     "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/config.rb",
     "lib/amee/connection.rb",
-    "lib/amee/core-extensions/hash.rb",
     "lib/amee/data_category.rb",
     "lib/amee/data_item.rb",
     "lib/amee/data_item_value.rb",
@@ -71,7 +68,6 @@ Gem::Specification.new do |s|
     "lib/amee/v3/item_value_definition_list.rb",
     "lib/amee/v3/meta_helper.rb",
     "lib/amee/v3/return_value_definition.rb",
-    "rails/init.rb",
     "spec/amee_spec.rb",
     "spec/cache_spec.rb",
     "spec/connection_spec.rb",
@@ -101,7 +97,6 @@ Gem::Specification.new do |s|
     "spec/fixtures/ivdlist.xml",
     "spec/fixtures/ivdlist_BD88D30D1214.xml",
     "spec/fixtures/parse_test.xml",
-    "spec/fixtures/rails_config.yml",
     "spec/fixtures/return_value_definition.xml",
     "spec/fixtures/return_value_definition_list.xml",
     "spec/fixtures/v0_data_transport_transport_drill_transportType_Car1.xml",
@@ -117,7 +112,6 @@ Gem::Specification.new do |s|
     "spec/profile_spec.rb",
     "spec/rails_spec.rb",
     "spec/spec.opts",
-    "spec/spec_amee_config.rb",
     "spec/spec_helper.rb",
     "spec/user_spec.rb",
     "spec/v3/connection_spec.rb",
@@ -128,49 +122,52 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/AMEE/amee-ruby}
   s.licenses = ["BSD 3-Clause"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.6.2}
+  s.rubygems_version = %q{1.4.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<activesupport>, ["~> 3.0.10"])
       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<rspec>, ["= 2.6.0"])
+      s.add_development_dependency(%q<flexmock>, ["> 0.8.6"])
+      s.add_development_dependency(%q<memcache-client>, [">= 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"])
+      s.add_development_dependency(%q<rdoc>, [">= 0"])
+      s.add_development_dependency(%q<activerecord>, ["~> 3.0.10"])
     else
-      s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+      s.add_dependency(%q<activesupport>, ["~> 3.0.10"])
       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<rspec>, ["= 2.6.0"])
+      s.add_dependency(%q<flexmock>, ["> 0.8.6"])
+      s.add_dependency(%q<memcache-client>, [">= 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"])
+      s.add_dependency(%q<rdoc>, [">= 0"])
+      s.add_dependency(%q<activerecord>, ["~> 3.0.10"])
     end
   else
-    s.add_dependency(%q<activesupport>, ["~> 2.3.5"])
+    s.add_dependency(%q<activesupport>, ["~> 3.0.10"])
     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<rspec>, ["= 2.6.0"])
+    s.add_dependency(%q<flexmock>, ["> 0.8.6"])
+    s.add_dependency(%q<memcache-client>, [">= 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"])
+    s.add_dependency(%q<rdoc>, [">= 0"])
+    s.add_dependency(%q<activerecord>, ["~> 3.0.10"])
   end
 end
 

data/lib/amee.rb

@@ -4,6 +4,7 @@
 require 'rexml/document'
 require 'nokogiri'
 require 'active_support'
+require 'active_support/time'
 require 'log4r'
 
 # We don't NEED the JSON gem, but if it's available, use it.
@@ -54,6 +55,16 @@ require 'amee/item_value_definition'
 require 'amee/user'
 require 'amee/v3'
 
+if defined?(Rails)
+  require 'amee/rails'
+  ActiveRecord::Base.send :include, AMEE::Rails
+  
+  amee_config = "config/amee.yml"
+  if File.exist?(amee_config)
+    $AMEE_CONFIG = YAML.load_file(amee_config)[Rails.env]
+  end
+end
+
 class Date
   def amee1_date
     strftime("%Y%m%d")

data/lib/amee/connection.rb

@@ -32,7 +32,7 @@ module AMEE
       end
       # Create cache store
       if options[:cache] &&
-        (options[:cache_store].is_a?(ActiveSupport::Cache::MemCacheStore) ||
+        (options[:cache_store].class.name == "ActiveSupport::Cache::MemCacheStore" ||
          options[:cache].to_sym == :mem_cache_store)         
         raise 'ActiveSupport::Cache::MemCacheStore is not supported, as it doesn\'t allow regexp expiry'
       end

data/lib/amee/logger.rb

@@ -7,15 +7,20 @@
 # AMEE::Log.to logtothis
 
 module AMEE
-  module Logger
-    @@log=Log4r::Logger.new('AMEERuby')
-    @@log.outputters=[Log4r::StderrOutputter.new('AMEERubyStdout')]
-    @@log.level=Log4r::WARN
+  class Logger
     def self.log
-      @@log
+      @@log ||= setup_logger
     end
     def self.to(log)
       @@log=log
     end
+    
+    private
+    def self.setup_logger
+      log = Log4r::Logger.new('AMEERuby')
+      log.outputters = [Log4r::StderrOutputter.new('AMEERubyStdout')]
+      log.level=Log4r::WARN
+      log
+    end
   end
 end