sugarcrm 0.5.3 → 0.6.0

data/lib/sugarcrm/api/get_note_attachment.rb

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

data/lib/sugarcrm/{get_relationships.rb → api/get_relationship.rb}

@@ -1,6 +1,8 @@
-module SugarCRM; class Base
-# A standard REST call to get a list of relationships
-def get_relationships(module_name, id, related_to, options={})
+module SugarCRM; class Connection
+# Retrieves a collection of beans that are related 
+# to the specified bean and, optionally, returns 
+# relationship data
+def get_relationship(module_name, id, related_to, options={})
   login! unless logged_in?
   json = <<-EOF
     {
@@ -15,6 +17,9 @@ def get_relationships(module_name, id, related_to, options={})
     }
   EOF
   json.gsub!(/^\s{6}/,'')
-  get(:get_relationships, json)
+  get(:get_relationship, json)
 end
+
+alias :get_relationships :get_relationship
+
 end; end

data/lib/sugarcrm/api/get_report_entries.rb

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

data/lib/sugarcrm/api/get_server_info.rb

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

data/lib/sugarcrm/api/get_user_id.rb

@@ -0,0 +1,13 @@
+module SugarCRM; class Connection
+  # Returns the ID of the user who is logged into the current session.
+  def get_user_id
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"
+      }
+    EOF
+    json.gsub!(/^\s{8}/,'')
+    response = get(:get_user_id, json)
+  end
+end; end

data/lib/sugarcrm/api/get_user_team_id.rb

@@ -0,0 +1,14 @@
+module SugarCRM; class Connection
+  # Retrieves the ID of the default team of the user 
+  # who is logged into the current session.
+  def get_user_team_id
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"
+      }
+    EOF
+    json.gsub!(/^\s{8}/,'')
+    response = get(:get_user_team_id, json)
+  end
+end; end

data/lib/sugarcrm/api/login.rb

@@ -0,0 +1,18 @@
+module SugarCRM; class Connection
+  # Logs the user into the Sugar application.
+  def login
+    connect! unless connected?
+    json = <<-EOF
+      {
+        \"user_auth\": {
+          \"user_name\": \"#{@user}\"\,
+          \"password\": \"#{OpenSSL::Digest::MD5.new(@pass)}\"\,
+          \"version\": \"2\"\,
+        },
+        \"application\": \"\"
+      }
+    EOF
+    json.gsub!(/^\s{8}/,'')
+    response = get(:login, json)
+  end
+end; end

data/lib/sugarcrm/api/logout.rb

@@ -0,0 +1,15 @@
+module SugarCRM; class Connection
+  # Logs out of the Sugar user session.
+  def logout
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"user_auth\": {
+          \"session\": \"#{@session}\"
+        }
+      }
+    EOF
+    json.gsub!(/^\s{8}/,'')
+    response = get(:logout, json)
+  end
+end; end

data/lib/sugarcrm/api/seamless_login.rb

@@ -0,0 +1,13 @@
+module SugarCRM; class Connection
+  # Performs a seamless login during synchronization.
+  def seamless_login
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"
+      }
+    EOF
+    json.gsub!(/^\s{8}/,'')
+    response = get(:seamless_login, json)
+  end
+end; end

data/lib/sugarcrm/api/search_by_module.rb

@@ -0,0 +1,24 @@
+module SugarCRM; class Connection
+  # Returns the ID, module name and fields for specified modules. 
+  # Supported modules are Accounts, Bugs, Calls, Cases, Contacts, 
+  # Leads, Opportunities, Projects, Project Tasks, and Quotes.
+  def search_by_module(search_string, modules, options={})
+    login! unless logged_in?
+    
+    { :offset => nil, 
+      :max_results => nil, 
+    }.merge! options
+    
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"search_string\": \"#{search_string}\"\,
+        \"modules\": \"#{modules}\"\,
+        \"offset\": #{options[:offset]}\,
+        \"max_results\": #{options[:max_results]}
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    get(:search_by_module, json)
+  end
+end; end

data/lib/sugarcrm/api/set_campaign_merge.rb

@@ -0,0 +1,15 @@
+module SugarCRM; class Connection
+  # Performs a mail merge for the specified campaign.
+  def set_campaign_merge(targets, campaign_id)
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"targets\": #{targets.to_json}\,
+        \"campaign-id\": \"#{campaign_id}\"
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    get(:set_campaign_merge, json)
+  end
+end; end

data/lib/sugarcrm/api/set_document_revision.rb

@@ -0,0 +1,15 @@
+module SugarCRM; class Connection
+  # Sets a new revision for a document.
+  def set_document_revision(id, revision)
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"document_revision\": \"#{revision}\"\,
+        \"id\": #{id}
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    get(:set_document_revision, json)
+  end
+end; end

data/lib/sugarcrm/api/set_entries.rb

@@ -0,0 +1,15 @@
+module SugarCRM; class Connection
+  # Creates or updates a list of SugarBeans.
+  def set_entries(module_name, name_value_lists)
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name\": \"#{module_name}\"\,
+        \"name_value_list\": #{name_value_lists.to_json}
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    get(:set_entries, json)
+  end
+end; end

data/lib/sugarcrm/api/set_entry.rb

@@ -0,0 +1,15 @@
+module SugarCRM; class Connection
+  # Creates or updates a single SugarBean.
+  def set_entry(module_name, name_value_list)
+    login! unless logged_in?
+    json = <<-EOF
+      {
+        \"session\": \"#{@session}\"\,
+        \"module_name\": \"#{module_name}\"\,
+        \"name_value_list\": #{name_value_list.to_json}
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    get(:set_entry, json)
+  end
+end; end

data/lib/sugarcrm/api/set_note_attachment.rb

@@ -0,0 +1,3 @@
+module SugarCRM; class Connection
+  # to be implemented
+end; end

data/lib/sugarcrm/api/set_relationship.rb

@@ -0,0 +1,18 @@
+module SugarCRM; class Connection
+  # Sets a single relationship between two SugarBeans.
+  def set_relationship(module_name, module_id, link_field_name, related_ids)
+    login! unless logged_in?
+    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\": #{link_field_name.to_json}   
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    get(:set_relationship, json)
+  end
+end; end

data/lib/sugarcrm/api/set_relationships.rb

@@ -0,0 +1,22 @@
+module SugarCRM; class Connection
+  # Sets multiple relationships between two SugarBeans.
+  def set_relationships(module_names, module_ids, link_field_names, related_ids)
+    login! unless logged_in?
+    
+    [module_names, module_ids, link_field_names, related_ids].each do |arg|
+      raise ArgumentError, "argument must be an Array" unless arg.class == Array
+    end
+    
+    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\": #{link_field_name.to_json}   
+      }
+    EOF
+    json.gsub!(/^\s{6}/,'')
+    get(:set_relationships, json)
+  end
+end; end

data/lib/sugarcrm/connection.rb

@@ -0,0 +1,112 @@
+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
+    
+    # Login
+    def login!
+      response = login
+      @session = response["id"]
+    end
+
+    # 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 @ssl
+        @connection.use_ssl = true
+        @connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      @connection.start
+    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
+    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
+    end
+
+  end
+end

data/lib/sugarcrm/exceptions.rb

@@ -0,0 +1,16 @@
+module SugarCRM
+  class LoginError < RuntimeError
+  end
+
+  class EmptyResponse < RuntimeError
+  end
+
+  class UnhandledResponse < RuntimeError
+  end
+
+  class InvalidSugarCRMUrl < RuntimeError
+  end
+  
+  class InvalidRequest < RuntimeError
+  end
+end

data/lib/sugarcrm/module.rb

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

data/lib/sugarcrm/request.rb

@@ -0,0 +1,28 @@
+module SugarCRM
+  
+class Request
+
+  attr :request, true
+  attr :url, true
+  attr :method, true
+  attr :json, true
+
+  def initialize(url, method, json, debug=false)
+    @request =  url.path.dup
+    @request << '?method=' << method.to_s
+    @request << '&input_type=JSON'
+    @request << '&response_type=JSON'
+    @request << '&rest_data=' << json
+    
+    if debug
+      puts "#{method}: Request:\n#{@request}" 
+    end
+  end
+  
+  def to_s
+    URI.escape(@request)
+  end
+  
+end
+
+end