rforce 0.2.0 → 0.2.1

data/History.txt

@@ -7,3 +7,8 @@
 
 * 1 major enhancement:
   * Incorporated fixes from ActiveSalesforce project
+
+== 0.2.1 2008-07-04
+
+* 1 minor enhancement:
+  * Updated examples for SalesForce API v10

data/Manifest.txt

@@ -6,4 +6,4 @@ lib/rforce.rb
 spec/rforce_spec.rb
 spec/spec.opts
 spec/spec_helper.rb
-tasks/rspec.rake
+tasks/rspec.rake

data/README.txt

@@ -1,6 +1,8 @@
 = rforce
 
 * http://rforce.rubyforge.org
+* http://rubyforge.org/projects/rforce
+* http://freehg.org/u/undees/rforce
 
 == DESCRIPTION:
 
@@ -12,25 +14,36 @@ Rather than enforcing adherence to the sforce.com schema, RForce assumes you are
 
 == SYNOPSIS:
 
-binding = RForce::Binding.new 'na1-api.salesforce.com'
-  binding.login 'username', 'password'
-  answer = binding.search(
+  binding = RForce::Binding.new \
+    'https://na2.salesforce.com/services/Soap/u/10.0'
+
+  binding.login \
+    'email', 'password_with_token'
+
+  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
+      '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
+
+  opportunity = [
+                 :type, 'Opportunity',
+                 :accountId, account_id,
+                 :amount, '10.00',
+                 :name, 'Fakey McFakerson',
+                 :closeDate, '2008-07-04',
+                 :stageName, 'Closed Won'
+                ]
+
+  binding.create :sObject => opportunity
   
 == REQUIREMENTS:
 
+* Builder gem
 * A SalesForce Enterprise or Developer account
 
 == INSTALL:

data/Rakefile

@@ -5,8 +5,9 @@ require 'hoe'
 require './lib/rforce.rb'
 
 Hoe.new('rforce', RForce::VERSION) do |p|
-  # p.rubyforge_name = 'rforcex' # if different than lowercase project name
   p.developer('Ian Dees', 'undees@gmail.com')
+  p.extra_deps = [['builder', '>= 2.0.0']]
+  p.extra_dev_deps = [['hoe', '>= 1.7.0']]
   p.remote_rdoc_dir = ''
 end
 

data/lib/rforce.rb

@@ -55,11 +55,12 @@ require 'stringio'
 require 'rexml/document'
 require 'rexml/xpath'
 require 'rubygems'
-gem 'builder', ">= 2.0.0"
+gem 'builder', '>= 2.0.0'
+require 'builder'
 
 
 module RForce
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 
   #Allows indexing hashes like method calls: hash.key
   #to supplement the traditional way of indexing: hash[key]
@@ -125,9 +126,45 @@ module RForce
     end
   end
 
+  #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
+  
   #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
@@ -162,7 +199,7 @@ module RForce
     ClientIdHeader = '<partner:CallOptions soap:mustUnderstand="1"><partner:client>%s</partner:client></partner:CallOptions>'
 
     #Connect to the server securely.
-    def initialize(url, sid)
+    def initialize(url, sid = nil)
       init_server(url)
 
       @session_id = sid
@@ -212,7 +249,7 @@ module RForce
       #Create XML text from the arguments.
       expanded = ''
       @builder = Builder::XmlMarkup.new(:target => expanded)
-      expand({method => args}, 'urn:partner.soap.sforce.com')
+      expand(@builder, {method => args}, 'urn:partner.soap.sforce.com')
 
       extra_headers = ""
       extra_headers << (AssignmentRuleHeaderUsingRuleId % assignment_rule_id) if assignment_rule_id
@@ -322,41 +359,5 @@ module RForce
 
       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/spec/rforce_spec.rb

@@ -9,3 +9,45 @@ describe FlashHash do
     h.nonexistent.should be_nil
   end
 end
+
+describe 'expand' do
+  it 'turns Ruby into XML' do
+    xmlns = 'urn:partner.soap.sforce.com'
+
+#     'sObject {"xsi:type" => "Opportunity"}'
+    
+    expanded = ''
+    builder = Builder::XmlMarkup.new(:target => expanded)
+
+    data =
+      ['partner:create',
+        ['partner:sObjects',
+          ['spartner:type', 'Contact',
+           'AccountId', '01234567890ABCD',
+           'FirstName', 'Jane',
+           'LastName', 'Doe'],
+         'partner:sObjects',
+           ['spartner:type', 'Account',
+            'Name', 'Acme Rockets, Inc.']]]
+       
+    expand(builder, data)
+
+    expanded.should == CreateXml
+  end
+end
+
+CreateXml = <<HERE.gsub(/\n\s*/, '')
+<partner:create>
+  <partner:sObjects>
+    <spartner:type>Contact</spartner:type>
+    <AccountId>01234567890ABCD</AccountId>
+    <FirstName>Jane</FirstName>
+    <LastName>Doe</LastName>
+  </partner:sObjects>
+  <partner:sObjects>
+    <spartner:type>Account</spartner:type>
+    <Name>Acme Rockets, Inc.</Name>
+  </partner:sObjects>
+</partner:create>
+HERE
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rforce
 version: !ruby/object:Gem::Version 
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors: 
 - Ian Dees
@@ -9,9 +9,29 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2008-07-03 00:00:00 -07:00
+date: 2008-07-04 00:00:00 -07:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.7.0
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development