amee 3.0.1 → 3.1.1

data/CHANGELOG.txt

@@ -1,5 +1,10 @@
 = 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.
+
 == 3.0.0
  * Add some pre-release functionality for AMEEconnect v3 in order to support 
    AMEEappkit gems.

data/VERSION

@@ -1 +1 @@
-3.0.1
+3.1.1

data/amee.gemspec

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

data/lib/amee/config.rb

@@ -0,0 +1,37 @@
+# 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.
+
+module AMEE
+
+  class Config
+
+
+    # Tries to load defaults from a yaml file, then if there are environment variables
+    # present (i.e. if we're using a service like heroku for determine them, or we want to
+    # manually override them), uses those values instead
+    def self.setup(amee_config_file = nil, environment = 'test')
+
+      if amee_config_file
+        # first try loading the yaml file
+        yaml_config = YAML.load_file(amee_config_file)
+        config = yaml_config[environment]
+
+        # make config[:username] possible instead of just config['username']
+        config.recursive_symbolize_keys!
+      else
+        config = {}
+      end
+
+        # then either override, or load in config deets from heroku
+      config[:username] = ENV['AMEE_USERNAME'] if ENV['AMEE_USERNAME']
+      config[:server]   = ENV['AMEE_SERVER'] if ENV['AMEE_SERVER']
+      config[:password] = ENV['AMEE_PASSWORD'] if ENV['AMEE_PASSWORD']
+
+      return config
+
+    end
+
+  end
+
+end
+

data/lib/amee/core-extensions/hash.rb

@@ -0,0 +1,43 @@
+# Copyright (C) 2011 AMEE UK Ltd. - http://www.amee.com
+# Released as Open Source Software under the BSD 3-Clause license. See LICENSE.txt for details.
+
+# :title: Class: Hash
+
+class Hash
+
+  # Return a new instance of <i>Hash</i> which represents the same data as
+  # <tt>self</tt> but with all keys - including those of sub-hashes - symbolized
+  #
+  def recursive_symbolize_keys
+    new_hash = {}
+    self.each_pair do |k,v|
+      new_hash[k.to_sym] = value_or_symbolize_value(v)
+    end
+    new_hash
+  end
+
+  # Modify <tt>self</tt> in place, transforming all keys - including those of
+  # sub-hashes - in to symbols
+  #
+  def recursive_symbolize_keys!
+    self.each_pair do |k,v|
+      value = delete(k)
+      self[k.to_sym] = value_or_symbolize_value(value)
+    end
+    self
+  end
+
+  private
+
+  # Symbolize any hash key or sub-hash key containing within <tt>value</tt>.
+  def value_or_symbolize_value(value)
+    if value.is_a? Hash
+      return value.recursive_symbolize_keys
+    elsif value.is_a? Array
+      return value.map { |elem| value_or_symbolize_value(elem) }
+    else
+      return value
+    end
+  end
+
+end

data/lib/amee/rails.rb

@@ -12,23 +12,23 @@ module AMEE
       def self.global(options = {})
         unless @connection
           $AMEE_CONFIG ||= {} # Make default values nil
-          if $AMEE_CONFIG['ssl'] == false
+          if $AMEE_CONFIG[:ssl] == false
             options.merge! :ssl => false
           end
-          if $AMEE_CONFIG['retries']
-            options.merge! :retries => $AMEE_CONFIG['retries'].to_i
+          if $AMEE_CONFIG[:retries]
+            options.merge! :retries => $AMEE_CONFIG[:retries].to_i
           end
-          if $AMEE_CONFIG['timeout']
-            options.merge! :timeout => $AMEE_CONFIG['timeout'].to_i
+          if $AMEE_CONFIG[:timeout]
+            options.merge! :timeout => $AMEE_CONFIG[:timeout].to_i
           end
-          if $AMEE_CONFIG['cache'] == 'rails'
+          if $AMEE_CONFIG[:cache] == 'rails'
             # Pass in the rails cache store
             options[:cache_store] = ActionController::Base.cache_store
           else
-            options[:cache] ||= $AMEE_CONFIG['cache'] if $AMEE_CONFIG['cache'].present?
+            options[:cache] ||= $AMEE_CONFIG[:cache] if $AMEE_CONFIG[:cache].present?
           end
-          options[:enable_debug]   ||= $AMEE_CONFIG['debug'] if $AMEE_CONFIG['debug'].present?
-          @connection = self.connect($AMEE_CONFIG['server'], $AMEE_CONFIG['username'], $AMEE_CONFIG['password'], options)
+          options[:enable_debug]   ||= $AMEE_CONFIG[:debug] if $AMEE_CONFIG[:debug].present?
+          @connection = self.connect($AMEE_CONFIG[:server], $AMEE_CONFIG[:username], $AMEE_CONFIG[:password], options)
           # Also store as $amee for backwards compatibility, though this is now deprecated
           $amee = @connection
         end

data/rails/init.rb

@@ -2,13 +2,16 @@
 # Released as Open Source Software under the BSD 3-Clause license. See LICENSE.txt for details.
 
 require 'amee'
+require 'amee/config'
+require 'amee/core-extensions/hash'
 require 'amee/rails'
 
 # Load config/amee.yml
-amee_config = "#{RAILS_ROOT}/config/amee.yml"
-if File.exist?(amee_config)
-  # Load config
-  $AMEE_CONFIG = YAML.load_file(amee_config)[RAILS_ENV]
+amee_config = "config/amee.yml"
+if File.exist? amee_config
+  $AMEE_CONFIG = AMEE::Config.setup(amee_config, Rails.env)
+else
+  $AMEE_CONFIG = AMEE::Config.setup
 end
 
 # Add AMEE extensions into ActiveRecord::Base

data/spec/fixtures/rails_config.yml

@@ -0,0 +1,13 @@
+defaults: &defaults
+  server: stage.amee.com
+  username: joe_shmoe
+  password: top_sekrit123
+
+development:
+  <<: *defaults
+
+test:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/spec/spec_amee_config.rb

@@ -0,0 +1,46 @@
+# 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 'spec_helper.rb'
+
+describe AMEE::Config do
+
+  # make sure environment variables are clear for each test
+  before(:each) do
+    ENV['AMEE_SERVER'] = nil
+    ENV['AMEE_USERNAME'] = nil
+    ENV['AMEE_PASSWORD'] = nil
+  end
+
+  context "loading config details from the environment"
+
+  it "should let us use ENV variables so we can use heroku" do
+    # fake the ENV variables setting
+    ENV['AMEE_SERVER'] = "stage.amee.com"
+    ENV['AMEE_USERNAME'] = "joe_shmoe"
+    ENV['AMEE_PASSWORD'] = "top_sekrit123"
+
+    amee_config = AMEE::Config.setup()
+
+    amee_config[:username].should eq "joe_shmoe"
+    amee_config[:server].should eq "stage.amee.com"
+    amee_config[:password].should eq "top_sekrit123"
+
+  end
+
+  context "loading config details from a yaml file" do
+
+    it "so we don't rely on heroku ALL the time" do
+
+      config_path = File.dirname(__FILE__)+'/fixtures/rails_config.yml'
+
+      amee_config = AMEE::Config.setup(config_path, 'test')
+
+      amee_config[:username].should eq "joe_shmoe"
+      amee_config[:server].should eq "stage.amee.com"
+      amee_config[:password].should eq "top_sekrit123"
+
+    end
+  end
+
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: amee
 version: !ruby/object:Gem::Version 
-  hash: 5
+  hash: 1
   prerelease: 
   segments: 
   - 3
-  - 0
   - 1
-  version: 3.0.1
+  - 1
+  version: 3.1.1
 platform: ruby
 authors: 
 - James Smith
@@ -18,7 +18,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-11 00:00:00 +01:00
+date: 2011-10-03 00:00:00 +01:00
 default_executable: ameesh
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -221,7 +221,9 @@ files:
 - 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
@@ -281,6 +283,7 @@ files:
 - 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
@@ -296,6 +299,7 @@ files:
 - 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