sugarcrm 0.6.2 → 0.7.2

data/lib/sugarcrm/module_methods.rb

@@ -0,0 +1,18 @@
+module SugarCRM
+  
+  @@connection = nil
+  def self.connection
+    @@connection
+  end
+  def self.connection=(connection)
+    @@connection = connection
+  end
+  
+  @@modules = []
+  def self.modules
+    @@modules
+  end
+  def self.modules=(modules)
+    @@modules = modules
+  end
+end

data/lib/sugarcrm/request.rb

@@ -6,18 +6,28 @@ class Request
   attr :url, true
   attr :method, true
   attr :json, true
+  attr :http_method
 
   def initialize(url, method, json, debug=false)
-    @request =  url.path.dup
-    @request << '?method=' << method.to_s
+    @url      = url
+    @method   = method
+    @json     = json
+
+    @request  = 'method=' << @method.to_s
     @request << '&input_type=JSON'
     @request << '&response_type=JSON'
-    @request << '&rest_data=' << json
+    @request << '&rest_data=' << @json
     
     if debug
       puts "#{method}: Request:"
       pp @request 
+      puts "\n"
     end
+    self
+  end
+  
+  def length
+    self.to_s.length
   end
   
   def to_s

data/lib/sugarcrm/response.rb

@@ -1,29 +1,79 @@
-module SugarCRM
-  # takes a raw JSON response and turns it into a REAL object
-  class Response
-    
-    attr :response, false
-    attr :module, false
-    attr :attributes, false
-    attr :object, false
-    attr :id, false
-    
-    def initialize(json)
-      @response   = json
-      @module     = @response["entry_list"][0]["module_name"].singularize
-      @attributes = flatten(@response["entry_list"][0]["name_value_list"])
-      @object     = SugarCRM.const_get(@module).new(@attributes) if SugarCRM.const_get(@module)
+module SugarCRM; class Response
+  
+  class << self
+    # This class handles the response from the server.
+    # It tries to convert the response into an object such as User
+    # or an object collection.  If it fails, it just returns the response hash
+    def handle(json)
+      r = new(json)
+      begin
+        return r.to_obj
+      rescue
+        return json
+      end
     end
-    
-    # Takes a hash like { "first_name" => {"name" => "first_name", "value" => "John"}}
-    # And flattens it into {"first_name" => "John"}
-    def flatten(list)
-      raise ArgumentError, 'method parameter must respond to #each_pair' unless list.respond_to? :each_pair
-      flat_list = {}
-      list.each_pair do |k,v|
-        flat_list[k.to_sym] = v["value"]
+  end
+
+  attr :response, false
+  
+  def initialize(json)
+    @response = json
+  end
+  
+  # Tries to instantiate and return an object with the values
+  # populated from the response
+  def to_obj
+    objects = []
+    @response["entry_list"].each do |object|
+      attributes = []
+      _module    = resolve_module(object)
+      id         = object["id"]
+      begin
+        attributes = flatten_name_value_list(object)
+      rescue ArgumentError => e
       end
-      flat_list
+      if SugarCRM.const_get(_module)
+        if attributes.length == 0
+          pp object
+          raise AttributeParsingError, "response contains objects without attributes!"
+        end
+        objects << SugarCRM.const_get(_module).new(id, attributes) 
+      else
+        raise InvalidModule, "#{_module} does not exist, or is not accessible"
+      end
+    end
+    # If we only have one result, just return the object
+    if objects.length == 1
+      return objects[0]
+    else
+      return objects
+    end
+  end
+  
+  def to_json
+    @response.to_json
+  end
+  
+  def resolve_module(list)
+    list["module_name"].classify
+  end
+  
+  def flatten_name_value_list(list)
+    if list["name_value_list"]
+      return flatten(list["name_value_list"])
+    else
+      return false
+    end
+  end
+  
+  # Takes a hash like { "first_name" => {"name" => "first_name", "value" => "John"}}
+  # And flattens it into {"first_name" => "John"}
+  def flatten(list)
+    raise ArgumentError, 'method parameter must respond to #each_pair' unless list.respond_to? :each_pair
+    flat_list = {}
+    list.each_pair do |k,v|
+      flat_list[k.to_sym] = v["value"]
     end
+    flat_list
   end
-end
+end; end

data/test/connection/test_get_available_modules.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestGetAvailableModules < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS)
+    end
+    should "return an array of modules when #get_modules" do
+      assert_instance_of SugarCRM::Module, SugarCRM.connection.get_modules[0]
+    end
+  end
+end

data/test/connection/test_get_entries.rb

@@ -0,0 +1,21 @@
+require 'helper'
+
+class TestGetEntries < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => true, :debug => false})
+      @response = SugarCRM.connection.get_entries(
+        "Users",
+        [1,"seed_sally_id"],
+        {:fields => ["first_name", "last_name"]} 
+      )
+    end
+#    should "return a list of entries when sent #get_entries." do
+#      assert @response.response.key? "entry_list"
+#    end
+    should "return an object when #get_entries" do
+      assert_instance_of Array, @response
+      assert_instance_of SugarCRM::User, @response[0]
+    end
+  end
+end

data/test/connection/test_get_entry.rb

@@ -0,0 +1,20 @@
+require 'helper'
+
+class TestGetEntry < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:debug => false })
+      @response = SugarCRM.connection.get_entry(
+        "Users",
+        1,
+        {:fields => ["first_name", "last_name"]} 
+      )
+    end
+#    should "return a single entry when sent #get_entry." do
+#      assert @response.response. "entry_list"
+#    end
+    should "return an object when #get_entry" do 
+      assert_instance_of SugarCRM::User, @response
+    end
+  end
+end

data/test/connection/test_get_entry_list.rb

@@ -0,0 +1,28 @@
+require 'helper'
+
+class TestGetEntryList < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => true, :debug => false})
+      @response = SugarCRM.connection.get_entry_list(
+        "Users",
+        "users.deleted = 0",
+        {:fields => ["first_name", "last_name"]} 
+      )
+    end
+#    should "return a list of entries when sent #get_entry_list." do
+#      assert @response.response.key? "entry_list"
+#    end
+    should "return a list of entries when sent #get_entry_list and no fields." do
+      users = SugarCRM.connection.get_entry_list(
+        "Users",
+        "users.deleted = 0"
+      )
+      assert_equal "Administrator", users.first.last_name
+    end
+    should "return an object when #get_entry_list" do
+      assert_instance_of Array, @response
+      assert_instance_of SugarCRM::User, @response[0]
+    end
+  end
+end

data/test/connection/test_get_module_fields.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestModuleFields < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:debug => false, :register_modules => false})
+    end
+    should "return a hash of module fields when #get_module_fields" do
+      fields = SugarCRM.connection.get_module_fields("Users")
+      assert_instance_of Hash, fields
+      assert "address_city", fields.keys[0]
+    end
+  end
+end

data/test/connection/test_get_relationships.rb

@@ -0,0 +1,15 @@
+require 'helper'
+
+class TestGetRelationships < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => false, :debug => false})
+    end
+    should "return a list of email_addresses when sent #get_relationship and a user_id" do
+      email_address = SugarCRM.connection.get_relationships(
+        "Users",1,"email_addresses"
+      )
+      assert_instance_of SugarCRM::EmailAddress, email_address
+    end
+  end
+end

data/test/connection/test_get_server_info.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestGetServerInfo < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => false})
+    end
+    should "get server info" do
+      assert true, SugarCRM.connection.get_server_info    
+    end
+  end
+end

data/test/connection/test_get_user_id.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestGetUserID < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => false})
+    end
+    should "get the ID of the logged in user" do
+      assert true, SugarCRM.connection.get_user_id  
+    end
+  end
+end

data/test/connection/test_get_user_team_id.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestGetUserTeamID < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => false})
+    end
+    should "get the team ID of the logged in user" do
+      assert true, SugarCRM.connection.get_user_team_id
+    end
+  end
+end

data/test/connection/test_login.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestLogin < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => false})
+    end
+    should "login and set session id" do
+      assert_not_nil SugarCRM.connection.session    
+    end
+  end
+end

data/test/connection/test_logout.rb

@@ -0,0 +1,12 @@
+require 'helper'
+
+class TestLogin < Test::Unit::TestCase
+  context "A SugarCRM.connection" do
+    setup do
+      SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => false})
+    end
+    should "logout and not be able to login with the old session id" do
+      assert true, SugarCRM.connection.logout
+    end
+  end
+end

data/test/helper.rb

@@ -11,5 +11,8 @@ class Test::Unit::TestCase
   URL   = "http://valet/sugarcrm6"
   USER  = "admin"
   PASS  = 'letmein' 
-  CRM   = SugarCRM::Base.establish_connection(URL, USER, PASS, {:debug => true})
+
+  def setup_connection
+    SugarCRM::Base.establish_connection(URL, USER, PASS, {:debug => false})
+  end
 end

data/test/test_connection.rb

@@ -1,60 +1,24 @@
 require 'helper'
-require "test/unit"
-require "pp"
 
-class TestSugarcrm < Test::Unit::TestCase
+#require 'connection/test_login'
+#require 'connection/test_get_available_modules'
+#require 'connection/test_get_module_fields'
+#require 'connection/test_get_entry'
+#require 'connection/test_get_entries'
+#require 'connection/test_get_entry_list'
+
+class TestConnection < Test::Unit::TestCase
   context "A SugarCRM::Connection instance" do
-    
     setup do
-      @connection = SugarCRM::Connection.new(URL, USER, PASS, false)
-    end
-    
-    should "login and set session id" do
-      assert_not_nil @connection.session    
+      @connection = SugarCRM::Connection.new(URL, USER, PASS)
     end
-    
     should "retrieve the list of available modules" do
-      assert_instance_of Array, @connection.modules
+      assert_instance_of Array, SugarCRM.modules
+      assert_instance_of SugarCRM::Module, SugarCRM.modules[0]
     end
-    
     should "create sub-classes by module name" do
+      @connection = SugarCRM::Connection.new(URL, USER, PASS, {:register_modules => true})
       assert SugarCRM.const_defined? "User"
     end
-    
-    should "return a single entry when sent #get_entry." do
-      response = @connection.get_entry(
-        "Users",
-        1,
-        {:fields => ["first_name", "last_name"]} 
-      )
-      assert response.response.key? "entry_list"
-    end
-
-    should "return a list of entries when sent #get_entries." do
-      response = @connection.get_entries(
-        "Users",
-        [1],
-        {:fields => ["first_name", "last_name"]} 
-      )
-      assert response.key? "entry_list"
-    end
-
-    should "return a list of entries when sent #get_entry_list." do
-      response = @connection.get_entry_list(
-        "Users",
-        "users.user_name = \'#{USER}\'",
-        {
-          :fields => ["first_name", "last_name"],
-          :link_fields => [
-            {
-              "name"  => "accounts",
-              "value" => ["id", "name"]
-            }
-          ]          
-        } 
-      )
-      assert response.key? "entry_list"
-    end
-    
   end
 end

data/test/test_module.rb

@@ -0,0 +1,14 @@
+require 'helper'
+
+class TestModule < Test::Unit::TestCase
+  context "A SugarCRM::Module instance" do
+    
+    setup do
+      @connection = SugarCRM::Connection.new(URL, USER, PASS)
+    end
+    
+    should "respond to #fields" do
+      assert_respond_to SugarCRM.modules[0], :fields
+    end
+  end
+end

data/test/test_response.rb

@@ -1,10 +1,9 @@
 require 'helper'
-require "test/unit"
-require "pp"
 
-class TestSugarcrm < Test::Unit::TestCase
+class TestResponse < Test::Unit::TestCase
   context "A SugarCRM::Response instance" do
     setup do
+      @connection = SugarCRM::Connection.new(URL, USER, PASS)
       @json =  {"entry_list"=> [{
                 "name_value_list"=> {
                   "address_city" => {"name"=>"address_city", "value"=>""},
@@ -17,19 +16,11 @@ class TestSugarcrm < Test::Unit::TestCase
               }],
              "relationship_list"=>[]}
   
-      @response = SugarCRM::Response.new(@json)
-    end
-    
-    should "set the module name" do
-      assert_equal "User", @response.module
-    end
-    
-    should "flatten the name_value_list into an attributes hash" do
-      assert_equal "never", @response.attributes[:pwd_last_changed]
+      @response = SugarCRM::Response.handle(@json)
     end
       
-    should "return an instance of a SugarCRM Module when #object" do
-      assert_instance_of SugarCRM::User, @response.object
+    should "return an instance of a SugarCRM Module" do
+      assert_instance_of SugarCRM::User, @response
     end
       
   end