zvent 0.0.3

data/README

@@ -0,0 +1,42 @@
+= Zvent 0.0.3
+
+An interface with zvents API without all the mess.
+
+== Description
+
+An interface with zvents API without all the mess.
+
+== Usage
+
+give it your API key when you initialize the session object.
+	@zvent = Zvent::Sesion.new('API_KEY')
+
+To get an event you give it an event id.
+This call returns an event object.
+	event = @zvent.find_event('12345')
+	
+The event can get images of all different types and sizes
+	event.image('tiny')			# returns an image (44x44)
+
+The event can have categories of sorts
+	event.categories				# returns the category object
+
+The event has support for timezones.  Please read the rdoc for more examples
+	event.startTime					# Returns the UTC of the start time
+	event.endTime(false)    # Returns the end time of the event in local time to the venue.  
+													# If the venue is in US/Pacific the time of the event will come back
+													# in US/Pacific.
+
+Each event has a venue object
+	venue = event.venue 		# returns the venue object
+
+To search for events give it a location
+	events = @zvent.find_events('Simi Valley, CA')
+	events[:event_count] 		# how many events total are in this search
+	events[:events] 			# access to the array of events
+
+== TODO
+
+- Get a list of categories
+- Implement tzinfo timezones of events
+- Have it not blow up if event can not be found with find_event call

data/lib/core/ext.rb

@@ -0,0 +1,18 @@
+# backported from rails
+class Hash
+  def to_query(namespace = nil)
+    collect do |key, value|
+      value.to_query(namespace ? "#{namespace}[#{key}]" : key)
+    end.sort * '&'
+  end
+end
+
+class Object
+  def to_query(key)
+    "#{CGI.escape(key.to_s)}=#{CGI.escape(to_param.to_s)}"
+  end
+  
+  def to_param
+    to_s
+  end    
+end

data/lib/zvent.rb

@@ -0,0 +1,11 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+
+require 'rubygems'
+require 'json'
+require 'tzinfo'
+require 'cgi'
+require 'net/http'
+
+Dir[File.dirname(__FILE__) + "/zvent/*.rb"].each { |file| require(file) }

data/lib/zvent/base.rb

@@ -0,0 +1,36 @@
+module Zvent
+  BASE_URL = "http://www.zvents.com/rest"  
+
+  # raised when no location is given when it is required
+  class NoLocationError < StandardError; end
+  
+  # raised when no id proveded when it is required
+  class NoIdError < StandardError; end
+  
+  # raise when not given an API key
+  class NoApiKeyError < StandardError; end
+  
+  # raise when the API doesn't like the request
+  class ZventApiError < StandardError; end
+  
+  class InvalidImageSize < StandardError; end
+        
+  class Base
+    
+    # Get Json and parse it
+    def get_resources(url)
+      url = URI.parse(url)
+      
+      res = Net::HTTP.start(url.host, url.port) {|http|
+        http.get(url.request_uri+"&format=json&key=#{@api_key}")
+      }
+      resources = JSON.parse(res.body)
+      
+      if resources['rsp']['status'] == 'error'
+        raise Zvent::ZventApiError.new(resources['rsp']['msg'])
+      end
+      
+      return resources      
+    end
+  end
+end

data/lib/zvent/category.rb

@@ -0,0 +1,14 @@
+module Zvent
+  # An object that represents a single venue from zvents
+  class Category < Base
+    attr_accessor  :name, :pid, :id, :count
+    
+    def initialize(category_hash)
+      begin
+        category_hash.each_pair{|key, value| self.send("#{key}=", value) }
+      rescue NoMethodError => e
+        # Do nothing!
+      end
+    end    
+  end
+end

data/lib/zvent/event.rb

@@ -0,0 +1,121 @@
+module Zvent  
+  # An object that represents a single event from zvents
+  class Event < Base    
+    IMAGE_SIZES = ['tiny', 'medium', 'featured', 'primary', 'original']    
+    
+    attr_accessor :name, :artists, :price, :private, :editors_pick, :url, :approved,
+                  :sc, :id, :images, :description, :vid, :color, :phone, :startTime,
+                  :endTime, :zurl, :venue, :categories
+    
+    # expects the json hash that is given from zvents
+    def initialize(event_hash)
+      begin
+        event_hash.each_pair{|key, value| self.send("#{key}=", value) }
+      rescue NoMethodError => e
+        # Do nothing!
+      end
+    end
+    
+    # Get the start time of the event.  Events are guaranteed an start time.  
+    # The function will return a DateTime object of the time.
+    #
+    # <b>options</b>
+    # <tt>utc</tt> - Want the time in local (to the venue) or in UTC? Defaults to UTC
+    def startTime(utc=true)
+      # if there is no startTime return nil
+      return nil if @startTime.nil?
+      
+      # Parse the startTime
+      start_time = DateTime.parse(@startTime)
+      
+      # Decide if we need to return UTC or local time
+      utc ? DateTime.parse(self.tz_timezone.local_to_utc(start_time).to_s) : start_time
+    end
+    
+    # Get the end time of the event.  Events are not guaranteed an end time.    
+    # The function will return a DateTime object of the time.  If there isn't an endtime it will return nil.  
+    #
+    # <b>options</b>
+    # <tt>utc</tt> - Want the time in local (to the venue) or in UTC? Defaults to UTC
+    def endTime(utc=true)
+      # if there is no startTime return nil
+      return nil if @endTime.nil?
+      
+      # Parse the startTime
+      end_time = DateTime.parse(@endTime)
+      
+      # Decide if we need to return UTC or local time
+      utc ? DateTime.parse(self.tz_timezone.local_to_utc(end_time).to_s) : end_time 
+    end
+            
+    # Returns the tz timezone object from the venue
+    def tz_timezone ; @venue.tz_timezone; end
+        
+    # Does the event have any images
+    def images?  ; !(@images.nil? || @images.empty?); end
+    
+    # Does the event or venue have any images
+    def deep_images?
+      self.images? || (@venue.nil? ? false : @venue.images?)
+    end
+    
+    # Categories takes in some json
+    def categories=(categories_json)
+      categories_json.each do |category|
+        if @categories.nil?
+          @categories = [Zvent::Category.new(category)]
+        else
+          @categories << Zvent::Category.new(category)
+        end
+      end if categories_json
+    end
+    
+    def category? ; !(@categories.nil? || @categories.empty?) ; end
+    
+    # Returns the first image it sees from event.  If none is found it will return nil
+    # <b>size</b>
+    # * <tt>tiny</tt> - 44x44
+    # * <tt>medium</tt> - 66x66
+    # * <tt>featured</tt> - 150x150
+    # * <tt>primary</tt> - 184x184
+    # * <tt>original</tt> Will just grab the original image from zvents (default)    
+    def image(size='original')
+      self.images? ? convert_image(@images.first, size) : nil
+    end
+    
+    # Returns the first image it sees.  First it checks the event for images thent the venue for images.
+    # If none is found it will return nil
+    # 
+    # <b>size</b>
+    # * <tt>tiny</tt> - 44x44
+    # * <tt>medium</tt> - 66x66
+    # * <tt>featured</tt> - 150x150
+    # * <tt>primary</tt> - 184x184
+    # * <tt>original</tt> Will just grab the original image from zvents (default)
+    def deep_image(size='original')
+      image = nil
+      if self.images?
+        image = @images.first
+      elsif self.venue
+        image = @venue.images? ? @venue.images.first : nil                
+      else
+        image = nil
+      end
+
+      (image.nil?) ? image : convert_image(image, size)
+    end
+    
+    private    
+    # grab the size of the image requested  
+    def convert_image(image, size)      
+      # Apparently venue returns a different kind of image than event.
+      image_url = image.class == Hash ? image['url'] : image
+      
+      # if the size is original just return the image
+      return image_url if size == 'original'
+
+      # else grab the specific size
+      IMAGE_SIZES.include?(size) ? image_url.insert(image_url.index('.jpg'), "_#{size}") : (raise Zvent::InvalidImageSize.new)
+    end     
+  end
+end

data/lib/zvent/session.rb

@@ -0,0 +1,115 @@
+module Zvent
+  # A zvent session used to search and everything
+  class Session < Base
+    # Initializes the session object.  It requires an API key
+    def initialize(api_key)
+      raise Zvent::NoApiKeyError.new if !api_key || api_key.strip.empty?
+      @api_key = api_key
+    end
+    
+    # Use this method to find events from zvents.
+    #
+    # <b>Return</b>
+    # returns a hash that contains an array of events and an event count  
+    # {:event_count => 10, :events => [<# event>, ...]}
+    # 
+    # <b>Arguments</b>
+    # 
+    # location
+    # * <tt>location</tt> - A string describing a location around which the search results will be restricted. (e.g., san francisco, ca or 94131). You can also specify a location using a longitude/latitude coordinate pair using the notation -74.0:BY:40.9    
+    #  
+    # zvent_options
+    # * <tt>what</tt> - The string against which events are matched. (e.g., parade). (<tt>default</tt> = nil, which searches for everything)
+    # * <tt>when</tt> - A string specifying a date range for the search (e.g., today, this week, next week, friday, etc.). Explicit date ranges can be specified by separating two dates with the word "to" (e.g., monday to thursday, 10/30/2007 to 11/4/2007). Leave this string blank to search all future events.	
+    # * <tt>radius</tt> - The number of miles around the location (specified in the where field) to search. If this field is left blank, a default radius is supplied. The default radius varies according to the location specified in the where field.	
+    # * <tt>limit</tt> - The maximum number of matching events to return. The default is 10 and maximum is 10. Zvents partners can exceed the maximum.(<tt>Default</tt> = 10.  <tt>Max</tt> = 25)
+    # * <tt>offset</tt> - The number of events to skip from the beginning of the search results. If a search matches 1000 events, returning 25 events starting at offset 100 will return event numbers 100-125 that match the search. (<tt>Default</tt> = 0)
+    # * <tt>trim</tt> - Set to 1 if repeating events should be trimmed from the search results. Set to 0 to return repeating events. If the trim option is enabled, only 1 event will be returned from each repeating series that matches the search. The number of events within the series that match the search is returned in the series_count response parameter. Defaults to 1.
+    # * <tt>sort</tt> - Set to 1 to sort search results by start time. Set to 0 to sort search results by relevance. Defaults to 0.	
+    # * <tt>cat</tt> - Restrict your search to items that belong to a specific category. You must provide a category identifier which can be determined using the categories API call.	
+    #	* <tt>catex</tt> - Exclude items from a specific category from the search. You must provide a category identifier which can be determined using the categories API call.	
+    #
+    # options
+    # * <tt>as_json</tt> - If set to true method will return the json from zvents without any transformation.  (<tt>false</tt> by default).
+    #  
+    # Examples:
+    #   find_events('93063')
+    #   => Finds any 10 events near the 93063 zip code area.
+    #
+    #   find_events('611 N. Brand Blvd. Glendale, Ca', {:what => 'dancing', :limit => 25})
+    #   => Finds 25 events near the address that consists of dancing
+    #
+    #   find_events('611 N. Brand Blvd. Glendale, Ca', {:what => 'dancing'}, {:as_json => true})
+    #   => Should return the json straight from zvents
+    #
+    def find_events(location, zvent_options = {}, options = {})      
+      #location is required
+      raise Zvent::NoLocationError.new if !location || location.strip.empty?
+      
+      #grab the json from zvents
+      json_ret = get_resources(BASE_URL+"/search?#{zvent_options.merge(:where => location).to_query}")
+      
+      #return the json or objectified json
+      options[:as_json] ? json_ret : objectify_zvents_json(json_ret)
+    end
+    
+    # Use this method to return a single event from zvents
+    #
+    # <b>Return</b>
+    # returns an single event.  If an event can not be found it will return nil
+    # <# event>
+    #  
+    # <b>Arguments</b>
+    # event_id
+    # * <tt>id</tt> - ID of the event
+    #
+    # options
+    # * <tt>as_json</tt> - If set to true method will return the json from zvents without any transformation.  (<tt>false</tt> by default).
+    #  
+    # Examples:
+    #   find_event('1234')
+    #   => Finds an event with the id of 1234
+    #
+    #   find_event('1234', {:as_json => true})
+    #   => Finds an event with the id of 1234 and returns the json as it comes in from zvents
+    def find_event(event_id, zvent_options={}, options = {})
+      # event_id is required
+      raise Zvent::NoIdError if event_id.strip.empty?
+      
+      #grab the json from zvents
+      json_ret = get_resources(BASE_URL+"/event?#{zvent_options.merge(:id => event_id).to_query}")
+      
+      #return the json or objectified json
+      options[:as_json] ? json_ret : objectify_zvents_json(json_ret)[:events].first
+    end
+    
+    protected
+    def objectify_zvents_json(json)
+      venues = objectify_venues(json['rsp']['content']['venues'])
+      {:events => objectify_events(json['rsp']['content']['events'], venues),
+       :event_count => json['rsp']['content']['event_count']||0}      
+    end
+    
+    # returns a hash of venues
+    # {venue_id => <# venue >, ...}
+    def objectify_venues(venues)
+      venue_hash = {}
+      venues.each do |venue|
+        v = objectify_venue(venue)
+        venue_hash[v.id] = v
+      end if venues && !venues.empty?
+      venue_hash
+    end
+    
+    # returns an array of events
+    def objectify_events(events, venues_hash)
+      (events && !events.empty?) ? events.collect{|e| objectify_event(e, venues_hash[e['vid']])} : []        
+    end
+    
+    # Turns the event json into an event object  
+    def objectify_event(event_hash, venue) ; Event.new(event_hash.merge(:venue => venue)) ; end
+
+    # Turns the venue json into a venue object    
+    def objectify_venue(venue) ; Venue.new(venue) ; end
+  end
+end

data/lib/zvent/venue.rb

@@ -0,0 +1,24 @@
+module Zvent
+  # An object that represents a single venue from zvents
+  class Venue < Base
+    attr_accessor  :address, :city, :state, :country, :name, :latitude, 
+                   :longitude, :zip, :private, :id, :timezone, :zurl,
+                   :types, :images, :phone, :url, :description, :parent_id
+    
+    def initialize(venue_hash)
+      begin
+        venue_hash.each_pair{|key, value| self.send("#{key}=", value) }
+      rescue NoMethodError => e
+        # Do nothing!
+      end
+    end
+    
+    # Does the venue have any images
+    def images? ; !@images.empty? ; end
+    
+    def timezone? ; !(@timezone.nil? || @timezone.empty?) ; end
+    
+    # Returns the tz timezone object
+    def tz_timezone ;  timezone? ? TZInfo::Timezone.get(@timezone) : nil ; end
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: zvent
+version: !ruby/object:Gem::Version 
+  version: 0.0.3
+platform: ruby
+authors: 
+- Austin Fonacier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-07-23 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: tzinfo
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.9
+    version: 
+description: Interface for the zvents API without all the mess.
+email: afonacier@yellowpages.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- lib/zvent.rb
+- lib/zvent/event.rb
+- lib/zvent/venue.rb
+- lib/zvent/base.rb
+- lib/zvent/category.rb
+- lib/zvent/session.rb
+- lib/core/ext.rb
+- README
+has_rdoc: true
+homepage: http://github.com/austinrfnd/zvent-gem/
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.0.1
+signing_key: 
+specification_version: 2
+summary: Interface for the zvents API without all the mess.
+test_files: []
+