gogokit 0.1.0

data/lib/gogokit/client/listing.rb

@@ -0,0 +1,41 @@
+require 'gogokit/utils'
+require 'gogokit/resource/listing'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting listings
+    module Listing
+      include GogoKit::Utils
+
+      # Retrieves a listing by ID
+      #
+      # @param [Integer] listing_id The ID of the listing to be retrieved
+      # @param [Hash] options Optional options
+      # @return [GogoKit::Listing] The requested listing
+      def get_listing(listing_id, options = {})
+        root = get_root
+        object_from_response(GogoKit::Listing,
+                             GogoKit::ListingRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/listings/" \
+                             "#{listing_id}",
+                             options)
+      end
+
+      # Retrieves all listings in a particular event
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#eventlistings
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] All listings in the specified event
+      def get_listings_by_event(event_id, options = {})
+        root = get_root
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::ListingsRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/events/" \
+                             "#{event_id}/listings",
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/client/metro_area.rb

@@ -0,0 +1,39 @@
+require 'gogokit/utils'
+require 'gogokit/resource/metro_area'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting metro areas
+    module MetroArea
+      include GogoKit::Utils
+
+      # Retrieves a metro area by ID
+      #
+      # @param [Integer] metro_area_id The ID of the metro area to be retrieved
+      # @param [Hash] options Optional options
+      # @return [GogoKit::MetroArea] The requested metro area
+      def get_metro_area(metro_area_id, options = {})
+        root = get_root
+        object_from_response(GogoKit::MetroArea,
+                             GogoKit::MetroAreaRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/metro_areas/" \
+                             "#{metro_area_id}",
+                             options)
+      end
+
+      # Retrieves all metro_areas
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#viagogometro_areas
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] All metro_areas
+      def get_metro_areas(options = {})
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::MetroAreasRepresenter,
+                             :get,
+                             get_root.links['viagogo:metro_areas'].href,
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/client/oauth.rb

@@ -0,0 +1,55 @@
+require 'base64'
+require 'gogokit/oauth_token'
+require 'gogokit/utils'
+
+module GogoKit
+  class Client
+    # OAuth authentication methods for {GogoKit::Client}
+    module OAuth
+      include GogoKit::Utils
+
+      # Get an OAuth access token
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#authentication
+      # @param [String] grant_type The grant type to use to get the token
+      # @param [Hash] options Token request information
+      # @return [GogoKit::OAuthToken] The OAuth token
+      def get_access_token(grant_type, options = {})
+        object_from_response(GogoKit::OAuthToken,
+                             GogoKit::OAuthTokenRepresenter,
+                             :post,
+                             oauth_token_endpoint,
+                             body: token_request_body(grant_type, options),
+                             headers: token_request_headers)
+      end
+
+      # Get an OAuth access token for an application.
+      #
+      # @see
+      # http://viagogo.github.io/developer.viagogo.net/#client-credentials-grant
+      # @param [Hash] options Token request information
+      # @return [GogoKit::OAuthToken] The OAuth token
+      def get_client_access_token(options = {})
+        get_access_token('client_credentials', options)
+      end
+
+      private
+
+      def token_request_body(grant_type, options)
+        body = options || {}
+        body[:grant_type] = grant_type
+        body
+      end
+
+      def token_request_headers
+        credentials = "#{client_id}:#{client_secret}"
+        basic_header_value = Base64.encode64(credentials).gsub("\n", '')
+        {
+          content_type: 'application/x-www-form-urlencoded',
+          accept: 'application/json',
+          authorization: "Basic #{basic_header_value}"
+        }
+      end
+    end
+  end
+end

data/lib/gogokit/client/root.rb

@@ -0,0 +1,24 @@
+require 'gogokit/utils'
+require 'gogokit/resource/root'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting the root resource
+    module Root
+      include GogoKit::Utils
+
+      # Gets the root of the viagogo API service.
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#root-endpoint
+      # @param [Hash] options Optional options
+      # @return [GogoKit::Resource::Root] The root resource
+      def get_root(options = {})
+        object_from_response(GogoKit::Root,
+                             GogoKit::RootRepresenter,
+                             :get,
+                             api_root_endpoint,
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/client/search.rb

@@ -0,0 +1,27 @@
+require 'gogokit/utils'
+require 'gogokit/resource/search_result'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for searching for viagogo entities
+    module Search
+      include GogoKit::Utils
+
+      # Search for entities that match a given query
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#viagogosearch
+      # @param [String] query The query text to be used to match entities
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] The results of the query
+      def search(query, options = {})
+        options[:params] ||= {}
+        options[:params] = options[:params].merge(query: query)
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::SearchResultsRepresenter,
+                             :get,
+                             get_root.links['viagogo:search'].href,
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/client/venue.rb

@@ -0,0 +1,39 @@
+require 'gogokit/utils'
+require 'gogokit/resource/venue'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting venues
+    module Venue
+      include GogoKit::Utils
+
+      # Retrieves a venue by ID
+      #
+      # @param [Integer] venue_id The ID of the venue to be retrieved
+      # @param [Hash] options Optional options
+      # @return [GogoKit::Venue] The requested venue
+      def get_venue(venue_id, options = {})
+        root = get_root
+        object_from_response(GogoKit::Venue,
+                             GogoKit::VenueRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/venues/" \
+                             "#{venue_id}",
+                             options)
+      end
+
+      # Retrieves all venues
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#viagogovenues
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] All venues
+      def get_venues(options = {})
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::VenuesRepresenter,
+                             :get,
+                             get_root.links['viagogo:venues'].href,
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/configuration.rb

@@ -0,0 +1,40 @@
+require 'uri'
+require 'gogokit/default'
+
+module GogoKit
+  # Configuration options for {GogoKit::Client} or falls back to
+  # {GogoKit::Default}
+  module Configuration
+    attr_writer :api_root_endpoint,
+                :oauth_token_endpoint
+
+    # The endpoint for the API root resource
+    def api_root_endpoint
+      @api_root_endpoint || GogoKit::Default::API_ROOT_ENDPOINT
+    end
+
+    # The endpoint for obtaining OAuth access tokens
+    def oauth_token_endpoint
+      @oauth_token_endpoint || GogoKit::Default::OAUTH_TOKEN_ENDPOINT
+    end
+
+    private
+
+    def endpoints
+      {
+        api_root_endpoint: api_root_endpoint,
+        oauth_token_endpoint: oauth_token_endpoint
+      }
+    end
+
+    def validate_configuration!
+      endpoints.each do |endpoint, value|
+        next if !value.nil? && value =~ /\A#{URI.regexp}\z/
+
+        fail(ConfigurationError,
+             "Invalid #{endpoint} specified: " \
+             "#{value.inspect} must be a valid URL")
+      end
+    end
+  end
+end

data/lib/gogokit/connection.rb

@@ -0,0 +1,34 @@
+require 'faraday'
+require 'gogokit/middleware/raise_error'
+
+module GogoKit
+  # HTTP Connection methods for {GogoKit::Client}
+  module Connection
+    private
+
+    def connection_options  # rubocop:disable Metrics/MethodLength
+      @connection_options ||= {
+        headers: {
+          accept: 'application/hal+json',
+          content_type: 'application/hal+json',
+          user_agent: user_agent
+        },
+        request: {
+          open_timeout: 5,
+          timeout: 10
+        }
+      }
+    end
+
+    def connection
+      Faraday::Connection.new(nil, connection_options) do |builder|
+        builder.use Faraday::Request::UrlEncoded
+
+        # Handle error responses
+        builder.use GogoKit::Middleware::RaiseError
+
+        builder.adapter Faraday.default_adapter
+      end
+    end
+  end
+end

data/lib/gogokit/default.rb

@@ -0,0 +1,10 @@
+module GogoKit
+  # Default configuration options for {GogoKit::Client}
+  module Default
+    # Default API root endpoint
+    API_ROOT_ENDPOINT = 'https://api.viagogo.net/v2'.freeze
+
+    # Default OAuth token endpoint
+    OAUTH_TOKEN_ENDPOINT = 'https://www.viagogo.com/secure/oauth2/token'.freeze
+  end
+end

data/lib/gogokit/error.rb

@@ -0,0 +1,12 @@
+module GogoKit
+  # Custom error class for rescuing from all GogoKit errors
+  class Error < StandardError; end
+
+  # Raised when {GogoKit::Client} is not configured correctly
+  class ConfigurationError < Error; end
+
+  # Raised for any error returned by the API
+  class ApiError < Error
+    attr_accessor :response
+  end
+end

data/lib/gogokit/middleware/raise_error.rb

@@ -0,0 +1,27 @@
+require 'faraday'
+require 'gogokit/error'
+
+module GogoKit
+  module Middleware
+    class RaiseError < Faraday::Middleware
+      def initialize(app)
+        super app
+      end
+
+      def call(request_env)
+        @app.call(request_env).on_complete do |response_env|
+          if response_env[:status].to_i >= 400
+            api_error = GogoKit::ApiError.new
+            api_error.response = response_env
+            fail api_error, error_message(response_env)
+          end
+        end
+      end
+
+      def error_message(response_env)
+        "#{response_env[:method].to_s.upcase} #{response_env[:url]}:" \
+        " #{response_env[:status]}}"
+      end
+    end
+  end
+end

data/lib/gogokit/money.rb

@@ -0,0 +1,19 @@
+require 'ostruct'
+require 'representable/json'
+
+module GogoKit
+  # Returned for monetary values, such as ticket prices, fees charged and tax
+  # amounts.
+  #
+  # @see http://viagogo.github.io/developer.viagogo.net/#money
+  class Money < OpenStruct
+  end
+
+  module MoneyRepresenter
+    include Representable::JSON
+
+    property :amount
+    property :currency
+    property :display
+  end
+end

data/lib/gogokit/oauth_token.rb

@@ -0,0 +1,21 @@
+require 'ostruct'
+require 'representable/json'
+
+module GogoKit
+  # An OAuth access token that can be used to access the viagogo API
+  #
+  # @see http://viagogo.github.io/developer.viagogo.net/#authentication
+  class OAuthToken < OpenStruct
+  end
+
+  # A representer for {GogoKit::OAuthToken}
+  module OAuthTokenRepresenter
+    include Representable::JSON
+
+    property :access_token
+    property :token_type
+    property :expires_in
+    property :scope
+    property :refresh_token
+  end
+end

data/lib/gogokit/paged_resource.rb

@@ -0,0 +1,23 @@
+require 'roar/json'
+require 'roar/json/hal'
+require 'gogokit/resource'
+
+module GogoKit
+  # Base class for pages of resources returned in API responses
+  class PagedResource < Resource
+    attr_accessor :page,
+                  :page_size,
+                  :total_items,
+                  :items
+  end
+
+  # Representer for {GogoKit::PagedResource}s
+  module PagedResourceRepresenter
+    include Representable::JSON
+    include GogoKit::ResourceRepresenter
+
+    property :page
+    property :page_size
+    property :total_items
+  end
+end

data/lib/gogokit/resource.rb

@@ -0,0 +1,18 @@
+require 'roar/json'
+require 'roar/json/hal'
+
+module GogoKit
+  # Base class for resources returned in API responses
+  class Resource
+    attr_accessor :links
+  end
+
+  # A base representer module for every {GogoKit::Resource}
+  module ResourceRepresenter
+    include Roar::Hypermedia
+    include Roar::JSON
+    include Roar::JSON::HAL
+
+    link(:self) { 'http://self' }
+  end
+end