Home > snooze_force

snooze_force

Snooze_force is a project mainly written in Ruby, based on the MIT license.

SnoozeForce - A Client for Saleforce.com's REST API

h1. SnoozeForce - A Client for Saleforce.com's REST API

h2. Setup


  client = SnoozeForce::Client.new(:instance_url => 'https://XXX.salesforce.com', 
                                   :token => '00D...cg3', 
                                   :uid => '005...IAC', 
                                   :refresh_token => "5Ae...JcQ==",
                                   :client_id => '3MV...zYT',
                                   :client_secret => '782...385')

h2. Use

h3. Direct Access


  res = client.get('sobjects/User/005...IAC')
  puts res.inspect

h3. Access Attributes


  res = client.user.me # same as: 
                       # client.get('sobjects/User/005...IAC')
                       # client.user.get('/005...IAC')
  puts res['Username'] # => 'joesmith'

h3. Object Access


  res = client.news_feed.get # same as: 
                             # client.news_feed.get('/')
  puts res.inspect

res = client.user.me # same as:

client.get('sobjects/User/005...IAC')

                   # client.user.get('/005...IAC')

res = client.account.get('/XXXX')

etc....

h3. SObject Details


  puts client.account._sobject.inspect # returns the details of the sobject

h3. Describe


  puts client.account._describe

h3. Fields


  puts client.account._fields

h3. Query


  res = client.query("SELECT Id, Name FROM Account")
  puts res.inspect

h3. Search


  res = client.search("FIND+{Oil}")
  puts res.inspect

h3. Post


  res = client.account.post('/', {:body => {'Name' => 'Billy Bob'}})
  puts res.inspect