sugarcrm 0.9.13 → 0.9.14

data/README.rdoc

@@ -128,6 +128,16 @@ A less clunky way to interact with SugarCRM via REST.
                                           # because records are passed to the block as they get fetched from SugarCRM (whereas `each`
                                           # will fetch all records, and only then pass them to the block). This will make a major difference
                                           # in resource use and execution time if you're dealing with many records.
+
+  # Create a document instance and upload a file
+  file = File.read(File.join(File.dirname(__FILE__),"test_excel.xls"))
+  doc = SugarCRM::Document.new
+  doc.active_date = Date.today
+  doc.document_name = "test_excel.xls"
+  doc.filename = "test_excel.xls"
+  doc.revision = 0
+  doc.uploadfile = SugarCRM.connection.b64_encode(file)
+  doc.save!
   
   # Look up the fields for a given module
   SugarCRM::Module.find("Accounts").fields
@@ -190,7 +200,7 @@ An example, accompanied by instructions, can be found in the `config/sugarcrm.ya
 
 1.  Type `irb` in your command prompt
 
-2.  Require the gem with `require 'sugarcrm'`
+2.  Require the gem with `require 'sugarcrm'` (Note: Windows users might need to `require 'rubygems'` before `require 'sugarcrm'`.)
 
 3.  * if your login credentials are stored in the `config/sugarcrm.yaml` file, you have been automagically logged in already ;
     * if your login credentials are stored in a different config file, just call `SugarCRM.load_config` followed by the absolute path to your config file. This will log you in automatically ;
@@ -243,6 +253,8 @@ To disconnect an active session:
 
 * sudo gem install sugarcrm
 
+Note: Windows users might need to `require 'rubygems'` before `require 'sugarcrm'`.
+
 == TEST:
 
 Put your credentials in a file called `test/config.yaml` (which you will have to create). These must point to a SugarCRM test instance with demo data. See an example file in `test/config_test.yaml` (leave that file as is).

data/VERSION

@@ -1 +1 @@
-0.9.13
+0.9.14

data/WATCHLIST.rdoc

@@ -0,0 +1,7 @@
+Each time a new version of SugarCRM comes out, the following should be checked to see whether it is still an issue. Conditional code based on SugarCRM version can be added if SugarCRM patches buggy functionality.
+
+The get_entries_count function does not work properly (always returns 0) if a condition on a custom (i.e. made with studio and ending in _c) is passed
+When functionality is fixed in SugarCRM: add conditional code so InvalidAttribute exception is raised on ly when dealing with broken versions
+
+get_entry_list function has a bug where, when :limit and :offset options are passed simultaneously, :limit is considered to be the smallest of the two, and :offset is the larger
+When functionality is fixed in SugarCRM: update comment in find_by_sql to reflect the fix (code can stay as is)

data/lib/sugarcrm/attributes/attribute_methods.rb

@@ -33,15 +33,25 @@ module SugarCRM; module AttributeMethods
         operator ||= '=' 
         # Extract value from query
         value = $3
-        if [TrueClass, FalseClass].include? attribute_condition.class
-          # fix value for checkboxes: users can pass true/false as condition, should be converted to '1' or '0' respectively
-          value = (attribute_condition.class == TrueClass ? '1' : '0')
+        unless attribute_condition.class == FalseClass
+          if attribute_condition.class == TrueClass
+            # fix value for checkboxes: users can pass true as condition, should be converted to '1' (false case for checkboxes is treated separately below)
+            value = (attribute_condition.class == TrueClass ? '1' : '0')
+          end
+          
+          # TODO: Write a test for sending invalid attribute names.  
+          # strip single quotes
+          value = value.strip[/'?([^']*)'?/,1] 
+          conditions << "#{table_name_for(attribute)}.#{attribute} #{operator} \'#{value}\'"
+        else
+          # When a user creates a custom checkbox field, a column is added to the *_cstm table for that module (e.g. contacts_cstm for Contacts module).
+          # Each time a new record is created, the value of the checkbox will be stored in that _cstm table.
+          # However, records that exsited before that field was created are absent from the _cstm table.
+          # To return the expected results when a user is searching for records with an unchecked checkbox, we must return all records that aren't present in
+          # the _cstm table with a value of 1 (returning the record with 0 in the table will ignore the pre-existing records).
+          # Here, we create the appropriate query that will return all records that don't have a value of "true" in the checkbox field.
+          conditions << "#{self._module.table_name}.id NOT IN (SELECT id_c FROM #{table_name_for(attribute)} WHERE #{table_name_for(attribute)}.#{attribute} #{operator} 1)"
         end
-        
-        # TODO: Write a test for sending invalid attribute names.  
-        # strip single quotes
-        value = value.strip[/'?([^']*)'?/,1] 
-        conditions << "#{table_name_for(attribute)}.#{attribute} #{operator} \'#{value}\'"
       end
       conditions
     end

data/lib/sugarcrm/base.rb

@@ -27,7 +27,19 @@ module SugarCRM; class Base
   class << self # Class methods
     def find(*args, &block)
       options = args.extract_options!
-      options = {:order_by => 'date_entered'}.merge(options)
+      # add default sorting date (necessary for first and last methods to work)
+      # most modules (Contacts, Accounts, etc.) use 'date_entered' to store when the record was created
+      # other modules (e.g. EmailAddresses) use 'date_created'
+      # Here, we account for this discrepancy...
+      self.new # make sure the fields are loaded from SugarCRM so method_defined? will work properly
+      if self.method_defined? :date_entered
+        sort_criteria = 'date_entered'
+      elsif self.method_defined? :date_created
+        sort_criteria = 'date_created'
+      else
+        raise InvalidAttribute, "Unable to determine record creation date for sorting criteria: expected date_entered or date_created attribute to be present"
+      end
+      options = {:order_by => sort_criteria}.merge(options)
       validate_find_options(options)
 
       case args.first
@@ -52,7 +64,11 @@ module SugarCRM; class Base
       self.session.connection
     end
     
+    # return the number of records satifsying the options
+    # note: the REST API has a bug (documented with Sugar as bug 43339) where passing custom attributes in the options will result in the 
+    # options being ignored and '0' being returned, regardless of the existence of records satisfying the options
     def count(options={})
+      raise InvalidAttribute, 'Conditions on custom attributes are not supported due to REST API bug' if contains_custom_attribute(options[:conditions])
       query = query_from_options(options)
       connection.get_entries_count(self._module.name, query, options)['result_count'].to_i
     end
@@ -111,6 +127,7 @@ module SugarCRM; class Base
 
   # Creates an instance of a Module Class, i.e. Account, User, Contact, etc.
   def initialize(attributes={}, &block)
+    attributes.delete('id')
     @errors = {}
     @modified_attributes = {}
     merge_attributes(attributes.with_indifferent_access)
@@ -257,6 +274,15 @@ module SugarCRM; class Base
   alias :=== :is_a?
   
   private
+  # returns true if the hash contains a custom attribute created in Studio (and whose name therefore ends in '_c')
+  def self.contains_custom_attribute(attributes)
+    attributes ||= {}
+    attributes.each_key{|k|
+      return true if k.to_s =~ /_c$/
+    }
+    false
+  end
+  
   def superclasses
     return @superclasses if @superclasses
     @superclasses = [self.class]

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

@@ -13,7 +13,7 @@ module SugarCRM; class Connection
         "module_name": "#{module_name}",
         "id": "#{id}",
         "select_fields": #{resolve_fields(module_name, options[:fields])},
-        "link_name_to_fields_array": #{options[:link_fields]}
+        "link_name_to_fields_array": #{options[:link_fields].to_json}
       }
     EOF
         

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

@@ -3,7 +3,8 @@ module SugarCRM; class Connection
   def set_document_revision(document_id, revision_number, opts={})
     options = { 
       :file => '', 
-      :file_name => '' 
+      :file_name => '',
+      :document_name => nil
     }.merge! opts
     
     # Raise an exception of we try to pass :file, but not :file_name
@@ -11,15 +12,20 @@ module SugarCRM; class Connection
       raise ArgumentException, ":file_name must be specified if :file is specified"
     end
     
+    # If no document_name is given, use the file_name
+    options[:document_name] ||= options[:file_name]
+    
     login! unless logged_in?
+    
     json = <<-EOF
       {
         "session": "#{@sugar_session_id}",
         "document_revision": {
            "id": "#{document_id}",
+           "document_name": "#{options[:document_name]}",
+           "revision": "#{revision_number}",
            "filename": "#{options[:file_name]}",
-           "file": "#{Base64.encode64(options[:file])}",
-           "revision": "#{revision_number}"
+           "file": "#{b64_encode(options[:file])}"
         }
       }
     EOF

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

@@ -13,7 +13,7 @@ module SugarCRM; class Connection
            "note": {
               "id": "#{id}",
               "filename": "#{filename}",
-              "file": "#{Base64.encode64(file)}",
+              "file": "#{b64_encode(file)}",
               "related_module_id": "#{options[:module_id]}",
               "related_module_name": "#{options[:module_name]}" 
            }

data/lib/sugarcrm/connection/connection.rb

@@ -68,6 +68,7 @@ module SugarCRM; class Connection
   
   # Send a request to the Sugar Instance
   def send!(method, json)
+    nb_failed_attempts = 0 # how many times we have failed to send
     @request  = SugarCRM::Request.new(@url, method, json, @options[:debug])
     begin
       if @request.length > 3900
@@ -75,10 +76,20 @@ module SugarCRM; class Connection
       else
         @response = @connection.get(@url.path.dup + "?" + @request.to_s)
       end
-    rescue Errno::ECONNRESET
-      retry!(method, json)
-    rescue EOFError
-      retry!(method, json)
+    rescue Timeout::Error, Errno::ECONNABORTED
+      nb_failed_attempts += 1
+      unless nb_failed_attempts >= 3
+        retry
+      else
+        raise
+      end
+    rescue Errno::ECONNRESET, EOFError
+      nb_failed_attempts += 1
+      unless nb_failed_attempts >= 3
+        retry!(method, json)
+      else
+        raise
+      end
     end
     handle_response
   end

data/lib/sugarcrm/connection/helper.rb

@@ -38,4 +38,13 @@ module SugarCRM; class Connection
     end
   end
   
+  # We need to strip newlines from Base64 encoding for JSON validation purposes.
+  def b64_encode(file)
+    Base64.encode64(file).gsub(/\n/, '')
+  end
+  
+  def b64_decode(file)
+    Base64.decode64(file)
+  end
+  
 end; end

data/lib/sugarcrm/finders/finder_methods.rb

@@ -72,7 +72,7 @@ module SugarCRM; module FinderMethods
       SLICE_SIZE.freeze
       # results accumulator stores the results we have fetched so far, recursively
       def find_by_sql(options, results_accumulator=nil, &block)
-        # SugarCRM REST API has a bug where, when :limit and :offset options are passed simultaneously,
+        # SugarCRM REST API has a bug (documented with Sugar as bug 43338) where, when :limit and :offset options are passed simultaneously,
         # :limit is considered to be the smallest of the two, and :offset is the larger
         # In addition to allowing querying of large datasets while avoiding timeouts (by fetching results in small slices),
         # this implementation fixes the :limit - :offset bug so that it behaves correctly

data/sugarcrm.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{sugarcrm}
-  s.version = "0.9.13"
+  s.version = "0.9.14"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Carl Hicks", "David Sulc"]
-  s.date = %q{2011-04-06}
+  s.date = %q{2011-05-03}
   s.default_executable = %q{sugarcrm}
   s.email = %q{carl.hicks@gmail.com}
   s.executables = ["sugarcrm"]
@@ -23,6 +23,7 @@ Gem::Specification.new do |s|
     "./README.rdoc",
     "./Rakefile",
     "./VERSION",
+    "./WATCHLIST.rdoc",
     "./lib/rails/generators/sugarcrm/config/config_generator.rb",
     "./lib/rails/generators/sugarcrm/config/templates/initializer.rb",
     "./lib/rails/generators/sugarcrm/config/templates/sugarcrm.yml",

data/test/connection/test_set_note_attachment.rb

@@ -9,7 +9,7 @@ class TestSetNoteAttachment < ActiveSupport::TestCase
       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_equal file, Base64.decode64(attachment["file"])
       assert n.delete
     end
   end

data/test/test_finders.rb

@@ -13,6 +13,24 @@ class TestFinders < ActiveSupport::TestCase
       assert users.length == 0
     end
     
+    should "support finding first instance with default sort order (for module using date_entered as creation date)" do
+      expected_account = SugarCRM::Account.first({:order_by => 'date_entered'})
+      account = nil
+      assert_nothing_raised do
+        account = SugarCRM::Account.first
+      end
+      assert_equal expected_account.id, account.id
+    end
+    
+    should "support finding first instance with default sort order (for module using date_created as creation date)" do
+      expected_email = SugarCRM::EmailAddress.first({:order_by => 'date_created'})
+      email = nil
+      assert_nothing_raised do
+        email = SugarCRM::EmailAddress.first
+      end
+      assert_equal expected_email.id, email.id
+    end
+    
     should "support finding first instance (sorted by attribute)" do
       account = SugarCRM::Account.first({
         :order_by => 'name'

data/test/test_session.rb

@@ -19,14 +19,17 @@ class TestSession < ActiveSupport::TestCase
     end
     
     should "assign namespaces in a way that prevents collisions" do
-      # Namespae0 already assigned (linked to the current connection)
-      One = SugarCRM::Session.from_file(CONFIG_PATH)
-      Two = SugarCRM::Session.from_file(CONFIG_PATH)
-      One.disconnect!
-      Three = SugarCRM::Session.from_file(CONFIG_PATH)
-      assert_not_equal Two, Three # namespaces must be different
-      Two.disconnect!
-      Three.disconnect!
+      begin
+        # Namespae0 already assigned (linked to the current connection)
+        One = SugarCRM::Session.from_file(CONFIG_PATH)
+        Two = SugarCRM::Session.from_file(CONFIG_PATH)
+        One.disconnect!
+        Three = SugarCRM::Session.from_file(CONFIG_PATH)
+        assert_not_equal Two, Three # namespaces must be different
+      ensure
+        Two.disconnect!
+        Three.disconnect!
+      end
     end
     
     should "parse config parameters from a file" do
@@ -91,23 +94,27 @@ class TestSession < ActiveSupport::TestCase
     should "show the only the namespaces currently in use with SugarCRM.namespaces" do
       assert_equal 1, SugarCRM.namespaces.size
       
-      assert_difference('SugarCRM.namespaces.size') do
-        OneA = SugarCRM::Session.from_file(CONFIG_PATH)
-      end
-      
-      assert_difference('SugarCRM.namespaces.size', -1) do
-        OneA.disconnect!
+      begin
+        assert_difference('SugarCRM.namespaces.size') do
+          OneA = SugarCRM::Session.from_file(CONFIG_PATH)
+        end
+      ensure
+        assert_difference('SugarCRM.namespaces.size', -1) do
+          OneA.disconnect!
+        end
       end
     end
     
     should "add a used namespace on each new connection" do
-      assert_difference('SugarCRM.used_namespaces.size') do
-        OneB = SugarCRM::Session.from_file(CONFIG_PATH)
-      end
-      
-      # connection (and namespace) is reused => no used namespace should be added
-      assert_no_difference('SugarCRM.used_namespaces.size') do
-        OneB.reconnect!
+      begin
+        assert_difference('SugarCRM.used_namespaces.size') do
+          OneB = SugarCRM::Session.from_file(CONFIG_PATH)
+        end
+      ensure
+        # connection (and namespace) is reused => no used namespace should be added
+        assert_no_difference('SugarCRM.used_namespaces.size') do
+          OneB.reconnect!
+        end
       end
       
       assert_no_difference('SugarCRM.used_namespaces.size') do
@@ -116,11 +123,13 @@ class TestSession < ActiveSupport::TestCase
     end
     
     should "not allow access to methods on SugarCRM if there are multiple active connections" do
-      OneC = SugarCRM::Session.from_file(CONFIG_PATH)
-      
-      assert_raise(SugarCRM::MultipleSessions){ SugarCRM.current_user }
-      
-      OneC.disconnect!
+      begin
+        OneC = SugarCRM::Session.from_file(CONFIG_PATH)
+        
+        assert_raise(SugarCRM::MultipleSessions){ SugarCRM.current_user }
+      ensure
+        OneC.disconnect!
+      end
     end
   end
 end

data/test/test_sugarcrm.rb

@@ -2,15 +2,33 @@ require 'helper'
 
 class TestSugarCRM < ActiveSupport::TestCase
   context "A class inheriting SugarCRM::Base" do
-    should "implement self.class.count" do
+    should "ignore 'id' attibute when creating an instance" do
+      first_account = SugarCRM::Account.first
+      new_account = nil
+      assert_difference('SugarCRM::Account.count') do
+        new_account = SugarCRM::Account.create(first_account.attributes)
+      end
+      assert first_account.id != new_account.id
+    end
+    
+    should "implement self.count" do
       nb_accounts = SugarCRM::Account.count
       assert nb_accounts > 0
-      nb_inc_accounts = SugarCRM::Account.count(:conditions => {:name => "LIKE '%Inc'"})
+      nb_inc_accounts = nil
+      assert_nothing_raised do
+        nb_inc_accounts = SugarCRM::Account.count(:conditions => {:name => "LIKE '%Inc'"})
+      end
       nb_inc_accounts_size = SugarCRM::Account.all(:conditions => {:name => "LIKE '%Inc'"}).size
       assert nb_inc_accounts > 0
       assert nb_inc_accounts < nb_accounts
       assert_equal nb_inc_accounts_size, nb_inc_accounts
     end
+    
+    should "raise InvalidAttribute if self.count is called with a custom attribute" do
+      assert_raise SugarCRM::InvalidAttribute do
+        SugarCRM::Account.count(:conditions => {:custom_attribute_c => "value"})
+      end
+    end
   end
   
   context "A SugarCRM::Base instance" do
@@ -95,8 +113,8 @@ class TestSugarCRM < ActiveSupport::TestCase
     end
     
     should "implement Base#reload!" do
-      a = SugarCRM::User.last
-      b = SugarCRM::User.last
+      a = SugarCRM::User.find("seed_will_id")
+      b = SugarCRM::User.find("seed_will_id")
       assert_not_equal 'admin', a.user_name # make sure we don't mess up admin user
       # Save the original value, so we can set it back.
       orig_last_name = a.last_name.dup

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: sugarcrm
 version: !ruby/object:Gem::Version 
-  hash: 33
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 13
-  version: 0.9.13
+  version: 0.9.14
 platform: ruby
 authors: 
 - Carl Hicks
@@ -16,98 +11,74 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-04-06 00:00:00 -07:00
+date: 2011-05-03 00:00:00 -07:00
 default_executable: sugarcrm
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+  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
-  name: activesupport
+  type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+  name: i18n
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: i18n
+  type: :runtime
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :runtime
+  name: json
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: json
+  type: :runtime
+  prerelease: false
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: shoulda
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
-  name: shoulda
+  type: :development
+  prerelease: false
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: bundler
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
-        segments: 
-        - 1
-        - 0
-        - 0
         version: 1.0.0
-  name: bundler
+  type: :development
+  prerelease: false
   version_requirements: *id005
 - !ruby/object:Gem::Dependency 
-  prerelease: false
-  type: :development
+  name: jeweler
   requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 1
-        - 5
-        - 2
         version: 1.5.2
-  name: jeweler
+  type: :development
+  prerelease: false
   version_requirements: *id006
 description: 
 email: carl.hicks@gmail.com
@@ -124,6 +95,7 @@ files:
 - ./README.rdoc
 - ./Rakefile
 - ./VERSION
+- ./WATCHLIST.rdoc
 - ./lib/rails/generators/sugarcrm/config/config_generator.rb
 - ./lib/rails/generators/sugarcrm/config/templates/initializer.rb
 - ./lib/rails/generators/sugarcrm/config/templates/sugarcrm.yml
@@ -222,7 +194,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
+      hash: -4256578188939241626
       segments: 
       - 0
       version: "0"
@@ -231,9 +203,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []