Enhanced Documentation and Classification

Author: connerfritz

README.md

@@ -14,7 +14,191 @@ Wraps the Ticketmaster API in easy to access functions.
  8. Get Classification
  9. Get Venue
 
-#### Example:
+#### Methods:
+For a list of parameters, check http://developer.ticketmaster.com/
+
+| Discovery Methods      | Required      |
+| ---------------------- |:-------------:|
+| search_events          |               |
+| get_event              | id            |
+| get_event_images       | id            |
+| search_attractions     |               |
+| get_attraction         | id            |
+| search_classifications |               |
+| get_classification     | id            |
+| search_venues          |               |
+| get_venue              | id            |
+
+Pass optional params to the call via options.params:
+```
+require 'ticketmaster'
+
+params = {page: 5, size: 10, source: 'ticketmaster'}
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_events(params: params)
+events = response.results
+```
+
+##### Search Events(options={})
+```
+require 'ticketmaster'
+
+params = {page: 5, size: 10, source: 'ticketmaster'}
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_events(params: params)
+events = response.results
+```
+
+##### Get Event (id, options={})
+```
+require 'ticketmaster'
+
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.get_event('ID OF EVENT')
+events = response.results
+```
+
+##### Get Event Images (id, options={})
+```
+require 'ticketmaster'
+
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.get_event_images('ID OF EVENT')
+events = response.results
+```
+
+##### Search Attractions (options={})
+```
+require 'ticketmaster'
+
+params = {page: 5, size: 10, source: 'ticketmaster'}
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_attractions(params: params)
+events = response.results
+```
+
+##### Get Attraction(id, options={})
+```
+require 'ticketmaster'
+
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.get_attraction('ID OF ATTRACTION')
+events = response.results
+```
+
+##### Search Classifications (options={})
+```
+require 'ticketmaster'
+
+params = {page: 5, size: 10, source: 'ticketmaster'}
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_classifications(params: params)
+events = response.results
+```
+
+##### Get Classification (id, options={})
+```
+require 'ticketmaster'
+
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.get_classification('ID OF CLASSIFICATION')
+events = response.results
+```
+
+##### Search Venues (options={})
+```
+require 'ticketmaster'
+
+params = {page: 5, size: 10, source: 'ticketmaster'}
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_venues(params: params)
+events = response.results
+```
+
+##### Get Venue(id, options={})
+```
+require 'ticketmaster'
+
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.get_venue('ID OF VENUE')
+events = response.results
+```
+
+#### Objects:
+
+##### Search Results
+Methods:
+* results
+* current_page
+* total_pages
+* next_page
+* previous_page
+* next_result
+* previous_result
+* reload
+
+##### Event
+Methods:
+* id
+* name
+* description
+* embedded
+* dates
+* start
+* end
+* timezone
+* images
+* get_images
+* classifications
+* attractions
+* venues
+* reload
+
+##### Venue
+Methods:
+* id
+* name
+* address
+* state
+* city
+* country
+* country_code
+* location
+* timezone
+* postal_code
+* url
+* reload
+
+##### Image
+Methods:
+* url
+* ratio
+* width
+* height
+* is_fallback?
+
+##### Classification
+Methods:
+* id
+* name
+* reload
+* genres
+* subgenres
+* type
+
+##### Attraction
+Methods:
+* id
+* name
+* type
+* url
+* locale
+* images
+* classifications
+* reload
+
+
+#### Examples:
 ```
 require 'ticketmaster'
 
@@ -23,3 +207,29 @@ response = client.search_events
 event = response.results.first
 event.get_images
 ```
+
+```
+require 'ticketmaster'
+
+params = {page: 5, size: 10, source: 'ticketmaster'}
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_events(params: params)
+events = response.results
+```
+
+```
+require 'ticketmaster'
+
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_venues
+venue = response.results.first
+venue.address
+```
+
+```
+require 'ticketmaster'
+
+client = Ticketmaster.client(apikey: 'YOUR API KEY')
+response = client.search_events
+next = response.next_result
+```

lib/ticketmaster/clients/discovery.rb

@@ -52,10 +52,10 @@ def search_classifications(options={})
         Result.search(response, request, 'classifications')
       end
 
-      def get_classification(id, options={})
+      def get_classification(id, type, options={})
         options[:version] ||= 'v2'
 
-        request  = Request.new("discovery/#{options[:version]}/classifications/#{id}", {}, self)
+        request  = Request.new("discovery/#{options[:version]}/#{type}/#{id}", {}, self)
         response = request.get
         Result.create(response, request, 'Ticketmaster::Classification')
       end

lib/ticketmaster/results/classification.rb

@@ -1,11 +1,27 @@
 module Ticketmaster
   class Classification < Result
     def id
-      data['segment']['id']
+      data['id'] || data['segment']['id']
+    end
+
+    def name
+      data['name'] || data['segment']['name']
+    end
+
+    def genres
+      Result.array(data['segment']['_embedded']['genres'], request, 'Ticketmaster::Classification') if data['segment']['_embedded']['genres']
+    end
+
+    def subgenres
+      Result.array(data['segment']['_embedded']['subgenres'], request, 'Ticketmaster::Classification') if data['segment']['_embedded']['subgenres']
+    end
+
+    def type
+      data['_links']['self']['href'].match(/(?<=\/discovery\/v\d\/)[a-z\/]+(?=\/)/)[0]
     end
 
     def reload
-      data = request.client.get_classification(id).data
+      data = request.client.get_classification(id, type).data
       self
     end
   end

test/ticketmaster/clients/discovery_test.rb

@@ -67,7 +67,7 @@ def test_search_classifications
   def test_get_classification
     VCR.use_cassette('get_classification') do
       client = Ticketmaster::Client.new(apikey: 'TEST')
-      results = client.get_classification('KZFzniwnSyZfZ7v7nn')
+      results = client.get_classification('KZFzniwnSyZfZ7v7nn', 'classifications')
 
       assert_equal 'KZFzniwnSyZfZ7v7nn', results.id
     end