sugarcrm 0.5.3 → 0.6.0

data/lib/sugarcrm/response.rb

@@ -0,0 +1,29 @@
+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)
+    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

data/test/helper.rb

@@ -7,4 +7,9 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'sugarcrm'
 
 class Test::Unit::TestCase
+  # Replace these with your test instance
+  URL   = "http://valet/sugarcrm6"
+  USER  = "admin"
+  PASS  = 'letmein' 
+  CRM   = SugarCRM::Base.establish_connection(URL, USER, PASS, {:debug => true})
 end

data/test/test_connection.rb

@@ -0,0 +1,60 @@
+require 'helper'
+require "test/unit"
+require "pp"
+
+class TestSugarcrm < 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    
+    end
+    
+    should "retrieve the list of available modules" do
+      assert_instance_of Array, @connection.modules
+    end
+    
+    should "create sub-classes by module name" do
+      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_response.rb

@@ -0,0 +1,36 @@
+require 'helper'
+require "test/unit"
+require "pp"
+
+class TestSugarcrm < Test::Unit::TestCase
+  context "A SugarCRM::Response instance" do
+    setup do
+      @json =  {"entry_list"=> [{
+                "name_value_list"=> {
+                  "address_city" => {"name"=>"address_city", "value"=>""},
+                  "receive_notifications" => {"name"=>"receive_notifications", "value"=>"1"},
+                  "is_group" => {"name"=>"is_group", "value"=>"0"},
+                  "pwd_last_changed" => {"name"=>"pwd_last_changed", "value"=>"never"}
+                },
+                "id"=>"1",
+                "module_name"=>"Users"
+              }],
+             "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]
+    end
+      
+    should "return an instance of a SugarCRM Module when #object" do
+      assert_instance_of SugarCRM::User, @response.object
+    end
+      
+  end
+end

data/test/test_sugarcrm.rb

@@ -2,61 +2,47 @@ require 'helper'
 require "test/unit"
 require "pp"
 
-# Replace these with your test instance
-URL   = "http://valet/sugarcrm"
-USER  = "admin"
-PASS  = 'letmein' 
-
 class TestSugarcrm < Test::Unit::TestCase
-  context "A SugarCRM::Base instance" do
-    setup do
-      @sugarcrm = SugarCRM::Base.new(URL, USER, PASS, {:debug => true})
+  context "A SugarCRM::Module instance" do
+  
+    should "return the module name" do
+      assert_equal "Users", SugarCRM::User.module_name
     end
     
-    should "return a single entry in JSON format when option :to_obj => false" do
-      @test = SugarCRM::Base.new(URL, USER, PASS, {:debug => true, :to_obj => false})
-      response = @test.get_entry(
-        "Users",
-        1,
-        {:fields => ["first_name", "last_name"]}
-      )
-      assert_kind_of Hash, response
+    should "respond to self.connection" do
+      assert_respond_to SugarCRM::User, :connection
+      assert_instance_of SugarCRM::Connection, SugarCRM::User.connection
     end
     
-    should "return a single entry when sent #get_entry." do
-      response = @sugarcrm.get_entry(
-        "Users",
-        1,
-        {:fields => ["first_name", "last_name"]} 
-      )
-      assert_respond_to 'response', :entry_list
+    should "respond to self.register_module_fields" do
+      assert_respond_to SugarCRM::User, :register_module_fields
+      SugarCRM::User.register_module_fields
+      assert SugarCRM::User.module_fields.length > 0
     end
     
-    should "return a list of entries when sent #get_entries." do
-      response = @sugarcrm.get_entries(
-        "Users",
-        [1],
-        {:fields => ["first_name", "last_name"]} 
-      )
-      assert_respond_to 'response', :entry_list
+    should "respond to self.connection.logged_in?" do
+      assert SugarCRM::User.connection.logged_in?
+    end
+  
+    should "return an instance of itself when #new" do
+      assert_instance_of SugarCRM::User, SugarCRM::User.new
     end
     
-    should "return a list of entries when sent #get_entry_list." do
-      response = @sugarcrm.get_entry_list(
-        "Users",
-        "users.user_name = \'#{USER}\'",
-        {
-          :fields => ["first_name", "last_name"],
-          :link_fields => [
-            {
-              "name"  => "accounts",
-              "value" => ["id", "name"]
-            }
-          ]          
-        } 
-      )
-      assert_respond_to 'response', :entry_list
+    should "define instance level attributes when #new" do
+      u = SugarCRM::User.new
+      assert SugarCRM::User.attribute_methods_generated
+    end
+
+    should "respond to attributes derived from module_fields" do
+      u = SugarCRM::User.new
+      u.last_name = "Test"
+      assert_equal "Test", u.last_name
     end
     
+    should "return an an instance of itself when sent #find(id)" do
+      u = SugarCRM::User.find(1)
+      assert_instance_of SugarCRM::User, u
+    end
   end
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: sugarcrm
 version: !ruby/object:Gem::Version 
-  hash: 13
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 3
-  version: 0.5.3
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Carl Hicks
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-07-16 00:00:00 -07:00
+date: 2010-08-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -46,7 +46,24 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id002
-description: A Ruby based REST client for SugarCRM.
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+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.
 email: carl.hicks@gmail.com
 executables: []
 
@@ -62,18 +79,39 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
-- lib/net/http_digest_auth.rb
-- lib/stdlib/array.rb
-- lib/stdlib/hash.rb
-- lib/stdlib/object.rb
 - lib/sugarcrm.rb
-- lib/sugarcrm/get_entries.rb
-- lib/sugarcrm/get_entry.rb
-- lib/sugarcrm/get_entry_list.rb
-- lib/sugarcrm/get_module_fields.rb
-- lib/sugarcrm/get_relationships.rb
+- lib/sugarcrm/api/get_available_modules.rb
+- lib/sugarcrm/api/get_document_revision.rb
+- lib/sugarcrm/api/get_entries.rb
+- lib/sugarcrm/api/get_entries_count.rb
+- lib/sugarcrm/api/get_entry.rb
+- lib/sugarcrm/api/get_entry_list.rb
+- lib/sugarcrm/api/get_module_fields.rb
+- lib/sugarcrm/api/get_note_attachment.rb
+- lib/sugarcrm/api/get_relationship.rb
+- lib/sugarcrm/api/get_report_entries.rb
+- lib/sugarcrm/api/get_server_info.rb
+- lib/sugarcrm/api/get_user_id.rb
+- lib/sugarcrm/api/get_user_team_id.rb
+- lib/sugarcrm/api/login.rb
+- lib/sugarcrm/api/logout.rb
+- lib/sugarcrm/api/seamless_login.rb
+- lib/sugarcrm/api/search_by_module.rb
+- lib/sugarcrm/api/set_campaign_merge.rb
+- lib/sugarcrm/api/set_document_revision.rb
+- lib/sugarcrm/api/set_entries.rb
+- lib/sugarcrm/api/set_entry.rb
+- lib/sugarcrm/api/set_note_attachment.rb
+- lib/sugarcrm/api/set_relationship.rb
+- lib/sugarcrm/api/set_relationships.rb
+- lib/sugarcrm/connection.rb
+- lib/sugarcrm/exceptions.rb
+- lib/sugarcrm/module.rb
+- lib/sugarcrm/request.rb
+- lib/sugarcrm/response.rb
 - test/helper.rb
-- test/test_json_to_obj.rb
+- test/test_connection.rb
+- test/test_response.rb
 - test/test_sugarcrm.rb
 has_rdoc: true
 homepage: http://github.com/chicks/sugarcrm
@@ -111,5 +149,6 @@ specification_version: 3
 summary: Ruby based REST client for SugarCRM
 test_files: 
 - test/helper.rb
-- test/test_json_to_obj.rb
+- test/test_connection.rb
+- test/test_response.rb
 - test/test_sugarcrm.rb

data/lib/net/http_digest_auth.rb

@@ -1,44 +0,0 @@
-# net_http_digest_auth.rb
-require 'digest/md5'
-require 'net/http'
-
-module Net
-  module HTTPHeader
-    @@nonce_count = -1
-    CNONCE = Digest::MD5.new.update("%x" % (Time.now.to_i + rand(65535))).hexdigest
-    def digest_auth(user, password, response)
-      # based on http://segment7.net/projects/ruby/snippets/digest_auth.rb
-      @@nonce_count += 1
-
-      response['www-authenticate'] =~ /^(\w+) (.*)/
-
-      params = {}
-      $2.gsub(/(\w+)="(.*?)"/) { params[$1] = $2 }
-
-      a_1 = "#{user}:#{params['realm']}:#{password}"
-      a_2 = "#{@method}:#{@path}"
-      request_digest = ''
-      request_digest << Digest::MD5.new.update(a_1).hexdigest
-      request_digest << ':' << params['nonce']
-      request_digest << ':' << ('%08x' % @@nonce_count)
-      request_digest << ':' << CNONCE
-      request_digest << ':' << params['qop']
-      request_digest << ':' << Digest::MD5.new.update(a_2).hexdigest
-
-      header = []
-      header << "Digest username=\"#{user}\""
-      header << "realm=\"#{params['realm']}\""
-      
-      header << "qop=#{params['qop']}"
-
-      header << "algorithm=MD5"
-      header << "uri=\"#{@path}\""
-      header << "nonce=\"#{params['nonce']}\""
-      header << "nc=#{'%08x' % @@nonce_count}"
-      header << "cnonce=\"#{CNONCE}\""
-      header << "response=\"#{Digest::MD5.new.update(request_digest).hexdigest}\""
-
-      @header['Authorization'] = header
-    end
-  end
-end

data/lib/stdlib/array.rb

@@ -1,14 +0,0 @@
-# A fancy way of iterating over an array and converting hashes to objects
-class Array
-  def to_obj
-    # Make a deep copy of the array
-    a = Marshal.load(Marshal.dump(self))
-    a.each do |i|
-      case i.class.to_s
-        when "Hash" then i = i.to_obj
-        when "Array" then i = i.to_obj
-      end
-    end
-    a
-  end
-end

data/lib/stdlib/hash.rb

@@ -1,17 +0,0 @@
-# A fancy way of iterating over a hash and converting hashes to objects
-class Hash
-  def to_obj
-    o = Object.new
-    self.each do |k,v|
-      # If we're looking at a hash or array, we need to look through them and convert any hashes to objects as well
-      case v.class.to_s
-        when "Hash"  then v = v.to_obj
-        when "Array" then v = v.to_obj
-      end
-      o.instance_variable_set("@#{k}", v)  ## create and initialize an instance variable for this key/value pair
-      o.class.send(:define_method, k, proc{o.instance_variable_get("@#{k}")})  ## create the getter that returns the instance variable
-      o.class.send(:define_method, "#{k}=", proc{|v| o.instance_variable_set("@#{k}", v)})  ## create the setter that sets the instance variable
-    end
-    o
-  end
-end

data/lib/stdlib/object.rb

@@ -1,5 +0,0 @@
-class Object
-  def to_obj
-    self
-  end
-end

data/test/test_json_to_obj.rb

@@ -1,48 +0,0 @@
-require 'helper'
-
-class TestJson2Object < Test::Unit::TestCase
-  def test_object
-    json = {"string" => "value"}.to_json
-    obj  = JSON.parse(json).to_obj
-    assert_equal("value", obj.string)
-  end
-  
-  def test_nested_object
-    json = {"dogs" => {"retriever" => "sparky", "basset" => "jennie", "pinscher" => "carver"}}.to_json
-    obj  = JSON.parse(json).to_obj
-    assert_equal("sparky", obj.dogs.retriever)
-  end
-  
-  def test_array_of_objects
-    json = [{"retriever" => "sparky"}, {"basset" => "jennie"}, {"pinscher" => "carver"}].to_json
-    obj  = JSON.parse(json).to_obj
-    assert_equal("sparky", obj[0].retriever)
-  end
-  
-  def test_deep_nest_mixed
-    json = {"kennels" => [
-            {"dallas" => [
-             {"name" => "north"},
-             {"name"  => "east"},
-            ]},
-            {"frisco" => [
-             {"name" => "south"},
-             {"name"  => "west"}
-            ],
-            "company" => "Doggie Daze"
-            }
-          ]}.to_json
-    obj  = JSON.parse(json).to_obj
-    assert_equal("west", obj.kennels[1].frisco[0].name)
-  end
-  
-  def test_deep_nest_hash
-    json = {"kennels" => {
-            "kennel" => {
-            "dallas" => ["north", "south"],
-            "frisco" => ["east", "west"]}}
-           }.to_json
-    obj  = JSON.parse(json).to_obj
-    assert_equal("north", obj.kennels.kennel.dallas[0])
-  end
-end