EventbriteClient 0.0.1 → 0.0.2

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3

data/EventbriteClient.gemspec

@@ -15,6 +15,8 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = EventbriteClient::VERSION
 
+  gem.required_ruby_version = '>= 1.8.7'
   gem.add_dependency('rest-client', '>= 1.6.7')
   gem.add_dependency('json', '>= 1.7')
+  gem.add_development_dependency('rake')
 end

data/README.md

@@ -1,6 +1,8 @@
 # EventbriteClient
 
-TODO: Write a gem description
+[![Build Status](https://secure.travis-ci.org/kurtisnelson/EventbriteClient.png?branch=master)](http://travis-ci.org/kurtisnelson/EventbriteClient)
+
+A library for querying the EventBrite API. It is [published](https://rubygems.org/gems/EventbriteClient) on RubyGems. Full documentation is at [rubydoc.info](http://rubydoc.info/gems/EventbriteClient/)
 
 ## Installation
 
@@ -18,7 +20,10 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+	eb = EventbriteClient::API.new(:app_key => "YOUR KEY")
+        events = eb.event_search({:keywords => ("food", "fun")})
+
+Currently just event search is implemented. All parameters [documented](http://developer.eventbrite.com/doc/events/event_search/) should be supported.
 
 ## Contributing
 

data/lib/EventbriteClient.rb

@@ -2,12 +2,19 @@ require "EventbriteClient/version"
 require 'rest_client'
 require 'json'
 
+#A library for using the EventBrite API
 module EventbriteClient
+  #Makes RESTful API calls
   class API
-    # constructor
+    # Setup a session with the specified API keys
+    #
+    # @param [Hash{String=>String}] auth_tokens Eventbrite API keys
+    # @option auth_tokens [String] :app_key Application key
+    # @option auth_tokens [String] :user_key Optional user key
+    #
     def initialize( auth_tokens )
       @base_url = "https://www.eventbrite.com"
-      @auth = {app_key: "IT7XL4RVM2CGSGTVLX"}
+      @auth = {:app_key => "IT7XL4RVM2CGSGTVLX"}
       @data_type = "json"
 
       if auth_tokens != nil and auth_tokens.is_a? Hash
@@ -15,14 +22,17 @@ module EventbriteClient
         #use api_key OR api_key + user_key OR api_key+email+pass
         if auth_tokens.include? :user_key
           # read/write access on the user account associated with :user_key
-          @auth = {app_key: auth_tokens[:app_key], user_key: auth_tokens[:user_key]}
+          @auth = {:app_key => auth_tokens[:app_key], :user_key => auth_tokens[:user_key]}
         else
           # read-only access to public data
-          @auth = {app_key: auth_tokens[:app_key]}
+          @auth = {:app_key => auth_tokens[:app_key]}
         end 
       end                                                                                        end
     end
 
+  # Search for and return an array of events
+    # @param [Hash{String=>String,Array,Integer}] params API request parameters
+    # @see http://developer.eventbrite.com/doc/events/event_search/ Event Search Documentation
   def event_search (params)
     querystring = @auth.merge( params.is_a?(Hash) ? params : {} )
     url = @base_url + "/#{@data_type}/event_search"

data/lib/EventbriteClient/version.rb

@@ -1,3 +1,4 @@
 module EventbriteClient
-  VERSION = "0.0.1"
+  #Gem version
+  VERSION = "0.0.2"
 end

data/test/test_api.rb

@@ -8,5 +8,7 @@ class TestApi < Test::Unit::TestCase
     def test_event_search
         events = @eb.event_search({})
         assert events.count > 0, "No events were returned"
+        events = @eb.event_search({:keywords => ("food")})
+        assert events.count > 0, "The keywords broke, or nobody likes food"
     end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: EventbriteClient
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -43,6 +43,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Access the Eventbrite API
 email:
 - kurtisnelson@gmail.com
@@ -51,6 +67,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - EventbriteClient.gemspec
 - Gemfile
 - LICENSE
@@ -70,13 +87,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 3960420601421177276
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24