sugarcrm 0.9.9 → 0.9.10

data/README.rdoc

@@ -6,13 +6,7 @@ REST Bindings for SugarCRM!
 
 == SUMMARY: 
 
-RubyGem for interacting with SugarCRM via REST.  
-
-== 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 à 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. 
+A less clunky way to interact with SugarCRM via REST. 
 
 == FEATURES/PROBLEMS:
 
@@ -145,12 +139,13 @@ Instead of SugarCRM.connection.get_entry("Users", "1") you could use SugarCRM::U
 
 == USING A CONFIGURATION FILE
 
-If you want to use a configuration file instead of always specifying the url, username, and password to connect to SugarCRM, you can either
+If you want to use a configuration file instead of always specifying the url, username, and password to connect to SugarCRM, you can add your credentials to one (or more) of
 
-* add your credentials to `/etc/sugarcrm.yaml`
-* add your credentials to `~/.sugarcrm.yaml`
-* add your credentials to `config/sugarcrm.yaml` (will need to be copied each time you upgrade or reinstall the gem)
-* add your credentials to a YAML file and call `SugarCRM::Environment.load_config` followed by the absolute path to your configuration file
+* `/etc/sugarcrm.yaml`
+* `~/.sugarcrm.yaml` (i.e. your home directory on Linux and Mac OSX)
+* a `sugarcrm.yaml` file at the root of you Windows home directory (execute `ENV['USERPROFILE']` in Ruby to see which directory should contain the file)
+* `config/sugarcrm.yaml` (will need to be copied each time you upgrade or reinstall the gem)
+* a YAML file and call `SugarCRM::Environment.load_config` followed by the absolute path to your configuration file
 
 If there are several configuration files, they are loaded sequentially in the order above and will overwrite previous values (if present). This allows you to (e.g.) have a config file in `/etc/sugarcrm.yaml` with system-wide configuration information (such as the url where SugarCRM is located) and/or defaults. Each developer/user can then have his personal configuration file in `~/.sugarcrm.yaml` with his own username and password. A developer could also specify a different location for the SugarCRM instance (e.g. a local testing instance) in his configuration file, which will take precedence over the value in `/etc/sugarcrm.yaml`.
 
@@ -175,9 +170,9 @@ An example, accompanied by instructions, can be found in the `config/sugarcrm.ya
 
 4. You now have full access to the gem's functionality, e.g. `puts SugarCRM::Account.first.name`
   
-== EXPANDING THE GEM
+== EXTENDING THE GEM
 
-If you want to expand the gem's capabilities (e.g. to add methods specific to your environment), you can either
+If you want to extend the gem's capabilities (e.g. to add methods specific to your environment), you can either
 
 * drop your `*.rb` files in `lib/sugarcrm/extensions/` (see the README in that folder)
 

data/Rakefile

@@ -13,11 +13,10 @@ require 'jeweler'
 Jeweler::Tasks.new do |gem|
   # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
   gem.name = "sugarcrm"
-  gem.summary = %Q{Ruby based REST client for SugarCRM}
-  gem.description = %Q{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.}
+  gem.summary = %Q{A less clunky way to interact with SugarCRM via REST.} 
   gem.email = "carl.hicks@gmail.com"
   gem.homepage = "http://github.com/chicks/sugarcrm"
-  gem.authors = ["Carl Hicks"]
+  gem.authors = ["Carl Hicks", "David Sulc"]
 end
 Jeweler::RubygemsDotOrgTasks.new
 
@@ -28,13 +27,6 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-#require 'rcov/rcovtask'
-#Rcov::RcovTask.new do |test|
-#  test.libs << 'test'
-#  test.pattern = 'test/**/test_*.rb'
-#  test.verbose = true
-#end
-
 task :default => :test
 
 require 'rake/rdoctask'

data/VERSION

@@ -1 +1 @@
-0.9.9
+0.9.10

data/lib/sugarcrm.rb

@@ -3,6 +3,7 @@ require 'pp'
 require 'set'
 require 'cgi'
 require 'uri'
+require 'base64'
 require 'rubygems'
 require 'active_support/core_ext'
 require 'json'

data/lib/sugarcrm/associations/association.rb

@@ -1,21 +1,30 @@
 module SugarCRM
-  # Represents an association and it's metadata
+  
+  # Associations are middlemen between the object that holds the association, known as the @owner, 
+  # and the actual associated object, known as the @target.  Methods are added to the @owner that 
+  # allow access to the association collection, and are held in @proxy_methods.  The cardinality 
+  # of the association is available in @cardinality, and the actual relationship details are held
+  # in @relationship.
   class Association    
     attr :owner, true
     attr :target, true
     attr :link_field, true
+    attr :relationship, true
     attr :attributes, true 
-    attr :methods, true 
+    attr :proxy_methods, true
+    attr :cardinality, true
     
-    # TODO: Describe this.
+    # Creates a new instance of an Association
     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]
+      @relationship = relationship_for(@attributes["relationship"])
       @target = resolve_target
-      @methods = define_methods if @options[:define_methods?]
+      @proxy_methods = define_methods if @options[:define_methods?]
+      @cardinality = resolve_cardinality
       self
     end
     
@@ -28,6 +37,27 @@ module SugarCRM
       false
     end
     
+    def ==(comparison_object)
+      comparison_object.instance_of?(self.class) &&
+      @target.class == comparison_object.class &&
+      @link_field == comparison_object.link_field
+    end
+    alias :eql? :==
+        
+    def hash
+      "#{@target.class}##{@link_field}".hash
+    end
+    
+    def inspect
+      self
+    end
+    
+    def to_s
+      "#<SugarCRM::Association @proxy_methods=[#{@proxy_methods.join(", ")}], " +
+      "@link_field=\"#{@link_field}\", @target=#{@target}, @owner=#{@owner.class}, " +
+      "@cardinality=#{@cardinality}>"
+    end
+    
     protected
 
     def check_valid_owner
@@ -36,7 +66,6 @@ module SugarCRM
     end
     
     # Attempts to determine the class of the target in the association
-    # TODO: Write tests for this.
     def resolve_target
       # Use the link_field name first
       klass = @link_field.singularize.camelize
@@ -46,47 +75,80 @@ module SugarCRM
         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"
+      # Use the "relationship" target
       if @attributes["relationship"].length > 0
-        klass = humanized_link_name(@attributes["relationship"]).singularize.camelize
+        klass = @relationship[:target][:name].singularize.camelize
         return "SugarCRM::#{klass}".constantize if SugarCRM.const_defined? klass
       end
       false
     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 = @relationship[:target][:name]
+      methods << define_method(@link_field)
+      methods << define_alias(pretty_name, @link_field) if pretty_name != @link_field
+      methods
+    end
+    
     # Generates the association proxy method for related module
     def define_method(link_field)
+      raise ArgumentException, "argument cannot be nil" if link_field.nil?
+      if (@owner.respond_to? link_field.to_sym) && @owner.debug
+        warn "Warning: Overriding method: #{@owner.class}##{link_field}"
+      end
       @owner.class.module_eval %Q?
         def #{link_field}
           query_association :#{link_field}
         end
       ?
+      link_field
     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(@link_field)
-      if pretty_name != @link_field
-        @owner.class.module_eval %Q?
-          alias :#{pretty_name} #{@link_field}
-        ?
-        methods << @link_field
-      end
-      methods
+    # Defines a method alias.  Checks to see if a method is already defined.
+    def define_alias(alias_name, method_name)
+      @owner.class.module_eval %Q?
+        alias :#{alias_name} :#{method_name}
+      ?
+      alias_name
+    end
+    
+    # This method breaks the relationship into parts and returns them
+    def relationship_for(relationship)
+      # We need to run both regexes, because the plurality of the @owner module name is 
+      # important
+      plural_regex   = /((.*)_)?(#{Regexp.quote(@owner.class._module.name.downcase)})(_(.*))?/
+      singular_regex = /((.*)_)?(#{Regexp.quote(@owner.class._module.name.downcase.singularize)})(_(.*))?/
+      # Break the loop if we match
+      [plural_regex, singular_regex].each {|r| break if relationship.match(r)}
+      # Assign sane values to things if we didnt match
+      o   = $3
+      o   = @owner.class._module.name.downcase if o.nil? || o.empty?
+      t   = [$2, $5].compact.join('_')
+      t   = @link_field if t.nil? || t.empty?
+      # Look up the cardinality
+      o_c, t_c = cardinality_for(o,t)
+      {:owner   => {:name => o, :cardinality => o_c},
+       :target  => {:name => t, :cardinality => t_c}}
+    end
+    
+    # Determines if the provided string is plural or singular
+    # Plurality == Cardinality
+    def cardinality_for(*args)
+      args.inject([]) {|results,arg|
+        result = :many 
+        result = :one if arg.singularize == arg
+        results << result        
+      }
     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)
-      # the module name is used to function properly with modules containing '_' (e.g. a custom module abc_sale : custom modules need a prefix (abc here) so they will always have a '_' in their table name)
-      return link_field unless link_field.to_s =~ /((.*)_)?#{Regexp.quote(@owner.class._module.name.downcase)}(_(.*))?/
-      [$2, $4].compact.join('_')
+    # TODO: Add Tests for This
+    def resolve_cardinality
+      "#{@relationship[:owner][:cardinality]}_to_#{@relationship[:target][:cardinality]}".to_sym
     end
     
   end

data/lib/sugarcrm/associations/association_methods.rb

@@ -38,7 +38,7 @@ module SugarCRM; module AssociationMethods
         "Couldn't associate #{self.class._module.name}: #{self.id} -> #{t}: #{t.id}!" 
       end
       # We need to update the association cache for any changes we make.
-      if opts[:delete]
+      if opts[:delete] == 1
         update_association_cache_for(association.link_field, t, :delete)
         t.update_association_cache_for(association.link_field, self, :delete)
       else
@@ -51,7 +51,6 @@ module SugarCRM; module AssociationMethods
   alias :relate! :associate!
     
   # Removes a relationship between the current object and the target object
-  # TODO: Write a test for this.
   def disassociate!(target)
     associate!(target,{:delete => 1})
   end

data/lib/sugarcrm/associations/associations.rb

@@ -19,6 +19,13 @@ module SugarCRM
       self
     end
     
+    # Returns the proxy methods of all the associations in the collection
+    def proxy_methods
+      @associations.inject([]) { |pm,a|
+        pm = pm | a.proxy_methods
+      } 
+    end
+    
     # Looks up an association by object, link_field, or method.
     # Raises an exception if not found
     def find!(target)
@@ -32,26 +39,13 @@ module SugarCRM
     # Returns false if not found
     def find(association)
       begin
-        find!
+        find!(association)
       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
-      
+    alias :include? :find
+          
     # 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)

data/lib/sugarcrm/attributes/attribute_typecast.rb

@@ -18,6 +18,13 @@ module SugarCRM; module AttributeTypeCast
       # skip primary key columns
       next if name == "id"
       attr_type = attr_type_for(name)
+      
+      # empty attributes should stay empty (e.g. an empty int field shouldn't be typecast as 0)
+      if [:datetime, :datetimecombo, :int].include? attr_type && (value.nil? || value == '')
+        @attributes[name] = nil
+        next
+      end
+      
       case attr_type
       when :bool
         @attributes[name] = (value == "1")

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

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"
+        "session": "#{@session}"
       }
     EOF
     

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

@@ -4,8 +4,8 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"id\": #{id}
+        "session": "#{@session}",
+        "id": #{id}
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -10,11 +10,11 @@ module SugarCRM; class Connection
 
     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}
+        "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}/,'')

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

@@ -8,10 +8,10 @@ module SugarCRM; class Connection
 
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"module_name\": \"#{module_name}\"\,
-        \"query\": \"#{query}\"\,
-        \"deleted\": #{options[:deleted]}
+        "session": "#{@session}",
+        "module_name": "#{module_name}",
+        "query": "#{query}",
+        "deleted": #{options[:deleted]}
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -9,11 +9,11 @@ module SugarCRM; class Connection
     
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"module_name\": \"#{module_name}\"\,
-        \"id\": \"#{id}\"\,
-        \"select_fields\": #{resolve_fields(module_name, options[:fields])}\,
-        \"link_name_to_fields_array\": #{options[:link_fields]}
+        "session": "#{@session}",
+        "module_name": "#{module_name}",
+        "id": "#{id}",
+        "select_fields": #{resolve_fields(module_name, options[:fields])},
+        "link_name_to_fields_array": #{options[:link_fields]}
       }
     EOF
         

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

@@ -14,15 +14,15 @@ module SugarCRM; class Connection
 
     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]}
+        "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}/,'')

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

@@ -4,8 +4,8 @@ module SugarCRM; class Connection
     login! unless logged_in?  
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"module_name": \"#{module_name}"
+        "session": "#{@session}",
+        "module_name": "#{module_name}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -4,11 +4,11 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"id\": #{id}\
+        "session": "#{@session}",
+        "id": "#{id}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    send!(:get_note_attachment, json)
+    send!(:get_note_attachment, json)["note_attachment"]
   end
 end; end

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

@@ -13,14 +13,14 @@ module SugarCRM; class Connection
 
     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]}
+        "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}/,'')

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

@@ -6,9 +6,9 @@ module SugarCRM; class Connection
 
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"ids\": #{ids.to_json}\,
-        \"select_fields\": \"#{options[:select_fields].to_json}\"
+        "session": "#{@session}",
+        "ids": #{ids.to_json},
+        "select_fields": "#{options[:select_fields].to_json}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"
+        "session": "#{@session}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -5,7 +5,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"
+        "session": "#{@session}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -4,8 +4,8 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"user_auth\": {
-          \"session\": \"#{@session}\"
+        "user_auth": {
+          "session": "#{@session}"
         }
       }
     EOF

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

@@ -4,7 +4,7 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"
+        "session": "#{@session}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -12,11 +12,11 @@ module SugarCRM; class Connection
     
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"search_string\": \"#{search_string}\"\,
-        \"modules\": \"#{modules}\"\,
-        \"offset\": #{options[:offset]}\,
-        \"max_results\": #{options[:limit]}
+        "session": "#{@session}",
+        "search_string": "#{search_string}",
+        "modules": "#{modules}",
+        "offset": #{options[:offset]},
+        "max_results": #{options[:limit]}
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -4,9 +4,9 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"targets\": #{targets.to_json}\,
-        \"campaign-id\": \"#{campaign_id}\"
+        "session": "#{@session}",
+        "targets": #{targets.to_json},
+        "campaign-id": "#{campaign_id}"
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -4,9 +4,9 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"document_revision\": \"#{revision}\"\,
-        \"id\": #{id}
+        "session": "#{@session}",
+        "document_revision": "#{revision}",
+        "id": #{id}
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -4,9 +4,9 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"module_name\": \"#{module_name}\"\,
-        \"name_value_list\": #{name_value_lists.to_json}
+        "session": "#{@session}",
+        "module_name": "#{module_name}",
+        "name_value_list": #{name_value_lists.to_json}
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -4,9 +4,9 @@ module SugarCRM; class Connection
     login! unless logged_in?
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"module_name\": \"#{module_name}\"\,
-        \"name_value_list\": #{name_value_list.to_json}
+        "session": "#{@session}",
+        "module_name": "#{module_name}",
+        "name_value_list": #{name_value_list.to_json}
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -1,3 +1,25 @@
 module SugarCRM; class Connection
-  # to be implemented
-end; end
+  # Creates or updates an attachment on a note
+  def set_note_attachment(id, filename, file, opts={})
+    options = { 
+      :module_id => '', 
+      :module_name => '' 
+    }.merge! opts
+    
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        "session": "#{@session}",
+           "note": {
+              "id": "#{id}",
+              "filename": "#{filename}",
+              "file": "#{Base64.encode64(file)}",
+              "related_module_id": "#{options[:module_id]}",
+              "related_module_name": "#{options[:module_name]}" 
+           }
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    send!(:set_note_attachment, json)
+  end
+end; end

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

@@ -9,13 +9,13 @@ module SugarCRM; class Connection
     raise ArgumentError, "related_ids must be an Array" unless related_ids.class == Array
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"module_name\": \"#{module_name}\"\,
-        \"module_id\": \"#{module_id}\"\,
-        \"link_field_name\": \"#{link_field_name}\"\,
-        \"related_ids\": #{related_ids.to_json}\,
-        \"name_value_list\": #{options[:name_value_list].to_json}\,
-        \"delete\": #{options[:delete]}  
+        "session": "#{@session}",
+        "module_name": "#{module_name}",
+        "module_id": "#{module_id}",
+        "link_field_name": "#{link_field_name}",
+        "related_ids": #{related_ids.to_json},
+        "name_value_list": #{options[:name_value_list].to_json},
+        "delete": #{options[:delete]}  
       }
     EOF
     json.gsub!(/^\s{6}/,'')

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

@@ -9,11 +9,11 @@ module SugarCRM; class Connection
     
     json = <<-EOF
       {
-        \"session\": \"#{@session}\"\,
-        \"module_names\": \"#{module_names.to_json}\"\,
-        \"module_ids\": #{module_ids.to_json}\,
-        \"link_field_names\": #{link_field_names.to_json}\,
-        \"related_ids\": #{related_ids.to_json}   
+        "session": "#{@session}",
+        "module_names": "#{module_names.to_json}",
+        "module_ids": #{module_ids.to_json},
+        "link_field_names": #{link_field_names.to_json},
+        "related_ids": #{related_ids.to_json}   
       }
     EOF
     json.gsub!(/^\s{6}/,'')

data/lib/sugarcrm/connection/connection.rb

@@ -29,7 +29,9 @@ module SugarCRM; class Connection
     resolve_url
     login!
     # make sure the environment singleton gets loaded
-    SugarCRM::Environment.instance if @options[:load_environment]
+    if @options[:load_environment] # prevent loops when Environment tries to log in automatically
+      SugarCRM::Environment.update_config({:base_url => url, :username => user, :password => pass}) 
+    end
     self
   end
   

data/lib/sugarcrm/environment.rb

@@ -9,7 +9,7 @@ module SugarCRM; class Environment
     @config = {}
     
     # see README for reasoning behind the priorization
-    ['/etc/sugarcrm.yaml', File.expand_path('~/.sugarcrm.yaml'), File.join(File.dirname(__FILE__), 'config', 'sugarcrm.yaml')].each{|path|
+    config_file_paths.each{|path|
       load_config path if File.exists? path
     }
     extensions_folder = File.join(File.dirname(__FILE__), 'extensions')
@@ -28,6 +28,14 @@ module SugarCRM; class Environment
         @config[k.to_sym] = v
       }
     end
+    @config
+  end
+  
+  def update_config(params)
+    params.each{|k,v|
+      @config[k.to_sym] = v
+    }
+    @config
   end
   
   # load all the monkey patch extension files in the provided folder
@@ -42,6 +50,13 @@ module SugarCRM; class Environment
   end
   
   private
+  def config_file_paths
+    # see README for reasoning behind the priorization
+    paths = ['/etc/sugarcrm.yaml', File.expand_path('~/.sugarcrm.yaml'), File.join(File.dirname(__FILE__), 'config', 'sugarcrm.yaml')]
+    paths.insert(1, File.join(ENV['USERPROFILE'], 'sugarcrm.yaml')) if ENV['USERPROFILE']
+    paths
+  end
+  
   def validate_path(path)
     raise "Invalid path: #{path}" unless File.exists? path
   end

data/test/connection/test_get_entry_list.rb

@@ -18,7 +18,7 @@ class TestGetEntryList < Test::Unit::TestCase
         "Users",
         "users.deleted = 0"
       )
-      assert_equal "Administrator", users.first.last_name
+      assert_equal "admin", users.first.user_name
     end
     should "return an object when #get_entry_list" do
       assert_instance_of Array, @response

data/test/connection/test_set_note_attachment.rb

@@ -0,0 +1,17 @@
+require 'helper'
+
+class TestSetNoteAttachment < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    should "Add an attachment to a Note" do
+      SugarCRM.connect(URL, USER, PASS, {:debug => false})
+      n = SugarCRM::Note.new
+      n.name = "A Test Note"
+      assert n.save
+      file = File.read("test/config_test.yaml")
+      assert SugarCRM.connection.set_note_attachment(n.id, "config_test.yaml", file)
+      attachment = SugarCRM.connection.get_note_attachment(n.id)
+      assert Base64.decode64(attachment["file"]) == file
+      assert n.delete
+    end
+  end
+end

data/test/helper.rb

@@ -13,6 +13,6 @@ class Test::Unit::TestCase
   PASS  = 'letmein' 
 
   def setup_connection
-    SugarCRM::Base.establish_connection(URL, USER, PASS, {:debug => false})
+    SugarCRM.connect(URL, USER, PASS, {:debug => false})
   end
 end

data/test/test_associations.rb

@@ -1,6 +1,13 @@
 require 'helper'
 
 class TestAssociations < Test::Unit::TestCase
+  context "A SugarCRM::Associations class" do
+    should "Return an array of Association objects when self#register(SugarCRM::User.new)" do
+      associations = SugarCRM::Associations.register(SugarCRM::User.new)
+      assert associations.include? "email_addresses"
+      assert associations.proxy_methods.include? "email_addresses"
+    end
+  end
   context "A SugarCRM::Base instance" do
     should "return an email address when sent #email_addresses" do
       u = SugarCRM::User.find("seed_sarah_id")
@@ -37,5 +44,96 @@ class TestAssociations < Test::Unit::TestCase
       a = SugarCRM::Account.first
       assert_instance_of SugarCRM::User, a.created_by_link.first
     end
+    
+    should "create relationships with associate!" do
+      a = SugarCRM::Account.first
+      c = SugarCRM::Contact.create(:last_name => 'Doe')
+      
+      nb_contacts = a.contacts.size
+      a.associate!(c)
+      assert_equal nb_contacts + 1, a.contacts.size # test association_cache is updated
+      
+      assert_equal nb_contacts + 1, SugarCRM::Account.first.contacts.size # test relationship is created in Sugar
+      
+      assert c.delete
+    end
+    
+    should "destroy relationships with disassociate!" do
+      a = SugarCRM::Account.first
+      c = SugarCRM::Contact.create(:last_name => 'Doe')
+      
+      a.associate!(c)
+      nb_contacts = a.contacts.size
+      a.disassociate!(c)
+      assert_equal nb_contacts - 1, a.contacts.size # test association_cache is updated
+      
+      assert_equal nb_contacts - 1, SugarCRM::Account.first.contacts.size # test relationship is destroyed in Sugar
+      
+      assert c.delete
+    end
+    
+    should "not destroy a relationship if associate! is called with {:delete => 0}" do
+      a = SugarCRM::Account.first
+      c = SugarCRM::Contact.create(:last_name => 'Doe')
+      
+      a.associate!(c)
+      nb_contacts = a.contacts.size
+      a.associate!(c, {:delete => 0})
+      assert_equal nb_contacts, a.contacts.size
+      
+      assert c.delete
+    end
+    
+    should "update association cache on associate! only if association changes" do
+      a = SugarCRM::Account.first
+      c = SugarCRM::Contact.create(:last_name => 'Doe')
+      
+      nb_contacts = a.contacts.size
+      a.associate!(c)
+      assert_equal nb_contacts + 1, a.contacts.size
+      a.associate!(c)
+      assert_equal nb_contacts + 1, a.contacts.size # should not change: already associated
+      
+      assert c.delete
+    end
+    
+    should "update association cache on << only if association changes" do
+      a = SugarCRM::Account.first
+      c = SugarCRM::Contact.create(:last_name => 'Doe')
+      
+      nb_contacts = a.contacts.size
+      a.contacts  << c
+      assert_equal nb_contacts + 1, a.contacts.size
+      a.contacts  << c
+      assert_equal nb_contacts + 1, a.contacts.size # should not change: already associated
+      
+      assert c.delete
+    end
+    
+    should "update association cache for both sides of the relationship when calling associate!" do
+      a = SugarCRM::Account.first
+      c = SugarCRM::Contact.create(:last_name => 'Doe')
+      
+      nb_contacts = a.contacts.size
+      nb_accounts = c.accounts.size
+      a.associate!(c)
+      assert_equal nb_contacts + 1, a.contacts.size
+      assert_equal nb_accounts + 1, c.accounts.size
+      
+      assert c.delete
+    end
+    
+    should "update association cache for both sides of the relationship when calling <<" do
+      a = SugarCRM::Account.first
+      c = SugarCRM::Contact.create(:last_name => 'Doe')
+      
+      nb_contacts = a.contacts.size
+      nb_accounts = c.accounts.size
+      a.contacts  << c
+      assert_equal nb_contacts + 1, a.contacts.size
+      assert_equal nb_accounts + 1, c.accounts.size
+      
+      assert c.delete
+    end
   end
 end

data/test/test_environment.rb

@@ -33,6 +33,13 @@ class TestEnvironment < Test::Unit::TestCase
       SugarCRM::Environment.load_config File.join(File.dirname(__FILE__), 'config_test.yaml')
       assert SugarCRM.connection.logged_in?
     end
+    
+    should "update the login credentials on connection" do
+      SugarCRM.connect!(URL, USER, PASS)
+      {:base_url => URL, :username => USER, :password => PASS}.each{|k,v|
+        assert_equal v, SugarCRM::Environment.config[k]
+      }
+    end
   end
   
 end

data/test/test_sugarcrm.rb

@@ -182,58 +182,6 @@ class TestSugarCRM < Test::Unit::TestCase
       assert a.delete
     end
     
-    should "update association cache on associate! only if association changes" do
-      a = SugarCRM::Account.first
-      c = SugarCRM::Contact.create(:last_name => 'Doe')
-      
-      nb_contacts = a.contacts.size
-      a.associate!(c)
-      assert_equal nb_contacts + 1, a.contacts.size
-      a.associate!(c)
-      assert_equal nb_contacts + 1, a.contacts.size # should not change: already associated
-      
-      c.delete
-    end
-    
-    should "update association cache on << only if association changes" do
-      a = SugarCRM::Account.first
-      c = SugarCRM::Contact.create(:last_name => 'Doe')
-      
-      nb_contacts = a.contacts.size
-      a.contacts  << c
-      assert_equal nb_contacts + 1, a.contacts.size
-      a.contacts  << c
-      assert_equal nb_contacts + 1, a.contacts.size # should not change: already associated
-      
-      c.delete
-    end
-    
-    should "update association cache for both sides of the relationship when calling associate!" do
-      a = SugarCRM::Account.first
-      c = SugarCRM::Contact.create(:last_name => 'Doe')
-      
-      nb_contacts = a.contacts.size
-      nb_accounts = c.accounts.size
-      a.associate!(c)
-      assert_equal nb_contacts + 1, a.contacts.size
-      assert_equal nb_accounts + 1, c.accounts.size
-      
-      c.delete
-    end
-    
-    should "update association cache for both sides of the relationship when calling <<" do
-      a = SugarCRM::Account.first
-      c = SugarCRM::Contact.create(:last_name => 'Doe')
-      
-      nb_contacts = a.contacts.size
-      nb_accounts = c.accounts.size
-      a.contacts  << c
-      assert_equal nb_contacts + 1, a.contacts.size
-      assert_equal nb_accounts + 1, c.accounts.size
-      
-      c.delete
-    end
-    
     should "support saving of records with special characters in them" do
       a = SugarCRM::Account.new
       a.name = "COHEN, WEISS & SIMON LLP"

metadata

@@ -1,114 +1,108 @@
 --- !ruby/object:Gem::Specification 
 name: sugarcrm
 version: !ruby/object:Gem::Version 
-  hash: 41
   prerelease: false
   segments: 
   - 0
   - 9
-  - 9
-  version: 0.9.9
+  - 10
+  version: 0.9.10
 platform: ruby
 authors: 
 - Carl Hicks
+- David Sulc
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 -08:00
+date: 2011-02-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  type: :runtime
-  prerelease: false
   name: activesupport
-  version_requirements: &id001 !ruby/object:Gem::Requirement 
+  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
-- !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: i18n
-  version_requirements: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id002
-- !ruby/object:Gem::Dependency 
   type: :runtime
   prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: json
-  version_requirements: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id003
-- !ruby/object:Gem::Dependency 
-  type: :development
+  type: :runtime
   prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: shoulda
-  version_requirements: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  requirement: *id004
-- !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: bundler
-  version_requirements: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
-  requirement: *id005
-- !ruby/object:Gem::Dependency 
   type: :development
   prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: jeweler
-  version_requirements: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 1
         - 5
         - 2
         version: 1.5.2
-  requirement: *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.
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+description: 
 email: carl.hicks@gmail.com
 executables: []
 
@@ -185,10 +179,10 @@ files:
 - test/connection/test_get_user_team_id.rb
 - test/connection/test_login.rb
 - test/connection/test_logout.rb
+- test/connection/test_set_note_attachment.rb
 - test/connection/test_set_relationship.rb
 - test/extensions_test/patch.rb
 - test/helper.rb
-- test/test_association.rb
 - test/test_association_collection.rb
 - test/test_associations.rb
 - test/test_connection.rb
@@ -210,7 +204,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: 957398452548061165
       segments: 
       - 0
       version: "0"
@@ -219,7 +213,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -229,7 +222,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Ruby based REST client for SugarCRM
+summary: A less clunky way to interact with SugarCRM via REST.
 test_files: 
 - test/connection/test_get_available_modules.rb
 - test/connection/test_get_entries.rb
@@ -242,10 +235,10 @@ test_files:
 - test/connection/test_get_user_team_id.rb
 - test/connection/test_login.rb
 - test/connection/test_logout.rb
+- test/connection/test_set_note_attachment.rb
 - test/connection/test_set_relationship.rb
 - test/extensions_test/patch.rb
 - test/helper.rb
-- test/test_association.rb
 - test/test_association_collection.rb
 - test/test_associations.rb
 - test/test_connection.rb

data/test/test_association.rb

@@ -1,18 +0,0 @@
-#TODO: Figure out how to test this.
-
-
-# That code works, but what didn't work:
-# document.tasks.size
-# document.associate!(task)
-# document.tasks.size
-# This seems to be fixed in HEAD in my repo. I haven't pushed the changes to your repo, because I don't really see why commit https://github.com/davidsulc/sugarcrm/commit/228375348c9113324370afa0aca4120eb117d3e1 fixes the issue...
-# Also, I fixed this case
-# document.tasks.size
-# document.associate!(task)
-# document.tasks.size # => 1 (correct)
-# document.associate!(task)
-# document.tasks.size # => 2 (incorrect: should remain 1)
-# One thing we should look into is
-# document.associate!(task)
-# document.tasks.size # => 1
-# task.documents.size # => 0 (should be 1)