chiketto 0.0.2 → 0.0.3

Sign up to get free protection for your applications and to get access to all the features.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +18 -5
  3. data/lib/chiketto/version.rb +1 -1
  4. metadata +2 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 1768bc70da3e48380d8910456c5f55fcd9a882c1
4
- data.tar.gz: 2f949518b15b4258dee4a863758e58b28b1d304e
3
+ metadata.gz: 83ec9115edcc91aebbee0a99c61dd44102464667
4
+ data.tar.gz: d03b93c1ec3577ee45bfd8b488ca8f36f8f4e818
5
5
  SHA512:
6
- metadata.gz: 31416533b8c8c98c82b2940846037a3fb817378e72f346f35e69962b75d8f1474322704a1c73afc6e31c0ab8abc4fb1040879a33038874e0275be7822503c6bb
7
- data.tar.gz: ccb0f0bf3eac15fcbd932b8443bdb95b208b642658791145f97377d4fe12af2dd7c95b0517d656d950297d5c3e33686bd485878bd7f591e2760bc5356006e001
6
+ metadata.gz: 96505a6e856b26128f29a1c12f689432bf8d6ac6f5a57b3e5f757fccb9f8d2ec622a4e14d2212234df60f8d54a1daaf74c7676586112dcc5eed431bd32cc966e
7
+ data.tar.gz: f33d909107e2710cec5b997baa7ad9a55169577fe1ad718ec2a649a2c99a973dc7126864856f251abded08226ec46891571417d8ff6b95b1cc7656e3119ff586
data/README.md CHANGED
@@ -24,19 +24,32 @@ Or install it yourself as:
24
24
 
25
25
  ## Usage
26
26
 
27
- ```
28
- Chiketto.token = EVENTBRITE_API_TOKEN
29
- ```
27
+ Chiketto will read your API access token from the `EVENTBRITE_API_TOKEN` enviroment variable, at some point it will allow this to be set explicitly.
28
+
29
+ Chiketto allows you to acces data from the Eventbrite API and formats it as Ruby objects for use within your application.
30
30
 
31
- or Chiketto will read from the `EVENTBRITE_API_TOKEN` enviroment variable if this is set.
31
+ For example, once you've found an event on the API, Chiketto provides a simple interface for the various pieces of data to make working with it easier.
32
32
 
33
33
  ```
34
34
  event = Chiketto::Event.find 123456
35
- Chiketto::Event::Attendees event or Chiketto::Event::Attendees 123456
35
+ event.name # => 'Event Name'
36
+ event.name.html # => '<p>Event Name</p>'
37
+ event.organizer # => Chicketto::Organizer
38
+ event.organizer.name # => 'Organizer Name'
39
+ ```
40
+
41
+ You can also use the search endpoint on the API to look up events and have an Array of events returned:
36
42
 
43
+ ```
37
44
  Chiketto::Event.search 'name'
38
45
  ```
39
46
 
47
+ Finally, for now, Chiketto allows you to list out all the possible Categories on the Eventbrite API, returning an Array of Category objects.
48
+
49
+ ```
50
+ Chiketto::Category.list
51
+ ```
52
+
40
53
  ## Contributing
41
54
 
42
55
  1. Fork it ( https://github.com/[my-github-username]/chiketto/fork )
@@ -1,3 +1,3 @@
1
1
  module Chiketto
2
- VERSION = "0.0.2"
2
+ VERSION = "0.0.3"
3
3
  end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: chiketto
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.2
4
+ version: 0.0.3
5
5
  platform: ruby
6
6
  authors:
7
7
  - Chris Radford
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2014-05-17 00:00:00.000000000 Z
11
+ date: 2014-05-18 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: bundler