activesalesforce 0.4.0 → 0.4.2

data/lib/asf_adapter.rb

@@ -1,23 +1,23 @@
 =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.
+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 'thread'  
 require 'benchmark'
 
@@ -29,6 +29,7 @@ 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'
+require File.dirname(__FILE__) + '/recording_binding'
 
 
 class ResultArray < Array
@@ -51,12 +52,19 @@ module ActiveRecord
       # Default to production system using 7.0 API
       url = config[:url]
       url = "https://www.salesforce.com/services/Soap/u/7.0" unless url
-
+      
       sid = config[:sid]  
-      binding = config[:binding] if config[:binding]
+      username = config[:username]
+      password = config[:password]
       
-      if binding
-        logger.debug("   via provided binding #{binding}\n")
+      # Recording/playback support      
+      recording_source = config[:recording_source]
+      recording = config[:recording]
+      
+      if recording_source
+        recording_source = File.open(recording_source, recording ? "w" : "r")
+        binding = ActiveSalesforce::RecordingBinding.new(url, nil, recording != nil, recording_source, logger)
+        binding.login(username, password) unless sid
       end
       
       if sid
@@ -74,10 +82,7 @@ module ActiveRecord
         ConnectionAdapters::SalesforceAdapter.new(binding, logger, [url, sid], config)
       else
         # Check to insure that the second to last path component is a 'u' for Partner API
-        raise ConnectionAdapters::SalesforceError.new(logger, "Invalid salesforce server url '#{url}', must be a valid Parter API URL") unless url.match(/\/u\//i)
-        
-        username = config[:username]
-        password = config[:password]
+        raise ActiveSalesforce::ASFError.new(logger, "Invalid salesforce server url '#{url}', must be a valid Parter API URL") unless url.match(/\/u\//i)
         
         binding = @@cache["#{url}.#{username}.#{password}"] unless binding
         
@@ -86,7 +91,7 @@ module ActiveRecord
           
           seconds = Benchmark.realtime {
             binding = RForce::Binding.new(url, sid)
-            binding.login(username, password).result
+            binding.login(username, password)
             
             @@cache["#{url}.#{username}.#{password}"] = binding
           }
@@ -98,25 +103,13 @@ module ActiveRecord
       end
     end
   end
-
+  
   
   module ConnectionAdapters
-    class SalesforceError < RuntimeError
-      attr :fault
-      
-      def initialize(logger, message, fault = nil)
-        super message
-        
-        @fault = fault
-        
-        logger.debug("\nSalesforceError:\n   message='#{message}'\n   fault='#{fault}'\n\n")
-      end
-    end
-    
     
     class SalesforceAdapter < AbstractAdapter
       include StringHelper
- 
+      
       MAX_BOXCAR_SIZE = 200
       
       attr_accessor :batch_size
@@ -221,7 +214,7 @@ module ActiveRecord
         unless errors.empty?
           message = errors.join("\n")
           fault = (errors.map { |error| error[:message] }).join("\n")
-          SalesforceError.new(@logger, message, fault) 
+          ActiveSalesforce::ASFError.new(@logger, message, fault) 
         end
         
         result
@@ -293,7 +286,7 @@ module ActiveRecord
             column_name.sub!(/\w+\./, '')
             
             column = columns[column_name]
-            raise SalesforceError.new(@logger, "Column not found for #{column_name}!") unless column
+            raise ActiveSalesforce::ASFError.new(@logger, "Column not found for #{column_name}!") unless column
             
             column.api_name
           end
@@ -440,7 +433,16 @@ module ActiveRecord
           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 }
+          field_values = []
+          result.each do |v| 
+            v = v.dup
+            v.delete(:type)
+            v[:Id] = v[:Id][0] if v[:Id].is_a? Array
+            
+            field_values << v
+          end
+          
+          field_values
         }
       end
       
@@ -453,7 +455,7 @@ module ActiveRecord
           if value
             column = columns[name]
             
-            raise SalesforceError.new(@logger, "Column not found for #{name}!") unless column
+            raise ActiveSalesforce::ASFError.new(@logger, "Column not found for #{name}!") unless column
             
             value.gsub!(/''/, "'") if value.is_a? String
             
@@ -470,7 +472,7 @@ module ActiveRecord
         responseName = (method.to_s + "Response").to_sym
         finalResponse = response[responseName]
         
-        raise SalesforceError.new(@logger, response[:Fault][:faultstring], response.fault) unless finalResponse
+        raise ActiveSalesforce::ASFError.new(@logger, response[:Fault][:faultstring], response.fault) unless finalResponse
         
         result = finalResponse[:result]
       end       
@@ -480,7 +482,7 @@ module ActiveRecord
         result = [ result ] unless result.is_a?(Array)
         
         result.each do |r|
-          raise SalesforceError.new(@logger, r[:errors], r[:errors][:message]) unless r[:success] == "true"
+          raise ActiveSalesforce::ASFError.new(@logger, r[:errors], r[:errors][:message]) unless r[:success] == "true"
         end
         
         result
@@ -494,7 +496,7 @@ module ActiveRecord
           # Check for the loss of asf AR setup 
           entity_klass = class_from_entity_name(entity_name)
           
-          configure_active_record cached_entity_def unless entity_klass.respond_to?(:asf_augmented?)
+          configure_active_record(cached_entity_def) unless entity_klass.respond_to?(:asf_augmented?)
           
           return cached_entity_def 
         end
@@ -506,7 +508,7 @@ module ActiveRecord
           begin
             metadata = get_result(@connection.describeSObject(:sObjectType => entity_name), :describeSObject)
             custom = false
-          rescue SalesforceError => e
+          rescue ActiveSalesforce::ASFError => e
             # Fallback and see if we can find a custom object with this name
             @logger.debug("   Unable to find medata for '#{entity_name}', falling back to custom object name #{entity_name + "__c"}")
             
@@ -536,8 +538,8 @@ 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
           
@@ -558,6 +560,9 @@ module ActiveRecord
           end
         end
         
+        # Add support for SID-based authentication
+        ActiveSalesforce::SessionIDAuthenticationFilter.register(klass)
+        
         klass.set_inheritance_column nil
         klass.set_primary_key "id" 
         klass.lock_optimistically = false
@@ -625,12 +630,12 @@ module ActiveRecord
       
       
       def class_from_entity_name(entity_name)
-          entity_klass = @class_to_entity_map[entity_name.upcase]
-          @logger.debug("Found matching class '#{entity_klass}' for entity '#{entity_name}'") if entity_klass
-          
-          entity_klass = entity_name.constantize unless entity_klass
-                    
-          entity_klass
+        entity_klass = @class_to_entity_map[entity_name.upcase]
+        @logger.debug("Found matching class '#{entity_klass}' for entity '#{entity_name}'") if entity_klass
+        
+        entity_klass = entity_name.constantize unless entity_klass
+        
+        entity_klass
       end
       
       

data/lib/id_resolver.rb

@@ -23,6 +23,7 @@ require 'pp'
 
 module ActiveSalesforce  
   class IdResolver
+    attr_reader :object_type_to_ids
     
     def initialize(connection)
       @connection = connection
@@ -43,13 +44,7 @@ module ActiveSalesforce
         
         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 = @object_type_to_ids[reference_to] ||= Set.new
           ids << value
         end
       end

data/lib/recording_binding.rb

@@ -0,0 +1,90 @@
+=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 'yaml'
+
+
+module ActiveSalesforce  
+  
+  class ASFError < RuntimeError
+    attr :fault
+    
+    def initialize(logger, message, fault = nil)
+      super message
+      
+      @fault = fault
+      
+      logger.debug("\nASFError:\n   message='#{message}'\n   fault='#{fault}'\n\n")
+    end
+  end
+  
+  
+  class ASFRecordingBindingError < ASFError
+    def initialize(logger, message)
+      super(logger, message)    
+    end
+  end
+  
+  
+  class RecordingBinding < RForce::Binding
+    
+    attr_reader :recorded_responses
+    
+    def initialize(url, sid, recording, recording_source, logger)
+      super(url, sid) 
+      
+      @recording = recording
+      @recorded_responses = {}
+      @recording_source = recording_source
+      @logger = logger
+      
+      unless @recording
+        YAML.load_documents(recording_source) do |recorded_response|
+          @recorded_responses.merge!(recorded_response)
+        end
+      end
+    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.
+    def call_remote(method, args)
+      # Blank out username and password
+      safe_args = args.inject([]) {|memo, v| memo << ((memo.last == :username or memo.last == :password) ? "" : v) }
+      key = "#{method}(#{safe_args.join(':')})"
+      
+      if @recording
+        response = super(method, args)
+        
+        unless @recorded_responses[key]
+          # track this { key => request } to avoid duplication in the YAML
+          @recorded_responses[key] = true
+          
+          YAML.dump({ key, response }, @recording_source)
+        end
+      else
+        response = @recorded_responses[key]
+        raise ASFRecordingBindingError.new(@logger, "Unable to find matching response for recorded request '#{key}'") unless response
+      end
+      
+      response
+    end
+    
+  end
+  
+end

data/lib/rforce.rb

@@ -180,6 +180,8 @@ module RForce
     #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
 

data/lib/sid_authentication_filter.rb

@@ -16,6 +16,7 @@
 =end
 
 require 'rubygems'
+require 'set'
 require_gem 'rails', ">= 1.0.0"
 
 require 'pp'
@@ -24,17 +25,37 @@ require 'pp'
 module ActiveSalesforce  
   
   class SessionIDAuthenticationFilter
+    @@klasses = Set.new
   
+  
+    def self.register(klass)
+      @@klasses.add(klass)
+    end
+    
+    
     def self.filter(controller)
       # Look to see if a SID was passed in the URL
       params = controller.params
       sid = params[:sid]
+      
+      puts "Checking for the presence of a SID for [#{@@klasses.to_a.join(', ')}]"
+      
       if sid
         api_server_url = params[:api_server_url]
         api_server_url = 'http://na1-api.salesforce.com/services/Soap/u/7.0' unless api_server_url
         
         puts "asf_sid_authenticate(:sid => '#{sid}', :url => '#{api_server_url}')"
-        Contact.establish_connection(:adapter => 'activesalesforce', :sid => sid, :url => api_server_url) if sid
+        
+        # Iterate over all classes that have registered for SID auth support
+        connection = nil
+        @@klasses.each do |klass|
+          unless connection
+            klass.establish_connection(:adapter => 'activesalesforce', :sid => sid, :url => api_server_url)
+            connection = klass.connection
+          else
+            klass = connection
+          end
+        end
       end
     end
     

data/test/unit/recorded_test_case.rb

@@ -31,9 +31,7 @@ module Asf
       LOGGER = Logger.new(STDOUT)
       @@config = YAML.load_file(File.dirname(__FILE__) + '/config.yml').symbolize_keys
     
-      attr_reader :connection
-      
-      
+
       def recording?
         @recording
       end
@@ -66,36 +64,20 @@ module Asf
     
         @recording = (((not File.exists?(recording_file_name)) or config[:recording]) or @force_recording.include?(method_name.to_sym))
         
-        @connection = MockBinding.new(url, nil, recording?)
+        action = { :adapter => 'activesalesforce', :username => config[:username], 
+          :password => config[:password], :recording_source => recording_file_name, }
+        
+        action[:recording] = true if @recording
 
         ActiveRecord::Base.logger = LOGGER
         ActiveRecord::Base.clear_connection_cache!
         ActiveRecord::Base.reset_column_information_and_inheritable_attributes_for_all_subclasses
-        ActiveRecord::Base.establish_connection(:adapter => 'activesalesforce', :username => config[:username], 
-          :password => config[:password], :binding => connection)
-            
-        unless recording?
-          File.open(recording_file_name) do |f|
-            puts "Opening recorded binding #{recording_file_name}"
-            connection.load(f)
-          end
-        end
+        ActiveRecord::Base.establish_connection(action)
         
-        response = connection.login(config[:username], config[:password])  
+        @connection = ActiveRecord::Base.connection
       end
       
       
-      def teardown
-        if recording?
-          puts "Saving recorded binding #{recording_file_name}"
-
-          File.open(recording_file_name, "w") do |f|
-            connection.save(f)
-          end
-        end 
-      end
-    
-      
       def recording_file_name
         File.dirname(__FILE__) + "/recorded_results/#{self.class.name.gsub('::', '')}.#{method_name}.recording"
       end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.11
 specification_version: 1
 name: activesalesforce
 version: !ruby/object:Gem::Version 
-  version: 0.4.0
-date: 2006-03-02 00:00:00 -05:00
+  version: 0.4.2
+date: 2006-03-03 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
@@ -29,10 +29,10 @@ authors:
 - Doug Chasman
 files: 
 - lib/boxcar_command.rb
+- lib/recording_binding.rb
 - lib/column_definition.rb
 - lib/activesalesforce.rb
 - lib/entity_definition.rb
-- lib/mock_binding.rb
 - lib/rforce.rb
 - lib/asf_adapter.rb
 - lib/sid_authentication_filter.rb

data/lib/mock_binding.rb

@@ -1,70 +0,0 @@
-=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 'yaml'
-require File.dirname(__FILE__) + '/rforce'
-
-
-class MockBinding < RForce::Binding
-  attr_reader :recorded_responses
-  
-  #Connect to the server securely.
-  def initialize(url, sid, recording)
-    @recording = recording
-    @recorded_responses = {}
-    
-    super(url, sid) if @recording
-  end
-  
-  
-  def save(f)
-    YAML.dump(@recorded_responses, f)
-  end
-  
-  
-  def load(f)
-    @recorded_responses = YAML.load(f)
-  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.
-  def call_remote(method, args)
-    # Blank out username and password
-    safe_args = args.inject([]) {|memo, v| memo << ((memo.last == :username or memo.last == :password) ? "" : v) }
-    key = "#{method}(#{safe_args.join(':')})"
-    
-    if @recording
-      response = super(method, args)
-      @recorded_responses[key] = response
-    else
-      response = @recorded_responses[key]
-      
-      unless response
-        @recorded_responses.each do |request, reponse|
-          #pp request
-        end
-        
-        raise "Unable to find matching response for recorded request '#{key}'" 
-      end
-    end
-    
-    response
-  end
-  
-end