activerecord-activesalesforce-adapter 2.0.0

data/lib/active_record/connection_adapters/asf_active_record.rb

@@ -0,0 +1,40 @@
+=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
+
+module ActiveSalesforce
+  
+  module ActiveRecord
+    
+    module Mixin
+      def self.append_features(base) #:nodoc:
+        super
+        
+        base.class_eval do  
+          class << self
+            def set_table_name(value = nil, &block)
+              super(value, &block)
+              
+              connection.set_class_for_entity(self, table_name.singularize)
+            end        
+          end
+        end
+      end
+    end
+  
+  end
+
+end

data/lib/active_record/connection_adapters/boxcar_command.rb

@@ -0,0 +1,66 @@
+=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 'pp'
+
+
+module ActiveSalesforce  
+  module BoxcarCommand
+  
+    class Base
+      attr_reader :verb, :args
+      
+      def initialize(connection, verb, args)
+        @connection = connection
+        @verb = verb
+        @args = args
+      end
+      
+      def after_execute(result)
+      end
+    end
+    
+    
+    class Insert < Base
+      def initialize(connection, sobject, idproxy)
+        super(connection, :create, sobject)
+        @idproxy = idproxy
+      end
+      
+      def after_execute(result)
+        id = result[:id]
+        @idproxy << id if id
+      end
+    end
+    
+    
+    class Update < Base
+      def initialize(connection, sobject)
+        super(connection, :update, sobject)
+      end
+    end
+  
+  
+    class Delete < Base
+      def initialize(connection, ids)
+        super(connection, :delete, ids)
+      end
+    end
+
+
+  end  
+end    

data/lib/active_record/connection_adapters/column_definition.rb

@@ -0,0 +1,95 @@
+=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 'pp'
+require 'active_record/connection_adapters/abstract_adapter'
+
+
+module ActiveRecord  
+  module StringHelper
+    def column_nameize(s)
+      s.underscore
+    end
+  end
+  
+  module ConnectionAdapters
+    class SalesforceColumn < Column
+      include StringHelper
+      
+      attr_reader :api_name, :custom, :label, :createable, :updateable, :reference_to
+      
+      def initialize(field)
+        @api_name = field[:name]
+        @custom = field[:custom] == "true"
+        @name = column_nameize(@api_name)
+        @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
+        
+        @createable = field[:createable] == "true"
+        @updateable = field[:updateable] == "true"
+        
+        if field[:type] =~ /reference/i
+          @reference_to = field[:referenceTo]
+          @one_to_many = false
+          @cascade_delete = false
+          
+          @name = @name.chop.chop << "id__c" if @custom
+        end
+      end
+      
+      def is_name?
+        @name_field
+      end 
+      
+      def get_type(field_type)
+          case field_type
+            when /int/i
+              :integer
+            when /currency|percent/i
+              :float
+            when /datetime/i
+              :datetime
+            when /date/i
+              :date
+            when /id|string|textarea/i
+              :text
+            when /phone|fax|email|url/i
+              :string
+            when /blob|binary/i
+              :binary
+            when /boolean/i
+              :boolean
+            when /picklist/i
+              :text
+            when /reference/i
+              :text
+          end
+      end
+      
+      def human_name
+        @label
+      end
+
+    end
+    
+  end
+end    

data/lib/active_record/connection_adapters/entity_definition.rb

@@ -0,0 +1,59 @@
+=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 'pp'
+
+
+module ActiveSalesforce  
+  class EntityDefinition
+    attr_reader :name, :asf_class, :columns, :column_name_to_column, :api_name_to_column, :relationships, :key_prefix
+    
+    def initialize(connection, name, asf_class, columns, relationships, custom, key_prefix)
+      @connection = connection
+      @name = name
+      @asf_class = asf_class
+      @columns = columns
+      @relationships = relationships
+      @custom = custom
+      @key_prefix = key_prefix
+      
+      @column_name_to_column = {}          
+      @columns.each { |column| @column_name_to_column[column.name] = column }
+      
+      @api_name_to_column = {}
+      @columns.each { |column| @api_name_to_column[column.api_name] = column }
+    end
+    
+    def custom?
+      @custom
+    end
+    
+    def api_name
+      @custom ? name + "__c" : name
+    end
+    
+    def layouts
+      return @layouts if @layouts
+      
+      # Lazy load Layout information
+      response = @connection.binding.describeLayout(:sObjectType => api_name)
+      @layouts = @connection.get_result(response, :describeLayout)
+    end
+    
+  end
+  
+end    

data/lib/active_record/connection_adapters/id_resolver.rb

@@ -0,0 +1,84 @@
+=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 'pp'
+
+
+module ActiveSalesforce  
+  class IdResolver
+    attr_reader :object_type_to_ids
+    
+    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] ||= Set.new
+          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    

data/lib/active_record/connection_adapters/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/active_record/connection_adapters/relationship_definition.rb

@@ -0,0 +1,81 @@
+=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 'pp'
+
+
+module ActiveRecord  
+  module StringHelper
+    def column_nameize(s)
+      s.underscore
+    end
+  end
+  
+  module ConnectionAdapters
+ 
+     class SalesforceRelationship
+      include StringHelper
+    
+      attr_reader :name, :api_name, :custom, :foreign_key, :label, :reference_to, :one_to_many
+      
+      def initialize(source, column = nil)
+        if source[:childSObject]
+          relationship = source
+          
+          if relationship[:relationshipName]
+            @api_name = relationship[:relationshipName]
+            @one_to_many = true
+            @label = @api_name
+            @name = column_nameize(@api_name)
+            @custom = false
+          else 
+            @api_name = relationship[:field]
+            @one_to_many = relationship[:cascadeDelete] == "true"
+            @label = relationship[:childSObject].pluralize
+            @custom = relationship[:childSObject].match(/__c$/)
+
+            name = relationship[:childSObject]
+            name = name.chop.chop.chop if custom
+            
+            @name = column_nameize(name.pluralize)
+            @name = @name + "__c" if custom
+          end
+          
+          @reference_to = relationship[:childSObject]
+          
+          @foreign_key = column_nameize(relationship[:field])
+          @foreign_key = @foreign_key.chop.chop << "id__c" if @foreign_key.match(/__c$/)
+        else
+          field = source
+          
+          @api_name = field[:name]
+          @custom = field[:custom] == "true"
+          
+          @api_name = @api_name.chop.chop unless @custom
+          
+          @label = field[:label]
+          @reference_to = field[:referenceTo]
+          @one_to_many = false
+          
+          @foreign_key = column.name
+          @name = column_nameize(@api_name)
+        end
+      end
+    end
+    
+  end
+end