viagogo-client 0.0.1.pre

data/lib/viagogo/public/api/categories.rb

@@ -0,0 +1,45 @@
+require 'viagogo/category'
+require 'viagogo/page'
+require 'viagogo/utils'
+
+module Viagogo
+  module Public
+    module API
+      module Categories
+        include Viagogo::Utils
+
+        def category(id, params={})
+          object_from_response(Viagogo::Category,
+                               Viagogo::CategoryRepresenter,
+                               :get,
+                               "/Public/Category/#{id}",
+                               params)
+        end
+
+        def categories_top(country_code, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::CategoryPageRepresenter,
+                               :get,
+                               "/Public/Category/#{country_code}/Top",
+                               params)
+        end
+
+        def categories_parents(country_code, id, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::CategoryPageRepresenter,
+                               :get,
+                               "/Public/Category/#{country_code}/Parents/#{id}",
+                               params)
+        end
+
+        def categories_children(country_code, id, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::CategoryPageRepresenter,
+                               :get,
+                               "/Public/Category/#{country_code}/Children/#{id}",
+                               params)
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/public/api/countries.rb

@@ -0,0 +1,29 @@
+require 'viagogo/country'
+require 'viagogo/page'
+require 'viagogo/utils'
+
+module Viagogo
+  module Public
+    module API
+      module Countries
+        include Viagogo::Utils
+
+        def country(code, params={})
+          object_from_response(Viagogo::Country,
+                               Viagogo::CountryRepresenter,
+                               :get,
+                               "/Public/Country/#{code}",
+                               params)
+        end
+
+        def countries(params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::CountryPageRepresenter,
+                               :get,
+                               "/Public/Country/All",
+                               params)
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/public/api/events.rb

@@ -0,0 +1,61 @@
+require 'viagogo/event'
+require 'viagogo/page'
+require 'viagogo/utils'
+
+module Viagogo
+  module Public
+    module API
+      module Events
+        include Viagogo::Utils
+
+        def event(id, params={})
+          object_from_response(Viagogo::Event,
+                               Viagogo::EventRepresenter,
+                               :get,
+                               "/Public/Event/#{id}",
+                               params)
+        end
+
+        def events_by_category(category_id, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::EventPageRepresenter,
+                               :get,
+                               "/Public/Event/ByCategory/#{category_id}",
+                               params)
+        end
+
+        def events_by_metro_area(metro_area_id, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::EventPageRepresenter,
+                               :get,
+                               "/Public/Event/ByMetroArea/#{metro_area_id}",
+                               params)
+        end
+
+        def events_by_venue(venue_id, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::EventPageRepresenter,
+                               :get,
+                               "/Public/Event/ByVenue/#{venue_id}",
+                               params)
+        end
+
+        def events_by_utc_start_date(year, month, day, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::EventPageRepresenter,
+                               :get,
+                               "/Public/Event/ByUtcStartDate/#{year}/#{month}/#{day}",
+                               params)
+        end
+
+        def events_search(query, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::EventPageRepresenter,
+                               :get,
+                               "/Public/Event/Search",
+                               params.merge(:searchText => query))
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/public/api/geographies.rb

@@ -0,0 +1,29 @@
+require 'viagogo/geography'
+require 'viagogo/page'
+require 'viagogo/utils'
+
+module Viagogo
+  module Public
+    module API
+      module Geographies
+        include Viagogo::Utils
+
+        def geography(id, params={})
+          object_from_response(Viagogo::Geography,
+                               Viagogo::GeographyRepresenter,
+                               :get,
+                               "/Public/Geography/#{id}",
+                               params)
+        end
+
+        def geographies(params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::GeographyPageRepresenter,
+                               :get,
+                               "/Public/Geography/All",
+                               params)
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/public/api/listings.rb

@@ -0,0 +1,29 @@
+require 'viagogo/listing'
+require 'viagogo/page'
+require 'viagogo/utils'
+
+module Viagogo
+  module Public
+    module API
+      module Listings
+        include Viagogo::Utils
+
+        def listing(id, params={})
+          object_from_response(Viagogo::Listing,
+                               Viagogo::ListingRepresenter,
+                               :get,
+                               "/Public/Listing/#{id}",
+                               params)
+        end
+
+        def listings_by_event(event_id, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::ListingPageRepresenter,
+                               :get,
+                               "/Public/Listing/ByEvent/#{event_id}",
+                               params)
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/public/api/metro_areas.rb

@@ -0,0 +1,29 @@
+require 'viagogo/metro_area'
+require 'viagogo/page'
+require 'viagogo/utils'
+
+module Viagogo
+  module Public
+    module API
+      module MetroAreas
+        include Viagogo::Utils
+
+        def metro_area(id, params={})
+          object_from_response(Viagogo::MetroArea,
+                               Viagogo::MetroAreaRepresenter,
+                               :get,
+                               "/Public/MetroArea/#{id}",
+                               params)
+        end
+
+        def metro_areas(params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::MetroAreaPageRepresenter,
+                               :get,
+                               "/Public/MetroArea/All",
+                               params)
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/public/api/venues.rb

@@ -0,0 +1,29 @@
+require 'viagogo/page'
+require 'viagogo/utils'
+require 'viagogo/venue'
+
+module Viagogo
+  module Public
+    module API
+      module Venues
+        include Viagogo::Utils
+
+        def venue(id, params={})
+          object_from_response(Viagogo::Venue,
+                               Viagogo::VenueRepresenter,
+                               :get,
+                               "/Public/Venue/#{id}",
+                               params)
+        end
+
+        def venues_by_metro_area(metro_area_id, params={})
+          object_from_response(Viagogo::Page,
+                               Viagogo::VenuePageRepresenter,
+                               :get,
+                               "/Public/Venue/ByMetroArea/#{metro_area_id}",
+                               params)
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/public/client.rb

@@ -0,0 +1,27 @@
+require 'viagogo/client'
+require 'viagogo/public/api/categories'
+require 'viagogo/public/api/countries'
+require 'viagogo/public/api/events'
+require 'viagogo/public/api/geographies'
+require 'viagogo/public/api/listings'
+require 'viagogo/public/api/metro_areas'
+require 'viagogo/public/api/venues'
+require 'viagogo/public/oauth'
+
+module Viagogo
+  module Public
+    # Client for the viagogo API public service
+    #
+    # @see http://developer.viagogo.net/documentation/description-of-services/public-services
+    class Client < Viagogo::Client
+      include Viagogo::Public::API::Categories
+      include Viagogo::Public::API::Countries
+      include Viagogo::Public::API::Events
+      include Viagogo::Public::API::Geographies
+      include Viagogo::Public::API::Listings
+      include Viagogo::Public::API::MetroAreas
+      include Viagogo::Public::API::Venues
+      include Viagogo::Public::OAuth
+    end
+  end
+end

data/lib/viagogo/public/oauth.rb

@@ -0,0 +1,25 @@
+require 'cgi'
+require 'viagogo/token'
+
+module Viagogo
+  module Public
+    # OAuth authentication helper methods for [Viagogo::Public::Client]
+    module OAuth
+      def get_access_token(scope="API.Public")
+        response = get("/Public/SimpleOAuthAccessRequest",
+                       {:scope => scope, :is_token_request => true})
+
+        utcNowTime = Time.now.utc
+        tokenAndSecret = CGI.parse(response[:body] || "")
+        Token.new do |token|
+          token.expiry_timestamp = utcNowTime + (24 * 60 * 60)
+          token.issue_timestamp = utcNowTime
+          token.oauth_token = tokenAndSecret["oauth_token"][0]
+          token.oauth_token_secret = tokenAndSecret["oauth_token_secret"][0]
+          token.scope = scope
+          token.type = "access token"
+        end
+      end
+    end
+  end
+end

data/lib/viagogo/resource.rb

@@ -0,0 +1,14 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/link'
+
+module Viagogo
+  class Resource < OpenStruct
+  end
+
+  module ResourceRepresenter
+    include Representable::JSON
+
+    property :link, as: :Link, extend: Viagogo::LinkRepresenter, class: Viagogo::Link
+  end
+end

data/lib/viagogo/response/follow_redirects.rb

@@ -0,0 +1,17 @@
+require 'faraday_middleware'
+
+module Viagogo
+  module Response
+    class FollowRedirects < FaradayMiddleware::FollowRedirects
+      AUTH_HEADER = 'Authorization'.freeze
+
+      private
+
+      def update_env(env, request_body, response)
+        env[:request_headers].delete(AUTH_HEADER)
+
+        super(env, request_body, response)
+      end
+    end
+  end
+end

data/lib/viagogo/response/raise_error.rb

@@ -0,0 +1,36 @@
+require 'faraday'
+require 'viagogo/error'
+
+module Viagogo
+  module Response
+    class RaiseError < Faraday::Middleware
+      def initialize(app, options = {})
+        super(app)
+        @options = options
+      end
+
+      def call(env)
+        @app.call(env).on_complete do |response|
+          case response[:status].to_i
+            when 400
+              raise Viagogo::BadRequestError, error_message_400(response)
+            when 401
+              raise Viagogo::UnauthorizedError, error_message_400(response)
+            when 403
+              raise Viagogo::ForbiddenError, error_message_400(response)
+            when 404
+              raise Viagogo::NotFoundError, error_message_400(response)
+            when 405
+              raise Viagogo::MethodNotAllowedError, error_message_400(response)
+            when 500
+              raise Viagogo::InternalServerError
+          end
+        end
+      end
+
+      def error_message_400(response)
+        "#{response[:method].to_s.upcase} #{response[:url].to_s}: #{response[:status]}}"
+      end
+    end
+  end
+end

data/lib/viagogo/site_url.rb

@@ -0,0 +1,15 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/resource'
+
+module Viagogo
+  class SiteUrl < OpenStruct
+  end
+
+  module SiteUrlRepresenter
+    include Representable::JSON
+
+    property :country_code, as: :CountryCode
+    property :link, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+  end
+end

data/lib/viagogo/token.rb

@@ -0,0 +1,17 @@
+module Viagogo
+  class Token
+    attr_accessor :expiry_timestamp,
+                  :issue_timestamp,
+                  :oauth_token,
+                  :oauth_token_secret,
+                  :scope,
+                  :type
+
+    def initialize(options={})
+      options.each do |key, value|
+        send(:"#{key}=", value)
+      end
+      yield self if block_given?
+    end
+  end
+end

data/lib/viagogo/utils.rb

@@ -0,0 +1,12 @@
+module Viagogo
+  module Utils
+    def object_from_response(klass,
+                             klass_representer,
+                             request_method,
+                             path,
+                             options = {})
+      response = send(request_method.to_sym, path, options)
+      response[:status] == 200 ? klass.new.extend(klass_representer).from_json(response[:body] || "") : nil
+    end
+  end
+end

data/lib/viagogo/venue.rb

@@ -0,0 +1,24 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/resource'
+
+module Viagogo
+  class Venue < OpenStruct
+  end
+
+  module VenueRepresenter
+    include Representable::JSON
+
+    property :id, as: :Id
+    property :name, as: :Name
+    property :address_line_1, as: :AddressLine1
+    property :address_line_2, as: :AddressLine2
+    property :city, as: :City
+    property :state_province, as: :StateProvince
+    property :country_code, as: :CountryCode
+    property :postal_code, as: :PostalCode
+    property :metro_area, as: :MetroArea, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    property :events, as: :Events, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    property :time_zone_description, as: :TimeZoneDescription
+  end
+end