songkickr 0.3.3 → 0.4.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d347acbb0fa6ed84ad0d56cf83cab5af5e16cec7
+  data.tar.gz: 6b5dcf947c5e0467cd8653e86c0f0b12d5011e66
+SHA512:
+  metadata.gz: 82aaa7def7817b654c7672426ca465c04f848076d64034c7dfda77b5f6a0c969e4bdb71f96217924c690b6fe7c4b9b1e7bbf9869b3b7fc6bcecff9ce854c37e3
+  data.tar.gz: e20637db3e43e5eff60e3d03c5b775b5a051be2316610bcdf8df2dd5a8d80eb77e9bb4f06b2685961881c76d015f705dacc8df3a7f4d534a6e990cc1d10c9d9a

data/.bundle/config

@@ -0,0 +1,2 @@
+--- 
+BUNDLE_BIN: bin

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+bin/*

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+  - ruby-head
+  - jruby-head

data/Gemfile.lock

@@ -1,32 +1,52 @@
 PATH
   remote: .
   specs:
-    songkickr (0.3.3)
+    songkickr (0.4.0)
+      httparty (~> 0.8.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (3.2.12)
-      i18n (~> 0.6)
-      multi_json (~> 1.0)
-    crack (0.3.1)
+    activesupport (4.0.0)
+      i18n (~> 0.6, >= 0.6.4)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.12)
+    coderay (1.0.9)
+    crack (0.4.1)
+      safe_yaml (~> 0.9.0)
     fakeweb (1.3.0)
     httparty (0.8.3)
       multi_json (~> 1.0)
       multi_xml
-    i18n (0.6.1)
-    multi_json (1.6.0)
-    multi_xml (0.5.2)
-    rake (10.0.3)
-    redgreen (1.2.2)
-    shoulda (3.1.1)
-      shoulda-context (~> 1.0)
-      shoulda-matchers (~> 1.2)
-    shoulda-context (1.0.0)
-    shoulda-matchers (1.2.0)
+    i18n (0.6.4)
+    json (1.8.0)
+    method_source (0.8.2)
+    minitest (4.7.5)
+    multi_json (1.7.7)
+    multi_xml (0.5.4)
+    pry (0.9.12.2)
+      coderay (~> 1.0.5)
+      method_source (~> 0.8)
+      slop (~> 3.4)
+    rake (10.0.4)
+    rdoc (4.0.1)
+      json (~> 1.4)
+    safe_yaml (0.9.4)
+    shoulda (3.5.0)
+      shoulda-context (~> 1.0, >= 1.0.1)
+      shoulda-matchers (>= 1.4.1, < 3.0)
+    shoulda-context (1.1.4)
+    shoulda-matchers (2.2.0)
       activesupport (>= 3.0.0)
-    test-unit (2.5.1)
-    vcr (2.2.4)
+    slop (3.4.6)
+    test-unit (2.5.5)
+    thread_safe (0.1.2)
+      atomic
+    tzinfo (0.3.37)
+    vcr (2.5.0)
 
 PLATFORMS
   ruby
@@ -34,10 +54,10 @@ PLATFORMS
 DEPENDENCIES
   crack
   fakeweb (>= 1.3.0)
-  httparty
-  rake
-  redgreen (>= 1.2.2)
+  pry
+  rake (~> 10.0.0)
+  rdoc (~> 4.0.1)
   shoulda (>= 2.11.0)
   songkickr!
-  test-unit
-  vcr
+  test-unit (~> 2.5.5)
+  vcr (~> 2.5.0)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010-2011 Jared Mehle
+Copyright (c) 2010-2013 Jared Mehle
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,5 +1,7 @@
 = songkickr
 
+{<img src="https://travis-ci.org/jrmehle/songkickr.png?branch=master" alt="Build Status" />}[https://travis-ci.org/jrmehle/songkickr]
+
 A Ruby wrapper around the Songkick API. Visit www.songkick.com/developer for documentation on the Songkick API.
 
 = Install Instructions
@@ -15,15 +17,18 @@ or if your environment requires
     require 'songkickr'
     remote = Songkickr::Remote.new API_KEY
 
-Then call events, users_events(username), or concert_setlists(event_id)
+Then call one of the remote methods such as events, users_events(username), or concert_setlists(event_id)
 
-    results = remote.events(:query => 'Iron Maiden')
-    results = remote.events(:query => 'As I Lay Dying')
+Get an artists events by name:
+    results = remote.events('Iron Maiden')
 
+Get a users events by username:
     results = remote.users_events('jrmehle')
 
+Get a the setlists of a concert by event ID:
     results = remote.concert_setlists(2680726)
-    results = remote.concert_setlists(2894471)
+
+More: As of v0.4.0 songkickr supports all of Songkick's APIs. Check the RDocs for the Songkickr::RemoteApi classes.
 
 
 == Note on Patches/Pull Requests
@@ -32,17 +37,17 @@ Then call events, users_events(username), or concert_setlists(event_id)
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
   future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
+* Commit, do not mess with Rakefile, version, or history.
   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
 == Copyright
 
-Copyright (c) 2010-2011 Jared Mehle. See LICENSE for details.
+Copyright (c) 2010-2013 Jared Mehle. See LICENSE for details.
 
-== Thanks
+== Contributors
 
-Thanks to Akshay Dodeja, Tomasz Stachewicz, and Dave Knapik for submitting code and pull requests.
+Thanks to Andrew Chen, Akshay Dodeja, Tomasz Stachewicz, and Dave Knapik for submitting code and pull requests.
 
-A special thank you to Jon Nunemaker for the httparty which is used extensively within this
+A special thank you to Jon Nunemaker for httparty which is used extensively within this
 gem and for the twitter gem as inspiration.

data/Rakefile

@@ -1,6 +1,5 @@
-require "rubygems"
-require "rake"
-require "bundler/gem_tasks"
+require 'rake'
+require 'bundler/gem_tasks'
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -13,7 +12,7 @@ task :default => :test
 
 require 'rdoc/task'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  version = Songkickr::VERSION ? Songkickr::VERSION : ""
 
   rdoc.rdoc_dir = 'rdoc'
   rdoc.title = "songkickr #{version}"

data/lib/songkickr/artist.rb

@@ -10,15 +10,15 @@ module Songkickr
   #
   # http://www.songkick.com/developer/artist-search
   class Artist
-    attr_accessor :uri, :display_name, :id, :on_tour_until
+    attr_accessor :uri, :display_name, :id, :on_tour_until, :identifier
 
     # Accepts a hash of artist attributes.
     def initialize(artist_hash = {})
-      @uri           = artist_hash["uri"]
       @display_name  = artist_hash["displayName"]
       @id            = artist_hash["id"]
       @uri           = artist_hash["uri"]
       @on_tour_until = artist_hash["onTourUntil"]
+      @identifier    = artist_hash["identifier"]
     end
   end
 end

data/lib/songkickr/artist_result.rb

@@ -1,32 +1,12 @@
 module Songkickr
   # A class to represent the result hash of an Artist search.
-  class ArtistResult
-    attr_accessor :page, :total_entries, :results
-
+  class ArtistResult < ResultSet
     # Takes the result hash directly and parses out the page and total entries and finally passes off to the parse_results method to get the results.
     def initialize(result_hash = {})
-      results_page = result_hash["resultsPage"]
-
-      if results_page
-        @page          = results_page["page"]
-        @total_entries = results_page["totalEntries"]
-        @results       = parse_results results_page["results"]
-      end
-    end
-
-    protected
+      @result_type       = "Artist"
+      @result_key_string = "artist"
 
-    # Take the results hash directly and parse the artists into Artist objects.
-    #
-    # Returns an array of Artists.
-    def parse_results(results = {})
-      artists = []
-      if results.include?("artist")
-        results["artist"].each do |artist|
-          artists << Songkickr::Artist.new(artist)
-        end
-      end
-      artists
+      super
     end
   end
 end

data/lib/songkickr/calendar_entry.rb

@@ -0,0 +1,23 @@
+module Songkickr
+  class CalendarEntry
+    attr_accessor :reason, :event, :created_at
+
+    def initialize(calendar_entry_hash = {})
+      @created_at = calendar_entry_hash['createdAt']
+      @event      = Event.new calendar_entry_hash['event']
+      @reason     = parse_reason(calendar_entry_hash['reason'])
+    end
+
+    protected
+
+      def parse_reason(entry_reason = {})
+        if entry_reason.include? 'trackedArtist'
+          # trackedArtist is an array of artists
+          entry_reason['trackedArtist'].map { |artist| Artist.new artist }
+        elsif entry_reason.include? 'attendance'
+          # attendance is a string i_might_go | im_going
+          entry_reason['attendance']
+        end
+      end
+  end
+end

data/lib/songkickr/calendar_result.rb

@@ -0,0 +1,10 @@
+module Songkickr
+  class CalendarResult < ResultSet
+    def initialize(result_hash = {})
+      @result_type       = "CalendarEntry"
+      @result_key_string = "calendarEntry"
+
+      super
+    end
+  end
+end

data/lib/songkickr/concert_setlist_result.rb

@@ -2,35 +2,13 @@ module Songkickr
   # A class to represent the result hash of an Setlist search.
   #
   # http://www.songkick.com/developer/setlists
-  class ConcertSetlistResult
-    attr_accessor :results
-    
+  class ConcertSetlistResult < ResultSet
     # Takes the result ash and passes it to parse_results
     def initialize(result_hash = {})
-      if result_hash["resultsPage"]
-        results_page = result_hash["resultsPage"]
-      
-        if results_page
-          @results = parse_results results_page["results"]
-        end
-      else
-        result_hash
-      end
+      @result_type       = "Setlist"
+      @result_key_string = "setlist"
+
+      super
     end
-    
-    
-    protected
-      
-      # Parses the setlist items into an array of SetlistItems
-      def parse_results(results = {})
-        setlists = []
-        if results.include?("setlist")
-          results["setlist"].each do |setlist|
-            setlists << Songkickr::Setlist.new(setlist)
-          end
-        end
-        
-        setlists
-      end
   end
 end

data/lib/songkickr/event.rb

@@ -37,9 +37,10 @@ module Songkickr
   #
   # http://www.songkick.com/developer/artist-search
   class Event
-    attr_accessor :type, :display_name, :location, :start, :uri, :id, :lat, :lng, :performances, :status, :venue, :tickets_uri
-    
+    attr_accessor :popularity, :type, :display_name, :location, :start, :uri, :id, :performances, :status, :venue, :tickets_uri
+
     def initialize(event_hash)
+      @popularity   = event_hash["popularity"].to_f
       @type         = event_hash["type"]
       @location     = Songkickr::Location.new event_hash["location"]
       @status       = event_hash["status"]
@@ -51,24 +52,17 @@ module Songkickr
       @id           = event_hash["id"]
       @tickets_uri  = event_hash["ticketsUri"]
     end
-    
+
     protected
-      
+
       # Takes the start hash and turns in into a DateTime object.
       def start_hash_to_datetime(start_hash)
         datetime = DateTime.parse("#{start_hash["date"]} #{start_hash["time"]}")
       end
-      
+
       # Builds a list of Performance objects.
-      def parse_performance(performance_array = nil)
-        performances = []
-        if performance_array
-          performance_array.each do |performance|
-            performances << Songkickr::Performance.new(performance)
-          end
-        end
-        
-        performances
+      def parse_performance(performances = [])
+        performances.map { |performance| Songkickr::Performance.new performance }
       end
   end
 end

data/lib/songkickr/event_result.rb

@@ -1,31 +1,13 @@
 module Songkickr
   # A class to represent the result hash of an Event search.
-  class EventResult
-    attr_accessor :page, :total_entries, :results
+  class EventResult < ResultSet
 
     # Takes the result hash directly and parses out the page and total entries and finally passes off to the parse_results method to get the results.
     def initialize(result_hash = {})
-      results_page = result_hash["resultsPage"]
-      
-      if results_page
-        @page          = results_page["page"]
-        @total_entries = results_page["totalEntries"]
-        @results       = parse_results results_page["results"]
-      end
+      @result_type       = "Event"
+      @result_key_string = "event"
+
+      super
     end
-    
-    
-    protected
-    
-      def parse_results(results = {})
-        events = []
-        if results.include?("event")
-          results["event"].each do |event|
-            events << Songkickr::Event.new(event)
-          end
-        end
-        
-        events
-      end
   end
 end

data/lib/songkickr/location.rb

@@ -23,7 +23,7 @@ module Songkickr
   # http://www.songkick.com/developer/location-search
   class Location
     attr_accessor :city, :lat, :lng, :metro_area
-    
+
     # Takes a location hash. Handles the different city hashes from Event and Location
     def initialize(location_hash)
       if location_hash["city"].is_a?(String) # location in Event
@@ -32,13 +32,13 @@ module Songkickr
         @lng  = location_hash["lng"]
       elsif location_hash["city"].is_a?(Hash) # stand-alone Location
         city_hash = location_hash["city"]
-        @city = city_hash["displayName"]
+        @city = city_hash["displayName"] if city_hash && city_hash["displayName"]
         # some locations have a null lng, lat in city hash, but have non-null in metroArea hash
         @lat  = city_hash["lat"]
         @lng  = city_hash["lng"]
       end
-      
-      @metro_area = location_hash['metroArea']
+
+      @metro_area = MetroArea.new location_hash['metroArea'] if location_hash.include? 'metroArea'
     end
   end
 end

data/lib/songkickr/location_result.rb

@@ -1,36 +1,11 @@
 module Songkickr
   # A class to represent the result hash of a Location search.
-  
-  #TODO: very similar to concert_setlist_result, event_result, and artist_result, extract common stuff to module/superclass
-  class LocationResult
-    attr_accessor :page, :total_entries, :results
-    
-    # Takes the result hash directly and parses out the page and total entries and finally passes off to the parse_results method to get the results.
+  class LocationResult < ResultSet
     def initialize(result_hash = {})
-      results_page = result_hash["resultsPage"]
-      
-      if results_page
-        @page          = results_page["page"]
-        @total_entries = results_page["totalEntries"]
-        @results       = parse_results results_page["results"]
-      end
+      @result_type       = "Location"
+      @result_key_string = "location"
+
+      super
     end
-    
-    
-    protected
-      
-      # Take the results hash directly and parse the locations into Location objects.
-      #
-      # Returns an array of Locations.
-      def parse_results(results = {})
-        locations = []
-        if results.include?("location")
-          results["location"].each do |location|
-            locations << Songkickr::Location.new(location)
-          end
-        end
-        
-        locations
-      end
   end
 end

data/lib/songkickr/metro_area.rb

@@ -0,0 +1,28 @@
+module Songkickr
+  # metroArea: {
+  #   displayName: "Twin Cities",
+  #   uri: "http://www.songkick.com/metro_areas/35130-us-twin-cities?utm_source=4791&utm_medium=partner",
+  #   id: 35130,
+  #   state: {
+  #     displayName: "MN"
+  #   },
+  #   country: {
+  #     displayName: "US"
+  #   },
+  #   lat: 44.9801,
+  #   lng: -93.2519
+  # }
+  class MetroArea
+    attr_accessor :display_name, :uri, :id, :state, :country, :lat, :lng
+
+    def initialize(metro_area_hash)
+      @display_name = metro_area_hash["displayName"]
+      @id           = metro_area_hash["id"]
+      @uri          = metro_area_hash["uri"]
+      @state        = metro_area_hash["state"]["displayName"] if metro_area_hash.include?("state") && metro_area_hash["state"].include?("displayName")
+      @country      = metro_area_hash["country"]["displayName"] if metro_area_hash.include?("country") && metro_area_hash["country"].include?("displayName")
+      @lat          = metro_area_hash["lat"] if metro_area_hash.include? "lat"
+      @lng          = metro_area_hash["lng"] if metro_area_hash.include? "lng"
+    end
+  end
+end

data/lib/songkickr/metro_area_result.rb

@@ -0,0 +1,12 @@
+module Songkickr
+  # A class to represent the result hash of a Metro Area search.
+  class MetroAreaResult < ResultSet
+    # Takes the result hash directly and parses out the page and total entries and finally passes off to the parse_results method to get the results.
+    def initialize(result_hash = {})
+      @result_type       = "MetroArea"
+      @result_key_string = "metroArea"
+
+      super
+    end
+  end
+end

data/lib/songkickr/performance.rb

@@ -1,17 +1,22 @@
 module Songkickr
   # A single performance by an artist.
-  #   {
-  #     "artist": {
-  #       "uri": "http://www.songkick.com/artists/288696-vampire-weekend",
-  #       "displayName": "Vampire Weekend",
-  #       "id": 288696,
-  #       "identifier": [{"mbid": "af37c51c-0790-4a29-b995-456f98a6b8c9"}]
-  #     }
-  #     "displayName": "Vampire Weekend",
-  #     "billingIndex": 1,
-  #     "id": 5380281,
-  #     "billing": "headline"
-  #   }
+  # {
+  #   billingIndex: 2,
+  #   billing: "headline",
+  #   displayName: "A Day to Remember",
+  #   artist: {
+  #     identifier: [
+  #       {
+  #         href: "http://api.songkick.com/api/3.0/artists/mbid:db008806-16f6-48fc-8521-3d953709689d.json",
+  #         mbid: "db008806-16f6-48fc-8521-3d953709689d"
+  #       }
+  #     ],
+  #     displayName: "A Day to Remember",
+  #     uri: "http://www.songkick.com/artists/470482-a-day-to-remember?utm_source=4791&utm_medium=partner",
+  #     id: 470482
+  #   },
+  #   id: 34045929
+  # }
   class Performance
     attr_accessor :artist, :display_name, :id, :billing_index, :billing