viagogo-client 0.0.1.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ed92f607696324531344d5e3857043930e1704e7
+  data.tar.gz: 80f90573bdb4a563f3414c5b7a3336abfb91b9e5
+SHA512:
+  metadata.gz: eecc02b778d2a878c7b62f0c0bac583be5be8a9485167269aab156f69956288d30ad615c30383720022e4b827c74e08005342c3720cff019b973b1b723e6e1b1
+  data.tar.gz: 1a8b0989dc73bc0eda514808e0c3aa9eb0317ccb873b12dbfb95a9eaf587fc28a63878c27e010fb3159904b9d22250a12ea6e4343a90dd5a58853b5ca231856b

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.idea/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in viagogo.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Akil Burgess
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# Viagogo
+
+Ruby toolkit for working with the viagogo API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'viagogo-client'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install viagogo-client
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( http://github.com/akilb/viagogo.rb/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/viagogo-client.rb

@@ -0,0 +1 @@
+require 'viagogo'

data/lib/viagogo.rb

@@ -0,0 +1,3 @@
+require 'viagogo/client'
+require 'viagogo/public/client'
+require 'viagogo/version'

data/lib/viagogo/category.rb

@@ -0,0 +1,21 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/resource'
+require 'viagogo/site_url'
+
+module Viagogo
+  class Category < OpenStruct
+  end
+
+  module CategoryRepresenter
+    include Representable::JSON
+
+    property :id, as: :Id
+    property :name, as: :Name
+    property :image_url, as: :ImageUrl
+    property :events, as: :Events, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    collection :child_categories, as: :ChildCategories, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    collection :parent_categories, as: :ParentCategories, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    collection :site_urls, as: :SiteUrls, extend: Viagogo::SiteUrlRepresenter, class: Viagogo::SiteUrl
+  end
+end

data/lib/viagogo/client.rb

@@ -0,0 +1,105 @@
+require 'faraday'
+require 'viagogo/connection'
+require 'viagogo/error'
+require 'viagogo/version'
+
+module Viagogo
+
+  # Client for the viagogo API
+  #
+  # @see http://developer.viagogo.net
+  class Client
+    attr_accessor :access_token,
+                  :access_token_secret,
+                  :consumer_key,
+                  :consumer_secret
+    include Viagogo::Connection
+
+    # TODO: Use SSL
+    API_ENDPOINT = "http://api.viagogo.net".freeze
+
+    # Initializes a new Client
+    #
+    # @param options [Hash]
+    # @raise [Viagogo::Error::ConfigurationError] Error is raised when supplied
+    #   viagogo credentials are not a String or Symbol.
+    # @return [Viagogo::Client]
+    def initialize(options={})
+      options.each do |key, value|
+        send(:"#{key}=", value)
+      end
+      yield self if block_given?
+
+      validate_credential_type!
+    end
+
+    # @return [Hash]
+    def credentials
+      {
+          :consumer_key    => consumer_key,
+          :consumer_secret => consumer_secret,
+          :token           => access_token,
+          :token_secret    => access_token_secret,
+      }
+    end
+
+    # @return [Boolean]
+    def credentials?
+      credentials.values.all?
+    end
+
+    # @return [String]
+    def user_agent
+      @user_agent ||= "viagogo Ruby Gem #{Viagogo::VERSION}"
+    end
+
+    # Perform an HTTP HEAD request
+    def delete(path, params = {})
+      request(:delete, path, params)
+    end
+
+    # Perform an HTTP GET request
+    def get(path, params = {})
+      request(:get, path, params)
+    end
+
+    # Perform an HTTP HEAD request
+    def head(path, params = {})
+      request(:head, path, params)
+    end
+
+    # Perform an HTTP POST request
+    def post(path, params = {})
+      request(:post, path, params)
+    end
+
+    # Perform an HTTP PUT request
+    def put(path, params = {})
+      request(:put, path, params)
+    end
+
+    private
+
+    # Perform an HTTP request
+    #
+    # @return [Hash] object containing response information
+    def request(method, path, params = {})
+      is_token_request = params.delete(:is_token_request)
+
+      connection(API_ENDPOINT, is_token_request || false).send(method.to_sym, path, params).env
+    end
+
+    # Ensures that all credentials set during configuration are of a
+    # valid type. Valid types are String and Symbol.
+    #
+    # @raise [Viagogo::Error::ConfigurationError] Error is raised when
+    #   supplied viagogo credentials are not a String or Symbol.
+    def validate_credential_type!
+      credentials.each do |credential, value|
+        next if value.nil? || value.is_a?(String) || value.is_a?(Symbol)
+        fail(ConfigurationError,
+             "Invalid #{credential} specified: #{value.inspect} must be a string or symbol.")
+      end
+    end
+  end
+end

data/lib/viagogo/connection.rb

@@ -0,0 +1,43 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'viagogo/response/follow_redirects'
+require 'viagogo/response/raise_error'
+
+module Viagogo
+  module Connection
+    private
+
+    def connection_options
+      @connection_options ||= {
+        :headers => {
+            :accept => 'application/json',
+            :content_type => 'application/json',
+            :user_agent => user_agent,
+        },
+        :request => {
+            :open_timeout => 5,
+            :timeout => 10
+        },
+      }
+    end
+
+    def connection(endpoint, is_token_request=false)
+      Faraday::Connection.new(endpoint, connection_options) do |builder|
+        request_credentials = credentials.clone.delete_if do |k,v|
+          k == :token || k == :token_secret if is_token_request
+        end
+        # Signs requests according to the OAuth protocol
+        builder.use FaradayMiddleware::OAuth, request_credentials
+        # Encodes request the body as JSON
+        builder.use FaradayMiddleware::EncodeJson
+        # Automatically follow 301, 302 and 307 redirects
+        builder.use Viagogo::Response::FollowRedirects
+        # Handle error responses
+        builder.use Viagogo::Response::RaiseError
+
+        # Set Faraday's HTTP adapter
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/viagogo/country.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/resource'
+
+module Viagogo
+  class Country < OpenStruct
+  end
+
+  module CountryRepresenter
+    include Representable::JSON
+
+    property :code, as: :Code
+    property :name, as: :Name
+    property :geography, as: :Geography, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+  end
+end

data/lib/viagogo/error.rb

@@ -0,0 +1,25 @@
+module Viagogo
+  # Custom error class for rescuing from all viagogo errors
+  class Error < StandardError; end
+
+  class ConfigurationError < Error; end
+
+  # Raised when viagogo returns the HTTP status code 400
+  class BadRequestError < Error; end
+
+  # Raised when viagogo returns the HTTP status code 401
+  class UnauthorizedError < Error; end
+
+  # Raised when viagogo returns the HTTP status code 403
+  class ForbiddenError < Error; end
+
+  # Raised when viagogo returns the HTTP status code 404
+  class NotFoundError < Error; end
+
+  # Raised when viagogo returns the HTTP status code 405
+  class MethodNotAllowedError < Error; end
+
+  # Raised when viagogo returns the HTTP status code 500
+  class InternalServerError < Error; end
+
+end

data/lib/viagogo/event.rb

@@ -0,0 +1,31 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/site_url'
+require 'viagogo/resource'
+
+module Viagogo
+  class Event < OpenStruct
+  end
+
+  module EventRepresenter
+    include Representable::JSON
+
+    property :id, as: :Id
+    property :name, as: :Name
+    property :start_datetime_utc, as: :StartDateTimeUtc #TODO Convert to DateTime
+    property :end_datetime_utc, as: :EndDateTimeUtc #TODO Convert to DateTime
+    property :start_datetime_local, as: :StartDateTimeLocal #TODO Convert to DateTime
+    property :end_datetime_local, as: :EndDateTimeUtc #TODO Convert to DateTime
+    property :total_listings, as: :TotalListings
+    property :total_available_tickets, as: :TotalAvailableTickets
+    property :minimum_price, as: :MinimumPrice
+    property :maximum_price, as: :MaximumPrice
+    property :default_currency_code, as: :DefaultCurrencyCode
+    property :is_available_for_public_listing, as: :IsAvailableForPublicListing
+    property :is_available_for_public_purchase, as: :IsAvailableForPublicPurchase
+    property :has_premium_listings, as: :HasPremiumListings
+    property :venue, as: :Venue, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    property :listings, as: :Listings, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    collection :site_urls, as: :SiteUrls, extend: Viagogo::SiteUrlRepresenter, class: Viagogo::SiteUrl
+  end
+end

data/lib/viagogo/geography.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/resource'
+
+module Viagogo
+  class Geography < OpenStruct
+  end
+
+  module GeographyRepresenter
+    include Representable::JSON
+
+    property :id, as: :Id
+    property :name, as: :Name
+    property :country, as: :Country, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+  end
+end

data/lib/viagogo/link.rb

@@ -0,0 +1,16 @@
+require 'ostruct'
+require 'representable/json'
+
+module Viagogo
+  class Link < OpenStruct
+  end
+
+  module LinkRepresenter
+    include Representable::JSON
+
+    property :href, as: :HRef
+    property :type, as: :Type
+    property :rel, as: :Rel
+    property :target, as: :Target
+  end
+end

data/lib/viagogo/listing.rb

@@ -0,0 +1,28 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/resource'
+
+module Viagogo
+  class Listing < OpenStruct
+  end
+
+  module ListingRepresenter
+    include Representable::JSON
+
+    property :id, as: :Id
+    property :event_id, as: :EventId
+    property :event_name, as: :EventName
+    property :event, as: :Event, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    property :section, as: :Section
+    property :row, as: :Row
+    property :seat_from, as: :SeatFrom
+    property :seat_to, as: :SeatTo
+    property :available_tickets, as: :AvailableTickets
+    property :default_current_price, as: :DefaultCurrentPrice
+    property :currency_code, as: :CurrencyCode
+    property :is_active, as: :IsActive
+    property :ticket_class_description, as: :TicketClassDescription
+    property :ticket_type, as: :TicketType
+    property :splitting, as: :Splitting
+  end
+end

data/lib/viagogo/metro_area.rb

@@ -0,0 +1,17 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/resource'
+
+module Viagogo
+  class MetroArea < OpenStruct
+  end
+
+  module MetroAreaRepresenter
+    include Representable::JSON
+
+    property :id, as: :Id
+    property :name, as: :Name
+    property :geography, as: :Geography, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+    property :venues, as: :Venues, extend: Viagogo::ResourceRepresenter, class: Viagogo::Resource
+  end
+end

data/lib/viagogo/page.rb

@@ -0,0 +1,74 @@
+require 'ostruct'
+require 'representable/json'
+require 'viagogo/category'
+require 'viagogo/country'
+require 'viagogo/event'
+require 'viagogo/geography'
+require 'viagogo/listing'
+require 'viagogo/metro_area'
+require 'viagogo/venue'
+
+module Viagogo
+  class Page < OpenStruct
+  end
+
+  module PageRepresenter
+    include Representable::JSON
+
+    property :maximum_timestamp, as: :MaximumTimeStamp
+    property :total_result_count, as: :TotalResultCount
+    property :total_number_of_page, as: :TotalNumberOfPages
+    property :current_page, as: :Currentpage
+    property :page_size, as: :PageSize
+    #TODO DeletedItems
+  end
+
+  module CategoryPageRepresenter
+    include Representable::JSON
+    include Viagogo::PageRepresenter
+
+    collection :results, as: :Results, extend: Viagogo::CategoryRepresenter, class: Viagogo::Category
+  end
+
+  module CountryPageRepresenter
+    include Representable::JSON
+    include Viagogo::PageRepresenter
+
+    collection :results, as: :Results, extend: Viagogo::CountryRepresenter, class: Viagogo::Country
+  end
+
+  module EventPageRepresenter
+    include Representable::JSON
+    include Viagogo::PageRepresenter
+
+    collection :results, as: :Results, extend: Viagogo::EventRepresenter, class: Viagogo::Event
+  end
+
+  module GeographyPageRepresenter
+    include Representable::JSON
+    include Viagogo::PageRepresenter
+
+    collection :results, as: :Results, extend: Viagogo::GeographyRepresenter, class: Viagogo::Geography
+  end
+
+  module ListingPageRepresenter
+    include Representable::JSON
+    include Viagogo::PageRepresenter
+
+    collection :results, as: :Results, extend: Viagogo::ListingRepresenter, class: Viagogo::Listing
+  end
+
+  module MetroAreaPageRepresenter
+    include Representable::JSON
+    include Viagogo::PageRepresenter
+
+    collection :results, as: :Results, extend: Viagogo::MetroAreaRepresenter, class: Viagogo::MetroArea
+  end
+
+  module VenuePageRepresenter
+    include Representable::JSON
+    include Viagogo::PageRepresenter
+
+    collection :results, as: :Results, extend: Viagogo::VenueRepresenter, class: Viagogo::Venue
+  end
+end