Class: Readiness::Salesforce::Client

Inherits:
Object
  • Object
show all
Defined in:
lib/support_readiness/salesforce/client.rb

Overview

Defines the class Client within the module Readiness::Salesforce.

Author:

  • Jason Colyer

Since:

  • 1.0.12

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = Readiness::Salesforce::Configuration.new) ⇒ Client

Creates a new Readiness::Salesforce::Client instance

Examples:

require 'support_readiness'
config = Readiness::Salesforce::Configuration.new
config.api_version = '58.0'
config.client_id = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789'
config.client_secret = 'XYZ789'
config.password = 'p@ssw0rd!'
config.security_token = 'ABC123'
config.username = 'alice@example.com'
client = Readiness::Salesforce::Client.new(config)

Parameters:

Author:

  • Jason Colyer

Since:

  • 1.0.12



32
33
34
 
# File 'lib/support_readiness/salesforce/client.rb', line 32

def initialize(config = Readiness::Salesforce::Configuration.new)
  @connection = generate_connection(config)
end

Instance Attribute Details

#connection ⇒ Object

Since:

  • 1.0.12



14
15
16
 
# File 'lib/support_readiness/salesforce/client.rb', line 14

def connection
  @connection
end

Instance Method Details

#generate_connection(config) ⇒ Object

Generates a connection to Salesforce

Examples:

require 'support_readiness'
config = Readiness::Salesforce::Configuration.new
config.api_version = '58.0'
config.client_id = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ123456789'
config.client_secret = 'XYZ789'
config.password = 'p@ssw0rd!'
config.security_token = 'ABC123'
config.username = 'alice@example.com'
connection = Readiness::Salesforce::Client.generate_connection(config)

Parameters:

Author:

  • Jason Colyer

Since:

  • 1.0.12



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/support_readiness/salesforce/client.rb', line 52

def generate_connection(config)
  Restforce.new(
    api_version: config.api_version,
    client_id: config.client_id,
    client_secret: config.client_secret,
    host: config.host,
    password: config.password,
    security_token: config.security_token,
    username: config.username
  )
end