Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 96 lines (63 sloc) 3.313 kb
20b4107 @therabidbanana More renaming
authored
1 eventbrite
4928748 @therabidbanana More markdown fixes
authored
2 ================
0601977 @therabidbanana Initial code
authored
3
ce52574 @therabidbanana Note about not being actively maintained, fix debugging message
authored
4 This gem is no longer actively maintained, though I do try to fix any reported
5 bugs. For a more official gem, see: https://github.com/ryanjarvinen/eventbrite-client.rb
6
2b77dbf @therabidbanana Fix up a spec for 1.9, update some docs
authored
7 A simple library for integrating with EventBrite's API. Requires the "httparty" gem
8 for connecting and doing XML parsing, and "tzinfo" gem for getting back and forth
9 between timezone names and GMT offsets.
10
11 The gem was recently renamed from Eventbright - since that was
12 a confusing name.
0601977 @therabidbanana Initial code
authored
13
14 Usage
15 -----
16
20b4107 @therabidbanana More renaming
authored
17 require 'eventbrite'
18 Eventbrite.setup("APP_KEY")
19 user = Eventbrite::User.new("USER_KEY") #=> <Eventbrite::User >
20 user.venues #=> [<Eventbrite::Venue>,...] # Venues the user has defined
d1c8a63 @therabidbanana The beginnings of support for Venues
authored
21
1b2443e @therabidbanana Link docs
authored
22
23 Some basic (yardoc generated) documentation availabe at: http://therabidbanana.github.com/eventbrite/
24
c5e3632 @therabidbanana Improve commenting and documentation
authored
25 This library attempts to create an almost ActiveResource like wrapper
26 around the Eventbrite api. The following objects are available:
27
28 * Attendee (can only be viewed, not edited)
29 * Discount
30 * Event (has many Tickets, Attendees, Discounts, has one Venue and
31 one Organizer)
32 * Organizer (has many Events)
33 * Ticket
34 * User (has many Events, Organizers, Venues)
35 * Venue
36
37
38
d1c8a63 @therabidbanana The beginnings of support for Venues
authored
39 Authentication
40 --------------
4928748 @therabidbanana More markdown fixes
authored
41 Many methods require user authentication. For these methods, you can pass a user object as an authentication token, and the user's api_key will automatically be used for the request.
d1c8a63 @therabidbanana The beginnings of support for Venues
authored
42
43 Example:
44
20b4107 @therabidbanana More renaming
authored
45 Eventbrite::Event.new({"x" => "y"... , "user" => user})
d1c8a63 @therabidbanana The beginnings of support for Venues
authored
46
c5e3632 @therabidbanana Improve commenting and documentation
authored
47 Known Issues
4928748 @therabidbanana More markdown fixes
authored
48 ----------
49
2b77dbf @therabidbanana Fix up a spec for 1.9, update some docs
authored
50 1. This library's testing coverage is almost zero.
ddef212 @therabidbanana Added discounts
authored
51 2. There is no subuser support.
d1c8a63 @therabidbanana The beginnings of support for Venues
authored
52
2b77dbf @therabidbanana Fix up a spec for 1.9, update some docs
authored
53
d1c8a63 @therabidbanana The beginnings of support for Venues
authored
54 A Note About App Keys
55 ---------------------
0601977 @therabidbanana Initial code
authored
56
4928748 @therabidbanana More markdown fixes
authored
57 This gem has an application key for accessing EventBrite, but each app key is limited to 30,000 requests a day. To make sure your limits aren't affected by others, you should register for your own app key specific to the application you're adding the gem to.
d1c8a63 @therabidbanana The beginnings of support for Venues
authored
58
4928748 @therabidbanana More markdown fixes
authored
59 If you just want to give the gem a whirl (you have to wait for approval to get your own) just don't call setup. The app key for the gem will be used.
0601977 @therabidbanana Initial code
authored
60
5d77225 @therabidbanana Fixed my markdown syntax in readme
authored
61 Learn more about EventBrite's App Key policy here: [Terms of Service](http://www.eventbrite.com/api/terms)
0601977 @therabidbanana Initial code
authored
62
5d77225 @therabidbanana Fixed my markdown syntax in readme
authored
63 Register for your own app key here: [Request a Key](http://www.eventbrite.com/api/key/)
0601977 @therabidbanana Initial code
authored
64
65
c5e3632 @therabidbanana Improve commenting and documentation
authored
66 API Gotchas
67 ------------
de08253 @therabidbanana Beginning support for Events class. Lots of API inconsistencies.
authored
68
c5e3632 @therabidbanana Improve commenting and documentation
authored
69 I've compiled a list of issues developers may encounter with the poorly
70 designed Eventbrite API (in case you're writing your own integration
71 from scratch in Ruby or any other language).
6765b53 @therabidbanana Events saves new organizations / venues first before adding them to even...
authored
72
c5e3632 @therabidbanana Improve commenting and documentation
authored
73 There are many places where variable names are misspelled, or format is
74 changed, and many places where the API documentation is flat out wrong
75 (dates are not ISO8601 anywhere in the eventbrite api, though they claim
76 they are).
6765b53 @therabidbanana Events saves new organizations / venues first before adding them to even...
authored
77
c5e3632 @therabidbanana Improve commenting and documentation
authored
78 Read the details at: http://therabidbanana.github.com/eventbrite/file.ImplementationGotchas.html
6765b53 @therabidbanana Events saves new organizations / venues first before adding them to even...
authored
79
de08253 @therabidbanana Beginning support for Events class. Lots of API inconsistencies.
authored
80
0601977 @therabidbanana Initial code
authored
81 Note on Patches/Pull Requests
82 -----------------------------
83
84 * Fork the project.
85 * Make your feature addition or bug fix.
86 * Add tests for it. This is important so I don't break it in a
87 future version unintentionally.
88 * Commit, do not mess with rakefile, version, or history.
89 (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
90 * Send me a pull request. Bonus points for topic branches.
91
92 Copyright
93 ---------
94
95 Copyright (c) 2010 David Haslem. See LICENSE for details.
Something went wrong with that request. Please try again.