Floppy-amee 0.2.3 → 0.3.0

data/README

@@ -32,3 +32,21 @@ You can use the 'ameesh' app to interactively explore the AMEE data area. Run
 'ameesh -u USERNAME -p PASSWORD -s SERVER' to try it out. Source code for this 
 tool is in bin/ameesh and lib/amee/shell.rb. Profiles are not accessible through
 this interface yet.
+
+== RAILS
+
+This gem can 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:
+
+    config.gem "Floppy-amee", :lib => "amee", :source => "http://gems.github.com"
+
+The first time you run your app after installing the gem, a config/amee.yml file
+will be created. You should edit this file and add your AMEE username and
+password to it, as well as the server you want to connect to.
+
+Once that is all set up, you can use AMEE objects within Rails anywhere you like.
+There is a persistent AMEE connection available called $amee, which you can pass
+into the other objects to fetch data. For instance:
+
+    data = AMEE::Data::Category.root($amee)

data/init.rb

@@ -0,0 +1 @@
+require File.dirname(__FILE__) + "/rails/init"

data/lib/amee/connection.rb

@@ -77,16 +77,6 @@ module AMEE
       response.body
     end
 
-    protected
-
-    def content_type
-      (@use_json_if_available && defined?(JSON)) ? 'application/json' : 'application/xml'
-    end
-    
-    def authentication_failed?(response)
-      response.code == '401'
-    end
-    
     def authenticate
       unless can_authenticate?        
         raise AMEE::AuthRequired.new("Authentication required. Please provide your username and password.")
@@ -99,6 +89,16 @@ module AMEE
       @auth_token = response['authToken']
       raise AMEE::AuthFailed.new("Authentication failed. Please check your username and password.") unless authenticated?
     end
+
+    protected
+
+    def content_type
+      (@use_json_if_available && defined?(JSON)) ? 'application/json' : 'application/xml'
+    end
     
+    def authentication_failed?(response)
+      response.code == '401'
+    end
+        
   end
 end

data/rails/init.rb

@@ -0,0 +1,23 @@
+require 'amee'
+
+# 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]
+  # Create a global AMEE connection that we can use from anywhere in this app
+  $amee = AMEE::Connection.new(AMEE_CONFIG['server'], AMEE_CONFIG['username'], AMEE_CONFIG['password'])
+  # Authenticate now to get it out of the way and to check settings
+  $amee.authenticate
+else
+  # Create an example AMEE config file and save it to config/amee.yml
+  example_config = {}
+  example_config['development'] = {'server' => "stage.co2.dgen.net", 'username' => "your_amee_username", 'password' => "your_amee_password"}
+  example_config['production'] = {'server' => "stage.co2.dgen.net", 'username' => "your_amee_username", 'password' => "your_amee_password"}
+  example_config['test'] = {'server' => "stage.co2.dgen.net", 'username' => "your_amee_username", 'password' => "your_amee_password"}
+  File.open(amee_config, 'w') do |out|
+   YAML.dump(example_config, out)
+  end
+  # Inform the user that we've written a file for them
+  raise AMEE::ConnectionFailed.new("config/amee.yml doesn't exist. I've created one for you - please add your API keys to it.")
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Floppy-amee
 version: !ruby/object:Gem::Version 
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors: 
 - James Smith
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-08-20 00:00:00 -07:00
+date: 2008-08-22 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -41,6 +41,8 @@ files:
 - examples/create_profile.rb
 - examples/view_data_category.rb
 - examples/view_data_item.rb
+- init.rb
+- rails/init.rb
 has_rdoc: true
 homepage: http://github.com/Floppy/amee-ruby
 post_install_message: