amee 3.1.1 → 3.1.2

data/CHANGELOG.txt

@@ -1,9 +1,20 @@
 = Changelog
 
-== 3.1.0
- * Back-ported the update in amee-ruby 4.1.0 to add an option to set connection
-   details using environment variables, for instance in Heroku deployments, to
-   create a Rails 2.3 compatible version of the gem with this feature.
+== 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 
@@ -48,4 +59,4 @@
     * Include accessors from other objects
  * Internal improvements including
     * Improved paging support
-    * Tidier code for collections
+    * Tidier code for collections

data/README.txt

@@ -19,22 +19,14 @@ 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 
@@ -66,11 +58,13 @@ this interface yet.
 
 == RAILS
 
-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:
+This gem can also be used as a Rails plugin.
+
+Rails 2: add the following to environment.rb:
+    config.gem "amee", :version => '~> 3.1'
 
-    config.gem "amee", :version => '~> 2.2.0'
+Rails 3: add the following to your Gemfile:
+    gem "amee", '~> 4.1'
 
 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 
@@ -82,6 +76,10 @@ 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:
 
@@ -118,20 +116,4 @@ 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.
-
-== 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.
+instance), pass ':timeout => 30' to AMEE::Connection.new, or 'timeout: 30' in amee.yml.

data/VERSION

@@ -1 +1 @@
-3.1.1
+3.1.2

data/amee.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{amee}
-  s.version = "3.1.1"
+  s.version = "3.1.2"
 
   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-03}
+  s.date = %q{2011-10-04}
   s.default_executable = %q{ameesh}
   s.email = %q{james@floppy.org.uk}
   s.executables = ["ameesh"]

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amee
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: 
   segments: 
   - 3
   - 1
-  - 1
-  version: 3.1.1
+  - 2
+  version: 3.1.2
 platform: ruby
 authors: 
 - James Smith
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-10-03 00:00:00 +01:00
+date: 2011-10-04 00:00:00 +01:00
 default_executable: ameesh
 dependencies: 
 - !ruby/object:Gem::Dependency