README.rdoc in databasedotcom-1.2.0 vs README.rdoc in databasedotcom-1.2.1
- old
+ new
@@ -15,11 +15,11 @@
Source is available at github[http://github.com/heroku/databasedotcom]
= Usage
== Initialization
-When you create a Databasedotcom::Client object, you need to configure it with a client id and client secret that corresponds to one of the Remote Access Applications configured within your SalesForce instance. The SalesForce UI refers to the client id as "Consumer Key", and to the client secret as "Consumer Secret".
+When you create a Databasedotcom::Client object, you need to configure it with a client id and client secret that corresponds to one of the Remote Access Applications configured within your Salesforce instance. The Salesforce UI refers to the client id as "Consumer Key", and to the client secret as "Consumer Secret".
You can configure your Client object with a client id and client secret in one of several different ways:
=== Configuration from the environment
If configuration information is present in the environment, the new Client will take configuration information from there.
@@ -77,29 +77,29 @@
client = Databasedotcom::Client.new
it will use the configuration information that you set with <tt>heroku config:add</tt>.
== Authentication
-The first thing you need to do with the new Client is to authenticate with SalesForce. You can do this in one of several ways:
+The first thing you need to do with the new Client is to authenticate with Salesforce. You can do this in one of several ways:
=== Authentication via an externally-acquired OAuth access token
-If you have acquired an OAuth access token for your SalesForce instance through some external means, you can use it. Note that you have to pass both the token and your SalesForce instance URL to the <tt>authenticate</tt> method:
+If you have acquired an OAuth access token for your Salesforce instance through some external means, you can use it. Note that you have to pass both the token and your Salesforce instance URL to the <tt>authenticate</tt> method:
client.authenticate :token => "my-oauth-token", :instance_url => "http://na1.salesforce.com" #=> "my-oauth-token"
=== Authentication via Omniauth
-If you are using the gem within the context of a web application, and your web app is using Omniauth to do OAuth with SalesForce, you can authentication the Client direction via the Hash that Omniauth passes to your OAuth callback method, like so:
+If you are using the gem within the context of a web application, and your web app is using Omniauth to do OAuth with Salesforce, you can authentication the Client direction via the Hash that Omniauth passes to your OAuth callback method, like so:
client.authenticate request.env['omniauth.auth'] #=> "the-oauth-token"
=== Authentication via username and password
-You can authenticate your Client directly with SalesForce with a valid username and password for a user in your SalesForce instance. Note that, if access to your SalesForce instance requires a {security token}[http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_concepts_security.htm], the value that you pass for <tt>:password</tt> must be the password for the user concatenated with her security token.
+You can authenticate your Client directly with Salesforce with a valid username and password for a user in your Salesforce instance. Note that, if access to your Salesforce instance requires a {security token}[http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_concepts_security.htm], the value that you pass for <tt>:password</tt> must be the password for the user concatenated with her security token.
client.authenticate :username => "foo@bar.com", :password => "ThePasswordTheSecurityToken" #=> "the-oauth-token"
== Accessing the Sobject API
-You can retrieve a list of Sobject defined in your SalesForce instance like so:
+You can retrieve a list of Sobject defined in your Salesforce instance like so:
client.list_sobjects #=> ['User', 'Group', 'Contact']
Once you have the name of an Sobject, the easiest way to interact with it is to first materialize it:
@@ -123,11 +123,11 @@
contact.save #=> save the changes to the database
contact.update_attributes "Name" => "newer name",
"Phone" => "4156543210" #=> change several attributes at once and save them
contact.delete #=> delete the contact from the database
-See the documentation for full details.
+See the documentation[http://rubydoc.info/github/heroku/databasedotcom/master/frames] for full details.
== Accessing the Chatter API
You can easily access Chatter feeds, group, conversations, etc.:
my_feed_items = Databasedotcom::Chatter::UserProfileFeed.find(client) #=> a Databasedotcom::Collection of FeedItems
@@ -145,10 +145,10 @@
me.post_status("what I'm doing now") #=> post a new status
you = Databasedotcom::Chatter::User.find(client, "your-user-id")
me.follow(you) #=> start following a user
-See the documentation for full details.
+See the documentation[http://rubydoc.info/github/heroku/databasedotcom/master/frames] for full details.
= License
This gem is licensed under the MIT License.
\ No newline at end of file