madcowley-jambase4r 1.1.3

data/lib/models/event.rb

@@ -0,0 +1,33 @@
+module JamBase4R
+  
+  class Event
+    include Model
+    
+    attr_reader :id, :artists, :venue, :ticket_url, :event_url, :date
+    
+    def initialize(element)
+      return if element.blank?
+      build(element)
+    end
+    
+    private
+    
+    def build(element)
+      @artists = []
+      @id = get_value(element, EVENT_ID)
+      @ticket_url = get_value(element, TICKET_URL)
+      @event_url = get_value(element, EVENT_URL)
+      @date = get_value(element, EVENT_DATE)
+      v = element.get_elements(VENUE)
+      unless v.blank?
+        @venue = Venue.new(v.first)
+      end
+      artists = element.get_elements(ARTISTS)
+      unless artists.blank?
+        artists.each {|a| @artists << Artist.new(a) }
+      end
+    end
+    
+  end
+  
+end

data/lib/models/model.rb

@@ -0,0 +1,31 @@
+module JamBase4R
+  module Model
+    
+    EVENT_ID = "event_id"
+    TICKET_URL = "ticket_url"
+    EVENT_URL = "event_url"
+    VENUE = "venue"
+    EVENT_DATE = "event_date"
+    ARTISTS = "artists/artist"
+    VENUE_ID = "venue_id"
+    VENUE_NAME = "venue_name"
+    VENUE_CITY = "venue_city"
+    VENUE_STATE = "venue_state"
+    VENUE_ZIP = "venue_zip"
+    ARTIST_ID = "artist_id"
+    ARTIST_NAME = "artist_name"
+    
+    def get_value(element, node_name)
+      return if element.blank? || node_name.blank?
+      collection = element.get_elements(node_name)
+      return (collection.blank? ? nil : get_element_value(collection.first))
+    end
+    
+    private
+    
+    def get_element_value(element)
+      element.nil? ? nil : (element.get_text.nil? ? nil : element.get_text.value)
+    end
+    
+  end
+end

data/lib/models/venue.rb

@@ -0,0 +1,25 @@
+module JamBase4R
+  
+  class Venue
+    include Model
+    
+    attr_reader :id, :name, :city, :state, :zip
+    
+    def initialize(element)
+      return if element.blank?
+      build(element)
+    end
+    
+    private
+    
+    def build(element)      
+      @id = get_value(element, VENUE_ID)
+      @name = get_value(element, VENUE_NAME)
+      @city = get_value(element, VENUE_CITY)
+      @state = get_value(element, VENUE_STATE)
+      @zip = get_value(element, VENUE_ZIP)
+    end
+    
+  end
+  
+end

data/lib/utility.rb

@@ -0,0 +1,13 @@
+module JamBase4R
+  module Utility
+    
+    def log_info(msg)
+      JamBase4R.logger.info(msg) if JamBase4R.logger && JamBase4R.logger.respond_to?(:info)
+    end
+    
+    def log_error(msg)
+      JamBase4R.logger.error(msg) if JamBase4R.logger && JamBase4R.logger.respond_to?(:error)
+    end
+    
+  end
+end

data/spec/lib/api_spec.rb

@@ -0,0 +1,167 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe JamBase4R::API do
+  
+  it "should respond_to? search" do
+    JamBase4R::API.should respond_to(:search)
+  end
+  
+  it "should respond_to? search_by_artist" do
+    JamBase4R::API.should respond_to(:search_by_artist)
+  end
+  
+  it "should respond_to? search by zip_code" do
+    JamBase4R::API.should respond_to(:search_by_zipcode)
+  end
+  
+  it "should respond_to? search by user" do
+    JamBase4R::API.should respond_to(:search_by_user)
+  end
+  
+  it "should respond_to? log_error" do
+    JamBase4R::API.should respond_to(:log_error)
+  end
+  
+  it "should respond_to? log_info" do
+    JamBase4R::API.should respond_to(:log_info)
+  end
+  
+  describe "search" do
+    
+    before(:each) do
+      @r = stub("Response", :status => "200", :message => "OK", :body => xml_response)
+      JamBase4R::API.stub!(:jambase_search).and_return(@r)
+    end
+    
+    it "should call jambase_search" do
+      JamBase4R::API.should_receive(:jambase_search).with(:band => "monkey").and_return(@r)
+      JamBase4R::API.search(:band => "monkey")
+    end
+    
+    it "should convert the response to an array" do
+      JamBase4R::API.should_receive(:convert).with(xml_response)
+      JamBase4R::API.search(:band => "monkey")
+    end
+    
+  end
+  
+  describe "custom methods" do
+    
+    before(:each) do
+      @r = stub("Response", :status => "200", :message => "OK", :body => xml_response)
+      JamBase4R::API.stub!(:search).and_return(@r)
+    end
+   
+    describe "search_by_zipcode" do
+      
+      it "should replace the value if :zip in additional filters" do
+        options = {:zip => "90210"}
+        JamBase4R::API.search_by_zipcode("99999", options)
+        options[:zip].should == "99999"
+      end
+      
+      it "should call search" do
+        JamBase4R::API.should_receive(:search).with({:zip => "99999"}).and_return(@r)
+        JamBase4R::API.search_by_zipcode("99999")
+      end
+      
+    end
+    
+    describe "search_by_user" do
+      
+      it "should replace the value if :user in additional filters" do
+        options = {:user => "A User"}
+        JamBase4R::API.search_by_user("A 2nd User", options)
+        options[:user].should == "A 2nd User"
+      end
+      
+      it "should call search" do
+        JamBase4R::API.should_receive(:search).with({:user => "Mr X"}).and_return(@r)
+        JamBase4R::API.search_by_user("Mr X")
+      end
+      
+    end
+  
+    describe "search_by_artist" do
+      
+      it "should replace the value of :artists in additional filters" do
+        options = {:artist => "TEST"}
+        JamBase4R::API.search_by_artist("A Band", options)
+        options[:artist].should == "A Band"
+      end
+    
+      it "should call search" do
+        JamBase4R::API.should_receive(:search).with({:artist => "A Band"}).and_return(@r)
+        JamBase4R::API.search_by_artist("A Band")
+      end
+    
+    end
+    
+    describe "convert" do
+      
+      it "should return an empty array if the xml passed to convert is nil" do
+         JamBase4R::API.send(:convert, nil).should be_is_a(Array)
+      end
+
+      it "should return an empty array if the xml passed to convert is empty" do
+         JamBase4R::API.send(:convert, "").should be_is_a(Array)
+      end
+
+      it "should convert xml passed to convert into an Array" do
+         JamBase4R::API.send(:convert, xml_response).should be_is_a(Array)
+      end
+      
+    end
+    
+    describe "Search" do
+      
+      def default_search_args
+        {:artist => "Some Band", :zip => "90210", :radius => 50, :user => "Mr X"}
+      end
+
+      before(:each) do
+        JamBase4R.configure do |c|
+          c.api_key = "dfsffd"
+        end
+        @resp = mock("Response")
+        @resp.stub!(:code).and_return("200")
+        @resp.stub!(:message).and_return("OK")
+        @resp.stub!(:body).and_return(xml_response)
+        @gateway = mock('Gateway')
+        @gateway.stub!(:get).and_return(@resp)
+        JamBase4R::API.stub!(:jambase_gateway).and_return(@gateway)
+      end
+
+      it "should return nil from jambase_search if search args are nil" do
+        JamBase4R::API.send(:jambase_search, nil).should be_nil
+      end
+
+      it "should return nil from jambase_search if search args are empty" do
+        JamBase4R::API.send(:jambase_search, {}).should be_nil
+      end
+
+      it "should return nil if after cleaning the search args they are empty" do
+        search_args = default_search_args.merge(
+          :zip => nil, :radius => "", :artist => "", :user => "")
+        JamBase4R::API.send(:jambase_search, search_args).should be_nil
+      end
+
+      it "should raise an exception if both the aliased param and the real param are set" do
+        search_args = default_search_args.merge(:band => "The Monkeys")
+        lambda {
+          JamBase4R::API.send(:jambase_search, search_args)
+        }.should raise_error
+      end
+
+      it "should call get on the gateway object with a properly constructed url" do
+        url = "http://api.jambase.com/search?band=Some+Band&apikey=dfsffd"
+        @gateway.should_receive(:get).with(url).and_return(@resp)
+        JamBase4R::API.send(:jambase_search, default_search_args.merge(
+            :zip => nil, :radius => nil, :user => nil))
+      end
+      
+    end
+    
+  end
+  
+end

data/spec/lib/http_gateway_spec.rb

@@ -0,0 +1,38 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe JamBase4R::HttpGateway do
+  
+  GET_URL = "http://api.jambase.com/search?apikey=dsdfgdfg&band=Zero"
+  
+  before(:each) do
+    @gate = JamBase4R::HttpGateway.new
+    @resp = mock("Response")
+    @resp.stub!(:code).and_return("200")
+    @resp.stub!(:message).and_return("OK")
+    @resp.stub!(:body).and_return("gdfgdfgdfgdfgfgdgdf")
+  end
+  
+  it "should respond_to? log_error" do
+    @gate.should respond_to(:log_error)
+  end
+  
+  it "should respond_to? log_info" do
+    @gate.should respond_to(:log_info)
+  end
+  
+  it "should use the Net::HTTP::Get class to get" do
+    get = Net::HTTP::Get.new(URI.parse(GET_URL).path_with_querystring)
+    Net::HTTP.stub!(:start).and_return(@resp)
+    Net::HTTP::Get.should_receive(:new).with(URI.parse(GET_URL).path_with_querystring).and_return(get)
+    @gate.get(GET_URL)
+  end
+  
+  it "should pass the URI path and query string for GET requests" do
+    Net::HTTP.stub!(:start).and_return(@resp)
+    url = URI.parse(GET_URL)
+    URI.stub!(:parse).and_return(url)
+    url.should_receive(:path_with_querystring).and_return("/search?apikey=dsdfgdfg&band=Zero")
+    @gate.get(GET_URL)
+  end
+  
+end

data/spec/lib/jambase4r_spec.rb

@@ -0,0 +1,51 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe JamBase4R do
+  
+  it "should respond_to? :configure" do
+    JamBase4R.should respond_to(:configure)
+  end
+  
+  it "should respond_to? :log_error" do
+    JamBase4R.should respond_to(:log_error)
+  end
+  
+  it "should respond_to? :log_info" do
+    JamBase4R.should respond_to(:log_info)
+  end
+  
+  it "should raise an exception if the api key is not set" do
+    lambda{
+      JamBase4R.configure do |s|
+        s.api_key = nil
+      end
+    }.should raise_error
+  end
+  
+  it "should log an error if the api key is not set" do
+    log = mock("Logger")
+    log.should_receive(:error)
+    begin
+      JamBase4R.configure do |c|
+        c.api_key = nil
+        c.logger = log
+      end
+    rescue
+    end
+  end
+  
+  it "should not raise an exception when configured with an API key" do
+    lambda {
+      JamBase4R.configure do |c|
+        c.api_key = "dffsdfsfdf"
+      end
+    }.should_not raise_error
+  end
+  
+  it "should raise an exception if configure is not passed a block" do
+    lambda {
+      JamBase4R.configure
+    }.should raise_error
+  end
+  
+end

data/spec/lib/models/artist_spec.rb

@@ -0,0 +1,36 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe JamBase4R::Artist do
+  
+  def create_mock_element(expect=true)
+    e = mock("Element")
+    e.stub!(:blank?).and_return(!expect)
+    
+    id_value = mock("ID Value")
+    expect ? id_value.should_receive(:value).and_return(10) : id_value.should_not_receive(:value)
+    id = mock("Artist ID")
+    expect ? id.should_receive(:get_text).at_least(1).times.and_return(id_value) : id.should_not_receive(:get_text)
+    
+    expect ? e.should_receive(:get_elements).with("artist_id").and_return([id]) : 
+      e.should_not_receive(:get_elements).with("artist_id")
+    
+    name_value = mock("Name Value")
+    expect ? name_value.should_receive(:value).and_return("Joe Artist") : name_value.should_not_receive(:value)
+    name = mock("Artist Name")
+    expect ? name.should_receive(:get_text).at_least(1).times.and_return(name_value) : name.should_not_receive(:get_text)
+    
+    expect ? e.should_receive(:get_elements).with("artist_name").and_return([name]) : 
+      e.should_not_receive(:get_elements).with("artist_name")
+    
+    return e
+  end
+  
+  it "should build itself from the passed in element" do
+    JamBase4R::Artist.new(create_mock_element)
+  end
+  
+  it "should return an empty object if the element passed in responds true to blank?" do
+    JamBase4R::Artist.new(create_mock_element(false))
+  end
+  
+end

data/spec/lib/models/event_spec.rb

@@ -0,0 +1,102 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe JamBase4R::Event do
+
+  def create_mock_element(expect=true, create_venue=true, create_artists=true)
+    e = mock("Element")
+    e.stub!(:blank?).and_return(!expect)
+    
+    #id
+    id_value = mock("ID Value")
+    expect ? id_value.should_receive(:value).and_return(10) : id_value.should_not_receive(:value)
+    id = mock("Event ID")
+    expect ? id.should_receive(:get_text).at_least(1).times.and_return(id_value) : id.should_not_receive(:get_text)
+    
+    expect ? e.should_receive(:get_elements).with("event_id").and_return([id]) : 
+      e.should_not_receive(:get_elements).with("event_id")
+    
+    #ticket url
+    ticket_url_value = mock("Ticket Url Value")
+    expect ? ticket_url_value.should_receive(:value).and_return("http://test.ca") : 
+      ticket_url_value.should_not_receive(:value)
+    ticket_url = mock("Ticket Url")
+    expect ? ticket_url.should_receive(:get_text).at_least(1).times.and_return(ticket_url_value) : 
+      ticket_url.should_not_receive(:get_text)
+    
+    expect ? e.should_receive(:get_elements).with("ticket_url").and_return([ticket_url]) : 
+      e.should_not_receive(:get_elements).with("ticket_url")
+    
+    #event url
+    event_url_value = mock("Event Url Value")
+    expect ? event_url_value.should_receive(:value).and_return("http://test.ca") : 
+      event_url_value.should_not_receive(:value)
+    event_url = mock("Event Url")
+    expect ? event_url.should_receive(:get_text).at_least(1).times.and_return(event_url_value) : 
+      event_url.should_not_receive(:get_text)
+
+    expect ? e.should_receive(:get_elements).with("event_url").and_return([event_url]) : 
+      e.should_not_receive(:get_elements).with("event_url")
+    
+    #date
+    date_value = mock("Event Date Value")
+    expect ? date_value.should_receive(:value).and_return("10/21/2009") : 
+      date_value.should_not_receive(:value)
+    date = mock("Event Date")
+    expect ? date.should_receive(:get_text).at_least(1).times.and_return(date_value) : 
+      date.should_not_receive(:get_text)
+
+    expect ? e.should_receive(:get_elements).with("event_date").and_return([date]) : 
+      e.should_not_receive(:get_elements).with("event_date")
+    
+    #venue
+    venues = nil
+    if create_venue
+      venue = mock("Venue")
+      venue.stub!(:get_elements).and_return([])
+      venues = [venue]
+    end
+    expect ? e.should_receive(:get_elements).with("venue").and_return(venues) :
+      e.should_not_receive(:get_elements).with("venue")
+    
+    #artists
+    artists = nil
+    if create_artists
+      artist = mock("Artist")
+      artist.stub!(:get_elements).and_return([])
+      artists = [artist]
+    end
+    expect ? e.should_receive(:get_elements).with("artists/artist").and_return(artists) : 
+      e.should_not_receive(:get_elements).with("artists/artist")
+    
+    return e
+  end
+  
+  it "should build itself from the passed in element" do
+    JamBase4R::Event.new(create_mock_element(true, true, false))
+  end
+  
+  it "should not build itself if the element passed in responds true to blank?" do
+    JamBase4R::Event.new(create_mock_element(false))
+  end
+  
+  it "should create a venue if there is venue XML" do
+    JamBase4R::Venue.should_receive(:new)
+    JamBase4R::Event.new(create_mock_element)
+  end
+  
+  it "should not create a venue if there is no venue XML" do
+    JamBase4R::Venue.should_not_receive(:new)
+    JamBase4R::Event.new(create_mock_element(true, false, false))
+  end
+  
+  it "should create artists if there is artist XML" do
+    JamBase4R::Artist.should_receive(:new).exactly(1).times
+    JamBase4R::Event.new(create_mock_element(true, true, true))
+  end
+  
+  it "should not create artists if there is no artist XML" do
+    JamBase4R::Artist.should_not_receive(:new)
+    JamBase4R::Event.new(create_mock_element(true, true, false))
+  end
+  
+end