An open API service indexing awesome lists of open source software.

https://github.com/jefflarkin/rupcoming

A Ruby Implementation of the Upcoming.org API
https://github.com/jefflarkin/rupcoming

Last synced: 12 months ago
JSON representation

A Ruby Implementation of the Upcoming.org API

Awesome Lists containing this project

README

          

RUpcoming
Author: Jeff Larkin
License: MIT License

Description:
A Ruby (partial) implementation of the Upcoming.org API. Responses
return ruby objects where the each attribute becomes a class variable
with appropriate get/set methods.

Security:
Although the values of XML attributes are slash-escaped to prevent
misinterpretation of incidental or malicous quote characters, this library
does assume that XmlSimple will properly handle malformed or malicious
XML.

Usage:

require 'upcoming'
Upcoming::Event.apikey = ""
e = Upcoming::Event.find_by_event_id

NOTE - The apikey needs to be set just once for multiple API calls.

Dependencies:
XmlSimplea (Currently assumed to come via RubyGems)
Net::Http
CGI

Caveats:
Because Rails comes with a slightly different version of XmlSimple, the
require 'xmlsimple' statement may need to be removed to work in a Rails
project.

Todo:
* Add test suite
* Create gem
* Implement Category.getList
* Implement Auth functionality
* Complete remaining API