Module: Lighthouse

Defined in:
lib/lighthouse.rb

Overview

Ruby lib for working with the Lighthouse API’s XML interface.

The first thing you need to set is the account name. This is the same as the web address for your account.

Lighthouse. = 'activereload'

Then, you should set the authentication. You can either use your login credentials with HTTP Basic Authentication or with an API Tokens. You can find more info on tokens at lighthouseapp.com/help/using-beacons.

# with basic authentication
Lighthouse.authenticate('[email protected]', 'spacemonkey')

# or, use a token
Lighthouse.token = 'abcdefg'

If no token or authentication info is given, you’ll only be granted public access.

This library is a small wrapper around the REST interface. You should read the docs at lighthouseapp.com/api.

Defined Under Namespace

Classes: Base, Bin, Error, Membership, Message, Milestone, Project, Ticket, Token, User

Class Attribute Summary collapse

Class Method Summary collapse

Class Attribute Details

.account ⇒ Object

Returns the value of attribute account.



30
31
32
 
# File 'lib/lighthouse.rb', line 30

def 
  @account
end

.domain_format ⇒ Object

Returns the value of attribute domain_format.



29
30
31
 
# File 'lib/lighthouse.rb', line 29

def domain_format
  @domain_format
end

.email ⇒ Object

Returns the value of attribute email.



29
30
31
 
# File 'lib/lighthouse.rb', line 29

def email
  @email
end

.host_format ⇒ Object

Returns the value of attribute host_format.



29
30
31
 
# File 'lib/lighthouse.rb', line 29

def host_format
  @host_format
end

.password ⇒ Object

Returns the value of attribute password.



29
30
31
 
# File 'lib/lighthouse.rb', line 29

def password
  @password
end

.port ⇒ Object

Returns the value of attribute port.



29
30
31
 
# File 'lib/lighthouse.rb', line 29

def port
  @port
end

.protocol ⇒ Object

Returns the value of attribute protocol.



29
30
31
 
# File 'lib/lighthouse.rb', line 29

def protocol
  @protocol
end

.token ⇒ Object

Returns the value of attribute token.



30
31
32
 
# File 'lib/lighthouse.rb', line 30

def token
  @token
end

Class Method Details

.authenticate(email, password) ⇒ Object

Sets up basic authentication credentials for all the resources.



41
42
43
44
 
# File 'lib/lighthouse.rb', line 41

def authenticate(email, password)
  @email    = email
  @password = password
end

.resources ⇒ Object 



54
55
56
 
# File 'lib/lighthouse.rb', line 54

def resources
  @resources ||= []
end