songkick_ruby 1.2.0 → 1.2.1

data/lib/songkick/client/calendar.rb

@@ -1,61 +1,59 @@
 module Songkick
-  class Client
     module Calendar
 
-      # Find upcoming events for an artist
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # events = sg.artist_calendar(123)
-      # or events = sg.artist_calendar(123, 2)
-      #
-      # The first argument is the artist_id
-      # and the second argument is the page number,
-      # by default it is set to 1
-      def artist_calendar(artist_id, page = 1)
-        get "artists/#{artist_id}/calendar.#{format}", page
-      end
+    # Find upcoming events for an artist
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # events = sg.artist_calendar(123)
+    # or events = sg.artist_calendar(123, 2)
+    #
+    # The first argument is the artist_id
+    # and the second argument is the page number,
+    # by default it is set to 1
+    def artist_calendar(artist_id, page = 1)
+      get "artists/#{artist_id}/calendar.#{format}", page
+    end
 
-      # Find upcoming events for a location
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # events = sg.location_calendar(123)
-      # or events = sg.location_calendar(123, 2)
-      #
-      # The first argument is the artist_id
-      # and the second argument is the page number,
-      # by default it is set to 1
-      def location_calendar(location_id, page = 1)
-        get "metro_areas/#{location_id}/calendar.#{format}", page
-      end
+    # Find upcoming events for a location
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # events = sg.location_calendar(123)
+    # or events = sg.location_calendar(123, 2)
+    #
+    # The first argument is the artist_id
+    # and the second argument is the page number,
+    # by default it is set to 1
+    def location_calendar(location_id, page = 1)
+      get "metro_areas/#{location_id}/calendar.#{format}", page
+    end
 
-      # Find upcoming events for a user
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # events = sg.users(123)
-      # or events = sg.users(123, 2)
-      #
-      # The first argument is the artist_id
-      # and the second argument is the page number,
-      # by default it is set to 1
-      def user_calendar(username, page = 1)
-        get "users/#{username}/calendar.#{format}", page
-      end
+    # Find upcoming events for a user
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # events = sg.users(123)
+    # or events = sg.users(123, 2)
+    #
+    # The first argument is the artist_id
+    # and the second argument is the page number,
+    # by default it is set to 1
+    def user_calendar(username, page = 1)
+      get "users/#{username}/calendar.#{format}", page
+    end
 
-      # Find upcoming events for a venue
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # or events = sg.usersvenue_calendar(123)
-      #
-      # The first argument is the venue_id
-      # and the second argument is the page number,
-      # by default it is set to 1
-      def venue_calendar(venue_id, page = 1)
-        get "users/#{venue_id}/venues.#{format}", page
-      end
+    # Find upcoming events for a venue
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # or events = sg.usersvenue_calendar(123)
+    #
+    # The first argument is the venue_id
+    # and the second argument is the page number,
+    # by default it is set to 1
+    def venue_calendar(venue_id, page = 1)
+      get "users/#{venue_id}/venues.#{format}", page
     end
   end
 end

data/lib/songkick/client/errors.rb

@@ -0,0 +1,7 @@
+module Songkick
+  module Errors
+    
+    class InvalidOptions < StandardError; end
+    
+  end
+end

data/lib/songkick/client/event.rb

@@ -1,17 +1,15 @@
 module Songkick
-  class Client
-    module Event
-
-    	# Find detailed information about an event
-    	#
-    	# Example:
-    	# sg = Songkick.new("myapikey")
-    	# event = sg.find_event(123)
-    	# The first argument is the event id
-      def find_event(event_id)
-        get "events/#{event_id}.#{format}"
-      end
+  module Event
 
+  	# Find detailed information about an event
+  	#
+  	# Example:
+  	# sg = Songkick.new("myapikey")
+  	# event = sg.find_event(123)
+  	# The first argument is the event id
+    def find_event(event_id)
+      get "events/#{event_id}.#{format}"
     end
+
   end
 end

data/lib/songkick/client/request.rb

@@ -1,27 +1,25 @@
 module Songkick
-  class Client
-    module Request
+  module Request
 
-      private
-      
-      # Perform a get request
-      # and returns the response body in the correct format
-      def get(url, page = 1)
-        uri = generate_uri(url, page)
+    private
+    
+    # Perform a get request
+    # and returns the response body in the correct format
+    def get(url, page = 1)
+      uri = generate_uri(url, page)
 
-        response = Net::HTTP.get_response(uri)
-        json? ? JSON.parse(response.body) : response.body
-      end
-
-      # Generate uri with aditionnal options
-      # such as the page number and the api key
-      def generate_uri(url, page)
-        uri = API_URL + url
-        uri += uri.include?("?") ? "&page=#{page}" : "?page=#{page}" if page.to_i > 1
-        uri = URI.parse uri.include?("?") ? uri + "&apikey=#{api_key}" : uri + "?apikey=#{api_key}"
-        uri
-      end
+      response = Net::HTTP.get_response(uri)
+      json? ? JSON.parse(response.body) : response.body
+    end
 
+    # Generate uri with aditionnal options
+    # such as the page number and the api key
+    def generate_uri(url, page)
+      uri = API_URL + url
+      uri += uri.include?("?") ? "&page=#{page}" : "?page=#{page}" if page.to_i > 1
+      uri = URI.parse uri.include?("?") ? uri + "&apikey=#{api_key}" : uri + "?apikey=#{api_key}"
+      uri
     end
+
   end
 end

data/lib/songkick/client/search.rb

@@ -1,66 +1,71 @@
-module Songkick
-  class Client
-    module Search
+require "songkick/client/validations"
 
-      # Search for upcoming events
-      #
-      # Options:
-      # * artist_name
-      # * location
-      # * * sk
-      # * * geo
-      # * * ip
-      # * * clientip
-      # * min_date
-      # * max_date
-      #
-      # Look at this page for more information about the location option: 
-      # http://www.songkick.com/developer/event-search
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # events = sg.search_events({:artist_name => "lady gaga"})
-      # events = sg.search_events({:artist_name => "lady gaga"}, 2)
-      # events = sg.search_events({:artist_name => "lady gaga", :location => "clientip=10.10.10.10"} )})
-      def search_events(opts, page = 1)
-        _opts = opts.collect{|k, v| "#{k}=#{v.gsub(" ", "%20")}"}.join("&")
-        get "events.#{format}?#{_opts}", page
-      end
-      alias_method :search_event, :search_events
+module Songkick
+  module Search
+    include Validations
 
-      # Search for locations
-      #
-      # Options:
-      # * query
-      # * location
-      #
-      # Look at this page for more information about the location option: 
-      # http://www.songkick.com/developer/location-search
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # locations = sg.search_locations({:query => "Paris"})
-      def search_locations(opts, page = 1)
-        _opts = opts.collect{|k, v| "#{k}=#{v.gsub(" ", "%20")}"}.join("&")
-        get "search/locations.#{format}?#{_opts}", page
-      end
-      alias_method :search_location, :search_locations
+    # Search for upcoming events
+    #
+    # Options:
+    # * artist_name
+    # * location
+    # * * sk
+    # * * geo
+    # * * ip
+    # * * clientip
+    # * min_date
+    # * max_date
+    #
+    # Look at this page for more information about the location option: 
+    # http://www.songkick.com/developer/event-search
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # events = sg.search_events({:artist_name => "lady gaga"})
+    # events = sg.search_events({:artist_name => "lady gaga"}, 2)
+    # events = sg.search_events({:artist_name => "lady gaga", :location => "clientip=10.10.10.10"} )})
+    def search_events(opts, page = 1)
+      validate_options %w(artist_name location min_date max_date), opts
+      
+      _opts = opts.collect{|k, v| "#{k}=#{v.gsub(" ", "%20")}"}.join("&")
+      get "events.#{format}?#{_opts}", page
+    end
+    alias_method :search_event, :search_events
 
-      # Search for artists
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # artists = sg.search_artists("ladygaga")
-      def search_artists(text, page = 1)
-        get "search/artists.#{format}?query=#{text.gsub(" ","%20")}", page
-      end
-      alias_method :search_artist, :search_artists
+    # Search for locations
+    #
+    # Options:
+    # * query
+    # * location
+    #
+    # Look at this page for more information about the location option: 
+    # http://www.songkick.com/developer/location-search
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # locations = sg.search_locations({:query => "Paris"})
+    def search_locations(opts, page = 1)
+      validate_options %w(query location), opts
+      
+      _opts = opts.collect{|k, v| "#{k}=#{v.gsub(" ", "%20")}"}.join("&")
+      get "search/locations.#{format}?#{_opts}", page
+    end
+    alias_method :search_location, :search_locations
 
-      # Search for venues
-      def search_venues(text, page = 1)
-        get "search/venues.#{format}?query=#{text.gsub(" ","%20")}", page   
-      end
+    # Search for artists
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # artists = sg.search_artists("ladygaga")
+    def search_artists(text, page = 1)
+      get "search/artists.#{format}?query=#{text.gsub(" ","%20")}", page
+    end
+    alias_method :search_artist, :search_artists
 
+    # Search for venues
+    def search_venues(text, page = 1)
+      get "search/venues.#{format}?query=#{text.gsub(" ","%20")}", page   
     end
+
   end
 end

data/lib/songkick/client/user.rb

@@ -1,50 +1,48 @@
 module Songkick
-  class Client
-    module User
+  module User
 
-      # Find past events that a user attended
-      # For upcoming events use user_calendar method
-      # Important:
-      # Only public profiles are considered
-      #
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # gigs = song.gigography("saleandro")
-      def gigography(username, page = 1)
-        get "users/#{username}/gigography.#{format}", page
-      end
-
-      # Get tracked locations for a user
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # locations = sg.tracked_locations("saleandro")
-      def tracked_locations(username, page = 1)
-        get "users/#{username}/metro_areas/tracked.#{format}", page
-      end
+    # Find past events that a user attended
+    # For upcoming events use user_calendar method
+    # Important:
+    # Only public profiles are considered
+    #
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # gigs = song.gigography("saleandro")
+    def gigography(username, page = 1)
+      get "users/#{username}/gigography.#{format}", page
+    end
 
-      # Get tracked artists for a user
-      # Example:
-      # sg = Songkick.new("myapikey")
-      # artists = sg.tracked_artists("saleandro")
-      def tracked_artists(username, page = 1)
-        get "users/#{username}/artists/tracked.#{format}", page
-      end
+    # Get tracked locations for a user
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # locations = sg.tracked_locations("saleandro")
+    def tracked_locations(username, page = 1)
+      get "users/#{username}/metro_areas/tracked.#{format}", page
+    end
 
-      # Track an artist
-      def track_artist(username, artist_id)
-        get "users/#{username}/trackings/artist:#{artist_id}.#{format}"
-      end
+    # Get tracked artists for a user
+    # Example:
+    # sg = Songkick.new("myapikey")
+    # artists = sg.tracked_artists("saleandro")
+    def tracked_artists(username, page = 1)
+      get "users/#{username}/artists/tracked.#{format}", page
+    end
 
-      # Track a location
-      def track_location(usersame, location_id)
-        get "users/#{username}/trackings/metro_area:#{location_id}.#{format}"
-      end
+    # Track an artist
+    def track_artist(username, artist_id)
+      get "users/#{username}/trackings/artist:#{artist_id}.#{format}"
+    end
 
-      # Attendance
-      def attendance(username, event_id)
-        get "users/#{username}/trackings/event:#{event_id}.#{format}"
-      end
+    # Track a location
+    def track_location(usersame, location_id)
+      get "users/#{username}/trackings/metro_area:#{location_id}.#{format}"
+    end
 
+    # Attendance
+    def attendance(username, event_id)
+      get "users/#{username}/trackings/event:#{event_id}.#{format}"
     end
+
   end
 end

data/lib/songkick/client/validations.rb

@@ -0,0 +1,14 @@
+require "songkick/client/errors"
+
+module Songkick
+  module Validations
+    include Errors
+    
+    def validate_options(valid_opts, opts)
+      if (opts.keys.map(&:to_s) - valid_opts).any?
+        raise InvalidOptions
+      end
+    end 
+  
+  end
+end

data/lib/songkick/client.rb

@@ -1,14 +1,12 @@
-require "songkick/client/calendar.rb"
-require "songkick/client/event.rb"
-require "songkick/client/request.rb"
-require "songkick/client/search.rb"
-require "songkick/client/user.rb"
+require "songkick/client/calendar"
+require "songkick/client/event"
+require "songkick/client/request"
+require "songkick/client/search"
+require "songkick/client/user"
 
 module Songkick
   class Client
     
-    API_URL = 'http://api.songkick.com/api/3.0/'
-    
     attr_accessor :api_key, :format
 
     # Look at the songkick.rb file for info
@@ -28,11 +26,11 @@ module Songkick
       format == 'xml'
     end
 
-    include Songkick::Client::Calendar
-    include Songkick::Client::Event
-    include Songkick::Client::Search
-    include Songkick::Client::User
-    include Songkick::Client::Request
+    include Songkick::Calendar
+    include Songkick::Event
+    include Songkick::Search
+    include Songkick::User
+    include Songkick::Request
 
   end
 end

data/lib/songkick.rb

@@ -2,10 +2,12 @@ require "net/http"
 require "rubygems"
 require 'json'
 
-require "songkick/version.rb"
-require "songkick/client.rb"
+require "songkick/client"
 
 module Songkick
+  
+  API_URL = 'http://api.songkick.com/api/3.0/'
+  
   class << self
    	
    	# In order to use the API you must have an API key

data/songkick_ruby.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = "songkick_ruby"
-  s.version = "1.2.0"
+  s.version = "1.2.1"
   s.author = "Gregory Marcilhacy"
   s.email = "g.marcilhacy@gmail.com"
   s.homepage = "http://github.com/gregorym/songkick_ruby"
@@ -14,14 +14,17 @@ Gem::Specification.new do |s|
     songkick_ruby.gemspec
     lib/songkick.rb
     lib/songkick
-    lib/songkick/version.rb
     lib/songkick/client.rb
     lib/songkick/client/calendar.rb
     lib/songkick/client/event.rb
     lib/songkick/client/search.rb
     lib/songkick/client/user.rb
     lib/songkick/client/request.rb
+    lib/songkick/client/validations.rb
+    lib/songkick/client/errors.rb
   )
   
-  s.test_files = %w()
-end
+  s.test_files = %w(
+    spec/songkick_spec.rb
+  )
+end

data/spec/songkick_spec.rb

@@ -0,0 +1,100 @@
+require "./lib/songkick.rb"
+
+API_KEY = "frs8I4dwEXMX5raJ"
+
+describe Songkick do
+  describe "#initialization" do
+    
+    it "should be a new intance of songkick" do
+      client1 = Songkick.new("abc")
+      client2 = Songkick::Client.new("abc")
+
+      client1.class.name.should == "Songkick::Client"
+      client2.class.name.should == "Songkick::Client"
+    end
+
+    it "should be json format" do 
+      client = Songkick.new("abc")
+      client.format.should == "json"
+      client.json?.should be_true
+    end
+
+    it "should be xml format" do 
+      client = Songkick.new("abc", :xml)
+      client.format.should == "xml"
+      client.xml?.should be_true
+    end
+    
+  end
+  
+  describe "#Validations" do
+    it "should raise an exception on wrong options" do
+      client = Songkick.new API_KEY
+      lambda {
+        client.search_event({:location => "Paris", :artist => "Fail!" })
+      }.should raise_error(Songkick::Errors::InvalidOptions)
+    end
+  end
+
+  describe "#Songkick request" do
+    it "should fail with a wrong API key" do
+      key     = "helloworld"
+      client  = Songkick.new(key)
+      
+      response = client.search_artists("Blink 182")
+      response["resultsPage"]["status"].should == "error"
+    end
+
+    it "should success with a valid API key" do 
+      client  = Songkick.new(API_KEY)
+
+      response = client.search_artists("Blink 182")
+      response["resultsPage"]["status"].should == "ok"
+    end
+  end
+
+  describe "#Songkick event" do
+    before :each do
+      @client = Songkick.new API_KEY
+    end
+
+    it "should find an event" do
+      event = @client.find_event(3037536)
+      event["resultsPage"]["status"].should == "ok"
+      event["resultsPage"]["results"]["event"].is_a?(Hash) == true 
+      event["resultsPage"]["results"]["event"]["displayName"].include?("Vampire") == true 
+    end
+  end
+
+  describe "#Songkick calendar" do
+    before :each do
+      @client = Songkick.new API_KEY
+    end
+
+    it "should search events" do
+      events = @client.search_events({:artist_name => "Coldplay"})
+      events["resultsPage"]["totalEntries"].nil? == false
+      events["resultsPage"]["totalEntries"].is_a?(Integer) == true
+    end
+
+    it "should search locations" do
+      events = @client.search_locations({:query => "Paris"})
+      events["resultsPage"]["totalEntries"].nil? == false
+      events["resultsPage"]["totalEntries"].is_a?(Integer) == true
+    end
+
+    it "should search artists" do
+      events = @client.search_artists("Coldplay")
+      events["resultsPage"]["totalEntries"].nil? == false
+      events["resultsPage"]["totalEntries"].is_a?(Integer) == true
+    end
+
+    it "should search venues" do
+      events = @client.search_venues("Stade de france")
+      events["resultsPage"]["totalEntries"].nil? == false
+      events["resultsPage"]["totalEntries"].is_a?(Integer) == true
+    end
+
+  end
+
+end

metadata

@@ -1,91 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: songkick_ruby
-version: !ruby/object:Gem::Version 
-  hash: 31
+version: !ruby/object:Gem::Version
+  version: 1.2.1
   prerelease: 
-  segments: 
-  - 1
-  - 2
-  - 0
-  version: 1.2.0
 platform: ruby
-authors: 
+authors:
 - Gregory Marcilhacy
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-12-15 00:00:00 +01:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2011-12-16 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: json
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &70320254905020 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 1
-        - 5
-        - 0
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.5.0
   type: :runtime
-  version_requirements: *id001
+  prerelease: false
+  version_requirements: *70320254905020
 description: 
 email: g.marcilhacy@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - README.textile
 - songkick_ruby.gemspec
 - lib/songkick.rb
-- lib/songkick/version.rb
 - lib/songkick/client.rb
 - lib/songkick/client/calendar.rb
 - lib/songkick/client/event.rb
 - lib/songkick/client/search.rb
 - lib/songkick/client/user.rb
 - lib/songkick/client/request.rb
-has_rdoc: true
+- lib/songkick/client/validations.rb
+- lib/songkick/client/errors.rb
+- spec/songkick_spec.rb
 homepage: http://github.com/gregorym/songkick_ruby
 licenses: []
-
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.6.2
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Ruby wrapper of the songkick api
-test_files: []
-
+test_files:
+- spec/songkick_spec.rb

data/lib/songkick/version.rb

@@ -1,3 +0,0 @@
-module Songkick
-  VERSION = '1.1.4'
-end