gogokit 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZDY1MDA2YjY5NTUyNmFjNzIzNjljNjNkNzUwYzM1MDU1YjlkNWY5Nw==
+  data.tar.gz: !binary |-
+    ODUxMjIyZGY2MDk3ODA0ZTM3NTFiYmRlNmQxYThkNjc4YjU4NjYxNg==
+SHA512:
+  metadata.gz: !binary |-
+    MTRhYjI4YTk2YTMzNTE3MTRkY2YwMjNmZjRiMjQ3MmY3ZDVkODhlNjlhMjQ1
+    NDU2MGVmNDU1ZGViYTM3ZWNiMDkxYTg3YTg0NDY0OTc5MjJhY2E3NTJiMTc3
+    NDUzYTFhMzJjYjc3ZTgwOWM3Yzk5ZWIzMTQ1ZGJjYjJhM2NlN2M=
+  data.tar.gz: !binary |-
+    NmU2ZmY4NDc2NTcyZTc5NzY3ZDNlYzYxZTVhZTcxNjlkNzViOGMxMmJjNDcx
+    YTg2NDEyOWZiMjJhOWZhZTQ3ZmRhMzViZGQ0OGVhYjViMDFhN2IxNjIxYTg4
+    OTdhMmU4MmFmNTUzMjJkOGUyMTA0Y2NiYWIyYTYyMGY5ZmI3NWI=

data/LICENSE.txt

@@ -0,0 +1,19 @@
+Copyright (c) 2015 viagogo
+
+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,18 @@
+# The GogoKit Ruby Gem
+
+[![Build Status](https://travis-ci.org/viagogo/gogokit.rb.svg?branch=master)][travis]
+[![Dependency Status](https://gemnasium.com/viagogo/gogokit.rb.svg)][gemnasium]
+[![Code Climate](https://codeclimate.com/github/viagogo/gogokit.rb/badges/gpa.svg)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/viagogo/gogokit.rb/badge.svg)][coverage]
+
+[travis]: https://travis-ci.org/viagogo/gogokit.rb
+[gemnasium]: https://gemnasium.com/viagogo/gogokit.rb
+[codeclimate]: https://codeclimate.com/github/viagogo/gogokit.rb
+[coverage]: https://coveralls.io/r/viagogo/gogokit.rb
+
+
+Ruby toolkit for working with the viagogo API
+
+## Troubleshooting on Windows
+
+GogoKit uses SSL for all HTTP requests. On Windows you will need to configure where your certificates live since OpenSSL cannot find one to validate the authenticity. [This post](https://github.com/jnunemaker/httparty/wiki/Troubleshooting-on-Windows) describes how you can get this working on windows.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task test: :spec
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new
+
+task default: [:spec, :rubocop]

data/gogokit.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'gogokit/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'gogokit'
+  spec.version       = GogoKit::VERSION
+  spec.authors       = ['viagogo']
+  spec.email         = ['api@viagogo.com']
+  spec.description   = 'Ruby toolkit for working with the viagogo API'
+  spec.summary       = 'viagogo API library'
+  spec.homepage      = 'https://github.com/viagogo/gogokit.rb'
+  spec.licenses      = 'MIT'
+
+  spec.files         = %w(LICENSE.txt README.md Rakefile gogokit.gemspec)
+  spec.files         = spec.files + Dir.glob('lib/**/*.rb')
+  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_rubygems_version = '>= 1.3.5'
+
+  spec.add_dependency 'faraday', '~> 0.9.1'
+  spec.add_dependency 'addressable', '~> 2.3'
+  spec.add_dependency 'roar', '~> 1.0'
+  spec.add_dependency 'virtus', '~> 1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+end

data/lib/gogokit.rb

@@ -0,0 +1,6 @@
+require 'gogokit/client'
+require 'gogokit/version'
+
+# Ruby toolkit for the viagogo API
+module GogoKit
+end

data/lib/gogokit/client.rb

@@ -0,0 +1,171 @@
+require 'addressable/uri'
+require 'addressable/template'
+require 'gogokit/configuration'
+require 'gogokit/connection'
+require 'gogokit/error'
+require 'gogokit/client/category'
+require 'gogokit/client/country'
+require 'gogokit/client/currency'
+require 'gogokit/client/event'
+require 'gogokit/client/language'
+require 'gogokit/client/listing'
+require 'gogokit/client/metro_area'
+require 'gogokit/client/oauth'
+require 'gogokit/client/root'
+require 'gogokit/client/search'
+require 'gogokit/client/venue'
+require 'gogokit/version'
+
+module GogoKit
+  # Client for the viagogo API
+  #
+  # @see http://developer.viagogo.net
+  class Client
+    include GogoKit::Configuration
+    include GogoKit::Connection
+    include GogoKit::Client::Category
+    include GogoKit::Client::Country
+    include GogoKit::Client::Currency
+    include GogoKit::Client::Event
+    include GogoKit::Client::Language
+    include GogoKit::Client::Listing
+    include GogoKit::Client::MetroArea
+    include GogoKit::Client::OAuth
+    include GogoKit::Client::Root
+    include GogoKit::Client::Search
+    include GogoKit::Client::Venue
+
+    attr_accessor :client_id,
+                  :client_secret,
+                  :access_token
+
+    # Initializes a new {GogoKit::Client}
+    #
+    # @param options [Hash]
+    # @option options [String] :client_id Client Id of your application
+    # @option options [String] :client_secret Client Secret of your application
+    # @option options [String] :oauth_token_endpoint Endpoint for obtaining
+    # OAuth access tokens
+    # @raise [GogoKit::Error::ConfigurationError] Error is raised when supplied
+    # client credentials are not a String or Symbol.
+    # @return [GogoKit::Client]
+    def initialize(options = {})
+      options.each do |key, value|
+        send(:"#{key}=", value)
+      end
+      yield self if block_given?
+
+      validate_credential_type!
+      validate_configuration!
+    end
+
+    # The User-Agent header used when making HTTP requests
+    #
+    # @return [String]
+    def user_agent
+      @user_agent ||= "GogoKit Ruby Gem #{GogoKit::VERSION}"
+    end
+
+    # Perform an HTTP DELETE request
+    #
+    # @return [Hash] object containing response information
+    def delete(url, options = {})
+      request(:delete, url, options)
+    end
+
+    # Perform an HTTP GET request
+    #
+    # @return [Hash] object containing response information
+    def get(url, options = {})
+      request(:get, url, options)
+    end
+
+    # Perform an HTTP HEAD request
+    #
+    # @return [Hash] object containing response information
+    def head(url, options = {})
+      request(:head, url, options)
+    end
+
+    # Perform an HTTP PATCH request
+    #
+    # @return [Hash] object containing response information
+    def patch(url, options = {})
+      request(:patch, url, options)
+    end
+
+    # Perform an HTTP POST request
+    #
+    # @return [Hash] object containing response information
+    def post(url, options = {})
+      request(:post, url, options)
+    end
+
+    # Perform an HTTP PUT request
+    #
+    # @return [Hash] object containing response information
+    def put(url, options = {})
+      request(:put, url, options)
+    end
+
+    private
+
+    # Perform an HTTP request
+    #
+    # @return [Hash] object containing response information
+    def request(method, url, options = {})
+      options ||= {}
+      url = expand_url(url, options[:params])
+      try_add_authorization_header(options)
+
+      connection.send(method.to_sym, url, options[:body], options[:headers]).env
+    end
+
+    # Expands a URI template with the given parameters
+    def expand_url(url, params)
+      params ||= {}
+      template = url.respond_to?(:expand) ? url : Addressable::Template.new(url)
+      if template.variables.empty? && !params.empty?
+        # the URI isn't templated so just append the query parameters
+        non_templated_url = Addressable::URI.parse(url)
+        existing_query_values = non_templated_url.query_values(Hash) || {}
+        non_templated_url.query_values = existing_query_values.merge(params)
+        return non_templated_url.to_s
+      end
+
+      template.expand(params || {}).to_s
+    end
+
+    def try_add_authorization_header(options)
+      options[:headers] ||= {}
+      return unless options[:headers]['Authorization'].nil? &&
+                    options[:headers][:authorization].nil?
+
+      # Add an Authorization header since we don't have one yet
+      options[:headers]['Authorization'] = "Bearer #{access_token}"
+    end
+
+    # @return [Hash]
+    def credentials
+      {
+        client_id: client_id,
+        client_secret: client_secret,
+        access_token: access_token
+      }
+    end
+
+    # Ensures that all credentials set during configuration are of a valid type.
+    # Valid types are String and Symbol.
+    #
+    # @raise [GogoKit::Error::ConfigurationError] Error is raised when supplied
+    # 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/gogokit/client/category.rb

@@ -0,0 +1,39 @@
+require 'gogokit/utils'
+require 'gogokit/resource/category'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting categories
+    module Category
+      include GogoKit::Utils
+
+      # Retrieves a category by ID
+      #
+      # @param [Integer] category_id The ID of the category to be retrieved
+      # @param [Hash] options Optional options
+      # @return [GogoKit::Category] The requested category
+      def get_category(category_id, options = {})
+        root = get_root
+        object_from_response(GogoKit::Category,
+                             GogoKit::CategoryRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/categories/" \
+                             "#{category_id}",
+                             options)
+      end
+
+      # Retrieves the genre categories (e.g. Sports, Concerts, Theatre)
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#viagogogenres
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] The genre categories
+      def get_genres(options = {})
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::CategoriesRepresenter,
+                             :get,
+                             get_root.links['viagogo:genres'].href,
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/client/country.rb

@@ -0,0 +1,38 @@
+require 'gogokit/utils'
+require 'gogokit/resource/country'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting countries
+    module Country
+      include GogoKit::Utils
+
+      # Retrieves a country by country code
+      #
+      # @param [String] code The country code of the country to be retrieved
+      # @param [Hash] options Optional options
+      # @return [GogoKit::Country] The requested country
+      def get_country(code, options = {})
+        root = get_root
+        object_from_response(GogoKit::Country,
+                             GogoKit::CountryRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/countries/#{code}",
+                             options)
+      end
+
+      # Retrieves all countries
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#viagogocountries
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] All countries
+      def get_countries(options = {})
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::CountriesRepresenter,
+                             :get,
+                             get_root.links['viagogo:countries'].href,
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/client/currency.rb

@@ -0,0 +1,38 @@
+require 'gogokit/utils'
+require 'gogokit/resource/currency'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting currencies
+    module Currency
+      include GogoKit::Utils
+
+      # Retrieves a currency by currency code
+      #
+      # @param [String] code The currency code of the currency to be retrieved
+      # @param [Hash] options Optional options
+      # @return [GogoKit::Country] The requested currency
+      def get_currency(code, options = {})
+        root = get_root
+        object_from_response(GogoKit::Currency,
+                             GogoKit::CurrencyRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/currencies/#{code}",
+                             options)
+      end
+
+      # Retrieves all currencies supported by viagogo
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#viagogocurrencies
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] All currencies
+      def get_currencies(options = {})
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::CurrenciesRepresenter,
+                             :get,
+                             get_root.links['viagogo:currencies'].href,
+                             options)
+      end
+    end
+  end
+end

data/lib/gogokit/client/event.rb

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

data/lib/gogokit/client/language.rb

@@ -0,0 +1,38 @@
+require 'gogokit/utils'
+require 'gogokit/resource/language'
+
+module GogoKit
+  class Client
+    # {GogoKit::Client} methods for getting languages
+    module Language
+      include GogoKit::Utils
+
+      # Retrieves a language by language code
+      #
+      # @param [String] code The language code of the language to be retrieved
+      # @param [Hash] options Optional options
+      # @return [GogoKit::Country] The requested language
+      def get_language(code, options = {})
+        root = get_root
+        object_from_response(GogoKit::Language,
+                             GogoKit::LanguageRepresenter,
+                             :get,
+                             "#{root.links['self'].href}/languages/#{code}",
+                             options)
+      end
+
+      # Retrieves all languages supported by viagogo
+      #
+      # @see http://viagogo.github.io/developer.viagogo.net/#viagogolanguages
+      # @param [Hash] options Optional options
+      # @return [GogoKit::PagedResource] All languages
+      def get_languages(options = {})
+        object_from_response(GogoKit::PagedResource,
+                             GogoKit::LanguagesRepresenter,
+                             :get,
+                             get_root.links['viagogo:languages'].href,
+                             options)
+      end
+    end
+  end
+end