sugarcrm 0.9.7 → 0.9.8

data/VERSION

@@ -1 +1 @@
-0.9.7
+0.9.8

data/lib/sugarcrm/associations.rb

@@ -1,2 +1,5 @@
+require 'sugarcrm/associations/association'
+require 'sugarcrm/associations/associations'
+require 'sugarcrm/associations/association_cache'
 require 'sugarcrm/associations/association_methods'
 require 'sugarcrm/associations/association_collection'

data/lib/sugarcrm/associations/association.rb

@@ -0,0 +1,104 @@
+module SugarCRM
+  # Represents an association and it's metadata
+  class Association    
+    attr :owner
+    attr :target
+    attr :link_field
+    attr :attributes
+    attr :methods
+    
+    def initialize(owner,link_field,opts={})
+      @options = { :define_methods? => true }.merge! opts
+      @owner = owner
+      check_valid_owner
+      @link_field = link_field
+      @attributes = owner.link_fields[link_field]
+      @target = resolve_target
+      @methods = define_methods if @options[:define_methods?]
+      self
+    end
+    
+    # Returns true if the association includes an attribute that matches
+    # the provided string
+    def include?(attribute)
+      return true if attribute.class == @target
+      return true if attribute == link_field
+      return true if methods.include? attribute
+      false
+    end
+    
+    protected
+
+    def check_valid_owner
+      valid = @owner.class.ancestors.include? SugarCRM::Base
+      raise InvalidModule, "#{@owner} is not registered, or is not a descendant of SugarCRM::Base" unless valid
+    end
+    
+    # Attempts to determine the class of the target in the association
+    def resolve_target
+      # Use the link_field name first
+      klass = @link_field.singularize.camelize
+      return "SugarCRM::#{klass}".constantize if SugarCRM.const_defined? klass
+
+      # Use the link_field attribute "module"
+      if @attributes["module"].length > 0
+        module_name = SugarCRM::Module.find(@attributes["module"])
+        return "SugarCRM::#{module_name.klass}".constantize if SugarCRM.const_defined? module_name.klass
+      end
+      # Use the link_field attribute "relationship"
+      if @attributes["relationship"].length > 0
+        klass = humanized_link_name(@attributes["relationship"]).singularize.camelize
+        return "SugarCRM::#{klass}".constantize if SugarCRM.const_defined? klass
+      end
+      false
+    end
+    
+    # Generates the association proxy method for related module
+    def define_method(link_field, pretty_name=nil)
+      pretty_name ||= link_field
+      @owner.class.module_eval %Q?
+        def #{pretty_name}
+          query_association :#{link_field}
+        end
+      ?
+      pretty_name
+    end
+    
+    # Defines methods for accessing the association target on the owner class.
+    # If the link_field name includes the owner class name, it is stripped before 
+    # creating the method.  If this occurs, we also create an alias to the stripped
+    # method using the full link_field name.
+    def define_methods
+      methods = []
+      pretty_name = humanized_link_name(@link_field)
+      methods << define_method(pretty_name)
+      if pretty_name != @link_field
+        @owner.class.module_eval %Q?
+          alias :#{@link_field} #{pretty_name}
+        ?
+        methods << @link_field
+      end
+      methods
+    end
+    
+    # Return the name of the relationship excluding the owner part of the name.
+    # e.g. if a custom relationship is defined in Studio between Tasks and Documents,
+    # the link_field will be `tasks_documents` but a human would call the relationship `documents`
+    def humanized_link_name(link_field)
+      # Split the relationship name into parts
+      # "contact_accounts" => ["contact","accounts"]
+      m = link_field.split(/_/)
+      # Determine the parts we don't want
+      # SugarCRM::Contact => ["contacts", "contact"]
+      o = @owner.class._module.table_name
+      # Use array subtraction to remove parts representing the owner side of the relationship
+      # ["contact", "accounts"] - ["contacts", "contact"] => ["accounts"]
+      t = m - [o, o.singularize]
+      # Reassemble whatever's left
+      # "accounts"
+      t.join('_')
+    end
+    
+  end
+end
+

data/lib/sugarcrm/associations/association_cache.rb

@@ -0,0 +1,30 @@
+module SugarCRM; module AssociationCache
+
+  attr :association_cache, false
+    
+  # Returns true if an association is cached
+  def association_cached?(association)
+    @association_cache.symbolize_keys.include? association.to_sym
+  end
+
+  protected
+
+  # Returns true if an association collection has changed
+  def associations_changed?
+    @association_cache.values.each do |collection|
+      return true if collection.changed?
+    end
+    false
+  end
+
+  # Updates an association cache entry if it's been initialized
+  def update_association_cache_for(association, target)
+    # only add to the cache if the relationship has been queried
+    @association_cache[association] << target if association_cached? association
+  end
+  
+  # Resets the association cache
+  def clear_association_cache
+    @association_cache = {}.with_indifferent_access
+  end
+end; end

data/lib/sugarcrm/associations/association_collection.rb

@@ -12,7 +12,7 @@ module SugarCRM
       load if preload
       self
     end
-    
+        
     def changed?
       return false unless loaded?
       return true if added.length > 0
@@ -95,8 +95,7 @@ module SugarCRM
       removed.each do |record|
         disassociate!(record)
       end
-      @original = @collection.dup
-      @original.freeze
+      reload
       true
     end
     
@@ -118,12 +117,12 @@ module SugarCRM
     # user would be the owner, and EmailAddress.new() is the target
     def associate!(target, opts={})
       #target.save! if target.new?
-      @owner.associate!(target, [target.id], opts)
+      @owner.associate!(target, opts)
     end
     
     # Removes a relationship between the current object and the target    
     def disassociate!(target)
-      associate!(target,{:delete => 1})
+      @owner.associate!(target,{:delete => 1})
     end
 
     alias :relate! :associate!

data/lib/sugarcrm/associations/association_methods.rb

@@ -1,74 +1,53 @@
 module SugarCRM; module AssociationMethods
-  
+
   module ClassMethods
-    # Returns an array of the module link fields
-    def associations_from_module_link_fields
-      self._module.link_fields.keys
-    end
-  end
-  
-  attr :association_cache, false
-  
-  def association_cached?(association)
-    @association_cache.keys.include? association.to_sym
   end
-  
-  def associations_changed?
+
+  # Saves all modified associations.
+  def save_modified_associations!
     @association_cache.values.each do |collection|
-      return true if collection.changed?
+      if collection.changed?
+        collection.save!
+      end
     end
-    false
+    true
   end
   
-  # Creates a relationship between the current object and the target
-  # The current instance and target records will have a relationship set
-  # i.e. account.associate!(contact) wyould link account and contact
+  # Returns the module link fields hash
+  def link_fields
+    self.class._module.link_fields
+  end
+  
+  # Creates a relationship between the current object and the target object
+  # The current and target records will have a relationship set
+  # i.e. account.associate!(contact) would link account and contact
   # In contrast to using account.contacts << contact, this method doesn't load the relationships
   # before setting the new relationship.
   # This method is useful when certain modules have many links to other modules: not loading the
   # relationships allows one ot avoid a Timeout::Error
-  def associate!(target, target_ids=[], opts={})
-    if self.class._module.custom_module? || target.class._module.custom_module?
-      link_field = get_link_field(target)
-    else
-      link_field = target.class._module.table_name
-    end
-    target_ids = [target.id] if target_ids.size < 1
-    response = SugarCRM.connection.set_relationship(
-      self.class._module.name, self.id, 
-      link_field, target_ids,
-      opts
-    )
-    raise AssociationFailed, 
-      "Couldn't associate #{self.class._module.name}: #{self.id} -> #{target.class._module.table_name}:#{target.id}!" if response["failed"] > 0
-    true
-  end
-  
-  protected
-  
-  def save_modified_associations
-    @association_cache.values.each do |collection|
-      if collection.changed?
-        return false unless collection.save
+  def associate!(target,opts={})
+    targets = Array.wrap(target)
+    targets.each do |t|
+      association = @associations.find!(t)
+      response = SugarCRM.connection.set_relationship(
+        self.class._module.name, self.id, 
+        association.link_field, [t.id], opts
+      )
+      if response["failed"] > 0
+        raise AssociationFailed, 
+        "Couldn't associate #{self.class._module.name}: #{self.id} -> #{t}: #{t.id}!" 
       end
+      update_association_cache_for(association.link_field, t)
     end
     true
   end
-  
-  def clear_association_cache
-    @association_cache = {}
-  end
-  
+    
+  protected
+
   # Generates the association proxy methods for related modules
   def define_association_methods
+    @associations = Associations.register(self)
     return if association_methods_generated?
-    @associations.each do |k|
-      self.class.module_eval %Q?
-      def #{k}
-        query_association :#{k}
-      end
-      ?
-    end
     self.class.association_methods_generated = true
   end
   
@@ -94,15 +73,5 @@ module SugarCRM; module AssociationMethods
     @association_cache[association] = collection
     collection
   end
-  
-  # return the link field involving a relationship with a custom module
-  def get_link_field(other)
-    this_table_name = self.class._module.custom_module? ? self.class._module.name : self.class._module.table_name
-    that_table_name = other.class._module.custom_module? ? other.class._module.name : other.class._module.table_name
-    # the link field will contain the name of both modules
-    link_field = self.associations.detect{|a| a == [this_table_name, that_table_name].join('_') || a == [that_table_name, this_table_name].join('_')}
-    raise "Unable to determine link field between #{self.class._module.name}: #{self.id} and #{other.class._module.table_name}:#{other.id}" unless link_field
-    link_field
-  end
 
 end; end

data/lib/sugarcrm/associations/associations.rb

@@ -0,0 +1,62 @@
+module SugarCRM
+  # Holds all the associations for a given class
+  class Associations
+    # Returns an array of Association objects
+    class << self
+      def register(owner)
+        associations = Associations.new
+        owner.link_fields.each_key do |link_field|
+          associations << Association.new(owner,link_field)
+        end
+        associations
+      end
+    end
+    
+    attr :associations
+    
+    def initialize
+      @associations = Set.new
+      self
+    end
+    
+    # Looks up an association by object, link_field, or method.
+    # Raises an exception if not found
+    def find!(target)
+      @associations.each do |a|
+        return a if a.include? target
+      end
+      raise InvalidAssociation, "Could not lookup association for: #{target}"
+    end
+
+    # Looks up an association by object, link_field, or method.
+    # Returns false if not found
+    def find(association)
+      begin
+        find!
+      rescue InvalidAssociation
+        false
+      end
+    end
+    
+    def inspect
+      self
+    end
+    
+    def to_s
+      methods = []
+      @associations.each do |a|
+        a.methods.each do |m|
+          methods << m
+        end
+      end
+      "[#{methods.join(', ')}]"
+    end
+      
+    # delegate undefined methods to the @collection array
+    # E.g. contact.cases should behave like an array and allow `length`, `size`, `each`, etc.
+    def method_missing(method_name, *args, &block)
+      @associations.send(method_name.to_sym, *args, &block)
+    end
+    
+  end
+end

data/lib/sugarcrm/attributes/attribute_methods.rb

@@ -2,7 +2,7 @@ module SugarCRM; module AttributeMethods
 
   module ClassMethods
     # Returns a hash of the module fields from the module
-    def attributes_from_module_fields
+    def attributes_from_module
       fields = {}.with_indifferent_access
       self._module.fields.keys.sort.each do |k|
         fields[k] = nil
@@ -74,7 +74,7 @@ module SugarCRM; module AttributeMethods
   # royally screws up our typecasting code, so we handle it here.
   def merge_attributes(attrs={})
     # copy attributes from the parent module fields array
-    @attributes = self.class.attributes_from_module_fields
+    @attributes = self.class.attributes_from_module
     # populate the attributes with values from the attrs provided to init.
     @attributes.keys.each do |name|
       write_attribute name, attrs[name] if attrs[name]
@@ -125,7 +125,7 @@ module SugarCRM; module AttributeMethods
   
   # Wrapper for invoking save on modified_attributes
   # sets the id if it's a new record
-  def save_modified_attributes
+  def save_modified_attributes!
     # Complain if we aren't valid
     raise InvalidRecord, errors.to_a.join(", ") if !valid?
     # Send the save request

data/lib/sugarcrm/base.rb

@@ -5,7 +5,7 @@ module SugarCRM; class Base
 
   # This holds our connection
   cattr_accessor :connection, :instance_writer => false
-    
+
   # Tracks if we have extended our class with attribute methods yet.
   class_attribute :attribute_methods_generated
   self.attribute_methods_generated = false
@@ -230,11 +230,7 @@ module SugarCRM; class Base
               record = find(:first, options)
 
               if record.nil?
-                record = self.new do |r|
-                  r.send(:attributes=, protected_attributes_for_create, true) unless protected_attributes_for_create.empty?
-                  r.send(:attributes=, unprotected_attributes_for_create, false) unless unprotected_attributes_for_create.empty?
-                end
-                #{'yield(record) if block_given?'}
+                record = self.new(unprotected_attributes_for_create)
                 #{'record.save' if instantiator == :create}
                 record
               else
@@ -250,7 +246,7 @@ module SugarCRM; class Base
     end
     
     def all_attributes_exists?(attribute_names)
-      attribute_names.all? { |name| attributes_from_module_fields.include?(name) }
+      attribute_names.all? { |name| attributes_from_module.include?(name) }
     end
     
     def construct_attributes_from_arguments(attribute_names, arguments)
@@ -269,11 +265,10 @@ module SugarCRM; class Base
   end
 
   # Creates an instance of a Module Class, i.e. Account, User, Contact, etc.
-  def initialize(attributes={})
+  def initialize(attributes={}, &block)
     @modified_attributes = {}
     merge_attributes(attributes.with_indifferent_access)
     clear_association_cache
-    @associations = self.class.associations_from_module_link_fields
     define_attribute_methods
     define_association_methods
     typecast_attributes
@@ -308,8 +303,8 @@ module SugarCRM; class Base
   # Saves the current object, and any modified associations. 
   # Raises an exceptions if save fails for any reason.
   def save!
-    save_modified_attributes
-    save_modified_associations
+    save_modified_attributes!
+    save_modified_associations!
     true
   end
   
@@ -371,6 +366,7 @@ module SugarCRM; class Base
     include AttributeSerializers
     include AssociationMethods
     extend  AssociationMethods::ClassMethods
+    include AssociationCache
   end
 
 end; end 

data/lib/sugarcrm/connection/api/get_entries.rb

@@ -1,23 +1,23 @@
 module SugarCRM; class Connection
-# Retrieve a list of SugarBeans by ID.  This method will not 
-# work with the report module.
-def get_entries(module_name, ids, opts={})
-  login! unless logged_in?
-  options = { 
-    :fields => [], 
-    :link_fields => [], 
-  }.merge! opts
+  # Retrieve a list of SugarBeans by ID.  This method will not 
+  # work with the report module.
+  def get_entries(module_name, ids, opts={})
+    login! unless logged_in?
+    options = { 
+      :fields => [], 
+      :link_fields => [], 
+    }.merge! opts
 
-  json = <<-EOF
-    {
-      \"session\": \"#{@session}\"\,
-      \"module_name\": \"#{module_name}\"\,
-      \"ids\": #{ids.to_json}\,
-      \"select_fields\": #{resolve_fields(module_name, options[:fields])}\,
-      \"link_name_to_fields_array\": #{options[:link_fields].to_json}\,
-    }
-  EOF
-  json.gsub!(/^\s{6}/,'')
-  SugarCRM::Response.handle(send!(:get_entries, json))
-end
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name\": \"#{module_name}\"\,
+        \"ids\": #{ids.to_json}\,
+        \"select_fields\": #{resolve_fields(module_name, options[:fields])}\,
+        \"link_name_to_fields_array\": #{options[:link_fields].to_json}\,
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    SugarCRM::Response.handle(send!(:get_entries, json))
+  end
 end; end

data/lib/sugarcrm/connection/api/get_entries_count.rb

@@ -1,20 +1,20 @@
 module SugarCRM; class Connection
-# Retrieves the specified number of records in a module.
-def get_entries_count(module_name, query, opts={})
-  login! unless logged_in?
-  options = {
-    :deleted => 0
-  }.merge! opts
+  # Retrieves the specified number of records in a module.
+  def get_entries_count(module_name, query, opts={})
+    login! unless logged_in?
+    options = {
+      :deleted => 0
+    }.merge! opts
 
-  json = <<-EOF
-    {
-      \"session\": \"#{@session}\"\,
-      \"module_name\": \"#{module_name}\"\,
-      \"query\": \"#{query}\"\,
-      \"deleted\": #{options[:deleted]}
-    }
-  EOF
-  json.gsub!(/^\s{6}/,'')
-  send!(:get_entries_count, json)
-end
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name\": \"#{module_name}\"\,
+        \"query\": \"#{query}\"\,
+        \"deleted\": #{options[:deleted]}
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    send!(:get_entries_count, json)
+  end
 end; end

data/lib/sugarcrm/connection/api/get_entry_list.rb

@@ -1,31 +1,31 @@
 module SugarCRM; class Connection
-# Retrieve a list of SugarBeans.  This is the primary method for getting 
-# a list of SugarBeans using the REST API.
-def get_entry_list(module_name, query, opts={})
-  login! unless logged_in?
-  options = {
-    :order_by => '', 
-    :offset => '', 
-    :fields => [], 
-    :link_fields => [], 
-    :limit => '', 
-    :deleted => 0
-  }.merge! opts
+  # Retrieve a list of SugarBeans.  This is the primary method for getting 
+  # a list of SugarBeans using the REST API.
+  def get_entry_list(module_name, query, opts={})
+    login! unless logged_in?
+    options = {
+      :order_by => '', 
+      :offset => '', 
+      :fields => [], 
+      :link_fields => [], 
+      :limit => '', 
+      :deleted => 0
+    }.merge! opts
 
-  json = <<-EOF
-    {
-      \"session\": \"#{@session}\"\,
-      \"module_name\": \"#{module_name}\"\,
-      \"query\": \"#{query}\"\,
-      \"order_by\": \"#{options[:order_by]}\"\,
-      \"offset\": \"#{options[:offset]}\"\,
-      \"select_fields\": #{resolve_fields(module_name, options[:fields])}\,
-      \"link_name_to_fields_array\": #{options[:link_fields].to_json}\,
-      \"max_results\": \"#{options[:limit]}\"\,
-      \"deleted\": #{options[:deleted]}
-    }
-  EOF
-  json.gsub!(/^\s{6}/,'')
-  SugarCRM::Response.handle(send!(:get_entry_list, json))
-end
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name\": \"#{module_name}\"\,
+        \"query\": \"#{query}\"\,
+        \"order_by\": \"#{options[:order_by]}\"\,
+        \"offset\": \"#{options[:offset]}\"\,
+        \"select_fields\": #{resolve_fields(module_name, options[:fields])}\,
+        \"link_name_to_fields_array\": #{options[:link_fields].to_json}\,
+        \"max_results\": \"#{options[:limit]}\"\,
+        \"deleted\": #{options[:deleted]}
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    SugarCRM::Response.handle(send!(:get_entry_list, json))
+  end
 end; end

data/lib/sugarcrm/connection/api/get_module_fields.rb

@@ -1,19 +1,15 @@
 module SugarCRM; class Connection
-
-# Retrieves the vardef information on fields of the specified bean.  
-def get_module_fields(module_name)
-  login! unless logged_in?  
-  json = <<-"EOF"
-    {
-      \"session\": \"#{@session}\"\,
-      \"module_name": \"#{module_name}"
-    }
-  EOF
-  json.gsub!(/^\s{6}/,'')
-  SugarCRM::Response.handle(send!(:get_module_fields, json))
-  #send!(:get_module_fields, json)
-end
-
-alias :get_fields :get_module_fields
-
+  # Retrieves the vardef information of the specified bean.  
+  def get_module_fields(module_name)
+    login! unless logged_in?  
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name": \"#{module_name}"
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    SugarCRM::Response.handle(send!(:get_module_fields, json))
+  end
+  alias :get_fields :get_module_fields
 end; end

data/lib/sugarcrm/connection/api/get_note_attachment.rb

@@ -1,14 +1,14 @@
 module SugarCRM; class Connection
-# Retrieves an attachment from a note.
-def get_note_attachment(id)
-  login! unless logged_in?
-  json = <<-EOF
-    {
-      \"session\": \"#{@session}\"\,
-      \"id\": #{id}\
-    }
-  EOF
-  json.gsub!(/^\s{6}/,'')
-  send!(:get_note_attachment, json)
-end
+  # Retrieves an attachment from a note.
+  def get_note_attachment(id)
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"id\": #{id}\
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    send!(:get_note_attachment, json)
+  end
 end; end

data/lib/sugarcrm/connection/api/get_relationships.rb

@@ -1,34 +1,30 @@
 module SugarCRM; class Connection
-# Retrieves a collection of beans that are related 
-# to the specified bean and, optionally, returns 
-# relationship data
-def get_relationships(module_name, id, related_to, opts={})
-  login! unless logged_in?
-  options = { 
-    :query => '',
-    :fields => [], 
-    :link_fields => [], 
-    :deleted => ''
-  }.merge! opts  
-  
-  related_module = related_to.classify
-  
-  json = <<-EOF
-    {
-      \"session\": \"#{@session}\"\,
-      \"module_name\": \"#{module_name}\"\,
-      \"module_id\": \"#{id}\"\,
-      \"link_field_name\": \"#{related_to.downcase}\"\,
-      \"related_module_query\": \"#{options[:query]}\"\,
-      \"related_fields\": #{resolve_fields(related_module, options[:fields])}\,
-      \"related_module_link_name_to_fields_array\": #{options[:link_fields].to_json}\,
-      \"deleted\": #{options[:deleted]}
-    }
-  EOF
-  json.gsub!(/^\s{6}/,'')
-  SugarCRM::Response.new(send!(:get_relationships, json)).to_obj
-end
-
-alias :get_relationship :get_relationships
+  # Retrieves a collection of beans that are related 
+  # to the specified bean and, optionally, returns 
+  # relationship data
+  def get_relationships(module_name, id, related_to, opts={})
+    login! unless logged_in?
+    options = { 
+      :query => '',
+      :fields => [], 
+      :link_fields => [], 
+      :deleted => ''
+    }.merge! opts  
 
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name\": \"#{module_name}\"\,
+        \"module_id\": \"#{id}\"\,
+        \"link_field_name\": \"#{related_to.downcase}\"\,
+        \"related_module_query\": \"#{options[:query]}\"\,
+        \"related_fields\": #{resolve_related_fields(module_name, related_to)}\,
+        \"related_module_link_name_to_fields_array\": #{options[:link_fields].to_json}\,
+        \"deleted\": #{options[:deleted]}
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    SugarCRM::Response.new(send!(:get_relationships, json), {:always_return_array => true}).to_obj
+  end
+  alias :get_relationship :get_relationships
 end; end

data/lib/sugarcrm/connection/api/get_report_entries.rb

@@ -1,17 +1,17 @@
 module SugarCRM; class Connection
-# Retrieves a list of report entries based on specified report IDs.
-def get_report_entries(ids, opts={})
-  login! unless logged_in?
-  options = {:select_fields => ''}.merge! opts
+  # Retrieves a list of report entries based on specified report IDs.
+  def get_report_entries(ids, opts={})
+    login! unless logged_in?
+    options = {:select_fields => ''}.merge! opts
 
-  json = <<-EOF
-    {
-      \"session\": \"#{@session}\"\,
-      \"ids\": #{ids.to_json}\,
-      \"select_fields\": \"#{options[:select_fields].to_json}\"
-    }
-  EOF
-  json.gsub!(/^\s{6}/,'')
-  send!(:get_report_entries, json)
-end
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"ids\": #{ids.to_json}\,
+        \"select_fields\": \"#{options[:select_fields].to_json}\"
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    send!(:get_report_entries, json)
+  end
 end; end

data/lib/sugarcrm/connection/api/login.rb

@@ -12,7 +12,7 @@ module SugarCRM; class Connection
         \"application\": \"\"
       }
     EOF
-    json.gsub!(/^\s{8}/,'')
+    json.gsub!(/^\s{6}/,'')
     response = send!(:login, json)
   end
 end; end

data/lib/sugarcrm/connection/api/logout.rb

@@ -9,7 +9,7 @@ module SugarCRM; class Connection
         }
       }
     EOF
-    json.gsub!(/^\s{8}/,'')
+    json.gsub!(/^\s{6}/,'')
     send!(:logout, json)
   end
 end; end

data/lib/sugarcrm/connection/api/seamless_login.rb

@@ -7,7 +7,7 @@ module SugarCRM; class Connection
         \"session\": \"#{@session}\"
       }
     EOF
-    json.gsub!(/^\s{8}/,'')
+    json.gsub!(/^\s{6}/,'')
     response = send!(:seamless_login, json)
   end
 end; end

data/lib/sugarcrm/connection/helper.rb

@@ -1,15 +1,40 @@
 module SugarCRM; class Connection
+  # Attempts to return a list of fields for the target of the association.
+  # i.e. if we are associating Contact -> Account, using the "contacts" link
+  # field name - this will lookup the contacts association and try to determine
+  # the target object type (Contact).  It will then pull the fields for that object
+  # and shove them in the related_fields portion of the get_relationship request.
+  def resolve_related_fields(module_name, link_field)
+    a = Association.new(class_for(module_name), link_field)
+    if a.target
+      fields = a.target.new.attributes.keys
+    else
+      fields = ["id"]
+    end
+    fields.to_json
+  end
+  
   def resolve_fields(module_name, fields)
     # FIXME: This is to work around a bug in SugarCRM 6.0
     # where no fields are returned if no fields are specified
     if fields.length == 0
-      mod = Module.find(module_name)
+      mod = Module.find(module_name.classify)
       if mod
         fields = mod.fields.keys
-      else  
-        fields = "id"
+      else
+        fields = ["id"]
       end
     end
     return fields.to_json
   end
+  
+  # Returns an instance of class for the provided module name
+  def class_for(module_name)
+    begin
+      klass = "SugarCRM::#{module_name.classify}".constantize.new
+    rescue NameError
+      raise InvalidModule, "Module: #{module_name} is not registered"
+    end
+  end
+  
 end; end

data/lib/sugarcrm/connection/request.rb

@@ -15,7 +15,7 @@ module SugarCRM; class Request
     @request << '&rest_data=' << @json
     if debug
       puts "#{method}: Request:"
-      pp @request 
+      puts @request 
       puts "\n"
     end
     self

data/lib/sugarcrm/connection/response.rb

@@ -26,7 +26,8 @@ module SugarCRM; class Response
 
   attr :response, false
   
-  def initialize(json)
+  def initialize(json,opts={})
+    @options  = { :always_return_array => false }.merge! opts
     @response = json
     @response = json.with_indifferent_access if json.is_a? Hash
   end
@@ -52,7 +53,7 @@ module SugarCRM; class Response
       end
     end
     # If we only have one result, just return the object
-    if objects.length == 1
+    if objects.length == 1 && !@options[:always_return_array]
       return objects[0]
     else
       return objects

data/lib/sugarcrm/exceptions.rb

@@ -13,4 +13,5 @@ module SugarCRM
   class UninitializedModule < RuntimeError; end
   class InvalidAttribute < RuntimeError; end
   class InvalidAttributeType < RuntimeError; end
+  class InvalidAssociation < RuntimeError; end
 end

data/lib/sugarcrm/module.rb

@@ -7,6 +7,7 @@ module SugarCRM
     attr :klass, true
     attr :fields, true
     attr :link_fields, true
+    alias :bean :klass
 
     # Dynamically register objects based on Module name
     # I.e. a SugarCRM Module named Users will generate
@@ -15,27 +16,28 @@ module SugarCRM
       @name   = name
       @klass  = name.classify
       @table_name = name.tableize
-      
-      # set table name for custom attibutes
-      # custom attributes are contained in a table named after the module, with a '_cstm' suffix
-      # the module's table name must be tableized for the modules that ship with SugarCRM
-      # for custom modules (created in the Studio), table name don't need to be tableized: the name passed to the constructor is already tableized
-      unless self.custom_module?
-        @custom_table_name = @table_name + "_cstm"
-      else
-        @custom_table_name = name + "_cstm"
-      end
-      
+      @custom_table_name = resolve_custom_table_name      
       @fields = {}
       @link_fields = {}
       @fields_registered = false
       self
     end
     
-    # return true if this module was created in the SugarCRM Studio (i.e. it is not part of the modules that
-    # ship in the dfault SugarCRM configuration
+    # Return true if this module was created in the SugarCRM Studio (i.e. it is not part of the modules that
+    # ship in the default SugarCRM configuration)
     def custom_module?
-      name.downcase == name # custom module names are all lower_case, whereas SugarCRM modules are CamelCase
+      # custom module names are all lower_case, whereas SugarCRM modules are CamelCase
+      @name.downcase == @name 
+    end
+
+    # Set table name for custom attibutes
+    # Custom attributes are contained in a table named after the module, with a '_cstm' suffix.
+    # The module's table name must be tableized for the modules that ship with SugarCRM.
+    # For custom modules (created in the Studio), table name don't need to be tableized since
+    # the name passed to the constructor is already tableized    
+    def resolve_custom_table_name
+      @custom_table_name = @table_name + "_cstm"
+      @custom_table_name = @name + "_cstm" if custom_module?
     end
     
     # Returns the fields associated with the module

data/test/connection/test_get_relationships.rb

@@ -6,10 +6,10 @@ class TestGetRelationships < Test::Unit::TestCase
       SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => false, :debug => false})
     end
     should "return a list of email_addresses when sent #get_relationship and a user_id" do
-      email_address = SugarCRM.connection.get_relationships(
+      email_addresses = SugarCRM.connection.get_relationships(
         "Users",1,"email_addresses"
       )
-      assert_instance_of SugarCRM::EmailAddress, email_address
+      assert_instance_of SugarCRM::EmailAddress, email_addresses.first
     end
   end
 end

data/test/test_association.rb

@@ -0,0 +1 @@
+#TODO: Figure out how to test this.

data/test/test_associations.rb

@@ -31,5 +31,11 @@ class TestAssociations < Test::Unit::TestCase
       assert u.meetings.save!
       assert !u.meetings.include?(m)
     end
+    
+    # TODO: Fix created_by_link to only return a single result
+    should "return a user when sent #created_by_link" do
+      a = SugarCRM::Account.first
+      assert_instance_of SugarCRM::User, a.created_by_link.first
+    end
   end
 end

data/test/test_module.rb

@@ -15,8 +15,9 @@ class TestModule < Test::Unit::TestCase
       assert SugarCRM::User._module.required_fields.include? :user_name
     end
     
-    should "return the custom table name when #custom_table_name" do
-      assert_equal "accounts_cstm", SugarCRM::Account._module.custom_table_name
-    end
+    # TODO: Figure out a way to test this.
+    #should "return the custom table name when #custom_table_name" do
+    #  assert_equal "accounts_cstm", SugarCRM::Account._module.custom_table_name
+    #end
   end
 end

data/test/test_sugarcrm.rb

@@ -39,7 +39,7 @@ class TestSugarCRM < Test::Unit::TestCase
     end
   
     should "respond to self.attributes_from_modules_fields" do
-      assert_instance_of ActiveSupport::HashWithIndifferentAccess, SugarCRM::User.attributes_from_module_fields
+      assert_instance_of ActiveSupport::HashWithIndifferentAccess, SugarCRM::User.attributes_from_module
     end
   
     should "return an instance of itself when #new" do
@@ -134,6 +134,21 @@ class TestSugarCRM < Test::Unit::TestCase
       assert_equal "sarah@example.com", u.email_addresses.first.email_address
     end
     
+    should "create or retrieve a record when #find_or_create_by_name" do
+      a = SugarCRM::Account.find_or_create_by_name("Really Important Co. Name")
+      assert_instance_of SugarCRM::Account, a
+      assert !a.new?
+      b = SugarCRM::Account.find_or_create_by_name("Really Important Co. Name")
+      assert a == b
+      assert a.delete
+    end
+    
+#    should "support saving of records with special characters in them" do
+#      a = SugarCRM::Account.new
+#      a.name = "COHEN, WEISS & SIMON LLP"
+#      assert a.save!
+#    end
+    
   end
   
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: sugarcrm
 version: !ruby/object:Gem::Version 
-  hash: 53
-  prerelease: 
+  prerelease: false
   segments: 
   - 0
   - 9
-  - 7
-  version: 0.9.7
+  - 8
+  version: 0.9.8
 platform: ruby
 authors: 
 - Carl Hicks
@@ -15,99 +14,93 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-15 00:00:00 -08:00
+date: 2011-01-18 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  name: activesupport
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 3
         - 0
         - 0
         version: 3.0.0
-  requirement: *id001
+  type: :runtime
   prerelease: false
-  name: activesupport
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  name: i18n
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id002
+  type: :runtime
   prerelease: false
-  name: i18n
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  name: shoulda
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id003
+  type: :development
   prerelease: false
-  name: shoulda
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  name: bundler
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
-  requirement: *id004
+  type: :development
   prerelease: false
-  name: bundler
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  name: jeweler
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 1
         - 5
         - 2
         version: 1.5.2
-  requirement: *id005
+  type: :development
   prerelease: false
-  name: jeweler
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  type: :development
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  name: rcov
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id006
+  type: :development
   prerelease: false
-  name: rcov
+  version_requirements: *id006
 description: A less clunky way to interact with SugarCRM via REST.  Instead of SugarCRM.connection.get_entry("Users", "1") you could use SugarCRM::User.find(1).  There is support for collections a la SugarCRM::User.find(1).email_addresses, or SugarCRM::Contact.first.meetings << new_meeting.  ActiveRecord style finders are in place, with limited support for conditions and joins.
 email: carl.hicks@gmail.com
 executables: []
@@ -126,8 +119,11 @@ files:
 - VERSION
 - lib/sugarcrm.rb
 - lib/sugarcrm/associations.rb
+- lib/sugarcrm/associations/association.rb
+- lib/sugarcrm/associations/association_cache.rb
 - lib/sugarcrm/associations/association_collection.rb
 - lib/sugarcrm/associations/association_methods.rb
+- lib/sugarcrm/associations/associations.rb
 - lib/sugarcrm/attributes.rb
 - lib/sugarcrm/attributes/attribute_methods.rb
 - lib/sugarcrm/attributes/attribute_serializers.rb
@@ -180,6 +176,7 @@ files:
 - test/connection/test_logout.rb
 - test/connection/test_set_relationship.rb
 - test/helper.rb
+- test/test_association.rb
 - test/test_association_collection.rb
 - test/test_associations.rb
 - test/test_connection.rb
@@ -200,7 +197,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -1258950620288984122
       segments: 
       - 0
       version: "0"
@@ -209,14 +206,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.4.1
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Ruby based REST client for SugarCRM
@@ -234,6 +230,7 @@ test_files:
 - test/connection/test_logout.rb
 - test/connection/test_set_relationship.rb
 - test/helper.rb
+- test/test_association.rb
 - test/test_association_collection.rb
 - test/test_associations.rb
 - test/test_connection.rb