bandsintown 0.1.1

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/script/txt2html

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+
+load File.dirname(__FILE__) + "/../Rakefile"
+require 'rubyforge'
+require 'redcloth'
+require 'syntax/convertors/html'
+require 'erb'
+
+download = "http://rubyforge.org/projects/#{$hoe.rubyforge_name}"
+version  = $hoe.version
+
+def rubyforge_project_id
+  RubyForge.new.configure.autoconfig["group_ids"][$hoe.rubyforge_name]
+end
+
+class Fixnum
+  def ordinal
+    # teens
+    return 'th' if (10..19).include?(self % 100)
+    # others
+    case self % 10
+    when 1: return 'st'
+    when 2: return 'nd'
+    when 3: return 'rd'
+    else    return 'th'
+    end
+  end
+end
+
+class Time
+  def pretty
+    return "#{mday}#{mday.ordinal} #{strftime('%B')} #{year}"
+  end
+end
+
+def convert_syntax(syntax, source)
+  return Syntax::Convertors::HTML.for_syntax(syntax).convert(source).gsub(%r!^<pre>|</pre>$!,'')
+end
+
+if ARGV.length >= 1
+  src, template = ARGV
+  template ||= File.join(File.dirname(__FILE__), '/../website/template.html.erb')
+else
+  puts("Usage: #{File.split($0).last} source.txt [template.html.erb] > output.html")
+  exit!
+end
+
+template = ERB.new(File.open(template).read)
+
+title = nil
+body = nil
+File.open(src) do |fsrc|
+  title_text = fsrc.readline
+  body_text_template = fsrc.read
+  body_text = ERB.new(body_text_template).result(binding)
+  syntax_items = []
+  body_text.gsub!(%r!<(pre|code)[^>]*?syntax=['"]([^'"]+)[^>]*>(.*?)</\1>!m){
+    ident = syntax_items.length
+    element, syntax, source = $1, $2, $3
+    syntax_items << "<#{element} class='syntax'>#{convert_syntax(syntax, source)}</#{element}>"
+    "syntax-temp-#{ident}"
+  }
+  title = RedCloth.new(title_text).to_html.gsub(%r!<.*?>!,'').strip
+  body = RedCloth.new(body_text).to_html
+  body.gsub!(%r!(?:<pre><code>)?syntax-temp-(\d+)(?:</code></pre>)?!){ syntax_items[$1.to_i] }
+end
+stat = File.stat(src)
+created = stat.ctime
+modified = stat.mtime
+
+$stdout << template.result(binding)

data/spec/bandsintown/artist_spec.rb

@@ -0,0 +1,114 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Bandsintown::Artist do
+  
+  before(:each) do
+    @name = "Little Brother"
+    @url = "http://www.bandsintown.com/LittleBrother"
+    @artist = Bandsintown::Artist.new(@name, @url)
+  end
+  
+  describe ".initialize(name, url = nil)" do
+    it "should set the Artist name" do
+      @artist.name.should == @name
+    end
+    it "should set the Artist bandsintown_url if given" do
+      @artist.bandsintown_url.should == @url
+    end
+    
+    describe "generating a url (initialize with nil url)" do
+      it "should strip spaces" do
+        name = "The Beatles "
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/TheBeatles"
+      end
+      it "should convert '&' -> 'And'" do
+        name = "Meg & Dia"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/MegAndDia"
+      end
+      it "should convert '+' -> 'Plus'" do
+        name = "+44"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/Plus44"
+      end
+      it "should camelcase seperate words" do
+        name = "meg & dia"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/MegAndDia"
+      end
+      it "should not cgi escape url" do
+        name = "$up"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/$up"
+      end
+      it "should uri escape accented characters" do
+        name = "sigur rós"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/SigurR%C3%B3s"
+      end
+      it "should not alter the case of single word names" do
+        name = "AWOL"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/AWOL"
+      end
+      it "should allow dots" do
+        name = "M.I.A"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/M.I.A"
+      end
+      it "should allow exclamations" do
+        name = "against me!"
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/AgainstMe!"
+      end
+      it "should not modify @name" do
+        name = "this is how i think"
+        Bandsintown::Artist.new(name)
+        name.should == "this is how i think"
+      end
+      it "should cgi escape '/' so it will be double encoded" do
+        name = "AC/DC"
+        escaped_name = URI.escape(name.gsub('/', CGI.escape('/')))
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/#{escaped_name}"
+      end
+      it "should cgi escape '?' so it will be double encoded" do
+        name = "Does it offend you, yeah?"
+        escaped_name = URI.escape("DoesItOffendYou,Yeah#{CGI.escape('?')}")
+        Bandsintown::Artist.new(name).bandsintown_url.should == "http://www.bandsintown.com/#{escaped_name}"
+      end
+    end
+  end
+  
+  describe ".resource_path" do
+    it "should return the API resource path for artists" do
+      Bandsintown::Artist.resource_path.should == 'artists'
+    end
+  end
+  
+  describe "#events" do
+    before(:each) do
+      @artist = Bandsintown::Artist.new("Little Brother")
+    end
+    it "should request and parse a call to the BIT artist events API method and the artist's api name" do
+      @artist.should_receive(:api_name).and_return("Little+Brother")
+      Bandsintown::Artist.should_receive(:request_and_parse).with("Little+Brother/events").and_return([])
+      @artist.events
+    end
+    it "should return an Array of Bandsintown::Event objects built from the response" do
+      event_1 = mock(Bandsintown::Event)
+      event_2 = mock(Bandsintown::Event)
+      results = [ "event 1", "event 2" ]
+      Bandsintown::Artist.stub!(:request_and_parse).and_return(results)
+      Bandsintown::Event.should_receive(:build_from_json).with("event 1").ordered.and_return(event_1)
+      Bandsintown::Event.should_receive(:build_from_json).with("event 2").ordered.and_return(event_2)
+      @artist.events.should == [event_1, event_2]
+    end
+    it "should be cached" do
+      @artist.events = 'events'
+      Bandsintown::Artist.should_not_receive(:request_and_parse)
+      @artist.events.should == 'events'
+    end
+  end
+  
+  describe "#api_name" do
+    it "should URI escape @name" do
+      @artist.api_name.should == URI.escape(@artist.name)
+    end
+    it "should CGI escape / and ? characters before URI escaping the whole name" do
+      Bandsintown::Artist.new("AC/DC").api_name.should == URI.escape(CGI.escape("AC/DC"))
+      Bandsintown::Artist.new("?uestlove").api_name.should == URI.escape(CGI.escape("?uestlove"))
+    end
+  end
+end

data/spec/bandsintown/base_spec.rb

@@ -0,0 +1,70 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Bandsintown::Base do
+  
+  describe ".connection" do
+    it "should be an instance of Bandsintown::Connection" do
+      Bandsintown::Base.connection.class.should == Bandsintown::Connection
+    end
+    it "should be cached" do
+      Bandsintown::Base.connection.should === Bandsintown::Base.connection
+    end
+  end
+  
+  describe ".request(api_method, args={})" do
+    it "should make a request to the connection url" do
+      resource_path = "events"
+      method        = "search"
+      args          = { :arg => "value" }
+      Bandsintown::Base.stub!(:resource_path).and_return(resource_path)
+      Bandsintown::Base.connection.should_receive(:request).with(resource_path, method, args)
+      Bandsintown::Base.request(method, args)
+    end
+  end
+  
+  describe ".parse(response)" do
+    it "should check the response for errors" do
+      response = "response"
+      parsed   = mock("parsed json")
+      JSON.stub!(:parse).and_return(parsed)
+      Bandsintown::Base.should_receive(:check_for_errors).with(parsed)
+      Bandsintown::Base.parse(response)
+    end
+    it "should convert the response from JSON format and return it" do
+      response = "{\"ok\": 123}\n"
+      Bandsintown::Base.parse(response).should == { "ok" => 123 }
+    end
+  end
+  
+  describe ".request_and_parse(api_method, args={})" do
+    before(:each) do
+      @resource_path = "events"
+      @method        = "search"
+      @args          = { :arg => "value" }
+      Bandsintown::Base.stub!(:resource_path).and_return(@resource_path)
+      @response = mock("WWW::Mechanize response")
+    end
+    it "should make a request" do
+      Bandsintown::Base.should_receive(:request).with(@method, @args).and_return(@response)
+      Bandsintown::Base.stub!(:parse)
+      Bandsintown::Base.request_and_parse(@method, @args)
+    end
+    it "should parse the response" do
+      Bandsintown::Base.stub!(:request).and_return(@response)
+      Bandsintown::Base.should_receive(:parse).with(@response)
+      Bandsintown::Base.request_and_parse(@method, @args)
+    end
+  end
+  
+  describe ".check_for_errors(json)" do
+    it "should raise an APIError containing all the error messages from the API, if the response has error messages" do
+      json = { "errors" => [ "location or artists param is required", "invalid date format" ] }
+      lambda { Bandsintown::Base.check_for_errors(json) }.should raise_error(Bandsintown::APIError, "location or artists param is required, invalid date format")
+    end
+    it "should not raise an error if the response doesn't have error messages" do
+      json = { "something" => "thats not an error" }
+      lambda { Bandsintown::Base.check_for_errors(json) }.should_not raise_error
+    end
+  end
+  
+end

data/spec/bandsintown/connection_spec.rb

@@ -0,0 +1,85 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Bandsintown::Connection do
+  before(:each) do
+    Bandsintown.app_id = 'YOUR_APP_ID'
+    @base_url = "http://api.bandsintown.com"
+  end
+  
+  describe ".initialize(base_url)" do
+    it "should set the base_url for the Connection" do
+      Bandsintown::Connection.new(@base_url).base_url.should == @base_url
+    end
+  end
+  
+  describe ".request(url_path, args = {}, method = :get)" do
+    before(:each) do
+      @connection = Bandsintown::Connection.new(@base_url)
+      @response = StringIO.new("response")
+      @connection.stub!(:open).and_return(@response)
+      @api_resource = "events"
+      @api_method = "search"
+    end
+    it "should convert args to url parameters when making a request" do
+      args         = { :artists => ["Little Brother", "Joe Scudda"], :location => "Boston, MA", :radius => 10 }
+      request_url  = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&artists%5B%5D=Little+Brother&artists%5B%5D=Joe+Scudda&format=json&location=Boston%2C+MA&radius=10"  
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)  
+    end
+    it "should convert args[:start_date] and args[:end_date] to a single args[:date] parameter when making a request" do
+      args         = { :start_date => "2009-01-01", :end_date => "2009-02-01" }
+      request_url  = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&date=2009-01-01%2C2009-02-01&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)
+    end
+    it "should allow date to be a Time object" do
+      args = { :date => Time.now.beginning_of_day }
+      request_url = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&date=#{Time.now.beginning_of_day.strftime("%Y-%m-%d")}&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)
+    end
+    it "should allow date to be a Date object" do
+      args = { :date => Date.today }
+      request_url = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&date=#{Date.today.strftime("%Y-%m-%d")}&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)
+    end
+    it "should allow date to be a String object" do
+      args = { :date => "2009-01-01" }
+      request_url = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&date=2009-01-01&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)
+    end
+    it "should allow start date and end date to be Time objects" do
+      args         = { :start_date => 1.week.ago, :end_date => 1.week.from_now }
+      request_url  = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&date=#{1.week.ago.strftime('%Y-%m-%d')}%2C#{1.week.from_now.strftime('%Y-%m-%d')}&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)
+    end
+    it "should allow start date and end date to be Date objects" do
+      args         = { :start_date => 1.week.ago.to_date, :end_date => 1.week.from_now.to_date }
+      request_url  = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&date=#{1.week.ago.to_date.strftime('%Y-%m-%d')}%2C#{1.week.from_now.to_date.strftime('%Y-%m-%d')}&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)
+    end
+    it "should allow start date and end date to be String objects" do
+      args         = { :start_date => "2009-01-01", :end_date => "2009-02-01" }
+      request_url  = "http://api.bandsintown.com/events/search?app_id=YOUR_APP_ID&date=2009-01-01%2C2009-02-01&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, args)
+    end
+    it "should return the API error message instead of raising an error if there was a problem with the request (404 response)" do
+      error = OpenURI::HTTPError.new('404', StringIO.new('error message'))
+      @connection.stub!(:open).and_raise(error)
+      lambda { @connection.request("", "", {}) }.should_not raise_error
+      error.io.rewind
+      @connection.request("", "", {}).should == 'error message'
+    end
+    it "should set the format to json and the send app id without the user having to specify them" do
+      request_url = "http://api.bandsintown.com/events/search?app_id=#{Bandsintown.app_id}&format=json"
+      @connection.should_receive(:open).with(request_url).and_return(@response)
+      @connection.request(@api_resource, @api_method, {})
+    end
+  end
+  
+end

data/spec/bandsintown/event_spec.rb

@@ -0,0 +1,149 @@
+require File.dirname(__FILE__) + '/../spec_helper.rb'
+
+describe Bandsintown::Event do
+  
+  describe ".resource_path" do
+    it "should return the relative path to Event requests" do
+      Bandsintown::Event.resource_path.should == "events"
+    end
+  end
+  
+  describe ".search(args = {})" do
+    @args = { :location => "Boston, MA", :date => "2009-01-01" }
+    it "should request and parse a call to the BIT events search api method" do
+      Bandsintown::Event.should_receive(:request_and_parse).with("search", @args).and_return([])
+      Bandsintown::Event.search(@args)
+    end
+    it "should return an Array of Bandsintown::Event objects built from the response" do
+      event_1 = mock(Bandsintown::Event)
+      event_2 = mock(Bandsintown::Event)
+      results = [ "event 1", "event 2" ]
+      Bandsintown::Event.stub!(:request_and_parse).and_return(results)
+      Bandsintown::Event.should_receive(:build_from_json).with("event 1").ordered.and_return(event_1)
+      Bandsintown::Event.should_receive(:build_from_json).with("event 2").ordered.and_return(event_2)
+      Bandsintown::Event.search(@args).should == [event_1, event_2]
+    end
+  end
+  
+  describe ".recommended(args = {})" do
+    @args = { :location => "Boston, MA", :date => "2009-01-01" }
+    it "should request and parse a call to the BIT recommended events api method" do
+      Bandsintown::Event.should_receive(:request_and_parse).with("recommended", @args).and_return([])
+      Bandsintown::Event.recommended(@args)
+    end
+    it "should return an Array of Bandsintown::Event objects built from the response" do
+      event_1 = mock(Bandsintown::Event)
+      event_2 = mock(Bandsintown::Event)
+      results = [ "event 1", "event 2" ]
+      Bandsintown::Event.stub!(:request_and_parse).and_return(results)
+      Bandsintown::Event.should_receive(:build_from_json).with("event 1").ordered.and_return(event_1)
+      Bandsintown::Event.should_receive(:build_from_json).with("event 2").ordered.and_return(event_2)
+      Bandsintown::Event.recommended(@args).should == [event_1, event_2]
+    end
+  end
+  
+  describe ".daily" do
+    it "should request and parse a call to the BIT daily events api method" do
+      Bandsintown::Event.should_receive(:request_and_parse).with("daily").and_return([])
+      Bandsintown::Event.daily
+    end
+    it "should return an array of Bandsintown::Events built from the response" do
+      event = mock(Bandsintown::Event)
+      Bandsintown::Event.stub!(:request_and_parse).and_return(['event json'])
+      Bandsintown::Event.should_receive(:build_from_json).with('event json').and_return(event)
+      Bandsintown::Event.daily.should == [event]
+    end
+  end
+  
+  describe ".build_from_json(json_hash)" do
+    before(:each) do
+      @event_id   = 745089
+      @event_url  = "http://www.bandsintown.com/event/745095"
+      @datetime   = "2008-09-30T19:30:00"
+      @ticket_url = "http://www.bandsintown.com/event/745095/buy_tickets"
+      
+      @artist_1 = { "name" => "Little Brother", "url" => "http://www.bandsintown.com/LittleBrother" }
+      @artist_2 = { "name" => "Joe Scudda", "url" => "http://www.bandsintown.com/JoeScudda" }
+            
+      @venue_hash = {
+        "id" => 327987,
+        "url" => "http://www.bandsintown.com/venue/327987",
+        "region" => "MA",
+        "city" => "Boston",
+        "name" => "Paradise Rock Club",
+        "country" => "United States",
+        "latitude" => 42.37,
+        "longitude" => 71.03
+      }
+      
+      @event_hash = {
+        "id" => @event_id,
+        "url" => @event_url,
+        "datetime" => @datetime,
+        "ticket_url" => @ticket_url,
+        "artists" => [@artist_1, @artist_2],
+        "venue" => @venue_hash,
+        "status" => "new",
+        "ticket_status" => "available",
+        "on_sale_datetime" => "2008-09-01T19:30:00"
+      }
+      
+      @built_event = Bandsintown::Event.build_from_json(@event_hash)
+    end
+    it "should return a built Event" do
+      @built_event.class.should == Bandsintown::Event
+    end
+    it "should set the Event id" do
+      @built_event.bandsintown_id.should == @event_id
+    end
+    it "should set the Event url" do
+      @built_event.bandsintown_url.should == @event_url
+    end
+    it "should set the Event datetime" do
+      @built_event.datetime.should == Time.parse(@datetime)
+    end
+    it "should set the Event ticket url" do
+      @built_event.ticket_url.should == @ticket_url
+    end
+    it "should set the Event status" do
+      @built_event.status.should == "new"
+    end
+    it "should set the Event ticket_status" do
+      @built_event.ticket_status.should == "available"
+    end
+    it "should set the Event on_sale_datetime" do
+      @built_event.on_sale_datetime.should == Time.parse(@event_hash['on_sale_datetime'])
+    end
+    it "should set the Event on_sale_datetime to nil if not given" do
+      @event_hash['on_sale_datetime'] = nil
+      Bandsintown::Event.build_from_json(@event_hash).on_sale_datetime.should be_nil
+    end
+    it "should set the Event's Venue" do
+      built_venue = mock(Bandsintown::Venue)
+      Bandsintown::Venue.should_receive(:new).with(@venue_hash).and_return(built_venue)
+      @built_event = Bandsintown::Event.build_from_json(@event_hash)
+      @built_event.venue.should == built_venue
+    end
+    it "should set the Event's Artists" do
+      built_artist_1 = mock(Bandsintown::Artist, :name => "Little Brother")
+      built_artist_2 = mock(Bandsintown::Artist, :name => "Joe Scudda")
+      Bandsintown::Artist.should_receive(:new).with(@artist_1["name"], @artist_1["url"]).and_return(built_artist_1)
+      Bandsintown::Artist.should_receive(:new).with(@artist_2["name"], @artist_2["url"]).and_return(built_artist_2)
+      @built_event = Bandsintown::Event.build_from_json(@event_hash)
+      @built_event.artists.should == [built_artist_1, built_artist_2]
+    end
+  end
+  
+  describe "#tickets_available?" do
+    it "should return true if @ticket_status is 'available'" do
+      event = Bandsintown::Event.new
+      event.ticket_status = 'available'
+      event.tickets_available?.should be_true
+    end
+    it "should return false if @ticket_status is not 'available'" do
+      event = Bandsintown::Event.new
+      event.ticket_status = 'unavailable'
+      event.tickets_available?.should be_false
+    end
+  end
+end