Skip to content

openstax/openstax_salesforce

main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
bin
 
 
 
 
lib
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

OpenStax::Salesforce

Gem Version Tests

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

Installation

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

Configuration

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:

  • Your username (append .sandboxname if using a sandbox)
  • Your password
  • Your security token
  • Connected App's client key
  • Connected App's client secret Enter all the above information in the initializer, secrets.yml or environment variables.

Testing

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

Specs in Parent App

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'

Contributing

  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

About

OpenStax Salesforce bindings

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages