Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
A simple, usable binding to the SalesForce API.
Failed to load latest commit information.
examples Add runnable examples
lib Release v0.13
spec
tasks Remove last vestiges of Hpricot
.hgignore Crude cut/paste addition of Wes's faster expat parser.
.hgtags Added tag v0.12 for changeset 9af08cc52691
.travis.yml The year is 2014; we can stop worrying about Ruby 1.8
Gemfile Update gemspec and manifest for new README.rdoc
Gemfile.ci Bump Hoe version for Travis
Gemfile.lock update Gemfile.lock
History.txt
Manifest.txt Bump version
README.rdoc
Rakefile Bump version
rforce.gemspec Bump version

README.rdoc

rforce

DESCRIPTION:

RForce is a simple, usable binding to the Salesforce API.

FEATURES:

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.

SYNOPSIS:

Logging in with a user name and password

binding = RForce::Binding.new \
  'https://www.salesforce.com/services/Soap/u/20.0'

binding.login \
  'email', 'password' + 'token'

Logging in with OAuth

oauth = {
  :consumer_key    => '...', # Tokens obtained from Salesforce
  :consumer_secret => '...',
  :access_token    => '...',
  :access_secret   => '...',
  :login_url       => 'https://login.salesforce.com/services/OAuth/u/20.0'
}

binding = RForce::Binding.new \
  'https://www.salesforce.com/services/Soap/u/20.0',
  nil,
  oauth

binding.login_with_oauth

Finding a record

answer = binding.search \
  :searchString =>
    'find {McFakerson Co} in name fields returning account(id)'

account = answer.searchResponse.result.searchRecords.record
account_id = account.Id

Creating a record

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 and oauth gems

  • A Salesforce Enterprise or Developer account

INSTALL:

  • gem install rforce

LICENSE:

Copyright © 2005-2014 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.

Something went wrong with that request. Please try again.