README.md

# Sf

It's a gem to access the Internet2 Salesforce instance with custom objects.

## Installation

Add the sf gem to your application's Gemfile:

For example,

```
gem 'sf', :git => 'git+ssh://github.internet2.edu/Internet2-TSG/sf.git', :tag => 'v0.1.66'
```

And then execute:

    $ bundle

## Usage

In the hosting application, a configuration file, for example
`config/restforce.yml`,  with the following information is needed.

```
  host: test.salesforce.com
  username: username@domain
  password: xxxxxxxxxxxxxxxxxxxxx
  security_token: xxxxxxxxxxxxx
  client_id: xxxxxxxxxxxxxxxxxxxx
  client_secret: xxxxxxxxxxxxxx
  api_version: '41.0'
```
Or
```
host: <%= ENV["SF_HOST"] %>
username: <%= ENV["SF_USERNAME"] %>
password: <%= ENV["SF_PASSWORD"] %>
security_token: <%= ENV["SF_SECURITY_TOKEN"] %>
client_id: <%= ENV["SF_CLIENT_ID"] %>
client_secret: <%= ENV["SF_CLIENT_SECRET"] %>
api_version: <%= ENV["SF_API_VERSION"] %>
```

Please refer to [https://github.com/ejholmes/restforce](https://github.com/ejholmes/restforce) for the detail.

## Contributing

1. Fork it
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create new Pull Request