eventfulapi 2.1

data/README

@@ -0,0 +1,10 @@
+A library for working with the Eventful API. Simple programmatic access to
+Eventful's database of events, venues, performers and speakers, groups,
+calendars, and users.
+
+See http://api.eventful.com/ for general information about the API, and
+http://api.eventful.com/docs/libs/ruby/doc for documentation about the Ruby library.
+
+Copyright 2005-2007 EVDB, Inc. All rights reserved. This module is distributed
+under the same terms as Ruby itself (see
+http://www.ruby-lang.org/en/LICENSE.txt)

data/lib/eventful/api.rb

@@ -0,0 +1,271 @@
+# A library for working with the Eventful API. Simple programmatic access to
+# Eventful's database of events, venues, performers and speakers, groups,
+# calendars, and users.
+#
+# See http://api.eventful.com for more information about the Eventful API and
+# the available API methods.
+#
+# = Example Usage
+#
+#  require 'rubygems'
+#  require 'eventful/api'
+#
+#  begin
+#
+#    # Start an API session with a username and password
+#    eventful = Eventful::API.new 'application_key', 
+#                                 'user' => 'username',
+#                                 'password' => 'password'
+#
+#    # Lookup an event by its unique id
+#    event = eventful.call 'events/get',
+#                          'id' => 'E0-001-001042544-7'
+#
+#    puts "Event Title: #{event['title']}"
+#    
+#    # Get information about that event's venue
+#    venue = eventful.call 'venues/get', 
+#                          'id' => event['venue_id']
+#
+#    puts "Venue: #{venue['name']}"
+#
+#  rescue Eventful::APIError => e
+#    puts "There was an error fetching the event: #{e}"
+#  end
+#
+#
+# = API Key
+#
+# Use of the Eventful API requires an application key (see http://api.eventful.com/keys for more information).
+#
+# = Change Notes
+#
+# == Eventful API
+#
+# === Version 2.1
+#
+# - As EVDB Inc. has been renamed Eventful Inc., the EVDB module has been 
+#   renamed Eventful, and the gem is now named eventfulapi. Support for the 
+#   evdbapi gem is being discontinued; please use the eventfulapi gem from now on.
+# - Much better at throwing an error when a network or server problem happens, 
+#   rather than failing silently and mysteriously
+# - Documentation improvements
+#
+# == EVDB API
+#
+# === Version 2.0.1
+#
+# - Fixed a minor documentation error
+#
+# === Version 2.0 
+#
+# Version 2.0 of this library includes some significant changes which may not
+# be backwards compatible. Specifically:
+#
+# - Anonymous logins are now allowed
+# - Fixes a potential image uploading API error
+#
+# Most importantly, the library now uses YAML as its data exchange format instead of
+# XML, and the objects returned from a call can be used like hashes instead of
+# REXML objects.
+#
+# = Information
+#
+# Status::             Stable
+# Version::            2.1
+# Date::               2007-03-24
+# Current Author::     Paul Knight (mailto:pknight@eventful.com)
+# Previous Authors::   Joe Auricchio
+# Copyright::          Copyright (C) 2005-2007 Eventful Inc.
+# License::            This code is distributed under the same terms as Ruby itself (see http://www.ruby-lang.org/en/LICENSE.txt)
+
+
+
+
+
+# mime/types is available as a gem, but that's out of our way if it happens to
+# be in our load path somewhere
+begin
+  require 'mime/types'
+rescue LoadError
+  require 'rubygems'
+  require 'mime/types'
+end
+
+# The rest of these are part of the standard distribution
+require 'yaml'
+require 'cgi'
+require 'net/http'
+require 'base64'
+require 'digest/md5'
+
+
+
+
+
+module Eventful
+
+
+  
+  # Version descriptor of this library
+  VERSION = '2.1'
+  
+  # Default API server to connect to
+  DEFAULT_API_SERVER = 'api.eventful.com' #:nodoc:
+  # Default server port
+  DEFAULT_API_PORT = 80 #:nodoc:
+  # Default server path
+  DEFAULT_API_ROOT = '/yaml/' #:nodoc:
+  
+  # Our POST data boundary
+  BOUNDARY = '1E666D29B5E749F6A145BE8A576049E6' #:nodoc:
+  BOUNDARY_MARKER = "--#{BOUNDARY}" #:nodoc:
+  BOUNDARY_END_MARKER = "--#{BOUNDARY}--" #:nodoc:
+  
+  
+  
+  # Parent Error used for all Eventful exceptions
+  class Error < StandardError ; end
+  
+  # An error that may also include the YAML response from the server
+  class APIError < Error
+    attr_reader :response
+    
+    # Creates a new exception.
+    def initialize(response)
+      super
+      @response = response
+    end
+    
+    # The error string returned by the API call.
+    def to_s
+      "#{@response['string']}: #{@response['description']}"
+    end
+  end
+  
+  
+  
+  # A class for working with the Eventful API.
+  class API
+    
+    
+    
+    # Create an object for working with the Eventful API. Working with the API
+    # requires an application key, which can be obtained at http://api.eventful.com/keys/
+    #
+    # Options may be:
+    #
+    # <tt>'user'</tt>:: Authenticate as this user, required for some API methods. A password must also be specified.
+    # <tt>'password'</tt>:: Password for user authentication.
+    # <tt>'api_server'</tt>, <tt>'api_root'</tt>, <tt>'api_port'</tt>:: For specifying a different API server.
+    #
+    # Example:
+    # 
+    #  eventful = Eventful::API.new 'app_key',
+    #                               'user' => 'username', 
+    #                               'password' => 'password'
+    #
+    def initialize(app_key, options = {})
+      @api_server = options['api_server'] || DEFAULT_API_SERVER
+      @api_root = options['api_root'] || DEFAULT_API_ROOT
+      @api_port = options['api_port'] || DEFAULT_API_PORT
+      
+      @auth_user = options['auth_user']
+      @auth_password = options['auth_password']
+      
+      @authentication = nil
+      
+      # User authentication
+      if (options['user'] && options['password'])
+        # Get a nonce; we expect an error response here, so rescue the exception and continue
+        begin
+          response = call 'users/login', 
+                          'app_key' => app_key
+        rescue APIError => err
+          raise if !err.response['nonce']
+          nonce = err.response['nonce']
+        end
+        
+        # Login with a hash of the nonce and our password
+        login_hash = Digest::MD5.hexdigest("#{nonce}:#{Digest::MD5.hexdigest(options['password'])}")
+        response = call 'users/login', 
+                        'app_key' => app_key, 
+                        'user' => options['user'], 
+                        'nonce' => nonce, 
+                        'response' => login_hash
+      
+        # Store authentication information and use it for all future calls
+        @authentication = { 'app_key' => app_key, 
+                            'user' => options['user'], 
+                            'user_key' => response['user_key'] }
+      else
+        @authentication = { 'app_key' => app_key }
+      end
+    end
+
+
+    
+    # Prepares the body of the POST request
+    def prepare_post(params) #:nodoc:
+      content = ""
+      params.each do |key, value|
+        content += BOUNDARY_MARKER + "\r\n"
+        if key.to_s =~ /_file$/
+          content += "Content-Disposition: file; name=\"#{CGI::escape(key.to_s)}\"; filename=\"#{value}\"\r\b"
+          content += "Content-Type: #{MIME::Types.type_for(value.to_s)}\r\n"
+          content += "Content-Transfer-Encoding: binary\r\n\r\n"
+          content += open(value) { |f| f.read } + "\r\n"
+        else
+          content += "Content-Disposition: form-data; name=\"#{CGI::escape(key.to_s)}\";\r\n\r\n#{value}\r\n" 
+        end
+      end
+      content += BOUNDARY_END_MARKER
+      return content
+    end
+
+
+
+    # Calls an API method with the given parameters, and returns the reply as
+    # a hash. Please see the Eventful API documentation (http://api.eventful.com/docs)
+    # for information about methods and their parameters.
+    #
+    # Example:
+    #
+    #  event = eventful.call 'events/get',
+    #                        'id' => 'E0-001-001042544-7'
+    #
+    def call(method, params = {})
+      # Use available auth tokens
+      params.merge! @authentication if @authentication
+
+      response = Net::HTTP.start(@api_server, @api_port) do |connection|
+        if @auth_user && @auth_password then
+          connection.post(
+            "#{@api_root}#{method}", 
+            prepare_post(params), 
+            "Content-type" => "multipart/form-data; boundary=#{BOUNDARY} ", 
+            "Authorization" => Base64.encode64("#{@auth_user}:#{@auth_password}"))
+        else
+          connection.post(
+            "#{@api_root}#{method}", 
+            prepare_post(params), 
+            "Content-type" => "multipart/form-data; boundary=#{BOUNDARY} ")
+        end
+      end
+      
+      # Raise an exception if we didn't get a 2xx response code
+      response.value
+      
+      yaml = YAML::load response.body
+      
+      # Raise an error if we got an API error
+      raise APIError.new(yaml['error']) if yaml['error']
+
+      return yaml
+    end
+    
+    
+    
+  end # class API
+end # module Eventful
+

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.9.2
+specification_version: 1
+name: eventfulapi
+version: !ruby/object:Gem::Version 
+  version: "2.1"
+date: 2007-03-26 00:00:00 -07:00
+summary: Interface to the Eventful API. http://eventful.com
+require_paths: 
+- lib
+email: pknight@eventful.com
+homepage: http://api.evdb.com
+rubyforge_project: 
+description: 
+autorequire: eventful/api
+default_executable: 
+bindir: bin
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">"
+    - !ruby/object:Gem::Version 
+      version: 0.0.0
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+post_install_message: 
+authors: 
+- Paul Knight, originally with Joe Auricchio
+files: 
+- lib/eventful
+- lib/eventful/api.rb
+- README
+test_files: []
+
+rdoc_options: 
+- -inline-code
+extra_rdoc_files: 
+- README
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mime-types
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Version::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: