activesalesforce 0.3.8 → 0.3.9

data/README

@@ -25,6 +25,15 @@
   		
 5. proceed using standard Rails development techniques!  	
 
+== Advanced Features
+
+  1. Session ID based Authentication: Add the following to /app/controllers/application.rb to enable SID auth for all controllers
+  
+  		class ApplicationController < ActionController::Base
+  			before_filter ActiveSalesforce::SessionIDAuthenticationFilter
+		end
+		
+  2. Boxcar'ing of updates, inserts, and deletes. Use <YourModel>.transaction() to demark boxcar boundaries.
 
 == Description of contents
 

data/lib/asf_adapter.rb

@@ -27,6 +27,8 @@ require File.dirname(__FILE__) + '/relationship_definition'
 require File.dirname(__FILE__) + '/boxcar_command'
 require File.dirname(__FILE__) + '/entity_definition'
 require File.dirname(__FILE__) + '/asf_active_record'
+require File.dirname(__FILE__) + '/id_resolver'
+require File.dirname(__FILE__) + '/sid_authentication_filter'
 
 
 class ResultArray < Array
@@ -118,7 +120,7 @@ module ActiveRecord
       MAX_BOXCAR_SIZE = 200
       
       attr_accessor :batch_size
-      attr_reader :entity_def_map, :config
+      attr_reader :entity_def_map, :keyprefix_to_entity_def_map, :config
       
       def initialize(connection, logger, connection_options, config)
         super(connection, logger)
@@ -126,6 +128,7 @@ module ActiveRecord
         @connection_options, @config = connection_options, config
         
         @entity_def_map = {}
+        @keyprefix_to_entity_def_map = {}
         
         @command_boxcar = []
         @class_to_entity_map = {}
@@ -424,6 +427,24 @@ module ActiveRecord
       end
       
       
+      def retrieve_field_values(object_type, fields, ids, name = nil) 
+        msg = "retrieve(#{object_type}, [#{ids.to_a.join(', ')}])"
+        log(msg, name) {
+          retrieve_element = []      
+          retrieve_element << :fieldList << fields.to_a.join(", ")
+          retrieve_element << 'type { :xmlns => "urn:sobject.partner.soap.sforce.com" }' << object_type
+          ids.to_a.each { |id| retrieve_element << :ids << id }
+          
+          result = get_result(@connection.retrieve(retrieve_element), :retrieve)
+          
+          result = [ result ] unless result.is_a?(Array)
+          
+          # Remove unwanted :type and normalize :Id if required
+          result.map { |v| v.delete(:type); v[:Id] = v[:Id][0] if v[:Id].is_a? Array; v }
+        }
+      end
+      
+      
       def get_fields(columns, names, values, access_check) 
         fields = {}
         names.each_with_index do | name, n | 
@@ -512,8 +533,13 @@ module ActiveRecord
             end
           end
           
-          entity_def = ActiveSalesforce::EntityDefinition.new(self, entity_name, cached_columns, cached_relationships, custom)
+          key_prefix = metadata[:keyPrefix]
+          
+          entity_def = ActiveSalesforce::EntityDefinition.new(self, entity_name, 
+            cached_columns, cached_relationships, custom, key_prefix)
+            
           @entity_def_map[entity_name] = entity_def
+          @keyprefix_to_entity_def_map[key_prefix] = entity_def
           
           configure_active_record entity_def
           

data/lib/boxcar_command.rb

@@ -63,5 +63,6 @@ module ActiveSalesforce
       end
     end
 
+
   end  
 end    

data/lib/column_definition.rb

@@ -41,6 +41,7 @@ module ActiveRecord
         @type = get_type(field[:type])
         @limit = field[:length]
         @label = field[:label]
+        @name_field = field[:nameField] == "true"
         
         @text = [:string, :text].include? @type
         @number = [:float, :integer].include? @type
@@ -57,6 +58,10 @@ module ActiveRecord
         end
       end
       
+      def is_name?
+        @name_field
+      end 
+      
       def get_type(field_type)
           case field_type
             when /int/i

data/lib/entity_definition.rb

@@ -23,14 +23,15 @@ require 'pp'
 
 module ActiveSalesforce  
   class EntityDefinition
-    attr_reader :name, :columns, :column_name_to_column, :api_name_to_column, :relationships
+    attr_reader :name, :columns, :column_name_to_column, :api_name_to_column, :relationships, :key_prefix
     
-    def initialize(connection, name, columns, relationships, custom)
+    def initialize(connection, name, columns, relationships, custom, key_prefix)
       @connection = connection
       @name = name
       @columns = columns
       @relationships = relationships
       @custom = custom
+      @key_prefix = key_prefix
       
       @column_name_to_column = {}          
       @columns.each { |column| @column_name_to_column[column.name] = column }

data/lib/id_resolver.rb

@@ -0,0 +1,92 @@
+=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 IdResolver
+    
+    def initialize(connection)
+      @connection = connection
+      @object_type_to_ids = {}
+    end
+    
+    
+    def add(record, columns = nil)
+      if columns
+        columns = columns.to_a.map { |column_name| record.column_for_attribute(column_name) }
+      else
+        columns = record.class.columns
+      end
+      
+      columns.each do |column|
+        reference_to = column.reference_to
+        next unless reference_to
+        
+        value = record.send(column.name)
+        if value
+          ids = @object_type_to_ids[reference_to]
+          
+          unless ids
+            ids = Set.new
+            @object_type_to_ids[reference_to] = ids
+          end
+          
+          ids << value
+        end
+      end
+    end
+    
+    
+    def resolve
+      result = {}
+      
+      @object_type_to_ids.each do |object_type, ids|
+        entity_def = @connection.get_entity_def(object_type)
+        
+        fields = (entity_def.columns.reject { |column| not column.is_name? }).map { |column| column.api_name }
+        
+        # DCHASMAN TODO Boxcar into requests of no more than 200 retrieves per request
+        puts "Resolving references to #{object_type}"
+        field_values = @connection.retrieve_field_values(object_type, fields, ids.to_a, "#{self}.resolve()") 
+        
+        field_values.each do |field_value|
+          id = field_value.delete(:Id)
+          result[id] = field_value
+        end
+      end
+      
+      result
+    end
+    
+    
+    def serialize
+      YAML.dump @object_type_to_ids
+    end
+
+
+    def deserialize(source)
+      @object_type_to_ids = YAML.load(source)
+    end
+    
+  end
+  
+end    

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: activesalesforce
 version: !ruby/object:Gem::Version 
-  version: 0.3.8
-date: 2006-02-28 00:00:00 -05:00
+  version: 0.3.9
+date: 2006-03-02 00:00:00 -05:00
 summary: ActiveSalesforce (ASF) is a Rails connection adapter that provides direct access to Salesforce.com hosted data and metadata via the ActiveRecord model layer. Objects, fields, and relationships are all auto surfaced as active record attributes and rels.
 require_paths: 
 - lib
@@ -37,6 +37,7 @@ files:
 - lib/asf_adapter.rb
 - lib/sid_authentication_filter.rb
 - lib/relationship_definition.rb
+- lib/id_resolver.rb
 - lib/asf_active_record.rb
 - test/unit
 - test/unit/recorded_test_case.rb
@@ -98,5 +99,5 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.0.8
+        version: 0.0.9
     version: