activesalesforce 0.4.3 → 0.4.4

data/lib/asf_adapter.rb

@@ -30,15 +30,7 @@ require File.dirname(__FILE__) + '/asf_active_record'
 require File.dirname(__FILE__) + '/id_resolver'
 require File.dirname(__FILE__) + '/sid_authentication_filter'
 require File.dirname(__FILE__) + '/recording_binding'
-
-
-class ResultArray < Array
-  attr_reader :actual_size
-  
-  def initialize(actual_size)
-    @actual_size = actual_size
-  end
-end
+require File.dirname(__FILE__) + '/result_array'
 
 
 module ActiveRecord    
@@ -262,11 +254,9 @@ module ActiveRecord
           end
           
           raw_table_name = sql.match(/FROM (\w+)/i)[1]
-          table_name = raw_table_name.singularize
-          entity_name = entity_name_from_table(table_name)
-          entity_def = get_entity_def(entity_name)
+          table_name, columns, entity_def = lookup(raw_table_name)
           
-          column_names = api_column_names(table_name)
+          column_names = columns.map { |column| column.api_name }
           
           # Always (unless COUNT*)'ing) select all columns (required for the AR attributes mechanism to work correctly
           soql = sql.sub(/SELECT .+ FROM/i, "SELECT #{column_names.join(', ')} FROM") unless selectCountMatch
@@ -274,13 +264,13 @@ module ActiveRecord
           soql.sub!(/\s+FROM\s+\w+/i, " FROM #{entity_def.api_name}")
           
           # Look for a LIMIT clause
-          soql.sub!(/LIMIT\s+1/i, "")
+          limit = extract_sql_modifier(soql, "LIMIT")
           
           # Look for an OFFSET clause
-          soql.sub!(/\d+\s+OFFSET\s+\d+/i, "")
+          offset = extract_sql_modifier(soql, "OFFSET")
           
           # Fixup column references to use api names
-          columns = columns_map(table_name)
+          columns = entity_def.column_name_to_column
           soql.gsub!(/((?:\w+\.)?\w+)(?=\s*(?:=|!=|<|>|<=|>=)\s*(?:'[^']*'|NULL|TRUE|FALSE))/mi) do |column_name| 
             # strip away any table alias
             column_name.sub!(/\w+\./, '')
@@ -295,12 +285,14 @@ module ActiveRecord
           soql.sub!(/#{raw_table_name}\./i, "#{entity_def.api_name}.")
           
           @connection.batch_size = @batch_size if @batch_size
+          @connection.batch_size = limit if limit
+          
           @batch_size = nil
           
           queryResult = get_result(@connection.query(:queryString => soql), :query)
           records = queryResult[:records]
           
-          result = ResultArray.new(queryResult[:size].to_i)
+          result = ActiveSalesforce::ResultArray.new(queryResult[:size].to_i)
           return result unless records
           
           records = [ records ] unless records.is_a?(Array)
@@ -324,7 +316,10 @@ module ActiveRecord
               end
             end  
             
-            result << row   
+            result << row
+            
+            # Insure that only LIMIT rows are returned
+            break if limit and result.length >= limit   
           end
           
           if selectCountMatch
@@ -348,9 +343,8 @@ module ActiveRecord
       def insert(sql, name = nil, pk = nil, id_value = nil, sequence_name = nil)
         log(sql, name) {
           # Convert sql to sobject
-          table_name = sql.match(/INSERT\s+INTO\s+(\w+)\s+/i)[1].singularize
-          entity_name = entity_name_from_table(table_name)
-          columns = columns_map(table_name)
+          table_name, columns, entity_def = lookup(sql.match(/INSERT\s+INTO\s+(\w+)\s+/i)[1])
+          columns = entity_def.column_name_to_column
           
           # Extract array of column names
           names = sql.match(/\((.+)\)\s+VALUES/i)[1].scan(/\w+/i)
@@ -363,7 +357,7 @@ module ActiveRecord
           
           fields = get_fields(columns, names, values, :createable)
           
-          sobject = create_sobject(entity_name, nil, fields)
+          sobject = create_sobject(entity_def.api_name, nil, fields)
           
           # Track the id to be able to update it when the create() is actually executed
           id = String.new
@@ -377,9 +371,8 @@ module ActiveRecord
       def update(sql, name = nil) #:nodoc:
         log(sql, name) {
           # Convert sql to sobject
-          table_name = sql.match(/UPDATE\s+(\w+)\s+/i)[1].singularize
-          entity_name = entity_name_from_table(table_name)
-          columns = columns_map(table_name)
+          table_name, columns, entity_def = lookup(sql.match(/UPDATE\s+(\w+)\s+/i)[1])
+          columns = entity_def.column_name_to_column
           
           match = sql.match(/SET\s+(.+)\s+WHERE/mi)[1]
           names = match.scan(/(\w+)\s*=\s*('|NULL|TRUE|FALSE)/i)
@@ -392,7 +385,7 @@ module ActiveRecord
           
           id = sql.match(/WHERE\s+id\s*=\s*'(\w+)'/i)[1]
           
-          sobject = create_sobject(entity_name, id, fields)
+          sobject = create_sobject(entity_def.api_name, id, fields)
           
           @command_boxcar << ActiveSalesforce::BoxcarCommand::Update.new(self, sobject)
         }
@@ -468,6 +461,17 @@ module ActiveRecord
       end
       
       
+      def extract_sql_modifier(soql, modifier)
+          value = soql.match(/\s+#{modifier}\s+(\d+)/i)
+          if value            
+            value = value[1].to_i
+            soql.sub!(/\s+#{modifier}\s+\d+/i, "")
+          end
+          
+          value
+      end
+      
+      
       def get_result(response, method)
         responseName = (method.to_s + "Response").to_sym
         finalResponse = response[responseName]
@@ -538,7 +542,7 @@ module ActiveRecord
           key_prefix = metadata[:keyPrefix]
           
           entity_def = ActiveSalesforce::EntityDefinition.new(self, entity_name, 
-          cached_columns, cached_relationships, custom, key_prefix)
+                                                              cached_columns, cached_relationships, custom, key_prefix)
           
           @entity_def_map[entity_name] = entity_def
           @keyprefix_to_entity_def_map[key_prefix] = entity_def
@@ -613,19 +617,8 @@ module ActiveRecord
       
       
       def columns(table_name, name = nil)
-        entity_name = entity_name_from_table(table_name)
-        get_entity_def(entity_name).columns
-      end
-      
-      
-      def columns_map(table_name, name = nil)
-        entity_name = entity_name_from_table(table_name)
-        get_entity_def(entity_name).column_name_to_column
-      end
-      
-      
-      def entity_name_from_table(table_name)
-        return table_name.singularize.camelize
+        table_name, columns, entity_def = lookup(table_name)
+        entity_def.columns
       end
       
       
@@ -640,11 +633,9 @@ module ActiveRecord
       
       
       def create_sobject(entity_name, id, fields)
-        entity_def = get_entity_def(entity_name)
-        
         sobj = []
         
-        sobj << 'type { :xmlns => "urn:sobject.partner.soap.sforce.com" }' << entity_def.api_name
+        sobj << 'type { :xmlns => "urn:sobject.partner.soap.sforce.com" }' << entity_name
         sobj << 'Id { :xmlns => "urn:sobject.partner.soap.sforce.com" }' << id if id    
         
         # now add any changed fields
@@ -660,10 +651,14 @@ module ActiveRecord
       def column_names(table_name)
         columns(table_name).map { |column| column.name }
       end
+
       
-      
-      def api_column_names(table_name)
-        columns(table_name).map { |column| column.api_name }
+      def lookup(raw_table_name)
+        table_name = raw_table_name.singularize
+        entity_def = get_entity_def(table_name.camelize)
+        columns = entity_def.columns
+        
+        [table_name, columns, entity_def]
       end
       
     end

data/lib/result_array.rb

@@ -0,0 +1,34 @@
+=begin
+  ActiveSalesforce
+  Copyright 2006 Doug Chasman
+ 
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+ 
+     http://www.apache.org/licenses/LICENSE-2.0
+ 
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.
+=end 
+
+require 'rubygems'
+require_gem 'rails', ">= 1.0.0"
+
+require 'pp'
+
+
+module ActiveSalesforce  
+  
+  class ResultArray < Array
+    attr_reader :actual_size
+    
+    def initialize(actual_size)
+      @actual_size = actual_size
+    end
+  end
+  
+end    

data/lib/rforce.rb

@@ -1,24 +1,24 @@
 =begin
-  RForce v0.1
-  Copyright (c) 2005 Ian Dees
-
-  Permission is hereby granted, free of charge, to any person obtaining a copy
-  of this software and associated documentation files (the "Software"), to deal
-  in the Software without restriction, including without limitation the rights
-  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-  copies of the Software, and to permit persons to whom the Software is
-  furnished to do so, subject to the following conditions:
-
-  The above copyright notice and this permission notice shall be included in
-  all copies or substantial portions of the Software.
-
-  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-  SOFTWARE.
+RForce v0.1
+Copyright (c) 2005 Ian Dees
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
 =end
 
 #  RForce is a simple Ruby binding to the SalesForce CRM system.
@@ -59,7 +59,7 @@ require_gem 'builder'
 
 
 module RForce
-
+  
   #Allows indexing hashes like method calls: hash.key
   #to supplement the traditional way of indexing: hash[key]
   module FlashHash
@@ -67,50 +67,50 @@ module RForce
       self[method]
     end
   end
-
+  
   #Turns an XML response from the server into a Ruby
   #object whose methods correspond to nested XML elements.
   class SoapResponse
     include FlashHash
-
+    
     #Parses an XML string into structured data.
     def initialize(content)
       document = REXML::Document.new content
       node = REXML::XPath.first document, '//soapenv:Body'
       @parsed = SoapResponse.parse node
     end
-
+    
     #Allows this object to act like a hash (and therefore
     #as a FlashHash via the include above).
     def [](symbol)
       @parsed[symbol]
     end
-
+    
     #Digests an XML DOM node into nested Ruby types.
     def SoapResponse.parse(node)
       #Convert text nodes into simple strings.
       return node.text unless node.has_elements?
-
+      
       #Convert nodes with children into FlashHashes.
       elements = {}
       class << elements
         include FlashHash
       end
-
+      
       #Add all the element's children to the hash.
       node.each_element do |e|
         name = e.name.to_sym
-
+        
         case elements[name]
           #The most common case: unique child element tags.
         when NilClass: elements[name] = parse(e)
-
+          
           #Non-unique child elements become arrays:
-
+          
           #We've already created the array: just
           #add the element.
         when Array: elements[name] << parse(e)
-
+          
           #We haven't created the array yet: do so,
           #then put the existing element in, followed
           #by the new one.
@@ -119,17 +119,17 @@ module RForce
           elements[name] << parse(e)
         end
       end
-
+      
       return elements
     end
   end
   
-
+  
   #Implements the connection to the SalesForce server.
   class Binding
     DEFAULT_BATCH_SIZE = 10
-    attr_accessor :batch_size, :url
-
+    attr_accessor :batch_size, :url, :assignment_rule_id, :use_default_rule, :update_mru
+    
     #Fill in the guts of this typical SOAP envelope
     #with the session ID and the body of the SOAP request.
     Envelope = <<-HERE
@@ -144,60 +144,66 @@ module RForce
     <QueryOptions>
       <batchSize>%d</batchSize>
     </QueryOptions>
+    %s
   </env:Header>
   <env:Body>
     %s
   </env:Body>
 </env:Envelope>
     HERE
+    
+    AssignmentRuleHeaderUsingRuleId = "<AssignmentRuleHeader><assignment_rule_id>%s</assignment_rule_id></AssignmentRuleHeader>"
+    AssignmentRuleHeaderUsingDefaultRule = "<AssignmentRuleHeader><use_default_rule>true</use_default_rule></AssignmentRuleHeader>"
+    MruHeader = "<MruHeader><update_mru>true</update_mru></MruHeader>"
 
-
+    
     #Connect to the server securely.
     def initialize(url, sid)
       init_server(url)
-
+      
       @session_id = sid
       @batch_size = DEFAULT_BATCH_SIZE
     end
-
-
+    
+    
     def show_debug
       $DEBUG or ENV['SHOWSOAP']
     end
-
+    
     
     def init_server(url)
       @url = URI.parse(url)
       @server = Net::HTTP.new(@url.host, @url.port)
       @server.use_ssl = @url.scheme == 'https'
       @server.verify_mode = OpenSSL::SSL::VERIFY_NONE
-
-      # run ruby with -d to see SOAP wiredumps.
+      
+      # run ruby with -d or env variable SHOWSOAP=true to see SOAP wiredumps.
       @server.set_debug_output $stderr if show_debug
     end
-
-
+    
+    
     #Log in to the server and remember the session ID
     #returned to us by SalesForce.
     def login(user, password)
-      puts "\n\nIn login(#{user})\n\n"
-
       @user = user
       @password = password
-
+      
       response = call_remote(:login, [:username, user, :password, password])
-
-      raise "Incorrect user name / password [#{response.fault}]" unless response.loginResponse
-
+      
+      unless response.loginResponse
+        pp response
+        raise "Incorrect user name / password [#{response.fault}]" 
+      end
+      
       result = response[:loginResponse][:result]
       @session_id = result[:sessionId]
-
+      
       init_server(result[:serverUrl])
-
+      
       response
     end
     
-
+    
     #Call a method on the remote server.  Arguments can be
     #a hash or (if order is important) an array of alternating
     #keys and values.
@@ -206,58 +212,63 @@ module RForce
       expanded = ''
       @builder = Builder::XmlMarkup.new(:target => expanded)
       expand({method => args}, 'urn:partner.soap.sforce.com')
+      
+      extra_headers = ""
+      extra_headers << (AssignmentRuleHeaderUsingRuleId % assignment_rule_id) if assignment_rule_id
+      extra_headers << AssignmentRuleHeaderUsingDefaultRule if use_default_rule
+      extra_headers << MruHeader if update_mru
 
       #Fill in the blanks of the SOAP envelope with our
       #session ID and the expanded XML of our request.
-      request = (Envelope % [@session_id, @batch_size, expanded])
-
+      request = (Envelope % [@session_id, @batch_size, extra_headers, expanded])
+      
       # reset the batch size for the next request
       @batch_size = DEFAULT_BATCH_SIZE
-
+      
       # gzip request
       request = encode(request)
-
+      
       headers = {
         'Connection' => 'Keep-Alive',
         'Content-Type' => 'text/xml',
         'SOAPAction' => '""',
-        'User-Agent' => 'ActiveSalesforce RForce'
+        'User-Agent' => 'ActiveSalesforce'
       }
       
       unless show_debug
         headers['Accept-Encoding'] = 'gzip'
         headers['Content-Encoding'] = 'gzip'
       end
-
+      
       #Send the request to the server and read the response.
-      response = @server.post2(@url.path, request, headers)
-
+      response = @server.post2(@url.path, request.lstrip, headers)
+      
       # decode if we have encoding
       content = decode(response)
-
+      
       # Check to see if INVALID_SESSION_ID was raised and try to relogin in
       if method != :login and @session_id and response =~ /<faultcode>sf\:INVALID_SESSION_ID<\/faultcode>/
         puts "\n\nSession timeout error - auto relogin activated"
-
+        
         login(@user, @password)
-
+        
         #Send the request to the server and read the response.
         response = @server.post2(@url.path, request, headers)
-
+        
         content = decode(response)
       end
-
+      
       SoapResponse.new(content)
     end
     
-
+    
     # decode gzip
     def decode(response)
       encoding = response['Content-Encoding']
-
+      
       # return body if no encoding
       if !encoding then return response.body end
-
+      
       # decode gzip
       case encoding.strip
       when 'gzip':
@@ -273,7 +284,7 @@ module RForce
       end
     end
     
-
+    
     # encode gzip
     def encode(request)
       return request if show_debug
@@ -287,28 +298,28 @@ module RForce
         gzw.close
       end
     end
-
-
+    
+    
     #Turns method calls on this object into remote SOAP calls.
     def method_missing(method, *args)
       unless args.size == 1 && [Hash, Array].include?(args[0].class)
         raise 'Expected 1 Hash or Array argument'
       end
-
+      
       call_remote method, args[0]
     end
     
-
+    
     #Expand Ruby data structures into XML.
     def expand(args, xmlns = nil)
       #Nest arrays: [:a, 1, :b, 2] => [[:a, 1], [:b, 2]]
       if (args.class == Array)
         args.each_index{|i| args[i, 2] = [args[i, 2]]}
       end
-
+      
       args.each do |key, value|
         attributes = xmlns ? {:xmlns => xmlns} : {}
-
+        
         #If the XML tag requires attributes,
         #the tag name will contain a space
         #followed by a string representation
@@ -318,16 +329,16 @@ module RForce
         #becomes <sObject xsi:type="Opportunity>...</sObject>
         if key.is_a? String
           key, modifier = key.split(' ', 2)
-
+          
           attributes.merge!(eval(modifier)) if modifier
         end
-
+        
         #Create an XML element and fill it with this
         #value's sub-items.
         case value
         when Hash, Array
           @builder.tag!(key, attributes) do expand value; end
-
+          
         when String
           @builder.tag!(key, attributes) { @builder.text! value }
         end

data/test/unit/basic_test.rb

@@ -17,10 +17,10 @@
 
 require 'rubygems'
 
-#require_gem 'activesalesforce', '>= 0.2.6'
-require 'activesalesforce'
+#require_gem 'activesalesforce', '>= 0.4.3'
+require File.dirname(__FILE__) + '/../../lib/activesalesforce'
 
-require 'recorded_test_case'
+require File.dirname(__FILE__) + '/recorded_test_case'
 require 'pp'
 
 
@@ -30,6 +30,9 @@ end
 class Department < ActiveRecord::Base
 end
 
+class Address < ActiveRecord::Base
+end
+
 
 module Asf
   module UnitTests
@@ -42,7 +45,7 @@ module Asf
       def initialize(test_method_name)
         super(test_method_name)
         
-        #force_recording :test_batch_insert
+        #force_recording :test_master_detail
       end
       
       def setup
@@ -51,6 +54,9 @@ module Asf
         super
 
         @contact = Contact.new
+        
+        reset_header_options
+        
         contact.first_name = 'DutchTestFirstName'
         contact.last_name = 'DutchTestLastName'
         contact.home_phone = '555-555-1212'
@@ -60,10 +66,19 @@ module Asf
       end
       
       def teardown
+        reset_header_options
+      
         contact.destroy if contact
 
         super
       end
+      
+      def reset_header_options
+        binding = Contact.connection.binding
+        binding.assignment_rule_id = nil
+        binding.use_default_rule = false
+        binding.update_mru = false      
+      end
 
 
       def test_create_a_contact
@@ -101,6 +116,23 @@ module Asf
         user = contact.created_by
         assert_equal contact.created_by_id, user.id
       end
+      
+      def test_use_update_mru
+        Contact.connection.binding.update_mru = true
+        contact.save
+      end
+
+      def test_use_default_rule
+        Contact.connection.binding.use_default_rule = true
+        contact.save
+      end
+
+      def test_assignment_rule_id
+        Contact.connection.binding.assignment_rule_id = "1234567890"
+        contact.save
+      end
+      
+      
  
       def test_add_notes_to_contact
         n1 = Note.new(:title => "My Title", :body => "My Body")
@@ -155,6 +187,10 @@ module Asf
           c1.destroy
         end
       end
+      
+      def test_find_addresses
+        adresses = Address.find(:all)
+      end
                   
     end