Module: Ketchup

Defined in:

lib/ketchup.rb

Overview

Ketchup Ruby API

See Also:

• http://useketchup.com

Author:

• Pat Allan

Defined Under Namespace

Classes: API, AccessDenied, Item, ItemArray, Meeting, MeetingArray, Note, NoteArray, Profile, Project

Class Method Summary

• .authenticate(email, password) ⇒ Ketchup::Profile

  Creates a new profile authenticated against the Ketchup API.

Class Method Details

.authenticate(email, password) ⇒ Ketchup::Profile

Creates a new profile authenticated against the Ketchup API. This is the recommended method to get access to an account’s meetings, notes and items.

Examples:

profile = Ketchup.authenticate 'foo@bar.com', 'secret'

Parameters:

• email (String) —

  The user’s email address

• password (String) —

  The user’s passwords

Returns:

• (Ketchup::Profile) —

  A new profile instance

Raises:

• (Ketchup::AccessDenied) —

  when the email or password is incorrect

# File 'lib/ketchup.rb', line 23

def self.authenticate(email, password)
  Ketchup::Profile.load(email, password)
end