amee 2.0.25

data/lib/amee/profile_object.rb

@@ -0,0 +1,20 @@
+module AMEE
+  module Profile
+    class Object < AMEE::Object
+
+      def initialize(options = {})
+        @profile_uid = options[:profile_uid]
+        @profile_date = options[:profile_date]
+        super
+      end
+
+      attr_reader :profile_uid
+      attr_reader :profile_date
+
+      def full_path
+        "/profiles#{'/' if @profile_uid}#{@profile_uid}#{@path}"
+      end
+      
+    end
+  end
+end

data/lib/amee/rails.rb

@@ -0,0 +1,82 @@
+module AMEE
+  module Rails
+
+    def self.connection(options = {})
+      Connection.global(options)
+    end
+
+    class Connection
+      def self.global(options = {})
+        unless @connection          
+          @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
+        @connection
+      end
+      protected
+      def self.connect(server, username, password, options)
+        connection = AMEE::Connection.new(server, username, password, options)
+        connection.authenticate
+        return connection
+      end
+    end
+
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def has_amee_profile(options = {})
+        # Include the instance methods for creation and desctruction
+        include InstanceMethods
+        # Install callbacks
+        before_validation_on_create :amee_create
+        alias_method_chain :save, :amee
+        before_destroy :amee_destroy
+        # Check that this object has an AMEE profile UID when saving
+        validates_presence_of :amee_profile        
+      end
+    end
+
+    module InstanceMethods
+
+      def save_with_amee
+        save_without_amee && amee_save
+      end
+
+      def amee_create
+        # Create profile
+        profile = AMEE::Profile::Profile.create(amee_connection)
+        self.amee_profile = profile.uid
+      end
+
+      def amee_save
+        # This is only here to be overridden
+        return true
+      end
+
+      def amee_destroy
+        # Delete profile
+        AMEE::Profile::Profile.delete(amee_connection, amee_profile)
+      rescue
+        puts "Couldn't remove profile #{amee_profile}"
+      end
+
+      def amee_connection
+        # Should be overridden by code which doesn't use the global AMEE connection
+        AMEE::Rails.connection
+      end
+
+    end
+
+  end
+end
+
+if Object.const_defined?("ActionController")
+  class ActionController::Base
+    def global_amee_connection(options={})
+      AMEE::Rails.connection(options)
+    end
+  end
+end

data/lib/amee/shell.rb

@@ -0,0 +1,90 @@
+module AMEE
+  module Shell
+    
+    def amee_help
+      puts "AMEE shell - version #{AMEE::VERSION::STRING}"
+      puts "--------------------------"
+      puts "Commands:"
+      puts " ls"
+      puts "            - display contents of current category."
+      puts " cd 'path'"
+      puts "            - change category. Path must be a quoted string. You can use things like '/data', '..', or 'subcategory'."
+      puts " pwd"
+      puts "            - display current category path."
+      puts " cat 'name'"
+      puts "            - display contents of data item called 'name' within the current category."
+      puts " set_value 'item_name', 'value_name', value"
+      puts "            - set the value 'value_name' inside 'item_name' to value."
+      puts " amee_help"
+      puts "            - display this help text."
+    end
+    
+    def ls
+      puts "Categories:"
+      @@category.children.each do |c|
+        puts " - #{c[:path]}"
+      end
+      puts "Items:"
+      @@category.items.each do |i|
+        puts " - #{i[:path]} (#{i[:label]})"
+      end
+      nil
+    end
+    
+    def pwd
+      @@category.full_path
+    end
+    
+    def cd(path)
+      if path == '..'
+        path_components = @@category.full_path.split('/')
+        path = path_components.first(path_components.size - 1).join('/')
+      elsif !path.match(/^\/.*/)
+        path = @@category.full_path + '/' + path
+      end
+      @@category = AMEE::Data::Category.get($connection, path)
+      @@category.full_path
+    end
+    
+    def cat(name)
+      item = @@category.items.detect { |i| i[:path].match("^#{name}") }
+      fullpath = "#{@@category.full_path}/#{item[:path]}"
+      item = AMEE::Data::Item.get($connection, fullpath)
+      puts fullpath
+      puts "Label: #{item.label}"
+      puts "Values:"
+      item.values.each do |v|
+        puts " - #{v[:name]}: #{v[:value]}"
+      end
+      nil
+    end
+
+    def set_value(item, name, value)
+      item = @@category.items.detect { |i| i[:path].match("^#{item}") }
+      fullpath = "#{@@category.full_path}/#{item[:path]}/#{name}"
+      itemval = AMEE::Data::ItemValue.get($connection, fullpath)
+      itemval.value = value
+      itemval.save!
+    end
+
+  end
+end
+
+dir = File.dirname(__FILE__) + "/.."
+$LOAD_PATH << dir unless $LOAD_PATH.include?(dir)
+
+require 'rubygems'
+require 'amee'
+include AMEE::Shell
+
+# Set up connection
+$connection = AMEE::Connection.new(ENV['AMEE_SERVER'], ENV['AMEE_USERNAME'], ENV['AMEE_PASSWORD'])
+
+if $connection.valid?
+  # Change to root of data api to get going
+  cd '/data'
+  # Display AMEE details
+  amee_help
+else
+  puts "Can't connect to AMEE - please check details"
+end

data/lib/amee/user.rb

@@ -0,0 +1,111 @@
+module AMEE
+  module Admin
+
+    class User < AMEE::Object
+
+      attr_reader :username
+      attr_reader :name
+      attr_reader :email
+      attr_reader :api_version
+      attr_reader :status
+
+      def initialize(data = {})
+        @username = data[:username]
+        @name = data[:name]
+        @email = data[:email]
+        @status = data[:status]
+        @api_version  = data[:api_version].to_f rescue nil
+        @environment_uid = data[:environment_uid]
+        super
+      end
+
+      def self.parse(connection, response)
+        # Parse data from response
+        if response.is_json?
+          user = User.from_json(response)
+        else
+          user = User.from_xml(response)
+        end
+        # Store connection in object for future use
+        user.connection = connection
+        # Done
+        return user
+      end
+
+      def self.from_json(json)
+        # Read JSON
+        doc = JSON.parse(json)
+        data = {}
+        data[:environment_uid] = doc['user']['environment']['uid']
+        data[:uid] = doc['user']['uid']
+        data[:created] = DateTime.parse(doc['user']['created'])
+        data[:modified] = DateTime.parse(doc['user']['modified'])
+        data[:username] = doc['user']['username']
+        data[:name] = doc['user']['name']
+        data[:email] = doc['user']['email']
+        data[:api_version] = doc['user']['apiVersion']
+        data[:status] = doc['user']['status']
+        # Create object
+        User.new(data)
+      rescue
+        raise AMEE::BadData.new("Couldn't load User from JSON. Check that your URL is correct.\n#{json}")
+      end
+
+      def self.from_xml(xml)
+        # Parse data from response into hash
+        doc = REXML::Document.new(xml)
+        data = {}
+        data[:environment_uid] = REXML::XPath.first(doc, "//Environment/@uid").to_s
+        data[:uid] = REXML::XPath.first(doc, "//User/@uid").to_s
+        data[:created] = DateTime.parse(REXML::XPath.first(doc, "//User/@created").to_s)
+        data[:modified] = DateTime.parse(REXML::XPath.first(doc, "//User/@modified").to_s)
+        data[:username] = REXML::XPath.first(doc, "//User/Username").text
+        data[:name] = REXML::XPath.first(doc, "//User/Name").text
+        data[:email] = REXML::XPath.first(doc, "//User/Email").text
+        data[:api_version] = REXML::XPath.first(doc, "//User/ApiVersion").text
+        data[:status] = REXML::XPath.first(doc, "//User/Status").text
+        # Create object
+        User.new(data)
+      rescue
+        raise AMEE::BadData.new("Couldn't load User from XML. Check that your URL is correct.\n#{xml}")
+      end
+
+      def self.get(connection, path, options = {})
+        # Load data from path
+        response = connection.get(path, options).body
+        # Parse response
+        User.parse(connection, response)
+      rescue
+        raise AMEE::BadData.new("Couldn't load User. Check that your URL is correct.\n#{response}")
+      end
+
+      def update(options = {})
+        connection.put(full_path, options).body
+        AMEE::Admin::User.get(connection, full_path)
+      end
+
+      def self.create(connection, environment_uid, options = {})
+        unless options.is_a?(Hash)
+          raise AMEE::ArgumentError.new("Second argument must be a hash of options!")
+        end
+        # Send data
+        response = connection.post("/environments/#{environment_uid}/users", options).body
+        # Parse response
+        User.parse(connection, response)
+      rescue
+        raise AMEE::BadData.new("Couldn't create User. Check that your information is correct.\n#{response}")
+      end
+
+      def delete
+        connection.delete(full_path)
+      rescue
+        raise AMEE::BadData.new("Couldn't delete User. Check that your information is correct.")
+      end
+
+      def full_path
+        "/environments/#{@environment_uid}/users/#{uid}"
+      end
+
+    end
+  end
+end

data/lib/amee/version.rb

@@ -0,0 +1,10 @@
+module AMEE
+  
+  module VERSION #:nodoc:
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 22
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+  
+end

data/rails/init.rb

@@ -0,0 +1,12 @@
+require 'amee'
+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]
+end
+
+# Add AMEE extensions into ActiveRecord::Base
+ActiveRecord::Base.class_eval { include AMEE::Rails } if Object.const_defined?("ActiveRecord")

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: amee
+version: !ruby/object:Gem::Version 
+  version: 2.0.25
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-01 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: 
+email: james@floppy.org.uk
+executables: 
+- ameesh
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- COPYING
+- 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/profile_category.rb
+- lib/amee/profile_item.rb
+- lib/amee/profile_item_value.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
+- lib/amee/drill_down.rb
+- lib/amee/rails.rb
+- lib/amee/pager.rb
+- lib/amee/item_definition.rb
+- lib/amee/user.rb
+- bin/ameesh
+- examples/list_profiles.rb
+- examples/create_profile.rb
+- examples/create_profile_item.rb
+- examples/view_data_category.rb
+- examples/view_data_item.rb
+- init.rb
+- rails/init.rb
+- amee.example.yml
+has_rdoc: true
+homepage: http://github.com/Floppy/amee-ruby
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby interface to the AMEE carbon calculator
+test_files: []
+