OpenStax::Salesforce

OpenStax::Salesforce is a Rails engine used by OpenStax projects to communicate with the OpenStax Salesforce instance.

Add this line to your application's Gemfile:

gem 'openstax_salesforce'

And then execute:

$ bundle

Or install it yourself:

$ gem install openstax_salesforce

Then execute the following command to copy the necessary initializer to your application:

$ rake openstax_salesforce:install

After installation, the initializer for OpenStax::Salesforce will be located under config/initializers/openstax_salesforce.rb. Make sure to configure it to suit your needs.

You will need the following information from Salesforce:

• Connected App's client key
• Connected App's client secret
• Your org's My Domain login domain (e.g. openstax.my.salesforce.com, or openstax--sandboxname.sandbox.my.salesforce.com for a sandbox) Enter all the above information in the initializer, secrets.yml or environment variables.

This uses the OAuth 2.0 client credentials flow. In Salesforce, the Connected App needs "Enable Client Credentials Flow" checked and a Run As user set under OAuth Policies — every object and field this gem touches must be readable and writable by that user. Requests to login.salesforce.com and test.salesforce.com are not supported by this flow, which is why the login domain must be My Domain.

Also setting username, password and security_token switches back to the OAuth username-password flow. Salesforce stops supporting it in Spring '27, so this exists only to let apps migrate one at a time. Leave the username unset for new setups.

From the gem's main folder, run bundle install and then bundle exec rake to run all the specs.

There's a helper you can include in your parent app's salesforce specs. It isn't automatically required by this engine, so you have to do it manually in your spec:

require 'openstax/salesforce/spec_helper'

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Create specs for your feature
4. Ensure that all specs pass
5. Commit your changes (git commit -am 'Add some feature')
6. Push to the branch (git push origin my-new-feature)
7. Create new pull request