Class: Ribose::Connection

Inherits:
Base
  • Object
show all
Includes:
Actions::All, Actions::Delete
Defined in:
lib/ribose/connection.rb

Class Method Summary collapse

Methods included from Actions::Delete

#delete

Methods included from Actions::Base

#included

Methods included from Actions::All

#all

Methods inherited from Base

#initialize

Methods included from ResourceHelper

#resource_id, #resource_key, #resource_path, #resources

Constructor Details

This class inherits a constructor from Ribose::Base

Class Method Details

.all(options = {}) ⇒ Sawyer::Resource

List Connections

Note: Currently, There are some chaching in place for this endpoint which requires us to pass the ‘s` query params otherwise we might have some unexpected behavior sometime. That’s why we are adding the ‘s` incase that’s not present with the query options.

Parameters:

  • options (Hash) (defaults to: {}) —

    Query parameters as a Hash

Returns:

  • (Sawyer::Resource) 


16
17
18
 
# File 'lib/ribose/connection.rb', line 16

def self.all(options = {})
  new(options.merge(query: { s: "" })).all
end

.disconnect(resource_id, options = {}) ⇒ Object

Disconnect

Disconnect connection / contact with the provided connection id. This will return nothing for successful request, but if disconnect fails then it will raise an Error for the client.

Returns:

  • nil



40
41
42
 
# File 'lib/ribose/connection.rb', line 40

def self.disconnect(resource_id, options = {})
  delete(resource_id, options)
end

.suggestions(client: nil, **options) ⇒ Array <Sawyer::Resource>

List connection suggestions

Parameters:

  • options (Hash) —

    Query parameters as a Hash

Returns:

  • (Array <Sawyer::Resource>) 


25
26
27
28
 
# File 'lib/ribose/connection.rb', line 25

def self.suggestions(client: nil, **options)
  Request.get("people_finding", client: client, query: options).
    suggested_connection
end