sugarcrm 0.8.2 → 0.9.0

data/test/test_associations.rb

@@ -0,0 +1,33 @@
+require 'helper'
+
+class TestAssociations < Test::Unit::TestCase
+  context "A SugarCRM::Base instance" do
+    should "return an email address when sent #email_addresses" do
+      u = SugarCRM::User.find("seed_sarah_id")
+      assert_equal "sarah@example.com", u.email_addresses.first.email_address
+    end
+    
+    should "utilize the association cache" do
+      u = SugarCRM::User.find(1)
+      u.email_addresses
+      assert u.association_cached? :email_addresses
+    end
+    
+    should "permit adding a record to an association collection (such as #meetings << Meeting.new)" do
+      u = SugarCRM::User.find(1)
+      m = SugarCRM::Meeting.new
+      m.date_start = DateTime.now
+      m.duration_hours = 0.5
+      m.name = "Yet Another Stupid Meeting"
+      u.meetings << m
+      assert u.meetings.include?(m)
+      assert_equal [m], u.meetings.added
+      assert u.save!
+      u = SugarCRM::User.find(1)
+      assert u.meetings.include?(m)
+      assert u.meetings.delete(m)
+      assert u.meetings.save!
+      assert !u.meetings.include?(m)
+    end
+  end
+end

data/test/test_connection.rb

@@ -1,12 +1,5 @@
 require 'helper'
 
-#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

data/test/test_module.rb

@@ -12,7 +12,7 @@ class TestModule < Test::Unit::TestCase
     end
     
     should "return required fields when #required_fields" do
-      assert SugarCRM::User._module.required_fields.include? "user_name"
+      assert SugarCRM::User._module.required_fields.include? :user_name
     end
   end
 end

data/test/test_sugarcrm.rb

@@ -17,6 +17,10 @@ class TestSugarCRM < Test::Unit::TestCase
       assert_equal "Users", SugarCRM::User._module.name
     end
     
+    should "return the module fields" do
+      assert_instance_of ActiveSupport::HashWithIndifferentAccess, SugarCRM::Account._module.fields
+    end
+    
     should "responsd to self#methods" do
       assert_instance_of Array, SugarCRM::User.new.methods
     end
@@ -48,9 +52,11 @@ class TestSugarCRM < Test::Unit::TestCase
     end
 
     should "not save a record that is missing required attributes" do
+      SugarCRM.connection.debug = false
       u = SugarCRM::User.new
       u.last_name = "Test"
       assert !u.save
+      SugarCRM.connection.debug = false
       assert_raise SugarCRM::InvalidRecord do
         u.save!
       end
@@ -67,6 +73,7 @@ class TestSugarCRM < Test::Unit::TestCase
       u.status = "Active"
       assert_equal "Test", u.modified_attributes[:first_name][:new]
       assert u.save!
+      assert !u.new?
       m = SugarCRM::User.find_by_first_name_and_last_name("Test", "User")
       m.title = "Test User"
       assert m.save!
@@ -74,13 +81,19 @@ class TestSugarCRM < Test::Unit::TestCase
       #SugarCRM.connection.debug = false
     end
     
+    should "support finding first instance (sorted by attribute)" do
+      account = SugarCRM::Account.first({
+       	:order_by => 'name'
+      })
+      assert_instance_of SugarCRM::Account, account
+    end
+    
     should "support searching based on conditions" do
       accounts = SugarCRM::Account.all({
-        :conditions => { :billing_address_postalcode => ["> '70000'", "< '72000'" ] },
+        :conditions => { :billing_address_postalcode => ["> '70000'", "< '79999'" ] },
         :limit => '10',
        	:order_by => 'billing_address_postalcode'
       })
-      assert_instance_of Array, accounts
       assert_instance_of SugarCRM::Account, accounts.first
     end
     
@@ -93,11 +106,6 @@ class TestSugarCRM < Test::Unit::TestCase
       assert_equal u.user_name, "admin"
     end
     
-    should "return an email address when sent #email_addresses" do
-      u = SugarCRM::User.find("seed_sarah_id")
-      assert_equal "sarah@example.com", u.email_addresses.first.email_address
-    end
-
     should "return an array of records when sent #find([id1, id2, id3])" do
       users = SugarCRM::User.find(["seed_sarah_id", 1])
       assert_equal "Administrator", users.last.title
@@ -107,7 +115,7 @@ class TestSugarCRM < Test::Unit::TestCase
       u = SugarCRM::User.find_by_user_name("sarah")
       assert_equal "sarah@example.com", u.email_addresses.first.email_address
     end
-
+    
   end
   
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 8
-  - 2
-  version: 0.8.2
+  - 9
+  - 0
+  version: 0.9.0
 platform: ruby
 authors: 
 - Carl Hicks
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-14 00:00:00 -08:00
+date: 2010-12-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -32,24 +32,10 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: json
-  prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
-  type: :runtime
-  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: activesupport
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -60,11 +46,8 @@ dependencies:
         - 0
         version: "3.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.
+  version_requirements: *id002
+description: "A less clunky way to interact with SugarCRM via REST.  Instead of SugarCRM.connection.get_entry(\"Users\", \"1\") you could use SugarCRM::User.find(1).  There is support for collections \xC3\xA0 la SugarCRM::User.find(1).email_addresses, or SugarCRM::Contact.first.meetings << new_meeting.  ActiveRecord style finders are in place, with limited support for conditions and joins."
 email: carl.hicks@gmail.com
 executables: []
 
@@ -80,8 +63,14 @@ files:
 - Rakefile
 - VERSION
 - lib/sugarcrm.rb
-- lib/sugarcrm/association_methods.rb
-- lib/sugarcrm/attribute_methods.rb
+- lib/sugarcrm/associations.rb
+- lib/sugarcrm/associations/association_collection.rb
+- lib/sugarcrm/associations/association_methods.rb
+- lib/sugarcrm/attributes.rb
+- lib/sugarcrm/attributes/attribute_methods.rb
+- lib/sugarcrm/attributes/attribute_serializers.rb
+- lib/sugarcrm/attributes/attribute_typecast.rb
+- lib/sugarcrm/attributes/attribute_validations.rb
 - lib/sugarcrm/base.rb
 - lib/sugarcrm/connection.rb
 - lib/sugarcrm/connection/api/get_available_modules.rb
@@ -108,13 +97,14 @@ files:
 - lib/sugarcrm/connection/api/set_note_attachment.rb
 - lib/sugarcrm/connection/api/set_relationship.rb
 - lib/sugarcrm/connection/api/set_relationships.rb
+- lib/sugarcrm/connection/connection.rb
 - lib/sugarcrm/connection/helper.rb
+- lib/sugarcrm/connection/request.rb
+- lib/sugarcrm/connection/response.rb
 - lib/sugarcrm/dynamic_finder_match.rb
 - lib/sugarcrm/exceptions.rb
 - lib/sugarcrm/module.rb
 - lib/sugarcrm/module_methods.rb
-- lib/sugarcrm/request.rb
-- lib/sugarcrm/response.rb
 - test/connection/test_get_available_modules.rb
 - test/connection/test_get_entries.rb
 - test/connection/test_get_entry.rb
@@ -128,6 +118,8 @@ files:
 - test/connection/test_logout.rb
 - test/connection/test_set_relationship.rb
 - test/helper.rb
+- test/test_association_collection.rb
+- test/test_associations.rb
 - test/test_connection.rb
 - test/test_module.rb
 - test/test_response.rb
@@ -180,6 +172,8 @@ test_files:
 - test/connection/test_logout.rb
 - test/connection/test_set_relationship.rb
 - test/helper.rb
+- test/test_association_collection.rb
+- test/test_associations.rb
 - test/test_connection.rb
 - test/test_module.rb
 - test/test_response.rb

data/lib/sugarcrm/association_methods.rb

@@ -1,46 +0,0 @@
-module SugarCRM; module AssociationMethods
-  
-  module ClassMethods
-    # Returns an array of the module link fields
-    def associations_from_module_link_fields
-      self._module.link_fields.keys
-    end
-  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)
-    collection = 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

@@ -1,170 +0,0 @@
-module SugarCRM; module AttributeMethods
-
-  module ClassMethods
-    # Returns a hash of the module fields from the module
-    def attributes_from_module_fields
-      fields = {}.with_indifferent_access
-      self._module.fields.keys.sort.each do |k|
-        fields[k.to_s] = nil
-      end
-      fields
-    end
-  end
-  
-  # Determines if attributes have been changed
-  def changed?
-    @modified_attributes.length > 0
-  end
-  
-  # Is this a new record?
-  def new?
-    @id.blank?
-  end
-
-  # Converts the attributes hash into format recognizable by Sugar
-  # { :last_name => "Smith"} 
-  # becomes
-  # { :last_name => {:name => "last_name", :value => "Smith"}}
-  def serialize_attributes
-    attr_hash = {}
-    @attributes.each_pair do |name,value|
-      attr_hash[name] = serialize_attribute(name,value)
-    end
-    attr_hash[:id] = serialize_id unless new?
-    attr_hash
-  end
-
-  # Converts the modified_attributes hash into format recognizable by Sugar
-  # { :last_name => {:old => "Smit", :new => "Smith"}} 
-  # becomes
-  # { :last_name => {:name => "last_name", :value => "Smith"}}  
-  def serialize_modified_attributes
-    attr_hash = {}
-    @modified_attributes.each_pair do |name,hash|
-      attr_hash[name] = serialize_attribute(name,hash[:new])
-    end
-    attr_hash[:id] = serialize_id unless new?
-    attr_hash
-  end
-
-  # Checks to see if we have all the neccessary attributes
-  def valid?
-    valid = true
-    self.class._module.required_fields.each do |attribute|
-      case attr_type_for(attribute)
-      when "bool"
-        case @attributes[attribute]
-        when TrueClass
-          next
-        when FalseClass
-          next
-        else
-          @errors.add "#{attribute} must be true or false"
-          valid = false
-        end
-      else 
-        if @attributes[attribute].blank?
-          @errors.add "#{attribute} cannot be blank"
-          valid = false
-        end
-      end
-    end
-    valid
-  end
-  
-  # List the required attributes for save
-  def required_attributes
-    self.class._module.required_fields
-  end
-
-  # Serializes the id
-  def serialize_id
-    {:name => "id", :value => @id.to_s}
-  end
-
-  # Un-typecasts the attribute - false becomes 0
-  def serialize_attribute(name,value)
-    attr_value = value
-    case attr_type_for(name)
-    when "bool"
-      attr_value = 0
-      attr_value = 1 if value
-    end
-    {:name => name, :value => attr_value}
-  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
-  
-  # Returns the attribute type for a given attribute
-  def attr_type_for(attribute)
-    field = self.class._module.fields[attribute]
-    return false unless field
-    field["type"]
-  end
-  
-  # Attempts to typecast each attribute based on the module field type
-  def typecast_attributes
-    @attributes.each_pair do |name,value|
-      attr_type = attr_type_for(name)
-      next unless attr_type
-      case attr_type
-      when "bool"
-        @attributes[name] = (value == "1")
-      end
-    end
-    @attributes
-  end
-
-  # Wrapper around attributes hash
-  def read_attribute(key)
-    @attributes[key]
-  end
-  
-  # Wrapper around attributes hash
-  def write_attribute(key, value)
-    @modified_attributes[key] = { :old => @attributes[key].to_s, :new => value }
-    @attributes[key] = value
-  end
-  
-end; end
-