sugarcrm 0.6.2 → 0.7.2

data/lib/sugarcrm/{api → connection/api}/get_available_modules.rb

@@ -9,7 +9,12 @@ module SugarCRM; class Connection
     EOF
     
     json.gsub!(/^\s{6}/,'')
-    get(:get_available_modules, json)["modules"]
+    mods = send!(:get_available_modules, json)["modules"]
+    modules = []
+    mods.each do |mod|
+      modules << Module.new(mod)
+    end
+    modules
   end
   
   alias :get_modules :get_available_modules

data/lib/sugarcrm/{api → connection/api}/get_document_revision.rb

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

data/lib/sugarcrm/{api → connection/api}/get_entries.rb

@@ -1,23 +1,22 @@
 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, options={})
+def get_entries(module_name, ids, opts={})
   login! unless logged_in?
-  {
-    :fields => '', 
+  options = { :fields => [], 
     :link_fields => [], 
-  }.merge! options
+  }.merge! opts
 
   json = <<-EOF
     {
       \"session\": \"#{@session}\"\,
       \"module_name\": \"#{module_name}\"\,
       \"ids\": #{ids.to_json}\,
-      \"select_fields\": #{options[:fields].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}/,'')
-  get(:get_entries, json)
+  SugarCRM::Response.handle(send!(:get_entries, json))
 end
 end; end

data/lib/sugarcrm/{api → connection/api}/get_entries_count.rb

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

data/lib/sugarcrm/{api → connection/api}/get_entry.rb

@@ -1,22 +1,22 @@
 module SugarCRM; class Connection
   # Retrieves a single SugarBean based on the ID.
-  def get_entry(module_name, id, options={})
+  def get_entry(module_name, id, opts={})
     login! unless logged_in?
-    { :fields => [], 
+    options = { :fields => [], 
       :link_fields => [], 
-    }.merge! options
-
+    }.merge! opts
+    
     json = <<-EOF
       {
         \"session\": \"#{@session}\"\,
         \"module_name\": \"#{module_name}\"\,
         \"id\": \"#{id}\"\,
-        \"select_fields\": #{options[:fields].to_json}\,
+        \"select_fields\": #{resolve_fields(module_name, options[:fields])}\,
         \"link_name_to_fields_array\": #{options[:link_fields]}\,
       }
     EOF
         
     json.gsub!(/^\s{6}/,'')
-    SugarCRM::Response.new(get(:get_entry, json))
+    SugarCRM::Response.handle(send!(:get_entry, json))
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/get_entry_list.rb

@@ -1,16 +1,16 @@
 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, options={})
+def get_entry_list(module_name, query, opts={})
   login! unless logged_in?  
-  {
+  options = {
     :order_by => '', 
     :offset => '', 
-    :fields => '', 
+    :fields => [], 
     :link_fields => [], 
     :max_results => '', 
     :deleted => ''
-  }.merge! options
+  }.merge! opts
 
   json = <<-EOF
     {
@@ -19,13 +19,13 @@ def get_entry_list(module_name, query, options={})
       \"query\": \"#{query}\"\,
       \"order_by\": \"#{options[:order_by]}\"\,
       \"offset\": \"#{options[:offset]}\"\,
-      \"select_fields\": #{options[:fields].to_json}\,
+      \"select_fields\": #{resolve_fields(module_name, options[:fields])}\,
       \"link_name_to_fields_array\": #{options[:link_fields].to_json}\,
       \"max_results\": \"#{options[:max_results]}\"\,
       \"deleted\": #{options[:deleted]}
     }
   EOF
   json.gsub!(/^\s{6}/,'')
-  get(:get_entry_list, json)
+  SugarCRM::Response.handle(send!(:get_entry_list, json))
 end
 end; end

data/lib/sugarcrm/{api → connection/api}/get_module_fields.rb

@@ -10,7 +10,8 @@ def get_module_fields(module_name)
     }
   EOF
   json.gsub!(/^\s{6}/,'')
-  get(:get_module_fields, json)
+  SugarCRM::Response.handle(send!(:get_module_fields, json))
+  #send!(:get_module_fields, json)
 end
 
 alias :get_fields :get_module_fields

data/lib/sugarcrm/{api → connection/api}/get_note_attachment.rb

@@ -10,6 +10,6 @@ def get_note_attachment(id)
     }
   EOF
   json.gsub!(/^\s{6}/,'')
-  get(:get_note_attachment, json)
+  send!(:get_note_attachment, json)
 end
 end; end

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

@@ -0,0 +1,34 @@
+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
+
+end; end

data/lib/sugarcrm/{api → connection/api}/get_report_entries.rb

@@ -14,6 +14,6 @@ def get_report_entries(ids, options={})
     }
   EOF
   json.gsub!(/^\s{6}/,'')
-  get(:get_report_entries, json)
+  send!(:get_report_entries, json)
 end
 end; end

data/lib/sugarcrm/{api → connection/api}/get_server_info.rb

@@ -2,6 +2,6 @@ module SugarCRM; class Connection
   # Returns server information such as version, flavor, and gmt_time.
   def get_server_info
     login! unless logged_in?
-    connection.get(:get_server_info, "")
+    Response.handle(send!(:get_server_info, ""))
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/get_user_id.rb

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

data/lib/sugarcrm/{api → connection/api}/get_user_team_id.rb

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

data/lib/sugarcrm/{api → connection/api}/login.rb

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

data/lib/sugarcrm/{api → connection/api}/logout.rb

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

data/lib/sugarcrm/{api → connection/api}/seamless_login.rb

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

data/lib/sugarcrm/{api → connection/api}/search_by_module.rb

@@ -19,6 +19,6 @@ module SugarCRM; class Connection
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    get(:search_by_module, json)
+    send!(:search_by_module, json)
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/set_campaign_merge.rb

@@ -10,6 +10,6 @@ module SugarCRM; class Connection
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    get(:set_campaign_merge, json)
+    send!(:set_campaign_merge, json)
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/set_document_revision.rb

@@ -10,6 +10,6 @@ module SugarCRM; class Connection
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    get(:set_document_revision, json)
+    send!(:set_document_revision, json)
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/set_entries.rb

@@ -10,6 +10,6 @@ module SugarCRM; class Connection
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    get(:set_entries, json)
+    send!(:set_entries, json)
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/set_entry.rb

@@ -10,6 +10,6 @@ module SugarCRM; class Connection
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    get(:set_entry, json)
+    send!(:set_entry, json)
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/set_relationship.rb

@@ -13,6 +13,6 @@ module SugarCRM; class Connection
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    get(:set_relationship, json)
+    send!(:set_relationship, json)
   end
 end; end

data/lib/sugarcrm/{api → connection/api}/set_relationships.rb

@@ -17,6 +17,6 @@ module SugarCRM; class Connection
       }
     EOF
     json.gsub!(/^\s{6}/,'')
-    get(:set_relationships, json)
+    send!(:set_relationships, json)
   end
 end; end

data/lib/sugarcrm/connection/helper.rb

@@ -0,0 +1,10 @@
+module SugarCRM; class Connection
+  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
+      fields = Module.find(module_name).fields.keys
+    end
+    return fields.to_json
+  end
+end; end

data/lib/sugarcrm/exceptions.rb

@@ -13,4 +13,10 @@ module SugarCRM
   
   class InvalidRequest < RuntimeError
   end
+  
+  class InvalidModule <RuntimeError
+  end
+  
+  class AttributeParsingError < RuntimeError
+  end
 end

data/lib/sugarcrm/module.rb

@@ -1,11 +1,110 @@
 module SugarCRM
-  class Base
- 
-    # Runs a find against the remote service
-    def self.find(id)
-      response = connection.get_entry(self.module_name, id,{:fields => self.module_fields.keys})
-      response.object
+  # A class for handling SugarCRM Modules
+  class Module
+    attr :name, false
+    attr :klass, false
+    attr :fields, false
+    attr :link_fields, false
+
+    # Dynamically register objects based on Module name
+    # I.e. a SugarCRM Module named Users will generate
+    # a SugarCRM::User class.
+    def initialize(name)
+      @name   = name
+      @klass  = name.classify
+      @fields = {}
+      @link_fields  = {}
+      @fields_registered = false
+      self
+    end
+    
+    def fields
+      return @fields if fields?
+      all_fields  = SugarCRM.connection.get_fields(@name)
+      @fields     = all_fields["module_fields"]
+      @link_fields= all_fields["link_fields"] 
+      @fields_registered = true
+      @fields
+    end
+    
+    def fields?
+      @fields_registered
+    end
+    
+    def link_fields
+      self.fields unless link_fields?
+      handle_empty_array
+      @link_fields
+    end
+    
+    def link_fields?
+      @fields_registered
+    end  
+  
+    def handle_empty_array
+      if @link_fields.class == Array && @link_fields.length == 0
+        @link_fields = {}
+      end
+    end
+    
+    # Registers a single module by name
+    # Adds module to SugarCRM.modules (SugarCRM.modules << Module.new("Users"))
+    # Adds module class to SugarCRM parent module (SugarCRM.constants << User)
+    # Note, SugarCRM::User.module == Module.find("Users")
+    def register
+      return self if registered?
+      mod_instance = self
+      # class Class < SugarCRM::Base
+      #   module_name = "Accounts"
+      # end
+      klass = Class.new(SugarCRM::Base) do
+        self._module = mod_instance
+      end 
+      
+      # class Account < SugarCRM::Base
+      SugarCRM.const_set self.klass, klass
+      self
     end
 
+    def registered?
+      SugarCRM.const_defined? @klass
+    end  
+      
+    def to_s
+      @name
+    end
+    
+    def to_class
+      SugarCRM.const_get(@klass).new
+    end
+      
+    class << self
+      @initialized = false
+      
+      # Registers all of the SugarCRM Modules
+      def register_all
+        SugarCRM.connection.get_modules.each do |m|
+          SugarCRM.modules << m.register
+        end
+        @initialized = true
+        true
+      end
+
+      # Finds a module by name, or klass name
+      def find(name)
+        register_all unless initialized?
+        SugarCRM.modules.each do |m|
+          return m if m.name  == name
+          return m if m.klass == name
+        end
+        false
+      end
+      
+      # Class variable to track if we've initialized or not
+      def initialized?
+        @initialized ||= false
+      end
+      
+    end
   end
 end