https://github.com/ngerakines/erlang_lighthouse

An Erlang client to interact with lighthouse
https://github.com/ngerakines/erlang_lighthouse

Last synced: about 1 month ago
JSON representation

An Erlang client to interact with lighthouse

• Host: GitHub
• URL: https://github.com/ngerakines/erlang_lighthouse
• Owner: ngerakines
• Created: 2009-01-10T04:46:17.000Z (almost 16 years ago)
• Default Branch: master
• Last Pushed: 2009-01-10T21:01:36.000Z (almost 16 years ago)
• Last Synced: 2024-05-01T13:43:23.384Z (8 months ago)
• Language: Erlang
• Homepage: http://ngerakines.github.com/erlang_lighthouse
• Size: 87.9 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.markdown

Awesome Lists containing this project

README

        
erlang\_lighthouse is an Erlang client library to interface with the lighthouseapp.com API.

**This is ALPHA software and is actively being developed and changed. Do Not Use.**

## Features

 * Can support multiple forms of authentication including username/password combinations as well as API keys.

 * Has a really simple interface to automate common items easily.

## Use

The first two parameters of every API function will always be the server and the authentication information. The server variable is the base name of the lighthouse domain.

For the activereload.lighthouseapp.com domain, the server variable would be "activereload".

The second parameter is the authentication information. This is either a 1 or 2 value tuple. The one value tuple's single value is a string representing a valid API token.

The two value tuple is used for username and password authentication

### Example

    $ erl

    ...

    1 > lighthouse:projects("activereload", {"APIKEY123"}).

    {projects,[{type,"array"}],

              [{project,[],

                        [{archived,[{type,"boolean"}],["false"]},

                         {'created-at',[{type,"datetime"}], ... }

    2> lighthouse:projects("activereload", {"username", "password"}).

    {projects,[{type,"array"}],

              [{project,[],

                        [{archived,[{type,"boolean"}],["false"]},

                         {'created-at',[{type,"datetime"}], ... }

    3> lighthouse:create_ticket("socklabs", {"APIKEY123"}, "23169-erlang_lighthouse", "Update bobbles").

    {ticket,[],

            [{'assigned-user-id',[{type,"integer"},{nil,"true"}],[]},

             {'attachments-count',[{type,"integer"}],["0"]}, ... }

    4> lighthouse:create_ticket("socklabs", {"APIKEY123"}, "23169-erlang_lighthouse", "Update bobbles", [{"user", "26027"}, {"milestone", "28145-01"}]).

    {ticket,[],

            [{'assigned-user-id',[{type,"integer"}],["26027"]},

             {'attachments-count',[{type,"integer"}],["0"]},

             {closed,[{type,"boolean"}],["false"]}, ... }

## Support

**Note**: This library requires r12-5 or later.

Please use http://socklabs.lighthouseapp.com/projects/23169-erlang\_lighthouse/overview for any issues or questions for this library.