Salesforce integration

[chrislo]

In order to support the ExperienceCS customer success team, this PR ensures that newly-verified School records are synchronised into Salesforce as Account records.

Setting up a Salesforce account and application in the Sandbox

The RPF sandbox salesforce environment is here: https://raspberrypi--digital.sandbox.lightning.force.com

Step 1

Liesl Quinn created me an account using my [email protected] email address. She sent me a password reset email to allow me to set a new password, and changed my profile to allow API access.

Step 2

Once in salesforce I needed to View profile > My personal information > Reset my security token to generate a new security token.

Step 3

I then visited Setup > Setup for current app > platform tools > Apps > External Client Apps > Settings and enabled "Allow creation of connected apps".

I clicked "New Connected App"

I created an editorapi app with OAuth settings:

• Require PKCE
• Require secret for web server flow
• Require secret for refresh token flow
• Callback URL: https://example.com
• Selected OAuth Scopes: Full access (full)

I copied the Consumer key and secret from "Manage consumer details".

Connecting to salesforce using restforce

With the above in place I was able to use restforce to connect to salesforce:

client = Restforce.new(
  username:      username,
  password:      password + security_token,
  client_id:     client_id,
  client_secret: client_secret,
  host:          'raspberrypi--digital.sandbox.my.salesforce.com',
  api_version:   '57.0'
)

Where username and password are from step 1, security_token from step 2 and client_id/client_secret from step 3 above. Note that the host is not the same as the URL you use to login to salesforce, lightning.force.com is replaced with my.salesforce.com.

I could then create an Account in Salesforce with

client.create('Account', { Name: 'Test Account' })

TODO

• Work out which user to associate salesforce editor api application with
• Create Salesforce application for editor api in production salesforce
• Associate sandbox editorapi application with correct user
• Reduce OAuth permissions for editorapi to the minimum required (currently "Full access" in the salesforce sandbox)
• Set new ENV variables in staging
• Set new ENV variables in production
• Work out whether we need to create Client records in Salesforce or if these are already created as part of another sync.
• Work out whether we need to create an Application record in Salesforce. This is suggested in the google sheet Jason and Emma put together, but I can't see it defined in the sandbox environment
• Work out how to back-fill all existing verified schools.
• Decide whether to store the Salesforce ID on the School (or another) record. It feels like this would be useful in case we need to later update the salesforce records.
• Do we want to try to find existing records for a school in Salesforce?
• Do we need to filter out "non-ExCS" schools?