rforce 0.8.1 → 0.9

data/History.txt

@@ -1,3 +1,10 @@
+== 0.9.0 2012-09-03
+* 1 minor enhancement
+  * Automatically correct duplicate ID fields (Tomas Svarovsky)
+* 1 bug fix
+  * Removed QueryOptions SOAP header when no block passed to
+    call_remote (clicrdv)
+
 == 0.8.1 2012-01-29
 * 1 minor enhancement
   * Updated history file

data/Manifest.txt

@@ -1,4 +1,3 @@
-.gemtest
 History.txt
 Manifest.txt
 README.txt

data/README.txt

@@ -47,10 +47,7 @@ Rather than enforcing adherence to the sforce.com schema, RForce assumes you are
       'find {McFakerson Co} in name fields returning account(id)'
 
   account = answer.searchResponse.result.searchRecords.record
-  account = account.first if account.is_a? Array
-
   account_id = account.Id
-  account_id = account_id.first if account_id.is_a? Array
 
 === Creating a record
 
@@ -76,7 +73,7 @@ Rather than enforcing adherence to the sforce.com schema, RForce assumes you are
 
 == LICENSE:
 
-Copyright (c) 2005-2011 Ian Dees and contributors
+Copyright (c) 2005-2012 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

data/Rakefile

@@ -15,6 +15,9 @@ Hoe.spec 'rforce' do
 
   self.extra_dev_deps << ['rspec', '~> 2.8']
   self.extra_dev_deps << ['hoe-gemspec2', '~> 1.1']
+  self.extra_dev_deps << ['hpricot', '~> 0.8']
+  self.extra_dev_deps << ['nokogiri', '~> 1.5']
+  self.extra_dev_deps << ['xmlparser', '~> 0.7']
 
   self.rdoc_locations = ['undees@rforce.rubyforge.org:/var/www/gforge-projects/rforce']
   self.remote_rdoc_dir = ''

data/lib/rforce/binding.rb

@@ -30,9 +30,6 @@ module RForce
     <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>
@@ -41,6 +38,7 @@ module RForce
 </soap:Envelope>
     HERE
 
+    QueryOptions = '<partner:QueryOptions soap:mustUnderstand=\'1\'><partner:batchSize>%d</partner:batchSize></partner:QueryOptions>'
     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>'
@@ -159,6 +157,12 @@ module RForce
       expand(@builder, {method => args}, urn)
 
       extra_headers = ""
+      
+      # QueryOptions is not valid when making an Apex Webservice SOAP call
+      if !block_given?
+        extra_headers << (QueryOptions % @batch_size)
+      end
+      
       extra_headers << (AssignmentRuleHeaderUsingRuleId % assignment_rule_id) if assignment_rule_id
       extra_headers << AssignmentRuleHeaderUsingDefaultRule if use_default_rule
       extra_headers << MruHeader if update_mru
@@ -176,7 +180,7 @@ module RForce
 
       # 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])
+      request = (Envelope % [@session_id, extra_headers, expanded])
 
       # reset the batch size for the next request
       @batch_size = DEFAULT_BATCH_SIZE

data/lib/rforce/soap_pullable.rb

@@ -54,7 +54,7 @@ module RForce
       # be empty.
       raise 'Parser is confused' unless working_hash.empty? || @current_value.nil?
 
-      use_value = working_hash.empty? ? @current_value : working_hash
+      use_value = working_hash.empty? ? convert(@current_value) : working_hash
       tag_sym = tag_name.to_sym
       element = @stack[index][tag_sym]
 
@@ -82,12 +82,24 @@ module RForce
         end
       else
         # We are here because the name of our current element has not been
-        # assigned yet.
-        @stack[index][tag_sym] = use_value
+        # assigned yet; anything inside 'records' should be an array
+        @stack[index][tag_sym] = (:records == tag_sym ? [use_value] : use_value)
       end
 
       # We are done with the current tag so reset the data for the next one
       @current_value = nil
     end
+
+    def convert(string)
+      return nil if string.nil?
+      s = string.strip
+
+      case s
+      when '' then nil
+      when /^\d+$/ then Integer(s)
+      when 'true', 'false' then ('true' == s)
+      else s
+      end
+    end
   end
 end

data/lib/rforce/soap_response_hpricot.rb

@@ -29,11 +29,11 @@ module RForce
       end
 
       if node.is_a?(Hpricot::Text)
-        return SoapResponseHpricot.unescapeXML(node.inspect[1..-2])
+        return convert(SoapResponseHpricot.unescapeXML(node.inspect[1..-2]))
       end
 
       if children.first.is_a?(Hpricot::Text)
-        return SoapResponseHpricot.unescapeXML(children.first.inspect[1..-2])
+        return convert(SoapResponseHpricot.unescapeXML(children.first.inspect[1..-2]))
       end
 
       # Convert nodes with children into MethodHashes.
@@ -52,18 +52,22 @@ module RForce
 
         case elements[name]
           # The most common case: unique child element tags.
-        when NilClass then elements[name] = node_to_ruby(e)
+        when NilClass then
+          # <records> contents are always arrays
+          elements[name] = :records == name ? [node_to_ruby(e)] : node_to_ruby(e)
 
           # Non-unique child elements become arrays:
 
           # We've already created the array: just
           # add the element.
-        when Array then elements[name] << node_to_ruby(e)
+        when Array then
+          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
+          next if :Id == name # avoid duplicate <Id> tags
           elements[name] = [elements[name]]
           elements[name] << node_to_ruby(e)
         end
@@ -71,5 +75,17 @@ module RForce
 
       return elements.empty? ? nil : elements
     end
+
+    def self.convert(string)
+      return nil if string.nil?
+      s = string.strip
+
+      case s
+      when '' then nil
+      when /^\d+$/ then Integer(s)
+      when 'true', 'false' then ('true' == s)
+      else s
+      end
+    end
   end
 end

data/lib/rforce/soap_response_nokogiri.rb

@@ -12,34 +12,54 @@ module RForce
       to_hash(body)
     end
 
-    private
+  private
+
     def to_hash(node)
-      if node.text?
-        stripped = node.text.strip
-        return stripped.empty? ? nil : stripped
-      end
+      return parse_text(text) if node.text?
 
       children = node.children.reject {|c| c.text? && c.text.strip.empty? }
 
       return nil if children.empty?
 
-      return children.first.text.strip if children.first.text?
+      if (child = children.first).text?
+        return parse_text(child.text)
+      end
 
       elements = MethodHash.new
 
       children.each do |elem|
         name = elem.name.split(":").last.to_sym
-        
+
         if !elements[name]
-          elements[name] = to_hash(elem)
+          # anything inside 'records' should be an array
+          elements[name] = elem.name == 'records' ? [to_hash(elem)] : to_hash(elem)
         elsif Array === elements[name]
           elements[name] << to_hash(elem)
         else
+          next if elem.name == "Id" # Id fields are duplicated
           elements[name] = [elements[name]] << to_hash(elem)
         end
       end
-      
+
       return elements.empty? ? nil : elements
     end
+
+    def parse_text(text)
+      text.strip!
+
+      return nil if text.empty?
+
+      text = Integer(text) rescue text # parse numbers
+
+      boolean?(text) ? boolean(text) : text
+    end
+
+    def boolean(string)
+      string == "true"
+    end
+
+    def boolean?(string)
+      %w{true false}.include?(string)
+    end
   end
 end

data/lib/rforce/version.rb

@@ -1,3 +1,3 @@
 module RForce
-  VERSION = '0.8.1'
+  VERSION = '0.9'
 end

data/spec/rforce_spec.rb

@@ -50,8 +50,8 @@ describe 'a SoapResponse implementation' do
     @contents = File.open(fname) {|f| f.read}
 
     [:rexml, :expat, :hpricot, :nokogiri].each do |processor|
-      name = "SoapResponse#{processor.to_s.capitalize}"
-      variable = "@#{processor}_recs"
+      name     = "SoapResponse#{processor.to_s.capitalize}".to_sym
+      variable = "@#{processor}_recs".to_sym
 
       results = begin
         klass = RForce.const_get name
@@ -70,33 +70,19 @@ describe 'a SoapResponse implementation' do
   end
 
   it 'returns the same results with expat' do
-    pending 'duplicate <Id> tags'
     @expat_recs.should == @rexml_recs
   end
 
   it 'returns the same results with hpricot' do
-    pending 'duplicate <Id> tags'
     @hpricot_recs.should == @rexml_recs
   end
 
-  it 'returns similar results with expat' do
-    pending 'expat not installed' unless @expat_recs
-    @expat_recs.should resemble(@rexml_recs)
-  end
-
-  it 'returns similar results with hpricot' do
-    pending 'hpricot not installed' unless @hpricot_recs
-    @hpricot_recs.should resemble(@rexml_recs)
-  end
-
   it 'understands XML entities' do
     expected = "Bee's knees"
     @rexml_recs.first.Description.should == expected
 
-    pending 'expat not installed' unless @expat_recs
     @expat_recs.first.Description.should == expected
 
-    pending 'hpricot not installed' unless @hpricot_recs
     @hpricot_recs.first.Description.should == expected
   end
 end
@@ -109,15 +95,16 @@ describe 'SoapResponseHpricot' do
   end
 end
 
-describe 'SoapResponseNokogiri' do
-    SOAP_WRAPPER = <<-XML
+SOAP_WRAPPER = <<-XML
 <?xml version="1.0" encoding="UTF-8"?>
 <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:sf="urn:sobject.partner.soap.sforce.com">
   <soapenv:Body>
     %s
-  </soapnenv:Body>
+  </soapenv:Body>
 </soapenv:Envelope>
 XML
+
+shared_examples_for 'a SOAP response' do
   def wrap_in_salesforce_envelope(xml)
     SOAP_WRAPPER % xml
   end
@@ -128,7 +115,7 @@ XML
       <bar>Bin</bar>
     </foo>""")
 
-    SoapResponseNokogiri.new(xml).parse.should == {:foo => {:bar => "Bin"}}
+    klass.new(xml).parse.should == {:foo => {:bar => "Bin"}}
   end
 
   it 'parses repeated elements into arrays' do
@@ -138,34 +125,100 @@ XML
       <bar>Bash</bar>
     </foo>""")
 
-    SoapResponseNokogiri.new(xml).parse.should == {:foo => {:bar => ["Bin", "Bash"]}}
+    klass.new(xml).parse.should == {:foo => {:bar => ["Bin", "Bash"]}}
+  end
+
+  it 'parses records with single record as an array' do
+    xml = wrap_in_salesforce_envelope("""
+    <records>
+      <sf:type>Contact</sf:type>
+    </records>""")
+
+    klass.new(xml).parse.should == {:records => [{:type => "Contact"}]}
+  end
+
+  it 'parses records with multiple records as an array' do
+    xml = wrap_in_salesforce_envelope("""
+    <records>
+      <sf:type>Contact</sf:type>
+    </records>
+    <records>
+      <sf:type>Contact</sf:type>
+    </records>""")
+
+    klass.new(xml).parse.should == {:records => [{:type => "Contact"}, {:type => "Contact"}]}
+  end
+
+  it 'parses Id array as single string' do
+    xml = wrap_in_salesforce_envelope("""
+    <foo>
+      <sf:Id>some_id</sf:Id>
+      <sf:Id>some_id</sf:Id>
+    </foo>""")
+
+    klass.new(xml).parse.should == {:foo => {:Id => "some_id"}}
+  end
+
+  it 'parses booleans and numbers' do
+    xml = wrap_in_salesforce_envelope("""
+    <foo>
+      <size>20</size>
+      <done>true</done>
+      <more>false</more>
+      <string>normal string</string>
+    </foo>""")
+
+    klass.new(xml).parse.should == {:foo => {:size => 20, :done => true, :more => false, :string => "normal string"}}
   end
 
   it 'disregards namespacing when determining hash keys' do
     xml = wrap_in_salesforce_envelope("""
     <soapenv:foo>
       <bar>Bin</bar>
-      <soapenv:bar>Bash</bar>
-    </foo>""")
+      <soapenv:bar>Bash</soapenv:bar>
+    </soapenv:foo>""")
 
-   SoapResponseNokogiri.new(xml).parse.should == {:foo => {:bar => ["Bin", "Bash"]}}
+   klass.new(xml).parse.should == {:foo => {:bar => ["Bin", "Bash"]}}
   end
 
   it 'unescapes any HTML contained in text nodes' do
     xml = wrap_in_salesforce_envelope("""
-    <soapenv:foo>
+    <foo>
       <bar>Bin</bar>
       <bar>&lt;tag attr=&quot;Bee&apos;s knees &amp; toes&quot;&gt;</bar>
     </foo>""")
 
-    SoapResponseNokogiri.new(xml).parse()[:foo][:bar].last.should == %q(<tag attr="Bee's knees & toes">)
+    klass.new(xml).parse()[:foo][:bar].last.should == %q(<tag attr="Bee's knees & toes">)
   end
 
   it 'returns an object that can be navigated via methods in addition to keys' do
     xml = wrap_in_salesforce_envelope("<foo><bar><bin>bash</bin></bar></foo>")
-    SoapResponseNokogiri.new(xml).parse().foo.bar.bin.should == "bash"
+    klass.new(xml).parse().foo.bar.bin.should == "bash"
   end
+end
 
+describe 'SoapResponseNokogiri' do
+  it_behaves_like 'a SOAP response' do
+    let(:klass) { SoapResponseNokogiri }
+  end
+end
+
+describe 'SoapResponseExpat' do
+  it_behaves_like 'a SOAP response' do
+    let(:klass) { SoapResponseExpat }
+  end
+end
+
+describe 'SoapResponseRexml' do
+  it_behaves_like 'a SOAP response' do
+    let(:klass) { SoapResponseRexml }
+  end
+end
+
+describe 'SoapResponseHpricot' do
+  it_behaves_like 'a SOAP response' do
+    let(:klass) { SoapResponseHpricot }
+  end
 end
 
 CreateXml = <<HERE.gsub(/\n\s*/, '')

data/spec/spec_helper.rb

@@ -2,65 +2,3 @@ gem 'builder'
 require 'rforce'
 
 include RForce
-
-module RForceXmlMatchers
-  class Resemble
-    def initialize(expected)
-      @expected = expected
-    end
-
-    def matches?(actual)
-      @actual = actual
-
-      return false if different 'size',
-        @actual.size,
-        @expected.size
-
-      @expected.each_with_index do |exp_rec, index|
-        act_rec = @actual[index]
-
-        # Only bother to look at the first <Id>
-        # tag in a (presumably) duplicated set.
-        act_id = first_id(act_rec[:Id])
-        exp_id = first_id(exp_rec[:Id])
-
-        return false if different '<Id>', act_id, exp_id
-        return false if different 'keys', act_rec.keys, exp_rec.keys
-
-        exp_rec.each do |key, _|
-          unless key == :Id
-            return false if different key, act_rec[key], exp_rec[key]
-          end
-        end
-      end
-
-      return true
-    end
-
-    def failure_message_for_should
-      %Q{expected "#{@actual.to_s[0..9]}..." } +
-        %Q{to resemble "#{@expected.to_s[0..9]}...":\n} +
-        @difference
-    end
-
-    private
-
-    def first_id(id)
-      id.is_a?(Array) ? id.first : id
-    end
-
-    def different(name, act, exp)
-      return nil if act == exp
-      @difference = %Q{  for #{name}, got:\n     } +
-        %Q{#{act.inspect}\n  expected:\n     #{exp.inspect}}
-    end
-  end
-
-  def resemble(expected)
-    Resemble.new(expected)
-  end
-end
-
-RSpec.configure do |config|
-  config.include(RForceXmlMatchers)
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rforce
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: '0.9'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-29 00:00:00.000000000Z
+date: 2012-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: builder
-  requirement: &70316342047860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '3.0'
   type: :runtime
   prerelease: false
-  version_requirements: *70316342047860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70316342047220 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +37,15 @@ dependencies:
         version: '0.4'
   type: :runtime
   prerelease: false
-  version_requirements: *70316342047220
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70316342046460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '2.8'
   type: :development
   prerelease: false
-  version_requirements: *70316342046460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.8'
 - !ruby/object:Gem::Dependency
   name: hoe-gemspec2
-  requirement: &70316342045700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +69,63 @@ dependencies:
         version: '1.1'
   type: :development
   prerelease: false
-  version_requirements: *70316342045700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: hpricot
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: xmlparser
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.7'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &70316342044600 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +133,15 @@ dependencies:
         version: '3.10'
   type: :development
   prerelease: false
-  version_requirements: *70316342044600
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.10'
 - !ruby/object:Gem::Dependency
   name: hoe
-  requirement: &70316342043760 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +149,12 @@ dependencies:
         version: '2.13'
   type: :development
   prerelease: false
-  version_requirements: *70316342043760
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
 description: RForce is a simple, usable binding to the Salesforce API.
 email:
 - undees@gmail.com
@@ -87,7 +165,6 @@ extra_rdoc_files:
 - Manifest.txt
 - README.txt
 files:
-- .gemtest
 - History.txt
 - Manifest.txt
 - README.txt
@@ -107,6 +184,7 @@ files:
 - spec/spec.opts
 - spec/spec_helper.rb
 - tasks/timing.rake
+- .gemtest
 homepage: http://rforce.rubyforge.org
 licenses: []
 post_install_message: 
@@ -129,7 +207,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: rforce
-rubygems_version: 1.8.10
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: RForce is a simple, usable binding to the Salesforce API.