bandsintown 0.2.0 → 0.3.1

data/History.txt

@@ -1,3 +1,11 @@
+== 0.3.1 2010-07-05
+* Fixed bug for API methods with a blank method name in the route (events - create and artists - create), "/artists/" => "/artists"
+
+== 0.3.0 2010-07-04
+* Added Events - Cancel API method (Bandsintown::Event#cancel)
+* Added Artists - Cancel Event API method (Bandsintown::Artist#cancel_event)
+* Added Artists - Create API method (Bandsintown::Artist.create)
+
 == 0.2.0 2010-06-03
 * Added Events - Create API method (Bandsintown::Event.create)
 

data/README.rdoc

@@ -149,6 +149,35 @@ For more information visit http://www.bandsintown.com/api/requests.
     :on_sale_datetime => "2010-05-01T19:30:00"
   })
 
+=== Cancel an event on bandsintown.com 
+
+  events = Bandsintown::Event.search(:location => "San Diego, CA")
+  event = events.first
+  event.cancel
+  
+
+=== Cancel an event on bandsintown.com for a single artist
+
+  artist = Bandsintown::Artist.new(:name => "Diamond District")
+  events = artist.events
+  event_id = events.first.bandsintown_id
+  artist.cancel_event(event_id)
+
+=== Create an artist on bandsintown.com with name, music brainz id, myspace url, and website
+  
+  artist = Bandsintown::Artist.create({
+    :name => "A New Artist",
+    :mbid => "abcd1234-abcd-1234-abcd-12345678abcd",
+    :myspace_url => "http://www.myspace.com/anewartist",
+    :website => "http://www.a-new-artist.com"
+  })
+
+=== Create an artist on bandsintown.com with name only (all other parameters optional)
+
+  artist = Bandsintown::Artist.create({
+    :name => "A New Artist"
+  })
+
 == Links
 
 * RDoc[http://bandsintown.rubyforge.org/rdoc]

data/lib/bandsintown.rb

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

data/lib/bandsintown/artist.rb

@@ -57,6 +57,58 @@ module Bandsintown
       (@upcoming_events_count || @events.size) > 0
     end
     
+    #This method is used to create an artist on bandsintown.com.
+    #If successful, it will return a Bandsintown::Artist object with the same data as a Bandsintown::Artist.get response.
+    #If you attempt to create an artist that already exists, the existing artist will be returned.
+    #See http://www.bandsintown.com/api/requests#artists-create for more information.
+    #
+    #====options
+    # * :name - artist name
+    # * :mbid - music brainz id
+    # * :myspace_url - url
+    # * :website - url
+    #
+    #====notes
+    # * :name is required, all other arguments are optional.
+    # * :mbid is uuid format, for example : "abcd1234-abcd-1234-abcd-12345678abcd"
+    # * :myspace_url must be from either myspace.com or www.myspace.com 
+    #
+    #====examples
+    #Create an artist with full data:
+    #   Bandsintown::Artist.create(:name => "A New Artist", :mbid => "abcd1234-abcd-1234-abcd-12345678abcd", :myspace_url => "http://www.myspace.com/anewartist", :website => "http://www.a-new-artist.com")
+    #
+    #Create an artist with name only:
+    #   Bandsintown::Artist.create(:name => "A New Artist")
+    #
+    def self.create(options)
+      build_from_json(self.request_and_parse(:post, "", :artist => options))
+    end
+    
+    #This is used to cancel an event on Bandsintown for a single artist.  If you want to cancel the entire event (all artists), use Bandsintown::Event#cancel.
+    #If successful, this method will always return a status message.
+    #Unless you have a trusted app_id, events added or removed through the API will need to be approved before the changes are seen live.
+    #Contact Bandsintown if you are often adding events and would like a trusted account.
+    #See http://www.bandsintown.com/api/requests#artists-cancel-event for more information.
+    #
+    #====examples:
+    #Cancel an artist's event with a non-trusted app_id:
+    #   artist = Bandsintown::Artist.new(:name => "Little Brother")
+    #   event_id = 12345
+    #   artist.cancel_event(event_id)
+    #   => "Event successfully cancelled (Pending Approval)"
+    #
+    #Cancel an artist's event with a trusted app_id:
+    #   artist = Bandsintown::Artist.new(:name => "Little Brother")
+    #   event_id = 12345
+    #   artist.cancel_event(event_id)
+    #   => "Event successfully cancelled"
+    #
+    def cancel_event(event_id)
+      raise StandardError.new("event cancellation requires a bandsintown_id") if event_id.blank?
+      response = self.class.request_and_parse(:post, "#{api_name}/events/#{event_id}/cancel")
+      response["message"]
+    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.

data/lib/bandsintown/connection.rb

@@ -7,7 +7,7 @@ module Bandsintown
     end
     
     def get(resource_path, method_path, params = {})
-      request_url = "#{@base_url}/#{resource_path}/#{method_path}?#{encode(params.symbolize_keys)}"
+      request_url = File.join([@base_url, resource_path, method_path].reject(&:blank?)) + "?" + encode(params.symbolize_keys)
       begin
         RestClient.get(request_url)
       rescue RestClient::ResourceNotFound => error_response
@@ -16,7 +16,7 @@ module Bandsintown
     end
     
     def post(resource_path, method_path, body = {})
-      request_url = "#{@base_url}/#{resource_path}/#{method_path}?#{encode({})}"
+      request_url = File.join([@base_url, resource_path, method_path].reject(&:blank?)) + "?" + encode({})
       begin
         RestClient.post(request_url, body.to_json, :content_type => :json, :accept => :json)
       rescue RestClient::ResourceNotFound => error_response

data/lib/bandsintown/event.rb

@@ -157,7 +157,7 @@ module Bandsintown
     end
     
     #This is used to create an event on bandsintown.com.
-    #Unless you have a trusted app_id, events added through the API will need to be approved before they are seen live. 
+    #Unless you have a trusted app_id, events added or removed through the API will need to be approved before the changes are seen live. 
     #Contact Bandsintown if you are often adding events and would like a trusted account.
     #See http://www.bandsintown.com/api/requests#events-create for more information.
     #===options:
@@ -211,7 +211,7 @@ module Bandsintown
         :ticket_price     => options[:ticket_price]
       }.reject { |k,v| v.blank? }
       
-      response = self.request_and_parse(:post, "create", :event => event_data)
+      response = self.request_and_parse(:post, "", :event => event_data)
       
       if response.key?("message")
         response["message"]
@@ -220,6 +220,31 @@ module Bandsintown
       end
     end
     
+    #This is used to cancel an event on Bandsintown.  If you want to remove a single artist from an event, use Bandsintown::Artist#cancel_event instead.
+    #If successful, this method will always return a status message.
+    #Unless you have a trusted app_id, events added or removed through the API will need to be approved before the changes are seen live.
+    #Contact Bandsintown if you are often adding events and would like a trusted account.
+    #See http://www.bandsintown.com/api/requests#events-cancel for more information.
+    #
+    #====examples:
+    #Cancel an event with a non-trusted app_id:
+    #   events = Bandsintown::Event.search(:location => "San Diego, CA")
+    #   event = events.first
+    #   event.cancel
+    #   => "Event successfully cancelled (Pending Approval)"
+    #
+    #Cancel an event with a trusted app_id:
+    #   events = Bandsintown::Event.search(:location => "San Diego, CA")
+    #   event = events.first
+    #   event.cancel
+    #   => "Event successfully cancelled"
+    #
+    def cancel
+      raise StandardError.new("event cancellation requires a bandsintown_id") if @bandsintown_id.blank?
+      response = self.class.request_and_parse(:post, "#{@bandsintown_id}/cancel")
+      response["message"]
+    end
+    
     def self.resource_path
       "events"
     end

data/spec/bandsintown/artist_spec.rb

@@ -220,4 +220,43 @@ describe Bandsintown::Artist do
       end
     end
   end
+
+  describe "#cancel_event(event_id)" do
+    before(:each) do
+      @event_id = 12345
+      @artist = Bandsintown::Artist.new(:name => "Little Brother")
+      @response = { "message" => "Event successfully cancelled (pending approval)" }
+      Bandsintown::Artist.stub!(:request_and_parse).and_return(@response)
+    end
+    it "should request and parse a call to the BIT artists - cancel event API method using the artist's api_name and the given event_id" do
+      Bandsintown::Artist.should_receive(:request_and_parse).with(:post, "#{@artist.api_name}/events/#{@event_id}/cancel").and_return(@response)
+      @artist.cancel_event(@event_id)
+    end
+    it "should return the response message if an event was successfully cancelled" do
+      @artist.cancel_event(@event_id).should == @response["message"]
+    end
+  end
+
+  describe ".create(options = {})" do
+    before(:each) do
+      @options = { 
+        :name => "A New Artist", 
+        :myspace_url => "http://www.myspace.com/a_new_artist", 
+        :mbid => "abcd1234-abcd-1234-5678-abcd12345678",
+        :website => "http://www.a-new-artist.com"
+      }
+      Bandsintown::Artist.stub!(:request_and_parse).and_return('json')
+      Bandsintown::Artist.stub!(:build_from_json).and_return('built artist')
+    end
+    it "should request and parse a call to the BIT artists - create API method using the supplied artist data" do
+      expected_params = { :artist => @options }
+      Bandsintown::Artist.should_receive(:request_and_parse).with(:post, "", expected_params).and_return('json')
+      Bandsintown::Artist.create(@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.create(@options).should == 'built artist'
+    end
+  end
+  
 end

data/spec/bandsintown/base_spec.rb

@@ -6,9 +6,12 @@ describe Bandsintown::Base do
     it "should be an instance of Bandsintown::Connection" do
       Bandsintown::Base.connection.class.should == Bandsintown::Connection
     end
-    it "should be cached" do
+    it "should be memoized" do
       Bandsintown::Base.connection.should === Bandsintown::Base.connection
     end
+    it "should use http://api.bandsintown.com as the base url" do
+      Bandsintown::Base.connection.base_url.should == "http://api.bandsintown.com"
+    end
   end
   
   describe ".request(http_method, api_method, params={})" do

data/spec/bandsintown/connection_spec.rb

@@ -36,37 +36,43 @@ describe Bandsintown::Connection do
       lambda { @connection.get("", "", {}) }.should_not raise_error
       @connection.get("", "", {}).should == "error message"
     end
+    
+    it "should return the correct URL format when method_path is blank (no slashes)" do
+      expected_url = "http://api.bandsintown.com/events?app_id=YOUR_APP_ID&format=json"
+      RestClient.should_receive(:get).with(expected_url).and_return("response")
+      @connection.get("events", "", {})
+    end
   end
   
   describe ".post(resource_path, method_path, body = {})" do
-   before(:each) do
-     @connection = Bandsintown::Connection.new(@base_url)
-     RestClient.stub!(:post).and_return("response")
-     @api_resource = "events"
-     @api_method = "create"
-     @body_params = { 
-       :event => { 
-         :artists => [{ :name => "Little Brother" }],
-         :datetime => "2010-06-01T19:30:00",
-         :venue => { :id => 123 }
-       }
-     }
-   end
-   it "should make a post request to the url constructed with resource path, method path, default encoded params, body converted to json, and application/json request headers" do
-     expected_url = "http://api.bandsintown.com/events/create?app_id=YOUR_APP_ID&format=json"
-     expected_body = @body_params.to_json
-     expected_headers = { :content_type => :json, :accept => :json }
-     @connection.should_receive(:encode).with({}).and_return("app_id=YOUR_APP_ID&format=json")
-     RestClient.should_receive(:post).with(expected_url, expected_body, expected_headers).and_return("response")
-     @connection.post(@api_resource, @api_method, @body_params).should == "response"
-   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 = RestClient::ResourceNotFound.new; error.response = "error message"
-     RestClient.stub!(:post).and_raise(error)
-     lambda { @connection.post(@api_resource, @api_method, @body_params) }.should_not raise_error
-     @connection.post(@api_resource, @api_method, @body_params).should == "error message"
-   end
+    before(:each) do
+    @connection = Bandsintown::Connection.new(@base_url)
+    RestClient.stub!(:post).and_return("response")
+    @api_resource = "events"
+    @api_method = ""
+    @body_params = { 
+      :event => { 
+        :artists => [{ :name => "Little Brother" }],
+        :datetime => "2010-06-01T19:30:00",
+        :venue => { :id => 123 }
+      }
+    }
+    end
+    it "should make a post request to the url constructed with resource path, method path, default encoded params, body converted to json, and application/json request headers" do
+      expected_url = "http://api.bandsintown.com/events?app_id=YOUR_APP_ID&format=json"
+      expected_body = @body_params.to_json
+      expected_headers = { :content_type => :json, :accept => :json }
+      @connection.should_receive(:encode).with({}).and_return("app_id=YOUR_APP_ID&format=json")
+      RestClient.should_receive(:post).with(expected_url, expected_body, expected_headers).and_return("response")
+      @connection.post(@api_resource, @api_method, @body_params).should == "response"
+    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 = RestClient::ResourceNotFound.new; error.response = "error message"
+      RestClient.stub!(:post).and_raise(error)
+      lambda { @connection.post(@api_resource, @api_method, @body_params) }.should_not raise_error
+      @connection.post(@api_resource, @api_method, @body_params).should == "error message"
+    end
   end
   
   describe ".encode(params={})" do

data/spec/bandsintown/event_spec.rb

@@ -190,7 +190,7 @@ describe Bandsintown::Event do
       Bandsintown::Event.stub!(:request_and_parse).and_return(@response)
     end
     it "should request and parse a call to the BIT events - create API mehod" do
-      Bandsintown::Event.should_receive(:request_and_parse).with(:post, "create", anything).and_return(@response)
+      Bandsintown::Event.should_receive(:request_and_parse).with(:post, "", anything).and_return(@response)
       Bandsintown::Event.create(@options)
     end
     it "should return the response message if an event was successfully submitted using a non-trusted app_id" do
@@ -214,28 +214,28 @@ describe Bandsintown::Event do
         @options = { :artists => ["Evidence", "Alchemist"] }
         Bandsintown::Event.should_receive(:parse_artists).with(@options[:artists]).and_return('parsed')
         expected_event_params = { :artists => 'parsed' }
-        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "create", :event => hash_including(expected_event_params))
+        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "", :event => hash_including(expected_event_params))
       end
       
       it "should parse the datetime using parse_datetime" do
         @options = { :datetime => "2010-06-01T20:30:00" }
         Bandsintown::Event.should_receive(:parse_datetime).with(@options[:datetime]).and_return('parsed')
         expected_event_params = { :datetime => "parsed" }
-        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "create", :event => hash_including(expected_event_params))
+        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "", :event => hash_including(expected_event_params))
       end
       
       it "should parse the on_sale_datetime using parse_datetime" do
         @options = { :on_sale_datetime => "2010-06-01T20:30:00" }
         Bandsintown::Event.should_receive(:parse_datetime).with(@options[:on_sale_datetime]).and_return('parsed')
         expected_event_params = { :on_sale_datetime => "parsed" }
-        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "create", :event => hash_including(expected_event_params))
+        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "", :event => hash_including(expected_event_params))
       end
       
       it "should parse the venue using parse_venue" do
         @options = { :venue => "data" }
         Bandsintown::Event.should_receive(:parse_venue).with("data").and_return("venue")
         expected_event_params = { :venue => "venue" }
-        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "create", :event => hash_including(expected_event_params))
+        Bandsintown::Event.should_receive(:request_and_parse).with(:post, "", :event => hash_including(expected_event_params))
       end
       
       after(:each) do
@@ -243,4 +243,24 @@ describe Bandsintown::Event do
       end
     end
   end
+
+  describe "#cancel" do
+    before(:each) do
+      @event = Bandsintown::Event.new
+      @event.bandsintown_id = 12345
+      @response = { "message" => "Event successfully cancelled (pending approval)" }
+      Bandsintown::Event.stub!(:request_and_parse).and_return(@response)
+    end
+    it "should raise an error if the event does not have a bandsintown_id" do
+      @event.bandsintown_id = nil
+      lambda { @event.cancel }.should raise_error(StandardError, "event cancellation requires a bandsintown_id")
+    end
+    it "should request and parse a call to the BIT events - cancel API method using the event's bandsintown_id" do
+      Bandsintown::Event.should_receive(:request_and_parse).with(:post, "#{@event.bandsintown_id}/cancel").and_return(@response)
+      @event.cancel
+    end
+    it "should return the response message if an event was successfully cancelled" do
+      @event.cancel.should == @response["message"]
+    end
+  end
 end

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.2.0</a>
+        <a href="http://rubyforge.org/projects/bandsintown" class="numbers">0.3.1</a>
       </div>
     </div>
     <h2>Description</h2>
@@ -176,6 +176,34 @@
   <span class="symbol">:on_sale_datetime</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">2010-05-01T19:30:00</span><span class="punct">&quot;</span>
 <span class="punct">})</span>
 </pre></p>
+<h3>Cancel an event on bandsintown.com</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><span class="symbol">:location</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">San Diego, CA</span><span class="punct">&quot;)</span>
+<span class="ident">event</span> <span class="punct">=</span> <span class="ident">events</span><span class="punct">.</span><span class="ident">first</span>
+<span class="ident">event</span><span class="punct">.</span><span class="ident">cancel</span>
+</pre></p>
+<h3>Cancel an event on bandsintown.com for a single artist</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">new</span><span class="punct">(</span><span class="symbol">:name</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">Diamond District</span><span class="punct">&quot;)</span>
+<span class="ident">events</span> <span class="punct">=</span> <span class="ident">artist</span><span class="punct">.</span><span class="ident">events</span>
+<span class="ident">event_id</span> <span class="punct">=</span> <span class="ident">events</span><span class="punct">.</span><span class="ident">first</span><span class="punct">.</span><span class="ident">bandsintown_id</span>
+<span class="ident">artist</span><span class="punct">.</span><span class="ident">cancel_event</span><span class="punct">(</span><span class="ident">event_id</span><span class="punct">)</span>
+</pre></p>
+<h3>Create an artist on bandsintown.com with name, music brainz id, myspace url, and website</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">create</span><span class="punct">({</span>
+  <span class="symbol">:name</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">A New Artist</span><span class="punct">&quot;,</span>
+  <span class="symbol">:mbid</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">abcd1234-abcd-1234-abcd-12345678abcd</span><span class="punct">&quot;,</span>
+  <span class="symbol">:myspace_url</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">http://www.myspace.com/anewartist</span><span class="punct">&quot;,</span>
+  <span class="symbol">:website</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">http://www.a-new-artist.com</span><span class="punct">&quot;</span>
+<span class="punct">})</span>
+</pre></p>
+<h3>Create an artist on bandsintown.com with name only (all other parameters optional)</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">create</span><span class="punct">({</span>
+  <span class="symbol">:name</span> <span class="punct">=&gt;</span> <span class="punct">&quot;</span><span class="string">A New Artist</span><span class="punct">&quot;</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

@@ -179,6 +179,42 @@ Bandsintown::Event.create({
 })
 </pre>
 
+h3. Cancel an event on bandsintown.com 
+
+<pre syntax="ruby">
+events = Bandsintown::Event.search(:location => "San Diego, CA")
+event = events.first
+event.cancel
+</pre>
+
+h3. Cancel an event on bandsintown.com for a single artist
+
+<pre syntax="ruby">
+artist = Bandsintown::Artist.new(:name => "Diamond District")
+events = artist.events
+event_id = events.first.bandsintown_id
+artist.cancel_event(event_id)
+</pre>
+
+h3. Create an artist on bandsintown.com with name, music brainz id, myspace url, and website
+
+<pre syntax="ruby">
+artist = Bandsintown::Artist.create({
+  :name => "A New Artist",
+  :mbid => "abcd1234-abcd-1234-abcd-12345678abcd",
+  :myspace_url => "http://www.myspace.com/anewartist",
+  :website => "http://www.a-new-artist.com"
+})
+</pre>
+
+h3. Create an artist on bandsintown.com with name only (all other parameters optional)
+
+<pre syntax="ruby">
+artist = Bandsintown::Artist.create({
+  :name => "A New Artist"
+})
+</pre>
+
 h2. Source
 
 <pre>git clone git://github.com/bandsintown/bandsintown.git</pre>

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 2
-  - 0
-  version: 0.2.0
+  - 3
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Mike Costanza
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-03 00:00:00 -07:00
+date: 2010-07-05 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -142,7 +142,7 @@ licenses: []
 post_install_message: 
 rdoc_options: 
 - --main
-- README.txt
+- README.rdoc
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement