event_inventory 0.0.1

data/lib/event_inventory.rb

@@ -0,0 +1,37 @@
+require 'active_support/core_ext'
+require 'patron'
+require 'sax-machine'
+
+module EventInventory
+  ROOT = 'http://services.eventinventory.com/webservices/'.freeze
+  CATALOG = File.join(ROOT, 'ticketsearch.asmx').freeze
+  EDIT_ORDER = File.join(ROOT, 'editorder.asmx').freeze
+  VIEW_ORDER = File.join(ROOT, 'vieworder.asmx').freeze
+
+  OLD_OPERATIONS = %w[
+    ListEvents_Active
+    GetEventList
+    ListVenues_Active
+    GetVenueList
+    ListBrokers_Active
+    ListShipping_Active
+    GetTicketInfo
+    CheckTicketAvailability
+    GetVenueMapURL
+    ListProductions_Active
+    ListTickets
+  ]
+
+  Error = Class.new(StandardError)
+  AuthorizationError = Class.new(Error)
+  ParameterError = Class.new(Error)
+  NetworkError = Class.new(Error)
+
+  mattr_accessor :security_token
+  mattr_accessor :proxy
+
+  autoload :Base, 'event_inventory/base'
+  autoload :Catalog, 'event_inventory/catalog'
+  autoload :FormatHelper, 'event_inventory/format_helper'
+  autoload :ParseHelper, 'event_inventory/parse_helper'
+end

data/lib/event_inventory/base.rb

@@ -0,0 +1,150 @@
+module EventInventory
+  class Base
+    class Action
+      include EventInventory::FormatHelper
+
+      attr_reader :name, :operation, :method, :service, :parser, :parameters
+
+      def initialize(operation, options={}, &block)
+        @name = options[:as] || operation
+        @operation = format_key(operation || options[:as])
+        @method = options[:method]
+        @service = options[:service]
+        @parser = options[:parser]
+        @parameters = {}
+
+        instance_eval(&block) if block_given?
+      end
+
+      # Adds a parameter that the web service accepts.
+      def parameter(name, options={})
+        @parameters[name] = options
+      end
+
+      def execute(*args)
+        parameters = args.first || {}
+        Request.new(self, parameters).perform
+      end
+    end
+
+    class Request
+      include EventInventory::FormatHelper
+
+      def initialize(action, parameters)
+        @action = action
+        @parameters = HashWithIndifferentAccess.new(parameters)
+      end
+
+      # Executes the call to the web service.
+      def perform
+        uri = URI.parse(url)
+
+        session = Patron::Session.new
+        session.timeout = 60
+        session.base_url = "#{uri.scheme}://#{uri.host}:#{uri.port}/"
+        session.proxy = EventInventory.proxy if EventInventory.proxy
+
+        retries = 5
+
+        begin
+          response = case @action.method
+            when :get
+              session.get([uri.path, uri.query].compact.join('?'))
+            when :post
+              session.post(uri.path, uri.query)
+          end
+        rescue Patron::PartialFileError, Patron::ConnectionFailed, Patron::HostResolutionError, Patron::TimeoutError
+          if (retries -= 1) > 0
+            retry
+          else
+            raise NetworkError.new($!.to_s)
+          end
+        end
+
+        case body = response.body
+          when /Security Token: (\w+) \(APPCLIENT_ID\) is not registered/
+            raise AuthorizationError, "Invalid security token (#{$1})"
+          when /IP Address: ([\d\.]+) is not enabled/
+            raise AuthorizationError, "Unauthorized IP (#{$1})"
+          when /^Missing parameter: (.*)\./
+            raise ParameterError, "Missing #{$1}"
+          when /There was an error parsing (\w+) parameter \[(\w+)=(.*?)\]/
+            raise ParameterError, "Invalid #{$2} (#{$1}, \"#{$3}\")"
+          else
+            @action.parser.parse(body) if body
+        end
+      end
+
+      def endpoint(service)
+        case service
+          when :catalog then CATALOG
+          else raise Error.new("Unknown endpoint for service (#{service})")
+        end
+      end
+      private :endpoint
+
+      # Builds the base URL from the endpoint and operation. If the method is
+      # GET, the query values are appended.
+      def url
+        base_url = "#{endpoint(@action.service)}/#{@action.operation}"
+        base_url << "?#{query(@action.operation)}" if @action.method == :get
+        base_url
+      end
+      private :url
+
+      # Builds the query string from the specified parameter values.
+      def query(operation)
+        old_format = OLD_OPERATIONS.include?(operation)
+
+        @action.parameters.collect do |key, options|
+          value = @parameters[options[:as] || key]
+          value ||= options[:default] if options.include?(:default)
+
+          "#{format_key(key, old_format)}=#{format_query_value(value)}"
+        end.tap do |parameters|
+          parameters << unless old_format
+            "SecurityToken=#{format_query_value(EventInventory.security_token)}"
+          else
+            "APPCLIENT_ID=#{format_query_value(EventInventory.security_token)}"
+          end
+        end.join('&')
+      end
+      private :query
+    end
+
+    class << self
+      # Sets or returns the service.
+      def service(service=nil)
+        unless service
+          read_inheritable_attribute(:service)
+        else
+          write_inheritable_attribute(:service, service)
+        end
+      end
+
+      # Creates a new GET operation.
+      def get(operation, options={}, &block)
+        action(operation, options.merge(:method => :get), &block)
+      end
+
+      # Creates a new POST operation.
+      def post(operation, options={}, &block)
+        action(operation, options.merge(:method => :post), &block)
+      end
+
+      # Creates a new operation.
+      def action(operation, options={}, &block)
+        options[:service] ||= service
+        options[:parser] ||= self::Parser
+        action = Action.new(operation, options, &block)
+
+        self.singleton_class.class_eval do
+          define_method(action.name) do |*args|
+            action.execute(*args)
+          end
+        end
+      end
+      private :action
+    end
+  end
+end

data/lib/event_inventory/catalog.rb

@@ -0,0 +1,12 @@
+module EventInventory
+  module Catalog
+    autoload :Base, 'event_inventory/catalog/base'
+    autoload :Category, 'event_inventory/catalog/category'
+    autoload :Configuration, 'event_inventory/catalog/configuration'
+    autoload :Event, 'event_inventory/catalog/event'
+    autoload :Performance, 'event_inventory/catalog/performance'
+    autoload :Performer, 'event_inventory/catalog/performer'
+    autoload :Ticket, 'event_inventory/catalog/ticket'
+    autoload :Venue, 'event_inventory/catalog/venue'
+  end
+end

data/lib/event_inventory/catalog/base.rb

@@ -0,0 +1,7 @@
+module EventInventory::Catalog
+  class Base < EventInventory::Base
+    service :catalog
+  end
+
+  ParseHelper = EventInventory::ParseHelper
+end

data/lib/event_inventory/catalog/category.rb

@@ -0,0 +1,25 @@
+module EventInventory::Catalog
+  class Category < Base
+    class Parser
+      include ParseHelper
+
+      class Category
+        include ParseHelper
+
+        element :row, :value => :category_id, :as => :id
+        element :row, :value => :category_name, :as => :name
+        element :row, :value => :parent_category_id, :as => :parent_id
+      end
+
+      elements :row, :as => :categories, :class => Category
+    end
+
+    get :get_all_categories, :as => :fetch
+
+    class << self
+      def all(parameters={})
+        fetch(parameters).categories
+      end
+    end
+  end
+end

data/lib/event_inventory/catalog/configuration.rb

@@ -0,0 +1,14 @@
+module EventInventory::Catalog
+  class Configuration < Base
+    class Parser
+      include ParseHelper
+
+      element :row, :value => :venuemap, :force => true, :as => :map_url
+    end
+
+    get :get_venue_map_url, :as => :fetch do
+      parameter :event_id, :as => :performer_id
+      parameter :venue_id
+    end
+  end
+end

data/lib/event_inventory/catalog/event.rb

@@ -0,0 +1,32 @@
+module EventInventory::Catalog
+  class Event < Base
+    class Parser
+      include ParseHelper
+
+      class Event
+        include ParseHelper
+
+        element :row, :value => :production_id, :as => :id
+        element :row, :value => :event_date, :as => :occurs_at
+        element :row, :value => :event_id, :as => :performer_id
+        element :row, :value => :opponent_event_id, :as => :opponent_id
+        element :row, :value => :venue_id, :as => :venue_id
+        element :row, :value => :short_note, :as => :note
+        element :row, :value => :is_long_note_available, :as => :has_note
+        element :row, :value => :min_cost, :as => :minimum_price
+        element :row, :value => :max_cost, :as => :maximum_price
+        element :row, :value => :content_standardization_type_id, :as => :content_standardization_type_id
+      end
+
+      elements :row, :as => :events, :class => Event
+    end
+
+    get :get_all_productions, :as => :fetch
+
+    class << self
+      def all(parameters={})
+        fetch(parameters).events
+      end
+    end
+  end
+end

data/lib/event_inventory/catalog/performer.rb

@@ -0,0 +1,26 @@
+module EventInventory::Catalog
+  class Performer < Base
+    class Parser
+      include ParseHelper
+
+      class Performer
+        include ParseHelper
+
+        element :row, :value => :event_id, :as => :id
+        element :row, :value => :event_name, :as => :name
+        element :row, :value => :event_type_id, :as => :event_type_id
+        element :row, :value => :category_id, :as => :category_id
+      end
+
+      elements :row, :as => :performers, :class => Performer
+    end
+
+    get :get_all_events, :as => :fetch
+
+    class << self
+      def all(parameters={})
+        fetch(parameters).performers
+      end
+    end
+  end
+end

data/lib/event_inventory/catalog/venue.rb

@@ -0,0 +1,32 @@
+module EventInventory::Catalog
+  class Venue < Base
+    class Parser
+      include ParseHelper
+
+      class Venue
+        include ParseHelper
+
+        element :row, :value => :venue_id, :as => :id
+        element :row, :value => :venue_name, :as => :name
+        element :row, :value => :address1, :as => :street_address
+        element :row, :value => :address2, :as => :extended_address
+        element :row, :value => :city, :as => :locality
+        element :row, :value => :region_code, :as => :region
+        element :row, :value => :postal_code, :as => :postal_code
+        element :row, :value => :country_code, :as => :country_code
+        element :row, :value => :phone, :as => :phone
+        element :row, :value => :market_area_id, :as => :market_area_id
+      end
+
+      elements :row, :as => :venues, :class => Venue
+    end
+
+    get :get_all_venues, :as => :fetch
+
+    class << self
+      def all(parameters={})
+        fetch(parameters).venues
+      end
+    end
+  end
+end

data/lib/event_inventory/format_helper.rb

@@ -0,0 +1,22 @@
+module EventInventory
+  module FormatHelper
+    # Formats keys for use in parsing responses and building query strings.
+    def format_key(key, old_format=false)
+      key = key.to_s
+      key.upcase! if key == 'id'
+      key.gsub!(/_id$/, '_ID')
+      key.gsub!(/_url$/, '_URL')
+      old_format ? key.upcase : key.camelize
+    end
+
+    # Formats and escapes query values for use in a query string.
+    def format_query_value(value)
+      value = case value
+        when Time, Date then value.to_s(:db)
+        else value.to_s
+      end
+
+      CGI.escape(value)
+    end
+  end
+end

data/lib/event_inventory/parse_helper.rb

@@ -0,0 +1,31 @@
+module EventInventory
+  module ParseHelper
+    def self.included(base)
+      base.class_eval do
+        include SAXMachine
+      end
+
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include FormatHelper
+
+      def element(name, options={})
+        if options[:value] && !options[:force]
+          options[:value] = format_key(options[:value])
+        end
+
+        super(name, options)
+      end
+
+      def elements(name, options={})
+        if options[:value] && !options[:force]
+          options[:value] = format_key(options[:value])
+        end
+
+        super(name, options)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification 
+name: event_inventory
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Tyler Hunt
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 0
+        - beta4
+        version: 3.0.0.beta4
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: patron
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        - 6
+        version: 0.4.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: sax-machine
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 15
+        version: 0.0.15
+  type: :runtime
+  version_requirements: *id003
+description: 
+email: 
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/event_inventory/base.rb
+- lib/event_inventory/catalog/base.rb
+- lib/event_inventory/catalog/category.rb
+- lib/event_inventory/catalog/configuration.rb
+- lib/event_inventory/catalog/event.rb
+- lib/event_inventory/catalog/performer.rb
+- lib/event_inventory/catalog/venue.rb
+- lib/event_inventory/catalog.rb
+- lib/event_inventory/format_helper.rb
+- lib/event_inventory/parse_helper.rb
+- lib/event_inventory.rb
+has_rdoc: true
+homepage: http://github.com/tylerhunt/event_inventory
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An interface library for the Event Inventory web service.
+test_files: []
+