Floppy-amee 0.1.2 → 0.1.5

data/README

@@ -22,9 +22,16 @@ Currently, you can read DataCategories, DataItems and DataItemValues. See
 examples/view_data_*.rb for simple usage examples. You can also get the list
 of available Profiles. See examples/list_profiles.rb for details.
 
+The gem will use the AMEE JSON API if the JSON gem is installed on the local
+system. Otherwise the XML API will be used. Currently, only DataCategories and
+Profile lists are supported with JSON, so you can disable JSON support by setting
+the fourth argument to AMEE::Connection.new() to false:
+
+ > AMEE::Connection.new($srv, $user, $pass, false) # last arg disables JSON support
+
 == INTERACTIVE SHELL
 
 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.
+this interface yet.

data/examples/view_data_item.rb

@@ -17,7 +17,7 @@ OptionParser.new do |opts|
 end.parse!
 
 # Connect
-connection = AMEE::Connection.new(options[:server], options[:username], options[:password])
+connection = AMEE::Connection.new(options[:server], options[:username], options[:password], false) # Disable JSON support for now
 
 # For each path in arg list, show details
 ARGV.each do |path|

data/lib/amee/connection.rb

@@ -2,12 +2,13 @@ require 'net/http'
 
 module AMEE
   class Connection
-    
-    def initialize(server, username = nil, password = nil)
+
+    def initialize(server, username = nil, password = nil, use_json_if_available = true)
       @server = server
       @username = username
       @password = password
       @auth_token = nil
+      @use_json_if_available = use_json_if_available
       raise "Must specify both username and password for authenticated access" if (@username || @password) && !valid?
       # Make connection to server
       @http = Net::HTTP.new(@server)
@@ -37,7 +38,7 @@ module AMEE
       response = nil
       get = Net::HTTP::Get.new(path)
       get['authToken'] = @auth_token
-      get['Accept'] = 'application/xml'
+      get['Accept'] = content_type
       response = @http.request(get)
       # Handle 404s
       raise AMEE::NotFound.new("URL doesn't exist on server.") if response.code == '404'
@@ -53,6 +54,10 @@ module AMEE
 
   protected
 
+    def content_type
+      (@use_json_if_available && defined?(JSON)) ? 'application/json' : 'application/xml'
+    end
+    
     def authentication_failed?(response)
       response.code == '401'
     end
@@ -64,7 +69,7 @@ module AMEE
       response = nil
       post = Net::HTTP::Post.new("/auth")
       post.body = "username=#{@username}&password=#{@password}"
-      post['Accept'] = 'application/xml'
+      post['Accept'] = content_type
       response = @http.request(post)
       @auth_token = response['authToken']
       raise AMEE::AuthFailed.new("Authentication failed. Please check your username and password.") unless authenticated?

data/lib/amee/data_category.rb

@@ -16,29 +16,60 @@ module AMEE
       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
+        # Parse data from response
+        profiles = []
+        if response.slice(0,1) == '{'
+          # Read JSON
+          doc = JSON.parse(response)
+          data = {}
+          data[:uid] = doc['dataCategory']['uid']
+          data[:created] = DateTime.parse(doc['dataCategory']['created'])
+          data[:modified] = DateTime.parse(doc['dataCategory']['modified'])
+          data[:name] = doc['dataCategory']['name']
+          data[:path] = doc['path']
+          data[:children] = []
+          doc['children']['dataCategories'].each do |child|
+            category_data = {}
+            category_data[:name] = child['name']
+            category_data[:path] = child['path']
+            category_data[:uid] = child['uid']
+            data[:children] << category_data
+          end
+          data[:items] = []
+          if doc['children']['dataItems']['rows']
+            doc['children']['dataItems']['rows'].each do |item|
+              item_data = {}
+              item_data[:label] = item['label']
+              item_data[:path] = item['path']
+              item_data[:uid] = item['uid']
+              data[:items] << item_data
+            end
+          end
+        else
+          # Read XML
+          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
         end
         # Create category object
         cat = Category.new(data)

data/lib/amee/data_item.rb

@@ -4,11 +4,13 @@ module AMEE
 
       def initialize(data = {})
         @values = data ? data[:values] : []
+        @choices = data ? data[:choices] : []
         @label = data ? data[:label] : []
         super
       end
 
       attr_reader :values
+      attr_reader :choices
       attr_reader :label
 
       def self.get(connection, path)
@@ -33,6 +35,14 @@ module AMEE
           value_data[:uid] = value.attributes['uid'].to_s
           data[:values] << value_data
         end
+        # Get choices
+        data[:choices] = []
+        REXML::XPath.each(doc, '/Resources/DataItemResource/Choices/Choices/Choice') do |choice|
+          choice_data = {}
+          choice_data[:name] = choice.elements['Name'].text
+          choice_data[:value] = choice.elements['Value'].text
+          data[:choices] << choice_data
+        end
         # Create item object
         item = Item.new(data)
         # Store connection in object for future use

data/lib/amee/profile.rb

@@ -3,27 +3,47 @@ module AMEE
     
     def self.list(connection)
       # Load data from path
-      response = connection.get('/profiles')
-      # Parse data from response into hash
-      doc = REXML::Document.new(response)
+      response = connection.get('/profiles')      
+      # Parse data from response
       profiles = []
-      REXML::XPath.each(doc, '/Resources/ProfilesResource/Profiles/Profile') do |p|
-        data = {}
-        data[:uid] = p.attributes['uid'].to_s
-        data[:created] = DateTime.parse(p.attributes['created'].to_s)
-        data[:modified] = DateTime.parse(p.attributes['modified'].to_s)
-        data[:name] = p.elements['Name'].text || data[:uid]
-        data[:path] = p.elements['Path'].text || data[:uid]
-        # Create profile
-        profile = AMEE::Profile.new(data)
-        # Store connection in object for future use
-        profile.connection = connection
-        # Store in array
-        profiles << profile
+      if response.slice(0,1) == '{'
+        # Read JSON
+        doc = JSON.parse(response)
+        doc['profiles'].each do |p|
+          data = {}
+          data[:uid] = p['uid']
+          data[:created] = DateTime.parse(p['created'])
+          data[:modified] = DateTime.parse(p['modified'])
+          data[:name] = p['name']
+          data[:path] = p['path']
+          # Create profile
+          profile = AMEE::Profile.new(data)
+          # Store connection in object for future use
+          profile.connection = connection
+          # Store in array
+          profiles << profile
+        end
+      else
+        # Read XML
+        doc = REXML::Document.new(response)
+        REXML::XPath.each(doc, '/Resources/ProfilesResource/Profiles/Profile') do |p|
+          data = {}
+          data[:uid] = p.attributes['uid'].to_s
+          data[:created] = DateTime.parse(p.attributes['created'].to_s)
+          data[:modified] = DateTime.parse(p.attributes['modified'].to_s)
+          data[:name] = p.elements['Name'].text || data[:uid]
+          data[:path] = p.elements['Path'].text || data[:uid]
+          # Create profile
+          profile = AMEE::Profile.new(data)
+          # Store connection in object for future use
+          profile.connection = connection
+          # Store in array
+          profiles << profile
+        end
       end
       # Done
       return profiles
     end
-    
+
   end
 end

data/lib/amee/shell.rb

@@ -60,7 +60,7 @@ require 'amee'
 include AMEE::Shell
 
 # Set up connection
-$connection = AMEE::Connection.new(ENV['AMEE_SERVER'], ENV['AMEE_USERNAME'], ENV['AMEE_PASSWORD'])
+$connection = AMEE::Connection.new(ENV['AMEE_SERVER'], ENV['AMEE_USERNAME'], ENV['AMEE_PASSWORD'], false)  # Disable JSON support for now
 
 if $connection.valid?
   # Change to root of data api to get going

data/lib/amee/version.rb

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

data/lib/amee.rb

@@ -1,4 +1,13 @@
 require 'rexml/document'
+
+# We don't NEED the JSON gem, but if it's available, use it.
+begin
+  require 'json'
+rescue LoadError
+  nil
+end
+
+require 'amee/version'
 require 'amee/exceptions'
 require 'amee/connection'
 require 'amee/object'
@@ -6,14 +15,3 @@ require 'amee/data_category'
 require 'amee/data_item'
 require 'amee/data_item_value'
 require 'amee/profile'
-
-module AMEE
-  
-  module VERSION #:nodoc:
-    MAJOR = 0
-    MINOR = 1
-    TINY  = 2
-    STRING = [MAJOR, MINOR, TINY].join('.')
-  end
-  
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: Floppy-amee
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.5
 platform: ruby
 authors: 
 - James Smith
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-24 00:00:00 -07:00
+date: 2008-07-29 00:00:00 -07:00
 default_executable: 
 dependencies: []
 
@@ -24,16 +24,17 @@ extra_rdoc_files: []
 files: 
 - README
 - COPYING
-- bin/ameesh
 - 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/exceptions.rb
-- lib/amee/object.rb
 - lib/amee/profile.rb
+- lib/amee/version.rb
+- lib/amee/data_category.rb
+- lib/amee/data_item_value.rb
+- lib/amee/object.rb
 - lib/amee/shell.rb
+- bin/ameesh
 - examples/list_profiles.rb
 - examples/view_data_category.rb
 - examples/view_data_item.rb