init.rb rails/init.rb @@ -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) \ No newline at end of file README @@ -1,7 +1,7 @@ Gem::Specification.new do |s| s.name = "amee" - s.version = "0.2.3" - s.date = "2008-08-20" + s.version = "0.3.0" + s.date = "2008-08-22" s.summary = "Ruby interface to the AMEE carbon calculator" s.email = "james@floppy.org.uk" s.homepage = "http://github.com/Floppy/amee-ruby" @@ -11,5 +11,6 @@ Gem::Specification.new do |s| s.files += ['lib/amee.rb', 'lib/amee/connection.rb', 'lib/amee/data_item.rb', 'lib/amee/exceptions.rb', 'lib/amee/profile.rb', 'lib/amee/profile_object.rb', 'lib/amee/version.rb', 'lib/amee/data_category.rb', 'lib/amee/data_item_value.rb', 'lib/amee/data_object.rb', 'lib/amee/object.rb', 'lib/amee/shell.rb'] s.files += ['bin/ameesh'] s.files += ['examples/list_profiles.rb', 'examples/create_profile.rb', 'examples/view_data_category.rb', 'examples/view_data_item.rb'] + s.files += ['init.rb', 'rails/init.rb'] s.executables = ['ameesh'] end \ No newline at end of file amee-ruby.gemspec 3bfc28ab23c7ce480d3efa7b7f41519011ded515 James Smith james@floppy.org.uk http://github.com/Floppy/amee-ruby/commit/32a813788551da7cf6a27e03664e95c07311bdbb 32a813788551da7cf6a27e03664e95c07311bdbb 2008-08-22T06:00:00-07:00 2008-08-22T06:00:00-07:00 Add Rails plugin functionality and bump to version 0.3.0 0dc2a7c4afa1d626380501e2b1b02e67798befad James Smith james@floppy.org.uk