sugarcrm 0.6.2 → 0.7.2

data/README.rdoc

@@ -11,8 +11,8 @@ RubyGem for interacting with SugarCRM via REST.
 == Description:
 
 I've implemented all of the basic API calls that SugarCRM supports, and am actively building an abstraction layer
-on top of the basic API methods.  The end result will be to provide ActiveRecord style finders and first class
-objects.  Some of this functionality is included today. 
+on top of the basic API methods.  The end result will be ActiveRecord style finders and first class objects.  Some 
+of this functionality is included today. 
 
 == FEATURES/PROBLEMS:
 
@@ -23,20 +23,25 @@ objects.  Some of this functionality is included today.
 
   require 'sugarcrm'
   # Establish a connection
-  sugarcrm = SugarCRM::Base.establish_connection("http://localhost/sugarcrm", 'user', 'password', {:debug => false})
+  SugarCRM::Base.establish_connection("http://localhost/sugarcrm", 'user', 'password', {:debug => false})
 
   # Retrieve a user by ID, using the SugarCRM::User Proxy object
   SugarCRM::User.find(id)
   
   # Show a list of available modules
-  sugarcrm.connection.modules
+  SugarCRM.modules
+  
+  # Use the HTTP for direct API calls
+  SugarCRM.connection.get_entry(1)
 
   # Lookup a user by name.  Find any associated accounts
-  sugarcrm.connection.get_entry_list(
+  SugarCRM::User.find_by_username('sarah').accounts
+  
+  # Same operation, but using the direct API calls
+  SugarCRM.connection.get_entry_list(
     "Users",
-    "users.user_name = \'#{USER}\'",
+    "users.user_name = \'sarah\'",
     {
-      :fields => ["first_name", "last_name"],
       :link_fields => [
         {
           "name"  => "accounts",
@@ -48,7 +53,7 @@ objects.  Some of this functionality is included today.
 
 == REQUIREMENTS:
 
-* activesupport gem
+* >= activesupport 3.0.0 gem
 * json gem
 
 == INSTALL:

data/Rakefile

@@ -14,7 +14,7 @@ begin
     gem.authors = ["Carl Hicks"]
     gem.add_development_dependency "shoulda", ">= 0"
     gem.add_dependency "json", ">= 0"
-    gem.add_dependency "activesupport", ">= 2.3"    
+    gem.add_dependency "activesupport", ">= 3.0"    
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.6.2
+0.7.2

data/lib/sugarcrm.rb

@@ -1,143 +1,11 @@
-#! /usr/bin/env ruby
-
-module SugarCRM
-
-Dir["#{File.dirname(__FILE__)}/sugarcrm/**/*.rb"].each { |f| load(f) }
-
 require 'pp'
-require 'uri'
-require 'net/https'
-require 'digest/md5'
-
 require 'rubygems'
 require 'active_support/core_ext'
-require 'json'
-
-class Base 
-  # Unset all of the instance methods we don't need.
-  instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$|^define_method$|^class$|^instance_of.$)/ }
-
-  # This holds our connection
-  cattr_accessor :connection, :instance_writer => false
-  
-  # Contains the name of the module in SugarCRM
-  class_attribute :module_name
-  self.module_name = self.name.split(/::/)[-1]
-  
-  # Contains the fields found on the current module
-  class_attribute :module_fields
-  self.module_fields = {}
-  
-  # Tracks if we have extended our class with attribute methods yet.
-  class_attribute :attribute_methods_generated
-  self.attribute_methods_generated = false
-
-  # Contains a list of attributes
-  attr :attributes, true
-  attr :debug, true
-
-  def self.establish_connection(url, user, pass, opts={})
-    options = { 
-      :debug  => false,
-    }.merge(opts)
-    @debug  = options[:debug]
-    @@connection = SugarCRM::Connection.new(url, user, pass, @debug)
-  end
-  
-  # Registers the module fields on the class
-  def self.register_module_fields
-    self.module_fields = connection.get_fields(self.module_name)["module_fields"] if self.module_fields.length == 0
-  end
-  
-  def initialize(attributes={})
-    @attributes = attributes_from_module_fields.merge(attributes)
-    define_attribute_methods
-  end
-  
-  def inspect
-    self
-  end
-  
-  def to_s
-    attrs = []
-    @attributes.each_key do |k|
-       attrs << "#{k}: #{attribute_for_inspect(k)}"
-    end
-    "#<#{self.class} #{attrs.join(", ")}>"
-  end
-
-  # Returns an <tt>#inspect</tt>-like string for the value of the
-  # attribute +attr_name+. String attributes are elided after 50
-  # characters, and Date and Time attributes are returned in the
-  # <tt>:db</tt> format. Other attributes return the value of
-  # <tt>#inspect</tt> without modification.
-  #
-  #   person = Person.create!(:name => "David Heinemeier Hansson " * 3)
-  #
-  #   person.attribute_for_inspect(:name)
-  #   # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
-  #
-  #   person.attribute_for_inspect(:created_at)
-  #   # => '"2009-01-12 04:48:57"'
-  def attribute_for_inspect(attr_name)
-    value = read_attribute(attr_name)
-
-    if value.is_a?(String) && value.length > 50
-      "#{value[0..50]}...".inspect
-    elsif value.is_a?(Date) || value.is_a?(Time)
-      %("#{value.to_s(:db)}")
-    else
-      value.inspect
-    end
-  end
-
-  protected
-
-  # Generates get/set methods for keys in the attributes hash
-  def define_attribute_methods
-    return if attribute_methods_generated?
-    @attributes.each_pair do |k,v|
-      self.class.module_eval %Q?
-      def #{k}
-        read_attribute :#{k}
-      end
-      def #{k}=(value)
-        write_attribute :#{k},value
-      end
-      ?
-    end
-    self.class.attribute_methods_generated = true
-  end
-
-  # Wrapper around class attribute
-  def attribute_methods_generated?
-    self.class.attribute_methods_generated
-  end
-  
-  def module_fields_registered?
-    self.class.module_fields.length > 0
-  end
-
-  # Returns a hash of the module fields from the 
-  def attributes_from_module_fields
-    self.class.register_module_fields unless module_fields_registered?
-    fields = {}
-    self.class.module_fields.keys.sort.each do |k|
-      fields[k.to_s] = nil
-    end
-    fields
-  end
-
-  # Wrapper around attributes hash
-  def read_attribute(key)
-    @attributes[key]
-  end
-  
-  # Wrapper around attributes hash
-  def write_attribute(key, value)
-    @attributes[key] = value
-  end
-
-end
 
-end
+require 'sugarcrm/module_methods'
+require 'sugarcrm/base'
+require 'sugarcrm/connection'
+require 'sugarcrm/exceptions'
+require 'sugarcrm/module'
+require 'sugarcrm/request'
+require 'sugarcrm/response'

data/lib/sugarcrm/association_methods.rb

@@ -0,0 +1,45 @@
+module SugarCRM; module AssociationMethods
+  
+  # Returns an array of the module link fields
+  def associations_from_module_link_fields
+    self.class._module.link_fields.keys
+  end
+  
+  # Generates the association proxy methods for related modules
+  def define_association_methods
+    return if association_methods_generated?
+    @associations.each do |k|
+      self.class.module_eval %Q?
+      def #{k}
+        query_association :#{k}
+      end
+      def #{k}=(value)
+        update_association :#{k},value
+      end
+      ?
+    end
+    self.class.association_methods_generated = true
+  end
+  
+  #
+  #  {"email_addresses"=>
+  #    {"name"=>"email_addresses",
+  #     "module"=>"EmailAddress",
+  #     "bean_name"=>"EmailAddress",
+  #     "relationship"=>"users_email_addresses",
+  #     "type"=>"link"},
+  #
+  def query_association(association)
+    klass = self.class._module.link_fields[association.to_s]["module"]
+    objects = SugarCRM.connection.get_relationships(
+      self.class._module.name,
+      self.id,
+      association.to_s
+    )
+  end
+  
+  def update_association(association, value)
+    false
+  end
+  
+end; end

data/lib/sugarcrm/attribute_methods.rb

@@ -0,0 +1,65 @@
+module SugarCRM; module AttributeMethods
+
+  # Returns a hash of the module fields from the 
+  def attributes_from_module_fields
+    fields = {}
+    self.class._module.fields.keys.sort.each do |k|
+      fields[k.to_s] = nil
+    end
+    fields
+  end
+
+  # Generates get/set methods for keys in the attributes hash
+  def define_attribute_methods
+    return if attribute_methods_generated?
+    @attributes.each_pair do |k,v|
+      self.class.module_eval %Q?
+      def #{k}
+        read_attribute :#{k}
+      end
+      def #{k}=(value)
+        write_attribute :#{k},value
+      end
+      ?
+    end
+    self.class.attribute_methods_generated = true
+  end
+
+  # Returns an <tt>#inspect</tt>-like string for the value of the
+  # attribute +attr_name+. String attributes are elided after 50
+  # characters, and Date and Time attributes are returned in the
+  # <tt>:db</tt> format. Other attributes return the value of
+  # <tt>#inspect</tt> without modification.
+  #
+  #   person = Person.create!(:name => "David Heinemeier Hansson " * 3)
+  #
+  #   person.attribute_for_inspect(:name)
+  #   # => '"David Heinemeier Hansson David Heinemeier Hansson D..."'
+  #
+  #   person.attribute_for_inspect(:created_at)
+  #   # => '"2009-01-12 04:48:57"'
+  def attribute_for_inspect(attr_name)
+    value = read_attribute(attr_name)
+    if value.is_a?(String) && value.length > 50
+      "#{value[0..50]}...".inspect
+    elsif value.is_a?(Date) || value.is_a?(Time)
+      %("#{value.to_s(:db)}")
+    else
+      value.inspect
+    end
+  end
+
+  protected
+
+  # Wrapper around attributes hash
+  def read_attribute(key)
+    @attributes[key]
+  end
+  
+  # Wrapper around attributes hash
+  def write_attribute(key, value)
+    @attributes[key] = value
+  end
+  
+end; end
+  

data/lib/sugarcrm/base.rb

@@ -0,0 +1,85 @@
+require 'sugarcrm/attribute_methods'
+require 'sugarcrm/association_methods'
+
+module SugarCRM; class Base 
+
+  # Unset all of the instance methods we don't need.
+  instance_methods.each { |m| undef_method m unless m =~ /(^__|^send$|^object_id$|^define_method$|^class$|^instance_of.$)/ }
+
+  # 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
+  
+  class_attribute :association_methods_generated
+  self.association_methods_generated = false
+  
+  class_attribute :_module
+  self._module = nil
+  
+  # Contains a list of attributes
+  attr :attributes, true
+  attr :id, true
+  attr :debug, true
+
+  class << self # Class methods
+    def establish_connection(url, user, pass, opts={})
+      options = { 
+        :debug  => false,
+      }.merge(opts)
+      @debug  = options[:debug]
+      @@connection = SugarCRM::Connection.new(url, user, pass, @debug)
+    end
+  
+    # Runs a find against the remote service
+    def find(id)
+      response = SugarCRM.connection.get_entry(self._module.name, id, {:fields => self._module.fields.keys})
+    end
+  end
+
+  # Creates an instance of a Module Class, i.e. Account, User, Contact, etc.
+  # This call depends upon SugarCRM.modules having actual data in it.  If you 
+  # are using Base.establish_connection, you should be fine.  But if you are 
+  # using the Connection class by itself, you may need to prime the pump with
+  # a call to Module.register_all
+  def initialize(id=nil, attributes={})
+    @id = id
+    @attributes = attributes_from_module_fields.merge(attributes)
+    @associations = associations_from_module_link_fields
+    define_attribute_methods
+    define_association_methods
+  end
+
+  def inspect
+    self
+  end
+  
+  def to_s
+    attrs = []
+    @attributes.each_key do |k|
+       attrs << "#{k}: #{attribute_for_inspect(k)}"
+    end
+    "#<#{self.class} #{attrs.join(", ")}>"
+  end
+
+  def save
+    response = SugarCRM.connection.set_entry(self._module.name, @attributes)
+  end
+  
+  # Wrapper around class attribute
+  def attribute_methods_generated?
+    self.class.attribute_methods_generated
+  end  
+  
+  def association_methods_generated?
+    self.class.association_methods_generated
+  end
+
+  Base.class_eval do
+    include AttributeMethods
+    include AssociationMethods
+  end
+
+end; end 

data/lib/sugarcrm/connection.rb

@@ -1,112 +1,135 @@
-module SugarCRM
-  class Connection
-    
-    URL = "/service/v2/rest.php"
-    
-    attr :url, true
-    attr :user, false
-    attr :pass, false
-    attr :ssl, false
-    attr :session, true
-    attr :connection, true
-    attr :modules, false  
-    attr :debug, true
-    
-    # This is the singleton connection class. 
-    def initialize(url, user, pass, debug=false)
-      @url    = URI.parse(url)
-      @user   = user
-      @pass   = pass
-      @debug  = debug
-      # Handles http/https in url string
-      @ssl    = false
-      @ssl    = true if @url.scheme == "https"
-      # Appends the rest.php path onto the end of the URL if it's not included
-      if @url.path !~ /rest.php$/
-        @url.path += URL
-      end
-      login!
-      raise SugarCRM::LoginError, "Invalid Login" unless logged_in?
-      @modules = get_modules
-      @modules.each do |m|
-        begin
-          register_module(m)
-        rescue SugarCRM::InvalidRequest
-          next
-        end
-      end
-    end
-    
-    # Check to see if we are logged in
-    def logged_in?
-      @session ? true : false
-    end
+
+require 'uri'
+require 'net/https'
+
+require 'rubygems'
+require 'json'
+
+require 'sugarcrm/connection/helper'
+Dir["#{File.dirname(__FILE__)}/connection/api/*.rb"].each { |f| load(f) }
+
+module SugarCRM; class Connection
+
+  URL = "/service/v2/rest.php"
+  DONT_SHOW_DEBUG_FOR = [:get_available_modules]
+  RESPONSE_IS_NOT_JSON = [:get_user_id, :get_user_team_id]
+  
+  attr :url, true
+  attr :user, false
+  attr :pass, false
+  attr :session, true
+  attr :connection, true
+  attr :options, true
+  attr :request, true
+  attr :response, true
+  
+  # This is the singleton connection class. 
+  def initialize(url, user, pass, options={})
+    @options  = {
+      :debug => false,
+      :register_modules => true      
+    }.merge(options)
     
-    # Login
-    def login!
-      response = login
-      @session = response["id"]
-    end
+    @url      = URI.parse(url)
+    @user     = user
+    @pass     = pass
+    @request  = ""
+    @response = ""
+
+    resolve_url
+    login!
+    self
+  end
+  
+  # Check to see if we are logged in
+  def logged_in?
+    @session ? true : false
+  end
+  
+  # Login
+  def login!
+    @session = login["id"]
+    raise SugarCRM::LoginError, "Invalid Login" unless logged_in?
+    SugarCRM.connection = self
+    SugarCRM::Base.connection = self
+    Module.register_all if @options[:register_modules]
+  end
 
-    # Check to see if we are connected
-    def connected?
-      return false unless @connection
-      return false unless @connection.started?
-      true
+  # Check to see if we are connected
+  def connected?
+    return false unless @connection
+    return false unless @connection.started?
+    true
+  end
+  
+  # Connect
+  def connect!
+    @connection = Net::HTTP.new(@url.host, @url.port)
+    if @url.scheme == "https"
+      @connection.use_ssl = true
+      @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
     end
-    
-    # Connect
-    def connect!
-      @connection = Net::HTTP.new(@url.host, @url.port)
-      if @ssl
-        @connection.use_ssl = true
-        @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    @connection.start
+  end
+  
+  # Send a GET request to the Sugar Instance
+  def send!(method, json)
+    @request  = SugarCRM::Request.new(@url, method, json, @options[:debug])
+    if @request.length > 3900
+      @response = @connection.post(@url.path, @request)
+    else
+      @response = @connection.get(@url.path.dup + "?" + @request.to_s)
+    end
+    handle_response
+  end
+  
+  def debug=(debug)
+    options[:debug] = debug
+  end
+  
+  private
+  
+  def handle_response
+    case @response
+    when Net::HTTPOK 
+      return process_response
+    when Net::HTTPNotFound
+      raise SugarCRM::InvalidSugarCRMUrl, "#{@url} is invalid"
+    when Net::HTTPInternalServerError
+      raise SugarCRM::InvalidRequest, "#{@request} is invalid"
+    else
+      if @options[:debug]
+        puts "#{@request.method}: Raw Response:"
+        puts @response.body
+        puts "\n"
       end
-      @connection.start
+      raise SugarCRM::UnhandledResponse, "Can't handle response #{@response}"
     end
+  end
 
-    # Send a GET request to the Sugar Instance
-    def get(method, json)
-      request   = SugarCRM::Request.new(@url, method, json, @debug)
-      response  = connection.get(request.to_s)
-    
-      case response
-        when Net::HTTPOK 
-          raise SugarCRM::EmptyResponse unless response.body
-          response_json = JSON.parse response.body
-          return false if response_json["result_count"] == 0
-          if @debug 
-            puts "#{method}: JSON Response:"
-            pp response_json
-            puts "\n"
-          end
-          return response_json
-        when Net::HTTPNotFound
-          raise SugarCRM::InvalidSugarCRMUrl, "#{@url} is invalid"
-        when Net::HTTPInternalServerError
-          raise SugarCRM::InvalidRequest, "#{request} is invalid"
-        else
-          if @debug 
-            puts "#{method}: Raw Response:"
-            puts response.body
-            puts "\n"
-          end
-          raise SugarCRM::UnhandledResponse, "Can't handle response #{response}"
-      end
+  def process_response
+    # Complain if our body is empty.
+    raise SugarCRM::EmptyResponse unless @response.body
+    # Some methods are dumb and don't return a JSON Response
+    return @response.body if RESPONSE_IS_NOT_JSON.include? @request.method
+    # Push it through the old meat grinder.
+    response_json = JSON.parse @response.body
+    # Empty result.  Is this wise?
+    return false if response_json["result_count"] == 0
+    # Filter debugging on REALLY BIG responses
+    if @options[:debug] && !(DONT_SHOW_DEBUG_FOR.include? @request.method)
+      puts "#{@request.method}: JSON Response:"
+      pp response_json
+      puts "\n"
     end
-    
-    # Dynamically register objects based on Module name
-    # I.e. a SugarCRM Module named Users will generate
-    # a SugarCRM::User class.
-    def register_module(module_name, mod=SugarCRM)
-      klass_name = module_name.singularize
-      return if mod.const_defined? klass_name
-      klass = Class.new(SugarCRM::Base) do
-        self.module_name = module_name
-      end 
-      mod.const_set klass_name, klass
-      klass
+    return response_json
+  end
+  
+  def resolve_url
+    # Appends the rest.php path onto the end of the URL if it's not included
+    if @url.path !~ /rest.php$/
+      @url.path += URL
     end
-
   end
-end
+  
+end; end