amee 2.0.35 → 2.2.0

data/CHANGELOG

@@ -0,0 +1,11 @@
+= Changelog
+
+== 2.2.0
+
+* Add SSL support. SSL connections are now used by default.
+* Log4r support
+* Support for reading ItemValueDefinitions
+    * Include accessors from other objects
+* Internal improvements including
+    * Improved paging support
+    * Tidier code for collections

data/README

@@ -12,13 +12,15 @@ Documentation: http://docs.github.com/Floppy/amee-ruby
 
 == INSTALLATION
 
-1) Enable gems from gemcutter, if you haven't already done so: 
-    > sudo gem install gemcutter
-    > sudo gem tumble
-
-2) Install gem
+1) Install gem
     > sudo gem install amee
 
+== IMPORTANT CHANGES when upgrading to 2.2.0 and above
+
+SSL connections are now supported, and are used BY DEFAULT.If you do not want to
+use SSL, you can disable it using the ":ssl => false" option to Connection.new, or
+by adding "ssl: false" to your amee.yml if you are using Rails.
+
 == IMPORTANT CHANGES when upgrading beyond 2.0.25
 
 If you are using the $amee connection in your Rails apps, this is now deprecated
@@ -60,7 +62,7 @@ This gem can also 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 "amee", :version => '>= 2.0.26'
+    config.gem "amee", :version => '~> 2.2.0'
 
 If you copy amee.example.yml from the gem source directory to amee.yml in your
 app's config directory, a persistent AMEE connection will be available from 

data/amee.example.yml

@@ -2,11 +2,14 @@ development:
   server: stage.amee.com
   username: your_amee_username
   password: your_amee_password
+  #ssl: false # Uncomment if you don't want to use SSL
 test:
   server: stage.amee.com
   username: your_amee_username
   password: your_amee_password
+  #ssl: false # Uncomment if you don't want to use SSL
 production:
   server: live.amee.com
   username: your_amee_username
   password: your_amee_password
+  #ssl: false # Uncomment if you don't want to use SSL

data/cacert.pem

@@ -0,0 +1,45 @@
+-----BEGIN CERTIFICATE-----
+MIIEdDCCA1ygAwIBAgIQRL4Mi1AAJLQR0zYq/mUK/TANBgkqhkiG9w0BAQUF
+ADCBlzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAlVUMRcwFQYDVQQHEw5TYWx0
+IExha2UgQ2l0eTEeMBwGA1UEChMVVGhlIFVTRVJUUlVTVCBOZXR3b3JrMSEw
+HwYDVQQLExhodHRwOi8vd3d3LnVzZXJ0cnVzdC5jb20xHzAdBgNVBAMTFlVU
+Ti1VU0VSRmlyc3QtSGFyZHdhcmUwHhcNOTkwNzA5MTgxMDQyWhcNMTkwNzA5
+MTgxOTIyWjCBlzELMAkGA1UEBhMCVVMxCzAJBgNVBAgTAlVUMRcwFQYDVQQH
+Ew5TYWx0IExha2UgQ2l0eTEeMBwGA1UEChMVVGhlIFVTRVJUUlVTVCBOZXR3
+b3JrMSEwHwYDVQQLExhodHRwOi8vd3d3LnVzZXJ0cnVzdC5jb20xHzAdBgNV
+BAMTFlVUTi1VU0VSRmlyc3QtSGFyZHdhcmUwggEiMA0GCSqGSIb3DQEBAQUA
+A4IBDwAwggEKAoIBAQCx98M4P7Sof885glFn0G2f0v9Y8+efK+wNiVSZuTiZ
+FvfgIXlIwrthdBKWHTxqctU8EGc6Oe0rE81m65UJM6Rsl7HoxuzBdXmcRl6N
+q9Bq/bkqVRcQVLMZ8Jr28bFdtqdt++BxF2uiiPsA3/4aMXcMmgF6sTLjKwEH
+OG7DpV4jvEWbe1DByTCP2+UretNb+zNAHqDVmBe8i4fDidNdoI6yqqr2jmmI
+BsX6iSHzCJ1pLgkzmykNRg+MzEk0sGlRvfkGzWitZky8PqxhvQqIDsjfPe58
+BEydCl5rkdbux+0ojatNh4lz0G6k0B4WixThdkQDf2Os5M1JnMWS9KsyoUhb
+AgMBAAGjgbkwgbYwCwYDVR0PBAQDAgHGMA8GA1UdEwEB/wQFMAMBAf8wHQYD
+VR0OBBYEFKFyXyYbKJhDlV0HN9WFlp1L0sNFMEQGA1UdHwQ9MDswOaA3oDWG
+M2h0dHA6Ly9jcmwudXNlcnRydXN0LmNvbS9VVE4tVVNFUkZpcnN0LUhhcmR3
+YXJlLmNybDAxBgNVHSUEKjAoBggrBgEFBQcDAQYIKwYBBQUHAwUGCCsGAQUF
+BwMGBggrBgEFBQcDBzANBgkqhkiG9w0BAQUFAAOCAQEARxkP3nTGmZev/K0o
+XnWO6y1n7k57K9cM//bey1WiCuFMVGWTYGufEpytXoMs61quwOQt9ABjHbjA
+bPLPSbtNk28GpgoiskliCE7/yMgUsogWXecB5BKV5UU0s4tpvc+0hY91UZ59
+Ojg6FEgSxvunOxqNDYJAB+gECJChicsZUN/KHAG8HQQZexB2lzvukJDKxA4f
+Fm517zP4029bHpbj4HR3dHuKom4t3XbWOTCC8KucUvIqx69JXn7HaOWCgchq
+J/kniCrVWFCVH/A7HFe7fRQ5YiuayZSSKqMiDP+JJn1fIytH1xUdqWqeUQ0q
+UZ6B+dQ7XnASfxAynB67nfhmqA==
+-----END CERTIFICATE-----
+-----BEGIN CERTIFICATE-----
+MIICkDCCAfmgAwIBAgIBATANBgkqhkiG9w0BAQQFADBaMQswCQYDVQQGEwJV
+UzEcMBoGA1UEChMTRXF1aWZheCBTZWN1cmUgSW5jLjEtMCsGA1UEAxMkRXF1
+aWZheCBTZWN1cmUgR2xvYmFsIGVCdXNpbmVzcyBDQS0xMB4XDTk5MDYyMTA0
+MDAwMFoXDTIwMDYyMTA0MDAwMFowWjELMAkGA1UEBhMCVVMxHDAaBgNVBAoT
+E0VxdWlmYXggU2VjdXJlIEluYy4xLTArBgNVBAMTJEVxdWlmYXggU2VjdXJl
+IEdsb2JhbCBlQnVzaW5lc3MgQ0EtMTCBnzANBgkqhkiG9w0BAQEFAAOBjQAw
+gYkCgYEAuucXkAJlsTRVPEnCUdXfp9E3j9HngXNBUmCbnaEXJnitx7HoJpQy
+td4zjTov2/KaelpzmKNc6fuKcxtc58O/gGzNqfTWK8D3+ZmqY6KxRwIP1ORR
+OhI8bIpaVIRw28HFkM9yRcuoWcDNM50/o5brhTMhHD4ePmBudpxnhcXIw2EC
+AwEAAaNmMGQwEQYJYIZIAYb4QgEBBAQDAgAHMA8GA1UdEwEB/wQFMAMBAf8w
+HwYDVR0jBBgwFoAUvqigdHJQa0S3ySPY+6j/s1draGwwHQYDVR0OBBYEFL6o
+oHRyUGtEt8kj2Puo/7NXa2hsMA0GCSqGSIb3DQEBBAUAA4GBADDiAVGqx+pf
+2rnQZQ8w1j7aDRRJbpGTJxQx78T3LUX47Me/okENI7SS+RkAZ70Br83gcfxa
+z2TE4JaY0KNA4gGK7ycH8WUBikQtBmV1UsCGECAhX2xrD2yuCRyv8qIYNMR1
+pHMc8Y3c7635s3a0kr/clRAevsvIO1qEYBlWlKlV
+-----END CERTIFICATE-----

data/lib/amee.rb

@@ -1,5 +1,6 @@
 require 'rexml/document'
 require 'active_support'
+require 'log4r'
 
 # We don't NEED the JSON gem, but if it's available, use it.
 begin
@@ -26,9 +27,12 @@ class String
   end
 end
 
+require 'amee/logger'
 require 'amee/version'
 require 'amee/exceptions'
 require 'amee/connection'
+require 'amee/parse_helper'
+require 'amee/collection'
 require 'amee/object'
 require 'amee/data_object'
 require 'amee/profile_object'
@@ -43,6 +47,7 @@ require 'amee/profile_item_value'
 require 'amee/drill_down'
 require 'amee/pager'
 require 'amee/item_definition'
+require 'amee/item_value_definition'
 require 'amee/user'
 
 class Date

data/lib/amee/collection.rb

@@ -0,0 +1,64 @@
+module AMEE
+  class Collection < Array
+    include ParseHelper
+    attr_reader :pager,:connection,:doc,:json,:response
+    def initialize(connection, options = {})
+      # Load data from path
+      @options=options
+      @max=options.delete :resultMax
+      @connection=connection
+      # Parse data from response     
+      each_page do
+        parse_page
+      end
+    rescue => err
+      #raise AMEE::BadData.new("Couldn't load #{self.class.name}.\n#{response} due to #{err}")
+      raise AMEE::BadData.new("Couldn't load #{self.class.name}.\n#{response}")
+    end
+    def parse_page
+      if json
+        jsoncollector.each do |p|
+          obj = klass.new(parse_json(p))
+          obj.connection = connection
+          self << obj
+          break if @max&&length>=@max
+        end
+      else
+        REXML::XPath.first(doc,xmlcollectorpath.split('/')[1...-1].join('/')) or
+          raise AMEE::BadData.new("Couldn't load #{self.class.name}.\n#{response}")
+        REXML::XPath.each(doc, xmlcollectorpath) do |p|
+          obj=klass.new(parse_xml(p))
+          obj.connection = connection
+          self << obj
+          break if @max&&length>=@max
+        end
+      end
+    end
+
+    def fetch
+      @options.merge! @pager.options if @pager
+      @response= @connection.get(collectionpath, @options).body
+      if @response.is_json?
+        @json = true
+        @doc = JSON.parse(@response)
+      else
+        @doc = REXML::Document.new(@response)
+      end
+    end
+
+    def each_page
+      begin           
+        fetch
+        yield
+        if json
+          @pager = AMEE::Pager.from_json(doc['pager'])
+        else
+          @pager = AMEE::Pager.from_xml(REXML::XPath.first(doc, '/Resources//Pager'))
+        end
+        break if @max && length>=@max
+      end while @pager && @pager.next! #pager is nil if no pager in response,
+      # pager.next! is false if @pager said current=last.
+    end
+  end
+end
+

data/lib/amee/connection.rb

@@ -1,8 +1,11 @@
 require 'net/http'
+require 'net/https'
 
 module AMEE
   class Connection
 
+    RootCA = File.dirname(__FILE__) + '/../../cacert.pem'
+
     def initialize(server, username, password, options = {})
       unless options.is_a?(Hash)
         raise AMEE::ArgumentError.new("Fourth argument must be a hash of options!")
@@ -10,8 +13,11 @@ module AMEE
       @server = server
       @username = username
       @password = password
+      @ssl = (options[:ssl] == false) ? false : true
+      @port = @ssl ? 443 : 80
       @auth_token = nil
       @format = options[:format] || (defined?(JSON) ? :json : :xml)
+      @amee_source = options[:amee_source]
       if !valid?
        raise "You must supply connection details - server, username and password are all required!"
       end
@@ -20,20 +26,29 @@ module AMEE
         $cache ||= {}
       end
       # Make connection to server
-      @http = Net::HTTP.new(@server)
+      @http = Net::HTTP.new(@server, @port)
+      if @ssl == true
+        @http.use_ssl = true
+        if File.exists? RootCA
+          @http.ca_file = RootCA
+          @http.verify_mode = OpenSSL::SSL::VERIFY_PEER
+          @http.verify_depth = 5
+        end
+      end
       @http.read_timeout = 60
       @http.set_debug_output($stdout) if options[:enable_debug]
+      @debug = options[:enable_debug]
     end
 
     attr_reader :format
     attr_reader :server
     attr_reader :username
     attr_reader :password
-    
+
     def timeout
       @http.read_timeout
     end
-    
+
     def timeout=(t)
       @http.read_timeout = t
     end
@@ -46,7 +61,7 @@ module AMEE
     def valid?
       @username && @password && @server
     end
-    
+
     def authenticated?
       !@auth_token.nil?
     end
@@ -68,7 +83,7 @@ module AMEE
       $cache[path] = response if @enable_caching
       return response
     end
-    
+
     def post(path, data = {})
       # Allow format override
       format = data.delete(:format) || @format
@@ -140,6 +155,7 @@ module AMEE
       post = Net::HTTP::Post.new("/auth/signIn")
       post.body = "username=#{@username}&password=#{@password}"
       post['Accept'] = content_type(:xml)
+      post['X-AMEE-Source'] = @amee_source if @amee_source
       response = @http.request(post)
       @auth_token = response['authToken']
       unless authenticated?
@@ -167,7 +183,7 @@ module AMEE
         return 'application/atom+xml'
       end
     end
-    
+
     def redirect?(response)
       response.code == '301' || response.code == '302'
     end
@@ -176,6 +192,8 @@ module AMEE
       case response.code
         when '200', '201'
           return true
+        when '404'
+          raise AMEE::NotFound.new("The URL was not found on the server.\nRequest: #{request.method} #{request.path}")
         when '403'
           raise AMEE::PermissionDenied.new("You do not have permission to perform the requested operation.\nRequest: #{request.method} #{request.path}\n#{request.body}\Response: #{response.body}")
         when '401'
@@ -197,6 +215,7 @@ module AMEE
       @http.start
       # Do request
       begin
+        Logger.log.debug("Requesting #{request.class} at #{request.path} with #{request.body} in format #{format}")
         response = send_request(request, format)
       end while !response_ok?(response, request)
       # Return response
@@ -207,19 +226,17 @@ module AMEE
       # Close HTTP connection
       @http.finish if @http.started?
     end
-        
+
     def send_request(request, format = @format)
       # Set auth token in cookie (and header just in case someone's stripping cookies)
       request['Cookie'] = "authToken=#{@auth_token}"
       request['authToken'] = @auth_token
       # Set accept header
       request['Accept'] = content_type(format)
+      # Set AMEE source header if set
+      request['X-AMEE-Source'] = @amee_source if @amee_source
       # Do the business
       response = @http.request(request)
-      # Handle 404s
-      if response.code == '404'
-        raise AMEE::NotFound.new("URL doesn't exist on server.") 
-      end
       # Done
       response
     end

data/lib/amee/data_category.rb

@@ -17,6 +17,11 @@ module AMEE
       attr_reader :pager
       attr_reader :itemdef
 
+      def item_definition
+        return nil unless itemdef
+        @item_definition ||= AMEE::Admin::ItemDefinition.load(connection,itemdef)
+      end
+
       def self.from_json(json)
         # Parse json
         doc = JSON.parse(json)
@@ -52,12 +57,15 @@ module AMEE
       rescue
         raise AMEE::BadData.new("Couldn't load DataCategory from JSON data. Check that your URL is correct.\n#{json}")
       end
-      
+
+      def self.xmlpathpreamble
+        "/Resources/DataCategoryResource/DataCategory/"
+      end
       def self.from_xml(xml)
         # Parse XML
-        doc = REXML::Document.new(xml)
+        @doc = doc= REXML::Document.new(xml)
         data = {}
-        data[:uid] = REXML::XPath.first(doc, "/Resources/DataCategoryResource/DataCategory/@uid").to_s
+        data[:uid] = x '@uid'
         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/?ame').text
@@ -90,7 +98,7 @@ module AMEE
       rescue
         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, orig_options = {})
         unless orig_options.is_a?(Hash)
           raise AMEE::ArgumentError.new("Third argument must be a hash of options!")
@@ -119,11 +127,11 @@ module AMEE
       rescue
         raise AMEE::BadData.new("Couldn't load DataCategory. Check that your URL is correct.\n#{response}")
       end
-      
+
       def self.root(connection)
         self.get(connection, '/data')
       end
-      
+
       def child(child_path)
         AMEE::Data::Category.get(connection, "#{full_path}/#{child_path}")
       end
@@ -148,7 +156,7 @@ module AMEE
 
         connection = category.connection
         path = category.full_path
-        
+
         # Do we want to automatically fetch the item afterwards?
         get_item = options.delete(:get_item)
 
@@ -162,7 +170,7 @@ module AMEE
         options[:newObjectType] = "DC"
         response = connection.post(path, options)
         if response['Location']
-          location = response['Location'].match("http://.*?(/.*)")[1]
+          location = response['Location'].match("https??://.*?(/.*)")[1]
         else
           category = Category.parse(connection, response.body)
           location = category.full_path
@@ -200,7 +208,7 @@ module AMEE
      rescue
        raise AMEE::BadData.new("Couldn't update Data Category. Check that your information is correct.")
      end
-       
+
     end
   end
 end

data/lib/amee/data_item.rb

@@ -8,21 +8,29 @@ module AMEE
         @values = data[:values]
         @choices = data[:choices]
         @label = data[:label]
-        @item_definition = data[:item_definition]
+        @item_definition_uid = data[:item_definition]
         @total_amount = data[:total_amount]
         @total_amount_unit = data[:total_amount_unit]
         @start_date = data[:start_date]
+        @category_uid = data[:category_uid]
         super
       end
 
       attr_reader :values
       attr_reader :choices
       attr_reader :label
-      attr_reader :item_definition
       attr_reader :total_amount
       attr_reader :total_amount_unit
       attr_reader :start_date
-      
+      attr_reader :category_uid
+      attr_reader :item_definition_uid
+
+      def item_definition
+        return nil unless item_definition_uid
+        @item_definition ||= AMEE::Admin::ItemDefinition.load(connection,item_definition_uid)
+      end
+
+
       def self.from_json(json)
         # Read JSON
         doc = JSON.parse(json)
@@ -34,6 +42,7 @@ module AMEE
         data[:path] = doc['path']
         data[:label] = doc['dataItem']['label']
         data[:item_definition] = doc['dataItem']['itemDefinition']['uid']
+        data[:category_uid] = doc['dataItem']['dataCategory']['uid']
         # Read v2 total
         data[:total_amount] = doc['amount']['value'] rescue nil
         data[:total_amount_unit] = doc['amount']['unit'] rescue nil
@@ -67,7 +76,7 @@ module AMEE
       rescue
         raise AMEE::BadData.new("Couldn't load DataItem 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)
@@ -79,6 +88,7 @@ module AMEE
         data[:path] = (REXML::XPath.first(doc, '/Resources/DataItemResource/Path') || REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/path')).text
         data[:label] = (REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/Label') || REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/label')).text
         data[:item_definition] = REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/ItemDefinition/@uid').to_s
+        data[:category_uid] = REXML::XPath.first(doc, '/Resources/DataItemResource/DataItem/DataCategory/@uid').to_s
         # Read v2 total
         data[:total_amount] = REXML::XPath.first(doc, '/Resources/DataItemResource/Amount').text.to_f rescue nil
         data[:total_amount_unit] = REXML::XPath.first(doc, '/Resources/DataItemResource/Amount/@unit').to_s rescue nil
@@ -113,7 +123,7 @@ module AMEE
         raise AMEE::BadData.new("Couldn't load DataItem 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
@@ -171,7 +181,7 @@ module AMEE
         # Send data to path
         response = connection.post(path, options)
         if response['Location']
-          location = response['Location'].match("http://.*?(/.*)")[1]
+          location = response['Location'].match("https??://.*?(/.*)")[1]
         else
           category = Category.parse(connection, response.body)
           location = category.full_path + "/" + category.items[0][:path]
@@ -203,7 +213,7 @@ module AMEE
       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
@@ -213,7 +223,7 @@ module AMEE
       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