insound_api 0.0.2

data/lib/insound_api/results.rb

@@ -0,0 +1,68 @@
+module InsoundApi
+  class Results
+
+    attr_reader :warnings, :doc
+
+    # takes a nokogiri document
+    def initialize(document)
+      @doc = document
+    end
+
+    def search_url
+      @search_url ||= parse_str('search_url')
+    end
+
+    def products
+      @products ||= parse_objects('product_matches product', Product)
+    end
+
+    def products_total
+      @products_total ||= parse_int('total_product_results')
+    end
+
+    def artists
+      @artists ||= parse_objects('artist_matches artist', Artist)
+    end
+
+    def artists_total
+      @artists_total ||= parse_int('total_artist_results')
+    end
+
+    def total_results
+      @total_results ||= parse_int('total_results')
+    end
+
+
+
+    def parse_objects(selector, klass)
+      nodes = doc.css(selector)
+      nodes.map{|n| klass.new(n) }
+    end
+
+
+    def parse_int(selector)
+      Results.parse_int(selector, doc)
+    end
+
+    def self.parse_int(selector, doc)
+      nodes = doc.css(selector)
+      if nodes.any?
+        nodes.first.inner_html.strip.to_i
+      else
+        0
+      end
+    end
+
+    def parse_str(selector)
+      Results.parse_str(selector, doc)
+    end
+
+    def self.parse_str(selector, doc)
+      nodes = doc.css(selector)
+      if nodes.any?
+        nodes.first.inner_html.strip
+      end
+    end
+
+  end
+end

data/test/config_test.rb

@@ -0,0 +1,11 @@
+require 'helper'
+
+class ConfigTest < Test::Unit::TestCase
+
+  should 'raise exception if not configured' do
+    assert_raise InsoundApi::ConfigException do
+      InsoundApi::Request.get(:artist => 'sdf')
+    end
+  end
+
+end

data/test/helper.rb

@@ -0,0 +1,69 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'test/unit'
+require 'shoulda'
+
+
+unless ENV['NO_MOCKING']
+  require 'webmock/test_unit'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'insound_api'
+
+class Test::Unit::TestCase
+
+  def mocking?
+    !ENV['NO_MOCKING']
+  end
+
+  def setup_credentials
+    if mocking?
+      setup_test_credentials
+    else
+      setup_credentials_from_config
+      # give their webserver a little break
+      sleep(1) unless mocking?
+    end
+  end
+
+  def setup_test_credentials
+    InsoundApi.setup do |config|
+      config.affiliate_id = 42
+      config.api_password = 'fart'
+    end
+  end
+
+
+  def setup_credentials_from_config
+    h = YAML.load_file('config.yml')
+    InsoundApi.setup do |config|
+      config.affiliate_id = h['affiliate_id']
+      config.api_password = h['api_password']
+    end
+  end
+
+  def mock(name, query_string)
+    return unless mocking?
+
+    dir = File.dirname(__FILE__) + "/webmock/#{name}.xml"
+    file = File.open(dir)
+    body = file.read
+    url = "https://www.insound.com/ws/affiliate/#{query_string}&id=42&password=fart"
+    stub_request(:get, url).to_return(:status => 200, :body => body)
+  end
+
+  def teardown
+    InsoundApi.instance_variable_set(:@config, nil)
+    WebMock.reset! if mocking?
+  end
+
+end

data/test/query_test.rb

@@ -0,0 +1,140 @@
+$:.unshift '.';require File.dirname(__FILE__) + '/helper'
+
+module InsoundApi
+  class QueryTest < Test::Unit::TestCase
+
+    context 'with credentials' do
+      setup do
+        setup_credentials
+      end
+
+
+
+      context 'search by artist returning no results' do
+        setup do
+          mock(:no_results_found, "?artist=xxcxccxcx")
+          @results = Query.search(:artist => 'xxcxccxcx')
+        end
+
+        should 'return empty stuff' do
+          assert_equal [], @results.products
+          assert_equal [], @results.artists
+
+          assert_equal 0, @results.products_total
+          assert_equal 0, @results.artists_total
+          assert_equal 0, @results.total_results
+          assert @results.search_url
+        end
+      end
+
+      context 'using module search' do
+        setup do
+          mock(:no_results_found, "?artist=xxcxccxcx")
+          @results = InsoundApi.search(:artist => 'xxcxccxcx')
+        end
+
+         should 'return empty stuff' do
+          assert_equal [], @results.products
+          assert_equal [], @results.artists
+
+          assert_equal 0, @results.products_total
+          assert_equal 0, @results.artists_total
+          assert_equal 0, @results.total_results
+          assert @results.search_url
+        end
+      end
+
+      context 'search artist vinyl format' do
+        setup do
+          mock(:jimmy_eat_world_vinyl, "?artist=Jimmy%20Eat%20World&format=vinyl")
+          @results = Query.search(:artist => 'Jimmy Eat World', :format => 'vinyl')
+        end
+
+        should 'return actual stuff' do
+          assert_equal 3, @results.products.length
+          assert_equal 1, @results.artists.length
+
+          assert_equal 3, @results.products_total
+          assert_equal 1, @results.artists_total
+          assert_equal 4, @results.total_results
+          assert_nil @results.search_url
+
+          product = @results.products.first
+          assert product.url
+          assert_equal 'Jimmy Eat World', product.artist_name
+          assert_equal 'Invented', product.title
+          assert_equal 'Vinyl LP', product.format
+          assert_equal 'INS79668', product.id
+
+          artist = @results.artists.first
+          assert artist.url
+          assert_equal 'Jimmy Eat World', artist.name
+          assert_equal 19191, artist.id
+        end
+      end
+
+      context 'search with bumped maxresults' do
+        setup do
+          mock(:maxresults, "?artist=arcade&maxresults=100")
+          @results = Query.search(:artist => 'arcade', :maxresults => 100)
+        end
+
+        should 'return multiple artists and products' do
+          assert_equal 30, @results.products.length
+          assert_equal 7, @results.artists.length
+
+          assert_equal 30, @results.products_total
+          assert_equal 7, @results.artists_total
+          assert_equal 37, @results.total_results
+          assert_nil @results.search_url
+
+          product = @results.products.first
+          assert product.url
+          assert_equal 'Arcade Fire', product.artist_name
+          assert_equal 'Funeral', product.title
+          assert_equal 'CD', product.format
+          assert_equal 'INS23877', product.id
+
+          artist = @results.artists.first
+          assert artist.url
+          assert_equal 'Arcade Fire', artist.name
+          assert_equal 29908, artist.id
+        end
+      end
+
+
+      context 'search using title' do
+        setup do
+          mock(:zen_arcade, "?artist=husker&title=zen%20arcade")
+          @results = Query.search(:artist => 'husker', :title => 'zen arcade')
+        end
+
+        should 'return multiple artists and products' do
+          assert_equal 2, @results.products.length
+          assert_equal 1, @results.artists.length
+
+          assert_equal 2, @results.products_total
+          assert_equal 1, @results.artists_total
+          assert_equal 3, @results.total_results
+          assert_nil @results.search_url
+
+          product = @results.products.first
+          assert product.url
+          assert_equal 'Husker Du', product.artist_name
+          assert_equal 'Zen Arcade', product.title
+          assert_equal 'Vinyl LP', product.format
+          assert_equal 'INS13241', product.id
+
+          artist = @results.artists.first
+          assert artist.url
+          assert_equal 'Husker Du', artist.name
+          assert_equal 21544, artist.id
+        end
+      end
+
+    end
+
+
+
+  end
+end

data/test/request_test.rb

@@ -0,0 +1,41 @@
+$:.unshift '.';require File.dirname(__FILE__) + '/helper'
+
+module InsoundApi
+  class RequestTest < Test::Unit::TestCase
+
+    context 'with credentials' do
+      setup do
+        setup_credentials
+      end
+
+      should 'raise if errors in response' do
+        if !mocking?
+          setup_test_credentials
+        end
+
+        mock(:bad_credentials, "?artist=townes%20van%20zandt&id=42&password=yyyyyy")
+        ex = assert_raise(RequestException) { Request.get(:artist => "townes van zandt") }
+        assert ex.message =~ /Invalid account information/i
+      end
+
+      should 'correctly build_url' do
+        if mocking?
+          request = Request.new(:artist => "townes van zandt")
+          assert_equal 'https://www.insound.com/ws/affiliate/?id=42&password=fart&artist=townes%20van%20zandt', request.build_url
+        end
+      end
+
+      should 'raise RequestException if artist not provided' do
+        ex = assert_raise(RequestException) { Request.get }
+        assert_equal ":artist is a required param for any request", ex.message
+      end
+
+      should 'raise RequestException if invalid format provided' do
+        ex = assert_raise(RequestException) { Request.get(:artist => 'blah', :format => 'fat32') }
+        assert_equal ":format must be one of the follwing: all, vinyl, seveninch, digital, poster, shirt, cd", ex.message
+      end
+
+    end
+
+  end
+end

data/test/response_test.rb

@@ -0,0 +1,40 @@
+require 'helper'
+
+module InsoundApi
+  class ResponseTest < Test::Unit::TestCase
+
+    should 'parse xml into a nokogiri document' do
+      response = Response.new(:raw_xml => '<blah>1</blah>')
+      doc = response.doc
+
+      assert_equal Nokogiri::XML::Document, doc.class
+      assert_equal '1', doc.css('blah').first.inner_html
+    end
+
+    should 'report errors if any' do
+      xml = <<THEXML
+<insound_query_response>
+<errors>
+<request_error>
+<error_code>102</error_code>
+<error_text>Invalid account information.</error_text>
+</request_error>
+<request_error>
+<error_code>101</error_code>
+<error_text>Missing required parameters</error_text>
+</request_error>
+</errors>
+</insound_query_response>
+THEXML
+
+      response = Response.new(:raw_xml => xml)
+
+      assert response.errors?
+
+      errors = [{:code=>"102", :text=>"Invalid account information."},
+                {:code=>"101", :text=>"Missing required parameters"}]
+      assert_equal errors, response.errors
+    end
+
+  end
+end

data/test/webmock/bad_credentials.xml

@@ -0,0 +1,8 @@
+<insound_query_response>
+<errors>
+<request_error>
+<error_code>102</error_code>
+<error_text>Invalid account information.</error_text>
+</request_error>
+</errors>
+</insound_query_response>

data/test/webmock/jimmy_eat_world_vinyl.xml

@@ -0,0 +1,45 @@
+<insound_query_response>
+<warnings/>
+<errors/>
+<product_matches>
+<product>
+<url>
+http://www.insound.com/Invented-Vinyl-LP-Jimmy-Eat-World/P/INS79668/&from=86902
+</url>
+<artist_name>Jimmy Eat World</artist_name>
+<title>Invented</title>
+<format>Vinyl LP</format>
+<product_id>INS79668</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Chase-This-Light-Vinyl-LP-Jimmy-Eat-World/P/INS39744/&from=86902
+</url>
+<artist_name>Jimmy Eat World</artist_name>
+<title>Chase This Light</title>
+<format>Vinyl LP</format>
+<product_id>INS39744</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Bleed-American-Vinyl-3xLP-Jimmy-Eat-World/P/INS111472/&from=86902
+</url>
+<artist_name>Jimmy Eat World</artist_name>
+<title>Bleed American</title>
+<format>Vinyl 3xLP</format>
+<product_id>INS111472</product_id>
+</product>
+</product_matches>
+<artist_matches>
+<artist>
+<artist_name>Jimmy Eat World</artist_name>
+<url>
+http://www.insound.com/Jimmy-Eat-World/A/19191/&from=86902
+</url>
+<artist_id>19191</artist_id>
+</artist>
+</artist_matches>
+<total_results>4</total_results>
+<total_product_results>3</total_product_results>
+<total_artist_results>1</total_artist_results>
+</insound_query_response>

data/test/webmock/maxresults.xml

@@ -0,0 +1,332 @@
+<insound_query_response>
+<warnings/>
+<errors/>
+<product_matches>
+<product>
+<url>
+http://www.insound.com/Funeral-CD-Arcade-Fire/P/INS23877/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Funeral</title>
+<format>CD</format>
+<product_id>INS23877</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/The-Suburbs-Vinyl-2xLP-Arcade-Fire/P/INS76692/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>The Suburbs</title>
+<format>Vinyl 2xLP</format>
+<product_id>INS76692</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Neon-Bible-Vinyl-LP-Arcade-Fire/P/INS33679/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Neon Bible</title>
+<format>Vinyl LP</format>
+<product_id>INS33679</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Neon-Bible-CD-Arcade-Fire/P/INS33678/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Neon Bible</title>
+<format>CD</format>
+<product_id>INS33678</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Neon-Bible-Deluxe-Edition-CD-Arcade-Fire/P/INS33683/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Neon Bible (Deluxe Edition)</title>
+<format>CD</format>
+<product_id>INS33683</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Funeral-Reissue-Vinyl-LP-Arcade-Fire/P/INS70891/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Funeral (Reissue)</title>
+<format>Vinyl LP</format>
+<product_id>INS70891</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Arcade-Fire-CDep-Arcade-Fire/P/INS26865/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Arcade Fire</title>
+<format>CDep</format>
+<product_id>INS26865</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/May-29-30-2007-Show-Poster-poster-Arcade-Fire/P/INS36391/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>May 29 & 30, 2007 Show Poster</title>
+<format>Poster</format>
+<product_id>INS36391</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/The-Suburbs-CD-Arcade-Fire/P/INS76693/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>The Suburbs</title>
+<format>CD</format>
+<product_id>INS76693</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Miroir-Noir-Deluxe-Edition-2xDVD-Arcade-Fire/P/INS54522/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Miroir Noir (Deluxe Edition)</title>
+<format>2xDVD</format>
+<product_id>INS54522</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/The-Suburbs-MP3-Arcade-Fire/P/INS78922/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>The Suburbs</title>
+<format>MP3</format>
+<product_id>INS78922</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/The-Suburbs-Deluxe-Edition-CD-and-DVD-Arcade-Fire/P/INS96835/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>The Suburbs (Deluxe Edition)</title>
+<format>CD+DVD</format>
+<product_id>INS96835</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Outlands-Vinyl-LP-Deep-Sea-Arcade/P/INS108373/&from=86902
+</url>
+<artist_name>Deep Sea Arcade</artist_name>
+<title>Outlands</title>
+<format>Vinyl LP</format>
+<product_id>INS108373</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Power-Out-CDep-Arcade-Fire/P/INS26778/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Power Out</title>
+<format>CDep</format>
+<product_id>INS26778</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Spring-Tour-2011-3-Chicago-poster-Arcade-Fire/P/INS95618/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Spring Tour 2011 #3 (Chicago)</title>
+<format>Poster</format>
+<product_id>INS95618</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Miroir-Noir-DVD-Arcade-Fire/P/INS54521/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Miroir Noir</title>
+<format>DVD</format>
+<product_id>INS54521</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/December-5-6-2010-Show-Poster-poster-Arcade-Fire/P/INS90082/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>December 5-6, 2010 Show Poster</title>
+<format>Poster</format>
+<product_id>INS90082</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/June-30-2011-Show-Poster-poster-Arcade-Fire/P/INS98765/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>June 30, 2011 Show Poster</title>
+<format>Poster</format>
+<product_id>INS98765</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Spring-Tour-2011-1-West-Coast-poster-Arcade-Fire/P/INS95619/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Spring Tour 2011 #1 (West Coast)</title>
+<format>Poster</format>
+<product_id>INS95619</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Funeral-MP3-Arcade-Fire/P/INS55433/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Funeral</title>
+<format>MP3</format>
+<product_id>INS55433</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/July-12-2010-Show-Poster-poster-Arcade-Fire/P/INS80896/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>July 12, 2010 Show Poster</title>
+<format>Poster</format>
+<product_id>INS80896</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/September-21-and-22-2011-Show-Poster-poster-Arcade-Fire/P/INS106729/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>September 21 and 22, 2011 Show Poster</title>
+<format>Poster</format>
+<product_id>INS106729</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Spring-Tour-2011-4-Tennessee-and-Texas-poster-Arcade-Fire/P/INS95616/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Spring Tour 2011 #4 (Tennessee and Texas)</title>
+<format>Poster</format>
+<product_id>INS95616</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Europe-Tour-2011-poster-Arcade-Fire/P/INS98764/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Europe Tour 2011</title>
+<format>Poster</format>
+<product_id>INS98764</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/The-Suburbs-Deluxe-MP3-Arcade-Fire/P/INS98280/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>The Suburbs Deluxe</title>
+<format>MP3</format>
+<product_id>INS98280</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Solo-Singles-Series-7-Vinyl-7inch-Trance-and-The-Arcade/P/INS17162/&from=86902
+</url>
+<artist_name>Trance and The Arcade</artist_name>
+<title>Solo Singles Series 7</title>
+<format>Vinyl 7&quot;</format>
+<product_id>INS17162</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Neon-Bible-MP3-Arcade-Fire/P/INS55434/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Neon Bible</title>
+<format>MP3</format>
+<product_id>INS55434</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/Canadian-Tour-September-2010-Show-Poster-poster-Arcade-Fire/P/INS89256/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>Canadian Tour, September 2010 Show Poster</title>
+<format>Poster</format>
+<product_id>INS89256</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/December-8-12-2010-Show-Poster-poster-Arcade-Fire/P/INS90081/&from=86902
+</url>
+<artist_name>Arcade Fire</artist_name>
+<title>December 8-12, 2010 Show Poster</title>
+<format>Poster</format>
+<product_id>INS90081</product_id>
+</product>
+<product>
+<url>
+http://www.insound.com/The-String-Quartet-Tribute-to-Arcade-Fires-Funereal-MP3-Arcade-Fire-String-Quartet-Tribute/P/INS39454/&from=86902
+</url>
+<artist_name>Arcade Fire String Quartet Tribute</artist_name>
+<title>
+The String Quartet Tribute to Arcade Fire's Funereal
+</title>
+<format>MP3</format>
+<product_id>INS39454</product_id>
+</product>
+</product_matches>
+<artist_matches>
+<artist>
+<artist_name>Arcade Fire</artist_name>
+<url>
+http://www.insound.com/Arcade-Fire/A/29908/&from=86902
+</url>
+<artist_id>29908</artist_id>
+</artist>
+<artist>
+<artist_name>Arcade Fire String Quartet Tribute</artist_name>
+<url>
+http://www.insound.com/Arcade-Fire-String-Quartet-Tribute/A/34443/&from=86902
+</url>
+<artist_id>34443</artist_id>
+</artist>
+<artist>
+<artist_name>Deep Sea Arcade</artist_name>
+<url>
+http://www.insound.com/Deep-Sea-Arcade/A/51254/&from=86902
+</url>
+<artist_id>51254</artist_id>
+</artist>
+<artist>
+<artist_name>Flashlight Arcade</artist_name>
+<url>
+http://www.insound.com/Flashlight-Arcade/A/30088/&from=86902
+</url>
+<artist_id>30088</artist_id>
+</artist>
+<artist>
+<artist_name>LCD Soundsystem / Arcade Fire</artist_name>
+<url>
+http://www.insound.com/LCD-Soundsystem-Arcade-Fire/A/34698/&from=86902
+</url>
+<artist_id>34698</artist_id>
+</artist>
+<artist>
+<artist_name>LCD Soundsystem/Arcade Fire</artist_name>
+<url>
+http://www.insound.com/LCD-SoundsystemArcade-Fire/A/38758/&from=86902
+</url>
+<artist_id>38758</artist_id>
+</artist>
+<artist>
+<artist_name>Trance and The Arcade</artist_name>
+<url>
+http://www.insound.com/Trance-and-The-Arcade/A/20727/&from=86902
+</url>
+<artist_id>20727</artist_id>
+</artist>
+</artist_matches>
+<total_results>37</total_results>
+<total_product_results>30</total_product_results>
+<total_artist_results>7</total_artist_results>
+</insound_query_response>