amee 3.1.1 → 3.1.2

Sign up to get free protection for your applications and to get access to all the features.
Files changed (5) hide show
  1. data/CHANGELOG.txt +16 -5
  2. data/README.txt +15 -33
  3. data/VERSION +1 -1
  4. data/amee.gemspec +2 -2
  5. metadata +4 -4
data/CHANGELOG.txt CHANGED
@@ -1,9 +1,20 @@
1
1
  = Changelog
2
2
 
3
- == 3.1.0
4
- * Back-ported the update in amee-ruby 4.1.0 to add an option to set connection
5
- details using environment variables, for instance in Heroku deployments, to
6
- create a Rails 2.3 compatible version of the gem with this feature.
3
+ == 4.1.3 (also 3.1.2 for Rails 2)
4
+ * Documentation update
5
+
6
+ == 4.1.2 (also 3.1.1 for Rails 2)
7
+ * Fix bug in initialisation of AMEE::Rails#connection from configuration.
8
+
9
+ == 4.1.1
10
+ * Configuration bugfix
11
+
12
+ == 4.1.0 (also 3.1.0 for Rails 2)
13
+ * Add option to set connection details using environment variables, for
14
+ instance in Heroku deployments.
15
+
16
+ == 4.0.0
17
+ * Rails 3 support. Rails 2 apps will not work with this version.
7
18
 
8
19
  == 3.0.0
9
20
  * Add some pre-release functionality for AMEEconnect v3 in order to support
@@ -48,4 +59,4 @@
48
59
  * Include accessors from other objects
49
60
  * Internal improvements including
50
61
  * Improved paging support
51
- * Tidier code for collections
62
+ * Tidier code for collections
data/README.txt CHANGED
@@ -19,22 +19,14 @@ Documentation: http://rubydoc.info/gems/amee/frames
19
19
 
20
20
  == REQUIREMENTS
21
21
 
22
+ If you are using Rails, note that version 4.x of this gem supports Rails 3 apps
23
+ only. If you are using Rails 2, you should stay with version 3.x. See the 'Rails'
24
+ section below for more details.
25
+
22
26
  'Nokogiri' is used for XML parsing, and requires libxml2. See
23
27
  http://nokogiri.org/tutorials/installing_nokogiri.html for instructions if you
24
28
  have problems installing.
25
29
 
26
- == IMPORTANT CHANGES when upgrading to 2.2.0 and above
27
-
28
- SSL connections are now supported, and are used BY DEFAULT.If you do not want to
29
- use SSL, you can disable it using the ":ssl => false" option to Connection.new, or
30
- by adding "ssl: false" to your amee.yml if you are using Rails.
31
-
32
- == IMPORTANT CHANGES when upgrading beyond 2.0.25
33
-
34
- If you are using the $amee connection in your Rails apps, this is now deprecated
35
- and will be removed in future releases. See the "Rails" section below for details
36
- of what you should use instead.
37
-
38
30
  == USAGE
39
31
 
40
32
  Currently, you can read DataCategories, DataItems and DataItemValues. See
@@ -66,11 +58,13 @@ this interface yet.
66
58
 
67
59
  == RAILS
68
60
 
69
- This gem can also be used as a Rails plugin. You can either extract it into
70
- vendor/plugins, or use the new-style config.gem command in environment.rb. For
71
- example:
61
+ This gem can also be used as a Rails plugin.
62
+
63
+ Rails 2: add the following to environment.rb:
64
+ config.gem "amee", :version => '~> 3.1'
72
65
 
73
- config.gem "amee", :version => '~> 2.2.0'
66
+ Rails 3: add the following to your Gemfile:
67
+ gem "amee", '~> 4.1'
74
68
 
75
69
  If you copy amee.example.yml from the gem source directory to amee.yml in your
76
70
  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
82
76
  If you do not use this facility, you will have to create your own connection
83
77
  objects and manage them yourself, which you can do using AMEE::Connection#new
84
78
 
79
+ Instead of using an amee.yml file, you can set ENV['AMEE_USERNAME'], ENV['AMEE_PASSWORD']
80
+ and ENV['AMEE_SERVER'] to achieve the same effect. This is useful for deploying
81
+ to environments like Heroku, for instance.
82
+
85
83
  There is a helper for ActiveRecord models which should be linked to an AMEE profile.
86
84
  By adding:
87
85
 
@@ -118,20 +116,4 @@ change the number of retry attempts, 3 is just used as an example above.
118
116
 
119
117
  The Connection object also allows a timeout to be set for requests. By default this is
120
118
  set to 60 seconds, but if you want to provide a different value (30 seconds for
121
- instance), pass ':timeout => 30' to AMEE::Connection.new, or 'timeout: 30' in amee.yml.
122
-
123
- == UPGRADING TO VERSION > 2
124
-
125
- There are a few changes to the API exposed by this gem for version 2. The main
126
- ones are:
127
-
128
- 1) AMEE::Connection#new takes a hash of options instead of an explicit parameter list.
129
- Whereas before you would have used new(server, username, password, use_json, enable_cache, enable_debug)
130
- you would now use new(server, username, password, :format => :json, :enable_caching => true, :enable_debug => true)
131
-
132
- 2) Many get functions take a hash of options instead of explicit date and itemsPerPage parameters.
133
- get(... , :start_date => {your_date}, :itemsPerPage => 20)
134
-
135
- 3) total_amount_per_month functions have been replaced with total_amount. There are also
136
- total_amount_unit and total_amount_per_unit functions which give the units that the total
137
- amount is in.
119
+ instance), pass ':timeout => 30' to AMEE::Connection.new, or 'timeout: 30' in amee.yml.
data/VERSION CHANGED
@@ -1 +1 @@
1
- 3.1.1
1
+ 3.1.2
data/amee.gemspec CHANGED
@@ -5,11 +5,11 @@
5
5
 
6
6
  Gem::Specification.new do |s|
7
7
  s.name = %q{amee}
8
- s.version = "3.1.1"
8
+ s.version = "3.1.2"
9
9
 
10
10
  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
11
  s.authors = ["James Smith", "James Hetherington", "Andrew Hill", "Andrew Berkeley"]
12
- s.date = %q{2011-10-03}
12
+ s.date = %q{2011-10-04}
13
13
  s.default_executable = %q{ameesh}
14
14
  s.email = %q{james@floppy.org.uk}
15
15
  s.executables = ["ameesh"]
metadata CHANGED
@@ -1,13 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: amee
3
3
  version: !ruby/object:Gem::Version
4
- hash: 1
4
+ hash: 7
5
5
  prerelease:
6
6
  segments:
7
7
  - 3
8
8
  - 1
9
- - 1
10
- version: 3.1.1
9
+ - 2
10
+ version: 3.1.2
11
11
  platform: ruby
12
12
  authors:
13
13
  - James Smith
@@ -18,7 +18,7 @@ autorequire:
18
18
  bindir: bin
19
19
  cert_chain: []
20
20
 
21
- date: 2011-10-03 00:00:00 +01:00
21
+ date: 2011-10-04 00:00:00 +01:00
22
22
  default_executable: ameesh
23
23
  dependencies:
24
24
  - !ruby/object:Gem::Dependency