Floppy-amee 2.0.22 → 2.0.24

data/README

@@ -55,16 +55,16 @@ example:
 
     config.gem "Floppy-amee", :lib => "amee", :source => "http://gems.github.com", :version => '>= 0.3.0'
 
-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:
+If you copy amee.example.yml from the gem source directory to amee.yml in your
+app's config directory, a persistent AMEE connection available called $amee,
+will be automatically set up for you, which you can pass into the other objects
+to fetch data. For instance:
 
     data = AMEE::Data::Category.root($amee)
 
+If you do not use this facility, you will have to create your own connection
+objects and manage them yourself.
+
 There is a helper for ActiveRecord models which should be linked to an AMEE profile.
 By adding:
 

data/amee.example.yml

@@ -0,0 +1,12 @@
+development:
+  server: stage.amee.com
+  username: your_amee_username
+  password: your_amee_password
+test:
+  server: stage.amee.com
+  username: your_amee_username
+  password: your_amee_password
+production:
+  server: live.amee.com
+  username: your_amee_username
+  password: your_amee_password

data/lib/amee.rb

@@ -42,6 +42,7 @@ require 'amee/profile_item_value'
 require 'amee/drill_down'
 require 'amee/pager'
 require 'amee/item_definition'
+require 'amee/user'
 
 class Date
   def amee1_date

data/lib/amee/connection.rb

@@ -178,6 +178,12 @@ module AMEE
         when '401'
           authenticate
           return false
+        when '400'
+          if response.body.include? "would have resulted in a duplicate resource being created"
+            raise AMEE::DuplicateResource.new("The specified resource already exists. This is most often caused by creating an item that overlaps another in time. AMEE Response: #{response.body}")
+          else
+            raise AMEE::UnknownError.new("An error occurred while talking to AMEE: HTTP response code #{response.code}. AMEE Response: #{response.body}")
+          end
         else
           raise AMEE::UnknownError.new("An error occurred while talking to AMEE: HTTP response code #{response.code}. AMEE Response: #{response.body}")
       end

data/lib/amee/data_category.rb

@@ -81,9 +81,21 @@ module AMEE
         raise AMEE::BadData.new("Couldn't load DataCategory from XML data. Check that your URL is correct.\n#{xml}")
       end
       
-      def self.get(connection, path, items_per_page = 10)
+      def self.get(connection, path, orig_options = {})
+        unless orig_options.is_a?(Hash)
+          raise AMEE::ArgumentError.new("Third argument must be a hash of options!")
+        end
+        # Convert to AMEE options
+        options = orig_options.clone
+        if orig_options[:items_per_page]
+          options[:itemsPerPage] = orig_options[:items_per_page]
+        else
+          options[:itemsPerPage] = 10
+        end
+
         # Load data from path
-        response = connection.get(path, :itemsPerPage => items_per_page).body
+        response = connection.get(path, options).body
+
         # Parse data from response
         if response.is_json?
           cat = Category.from_json(response)
@@ -161,6 +173,23 @@ module AMEE
      rescue
        raise AMEE::BadData.new("Couldn't delete DataCategory. Check that your information is correct.")
      end
+
+     def self.update(connection, path, options = {})
+       # Do we want to automatically fetch the item afterwards?
+       get_item = options.delete(:get_item)
+       get_item = true if get_item.nil?
+       # Go
+       response = connection.put(path, options)
+       if get_item
+         if response.body.empty?
+           return Category.get(connection, path)
+         else
+           return Category.parse(connection, response.body)
+         end
+       end
+     rescue
+       raise AMEE::BadData.new("Couldn't update Data Category. Check that your information is correct.")
+     end
        
     end
   end

data/lib/amee/data_item.rb

@@ -18,7 +18,7 @@ module AMEE
       attr_reader :item_definition
       attr_reader :total_amount
       attr_reader :total_amount_unit
-
+      
       def self.from_json(json)
         # Read JSON
         doc = JSON.parse(json)
@@ -111,6 +111,12 @@ module AMEE
       def self.get(connection, path, options = {})
         # Load data from path
         response = connection.get(path, options).body
+        AMEE::Data::Item.parse(connection, response)
+      rescue
+        raise AMEE::BadData.new("Couldn't load DataItem. Check that your URL is correct.\n#{response}")
+      end
+
+      def self.parse(connection, response)
         # Parse data from response
         if response.is_json?
           item = Item.from_json(response)
@@ -121,8 +127,6 @@ module AMEE
         item.connection = connection
         # Done
         return item
-      rescue
-        raise AMEE::BadData.new("Couldn't load DataItem. Check that your URL is correct.\n#{response}")
       end
 
       def self.create_batch_without_category(connection, category_path, items, options = {})
@@ -156,47 +160,54 @@ module AMEE
         unless options.is_a?(Hash)
           raise AMEE::ArgumentError.new("Third argument must be a hash of options!")
         end
-        # Set dates
-        if options[:start_date] && connection.version < 2
-          options[:validFrom] = options[:start_date].amee1_date
-        elsif options[:start_date] && connection.version >= 2
-          options[:startDate] = options[:start_date].xmlschema
-        end
-        options.delete(:start_date)
-        if options[:end_date] && connection.version >= 2
-          options[:endDate] = options[:end_date].xmlschema
-        end
-        options.delete(:end_date)
-        if options[:duration] && connection.version >= 2
-          options[:duration] = "PT#{options[:duration] * 86400}S"
-        end
         # Create a data item!
         options[:newObjectType] = "DI"
         # Send data to path
         response = connection.post(path, options)
-#        if response['Location']
-#          location = response['Location'].match("http://.*?(/.*)")[1]
-#        else
-#          category = Category.parse(connection, response.body)
-#          location = category.full_path + "/" + category.items[0][:path]
-#        end
-#        if get_item == true
-#          get_options = {}
-#          get_options[:format] = format if format
-#          return AMEE::Data::Item.get(connection, location, get_options)
-#        else
-#          return location
-#        end
+        if response['Location']
+          location = response['Location'].match("http://.*?(/.*)")[1]
+        else
+          category = Category.parse(connection, response.body)
+          location = category.full_path + "/" + category.items[0][:path]
+        end
+        if get_item == true
+          get_options = {}
+          get_options[:format] = format if format
+          return AMEE::Data::Item.get(connection, location, get_options)
+        else
+          return location
+        end
       rescue
         raise AMEE::BadData.new("Couldn't create DataItem. Check that your information is correct.\n#{response}")
       end
 
-      def update(options = {})
-        response = connection.put(full_path, options).body
+      def self.update(connection, path, options = {})
+        # Do we want to automatically fetch the item afterwards?
+        get_item = options.delete(:get_item)
+        get_item = true if get_item.nil?
+        # Go
+        response = connection.put(path, options)
+        if get_item
+          if response.body.empty?
+            return Item.get(connection, path)
+          else
+            return Item.parse(connection, response.body)
+          end
+        end
       rescue
         raise AMEE::BadData.new("Couldn't update DataItem. Check that your information is correct.\n#{response}")
       end
+      
+      def update(options = {})
+        AMEE::Data::Item.update(connection, full_path, options)
+      end
 
+      def self.delete(connection, path)
+        connection.delete(path)
+      rescue
+        raise AMEE::BadData.new("Couldn't delete DataItem. Check that your information is correct.")
+      end
+      
       def value(name_or_path_or_uid)
         val = values.find{ |x| x[:name] == name_or_path_or_uid || x[:path] == name_or_path_or_uid || x[:uid] == name_or_path_or_uid}
         val ? val[:value] : nil

data/lib/amee/data_item_value.rb

@@ -7,6 +7,7 @@ module AMEE
         @type = data ? data[:type] : nil
         @from_profile = data ? data[:from_profile] : nil
         @from_data = data ? data[:from_data] : nil
+        @start_date = data ? data[:start_date] : nil
         super
       end
 
@@ -33,6 +34,10 @@ module AMEE
         @from_data
       end
       
+      def start_date
+        @start_date
+      end
+      
       def self.from_json(json, path)
         # Read JSON
         doc = JSON.parse(json)['itemValue']
@@ -44,6 +49,7 @@ module AMEE
         data[:path] = path.gsub(/^\/data/, '')
         data[:value] = doc['value']
         data[:type] = doc['itemValueDefinition']['valueDefinition']['valueType']
+        data[:start_date] = DateTime.parse(doc['startDate']) rescue nil
         # Create object
         ItemValue.new(data)
       rescue 
@@ -63,6 +69,7 @@ module AMEE
         data[:type] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/ItemValueDefinition/ValueDefinition/ValueType').text
         data[:from_profile] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/ItemValueDefinition/FromProfile').text == "true" ? true : false
         data[:from_data] = REXML::XPath.first(doc, '/Resources/DataItemValueResource/ItemValue/ItemValueDefinition/FromData').text == "true" ? true : false
+        data[:start_date] = DateTime.parse(REXML::XPath.first(doc, "/Resources/DataItemValueResource/ItemValue/StartDate").text) rescue nil
         # Create object
         ItemValue.new(data)
       rescue
@@ -74,6 +81,18 @@ module AMEE
         response = connection.get(path).body
         # Parse data from response
         data = {}
+        value = ItemValue.parse(connection, response, path)
+        # Done
+        return value
+      rescue
+        raise AMEE::BadData.new("Couldn't load DataItemValue. Check that your URL is correct.")
+      end
+
+      def save!
+        response = @connection.put(full_path, :value => value).body
+      end
+
+      def self.parse(connection, response, path) 
         if response.is_json?
           value = ItemValue.from_json(response, path)
         else
@@ -86,11 +105,63 @@ module AMEE
       rescue
         raise AMEE::BadData.new("Couldn't load DataItemValue. Check that your URL is correct.\n#{response}")
       end
+      
+      def self.create(data_item, options = {})
+        # Do we want to automatically fetch the item afterwards?
+        get_item = options.delete(:get_item)
+        get_item = true if get_item.nil?
+        # Store format if set
+        format = options[:format]
+        unless options.is_a?(Hash)
+          raise AMEE::ArgumentError.new("Third argument must be a hash of options!")
+        end
+        # Set startDate
+        if (options[:start_date])
+          options[:startDate] = options[:start_date].xmlschema
+          options.delete(:start_date)
+        end
+      
+        response = data_item.connection.post(data_item.full_path, options)
+        location = response['Location'].match("http://.*?(/.*)")[1]
 
-      def save!
-        response = @connection.put(full_path, :value => value).body
+        if get_item == true
+          get_options = {}
+          get_options[:format] = format if format
+          return AMEE::Data::ItemValue.get(data_item.connection, location)
+        else
+          return location
+        end
+      rescue
+        raise AMEE::BadData.new("Couldn't create DataItemValue. Check that your information is correct.")
       end
 
+      def self.update(connection, path, options = {})
+        # Do we want to automatically fetch the item afterwards?
+        get_item = options.delete(:get_item)
+        get_item = true if get_item.nil?
+        # Go
+        response = connection.put(path, options)
+        if get_item
+          if response.body.empty?
+            return AMEE::Data::ItemValue.get(connection, path)
+          else
+            return AMEE::Data::ItemValue.parse(connection, response.body)
+          end
+        end
+      rescue
+        raise AMEE::BadData.new("Couldn't update DataItemValue. Check that your information is correct.\n#{response}")
+      end
+      
+      def update(options = {})
+        AMEE::Data::ItemValue.update(connection, full_path, options)
+      end
+      
+      def self.delete(connection, path)
+        connection.delete(path)
+      rescue
+        raise AMEE::BadData.new("Couldn't delete DataItemValue. Check that your information is correct.")
+      end      
+    
     end
   end
-end
+end

data/lib/amee/exceptions.rb

@@ -18,6 +18,9 @@ module AMEE
   class NotFound < Exception
   end
   
+  class DuplicateResource < Exception
+  end
+
   class UnknownError < Exception
   end
   

data/lib/amee/item_definition.rb

@@ -110,8 +110,19 @@ module AMEE
         raise AMEE::BadData.new("Couldn't load ItemDefinition. Check that your URL is correct.\n#{response}")
       end
 
-      def update(options = {})
-        response = connection.put(full_path, options).body
+      def self.update(connection, path, options = {})
+        # Do we want to automatically fetch the item afterwards?
+        get_item = options.delete(:get_item)
+        get_item = true if get_item.nil?
+        # Go
+        response = connection.put(path, options)
+        if get_item
+          if response.body.empty?
+            return ItemDefinition.get(connection, path)
+          else
+            return ItemDefinition.parse(connection, response.body)
+          end
+        end
       rescue
         raise AMEE::BadData.new("Couldn't update ItemDefinition. Check that your information is correct.\n#{response}")
       end

data/lib/amee/profile_item.rb

@@ -316,7 +316,7 @@ module AMEE
         options.delete(:start_date)
         if options[:end_date] && connection.version >= 2
           options[:endDate] = options[:end_date].xmlschema
-        end
+        end        
         options.delete(:end_date)
         if options[:duration] && connection.version >= 2
           options[:duration] = "PT#{options[:duration] * 86400}S"

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/rails/init.rb

@@ -8,17 +8,6 @@ if File.exist?(amee_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::Rails.establish_connection($AMEE_CONFIG['server'], $AMEE_CONFIG['username'], $AMEE_CONFIG['password'])
-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
 
 # Add AMEE extensions into ActiveRecord::Base

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Floppy-amee
 version: !ruby/object:Gem::Version 
-  version: 2.0.22
+  version: 2.0.24
 platform: ruby
 authors: 
 - James Smith
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-08-06 00:00:00 -07:00
+date: 2009-09-15 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,7 @@ files:
 - 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
@@ -70,6 +71,7 @@ files:
 - examples/view_data_item.rb
 - init.rb
 - rails/init.rb
+- amee.example.yml
 has_rdoc: true
 homepage: http://github.com/Floppy/amee-ruby
 licenses: