-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathindex.html
More file actions
303 lines (239 loc) · 15.3 KB
/
index.html
File metadata and controls
303 lines (239 loc) · 15.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
<!DOCTYPE html>
<html>
<head>
<title>Restforce</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="description"
content="Restforce is the most popular Ruby gem for interacting with Salesforce using the Salesforce API, downloaded over 16,000,000 times">
<meta name="keywords" content="ruby,salesforce,restforce,gem">
<link rel="stylesheet" type="text/css" href="normalize.min.css" />
<link rel="stylesheet" type="text/css" href="prism.min.css" />
<link href='https://fonts.googleapis.com/css?family=Roboto+Slab:700' rel='stylesheet' type='text/css'>
<script>
(function (i, s, o, g, r, a, m) {
i['GoogleAnalyticsObject'] = r; i[r] = i[r] || function () {
(i[r].q = i[r].q || []).push(arguments)
}, i[r].l = 1 * new Date(); a = s.createElement(o),
m = s.getElementsByTagName(o)[0]; a.async = 1; a.src = g; m.parentNode.insertBefore(a, m)
})(window, document, 'script', '//www.google-analytics.com/analytics.js', 'ga');
ga('create', 'UA-185993-31', 'auto');
ga('send', 'pageview');
</script>
<style type="text/css">
body {
background-color: #EEEEEE;
line-height: 2em;
font-family: "Helvetica Neue", "Helvetica", sans-serif;
}
.container {
margin: auto;
padding: 2em;
max-width: 900px;
}
h1.title {
font-family: "Roboto Slab", serif;
font-size: 2.8em;
line-height: 1.5em;
margin-bottom: 0.25em;
}
section {
margin: 3em 0;
}
section a.section-title h2 {
text-transform: uppercase;
}
section a.section-title {
text-decoration: none;
}
code.code-block {
display: block;
}
code {
font-family: "Courier New", monospace;
padding: 0.5em;
}
a {
color: inherit;
}
.text-muted {
color: #CCC;
}
#stay-up-to-date ul li {
margin: 1em auto;
}
#stay-up-to-date ul li a.changelog {
text-decoration: none;
}
</style>
</head>
<body>
<div class="container">
<h1 class="title">Restforce</h1>
<a href="https://rubygems.org/gems/restforce">
<img src="https://img.shields.io/gem/dt/restforce.svg"
style="display: block; float: left; margin-top: 2px; margin-right: 0.4em;" />
</a>
<a href="https://circleci.com/gh/restforce/restforce">
<img src="https://circleci.com/gh/restforce/restforce.svg?style=svg"
style="display: block; float: left; margin-top: 3px; margin-right: 0.4em;" />
</a>
<iframe src="https://ghbtns.com/github-btn.html?user=restforce&repo=restforce&type=star" frameborder="0"
scrolling="0" width="160px" height="20px"></iframe>
<p><a href="https://github.com/restforce/restforce">Restforce</a> is the most popular Ruby gem for interacting with
Salesforce using the Salesforce API, <a href="https://rubygems.org/gems/restforce">downloaded over 16,000,000
times</a>.</p>
<section id="get-started">
<a href="#get-started" class="section-title">
<h2>Get started</h2>
</a>
<p>1. Add <code>restforce</code> to your <code>Gemfile</code>, then run <code>bundle install</code> (or install it
manually with <code>gem install</code>).</p>
<pre><code class="code-block language-ruby">gem 'restforce', '~> 5.0.0'</code></pre>
<p>The gem only supports Ruby 2.5 onwards. To use Restforce with earlier versions of Ruby, you'll need to <a href="https://github.com/restforce/restforce#installation">use an
earlier version of the gem</a>.</p>
<p>2. Instantiate a <code>Restforce</code> client object with your <a
href="https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_authentication.htm">API
authentication details</a>. You can use your username and password as below, or <a
href="https://github.com/restforce/restforce#oauth-token-authentication">authenticate with OAuth</a>.</p>
<pre style="margin: 0;"><code class="code-block language-bash"># Don't commit your authentication details with your code - use environment variables <3
export SALESFORCE_USERNAME="username"
export SALESFORCE_PASSWORD="password"
export SALESFORCE_SECURITY_TOKEN="security token"
export SALESFORCE_CLIENT_ID="client id"
export SALESFORCE_CLIENT_SECRET="client secret"
export SALESFORCE_API_VERSION="38.0"</code></pre>
<pre style="margin: 0;"><code class="code-block language-ruby">client = Restforce.new</code></pre>
<p>3. Query Salesforce like a pro.</p>
<pre><code class="code-block language-ruby">my_leads = client.query("SELECT Id, Source FROM Lead where OwnerId = 'INSERT_USER_ID_HERE'")
# => #<Restforce::Collection >
</code></pre>
</section>
<section id="learn-more">
<a href="#learn-more" class="section-title">
<h2>Learn more</h2>
</a>
<p>To discover all the great things you can do with Restforce, check out the <a
href="https://github.com/restforce/restforce/blob/master/README.md">README</a> and the <a
href="http://www.rubydoc.info/gems/restforce/frames">full documentation</a>.</p>
</section>
<section id="stay-up-to-date">
<a href="#stay-up-to-date" class="section-title">
<h2>Stay up to date</h2>
</h2>
<ul class="updates">
<li><b>10th July 2020</b>: We've released a new major version of the gem, <a href="https://rubygems.org/gems/restforce/versions/5.0.0">v5.0.0</a>. This version drops support for Ruby 2.4, introduces a number of other breaking changes (e.g. tweaks to how errors are defined) and brings exciting new features, including support for Faraday v1.0. For more details, see the <a href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#500-jul-10-2020">changelog</a> and <a href="https://github.com/restforce/restforce/blob/master/UPGRADING.md">upgrade guide</a>.</li>
<li><b>23rd January 2020</b>: <a href="https://rubygems.org/gems/restforce/versions/4.2.2">v4.2.2</a> has been released, fixing a pesky bug with how we generate the results returned by the library.</li>
<li><b>5th December 2019</b>: <a href="https://rubygems.org/gems/restforce/versions/4.2.1">v4.2.1</a> is now
available, fixing a bug with authentication errors and a Faraday deprecation warning.
</li>
<li><b>23rd October 2019</b>: <a href="https://rubygems.org/gems/restforce/versions/4.2.0">v4.2.0</a> has been
released, adding support for platform events, CDC, generic events and more in the Streaming API.
</li>
<li><b>20th October 2019</b>: <a href="https://rubygems.org/gems/restforce/versions/4.1.0">v4.1.0</a> is now
available, adding support for JWT authentication.
</li>
<li><b>9th October 2019</b>: <a href="https://rubygems.org/gems/restforce/versions/4.0.0">v4.0.0</a> has
launched,
bringing support for the bulk API, better errors and a fix for how IDs are escaped. This version
officially drops support for
Ruby 2.3 - if you want to use Ruby 2.3, then v3.2.0 of the gem includes the same features and bug fixes.
</li>
<li><b>16th August 2018</b>: <a href="https://rubygems.org/gems/restforce/versions/3.1.0">v3.1.0</a> has been
released, adding support for replying missed messages when using Salesforce's Streaming API.</li>
<li><b>4th August 2018</b>: <a href="https://rubygems.org/gems/restforce/versions/3.0.1">v3.0.1</a> is now
available, fixing a bug introduced by v3.0.0 which led to a <code>NoMethodError</code> when upserting an
existing record.</li>
<li><b>2nd August 2018</b>: <a href="https://rubygems.org/gems/restforce/versions/3.0.0">v3.0.0</a> has been
released. It drops support for Ruby 2.0, 2.1 and 2.2 (which have all reached end-of-life) and fixes a number
of bugs.</li>
<li><b>21st August 2017</b>: Restforce has moved (again!), now to <a
href="https://github.com/restforce/restforce">restforce/restforce</a>. Thanks to <a
href="https://github.com/antwonlee">@antwonlee</a> for letting us have the organisation name!</li>
<li><b>19th August 2017</b>: Restforce has moved to its own organisation on GitHub - the source code and
community is now at <a href="https://github.com/restforcegem/restforce">restforcegem/restforce</a>.</li>
<li><b>25th April 2017</b>: <a href="https://rubygems.org/gems/restforce/versions/2.5.3">v2.5.3</a> is now
available. It fixes a bug where <code>upsert</code> and <code>upsert!</code> mutated the provided
attributes, starts raising an error where a custom external ID field name is supplied to <code>upsert</code>
and <code>upsert!</code> but it is missing from the provided attributes, and uses the client's configured
SSL options for authentication requests. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#253-apr-25-2017">(changelog)</a>
</li>
<li><b>3rd April 2017</b>: <a href="https://rubygems.org/gems/restforce/versions/2.5.2">v2.5.2</a> has been
released. It fixes a bug with logging that caused logs related to custom headers (added in v2.5.1) and Gzip
to be missing, and improves compatability with versions of <a
href="https://github.com/intridea/hashie">Hashie</a> since v3.5.0. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#252-apr-3-2017">(changelog)</a></li>
<li><b>16th March 2017</b>: <a href="https://rubygems.org/gems/restforce/versions/2.5.1">v2.5.1</a> is now
available. It adds support for setting custom headers and <code>upsert</code>ing with an ID, and relaxes the
gem's dependency on Faraday to allow upgrading it to 1.0. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#251-mar-16-2017">(changelog)</a>
</li>
<li><b>7th December 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.5.0">v2.5.0</a> has been
released. <b>It removes compatability with Ruby 1.9.3</b> and improves the security of the gem's caching
behaviour by hashing authentication credentials in cache keys. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#250-dec-5-2016"
class="changelog text-muted">(changelog)</a></li>
<li><b>20th October 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.4.2">v2.4.2</a> is now
available. It relaxes the gem's dependencies for users of Ruby 2.0.0 onwards to allow wider compatability
(e.g. with Rails 4). <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#242-oct-20-2016"
class="changelog text-muted">(changelog)</a></li>
<li><b>18th October 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.4.1">v2.4.1</a> has just
been released. It adds compatability with pre-released versions of Ruby 2.4.0. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#241-oct-18-2016"
class="changelog text-muted">(changelog)</a></li>
<li><b>29th July 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.4.0">v2.4.0</a> is
available via RubyGems.org. It supports the Document resource, which behaves just like Attachment. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#240-jul-29-2016"
class="changelog text-muted">(changelog)</a></li>
<li><b>15th July 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.3.0">v2.3.0</a> is live on
RubyGems.org. It allows you to optionally specify the Salesforce API version with a
<code>SALESFORCE_API_VERSION</code> environment variable. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#230-jul-15-2016"
class="changelog text-muted">(changelog)</a></li>
<li><b>6th June 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.2.1">v2.2.1</a> is now
available from RubyGems.org. It adds support for a new <code>get_deleted</code> method. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#221-jun-6-2016"
class="changelog text-muted">(changelog)</a></li>
<li><b>16th March 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.2.0">v2.2.0</a> has just
been released. It improves the handling of errors returned by the API, notably raising an error when a
<code>300</code> is returned due to an external ID matching multiple records for an <a
href="https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_upsert.htm">upsert</a>
operation. <a href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#220-mar-16-2016"
class="changelog text-muted">(changelog)</a></li>
<li><b>9th March 2016</b>: <a href="https://rubygems.org/gems/restforce/versions/2.1.3">v2.1.3</a> is now
available. It returns a new <code>Restforce::ServerError</code> when Salesforce is experiencing problems,
and improves the handling of the response body in errors. <a
href="https://github.com/restforce/restforce/blob/master/CHANGELOG.md#213-mar-9-2016"
class="changelog text-muted">(changelog)</a></li>
</ul>
</section>
<section id="get-involved">
<a href="#get-involved" class="section-title">
<h2>Get involved</h2>
</a>
<p>We welcome <a href="https://github.com/restforce/restforce/tree/master/CHANGELOG.md">contributions</a> and <a
href="https://github.com/restforce/restforce/issues">bug reports</a> so we can together make Restforce as
great as possible 💕</p>
<p>We'd love to have you involved, whether it's your first open source contribution or your thousandth. To get
started, see our <a
href="https://github.com/restforce/restforce/blob/master/CONTRIBUTING.md">CONTRIBUTING.md</a>, and take note
of our <a href="https://github.com/restforce/restforce/blob/master/CODE_OF_CONDUCT.md">code of conduct</a>.
<p>If you have any questions, contact <a href="#get-in-touch">Tim Rogers, the maintainer</a>.</p>
</section>
<section id="get-in-touch">
<a href="#get-in-touch" class="section-title">
<h2>Get in touch</h2>
</a>
<p>Want help using Restforce, with contributing, or have another question?</p>
<p>Get in touch with <a href="https://timrogers.co.uk">Tim Rogers</a>, the maintainer of Restforce, at <a
href="mailto:tim@restforce.org">tim@restforce.org</a>.</p>
</section>
<p class="text-muted">Restforce is released under the <a
href="https://github.com/restforce/restforce/blob/master/LICENSE">MIT license</a><br />Page last updated 10th July 2020<br />© <a href="https://timrogers.co.uk">Tim Rogers</a> and <a
href="https://github.com/ejholmes">Eric J. Holmes</a> 2020
</div>
<script src="prism.min.js" type="text/javascript"></script>
</body>
</html>