Class: Webhookdb::Oauth::Provider

Inherits:

Object

• Object
• Webhookdb::Oauth::Provider

Defined in:

lib/webhookdb/oauth.rb

Direct Known Subclasses

FakeProvider, FrontProvider, IncreaseProvider, IntercomProvider

Instance Method Summary

• #app_name ⇒ String

  Name of the app to present to users.

• #authorization_url(state:) ⇒ String

  The Oauth URL to send users to to begin OAuth.

• #build_marketplace_integrations(organization:, tokens:) ⇒ Webhookdb::ServiceIntegration

  Create the actual service integrations for the given org.

• #exchange_authorization_code(code:) ⇒ Webhookdb::Oauth::Tokens

  Exchange the access code (from the authorization url) for access and/or refresh tokens.

• #key ⇒ String

  Unique key to identify the provider.

• #supports_webhooks? ⇒ Boolean

  This is similar to ‘supports_webhooks` in the Replicator descriptors, except that this is used to make the success page dynamic.

Instance Method Details

#app_name ⇒ String

Returns Name of the app to present to users.

Returns:

• (String) —

  Name of the app to present to users.

Raises:

• (NotImplementedError)

# File 'lib/webhookdb/oauth.rb', line 19

def app_name = raise NotImplementedError

#authorization_url(state:) ⇒ String

Returns The Oauth URL to send users to to begin OAuth.

Returns:

• (String) —

  The Oauth URL to send users to to begin OAuth.

Raises:

• (NotImplementedError)

# File 'lib/webhookdb/oauth.rb', line 28

def authorization_url(state:) = raise NotImplementedError

#build_marketplace_integrations(organization:, tokens:) ⇒ Webhookdb::ServiceIntegration

Create the actual service integrations for the given org.

Parameters:

• organization (Webhookdb::Organization)
• tokens (Webhookdb::Oauth::Tokens)

Returns:

• (Webhookdb::ServiceIntegration)

Raises:

• (NotImplementedError)

# File 'lib/webhookdb/oauth.rb', line 38

def build_marketplace_integrations(organization:, tokens:) = raise NotImplementedError

#exchange_authorization_code(code:) ⇒ Webhookdb::Oauth::Tokens

Exchange the access code (from the authorization url) for access and/or refresh tokens.

Returns:

• (Webhookdb::Oauth::Tokens)

Raises:

• (NotImplementedError)

# File 'lib/webhookdb/oauth.rb', line 32

def exchange_authorization_code(code:) = raise NotImplementedError

#key ⇒ String

Returns Unique key to identify the provider.

Returns:

• (String) —

  Unique key to identify the provider.

Raises:

• (NotImplementedError)

# File 'lib/webhookdb/oauth.rb', line 16

def key = raise NotImplementedError

#supports_webhooks? ⇒ Boolean

This is similar to ‘supports_webhooks` in the Replicator descriptors, except that this is used to make the success page dynamic. True if this provider’s integrations support webhooks (real-time or user-built webhook payloads).

Returns:

• (Boolean)

Raises:

• (NotImplementedError)

# File 'lib/webhookdb/oauth.rb', line 25

def supports_webhooks? = raise NotImplementedError