activerecord-activesalesforce-adapter 2.0.0

data/lib/active_record/connection_adapters/result_array.rb

@@ -0,0 +1,31 @@
+=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 ResultArray < Array
+    attr_reader :actual_size
+    
+    def initialize(actual_size)
+      @actual_size = actual_size
+    end
+  end
+  
+end    

data/lib/active_record/connection_adapters/rforce.rb

@@ -0,0 +1,361 @@
+=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.
+=end
+
+#  RForce is a simple Ruby binding to the SalesForce CRM system.
+#  Rather than enforcing adherence to the sforce.com schema,
+#  RForce assumes you are familiar with the API.  Ruby method names
+#  become SOAP method names.  Nested Ruby hashes become nested
+#  XML elements.
+#
+#  Example:
+#
+#    binding = RForce::Binding.new 'na1-api.salesforce.com'
+#    binding.login 'username', 'password'
+#    answer = binding.search(
+#      :searchString =>
+#        'find {Some Account Name} in name fields returning account(id)')
+#    account_id = answer.searchResponse.result.searchRecords.record.Id
+#
+#    opportunity = {
+#      :accountId => account_id,
+#      :amount => "10.00",
+#      :name => "New sale",
+#      :closeDate => "2005-09-01",
+#      :stageName => "Closed Won"
+#    }
+#
+#    binding.create 'sObject {"xsi:type" => "Opportunity"}' => opportunity
+#
+
+
+require 'net/https'
+require 'uri'
+require 'zlib'
+require 'stringio'
+require 'rexml/document'
+require 'rexml/xpath'
+require 'rubygems'
+gem 'builder', ">= 2.0.0"
+
+
+module RForce
+
+  #Allows indexing hashes like method calls: hash.key
+  #to supplement the traditional way of indexing: hash[key]
+  module FlashHash
+    def method_missing(method, *args)
+      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.
+        else
+          elements[name] = [elements[name]]
+          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, :assignment_rule_id, :use_default_rule, :update_mru, :client_id, :trigger_user_email, 
+      :trigger_other_email, :trigger_auto_response_email
+
+    #Fill in the guts of this typical SOAP envelope
+    #with the session ID and the body of the SOAP request.
+    Envelope = <<-HERE
+<?xml version="1.0" encoding="utf-8" ?>
+<soap:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+    xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xmlns:partner="urn:partner.soap.sforce.com">
+    xmlns:spartner="urn:sobject.partner.soap.sforce.com">
+  <soap:Header>
+    <partner:SessionHeader soap:mustUnderstand='1'>
+      <partner:sessionId>%s</partner:sessionId>
+    </partner:SessionHeader>
+    <partner:QueryOptions soap:mustUnderstand='1'>
+      <partner:batchSize>%d</partner:batchSize>
+    </partner:QueryOptions>
+    %s
+  </soap:Header>
+  <soap:Body>
+    %s
+  </soap:Body>
+</soap:Envelope>
+    HERE
+
+    AssignmentRuleHeaderUsingRuleId = '<partner:AssignmentRuleHeader soap:mustUnderstand="1"><partner:assignmentRuleId>%s</partner:assignmentRuleId></partner:AssignmentRuleHeader>'
+    AssignmentRuleHeaderUsingDefaultRule = '<partner:AssignmentRuleHeader soap:mustUnderstand="1"><partner:useDefaultRule>true</partner:useDefaultRule></partner:AssignmentRuleHeader>'
+    MruHeader = '<partner:MruHeader soap:mustUnderstand="1"><partner:updateMru>true</partner:updateMru></partner:MruHeader>'
+    ClientIdHeader = '<partner:CallOptions soap:mustUnderstand="1"><partner:client>%s</partner:client></partner:CallOptions>'
+
+    #Connect to the server securely.
+    def initialize(url, sid)
+      init_server(url)
+
+      @session_id = sid
+      @batch_size = DEFAULT_BATCH_SIZE
+    end
+
+
+    def show_debug
+      ENV['SHOWSOAP'] == 'true'
+    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 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)
+      @user = user
+      @password = password
+
+      response = call_remote(:login, [:username, user, :password, password])
+      
+      raise "Incorrect user name / password [#{response.fault}]" unless response.loginResponse
+
+      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.
+    def call_remote(method, args)
+      #Create XML text from the arguments.
+      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
+      extra_headers << (ClientIdHeader % client_id) if client_id
+      
+      if trigger_user_email or trigger_other_email or trigger_auto_response_email
+        extra_headers << '<partner:EmailHeader soap:mustUnderstand="1">'
+        
+        extra_headers << '<partner:triggerUserEmail>true</partner:triggerUserEmail>' if trigger_user_email
+        extra_headers << '<partner:triggerOtherEmail>true</partner:triggerOtherEmail>' if trigger_other_email
+        extra_headers << '<partner:triggerAutoResponseEmail>true</partner:triggerAutoResponseEmail>' if trigger_auto_response_email
+        
+        extra_headers << '</partner:EmailHeader>'
+      end
+
+      #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, 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/1.0'
+      }
+
+      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.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 content =~ /sf:INVALID_SESSION_ID/
+        login(@user, @password)
+
+		#  repackage and rencode request with the new session id
+		request = (Envelope % [@session_id, @batch_size, extra_headers, expanded])
+		request = encode(request)
+
+        #Send the request to the server and read the response.
+        response = @server.post2(@url.path, request.lstrip, 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':
+        begin
+          gzr = Zlib::GzipReader.new(StringIO.new(response.body))
+          decoded = gzr.read
+        ensure
+          gzr.close
+        end
+        decoded
+      else
+        response.body
+      end
+    end
+
+
+    # encode gzip
+    def encode(request)
+      return request if show_debug
+
+      begin
+        ostream = StringIO.new
+        gzw = Zlib::GzipWriter.new(ostream)
+        gzw.write(request)
+        ostream.string
+      ensure
+        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
+        #of a hash of attributes.
+        #
+        #e.g. 'sObject {"xsi:type" => "Opportunity"}'
+        #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
+      end
+    end
+  end
+end

data/lib/active_record/connection_adapters/sid_authentication_filter.rb

@@ -0,0 +1,57 @@
+=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 'set'
+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]
+      
+      if sid
+        api_server_url = params[:api_server_url]
+        
+        # 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
+    
+  end
+
+end
+