copious-activerecord-activesalesforce-adapter 2.3.0 → 2.3.1

data/lib/active_record/connection_adapters/activesalesforce_adapter.rb

@@ -21,7 +21,7 @@ require 'benchmark'
 require 'active_record'
 require 'active_record/connection_adapters/abstract_adapter'
 
-require File.dirname(__FILE__) + '/rforce'
+require File.dirname(__FILE__) + '/../../rforce'
 require File.dirname(__FILE__) + '/column_definition'
 require File.dirname(__FILE__) + '/relationship_definition'
 require File.dirname(__FILE__) + '/boxcar_command'

data/lib/rforce.rb

@@ -0,0 +1,116 @@
+=begin
+RForce v0.3
+Copyright (c) 2005-2008 Ian Dees and contributors
+
+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 'rubygems'
+
+gem 'builder', '>= 2.0.0'
+require 'builder'
+
+gem 'facets', '>= 2.4'
+require 'facets/openhash'
+
+require 'rforce/binding'
+require 'rforce/soap_response_rexml'
+require 'rforce/soap_response_hpricot' rescue nil
+require 'rforce/soap_response_expat' rescue nil
+
+
+module RForce
+  # Use the fastest XML parser available.
+  def self.parser(name)
+      RForce.const_get(name) rescue nil
+  end
+  
+  SoapResponse = 
+    parser(:SoapResponseExpat) ||
+    parser(:SoapResponseHpricot) ||
+    SoapResponseRexml
+  
+  # Expand Ruby data structures into XML.
+  def expand(builder, 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 builder, value; end
+
+      when String
+        builder.tag!(key, attributes) { builder.text! value }
+      end
+    end
+  end
+  
+end

data/lib/rforce/binding.rb

@@ -0,0 +1,202 @@
+module RForce
+  # Implements the connection to the SalesForce server.
+  class Binding
+    include RForce
+    
+    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 = nil)
+      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][:faultstring]}]" 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(@builder, {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).parse
+    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
+  end
+end
+

data/lib/rforce/method_keys.rb

@@ -0,0 +1,14 @@
+module RForce
+  # Allows indexing hashes like method calls: hash.key
+  # to supplement the traditional way of indexing: hash[key]
+  module MethodKeys
+    def method_missing(method, *args)
+      raise NoMethodError unless respond_to?('[]')
+      self[method]
+    end
+  end
+  
+  class MethodHash < Hash
+    include MethodKeys
+  end
+end

data/lib/rforce/soap_pullable.rb

@@ -0,0 +1,90 @@
+module RForce
+  module SoapPullable
+    SOAP_ENVELOPE = 'soapenv:Envelope'
+    
+    # Split off the local name portion of an XML tag.
+    def local(tag)
+      first, second = tag.split ':'
+      return first if second.nil?
+      @namespaces.include?(first) ? second : tag
+    end
+
+    def tag_start(name, attrs)
+      tag_name = local name
+
+      # For shorter hash keys, we can strip any namespaces of the SOAP
+      # envelope tag from the tags inside it.
+      if name == SOAP_ENVELOPE
+        @namespaces = attrs.keys.grep(/xmlns:/).map {|k| k.split(':').last}
+        return
+      end
+            
+      @stack.push OpenHash.new({})
+    end
+    
+    def text(data)
+      @current_value = data.strip.empty? ? nil : data
+    end
+    
+    def tag_end(name)
+      return if @done
+
+      tag_name = local name
+      
+      return if tag_name == SOAP_ENVELOPE
+
+      working_hash = @stack.pop
+
+      # We are either done or working on a certain depth in the current
+      # stack.
+      if @stack.empty?
+        @parsed = working_hash
+        @done = true
+        return
+      else
+        index = @stack.size - 1
+      end
+
+      # working_hash and @current_value have a mutually exclusive relationship.
+      # If the current element doesn't have a value then it means that there
+      # is a nested data structure.  In this case then working_hash is populated
+      # and @current_value is nil.  Conversely, if @current_value has a value
+      # then we do not have a nested data sctructure and working_hash will
+      # be empty.
+      use_value = working_hash.empty? ? @current_value : working_hash
+      tag_sym = tag_name.to_sym
+      element = @stack[index][tag_sym]
+
+      if @stack[index].keys.include? tag_sym
+        # This is here to handle the Id value being included twice and thus
+        # producing an array.  We skip the second instance so the array is
+        # not created.
+        #
+        # We also need to clear out the current value, so that the next
+        # tag doesn't erroneously pick up the value of the Id.
+        if tag_name == 'Id'
+          @current_value = nil
+          return
+        end
+
+        # We are here because the name of our current element is one that
+        # already exists in the hash.  If this is the first encounter with
+        # the duplicate tag_name then we convert the existing value to an
+        # array otherwise we push the value we are working with and add it
+        # to the existing array.
+        if element.is_a?( Array )
+          element << use_value
+        else
+          @stack[index][tag_sym] = [element, use_value]
+        end
+      else
+        # We are here because the name of our current element has not been
+        # assigned yet.
+        @stack[index][tag_sym] = use_value
+      end
+      
+      # We are done with the current tag so reset the data for the next one
+      @current_value = nil
+    end
+  end
+end

data/lib/rforce/soap_response_expat.rb

@@ -0,0 +1,35 @@
+require 'xml/parser'
+require 'rforce/soap_pullable'
+
+module RForce
+  class SoapResponseExpat
+    include SoapPullable
+
+    def initialize(content)
+      @content = content
+    end
+    
+    def parse   
+      @current_value = nil
+      @stack = []
+      @parsed = OpenHash.new({})
+      @done = false
+      @namespaces = []
+
+      XML::Parser.new.parse(@content) do |type, name, data|
+        case type
+        when XML::Parser::START_ELEM
+          tag_start name, data
+        when XML::Parser::CDATA
+          text data
+        when XML::Parser::END_ELEM
+          tag_end name
+        end
+          
+        break if @done
+      end
+
+      @parsed
+    end
+  end
+end

data/lib/rforce/soap_response_hpricot.rb

@@ -0,0 +1,70 @@
+require 'hpricot'
+
+
+module RForce
+  class SoapResponseHpricot
+    # Parses an XML string into structured data.
+    def initialize(content)
+      @content = content
+    end
+
+    # Digests an XML DOM node into nested Ruby types.
+    def parse
+      document = Hpricot.XML(@content)
+      node = document % 'soapenv:Body'
+      self.class.node_to_ruby node
+    end
+    
+    private
+    
+    def self.node_to_ruby(node)
+      # Convert text nodes into simple strings.
+      children = node.children.reject do |c|
+        c.is_a?(Hpricot::Text) && c.to_s.strip.empty?
+      end
+
+      if node.is_a?(Hpricot::Text)
+        return node.inner_text
+      end
+      
+      if children.first.is_a?(Hpricot::Text)
+        return children.first
+      end
+
+      # Convert nodes with children into MethodHashes.
+      elements = OpenHash.new({})
+
+      # Add all the element's children to the hash.
+      children.each do |e|
+        next if e.is_a?(Hpricot::Text) && e.to_s.strip.empty?
+        name = e.name
+        
+        if name.include? ':'
+          name = name.split(':').last
+        end
+        
+        name = name.to_sym
+
+        case elements[name]
+          # The most common case: unique child element tags.
+        when NilClass: elements[name] = node_to_ruby(e)
+
+          # Non-unique child elements become arrays:
+
+          # We've already created the array: just
+          # add the element.
+        when Array: elements[name] << node_to_ruby(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] << node_to_ruby(e)
+        end
+      end
+
+      return elements.empty? ? nil : elements
+    end
+  end
+end

data/lib/rforce/soap_response_rexml.rb

@@ -0,0 +1,34 @@
+require 'rexml/document'
+require 'rexml/xpath'
+require 'rforce/soap_pullable'
+
+
+module RForce
+  # Turns an XML response from the server into a Ruby
+  # object whose methods correspond to nested XML elements.
+  class SoapResponseRexml
+    include SoapPullable
+
+    %w(attlistdecl cdata comment doctype doctype_end elementdecl
+       entity entitydecl instruction notationdecl xmldecl).each do |unused|
+      define_method(unused) {}
+    end
+
+    def initialize(content)
+      @content = content
+    end
+    
+    # Parses an XML string into structured data.
+    def parse
+      @current_value = nil
+      @stack = []
+      @parsed = OpenHash.new({})
+      @done = false
+      @namespaces = []
+
+      REXML::Document.parse_stream @content, self
+      
+      @parsed
+    end
+  end
+end

data/lib/rforce/version.rb

@@ -0,0 +1,3 @@
+module RForce
+  VERSION = '0.3'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: copious-activerecord-activesalesforce-adapter
 version: !ruby/object:Gem::Version 
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors: 
 - Doug Chasman
@@ -13,7 +13,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-12-19 00:00:00 -08:00
+date: 2008-12-31 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -37,8 +37,26 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.2.4
     version: 
+- !ruby/object:Gem::Dependency 
+  name: xmlparser
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0.6"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: facets
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "2.4"
+    version: 
 description: 
-email: dchasman@salesforce.com
+email: jesse@copiousinc.com
 executables: []
 
 extensions: []
@@ -48,7 +66,6 @@ extra_rdoc_files:
 files: 
 - lib/active_record
 - lib/active_record/connection_adapters
-- lib/active_record/connection_adapters/rforce.rb
 - lib/active_record/connection_adapters/relationship_definition.rb
 - lib/active_record/connection_adapters/result_array.rb
 - lib/active_record/connection_adapters/activesalesforce_adapter.rb
@@ -60,6 +77,15 @@ files:
 - lib/active_record/connection_adapters/activesalesforce.rb
 - lib/active_record/connection_adapters/boxcar_command.rb
 - lib/active_record/connection_adapters/recording_binding.rb
+- lib/rforce.rb
+- lib/rforce
+- lib/rforce/binding.rb
+- lib/rforce/method_keys.rb
+- lib/rforce/soap_pullable.rb
+- lib/rforce/soap_response_expat.rb
+- lib/rforce/soap_response_hpricot.rb
+- lib/rforce/soap_response_rexml.rb
+- lib/rforce/version.rb
 - test/unit
 - test/unit/config.yml
 - test/unit/recorded_test_case.rb
@@ -83,10 +109,11 @@ files:
 - test/unit/recorded_results/AsfUnitTestsBasicTest.test_find_a_contact_by_first_name.recording
 - README
 has_rdoc: true
-homepage: http://activesfdc.rubyforge.org/
-post_install_message: "this version is compatible with Rails 2.1,\n  please report any bug in the group\n  http://groups.google.com/group/activesalesforce\n  "
-rdoc_options: []
-
+homepage: http://github.com/copious/activerecord-activesalesforce-adapter
+post_install_message: This version is compatible with Rails 2.1.
+rdoc_options: 
+- --main
+- README
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -108,5 +135,25 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 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.
-test_files: []
-
+test_files: 
+- test/unit
+- test/unit/config.yml
+- test/unit/recorded_test_case.rb
+- test/unit/basic_test.rb
+- test/unit/recorded_results
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_batch_insert.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_read_all_content_columns.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_find_a_contact_by_id.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_create_a_contact.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_count_contacts.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_get_created_by_from_contact.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_use_default_rule.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_assignment_rule_id.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_client_id.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_use_update_mru.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_master_detail.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_add_notes_to_contact.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_find_addresses.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_save_a_contact.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_find_a_contact.recording
+- test/unit/recorded_results/AsfUnitTestsBasicTest.test_find_a_contact_by_first_name.recording

data/lib/active_record/connection_adapters/rforce.rb

@@ -1,361 +0,0 @@
-=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