Floppy-amee 0.0.2

data/README

@@ -0,0 +1,22 @@
+== AMEE-Ruby
+
+A gem to provide a Ruby interface to the AMEE carbon calculator (http://amee.cc)
+
+Licensed under the MIT license (See COPYING file for details)
+
+Author: James Smith (james@floppy.org.uk / http://www.floppy.org.uk)
+
+Homepage: http://github.com/Floppy/amee-ruby
+
+== INSTALLATION
+
+1) Enable gems from github, if you haven't already done so: 
+    > sudo gem sources -a http://gems.github.com
+
+2) Install gem
+    > sudo gem install Floppy-amee
+
+== USAGE
+
+Currently, in this first version, only reading data categories is supported. See 
+examples/view_data_category.rb for a simple usage example.

data/examples/view_data_category.rb

@@ -0,0 +1,40 @@
+require 'rubygems'
+require 'amee'
+require 'optparse'
+
+# Command-line options - get username, password, and server
+options = {}
+OptionParser.new do |opts|
+  opts.on("-u", "--username USERNAME", "AMEE username") do |u|
+    options[:username] = u
+  end  
+  opts.on("-p", "--password PASSWORD", "AMEE password") do |p|
+    options[:password] = p
+  end
+  opts.on("-s", "--server SERVER", "AMEE server") do |s|
+    options[:server] = s
+  end
+end.parse!
+
+# Connect
+connection = AMEE::Connection.new(options[:server], options[:username], options[:password])
+
+# For each path in arg list, show details
+ARGV.each do |path|
+  cat = AMEE::Data::Category.get(connection, path)
+  puts "---------------------"
+  puts "Category: #{cat.name}"
+  puts "Path: #{cat.full_path}"
+  puts "UID: #{cat.uid}"
+  puts "Subcategories:"
+  cat.children.each do |c|
+    puts "  - #{c[:path]} (#{c[:name]})"
+  end
+  puts "Items:"
+  cat.items.each do |i|
+    puts "  - #{i[:path]} (#{i[:label]})"
+  end
+  
+end
+
+

data/lib/amee.rb

@@ -0,0 +1,17 @@
+require 'rexml/document'
+require 'amee/connection'
+require 'amee/object'
+require 'amee/data_category'
+require 'amee/data_item'
+require 'amee/data_item_value'
+
+module AMEE
+  
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 2
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+  
+end

data/lib/amee/connection.rb

@@ -0,0 +1,66 @@
+require 'net/http'
+
+module AMEE
+  class Connection
+    
+    def initialize(server, username = nil, password = nil)
+      @server = server
+      @username = username
+      @password = password
+      @auth_token = nil
+      raise "Must specify both username and password for authenticated access" if (@username || @password) && !valid?
+    end
+    
+    def valid?
+      !((@username || @password) ? (@username.nil? || @password.nil? || @server.nil?) : @server.nil?)
+    end
+    
+    def can_authenticate?
+      !(@username.nil? || @password.nil?)
+    end
+
+    def authenticated?
+      !@auth_token.nil?
+    end
+
+    def get(path)
+      response = nil
+      http = Net::HTTP.new(@server)
+      #http.set_debug_output($stdout)
+      http.start do
+        get = Net::HTTP::Get.new(path)
+        get['authToken'] = @auth_token
+        get['Accept'] = 'application/xml'
+        response = http.request(get)
+        # If request fails, authenticate and try again
+        if authentication_failed?(response)
+          authenticate
+          get['authToken'] = @auth_token
+          response = http.request(get)
+        end
+      end
+      yield response.body if block_given?
+      response.body
+    end
+
+  protected
+
+    def authentication_failed?(response)
+      response.code == '401'
+    end
+    
+    def authenticate
+      unless can_authenticate?        
+        raise "AMEE authentication required. Please provide your username and password."
+      end
+      response = nil
+      http = Net::HTTP.new(@server)
+      http.start do
+        response = http.post("/auth", "username=#{@username}&password=#{@password}")
+        @auth_token = response['authToken']
+        raise "AMEE authentication failed. Please check your username and password." unless authenticated?
+      end
+    end
+    
+  end
+end

data/lib/amee/data_category.rb

@@ -0,0 +1,61 @@
+require 'date'
+
+module AMEE
+  module Data
+    class Category < AMEE::Object
+
+      def initialize(data = {})
+        @children = data ? data[:children] : []
+        @items = data ? data[:items] : []
+        super
+      end
+
+      attr_reader :children
+      attr_reader :items
+
+      def self.get(connection, path)
+        # Load data from path
+        response = connection.get(path)
+        # Parse data from response into hash
+        doc = REXML::Document.new(response)
+        data = {}
+        data[:uid] = REXML::XPath.first(doc, "/Resources/DataCategoryResource/DataCategory/@uid").to_s
+        data[:created] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataCategoryResource/DataCategory/@created").to_s)
+        data[:modified] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataCategoryResource/DataCategory/@modified").to_s)
+        data[:name] = REXML::XPath.first(doc, '/Resources/DataCategoryResource/DataCategory/Name').text
+        data[:path] = REXML::XPath.first(doc, '/Resources/DataCategoryResource/Path').text || ""
+        data[:children] = []
+        REXML::XPath.each(doc, '/Resources/DataCategoryResource/Children/DataCategories/DataCategory') do |child|
+          category_data = {}
+          category_data[:name] = child.elements['Name'].text
+          category_data[:path] = child.elements['Path'].text
+          category_data[:uid] = child.attributes['uid'].to_s
+          data[:children] << category_data
+        end
+        data[:items] = []
+        REXML::XPath.each(doc, '/Resources/DataCategoryResource/Children/DataItems/DataItem') do |item|
+          item_data = {}
+          item_data[:label] = item.elements['label'].text
+          item_data[:path] = item.elements['path'].text
+          item_data[:uid] = item.attributes['uid'].to_s
+          data[:items] << item_data
+        end
+        # Create category object
+        cat = Category.new(data)
+        # Store connection in object for future use
+        cat.connection = connection
+        # Done
+        return cat
+      end
+      
+      def self.root(connection)
+        self.get(connection, '/data')
+      end
+      
+      def child(child_path)
+        AMEE::Data::Category.get(connection, "#{full_path}/#{child_path}")
+      end
+      
+    end
+  end
+end

data/lib/amee/data_item.rb

@@ -0,0 +1,46 @@
+module AMEE
+  module Data
+    class Item < AMEE::Object
+
+      def initialize(data = {})
+        @values = data ? data[:values] : []
+        @label = data ? data[:label] : []
+        super
+      end
+
+      attr_reader :values
+      attr_reader :label
+
+      def self.get(connection, path)
+        # Load data from path
+        response = connection.get(path)
+        # Parse data from response into hash
+        doc = REXML::Document.new(response)
+        data = {}
+        data[:uid] = REXML::XPath.first(doc, "/Resources/DataItemResource/DataItem/@uid").to_s
+        data[:created] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataItemResource/DataItem/@created").to_s)
+        data[:modified] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataItemResource/DataItem/@modified").to_s)
+        data[:name] = REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/Name').text
+        data[:path] = REXML::XPath.first(doc, '/Resources/DataItemResource/Path').text
+        data[:label] = REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/Label').text
+        # Get values
+        data[:values] = []
+        REXML::XPath.each(doc, '/Resources/DataItemResource/DataItem/ItemValues/ItemValue') do |value|
+          value_data = {}
+          value_data[:name] = value.elements['Name'].text
+          value_data[:path] = value.elements['Path'].text
+          value_data[:value] = value.elements['Value'].text
+          value_data[:uid] = value.attributes['uid'].to_s
+          data[:values] << value_data
+        end
+        # Create item object
+        item = Item.new(data)
+        # Store connection in object for future use
+        item.connection = connection
+        # Done
+        return item
+      end
+
+    end
+  end
+end

data/lib/amee/data_item_value.rb

@@ -0,0 +1,14 @@
+module AMEE
+  module Data
+    class ItemValue < AMEE::Object
+
+      def initialize(data = {})
+        @value = data ? data[:value] : nil
+        super
+      end
+
+      attr_reader :value
+      
+    end
+  end
+end

data/lib/amee/object.rb

@@ -0,0 +1,25 @@
+module AMEE
+  class Object
+    
+    def initialize(data = nil)
+      @uid = data ? data[:uid] : nil
+      @created = data ? data[:created] : Time.now
+      @modified = data ? data[:modified] : @created
+      @path = data ? data[:path] : nil
+      @name = data ? data[:name] : nil
+      @connection = nil
+    end
+    
+    attr_accessor :connection
+    attr_reader :uid
+    attr_reader :created
+    attr_reader :modified
+    attr_reader :path
+    attr_reader :name
+    
+    def full_path
+      "/data#{@path}"
+    end
+      
+  end
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification 
+name: Floppy-amee
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- James Smith
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-10 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: james@floppy.org.uk
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README
+- lib/amee.rb
+- lib/amee/connection.rb
+- lib/amee/data_category.rb
+- lib/amee/data_item.rb
+- lib/amee/data_item_value.rb
+- lib/amee/object.rb
+- examples/view_data_category.rb
+has_rdoc: false
+homepage: http://github.com/Floppy/amee-ruby
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby interface to the AMEE carbon calculator
+test_files: []
+