Class: BaseProvider Abstract

Inherits:

Object

• Object
• BaseProvider

Defined in:

lib/cal_invite/providers/base_provider.rb

Overview

This class is abstract.

Subclass and override #generate to implement a calendar provider

app/lib/base_provider.rb Base class for calendar providers that implements common functionality and defines the interface that all providers must implement.

Direct Known Subclasses

CalInvite::Providers::Google, CalInvite::Providers::IcsContent, CalInvite::Providers::Office365, CalInvite::Providers::Outlook, CalInvite::Providers::Yahoo

Instance Attribute Summary

• #event ⇒ Object readonly

  Returns the value of attribute event.

Instance Method Summary

• #generate ⇒ String abstract

  Generate a calendar URL or content for the event.

• #initialize(event) ⇒ BaseProvider constructor

  Initialize a new calendar provider.

Constructor Details

#initialize(event) ⇒ BaseProvider

Initialize a new calendar provider

# File 'lib/cal_invite/providers/base_provider.rb', line 14

def initialize(event)
  @event = event
end

Instance Attribute Details

#event ⇒ Object (readonly)

Returns the value of attribute event.

# File 'lib/cal_invite/providers/base_provider.rb', line 9

def event
  @event
end

Instance Method Details

#generate ⇒ String

This method is abstract.

Generate a calendar URL or content for the event. This method must be implemented by all provider subclasses.

Raises:

• (NotImplementedError) —

  if the provider class doesn’t implement this method

# File 'lib/cal_invite/providers/base_provider.rb', line 24

def generate
  raise NotImplementedError, "#{self.class} must implement #generate"
end