metal_archives 0.2.0

data/lib/metal_archives/version.rb

@@ -0,0 +1,6 @@
+module MetalArchives
+  ##
+  # MetalArchives API version
+  #
+  VERSION = '0.2.0'
+end

data/metal_archives.gemspec

@@ -0,0 +1,28 @@
+require File.expand_path('../lib/metal_archives/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Florian Dejonckheere"]
+  gem.email         = ["florian@floriandejonckheere.be"]
+  gem.summary       = %q{Metal Archives Ruby API}
+  gem.homepage      = "http://github.com/floriandejonckheere/metal_archives"
+
+  gem.files         = %x{git ls-files}.split($\)
+  gem.executables   = []
+  gem.test_files    = gem.files.grep(%r{^spec/})
+  gem.name          = "metal_archives"
+  gem.require_paths = %w[lib]
+  gem.version       = MetalArchives::VERSION
+  gem.license       = "MIT"
+
+  gem.add_development_dependency 'byebug'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'test-unit'
+  gem.add_development_dependency 'activesupport'
+
+  gem.add_dependency 'faraday'
+  gem.add_dependency 'faraday-http-cache'
+  gem.add_dependency 'faraday_throttler'
+  gem.add_dependency 'nokogiri'
+  gem.add_dependency 'countries'
+end

data/test/base_model_test.rb

@@ -0,0 +1,87 @@
+require 'test_helper'
+
+require 'metal_archives/models/base_model'
+
+##
+# Sample model without :id property
+#
+class ModelOne < MetalArchives::BaseModel
+  property :property_one
+end
+
+##
+# Sample model without :assemble method
+#
+class ModelTwo < MetalArchives::BaseModel
+  property :id
+  property :property_one
+end
+
+##
+# Sample model
+#
+class ModelThree < MetalArchives::BaseModel
+  property :id
+  property :property_one
+
+  def assemble
+    instance_variable_set "@property_one", 'Property One'
+  end
+end
+
+##
+# BaseModel tests
+#
+class BaseModelTest < Test::Unit::TestCase
+  def test_need_id
+    assert_raise MetalArchives::Errors::NotImplementedError do
+      ModelOne.new(:property_one => 'foo')
+    end
+  end
+
+  def test_need_assemble
+    assert_raise MetalArchives::Errors::NotImplementedError do
+      ModelTwo.new(:id => 'foo').property_one
+    end
+  end
+
+  def test_constructor
+    model = ModelThree.new(:id => 'foo', :property_one => 'bar')
+
+    assert model.instance_variable_defined? '@id'
+    assert model.instance_variable_defined? '@property_one'
+    assert !model.instance_variable_defined?('@property_two')
+  end
+
+  def test_methods
+    model = ModelThree.new(:id => 'foo')
+
+    assert_respond_to model, :id
+    assert_respond_to model, :id?
+    assert_respond_to model, :id=
+
+    assert_respond_to model, :property_one
+    assert_respond_to model, :property_one?
+    assert_respond_to model, :property_one=
+  end
+
+  def test_assemble
+    model = ModelThree.new :id => 'foo'
+
+    assert_equal 'foo', model.id
+    assert_equal 'Property One', model.property_one
+  end
+
+  def test_lazy_load
+    model = ModelThree.new :id => 'foo'
+
+    assert model.instance_variable_defined? '@id'
+    assert !model.instance_variable_defined?('@property_one')
+
+    model.property_one
+
+    assert model.instance_variable_defined? '@id'
+    assert model.instance_variable_defined? '@property_one'
+    assert_equal 'Property One', model.property_one
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,57 @@
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'test/unit'
+
+require 'metal_archives'
+require 'metal_archives/error'
+
+##
+# Configuration tests
+#
+class ConfigurationTest < Test::Unit::TestCase
+  def setup
+    MetalArchives.config = nil
+  end
+
+  def test_no_configuration
+    assert_raise MetalArchives::Errors::InvalidConfigurationError do
+      MetalArchives::Band.search 'some_name'
+    end
+  end
+
+  def test_missing_app_name
+    assert_raise MetalArchives::Errors::InvalidConfigurationError do
+      MetalArchives.configure do |c|
+        c.app_version = MetalArchives::VERSION
+        c.app_contact = `git config user.email`.chomp || 'user@example.com'
+      end
+    end
+  end
+
+  def test_missing_app_version
+    assert_raise MetalArchives::Errors::InvalidConfigurationError do
+      MetalArchives.configure do |c|
+        c.app_name = 'MetalArchivesGemTestSuite'
+        c.app_contact = `git config user.email`.chomp || 'user@example.com'
+      end
+    end
+  end
+
+  def test_missing_app_contact
+    assert_raise MetalArchives::Errors::InvalidConfigurationError do
+      MetalArchives.configure do |c|
+        c.app_name = 'MetalArchivesGemTestSuite'
+        c.app_version = MetalArchives::VERSION
+      end
+    end
+  end
+
+  def test_full_configuration
+    assert_nothing_raised do
+      MetalArchives.configure do |c|
+        c.app_name = 'MetalArchivesGemTestSuite'
+        c.app_version = MetalArchives::VERSION
+        c.app_contact = `git config user.email`.chomp || 'user@example.com'
+      end
+    end
+  end
+end

data/test/parser_helper_test.rb

@@ -0,0 +1,37 @@
+require 'test_helper'
+
+require 'date'
+require 'countries'
+
+require 'metal_archives/parsers/parser_helper.rb'
+
+class ParserHelperTest < Test::Unit::TestCase
+  def test_parse_country
+    assert_equal ISO3166::Country['US'], MetalArchives::Parsers::ParserHelper.parse_country('United States')
+    assert_equal ISO3166::Country['DE'], MetalArchives::Parsers::ParserHelper.parse_country('Germany')
+    assert_equal ISO3166::Country['BE'], MetalArchives::Parsers::ParserHelper.parse_country('Belgium')
+  end
+
+  def test_parse_genre
+    assert_equal ['Black', 'Death', 'Power'].sort,
+        MetalArchives::Parsers::ParserHelper.parse_genre('Death, Power, Black').sort
+
+    assert_equal ['Black', 'Death', 'Power'].sort,
+        MetalArchives::Parsers::ParserHelper.parse_genre('Death, Power, Black').sort
+
+    assert_equal ['Black', 'Death', 'Heavy', 'Power'].sort,
+        MetalArchives::Parsers::ParserHelper.parse_genre('Death (early), Heavy/Power Metal, Black (later)').sort
+
+    assert_equal ['Death', 'Power'].sort,
+        MetalArchives::Parsers::ParserHelper.parse_genre('        Death       ,      Power   Metal, Power, Power').sort
+
+    assert_equal ['Heavy Power', 'Speed Power'].sort,
+        MetalArchives::Parsers::ParserHelper.parse_genre('Heavy/Speed Power Metal').sort
+
+    assert_equal ['Traditional Heavy', 'Traditional Power'].sort,
+        MetalArchives::Parsers::ParserHelper.parse_genre('Traditional Heavy/Power Metal').sort
+
+    assert_equal ['Traditional Heavy', 'Traditional Power', 'Classical Heavy', 'Classical Power'].sort,
+        MetalArchives::Parsers::ParserHelper.parse_genre('Traditional/Classical Heavy/Power Metal').sort
+  end
+end

data/test/property/artist_property_test.rb

@@ -0,0 +1,43 @@
+require_relative '../test_helper'
+
+require 'metal_archives/parsers/band'
+
+##
+# Property testing
+#
+# If a test fails, please check the online results to make sure it's not
+# the content itself that has changed.
+#
+class ArtistPropertyTest < Test::Unit::TestCase
+  def test_basic_attributes
+    artist = MetalArchives::Artist.find 60908
+
+    assert artist.is_a? MetalArchives::Artist
+    assert_equal 60908, artist.id
+    assert_equal 'Alberto Rionda', artist.name
+    assert_empty artist.aliases
+    assert_equal ISO3166::Country['ES'], artist.country
+    assert_equal 'Oviedo, Asturias', artist.location
+    assert_equal Date.new(1972, 9, 2), artist.date_of_birth
+    assert_equal :male, artist.gender
+    assert_match 'Avalanch', artist.biography
+    assert_match 'Sanctuarium Estudios', artist.trivia
+
+    artist = MetalArchives::Artist.find 260
+
+    assert artist.is_a? MetalArchives::Artist
+    assert_equal 'Ian Fraser Kilmister', artist.name
+    assert_equal ['Lemmy Kilmister'], artist.aliases
+    assert_equal Date.new(2015, 12, 28), artist.date_of_death
+    assert_equal 4, artist.links.length
+    assert_equal 1, artist.links.count { |l| l[:type] == :official }
+    assert_equal 2, artist.links.count { |l| l[:type] == :unofficial }
+    assert_equal 1, artist.links.count { |l| l[:type] == :unlisted_bands }
+    assert_equal 'https://www.facebook.com/OfficialLemmy', artist.links.select { |l| l[:type] == :official }.first[:url]
+    assert_equal 'Facebook', artist.links.select { |l| l[:type] == :official }.first[:title]
+  end
+
+  def test_map_params
+    assert_equal 'name', MetalArchives::Parsers::Artist.map_params(:name => 'name')[:query]
+  end
+end

data/test/property/band_property_test.rb

@@ -0,0 +1,94 @@
+require_relative '../test_helper'
+
+require 'metal_archives/parsers/band'
+
+##
+# Property testing
+#
+# If a test fails, please check the online results to make sure it's not
+# the content itself that has changed.
+#
+class BandPropertyTest < Test::Unit::TestCase
+  def test_basic_attributes
+    band = MetalArchives::Band.find 122302
+
+    assert_equal 'Pathfinder', band.name
+    assert_empty band.aliases
+    assert_equal ISO3166::Country['PL'], band.country
+    assert_equal 'Poznań', band.location
+    assert_equal Date.new(2006), band.date_formed
+    assert_equal [MetalArchives::Range.new(Date.new(2006), nil)], band.date_active
+    assert_equal :active, band.status
+    assert_equal ['Symphonic Power'], band.genres
+    assert_equal ['Fantasy', 'Battles', 'Glory', 'The Four Elements', 'Metal'].sort, band.lyrical_themes.sort
+    assert_match 'Pathfinder was founded by', band.comment
+    assert_equal 'http://www.metal-archives.com/images/1/2/2/3/122302_logo.jpg', band.logo
+    assert_equal 'http://www.metal-archives.com/images/1/2/2/3/122302_photo.jpg?5400', band.photo
+    assert !band.independent
+    assert_equal 19, band.similar.length
+    assert_equal 15, band.links.length
+    assert_equal 12, band.links.count { |l| l[:type] == :official }
+    assert_equal 3, band.links.count { |l| l[:type] == :merchandise }
+    assert_equal 'http://www.amazon.com/Fifth-Element-Pathfinder/dp/B007MNNCVW', band.links.select { |l| l[:type] == :merchandise }.first[:url]
+    assert_equal 'Amazon', band.links.select { |l| l[:type] == :merchandise }.first[:title]
+
+
+    band = MetalArchives::Band.find 32
+
+    assert_equal 'Rhapsody of Fire', band.name
+    assert_equal ['Thundercross', 'Rhapsody'].sort, band.aliases.sort
+  end
+
+  def test_map_status
+    assert_equal '', MetalArchives::Parsers::Band.send(:map_status, nil)
+    assert_equal 'Active', MetalArchives::Parsers::Band.send(:map_status, :active)
+    assert_equal 'Split-up', MetalArchives::Parsers::Band.send(:map_status, :split_up)
+    assert_equal 'On hold', MetalArchives::Parsers::Band.send(:map_status, :on_hold)
+    assert_equal 'Unknown', MetalArchives::Parsers::Band.send(:map_status, :unknown)
+    assert_equal 'Changed name', MetalArchives::Parsers::Band.send(:map_status, :changed_name)
+    assert_equal 'Disputed', MetalArchives::Parsers::Band.send(:map_status, :disputed)
+
+    assert_raises MetalArchives::Errors::ParserError do
+      MetalArchives::Parsers::Band.send(:map_status, :invalid_status)
+    end
+  end
+
+  def test_map_params
+    assert_equal 'name', MetalArchives::Parsers::Band.map_params(:name => 'name')[:bandName]
+
+    assert_equal 1, MetalArchives::Parsers::Band.map_params(:exact => true)[:exactBandMatch]
+    assert_equal 1, MetalArchives::Parsers::Band.map_params(:exact => 'somevalue')[:exactBandMatch]
+    assert_equal 0, MetalArchives::Parsers::Band.map_params(:exact => false)[:exactBandMatch]
+    assert_equal 0, MetalArchives::Parsers::Band.map_params(:exact => nil)[:exactBandMatch]
+
+    assert_equal '', MetalArchives::Parsers::Band.map_params({})[:bandName]
+    assert_equal 0, MetalArchives::Parsers::Band.map_params({})[:exactBandMatch]
+    assert_equal 'genre', MetalArchives::Parsers::Band.map_params({ :genre => 'genre'})[:genre]
+    assert_equal '', MetalArchives::Parsers::Band.map_params({})[:genre]
+
+    range = Range.new Date.new(2016), Date.new(2017)
+    assert_equal 2016, MetalArchives::Parsers::Band.map_params({ :year => range })[:yearCreationFrom]
+    assert_equal 2017, MetalArchives::Parsers::Band.map_params({ :year => range })[:yearCreationTo]
+    assert_equal '', MetalArchives::Parsers::Band.map_params({})[:yearCreationFrom]
+    assert_equal '', MetalArchives::Parsers::Band.map_params({})[:yearCreationTo]
+
+    assert_equal 'comment', MetalArchives::Parsers::Band.map_params({ :comment => 'comment' })[:bandNotes]
+    # :status is tested in test_map_status
+    assert_equal 'themes', MetalArchives::Parsers::Band.map_params({ :lyrical_themes => 'themes' })[:themes]
+    assert_equal 'location', MetalArchives::Parsers::Band.map_params({ :location => 'location' })[:location]
+    assert_equal 'label', MetalArchives::Parsers::Band.map_params({ :label => 'label' })[:bandLabelName]
+    assert_equal 1, MetalArchives::Parsers::Band.map_params({ :independent => true })[:indieLabelBand]
+    assert_equal 1, MetalArchives::Parsers::Band.map_params({ :independent => 'some value' })[:indieLabelBand]
+    assert_equal 1, MetalArchives::Parsers::Band.map_params({ :independent => '' })[:indieLabelBand]
+    assert_equal 0, MetalArchives::Parsers::Band.map_params({ :independent => false })[:indieLabelBand]
+    assert_equal 0, MetalArchives::Parsers::Band.map_params({ :independent => nil })[:indieLabelBand]
+
+    country = ISO3166::Country['BE']
+    country2 = ISO3166::Country['NL']
+    assert_equal 'BE', MetalArchives::Parsers::Band.map_params({ :country => country })[:country]
+    assert_equal ['BE', 'NL'], MetalArchives::Parsers::Band.map_params({ :country => [country, country2] })[:country]
+
+    assert_equal 'BE', MetalArchives::Parsers::Band.map_params({ :country => ['BE'] })[:country]
+    assert_equal ['BE', 'NL'], MetalArchives::Parsers::Band.map_params({ :country => ['BE', 'NL'] })[:country]
+  end
+end

data/test/query/artist_query_test.rb

@@ -0,0 +1,44 @@
+require_relative '../test_helper'
+
+##
+# Query method testing
+#
+# If a test fails, please check the online results to make sure it's not
+# the content itself that has changed.
+#
+class ArtistQueryTest < Test::Unit::TestCase
+  def test_find
+    artist = MetalArchives::Artist.find 60908
+
+    assert_not_nil artist
+    assert artist.is_a? MetalArchives::Artist
+    assert_equal 'Alberto Rionda', artist.name
+    assert_equal ISO3166::Country['ES'], artist.country
+
+    artist = MetalArchives::Artist.find(999999)
+
+    assert artist.is_a? MetalArchives::Artist
+  end
+
+  def test_find_by
+    artist = MetalArchives::Artist.find_by :name => 'Alberto Rionda'
+
+    assert_not_nil artist
+    assert artist.is_a? MetalArchives::Artist
+    assert_equal 'Alberto Rionda', artist.name
+    assert_equal 60908, artist.id
+    assert_equal ISO3166::Country['ES'], artist.country
+
+
+    artist = MetalArchives::Artist.find_by :name => 'SomeNonExistantName'
+
+    assert_nil artist
+  end
+
+  def test_search
+    assert_equal 1, MetalArchives::Artist.search('Alberto Rionda').length
+    assert_equal 9, MetalArchives::Artist.search('Name').length
+    assert_equal 0, MetalArchives::Artist.search('SomeNonExistantName').length
+    assert_equal 293, MetalArchives::Artist.search('Filip').length
+  end
+end

data/test/query/band_query_test.rb

@@ -0,0 +1,84 @@
+require_relative '../test_helper'
+
+##
+# Query method testing
+#
+# If a test fails, please check the online results to make sure it's not
+# the content itself that has changed.
+#
+class BandQueryTest < Test::Unit::TestCase
+  def test_find
+    band = MetalArchives::Band.find 3540361100
+
+    assert_not_nil band
+    assert band.is_a? MetalArchives::Band
+    assert_equal 'Alquimia', band.name
+    assert_equal ISO3166::Country['ES'], band.country
+
+    assert_match 'http', band.logo
+    assert_match 'http', band.photo
+
+    band = MetalArchives::Band.find(2)
+
+    assert band.is_a? MetalArchives::Band
+  end
+
+  def test_find_by
+    band = MetalArchives::Band.find_by :name => 'Falconer'
+
+    assert_not_nil band
+    assert band.is_a? MetalArchives::Band
+    assert_equal 'Falconer', band.name
+    assert_equal 74, band.id
+    assert_equal ISO3166::Country['SE'], band.country
+
+
+    band = MetalArchives::Band.find_by :name => 'SomeNonExistantName'
+
+    assert_nil band
+
+
+    band = MetalArchives::Band.find_by(:name => 'Alquimia', :country => ISO3166::Country['ES'])
+
+    assert_not_nil band
+    assert band.is_a? MetalArchives::Band
+    assert_equal 3540361100, band.id
+  end
+
+  def test_search_by
+    assert_equal 5, MetalArchives::Band.search_by(:name => 'Alquimia').length
+
+    assert_equal 3, MetalArchives::Band.search_by(:name => 'Lost Horizon').length
+    assert_equal 2, MetalArchives::Band.search_by(:name => 'Lost Horizon', :exact => true).length
+
+    assert_equal 2, MetalArchives::Band.search_by(:name => 'Alquimia', :genre => 'Melodic Power').length
+
+
+      countries = MetalArchives::Band.search('Alquimia').map { |a| a.country }.sort
+
+      assert_equal 5, countries.size
+      assert countries.include? ISO3166::Country['AR']
+      assert countries.include? ISO3166::Country['ES']
+      assert countries.include? ISO3166::Country['CL']
+
+    assert_equal 5, MetalArchives::Band.search_by(
+              :name => 'Alquimia', :year => MetalArchives::Range.new(nil, nil)).length
+    assert_equal 1, MetalArchives::Band.search_by(
+              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2013), nil)).length
+    assert_equal 1, MetalArchives::Band.search_by(
+              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2008))).length
+    assert_equal 2, MetalArchives::Band.search_by(
+              :name => 'Alquimia', :year => MetalArchives::Range.new(Date.new(2008), Date.new(2013))).length
+    assert_equal 5, MetalArchives::Band.search_by(
+              :name => 'Alquimia', :year => MetalArchives::Range.new(nil, Date.new(2013))).length
+
+    assert_equal 1, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['ES']).length
+    assert_equal 3, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).length
+    assert_equal 3, MetalArchives::Band.search_by(:name => 'Alquimia', :country => ISO3166::Country['AR']).length
+    assert_equal 1, MetalArchives::Band.search_by(:name => 'Alquimia', :label => 'Mutus Liber').length
+
+    assert_empty MetalArchives::Band.search_by(:name => 'SomeNonExistantName')
+
+    assert_equal 274, MetalArchives::Band.search_by(:country => ISO3166::Country['CN']).length
+  end
+end