aq1018-rforce 0.5.1

data/wsdl/sample/create.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/ruby
+# vim: set tw=72 ai sw=2:
+
+### User Configurable Constants ###
+
+DefaultUser = 'changeme@salesforce.com'
+DefaultPasswd = 'changemetoo'
+
+###################################
+
+require 'wsdl'
+require 'pp'
+
+user = ENV['RFORCE_USER'] || DefaultUser
+passwd = ENV['RFORCE_PASS'] || DefaultPasswd
+
+
+# Open a connection and login
+
+if $DEBUG
+  drv = RForce::WSDL.new(user, passwd, $DEBUG, 
+	"http://na1-api.salesforce.com/services/Soap/u/6.0")
+else
+  drv = RForce::WSDL.new(user, passwd)
+end
+
+#result = drv.describeSObjects(["Contact"])
+#pp result
+
+
+sobj = RForce::makeSObject("Contact", 
+	:LastName => "Blow",
+	:FirstName => "Joe",
+	:Salutation => "Mr.",
+	:Phone => "555-555-1212")
+
+pp drv.create([sobj])

data/wsdl/sample/describeGlobal.rb

@@ -0,0 +1,28 @@
+#!/usr/bin/ruby
+# vim: set tw=72 ai sw=2:
+
+### User Configurable Constants ###
+
+DefaultUser = 'changeme@salesforce.com'
+DefaultPasswd = 'changemetoo'
+
+###################################
+
+require 'wsdl'
+require 'pp'
+
+user = ENV['RFORCE_USER'] || DefaultUser
+passwd = ENV['RFORCE_PASS'] || DefaultPasswd
+
+
+# Open a connection and login
+
+if $DEBUG
+  drv = RForce::WSDL.new(user, passwd, $DEBUG, 
+	"http://na1-api.salesforce.com/services/Soap/c/6.0")
+else
+  drv = RForce::WSDL.new(user, passwd)
+end
+
+puts "Your login can access the following objects:"
+puts drv.types.join(", ")

data/wsdl/sample/describeSObjects.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+# vim: set tw=72 ai sw=2:
+
+### User Configurable Constants ###
+
+DefaultUser = 'changeme@salesforce.com'
+DefaultPasswd = 'changemetoo'
+
+###################################
+
+require 'wsdl'
+require 'pp'
+
+user = ENV['RFORCE_USER'] || DefaultUser
+passwd = ENV['RFORCE_PASS'] || DefaultPasswd
+
+
+# Open a connection and login
+
+if $DEBUG
+  drv = RForce::WSDL.new(user, passwd, $DEBUG, 
+	"http://na1-api.salesforce.com/services/Soap/c/6.0")
+else
+  drv = RForce::WSDL.new(user, passwd)
+end
+
+result = drv.describeSObjects(["SelfServiceUser", "Contact"])
+
+puts "The SelfServiceUser object has the following fields:"
+result[0].fields.each { |field| print "#{field.name}, " }
+
+puts "\n\nThe Contact object has the following fields:"
+result[1].fields.each { |field| print "#{field.name}, " }
+

data/wsdl/sample/getServerTimestamp.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/ruby
+# vim: set tw=72 ai sw=2:
+
+### User Configurable Constants ###
+
+DefaultUser = 'changeme@salesforce.com'
+DefaultPasswd = 'changemetoo'
+
+###################################
+
+require 'wsdl'
+require 'pp'
+
+user = ENV['RFORCE_USER'] || DefaultUser
+passwd = ENV['RFORCE_PASS'] || DefaultPasswd
+
+
+# Open a connection and login
+
+if $DEBUG
+  drv = RForce::WSDL.new(user, passwd, $DEBUG, 
+	"http://na1-api.salesforce.com/services/Soap/c/6.0")
+else
+  drv = RForce::WSDL.new(user, passwd)
+end
+
+puts "Server time is : #{drv.getServerTimestamp.asctime}"

data/wsdl/sample/query.rb

@@ -0,0 +1,31 @@
+#!/usr/bin/ruby
+# vim: set tw=72 ai sw=2:
+
+### User Configurable Constants ###
+
+DefaultUser = 'changeme@salesforce.com'
+DefaultPasswd = 'changemetoo'
+
+###################################
+
+require 'wsdl'
+require 'pp'
+
+user = ENV['RFORCE_USER'] || DefaultUser
+passwd = ENV['RFORCE_PASS'] || DefaultPasswd
+
+
+# Open a connection and login
+
+if $DEBUG
+  drv = RForce::WSDL.new(user, passwd, $DEBUG, 
+	"http://na1-api.salesforce.com/services/Soap/c/6.0")
+else
+  drv = RForce::WSDL.new(user, passwd)
+end
+
+query_rslt = drv.query("select Id, Name, SerialNumber from Asset where SerialNumber like '%04BM%'")
+
+query_rslt.records.each do |rec|
+  puts "Id: #{rec.id}\tName: #{rec.name}\tSN: #{rec.serialNumber}"
+end

data/wsdl/sample/queryMore.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby
+# vim: set tw=72 ai sw=2:
+
+### User Configurable Constants ###
+
+DefaultUser = 'changeme@salesforce.com'
+DefaultPasswd = 'changemetoo'
+
+###################################
+
+require 'wsdl'
+require 'pp'
+
+user = ENV['RFORCE_USER'] || DefaultUser
+passwd = ENV['RFORCE_PASS'] || DefaultPasswd
+
+
+# Open a connection and login
+
+if $DEBUG
+  drv = RForce::WSDL.new(user, passwd, $DEBUG, 
+	"http://na1-api.salesforce.com/services/Soap/c/6.0")
+else
+  drv = RForce::WSDL.new(user, passwd)
+end
+
+query_rslt = drv.query("select LastName from Contact")
+puts "Size: #{query_rslt.size}\t Done: #{query_rslt.done}\tLoc: #{query_rslt.queryLocator}"
+
+query_rslt = drv.queryMore(query_rslt.queryLocator)
+puts "Size: #{query_rslt.size}\t Done: #{query_rslt.done}\tLoc: #{query_rslt.queryLocator}"
+

data/wsdl/sample/retrieve.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/ruby
+# vim: set tw=72 ai sw=2:
+
+### User Configurable Constants ###
+
+DefaultUser = 'changeme@salesforce.com'
+DefaultPasswd = 'changemetoo'
+
+###################################
+
+require 'wsdl'
+require 'pp'
+
+user = ENV['RFORCE_USER'] || DefaultUser
+passwd = ENV['RFORCE_PASS'] || DefaultPasswd
+
+
+# Open a connection and login
+
+if $DEBUG
+  drv = RForce::WSDL.new(user, passwd, $DEBUG, 
+	"http://na1-api.salesforce.com/services/Soap/c/6.0")
+else
+  drv = RForce::WSDL.new(user, passwd)
+end
+
+query_results = drv.query("select Id from Asset where SerialNumber like '%04BM%'")
+ids = query_results.records.map { |rslt| rslt.id }
+
+drv.retrieve("Name, SerialNumber, SE__c", "Asset", ids).each do |obj|
+  puts "Name: #{obj.name}\tSN: #{obj.serialNumber}\tSE: #{obj.sE__c}"
+end

data/wsdl/sforceDriver.rb

@@ -0,0 +1,43 @@
+require 'defaultDriver.rb'
+require 'soap/header/simplehandler'
+require 'orderedhash'
+ 	
+class SessionHeaderHandler < SOAP::Header::SimpleHandler
+
+  HeaderName = XSD::QName.new('urn:partner.soap.sforce.com', 'SessionHeader')
+
+  attr_accessor :sessionid
+
+  def initialize
+    super(HeaderName)
+    @sessionid = nil
+  end
+
+  def on_simple_outbound
+    if @sessionid
+      {'sessionId' => @sessionid}
+    else
+      nil       # no header
+    end
+  end
+end
+
+class CallOptionsHandler < SOAP::Header::SimpleHandler
+
+  HeaderName = XSD::QName.new('urn:partner.soap.sforce.com', 'CallOptions')
+
+  attr_accessor :client
+
+  def initialize
+    super(HeaderName)
+    @client = nil
+  end
+
+  def on_simple_outbound
+    if @client
+      {'client' => @client}
+    else
+      nil       # no header
+    end
+  end
+end

data/wsdl/soap/property

@@ -0,0 +1 @@
+client.protocol.http.ssl_config.ca_file = ca.pem

data/wsdl/wsdl.rb

@@ -0,0 +1,121 @@
+# vim: set tw=72 ai sw=2:
+
+require 'defaultDriver.rb'
+require 'sforceDriver.rb'
+
+# RForce module for using the Salesforce.com "SForce" API
+module RForce
+ 	
+  # This is the WSDL interface rather than "raw" XML interface
+  class WSDL
+
+    # The underlying SOAP binding
+    attr_reader :soap
+
+    # Specifies how an organization's data is encoded, such as UTF-8 or
+    # ISO8859/1
+    attr_reader :encoding
+
+    # Maximum number of records allowed in a create, update, or delete
+    # call
+    attr_reader :maxBatchSize
+
+    # Array of available objects for your organization.
+    attr_reader :types
+
+    # Create a new rforce object, handling the resetting of the endpoint
+    # URL and sessionId
+    def initialize(user, password, wiredump=false, endpoint=nil)
+
+      @fields = {}
+      @soap = Soap.new(endpoint)
+
+      sessionid_handler = SessionHeaderHandler.new
+      calloptions_handler = CallOptionsHandler.new
+
+
+      @soap.headerhandler << sessionid_handler
+      @soap.headerhandler << calloptions_handler
+
+      @soap.wiredump_dev = STDERR if wiredump
+
+      params = Login.new(user, password)
+      login_result = @soap.login(params).result
+
+      sessionid_handler.sessionid = login_result.sessionId
+      calloptions_handler.client = 'client'
+
+      @soap.endpoint_url = login_result.serverUrl unless endpoint
+
+      #result = soap.describeGlobal(DescribeGlobal.new).result
+      result = describeGlobal
+
+      @encoding = result.encoding
+      @maxBatchSize = result.maxBatchSize
+      @types = result.types
+
+    end
+
+    # Return the server timestamp
+    def getServerTimestamp
+      soap.getServerTimestamp(GetServerTimestamp.new).result.timestamp
+    end
+
+    # Retrieve a list of available SObjects for this login
+    def describeGlobal
+      soap.describeGlobal(DescribeGlobal.new).result
+    end
+
+    # Describe a list of SObjects (what fields, etc.)
+    # [Note: should really cache the results]
+    def describeSObjects(list)
+      soap.describeSObjects(DescribeSObjects.new(list)).result
+    end
+
+    # Perform a SOQL query
+    def query(querystr)
+      soap.query(Query.new(querystr)).result
+    end
+
+    # Continue a SOQL query
+    def queryMore(locator)
+      soap.queryMore(QueryMore.new(locator)).result
+    end
+
+    # Retrieve a list of specific objects
+    def retrieve(fieldList, from, ids)
+      soap.retrieve(Retrieve.new(fieldList, from, ids)).result
+    end
+
+    # Create an SObject
+    def RForce.makeSObject(type, params)
+      sobj = OrderedHash.new
+      sobj[XSD::QName.new('urn:sobject.partner.soap.sforce.com', 'type')] = type
+      params.keys.collect { |key| sobj[key] = params[key] }
+      sobj
+    end
+
+    def create(sobjects)
+      soap.create(:sObjects => sobjects).result
+    end
+
+  end
+
+  class SObject
+    attr_accessor :type, :id, :fieldsToNull, :any
+
+    def initialize(type, id, fieldsToNull, any)
+      @type = type
+      @id = id
+      @fieldsToNull = fieldsToNull
+      @any = any
+
+      sobj = OrderedHash.new
+      sobj[XSD::QName.new('urn:sobject.partner.soap.sforce.com', 'type')] = type
+      any.keys.collect { |key| sobj[key] = any[key] }
+      sobj
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification 
+name: aq1018-rforce
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 1
+  version: 0.5.1
+platform: ruby
+authors: 
+- Ian Dees
+- Logan (henriquez)
+- Aaron Qian
+- Moritz Heidkamp
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-12-02 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: builder
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 0
+        version: 2.0.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 4
+        - 4
+        version: 1.4.4
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: oauth
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        version: "1.3"
+  type: :development
+  version_requirements: *id004
+description: 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.
+email: aq1018@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .gitignore
+- History.txt
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- aq1018-rforce.gemspec
+- bugs/issue-09d998dc3f9d6e8928598fd5d9c6627102dedd65.yaml
+- bugs/issue-1b668248120eb4fd055f0ea6b75ff807f6955936.yaml
+- bugs/issue-3ef7a7c5c7e38fb76e1f53e1b67f45559e21b104.yaml
+- bugs/issue-a7a87cb98d29943a49d1608adb68475838ad2e65.yaml
+- bugs/issue-c92d34e10038ba6b9acfd7e3dfb2b154e463baba.yaml
+- bugs/project.yaml
+- lib/rforce.rb
+- lib/rforce/binding.rb
+- lib/rforce/method_keys.rb
+- lib/rforce/soap_pullable.rb
+- lib/rforce/soap_response.rb
+- lib/rforce/soap_response_expat.rb
+- lib/rforce/soap_response_hpricot.rb
+- lib/rforce/soap_response_nokogiri.rb
+- lib/rforce/soap_response_rexml.rb
+- lib/rforce/version.rb
+- spec/rforce_spec.rb
+- spec/soap-response.xml
+- spec/spec.opts
+- spec/spec_helper.rb
+- tasks/timing.rake
+- test/oauth_tests.rb
+- wsdl/README.html
+- wsdl/README.txt
+- wsdl/ca.pem
+- wsdl/default.rb
+- wsdl/defaultDriver.rb
+- wsdl/orderedhash.rb
+- wsdl/partner.wsdl.xml
+- wsdl/partner.wsdl.xml.old
+- wsdl/sample/create.rb
+- wsdl/sample/describeGlobal.rb
+- wsdl/sample/describeSObjects.rb
+- wsdl/sample/getServerTimestamp.rb
+- wsdl/sample/query.rb
+- wsdl/sample/queryMore.rb
+- wsdl/sample/retrieve.rb
+- wsdl/sforceDriver.rb
+- wsdl/soap/property
+- wsdl/wsdl.rb
+has_rdoc: true
+homepage: http://github.com/aq1018/rforce
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A simple, usable binding to the SalesForce API.
+test_files: 
+- spec/rforce_spec.rb
+- spec/spec_helper.rb
+- test/oauth_tests.rb