DerGuteMoritz-rforce 0.4.2

data/bugs/issue-a7a87cb98d29943a49d1608adb68475838ad2e65.yaml

@@ -0,0 +1,22 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Binding#call_remote should use parse()
+desc: Search for uses of the old API (SoapResponse#new) and replace with the new API (SoapResponse#parse).
+type: :bugfix
+component: rforce
+release: "0.3"
+reporter: Ian Dees <undees@gmail.com>
+status: :closed
+disposition: :fixed
+creation_time: 2008-07-28 05:37:21.978938 Z
+references: []
+
+id: a7a87cb98d29943a49d1608adb68475838ad2e65
+log_events: 
+- - 2008-07-28 05:37:24.755692 Z
+  - Ian Dees <undees@gmail.com>
+  - created
+  - ""
+- - 2008-07-28 05:39:29.817686 Z
+  - Ian Dees <undees@gmail.com>
+  - closed issue with disposition fixed
+  - Done.

data/bugs/issue-c92d34e10038ba6b9acfd7e3dfb2b154e463baba.yaml

@@ -0,0 +1,29 @@
+--- !ditz.rubyforge.org,2008-03-06/issue 
+title: Select XML parser at runtime
+desc: |-
+  XML parsing is done by three different classes: SoapResponse, SoapResponseHpricot, and SoapResponseExpat.  The Binding class, in a holdover from the old days, is hard-coded to use SoapResponse.
+  
+  At the very least, we should scan the installed libraries / gems and choose the fastest one available.  We might also allow Binding's initializer to pass in a specific parser.
+type: :task
+component: rforce
+release: "0.3"
+reporter: Ian Dees <undees@gmail.com>
+status: :closed
+disposition: :fixed
+creation_time: 2008-07-23 17:10:22.283059 Z
+references: []
+
+id: c92d34e10038ba6b9acfd7e3dfb2b154e463baba
+log_events: 
+- - 2008-07-23 17:10:29.352269 Z
+  - Ian Dees <undees@gmail.com>
+  - created
+  - ""
+- - 2008-07-28 05:37:48.378891 Z
+  - Ian Dees <undees@gmail.com>
+  - assigned to release 0.3 from unassigned
+  - ""
+- - 2008-07-28 05:39:05.294916 Z
+  - Ian Dees <undees@gmail.com>
+  - closed issue with disposition fixed
+  - Used the simple fix of seeing which constants are defined and assigning SoapResponse based on that.

data/bugs/project.yaml

@@ -0,0 +1,16 @@
+--- !ditz.rubyforge.org,2008-03-06/project 
+name: rforce
+version: "0.3"
+components: 
+- !ditz.rubyforge.org,2008-03-06/component 
+  name: rforce
+releases: 
+- !ditz.rubyforge.org,2008-03-06/release 
+  name: "0.3"
+  status: :unreleased
+  release_time: 
+  log_events: 
+  - - 2008-07-28 05:35:54.153742 Z
+    - Ian Dees <undees@gmail.com>
+    - created
+    - Will be ready for ActiveSalesforce.

data/lib/rforce.rb

@@ -0,0 +1,88 @@
+=begin
+Copyright (c) 2005-2010 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 'https://www.salesforce.com/services/Soap/u/10.0'
+#    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 'rforce/binding'
+require 'rforce/soap_response'
+
+
+module RForce
+  # 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 then
+        builder.tag!(key, attributes) do expand builder, value; end
+
+      when String then
+        builder.tag!(key, attributes) { builder.text! value }
+      end
+    end
+  end
+end

data/lib/rforce/binding.rb

@@ -0,0 +1,261 @@
+require 'net/https'
+require 'uri'
+require 'zlib'
+require 'stringio'
+require 'rexml/document'
+require 'builder'
+require 'oauth' # the 0.3.6 version must be checked out  
+
+
+module RForce
+  # Implements the connection to the SalesForce server.
+  class Binding
+    include RForce
+
+    DEFAULT_BATCH_SIZE = 2000
+    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.  If you pass an oauth hash, it
+    # must contain the keys :consumer_key, :consumer_secret,
+    # :access_token, :access_secret, and :login_url.
+    def initialize(url, sid = nil, oauth = nil)
+      @session_id = sid
+      @oauth = oauth
+      @batch_size = DEFAULT_BATCH_SIZE
+
+      init_server(url)
+    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
+
+
+    def consumer
+       OAuth::Consumer.new(@oauth[:consumer_key], 
+                           @oauth[:consumer_secret], {
+           :site               => "https://login.salesforce.com",
+           :signature_method   => 'HMAC-SHA1', # this is default, but just for clarity
+           :scheme             => :body,
+           :request_token_path => "/_nc_external/system/security/oauth/RequestTokenHandler",
+           :access_token_path  => "/_nc_external/system/security/oauth/AccessTokenHandler",
+           :authorize_path     => '/setup/secur/RemoteAccessAuthorizationPage.apexp',
+          })
+     end
+
+     
+     
+    # Log in to the server with OAuth, remembering
+    # the session ID returned to us by SalesForce.
+    def login_with_oauth
+      # post is method of Oauth::AccessToken, @server is instance of it
+      access_token  = OAuth::AccessToken.new consumer, @oauth[:access_token], @oauth[:access_secret]
+      result = access_token.post @oauth[:login_url]
+      
+      case result
+      when Net::HTTPSuccess
+        doc = REXML::Document.new result.body
+        @session_id = doc.elements['*/sessionId'].text
+        server_url  = doc.elements['*/serverUrl'].text
+        init_server(server_url)
+
+        return {:sessionId => @session_id, :serverUrl => server_url}
+      when Net::HTTPUnauthorized
+        raise "Invalid OAuth tokens=#{@oauth.inspect}"
+      else
+        raise "Unexpected error: #{result.inspect}"
+      end
+    end
+
+
+
+
+    # Log in to the server with a user name and password, remembering
+    # 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)
+
+      urn, soap_url = block_given? ? yield : ["urn:partner.soap.sforce.com", @url.path]
+
+      # Create XML text from the arguments.
+      expanded = ''
+      @builder = Builder::XmlMarkup.new(:target => expanded)
+      expand(@builder, {method => args}, urn)
+
+      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/0.4.1 LH'
+      }
+
+      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(soap_url, 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 && @session_id  && content =~ /sf:INVALID_SESSION_ID/
+        if @oauth
+          login_with_oauth
+        else  
+          login(@user, @password)
+        end  
+
+        # 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(soap_url, 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' then
+        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,93 @@
+require 'rforce/method_keys'
+
+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)
+      # 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 MethodHash.new
+    end
+
+    def text(data)
+      adding = data.strip.empty? ? nil : data
+
+      if adding
+        @current_value = (@current_value || '') + adding
+      end
+    end
+
+    def tag_end(name)
+      return if @done || name == SOAP_ENVELOPE
+
+      tag_name = local name
+      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
+      end
+
+      index = @stack.size - 1
+
+      # 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 structure and working_hash will
+      # be empty.
+      raise 'Parser is confused' unless working_hash.empty? || @current_value.nil?
+
+      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