bandsintown 0.1.2 → 0.1.4

data/History.txt

@@ -1,3 +1,12 @@
+== 0.1.4 2010-03-02
+* Added Events - On Sale Soon API method (Bandsintown::Event.on_sale_soon)
+* Corrected some typos in Bandsintown::Event spec
+
+== 0.1.3 2010-01-28
+* Added Artists - Get API method (Bandsintown::Artist.get)
+* Added Bandsintown::Artist#on_tour? method
+* Updated readme and documentation for Bandsintown::Artist.get and Bandsintown::Artist#on_tour?
+
 == 0.1.2 2009-11-11
 * updated Bandsintown::Artist class with support for mbid / music brainz id and additional documentation
 

data/README.rdoc

@@ -39,6 +39,27 @@ For more information visit http://www.bandsintown.com/api/requests.
   })
   events = artist.events
 
+=== Find basic information about an artist without requesting event data
+
+  artist = Bandsintown::Artist.get({
+    :name => "Raekwon"
+  })
+  artist.upcoming_events_count
+  => 5
+  artist.on_tour?
+  => true
+
+=== Find basic information about an artist without requesting event data, using mbid
+
+  # 4e954b02-fae2-4bd7-9547-e055a6ac0527 => mbid for Raekwon
+  artist = Bandsintown::Artist.get({
+    :mbid => "4e954b02-fae2-4bd7-9547-e055a6ac0527"
+  })
+  artist.upcoming_events_count
+  => 5
+  artist.on_tour?
+  => true
+
 === Find events this week around Boston, MA 
 
   events = Bandsintown::Event.search({
@@ -75,10 +96,17 @@ For more information visit http://www.bandsintown.com/api/requests.
     :location => 'Boston, MA'
   })
 
-=== find events added/updated/deleted within the last day
+=== Find events added/updated/deleted within the last day
 
   events = Bandsintown::Event.daily
 
+=== Find events going on sale in the next week within 10 miles of Boston, MA
+
+  events = Bandsintown::Event.on_sale_soon({
+    :location => "Boston, MA",
+    :radius => 10
+  })
+
 == Links
 
 * RDoc[http://bandsintown.rubyforge.org/rdoc]

data/Rakefile

@@ -1,4 +1,4 @@
-%w[rubygems rake rake/clean fileutils newgem rubigen hoe].each { |f| require f }
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
 require File.dirname(__FILE__) + '/lib/bandsintown'
 
 # Generate all the Rake tasks

data/lib/bandsintown.rb

@@ -14,7 +14,7 @@ require 'bandsintown/event'
 require 'bandsintown/venue'
 
 module Bandsintown
-  VERSION = '0.1.2'
+  VERSION = '0.1.4'
   class APIError < StandardError; end
   class << self
     # All Bandsintown API requests require an app_id parameter for identification.

data/lib/bandsintown/artist.rb

@@ -1,7 +1,7 @@
 module Bandsintown
   class Artist < Base
     
-    attr_accessor :name, :bandsintown_url, :mbid, :events
+    attr_accessor :name, :bandsintown_url, :mbid, :events, :upcoming_events_count
     
     def initialize(options = {})
       @name = options[:name]
@@ -40,6 +40,47 @@ module Bandsintown
         "mbid_#{@mbid}"
       end
     end
+
+    #Returns true if there is at least 1 upcoming event for the artist, or false if there are 0 upcoming events for the artist.
+    #Should only be used for artists requested using Bandsintown::Artist.get, or with events already loaded, otherwise an error will be raised.
+    #====example:
+    #   # using .get method
+    #   artist = Bandsintown::Artist.get(:name => "Little Brother")
+    #   artist_on_tour = artist.on_tour?
+    #
+    #   # using .initialize and .events methods
+    #   artist = Bandsintown::Artist.get(:name => "Little Brother")
+    #   events = artist.events
+    #   artist_on_tour = artist.on_tour?
+    #
+    def on_tour?
+      (@upcoming_events_count || @events.size) > 0
+    end
+    
+    #Returns a Bandsintown::Artist object with basic information for a single artist, including the number of upcoming events. 
+    #Useful in determining if an artist is on tour without requesting the event data.
+    #See http://www.bandsintown.com/api/requests#artists-get for more information.
+    #Can be used with either artist name or mbid (music brainz id).
+    #====example:
+    #   # using artist name
+    #   artist = Bandsintown::Artist.get(:name => "Little Brother")
+    #
+    #   # using mbid for Little Brother
+    #   artist = Bandsintown::Artist.get(:mbid => "b929c0c9-5de0-4d87-8eb9-365ad1725629")
+    #
+    def self.get(options = {})
+      request_url = Bandsintown::Artist.new(options).api_name
+      build_from_json(request_and_parse(request_url))
+    end
+    
+    def self.build_from_json(json_hash)
+      artist = Bandsintown::Artist.new({})
+      artist.name = json_hash['name']
+      artist.mbid = json_hash['mbid']
+      artist.bandsintown_url = json_hash['url']
+      artist.upcoming_events_count = json_hash['upcoming_events_count']
+      artist
+    end
     
     def self.resource_path
       "artists"

data/lib/bandsintown/event.rb

@@ -79,6 +79,27 @@ module Bandsintown
       events
     end
     
+    #Returns an array of Bandsintown::Event objects going on sale in the next week, and matching the options passed.
+    #See http://www.bandsintown.com/api/requests#on-sale-soon for more information.
+    #====options:
+    #:location, :radius, and :date options are supported.  See the Bandsintown::Event.search documentation for accepted formats.
+    #
+    #====notes:
+    #If :location is given without :radius, a default radius of 25 miles will be used.
+    #
+    #====examples:
+    #All upcoming concerts within 10 miles of Boston, MA, with tickets going on sale in the next week:
+    #   Bandsintown::Event.on_sale_soon(:location => "Boston, MA", :radius => 10)
+    #
+    #All concerts happening between Mar 01 2010 and Mar 15 2010 within 25 miles of London, UK, with tickets going on sale in the next week:
+    #   Bandsintown::Event.on_sale_soon(:location => "London, UK", :start_date => "2010-03-01", :end_date => "2010-03-15")
+    #
+    def self.on_sale_soon(options = {})
+      events = []
+      self.request_and_parse("on_sale_soon", options).each { |event| events << Bandsintown::Event.build_from_json(event) }
+      events
+    end
+    
     def self.resource_path
       "events"
     end

data/spec/bandsintown/artist_spec.rb

@@ -24,6 +24,10 @@ describe Bandsintown::Artist do
       @artist.should respond_to(:mbid)
       @artist.should respond_to(:mbid=)
     end
+    it "should have an attr_accessor for @upcoming_events_count" do
+      @artist.should respond_to(:upcoming_events_count)
+      @artist.should respond_to(:upcoming_events_count=)
+    end
   end
   
   describe ".initialize(options = {})" do
@@ -140,4 +144,80 @@ describe Bandsintown::Artist do
       Bandsintown::Artist.new(:mbid => '1234').api_name.should == 'mbid_1234'
     end
   end
+  
+  describe ".get(options = {})" do
+    before(:each) do
+      @options = { :name => "Pete Rock" }
+      @artist = Bandsintown::Artist.new(@options)
+      Bandsintown::Artist.stub!(:request_and_parse).and_return('json')
+      Bandsintown::Artist.stub!(:build_from_json).and_return('built artist')
+    end
+    it "should initialize a Bandsintown::Artist from options" do
+      Bandsintown::Artist.should_receive(:new).with(@options).and_return(@artist)
+      Bandsintown::Artist.get(@options)
+    end
+    it "should request and parse a call to the BIT artists - get API method using api_name" do
+      Bandsintown::Artist.should_receive(:request_and_parse).with(@artist.api_name).and_return('json')
+      Bandsintown::Artist.get(@options)
+    end
+    it "should return the result of Bandsintown::Artist.build_from_json with the response data" do
+      Bandsintown::Artist.should_receive(:build_from_json).with('json').and_return('built artist')
+      Bandsintown::Artist.get(@options).should == 'built artist'
+    end
+  end
+  
+  describe ".build_from_json(json_hash)" do
+    before(:each) do
+      @name = "Pete Rock"
+      @bandsintown_url = "http://www.bandsintown.com/PeteRock"
+      @mbid = "39a973f2-0785-4ef6-90d9-551378864f89"
+      @upcoming_events_count = 7
+      @json_hash = {
+        "name" => @name,
+        "url" => @bandsintown_url,
+        "mbid" => @mbid,
+        "upcoming_events_count" => @upcoming_events_count
+      }
+      @artist = Bandsintown::Artist.build_from_json(@json_hash)
+    end
+    it "should return an instance of Bandsintown::Artist" do
+      @artist.should be_instance_of(Bandsintown::Artist)
+    end
+    it "should set the name" do
+      @artist.name.should == @name
+    end
+    it "should set the mbid" do
+      @artist.mbid.should == @mbid
+    end
+    it "should set the bandsintown_url" do 
+      @artist.bandsintown_url.should == @bandsintown_url
+    end
+    it "should set the upcoming events count" do
+      @artist.upcoming_events_count.should == @upcoming_events_count
+    end
+  end
+  
+  describe "#on_tour?" do
+    it "should return true if @upcoming_events_count is greater than 0" do
+      @artist.upcoming_events_count = 1
+      @artist.should be_on_tour
+    end
+    it "should return false if @upcoming_events_count is 0" do
+      @artist.upcoming_events_count = 0
+      @artist.should_not be_on_tour
+    end
+    it "should raise an error if both @upcoming_events_count and @events are nil" do
+      lambda { @artist.on_tour? }.should raise_error
+    end
+    describe "when @upcoming_events_count is nil" do
+      it "should return true if @events is not empty (.events only returns upcoming events)" do
+        @artist.events = [mock(Bandsintown::Event)]
+        @artist.should be_on_tour
+      end
+      it "should return false if @events is empty" do
+        @artist.events = []
+        @artist.should_not be_on_tour
+      end
+    end
+  end
 end

data/spec/bandsintown/event_spec.rb

@@ -8,8 +8,10 @@ describe Bandsintown::Event do
     end
   end
   
-  describe ".search(args = {})" do
-    @args = { :location => "Boston, MA", :date => "2009-01-01" }
+  describe ".search(options = {})" do
+    before(:each) do
+      @args = { :location => "Boston, MA", :date => "2009-01-01" }
+    end
     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)
@@ -25,8 +27,10 @@ describe Bandsintown::Event do
     end
   end
   
-  describe ".recommended(args = {})" do
-    @args = { :location => "Boston, MA", :date => "2009-01-01" }
+  describe ".recommended(options = {})" do
+    before(:each) do
+      @args = { :location => "Boston, MA", :date => "2009-01-01" }
+    end
     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)
@@ -55,6 +59,22 @@ describe Bandsintown::Event do
     end
   end
   
+  describe ".on_sale_soon(options = {})" do
+    before(:each) do
+      @args = { :location => "Boston, MA", :radius => 50, :date => "2010-03-02" }
+    end
+    it "should request and parse a call to the BIT on sale soon api method" do
+      Bandsintown::Event.should_receive(:request_and_parse).with("on_sale_soon", @args).and_return([])
+      Bandsintown::Event.on_sale_soon(@args)
+    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

data/website/index.html

@@ -34,7 +34,7 @@
     <div class="sidebar">
       <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/bandsintown"; return false'>
         <p>Get Version</p>
-        <a href="http://rubyforge.org/projects/bandsintown" class="numbers">0.1.2</a>
+        <a href="http://rubyforge.org/projects/bandsintown" class="numbers">0.1.4</a>
       </div>
     </div>
     <h2>Description</h2>
@@ -66,6 +66,27 @@
 <span class="punct">})</span>
 <span class="ident">events</span> <span class="punct">=</span> <span class="ident">artist</span><span class="punct">.</span><span class="ident">events</span>
 </pre></p>
+<h3>Find basic information about an artist without requesting event data</h3>
+<p><pre class='syntax'>
+<span class="ident">artist</span> <span class="punct">=</span> <span class="constant">Bandsintown</span><span class="punct">::</span><span class="constant">Artist</span><span class="punct">.</span><span class="ident">get</span><span class="punct">({</span>
+  <span class="symbol">:name</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">Raekwon</span><span class="punct">&quot;</span>
+<span class="punct">})</span>
+<span class="ident">artist</span><span class="punct">.</span><span class="ident">upcoming_events_count</span>
+<span class="punct">=&gt;</span> <span class="number">5</span>
+<span class="ident">artist</span><span class="punct">.</span><span class="ident">on_tour?</span>
+<span class="punct">=&gt;</span> <span class="constant">true</span>
+</pre></p>
+<h3>Find basic information about an artist without requesting event data, using mbid</h3>
+<p><pre class='syntax'>
+<span class="comment"># 4e954b02-fae2-4bd7-9547-e055a6ac0527 =&gt; mbid for Raekwon</span>
+<span class="ident">artist</span> <span class="punct">=</span> <span class="constant">Bandsintown</span><span class="punct">::</span><span class="constant">Artist</span><span class="punct">.</span><span class="ident">get</span><span class="punct">({</span>
+  <span class="symbol">:mbid</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">4e954b02-fae2-4bd7-9547-e055a6ac0527</span><span class="punct">&quot;</span>
+<span class="punct">})</span>
+<span class="ident">artist</span><span class="punct">.</span><span class="ident">upcoming_events_count</span>
+<span class="punct">=&gt;</span> <span class="number">5</span>
+<span class="ident">artist</span><span class="punct">.</span><span class="ident">on_tour?</span>
+<span class="punct">=&gt;</span> <span class="constant">true</span>
+</pre></p>
 <h3>Find events this week around Boston, MA</h3>
 <p><pre class='syntax'>
 <span class="ident">events</span> <span class="punct">=</span> <span class="constant">Bandsintown</span><span class="punct">::</span><span class="constant">Event</span><span class="punct">.</span><span class="ident">search</span><span class="punct">({</span>
@@ -106,6 +127,13 @@
 <p><pre class='syntax'>
 <span class="ident">events</span> <span class="punct">=</span> <span class="constant">Bandsintown</span><span class="punct">::</span><span class="constant">Event</span><span class="punct">.</span><span class="ident">daily</span>
 </pre></p>
+<h3>Find events going on sale in the next week within 10 miles of Boston, MA</h3>
+<p><pre class='syntax'>
+<span class="ident">events</span> <span class="punct">=</span> <span class="constant">Bandsintown</span><span class="punct">::</span><span class="constant">Event</span><span class="punct">.</span><span class="ident">on_sale_soon</span><span class="punct">({</span>
+  <span class="symbol">:location</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">Boston, MA</span><span class="punct">&quot;,</span>
+  <span class="symbol">:radius</span> <span class="punct">=&gt;</span> <span class="number">10</span>
+<span class="punct">})</span>
+</pre></p>
 <h2>Source</h2>
 <pre>git clone git://github.com/bandsintown/bandsintown.git</pre>
 <h2>Links</h2>

data/website/index.txt

@@ -45,6 +45,31 @@ artist = Bandsintown::Artist.new({
 events = artist.events
 </pre>
 
+h3. Find basic information about an artist without requesting event data
+
+<pre syntax="ruby">
+artist = Bandsintown::Artist.get({
+  :name => "Raekwon"
+})
+artist.upcoming_events_count
+=> 5
+artist.on_tour?
+=> true
+</pre>
+
+h3. Find basic information about an artist without requesting event data, using mbid
+
+<pre syntax="ruby">
+# 4e954b02-fae2-4bd7-9547-e055a6ac0527 => mbid for Raekwon
+artist = Bandsintown::Artist.get({
+  :mbid => "4e954b02-fae2-4bd7-9547-e055a6ac0527"
+})
+artist.upcoming_events_count
+=> 5
+artist.on_tour?
+=> true
+</pre>
+
 h3. Find events this week around Boston, MA
 
 <pre syntax="ruby">
@@ -95,6 +120,15 @@ h3. Find events added/updated/deleted within the last day
 events = Bandsintown::Event.daily
 </pre>
 
+h3. Find events going on sale in the next week within 10 miles of Boston, MA
+
+<pre syntax="ruby">
+events = Bandsintown::Event.on_sale_soon({
+  :location => "Boston, MA",
+  :radius => 10
+})
+</pre>
+
 h2. Source
 
 <pre>git clone git://github.com/bandsintown/bandsintown.git</pre>

metadata

@@ -1,7 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: bandsintown
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 4
+  version: 0.1.4
 platform: ruby
 authors: 
 - Mike Costanza
@@ -9,49 +14,65 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-12 00:00:00 -05:00
+date: 2010-03-03 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 0
+        - 2
         version: 2.0.2
-    version: 
+  type: :runtime
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: json
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 3
         version: 1.1.3
-    version: 
+  type: :runtime
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: newgem
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.5.2
-    version: 
+        segments: 
+        - 1
+        - 4
+        - 1
+        version: 1.4.1
+  type: :development
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
+        segments: 
+        - 1
+        - 8
+        - 0
+        version: 1.8.0
+  type: :development
+  version_requirements: *id004
 description: |-
   Bandsintown.com API gem
   
@@ -69,6 +90,7 @@ extensions: []
 extra_rdoc_files: 
 - History.txt
 - Manifest.txt
+- README.rdoc
 - website/index.txt
 files: 
 - History.txt
@@ -112,18 +134,20 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: bandsintown
-rubygems_version: 1.3.5
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: Bandsintown.com API gem  A Ruby library for accessing the Bandsintown API